luchadeer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b22250f9c3271c62347190dfd92e2e7789e39943
-  data.tar.gz: de1419a049fc0cea1271c07f1d050edd936ca0fc
+SHA256:
+  metadata.gz: f24bbcc0abbc0e797271da9f9cd00f0d1f6aa3b6119f1e663c59d1240885031f
+  data.tar.gz: c1a173ec9966a10fcff77ec484e9173323047c68fcd39986c3e45b3b9c8f0aab
 SHA512:
-  metadata.gz: cfefb61e51e347137953212ad823fb70875e049f8e07f44c5ed10e93a3a93f8a6162702aaf56f2839774c3c10d174ee11e59c78ea63bd64d70668c893c32aa22
-  data.tar.gz: 982ec4afd6c622a9868af1b05c8cc56b6f59ca15f4ebf62b27a21817063bdecb441aae48ed1e80e1c5b568a283546dfb615aea7160688c2ae05986c478a7fdea
+  metadata.gz: 1586bd13f33b1bd9888c4130fec1f32d3cceef388909855ac2f0ba8c51560c58e36aca96b925264824f40f1135cd96bb3ac97dadf48440700258c8a58ab19209
+  data.tar.gz: 810e8eecb979e6d1741c4c9e3b1e59fb47cd0ff0010108159a6aa8395e02181ca43d23317232cf3fb5a3625e3aaaa38d0149554e21a4657168d7dd222ac29274

data/.gitignore

@@ -12,6 +12,7 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+Gemfile.lock
 
 # YARD artifacts
 .yardoc

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
 
 script: bundle exec rspec

data/lib/luchadeer/client.rb

@@ -9,24 +9,17 @@ require 'luchadeer/middleware/parse_api_error'
 
 module Luchadeer
   class Client
+    GIANT_BOMB = 'http://www.giantbomb.com/api'
+
     include Luchadeer::API
 
     attr_accessor :api_key
-    GIANT_BOMB = 'http://www.giantbomb.com/api'
 
     def initialize(opts = {})
       @api_key = opts[:api_key] if opts[:api_key]
       yield self if block_given?
     end
 
-    def user_agent
-      "Luchadeer #{Luchadeer::VERSION}"
-    end
-
-    def api_key?
-      not (api_key.nil? || api_key == '')
-    end
-
     def get(path, params = {})
       request(:get, path, params)
     end
@@ -34,28 +27,18 @@ module Luchadeer
   private
 
     def connection
-      @_connection ||= Faraday.new(GIANT_BOMB, connection_options)
-    end
+      @_connection ||= Faraday.new(GIANT_BOMB, headers: headers) do |f|
+        f.response :parse_api_error
+        f.response :parse_json
+        f.response :parse_http_error
+        f.response :follow_redirects
 
-    def connection_options
-      {
-        builder: middleware,
-        headers: {
-          accept: 'application/json',
-          user_agent: user_agent,
-        }
-      }
+        f.adapter  :net_http
+      end
     end
 
-    def middleware
-      Faraday::RackBuilder.new do |builder| # order is important
-        builder.response :parse_api_error
-        builder.response :parse_json
-        builder.response :parse_http_error
-        builder.response :follow_redirects
-
-        builder.adapter  :net_http
-      end
+    def headers
+      { accept: 'application/json', user_agent: "Luchadeer v#{Luchadeer::VERSION}" }
     end
 
     def request(method, path, params = {})

data/lib/luchadeer/middleware/follow_redirects.rb

@@ -21,7 +21,7 @@ module Luchadeer
           if follow_redirect?(env, response)
             raise Luchadeer::Error::RedirectLimitReached, response if follows.zero?
 
-            env      = update_env(env, request_body, response)
+            env = update_env(env, request_body, response)
             response = follow_redirect(env, follows - 1)
           end
         end

data/lib/luchadeer/version.rb

@@ -1,3 +1,3 @@
 module Luchadeer
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/luchadeer.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'faraday', '~> 0.10'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'

data/spec/luchadeer/client_spec.rb

@@ -10,41 +10,21 @@ describe Luchadeer::Client do
     end
   end
 
-  describe '#user_agent' do
-    it 'identifies the library' do
-      expect(client.user_agent).to eq "Luchadeer #{Luchadeer::VERSION}"
-    end
-  end
-
-  describe '#api_key?' do
-    context 'when API key is present' do
-      it 'returns true' do
-        client.api_key = 'key'
-        expect(client.api_key?).to be_true
-      end
-    end
-
-    context 'when API key is not present' do
-      it 'returns false' do
-        client.api_key = ''
-        expect(client.api_key?).to be_false
-      end
-    end
-  end
-
   describe '#get' do
     let(:url) { %r(http://laika.io) }
+    let(:empty_body) { '{ }' }
 
     it 'makes a GET request' do
-      stub = stub_request(:get, url).to_return(body: '{ "asdf": "asdf" }')
+      stub = stub_request(:get, url).to_return(body: empty_body)
       client.get("http://laika.io")
 
       expect(stub).to have_been_requested
     end
 
     it 'adds default parameters' do
-      stub = stub_request(:get, url).with(format: 'json', api_key: api_key)
-        .to_return(body: '{ "asdf": "asdf" }')
+      stub = stub_request(:get, url)
+        .with(query: { format: 'json', api_key: api_key })
+        .to_return(body: empty_body)
 
       client.get("http://laika.io")
       expect(stub).to have_been_requested
@@ -56,4 +36,23 @@ describe Luchadeer::Client do
     end
   end
 
+  describe '#connection' do
+    describe 'user agent header' do
+      it 'identifies the library' do
+        expect(client.send(:connection).headers[:user_agent]).to eq "Luchadeer v#{Luchadeer::VERSION}"
+      end
+    end
+
+    describe 'middleware stack' do
+      it 'includes all custom middleware and the Net::HTTP adapter' do
+        expect(client.send(:connection).builder.handlers).to include \
+          Luchadeer::Middleware::ParseAPIError,
+          Luchadeer::Middleware::ParseJSON,
+          Luchadeer::Middleware::ParseHTTPError,
+          Luchadeer::Middleware::FollowRedirects,
+          Faraday::Adapter::NetHttp
+      end
+    end
+  end
+
 end

data/spec/luchadeer/middleware/follow_redirects_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Luchadeer::Middleware::FollowRedirects do
+  let(:response) { 'yay!' }
+
+  # adapted from:
+  # https://github.com/lostisland/faraday_middleware/blob/5a19d04a77650405a97ea0abc6152d23134b624e/spec/follow_redirects_spec.rb
+  [301, 302, 303, 307].each do |status|
+    it "follows redirects for responses with status #{status}" do
+      connection = Faraday.new do |f|
+        f.use described_class
+        f.adapter :test do |stub|
+          stub.get('/redirect') { [status, { 'Location' => '/found' }, ''] }
+          stub.get('/found')    { [200, { 'Content-Type' => 'text/plain' }, response] }
+        end
+      end
+
+      expect(connection.get('/redirect').body).to eq response
+    end
+  end
+
+  it 'raises a RedirectLimitReached after three redirects' do
+    connection = Faraday.new do |f|
+      f.use described_class
+      f.adapter :test do |stub|
+        stub.get('/')          { [301, {'Location' => '/redirect'}, ''] }
+        stub.get('/redirect')  { [301, {'Location' => '/redirect2'}, ''] }
+        stub.get('/redirect2') { [301, {'Location' => '/redirect3'}, ''] }
+        stub.get('/redirect3') { [301, {'Location' => '/found'}, ''] }
+        stub.get('/found')     { [200, {'Content-Type' => 'text/plain'}, 'fin'] }
+      end
+    end
+
+    expect { connection.get('/') }.to raise_error(Luchadeer::Error::RedirectLimitReached)
+  end
+
+end

data/spec/luchadeer/resource_spec.rb

@@ -55,7 +55,7 @@ describe Luchadeer::Resource do
 
       it 'fetches details and returns the new object' do
         stub_request(:get, %r(#{url})).to_return(body: '{ "results": { "detailed?": true } }')
-        expect(resource.detail.detailed?).to be_true
+        expect(resource.detail.detailed?).to be true
       end
     end
 

data/spec/luchadeer/search_spec.rb

@@ -174,15 +174,15 @@ describe Luchadeer::Search do
         search
       end
 
-      its([0]) { should be_instance_of Luchadeer::Character }
-      its([1]) { should be_instance_of Luchadeer::Company }
-      its([2]) { should be_instance_of Luchadeer::Concept }
-      its([3]) { should be_instance_of Luchadeer::Franchise }
-      its([4]) { should be_instance_of Luchadeer::Game }
-      its([5]) { should be_instance_of Luchadeer::Location }
-      its([6]) { should be_instance_of Luchadeer::Object }
-      its([7]) { should be_instance_of Luchadeer::Person }
-      its([8]) { should be_instance_of Luchadeer::Video }
+      it { expect(subject[0]).to be_instance_of Luchadeer::Character }
+      it { expect(subject[1]).to be_instance_of Luchadeer::Company }
+      it { expect(subject[2]).to be_instance_of Luchadeer::Concept }
+      it { expect(subject[3]).to be_instance_of Luchadeer::Franchise }
+      it { expect(subject[4]).to be_instance_of Luchadeer::Game }
+      it { expect(subject[5]).to be_instance_of Luchadeer::Location }
+      it { expect(subject[6]).to be_instance_of Luchadeer::Object }
+      it { expect(subject[7]).to be_instance_of Luchadeer::Person }
+      it { expect(subject[8]).to be_instance_of Luchadeer::Video }
     end
 
     context 'when the resource type isn\'t mapped' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luchadeer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Paul Friedman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-02 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,9 +103,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -125,6 +125,7 @@ files:
 - spec/luchadeer/api_spec.rb
 - spec/luchadeer/client_spec.rb
 - spec/luchadeer/error_spec.rb
+- spec/luchadeer/middleware/follow_redirects_spec.rb
 - spec/luchadeer/resource_spec.rb
 - spec/luchadeer/resources_spec.rb
 - spec/luchadeer/search_spec.rb
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The bombingest Giant Bomb API client library for Ruby.
@@ -160,6 +161,7 @@ test_files:
 - spec/luchadeer/api_spec.rb
 - spec/luchadeer/client_spec.rb
 - spec/luchadeer/error_spec.rb
+- spec/luchadeer/middleware/follow_redirects_spec.rb
 - spec/luchadeer/resource_spec.rb
 - spec/luchadeer/resources_spec.rb
 - spec/luchadeer/search_spec.rb
@@ -167,4 +169,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/shared_resource.rb
 - spec/support/shared_searchable.rb
-has_rdoc: 

data/Gemfile.lock

@@ -1,60 +0,0 @@
-PATH
-  remote: .
-  specs:
-    luchadeer (0.3.1)
-      faraday (~> 0.9.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.5)
-    coveralls (0.7.0)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    docile (1.1.3)
-    faraday (0.9.0)
-      multipart-post (>= 1.2, < 3)
-    mime-types (2.1)
-    multi_json (1.8.4)
-    multipart-post (2.0.0)
-    rake (10.1.1)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.5)
-    safe_yaml (1.0.1)
-    simplecov (0.8.2)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    thor (0.18.1)
-    tins (1.0.0)
-    webmock (1.17.2)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.5)
-  coveralls
-  luchadeer!
-  rake
-  rspec
-  webmock