metonym 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e81e54efd95bea0fd9fb3d0d60bd8ed7f9aa47446940fba655727deaf2fa540e
-  data.tar.gz: 0c8a8841e0bced4cad65b8f1c4a2916fd7d664d2aaafe2ecddcc67280f93bf4b
+  metadata.gz: 5a27e8f0d493acf4d9b4f731fa7c8a69559b6f693d29664c399db8c285cd1b8d
+  data.tar.gz: cd90c6e758930f31e110afcfdf30e3193cc506a584e872a207eb9876364a348b
 SHA512:
-  metadata.gz: 7d738e6519d6c63e0b63cbbb5e5b4b8ed89fdd583f216ec28c21b32fbe90f7980827b68046b267ac61740ee49877e07ea4af1ccc57a03a07a04818921aa124c2
-  data.tar.gz: 5cf2e7658dbca5e7d62f336f4cc084828e258dd82321d28547998a3b7ad2cfb5bbb078af673c930dfff35e1a1c1647202e66f65e12eb2eec65965147127a9185
+  metadata.gz: ddfe1458407ac402138b8a4d3e97edacb9f2a6857098c37b3370d5292f3357727bbe40499d003c0bbcea07b2ff80c4e1094d686b0e595856277a3bd69026fb5c
+  data.tar.gz: 5d8a2ac8eb71330aab43aaae3811fbbc7f6a402cc266c5605b14fa822267089c6d5209ef5266896f61feace244357ebc66c649745124e3113c00091a9e20e704

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metonym (0.1.0)
+    metonym (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Metonym
 
-A ruby gem for [GNews API](https://gnews.io)
+A ruby gem for [GNews API](https://gnews.io) and [NewsApi](https://newsapi.org/)
 
 
 ## Installation
@@ -23,7 +23,9 @@ Or install it yourself as:
 
 To be able to send requests to the GNews API, you first must create an account to receive a token [here](https://gnews.io/register.php).
 
-## Query
+To be able to send requests to NewsApi, you first must create an account to receive a token [here](https://newsapi.org/).
+
+## Query Gnews API
 ```ruby
 # Establish parameters for query
 args = { "q" => "Dragon Ball Super", "country" => "MX", "mindate" => (DateTime.now - 2), 'max' => 1 }
@@ -99,6 +101,188 @@ MydvTAug0D-dSSDfZDG9oywTEcfQXsWXtzBHULFJzLYwJDjmnxza=-c"
 |  maxdate	    |  Optional (Date/DateTime)                 | Get articles that are less recent than the max date
 |  in 	        |  Optional 	                            | Get articles that contains q in the specified article section
 
+## Query NewsApi
+
+### Top Headlines
+Source: [NewsApi documentation.](https://www.newsapi.org/docs/endpoints)
+
+> Returns breaking news headlines for a country and category, or currently running on a single or multiple sources. This is perfect for use with news tickers or anywhere you want to display live up-to-date news headlines and images. 
+
+```ruby
+args = { "q" => "Brexit", "country" => "DE" }
+
+news = NewsApi::Query.new("my-secret-key")
+
+response = news.top_headlines(args)
+
+# =>
+```
+```json
+{  
+   "status":"ok",
+   "totalResults":1,
+   "articles":[  
+      {  
+         "source":{  
+            "id":null,
+            "name":"Faz.net"
+         },
+         "author":"Klaus-Dieter Frankenberger",
+         "title":"Brexit-Opfer - FAZ - Frankfurter Allgemeine Zeitung",
+         "description":"Das Brexit-Thema wurde May wie zuvor schon Cameron zum politischen Verhängnis  – und es ist eine Last, die auch die kommende Regierung nicht einfach abschütteln kann. Die EU allerdings auch nicht.",
+         "url":"https://www.faz.net/aktuell/brexit/theresa-may-ist-wie-david-cameron-zum-brexit-opfer-geworden-16204205.html",
+         "urlToImage":"https://media1.faz.net/ppmedia/aktuell/112808907/1.6204201/facebook_teaser/theresa-may-am-freitag-bei.jpg",
+         "publishedAt":"2019-05-24T11:07:00Z",
+         "content":"David Cameron führt die Liste der Brexit-Opfer an, und nun wird auch seine Nachfolgerin einen Platz darauf finden, zunächst, am 7. Juni, als Parteichefin der Konservativen, etwas später dann auch als Premierministerin. Cameron trat zurück, weil er seine Absti… [+2771 chars]"
+      }
+   ]
+}
+```
+
+#### Search Parameters for *Top Headlines*
+| Parameter 	| Info/Description                              | Additional Notes
+|---	         |---	                                          |---
+|  q	         |  Required                                     |Keywords or a phrase to search for.
+|  country     |  The 2-letter ISO 3166-1 code of the country  |You can't mix this param with the *sources* param.
+|  category    |  Options: *business, entertainment, general, health, science, sports, technology* |You can't mix this param with the *sources* param.
+|  sources     |  A comma-seperated string of identifiers for the news sources or blogs you want headlines from |You can't mix this param with the country or category params.
+|  pageSize	   |  The number of results to return per page (request). 20 is the default, 100 is the maximum. |
+|  page  	   |  Use this to page through the results if the total results found is greater than the page size. |     
+
+### Everything
+Source: [NewsApi documentation.](https://www.newsapi.org/docs/endpoints)
+
+
+> We index every recent news and blog article published by over 30,000 different sources large and small, and you can search through them with this endpoint. This endpoint is better suited for news analysis and article discovery, but can be used to retrieve articles for display too.
+
+```ruby
+args = { "q" => "Huawei", "from" => (DateTime.now - 2)}
+
+news = NewsApi::Query.new('my-secret-key')
+
+response = news.everything(args)
+
+# =>
+```
+
+```json
+{  
+   "status":"ok",
+   "totalResults":4599,
+   "articles":[  
+      {  
+         "source":{  
+            "id":"techcrunch",
+            "name":"TechCrunch"
+         },
+         "author":"Catherine Shu",
+         "title":"Semiconductor startup CNEX Labs alleged Huawei’s deputy chairman conspired to steal its intellectual property",
+         "description":"A San Jose-based semiconductor startup being sued by Huawei for stealing trade secrets has hit back in court documents, accusing the Chinese firm’s deputy chairman of conspiring to steal its intellectual property, reports the Wall Street Journal. In court fil…",
+         "url":"http://techcrunch.com/2019/05/22/semiconductor-startup-cnex-labs-alleged-huaweis-deputy-chairman-conspired-to-steal-its-intellectual-property/",
+         "urlToImage":"https://techcrunch.com/wp-content/uploads/2019/05/GettyImages-1150756100.jpg?w=600",
+         "publishedAt":"2019-05-23T06:01:44Z",
+         "content":"A San Jose-based semiconductor startup being sued by Huawei for stealing trade secrets has hit back in court documents, accusing the Chinese firms deputy chairman of conspiring to steal its intellectual property, reports the Wall Street Journal. In court fili… [+3077 chars]"
+      }
+   ]
+}
+```
+#### Search Parameters for *Everything*
+| Parameter 	| Info/Description                              | Additional Notes
+|---	         |---	                                          |---
+|  q	         |Required                                       |Keywords or a phrase to search for.
+|  sources     |A comma-seperated string of identifiers (maximum 20) for the news sources or blogs you want headlines from.      |
+|  domains     |A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.      |
+|  excludeDomains|A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.   |
+|  from  	   |A date and optional time for the oldest article allowed. This should be in ISO 8601 format.                      |
+|  to      	   |A date and optional time for the newest article allowed. This should be in ISO 8601 format                       |     
+|  language	   |The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: *ar de en es fr he it nl no pt ru se ud zh*. |Default: All languages returned 
+|  sortBy  	   |Options: *relevancy, popularity, publishedAt.*                                     |Default: publishedAt 
+|  pageSize	   |The number of results to return per page. 20 is the default, 100 is the maximum.   |     
+|  page  	   |Use this to page through the results.                                              |     
+
+
+
+### Sources
+Source: [NewsApi documentation.](https://www.newsapi.org/docs/endpoints)
+
+> Returns information (including name, description, and category) about the most notable sources we index. This list could be piped directly through to your users when showing them some of the options available.
+
+```ruby
+news = NewsApi::Query.new("my-secret-key")
+response = news.sources(args)
+
+# =>
+```
+
+
+```json
+{  
+   "status":"ok",
+   "sources":[  
+      {  
+         "id":"abc-news",
+         "name":"ABC News",
+         "description":"Your trusted source for breaking news, analysis, exclusive interviews, headlines, and videos at ABCNews.com.",
+         "url":"https://abcnews.go.com",
+         "category":"general",
+         "language":"en",
+         "country":"us"
+      },
+      {  
+         "id":"abc-news-au",
+         "name":"ABC News (AU)",
+         "description":"Australia's most trusted source of local, national and world news. Comprehensive, independent, in-depth analysis, the latest business, sport, weather and more.",
+         "url":"http://www.abc.net.au/news",
+         "category":"general",
+         "language":"en",
+         "country":"au"
+      },
+   ]
+}
+
+```
+
+#### Search Parameters for *Sources*
+| Parameter 	| Info/Description                              
+|---	         |---	                                          
+|  country     |Find sources that display news in a specific country
+|  category    | Options: *business, entertainment, general, health, science, sports, technology* |
+|  language    |The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: *ar de en es fr he it nl no pt ru se ud zh*
+
+## Format
+Additionaly, just like with the Gnews module, you may send a second parmeter to specify the format you may want to receive the response.
+
+Supported types: **json** and **hash**
+
+```ruby
+args = { "q" => "Brexit", "country" => "DE" }
+
+news = NewsApi::Query.new("my-secrety-key")
+
+response = news.top_headlines(args, 'hash')
+# =>
+{
+   "status"=>"ok", 
+   "totalResults"=>1, 
+   "articles"=>[
+      {
+         "source"=> {
+            "id"=>nil, 
+            "name"=>"Tagesschau.de"
+         }, 
+         "author"=>"tagesschau.de", 
+         "title"=>"Mays Rücktritt: \"Sie hätte Nationalheldin werden können\" - tagesschau.de", "description"=>"Premierministerin May wollte den Brexit mit aller Kraft. Doch nun hat sie überraschend emotional aufgegeben. Ihre möglichen Nachfolger bringen sich schon in Stellung. Von Imke Köhler.", 
+         "url"=>"https://www.tagesschau.de/ausland/may-ruecktritt-103.html", 
+         "urlToImage"=>"https://www.tagesschau.de/multimedia/bilder/may-741~_v-videowebm.jpg", 
+         "publishedAt"=>"2019-05-24T15:52:00Z", 
+         "content"=>"Premierministerin May wollte den Brexit mit aller Kraft. Doch nun hat sie überraschend emotional aufgegeben. Ihre möglichen Nachfolger bringen sich schon in Stellung. \r\nVon Imke Köhler, ARD-Studio London\r\n Theresa May hat selten Gefühle gezeigt in den vergang…"
+   ]
+}
+
+
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/viccarrasco/metonym. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/metonym/lib/gnews.rb

@@ -7,17 +7,18 @@ module Gnews
         def initialize(key, version = nil)
             @gnews_api_key = key
             @gnews_version = version.nil? ? 'v2' : version
-            @uri = URI('https://gnews.io/api/v2/')
+            @uri = URI("https://gnews.io/api/#{@gnews_version}/")
         end
 
         def search(args, format = 'json')
             begin
-                v = Gnews::Validate.new
+                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)

data/lib/metonym/lib/news_api.rb

@@ -0,0 +1,65 @@
+module NewsApi
+    class Query
+        attr_accessor :news_api_key
+        attr_accessor :news_api_version
+        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 top_headlines(args, format = 'json')
+            uri = URI("#{@uri}/top-headlines")
+            return request(args, format, uri, 'top-headlines')
+        end
+
+        def everything(args, format = 'json')
+            uri = URI("#{@uri}/everything")
+            return request(args, format, uri, 'everything')
+        end
+
+        def sources(args, format = 'json')
+            uri = URI("#{@uri}/sources")
+            return request(args, format, uri, 'sources')
+        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)
+
+                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 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
+    end
+end

data/lib/metonym/lib/validate.rb

@@ -1,14 +1,9 @@
-module Gnews
-    class Validate
-        def is_key_present?(args)
+module Validate
+    class Validator
+         def is_key_present?(args)
             return !args.nil?
         end
 
-        def is_query_valid?(args)
-            template = %w(q max lang country mindate maxdate in)
-            return (args.keys - template).empty?
-        end
-
         def is_language_valid?(args)
             if args['lang'].nil?
                 true
@@ -25,24 +20,43 @@ module Gnews
             end
         end
 
+        def is_format_valid?(args)
+            template = %w(json hash)
+            
+            if args.nil?
+                true
+            else
+                template.include?(args.downcase)
+            end
+        end
+    end
+
+    class GnewsValidator < Validator
+        COUNTRIES = [
+            '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'
+        ]
+
+        def is_query_valid?(args)
+            template = %w(q max lang country mindate maxdate in)
+            return (args.keys - template).empty?
+        end
+
         def is_country_valid?(args)
             if args['country'].nil?
                 true
             else
-                return [
-                    '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'
-                ].include?(args['country'].downcase)
+                return COUNTRIES.include?(args['country'].downcase)
             end
         end
 
@@ -58,4 +72,53 @@ module Gnews
             end
         end
     end
+
+    class NewsApiValidator < Validator
+        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)
+        CATEGORIES  = %w(business entertainment general health science sports technology)
+
+        def is_query_valid?(args, endpoint = 'top-headlines')
+            case endpoint
+            when 'top-headlines'
+                template = %w(q country category sources page_size page)
+            when 'everything'
+                template = %w(q sources domains excludeDomains from to language sortBy pageSize page)
+            when 'sources'
+                template = %w(category language country)
+            end
+
+            if (endpoint == 'top-headlines' && (args.include?('sources') && (args.include?('country') || args.include?('category'))))
+                false
+            elsif (endpoint == "sources") && (args.has_key?("category")) && (CATEGORIES.include?(args["category"]) == false)
+                false
+            else
+                (args.keys - template).empty?
+            end
+        end
+
+        def is_country_valid?(args)
+            if args['country'].nil?
+                true
+            else
+                return COUNTRIES.include?(args['country'].downcase)
+            end
+        end
+
+        def is_category_valid?(args)
+            template = %w(business entertainment general health science sports technology)
+            return template.include?(args['country'])
+        end
+
+        def is_date_valid?(args)
+            if (args['from'].nil? && args['to'].nil?)
+                true
+            elsif (args['from'] && args['to'])
+                return (args['from'].respond_to?(:strftime) && args['to'].respond_to?(:strftime))
+            elsif (args['from'] && args['to'].nil?)
+                return args['from'].respond_to?(:strftime)
+            elsif (args['from'].nil? && args['to'])
+                return args['from'].respond_to?(:strftime)
+            end
+        end
+    end
 end

data/lib/metonym/version.rb

@@ -1,3 +1,3 @@
 module Metonym
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/metonym.rb

@@ -3,6 +3,7 @@ require 'date'
 require 'net/http'
 require 'metonym/lib/gnews.rb'
 require 'metonym/lib/validate.rb'
+require 'metonym/lib/news_api.rb'
 require 'byebug'
 require 'json'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metonym
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Vic Carrasco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ files:
 - bin/setup
 - lib/metonym.rb
 - lib/metonym/lib/gnews.rb
+- lib/metonym/lib/news_api.rb
 - lib/metonym/lib/validate.rb
 - lib/metonym/version.rb
 - metonym.gemspec