metonym 1.0.0 → 1.0.1

data/lib/metonym.rb

@@ -1,8 +1,18 @@
-require "metonym/version"
+# frozen_string_literal: true
+
+require 'metonym/version'
 require 'date'
 require 'net/http'
 require 'metonym/lib/gnews.rb'
-require 'metonym/lib/validate.rb'
+require 'metonym/lib/presenters/base_response_presenter.rb'
+require 'metonym/lib/presenters/gnews_response_presenter.rb'
+require 'metonym/lib/presenters/news_api_response_presenter.rb'
+require 'metonym/lib/repositories/base_repository.rb'
+require 'metonym/lib/repositories/gnews_repository.rb'
+require 'metonym/lib/repositories/news_api_repository.rb'
+require 'metonym/lib/validators/base_validator.rb'
+require 'metonym/lib/validators/gnews_query_validator.rb'
+require 'metonym/lib/validators/news_api_query_validator.rb'
 require 'metonym/lib/news_api.rb'
 require 'byebug'
 require 'json'

data/lib/metonym/lib/gnews.rb

@@ -1,49 +1,51 @@
+# frozen_string_literal: true
+
 module Gnews
-    class Query
-        attr_accessor :gnews_api_key
-        attr_accessor :gnews_version
-        attr_accessor :uri
-
-        def initialize(key, version = nil)
-            @gnews_api_key = key
-            @gnews_version = version.nil? ? 'v2' : version
-            @uri = URI("https://gnews.io/api/#{@gnews_version}/")
-        end
-
-        def search(args, format = 'json')
-            begin
-                v = Validate::GnewsValidator.new
-                raise "API Key is required"        if v.is_key_present?(@gnews_api_key) == false
-                raise "Invalid parameter sequence" if v.is_query_valid?(args)    == false
-                raise "Invalid country sent"       if v.is_country_valid?(args)  == false
-                raise "Invalid language sent"      if v.is_language_valid?(args) == false
-                raise "Invalid date or dates sent" if v.is_date_valid?(args)     == false
-                raise "Invalid format sent"        if v.is_format_valid?(format) == false
-
-                args = prepare_arguments(args)
-                @uri.query = URI.encode_www_form(args)
-                response = Net::HTTP.get_response(@uri)
-            rescue Exception => e
-                response = {"errors" => e.to_s}
-            ensure
-                if response.is_a?(Hash) && response.has_key?('errors')
-                    return response
-                else
-                    if format.nil? || format == 'json'
-                        return response.body
-                    elsif format == 'hash'
-                        return JSON.parse(response.body)
-                    end
-                end
-            end
-        end
-
-        private
-        def prepare_arguments(args)
-            args['mindate'] = args.has_key?('mindate') ? args['mindate'].strftime("%y-%m-%d") : nil
-            args['maxdate'] = args.has_key?('maxdate') ? args['maxdate'].strftime("%y-%m-%d") : nil
-            args["token"] = @gnews_api_key
-            args
-        end
+  class Query
+    attr_accessor :gnews_api_key
+    attr_accessor :uri
+
+    def initialize(key)
+      @gnews_api_key = key
+      @gnews = Gnews::GnewsRepository.new(key)
+    end
+
+    def search(args, **options)
+      request('search', args: args, format: define_response_format(options))
+    end
+
+    def top_news(args, **options)
+      request('top-news', args: args, format: define_response_format(options))
+    end
+
+    private
+
+    def define_response_format(options)
+      options[:format] || 'json'
+    end
+
+    def request(resource, args:, format:)
+      validate_query_parameters(args, format)
+
+      case resource
+      when 'search'
+        response = @gnews.search(query: args)
+      when 'top-news'
+        response = @gnews.top_news(query: args)
+      when 'topics'
+        response = @gnews.topics(query: args)
+      end
+    rescue StandardError => e
+      response = { errors: e.to_s }
+    ensure
+      presenter = Gnews::GnewsResponsePresenter.new
+      return presenter.generate_formatted_response(response, format)
+    end
+
+    def validate_query_parameters(args, format)
+      v = Validate::GnewsQueryValidator.new(@gnews_api_key,
+                                            args: args, format: format)
+      raise v unless v
     end
-end
+  end
+end

data/lib/metonym/lib/news_api.rb

@@ -1,65 +1,54 @@
+# frozen_string_literal: true
+
 module NewsApi
-    class Query
-        attr_accessor :news_api_key
-        attr_accessor :news_api_version
-        attr_accessor :uri
+  class Query
+    attr_accessor :news_api_key
+    attr_accessor :uri
 
-        def initialize(key, version = nil)
-            @news_api_key = key
-            @news_api_version = version.nil? ? 'v2' : version
-            @uri = "https://newsapi.org/#{@news_api_version}"
-        end
+    def initialize(key)
+      @news_api_key = key
+      @news_api = NewsApi::NewsApiRepository.new(key)
+    end
 
-        def top_headlines(args, format = 'json')
-            uri = URI("#{@uri}/top-headlines")
-            return request(args, format, uri, 'top-headlines')
-        end
+    def everything(args, **options)
+      request('everything', args: args, format: define_response_format(options))
+    end
 
-        def everything(args, format = 'json')
-            uri = URI("#{@uri}/everything")
-            return request(args, format, uri, 'everything')
-        end
+    def top_headlines(args, **options)
+      request('top-headlines', args: args, format: define_response_format(options))
+    end
 
-        def sources(args, format = 'json')
-            uri = URI("#{@uri}/sources")
-            return request(args, format, uri, 'sources')
-        end
+    def sources(args, **options)
+      request('sources', args: args, format: define_response_format(options))
+    end
 
-        private
-        def request(args, format, uri, endpoint)
-            begin
-                v = Validate::NewsApiValidator.new
-                raise "API Key is required"        if v.is_key_present?(@news_api_key)  == false
-                raise "Invalid parameter sequence" if v.is_query_valid?(args, endpoint) == false
-                raise "Invalid country sent"       if v.is_country_valid?(args)  == false
-                raise "Invalid language sent"      if v.is_language_valid?(args) == false
-                raise "Invalid date or dates sent" if v.is_date_valid?(args)     == false
-                raise "Invalid format sent"        if v.is_format_valid?(format) == false
-                
-                args = prepare_arguments(args)
+    private
 
-                uri.query = URI.encode_www_form(args)
-                response = Net::HTTP.get_response(uri)                
-            rescue Exception => e
-                response = {"errors" => e.to_s}
-            ensure
-                if response.is_a?(Hash) && response.has_key?('errors')
-                    return response
-                else
-                    if format.nil? || format == 'json'
-                        return response.body
-                    elsif format == 'hash'
-                        return JSON.parse(response.body)
-                    end
-                end
-            end
-        end
+    def define_response_format(options)
+      options[:format] || 'json'
+    end
+
+    def request(resource, args:, format:)
+      validate_query_parameters(args, format, resource)
+
+      case resource
+      when 'top-headlines'
+        response = @news_api.top_headlines(query: args)
+      when 'everything'
+        response = @news_api.everything(query: args)
+      when 'sources'
+        response = @news_api.sources(query: args)
+      end
+    rescue StandardError => e
+      response = { errors: e.to_s }
+    ensure
+      presenter = NewsApi::NewsApiResponsePresenter.new
+      return presenter.generate_formatted_response(response, format)
+    end
 
-        def prepare_arguments(args)
-            args['apiKey'] = @news_api_key
-            args['from'] = args.has_key?('from') ? args['from'].strftime("%FT%T%:z") : nil
-            args['to']   = args.has_key?('to')   ? args['to'].strftime("%FT%T%:z") : nil
-            args
-        end
+    def validate_query_parameters(args, format, resource)
+      v = Validate::NewsApiQueryValidator.new(@news_api_key, args: args, format: format, endpoint: resource)
+      raise v unless v
     end
-end
+  end
+end

data/lib/metonym/lib/presenters/base_response_presenter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class BaseResponsePresenter
+  def generate_formatted_response(response, format)
+    return response if response.is_a?(Hash) && response.key?(:errors)
+
+    case format
+    when nil
+      response.body
+    when 'json'
+      response.body
+    when 'hash'
+      JSON.parse(response.body)
+    else
+      response.body
+    end
+  end
+end

data/lib/metonym/lib/presenters/gnews_response_presenter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gnews
+  class GnewsResponsePresenter < BaseResponsePresenter; end
+end

data/lib/metonym/lib/presenters/news_api_response_presenter.rb

@@ -0,0 +1,3 @@
+module NewsApi
+  class NewsApiResponsePresenter < BaseResponsePresenter; end
+end

data/lib/metonym/lib/repositories/base_repository.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class BaseRepository
+  def request(uri, query:, resource:)
+    uri = URI(uri += resource)
+    uri.query = URI.encode_www_form(prepare_arguments(query))
+    Net::HTTP.get_response(uri)
+  end
+end

data/lib/metonym/lib/repositories/gnews_repository.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Gnews
+  class GnewsRepository < BaseRepository
+    def initialize(api_key)
+      @gnews_api_key = api_key
+      @uri = 'https://gnews.io/api/v3/'
+    end
+
+    def search(query:)
+      request(@uri, query: query, resource: 'search')
+    end
+
+    def top_news(query:)
+      request(@uri, query: query, resource: 'top-news')
+    end
+
+    def topic
+      request(@uri, query: query, resource: 'topic')
+    end
+
+    private
+
+    def prepare_arguments(query)
+      query['mindate'] = query.key?(:mindate) ? query[:mindate].strftime('%y-%m-%d') : nil
+      query['maxdate'] = query.key?(:maxdate) ? query[:maxdate].strftime('%y-%m-%d') : nil
+      query['token'] = @gnews_api_key
+      query
+    end
+  end
+end

data/lib/metonym/lib/repositories/news_api_repository.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NewsApi
+  class NewsApiRepository < BaseRepository
+    def initialize(api_key)
+      @news_api_key = api_key
+      @uri = 'https://newsapi.org/v2/'
+    end
+
+    def everything(query:)
+      request(@uri, query: query, resource: 'everything')
+    end
+
+    def top_headlines(query:)
+      request(@uri, query: query, resource: 'top-headlines')
+    end
+
+    def sources(query:)
+      request(@uri, query: query, resource: 'sources')
+    end
+
+    private
+
+    def prepare_arguments(query)
+      query['from'] = query.key?(:from) ? query[:from].strftime('%FT%T%:z') : nil
+      query['to']   = query.key?(:to)   ? query[:to].strftime('%FT%T%:z') : nil
+      query['apiKey'] = @news_api_key
+      query
+    end
+  end
+end

data/lib/metonym/lib/validators/base_validator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Validate
+  class BaseValidator
+    protected
+
+    def key_present?(args)
+      !args.nil?
+    end
+
+    def language_valid?(args)
+      return true if args[:lang].nil?
+
+      [
+        'af', 'ak', 'sq', 'am', 'ar', 'hy', 'az', 'eu', 'be', 'bem', 'bn', 'bs', 'bh', 'br', 'bg', 'km', 'ca', 'chr', 'ny', 'zh-CN',
+        'zh-TW', 'co', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'ee', 'fo', 'tl', 'fi', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'gn', 'gu',
+        'ht', 'ha', 'haw', 'iw', 'hi', 'hu', 'is', 'ig', 'id', 'ia', 'ga', 'it', 'ja', 'jw', 'kn', 'kk', 'rw', 'rn', 'kg', 'ko', 'kri',
+        'ku', 'ckb', 'ky', 'lo', 'la', 'lv', 'ln', 'lt', 'loz', 'lg', 'ach', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mfe', 'mo', 'mn',
+        'sr-ME', 'ne', 'nso', 'no', 'nn', 'oc', 'or', 'om', 'ps', 'fa', 'pl', 'pt-BR', 'pt-PT', 'pa', 'qu', 'ro', 'rm', 'nyn', 'ru', 'gd',
+        'sr', 'sh', 'st', 'tn', 'crs', 'sn', 'sd', 'si', 'sk', 'sl', 'so', 'es', 'sp-419', 'su', 'sw', 'sv', 'tg', 'ta', 'tt', 'te', 'th', 'ti',
+        'to', 'lua', 'tum', 'tr', 'tk', 'tw', 'ug', 'uk', 'ur', 'uz', 'vi', 'cy', 'wo', 'xh', 'yi', 'yo', 'zu'
+      ].include?(args[:lang].downcase)
+    end
+  end
+end

data/lib/metonym/lib/validators/gnews_query_validator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Validate
+  class GnewsQueryValidator < BaseValidator
+    COUNTRIES = %w[
+      af al dz as ad ao ai aq ag ar am aw au at az bs bh bd bb by
+      be bz bj bm bt bo ba bw bv br io bn bg bf bi kh cm ca cv ky
+      cf td cl cn cx cc co km cg cd ck cr ci hr cu cy cz dk dj dm
+      do ec eg sv gq er ee et fk fo fj fi fr gf pf tf ga gm ge de
+      gh gi gr gl gd gp gu gt gn gw gy ht hm va hn hk hu is in id
+      ir iq ie il it jm jp jo kz ke ki kp kr kw kg la lv lb ls lr
+      ly li lt lu mo mk mg mw my mv ml mt mh mq mr mu yt mx fm md
+      mc mn ms ma mz mm na nr np nl an nc nz ni ne ng nu nf mp no
+      om pk pw ps pa pg py pe ph pn pl pt pr qa re ro ru rw sh kn
+      lc pm vc ws sm st sa sn cs sc sl sg sk si sb so za gs sp lk
+      sd sr sj sz se ch sy tw tj tz th tl tg tk to tt tn tr tm tc
+      tv ug ua ae uk us um uy uz vu ve vn vg vi wf eh ye zm zw
+    ].freeze
+
+    def initialize(api_key, args:, format:)
+      raise 'API Key is required'        unless key_present?(api_key)
+      raise 'Invalid parameter sequence' unless query_valid?(args)
+      raise 'Invalid country sent'       unless country_valid?(args)
+      raise 'Invalid language sent'      unless language_valid?(args)
+      raise 'Invalid date or dates sent' unless date_valid?(args)
+
+      true
+    end
+
+    private
+
+    def query_valid?(args)
+      search_template   = %i[q max lang country mindate maxdate in]
+      top_news_template = %i[lang country max image]
+      template = search_template + top_news_template
+      (args.keys - template).empty?
+    end
+
+    def country_valid?(args)
+      args[:country].nil? ? true : COUNTRIES.include?(args[:country].downcase)
+    end
+
+    def date_valid?(args)
+      if args[:mindate].nil? && args[:maxdate].nil?
+        true
+      elsif args[:mindate] && args[:maxdate]
+        (args[:mindate].respond_to?(:strftime) && args[:maxdate].respond_to?(:strftime))
+      elsif args[:mindate] && args[:maxdate].nil?
+        args[:mindate].respond_to?(:strftime)
+      elsif args[:mindate].nil? && args[:maxdate]
+        args[:maxdate].respond_to?(:strftime)
+      end
+    end
+  end
+end

data/lib/metonym/lib/validators/news_api_query_validator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Validate
+  class NewsApiQueryValidator < BaseValidator
+    COUNTRIES   = %w[ar au at be br bg ca cn co cu cz eg fr de gr hk hu in id ie il it jp lv lt my mx ma nl nz ng no ph pl pt ro ru sa rs sg sk si za kr se ch tw th tr ae ua gb us ve].freeze
+    CATEGORIES  = %w[business entertainment general health science sports technology].freeze
+
+    def initialize(api_key, args:, format:, endpoint: nil)
+      raise 'API Key is required'        unless key_present?(api_key)
+      raise 'Invalid parameter sequence' unless query_valid?(args, endpoint)
+      raise 'Invalid country sent'       unless country_valid?(args)
+      raise 'Invalid language sent'      unless language_valid?(args)
+      raise 'Invalid date or dates sent' unless date_valid?(args)
+
+      true
+    end
+
+    private
+
+    def query_valid?(args, endpoint = 'top-headlines')
+      case endpoint
+      when 'top-headlines'
+        template = %i[q country category sources page_size page]
+      when 'everything'
+        template = %i[q sources domains excludeDomains
+                      from to language sortBy pageSize page]
+      when 'sources'
+        template = %i[category language country]
+      end
+
+      if endpoint == 'top-headlines' && (args.include?(:sources) && (args.include?(:country) || args.include?(:category)))
+        false
+      elsif (endpoint == 'sources') && args.key?(:category) && (CATEGORIES.include?(args[:category]) == false)
+        false
+      else
+        (args.keys - template).empty?
+      end
+    end
+
+    def country_valid?(args)
+      args[:country].nil? ? true : COUNTRIES.include?(args[:country].downcase)
+    end
+
+    def category_valid?(args)
+      template = %w[business entertainment general health science sports technology]
+      template.include?(args[:country])
+    end
+
+    def date_valid?(args)
+      if args[:from].nil? && args[:to].nil?
+        true
+      elsif args[:from] && args[:to]
+        (args[:from].respond_to?(:strftime) && args['to'].respond_to?(:strftime))
+      elsif args[:from] && args['to'].nil?
+        args[:from].respond_to?(:strftime)
+      elsif args[:from].nil? && args['to']
+        args[:from].respond_to?(:strftime)
+      end
+    end
+  end
+end