luchadeer 0.1.0

data/spec/luchadeer/error_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Luchadeer::Error do
+
+  describe '.api_errors' do
+    let(:ok)         { Luchadeer::Error::Codes::OK }
+    let(:error_code) { Luchadeer::Error::Codes::INVALID_API_KEY }
+    let(:exception)  { Luchadeer::Error::InvalidAPIKey }
+
+    it 'returns a hash' do
+      expect(described_class.api_errors).to respond_to :[]
+    end
+
+    it 'maps API error codes to exceptions' do
+      expect(described_class.api_errors[error_code]).to eq exception
+    end
+
+    it 'does not map "OK" to an exception' do
+      expect(described_class.api_errors[ok]).to be_nil
+    end
+  end
+
+  describe '.http_errors' do
+    let(:error_code) { 404 }
+    let(:exception)  { Luchadeer::Error::NotFound }
+
+    it 'returns a hash' do
+      expect(described_class.http_errors).to respond_to :[]
+    end
+
+    it 'maps HTTP status codes to exceptions' do
+      expect(described_class.http_errors[error_code]).to eq exception
+    end
+
+    it 'does not map 200' do
+      expect(described_class.http_errors[200]).to be_nil
+    end
+  end
+
+  describe '#initialize' do
+    let(:message) { 'testing' }
+    let(:error) { described_class.new(message) }
+
+    it 'is raiseable' do
+      expect(error).to be_a StandardError
+    end
+
+    it 'constructs with message and status' do
+      expect(error.message).to eq message
+    end
+  end
+
+end

data/spec/luchadeer/franchise_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Luchadeer::Franchise do
+
+  it 'is a resource' do
+    expect(described_class.new).to be_a Luchadeer::Resource
+  end
+
+  describe '.find' do
+    let(:client) { Luchadeer::Client.new }
+
+    before :each do
+      Luchadeer.client = client
+    end
+
+    it 'forwards to Client#franchise with arguments' do
+      expect(client).to receive(:franchise).with(1, true)
+      described_class.find(1, true)
+    end
+
+    it 'forwards to Client#franchise with default refresh' do
+      expect(client).to receive(:franchise).with(1, false)
+      described_class.find(1)
+    end
+  end
+
+end

data/spec/luchadeer/game_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Luchadeer::Game do
+
+  it 'is a resource' do
+    expect(described_class.new).to be_a Luchadeer::Resource
+  end
+
+  describe '.find' do
+    let(:client) { Luchadeer::Client.new }
+
+    before :each do
+      Luchadeer.client = client
+    end
+
+    it 'forwards to Client#game with arguments' do
+      expect(client).to receive(:game).with(1, true)
+      described_class.find(1, true)
+    end
+
+    it 'forwards to Client#game with default refresh' do
+      expect(client).to receive(:game).with(1, false)
+      described_class.find(1)
+    end
+  end
+
+end

data/spec/luchadeer/location_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Luchadeer::Location do
+
+  it 'is a resource' do
+    expect(described_class.new).to be_a Luchadeer::Resource
+  end
+
+  describe '.find' do
+    let(:client) { Luchadeer::Client.new }
+
+    before :each do
+      Luchadeer.client = client
+    end
+
+    it 'forwards to Client#location with arguments' do
+      expect(client).to receive(:location).with(1, true)
+      described_class.find(1, true)
+    end
+
+    it 'forwards to Client#location with default refresh' do
+      expect(client).to receive(:location).with(1, false)
+      described_class.find(1)
+    end
+  end
+
+end

data/spec/luchadeer/object_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Luchadeer::Object do
+
+  it 'is a resource' do
+    expect(described_class.new).to be_a Luchadeer::Resource
+  end
+
+  describe '.find' do
+    let(:client) { Luchadeer::Client.new }
+
+    before :each do
+      Luchadeer.client = client
+    end
+
+    it 'forwards to Client#object with arguments' do
+      expect(client).to receive(:object).with(1, true)
+      described_class.find(1, true)
+    end
+
+    it 'forwards to Client#object with default refresh' do
+      expect(client).to receive(:object).with(1, false)
+      described_class.find(1)
+    end
+  end
+
+end

data/spec/luchadeer/person_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Luchadeer::Person do
+
+  it 'is a resource' do
+    expect(described_class.new).to be_a Luchadeer::Resource
+  end
+
+  describe '.find' do
+    let(:client) { Luchadeer::Client.new }
+
+    before :each do
+      Luchadeer.client = client
+    end
+
+    it 'forwards to Client#person with arguments' do
+      expect(client).to receive(:person).with(1, true)
+      described_class.find(1, true)
+    end
+
+    it 'forwards to Client#person with default refresh' do
+      expect(client).to receive(:person).with(1, false)
+      described_class.find(1)
+    end
+  end
+
+end

data/spec/luchadeer/resource_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Luchadeer::Resource do
+  let(:hash) { { first_name: 'Chie', last_name: 'Satonaka', age: 16 } }
+  let(:resource) { described_class.new(hash) }
+
+  describe '#initialize' do
+    it 'generates ostruct accessors for its keys' do
+      expect(resource.first_name).to eq hash[:first_name]
+      expect(resource.last_name).to eq hash[:last_name]
+      expect(resource.age).to eq hash[:age]
+    end
+
+    it 'returns nil for non-existent keys' do
+      expect(resource.foo).to be_nil
+    end
+
+    context 'with nested hashes as values' do
+      let(:nested) { hash.merge(nested: hash) }
+      let(:nested_resource) { described_class.new(nested) }
+
+      it 'recursively generates resource objects for nested hashes' do
+        expect(nested_resource.nested).to be_a Luchadeer::Resource
+      end
+    end
+
+    context 'with arrays as values' do
+      let(:arrayed) { hash.merge(arrayed: [{ test: "array" }]) }
+      let(:arrayed_resource) { described_class.new(arrayed) }
+
+      it 'recursively generates resource objects inside nested arrays' do
+        expect(arrayed_resource.arrayed[0]).to be_a Luchadeer::Resource
+      end
+    end
+  end
+
+  describe '#to_h' do
+    it 'returns a hash' do
+      expect(described_class.new(hash).to_h).to be_a Hash
+    end
+
+    it 'returns a hash representation of the object' do
+      expect(described_class.new(hash).to_h).to eq hash
+    end
+  end
+
+  describe '#detail' do
+    before :each do
+      Luchadeer.client = Luchadeer::Client.new
+    end
+
+    context 'when api_detail_url is present' do
+      let(:url) { 'http://www.giantbomb.com/api/game-3030/1' }
+      let(:resource) { described_class.new(api_detail_url: url) }
+
+      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
+      end
+    end
+
+    context 'when api_detail_url is not present' do
+      let(:resource) { described_class.new }
+
+      it 'returns the original object' do
+        expect(resource.detail).to eq resource
+      end
+    end
+  end
+end

data/spec/luchadeer/search_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Luchadeer::Search do
+  let(:query) { 'Chie Satonaka' }
+  let(:search_path) { %r(#{Luchadeer::Client::GIANT_BOMB}/search) }
+
+  describe '#initialize' do
+    it 'instantiates with a search query' do
+      expect(described_class.new(query).query).to eq query
+    end
+  end
+
+  describe '#fetch' do
+    before :each do
+      Luchadeer.client = Luchadeer::Client.new
+    end
+
+    it 'queries the Giant Bomb search API' do
+      stub = stub_request(:get, search_path).to_return(body: '{ "results": [] }')
+
+      described_class.new(query).fetch
+      expect(stub).to have_been_requested
+    end
+
+    describe 'generates the proper class based on the result type' do
+      subject do
+        stub_request(:get, search_path).to_return(body:
+                            '{ "results": [
+                                {"resource_type": "character"},
+                                {"resource_type": "company"},
+                                {"resource_type": "concept"},
+                                {"resource_type": "franchise"},
+                                {"resource_type": "game"},
+                                {"resource_type": "location"},
+                                {"resource_type": "object"},
+                                {"resource_type": "person"},
+                                {"resource_type": "video"}
+                            ] }')
+        described_class.new(query).fetch
+      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 }
+    end
+
+    context 'when there are no results' do
+      it 'returns an empty array' do
+        stub_request(:get, search_path).to_return(body:
+          '{ "results": [{ "resource_type": "banana"}] }')
+        expect(described_class.new(query).fetch).to eq []
+      end
+    end
+
+    context 'when the resource type isn\'t mapped' do
+      it 'skips modeling the resource' do
+        stub_request(:get, search_path).to_return(body: '{ "results": [] }')
+        expect(described_class.new(query).fetch).to eq []
+      end
+    end
+  end
+
+end

data/spec/luchadeer/video_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Luchadeer::Video do
+
+  it 'is a resource' do
+    expect(described_class.new).to be_a Luchadeer::Resource
+  end
+
+  describe '.find' do
+    let(:client) { Luchadeer::Client.new }
+
+    before :each do
+      Luchadeer.client = client
+    end
+
+    it 'forwards to Client#video with arguments' do
+      expect(client).to receive(:video).with(1, true)
+      described_class.find(1, true)
+    end
+
+    it 'forwards to Client#video with default refresh' do
+      expect(client).to receive(:video).with(1, false)
+      described_class.find(1)
+    end
+  end
+
+end

data/spec/luchadeer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Luchadeer do
+  let(:api_key) { 'VinnCo' }
+
+  describe '.configure' do
+    it 'returns a Luchadeer::Client' do
+      expect(described_class.configure).to be_instance_of Luchadeer::Client
+    end
+
+    it 'passes opts hash to the new client' do
+      hash = { api_key: api_key }
+
+      expect(described_class.configure(hash).api_key).to eq api_key
+    end
+
+    it 'passes the given block to the new client' do
+      proc = Proc.new { |c| c.api_key = api_key }
+
+      expect(described_class.configure(&proc).api_key).to eq api_key
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'luchadeer'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: luchadeer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Friedman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- paulrfri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/luchadeer.rb
+- lib/luchadeer/api.rb
+- lib/luchadeer/api/characters.rb
+- lib/luchadeer/api/companies.rb
+- lib/luchadeer/api/concepts.rb
+- lib/luchadeer/api/franchises.rb
+- lib/luchadeer/api/games.rb
+- lib/luchadeer/api/locations.rb
+- lib/luchadeer/api/objects.rb
+- lib/luchadeer/api/people.rb
+- lib/luchadeer/api/videos.rb
+- lib/luchadeer/character.rb
+- lib/luchadeer/client.rb
+- lib/luchadeer/company.rb
+- lib/luchadeer/concept.rb
+- lib/luchadeer/error.rb
+- lib/luchadeer/franchise.rb
+- lib/luchadeer/game.rb
+- lib/luchadeer/location.rb
+- lib/luchadeer/middleware/follow_redirects.rb
+- lib/luchadeer/middleware/parse_api_error.rb
+- lib/luchadeer/middleware/parse_http_error.rb
+- lib/luchadeer/middleware/parse_json.rb
+- lib/luchadeer/object.rb
+- lib/luchadeer/person.rb
+- lib/luchadeer/resource.rb
+- lib/luchadeer/search.rb
+- lib/luchadeer/version.rb
+- lib/luchadeer/video.rb
+- luchadeer.gemspec
+- spec/luchadeer/api/characters_spec.rb
+- spec/luchadeer/api/companies_spec.rb
+- spec/luchadeer/api/concepts_spec.rb
+- spec/luchadeer/api/franchises_spec.rb
+- spec/luchadeer/api/games_spec.rb
+- spec/luchadeer/api/locations_spec.rb
+- spec/luchadeer/api/objects_spec.rb
+- spec/luchadeer/api/people_spec.rb
+- spec/luchadeer/api/videos_spec.rb
+- spec/luchadeer/api_spec.rb
+- spec/luchadeer/character_spec.rb
+- spec/luchadeer/client_spec.rb
+- spec/luchadeer/company_spec.rb
+- spec/luchadeer/concept_spec.rb
+- spec/luchadeer/error_spec.rb
+- spec/luchadeer/franchise_spec.rb
+- spec/luchadeer/game_spec.rb
+- spec/luchadeer/location_spec.rb
+- spec/luchadeer/object_spec.rb
+- spec/luchadeer/person_spec.rb
+- spec/luchadeer/resource_spec.rb
+- spec/luchadeer/search_spec.rb
+- spec/luchadeer/video_spec.rb
+- spec/luchadeer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/paulfri/luchadeer
+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.2.1
+signing_key: 
+specification_version: 4
+summary: The bombingest Giant Bomb API client library for Ruby.
+test_files:
+- spec/luchadeer/api/characters_spec.rb
+- spec/luchadeer/api/companies_spec.rb
+- spec/luchadeer/api/concepts_spec.rb
+- spec/luchadeer/api/franchises_spec.rb
+- spec/luchadeer/api/games_spec.rb
+- spec/luchadeer/api/locations_spec.rb
+- spec/luchadeer/api/objects_spec.rb
+- spec/luchadeer/api/people_spec.rb
+- spec/luchadeer/api/videos_spec.rb
+- spec/luchadeer/api_spec.rb
+- spec/luchadeer/character_spec.rb
+- spec/luchadeer/client_spec.rb
+- spec/luchadeer/company_spec.rb
+- spec/luchadeer/concept_spec.rb
+- spec/luchadeer/error_spec.rb
+- spec/luchadeer/franchise_spec.rb
+- spec/luchadeer/game_spec.rb
+- spec/luchadeer/location_spec.rb
+- spec/luchadeer/object_spec.rb
+- spec/luchadeer/person_spec.rb
+- spec/luchadeer/resource_spec.rb
+- spec/luchadeer/search_spec.rb
+- spec/luchadeer/video_spec.rb
+- spec/luchadeer_spec.rb
+- spec/spec_helper.rb