twingly/twingly-search-api-ruby

# encoding: utf-8
# frozen_string_literal: true

module Twingly
  module Search
    # A blog post
    #
    # @attr_reader [String] id the post ID (Twingly internal identification)
    # @attr_reader [String] author the author of the blog post
    # @attr_reader [String] url the post URL
    # @attr_reader [String] title the post title
    # @attr_reader [String] text the blog post text
    # @attr_reader [String] language_code ISO two letter language code for the
    #   language that the post was written in
    # @attr_reader [String] location_code ISO two letter country code for the
    #   location of the blog
    # @attr_reader [Hash] coordinates a hash containing :latitude and :longitude
    #   from the post RSS
    # @attr_reader [Array] links all links from the blog post to other resources
    # @attr_reader [Array] tags the post tags/categories
    # @attr_reader [Array] images image URLs from the post (currently not populated)
    # @attr_reader [Time] indexed_at the time, in UTC, when the post was indexed by Twingly
    # @attr_reader [Time] published_at the time, in UTC, when the post was published
    # @attr_reader [Time] reindexed_at timestamp when the post last was changed in our database/index
    # @attr_reader [String] inlinks_count number of links to this post that was found in other blog posts
    # @attr_reader [String] blog_id the blog ID (Twingly internal identification)
    # @attr_reader [String] blog_name the name of the blog
    # @attr_reader [String] blog_url the blog URL
    # @attr_reader [Integer] blog_rank the rank of the blog, based on authority and language.
    #   See https://app.twingly.com/blog_search?tab=documentation
    # @attr_reader [Integer] authority the blog's authority/influence.
    #   https://app.twingly.com/blog_search?tab=documentation
    class Post
      attr_reader :id, :author, :url, :title, :text, :location_code,
        :language_code, :coordinates, :links, :tags, :images, :indexed_at,
        :published_at, :reindexed_at, :inlinks_count, :blog_id, :blog_name,
        :blog_url, :blog_rank, :authority

      EMPTY_ARRAY = [].freeze
      EMPTY_HASH  = {}.freeze

      # Sets all instance variables for the {Post}, given a Hash.
      #
      # @param [Hash] params containing blog post data.
      def set_values(params)
        @id            = params.fetch('id')
        @author        = params.fetch('author')
        @url           = params.fetch('url')
        @title         = params.fetch('title')
        @text          = params.fetch('text')
        @language_code = params.fetch('languageCode')
        @location_code = params.fetch('locationCode')
        @coordinates   = params.fetch('coordinates') { EMPTY_HASH }
        @links         = params.fetch('links') { EMPTY_ARRAY }
        @tags          = params.fetch('tags') { EMPTY_ARRAY }
        @images        = params.fetch('images') { EMPTY_ARRAY }
        @indexed_at    = Time.parse(params.fetch('indexedAt'))
        @published_at  = Time.parse(params.fetch('publishedAt'))
        @reindexed_at  = Time.parse(params.fetch('reindexedAt'))
        @inlinks_count = params.fetch('inlinksCount').to_i
        @blog_id       = params.fetch('blogId')
        @blog_name     = params.fetch('blogName')
        @blog_url      = params.fetch('blogUrl')
        @blog_rank     = params.fetch('blogRank').to_i
        @authority     = params.fetch('authority').to_i
      end

      # @deprecated Please use {#text} instead
      def summary
        warn "[DEPRECATION] `summary` is deprecated. Please use `text` instead."
        text
      end

      # @deprecated Please use {#indexed_at} instead
      def indexed
        warn "[DEPRECATION] `indexed` is deprecated. Please use `indexed_at` instead."
        indexed_at
      end

      # @deprecated Please use {#published_at} instead
      def published
        warn "[DEPRECATION] `published` is deprecated. Please use `published_at` instead."
        published_at
      end

      # @deprecated Please use {#links} instead
      def outlinks
        warn "[DEPRECATION] `outlinks` is deprecated. Please use `links` instead."
        links
      end

      # @return [Hash] a hash containing all post attributes.
      def to_h
        {
          id: @id,
          author: @author,
          url: @url,
          title: @title,
          text: @text,
          language_code: @language_code,
          location_code: @location_code,
          coordinates: @coordinates,
          links: @links,
          tags: @tags,
          images: @images,
          indexed_at: @indexed_at,
          published_at: @published_at,
          reindexed_at: @reindexed_at,
          inlinks_count: @inlinks_count,
          blog_id: @blog_id,
          blog_name: @blog_name,
          blog_url: @blog_url,
          blog_rank: @blog_rank,
          authority: @authority,
        }
      end
    end
  end
end