news_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f337c69630a74a785d7401def98479a1528ae40d
+  data.tar.gz: 59ed020d021f3735300e8a7946a5503bd31f5275
+SHA512:
+  metadata.gz: fa050a3443ed8d1eec61f25e63cadbafa0c9604dba816633b4a921091b38660396123abe28b27f04c7d4152490fa11342efff4235c6ee1e41b81e16e4e926b49
+  data.tar.gz: d27299581449b602c319eb477567ffe6bd54d3cb3a37df4a391cb512be3c34208311d7cb15586382943077fc2560579fc52fb15736fa592349af8610d592bb95

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.5
+
+Metrics/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in news_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    news_api (0.1.0)
+      api_struct (~> 0.1.0)
+      dry-configurable (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    api_struct (0.1.0)
+      dry-configurable (~> 0.7.0)
+      dry-monads (~> 0.3.1)
+      hashie (~> 3.5, >= 3.5.6)
+      http (>= 2.0.3)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-core (0.4.5)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.1)
+    dry-monads (0.3.1)
+      dry-core
+      dry-equalizer
+    hashie (3.5.7)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.0)
+    http_parser.rb (0.6.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  news_api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.55.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kirill Shevchenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# NewsApi
+
+An API wrapper for [News API v2](https://newsapi.org/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'news_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install news_api
+
+## Configuration
+
+Add setting with your [API key](https://newsapi.org/register).
+
+```ruby
+NewsApi::Settings.configure do |config|
+  config.api_key = 'your_api_key'
+end
+```
+
+## Usage
+
+News API has 2 main [endpoints](https://newsapi.org/docs/endpoints) and 1 minor endpoint.
+
+[Read more](https://newsapi.org/docs/endpoints) about required and available params.
+
+Each request below returns instance of [ApiStruct::Entity](https://github.com/rubygarage/api_struct#entity)
+
+### [Top headlines](https://newsapi.org/docs/endpoints/top-headlines)
+
+```ruby
+NewsApi::TopHeadliners.search(country: :us, pageSize: 2)
+```
+
+### [Everything](https://newsapi.org/docs/endpoints/everything)
+
+```ruby
+NewsApi::Everything.search(q: 'bitcoin', pageSize: 2)
+```
+
+### [Sources](https://newsapi.org/docs/endpoints/sources)
+
+```ruby
+NewsApi::Sources.search
+```
+
+## Errors handling
+
+Each result respond on methods `.failure?` and '.success?'.
+
+For example you have invalid API key:
+
+```ruby
+NewsApi::Settings.configure do |config|
+  config.api_key = 'fail_key'
+end
+
+NewsApi::Sources.search
+=> #<Hashie::Mash body=#<Hashie::Mash code="apiKeyInvalid" message="Your API key is invalid or incorrect. Check your key, or go to https://newsapi.org to create a free API key." status="error"> error=true status=#<HTTP::Response::Status 401 Unauthorized>>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kirillshevch/news_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'news_api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/news_api.rb

@@ -0,0 +1,20 @@
+require 'news_api/version'
+require 'api_struct'
+require 'dry-configurable'
+
+require 'news_api/settings'
+require 'news_api/api_struct_settings'
+
+require 'news_api/clients/top_headliners'
+require 'news_api/clients/everything'
+require 'news_api/clients/sources'
+
+require 'news_api/entities/article'
+require 'news_api/entities/source'
+
+require 'news_api/everything'
+require 'news_api/top_headliners'
+require 'news_api/sources'
+
+module NewsApi
+end

data/lib/news_api/api_struct_settings.rb

@@ -0,0 +1,10 @@
+ApiStruct::Settings.configure do |config|
+  config.endpoints = {
+    news_api: {
+      root: 'https://newsapi.org/v2',
+      headers: {
+        'X-Api-Key': NewsApi::Settings.config.api_key
+      }
+    }
+  }
+end

data/lib/news_api/clients/everything.rb

@@ -0,0 +1,11 @@
+module NewsApi
+  module Clients
+    class Everything < ApiStruct::Client
+      news_api :everything
+
+      def search(**options)
+        get(params: options)
+      end
+    end
+  end
+end

data/lib/news_api/clients/sources.rb

@@ -0,0 +1,11 @@
+module NewsApi
+  module Clients
+    class Sources < ApiStruct::Client
+      news_api :sources
+
+      def search(**options)
+        get(params: options)
+      end
+    end
+  end
+end

data/lib/news_api/clients/top_headliners.rb

@@ -0,0 +1,11 @@
+module NewsApi
+  module Clients
+    class TopHeadliners < ApiStruct::Client
+      news_api :'top-headlines'
+
+      def search(**options)
+        get(params: options)
+      end
+    end
+  end
+end

data/lib/news_api/entities/article.rb

@@ -0,0 +1,8 @@
+module NewsApi
+  module Entities
+    class Article < ApiStruct::Entity
+      attr_entity :source, :author, :title, :description, :url,
+                  :urlToImage, :publishedAt
+    end
+  end
+end

data/lib/news_api/entities/source.rb

@@ -0,0 +1,8 @@
+module NewsApi
+  module Entities
+    class Source < ApiStruct::Entity
+      attr_entity :id, :name, :description, :url, :category,
+                  :language, :country
+    end
+  end
+end

data/lib/news_api/everything.rb

@@ -0,0 +1,9 @@
+module NewsApi
+  class Everything < ApiStruct::Entity
+    client_service NewsApi::Clients::Everything
+
+    attr_entity :status, :'totalResults'
+
+    has_entities :articles, as: NewsApi::Entities::Article
+  end
+end

data/lib/news_api/settings.rb

@@ -0,0 +1,7 @@
+module NewsApi
+  class Settings
+    extend ::Dry::Configurable
+
+    setting :api_key, ''
+  end
+end

data/lib/news_api/sources.rb

@@ -0,0 +1,9 @@
+module NewsApi
+  class Sources < ApiStruct::Entity
+    client_service NewsApi::Clients::Sources
+
+    attr_entity :status
+
+    has_entities :sources, as: NewsApi::Entities::Source
+  end
+end

data/lib/news_api/top_headliners.rb

@@ -0,0 +1,9 @@
+module NewsApi
+  class TopHeadliners < ApiStruct::Entity
+    client_service NewsApi::Clients::TopHeadliners
+
+    attr_entity :status, :'totalResults'
+
+    has_entities :articles, as: NewsApi::Entities::Article
+  end
+end

data/lib/news_api/version.rb

@@ -0,0 +1,3 @@
+module NewsApi
+  VERSION = '0.1.0'
+end

data/news_api.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'news_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'news_api'
+  spec.version       = NewsApi::VERSION
+  spec.authors       = ['Kirill Shevchenko']
+  spec.email         = ['hello@kirillshevch.com']
+
+  spec.summary       = 'An API wrapper for News API v2'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/kirillshevch/news_api'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'api_struct', '~> 0.1.0'
+  spec.add_dependency 'dry-configurable', '~> 0.7.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.55.0'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: news_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirill Shevchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: api_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+description: An API wrapper for News API v2
+email:
+- hello@kirillshevch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/news_api.rb
+- lib/news_api/api_struct_settings.rb
+- lib/news_api/clients/everything.rb
+- lib/news_api/clients/sources.rb
+- lib/news_api/clients/top_headliners.rb
+- lib/news_api/entities/article.rb
+- lib/news_api/entities/source.rb
+- lib/news_api/everything.rb
+- lib/news_api/settings.rb
+- lib/news_api/sources.rb
+- lib/news_api/top_headliners.rb
+- lib/news_api/version.rb
+- news_api.gemspec
+homepage: https://github.com/kirillshevch/news_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: An API wrapper for News API v2
+test_files: []