luchadeer 0.2.0 → 0.3.0

data/spec/luchadeer/resources_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+Luchadeer::API::RESOURCES.each do |resource|
+  describe(resource) { it_behaves_like 'a resource' } # spec/support/shared_resource.rb
+  describe(resource) { it_behaves_like 'a searchable resource' } # spec/support/shared_searchable.rb
+end

data/spec/luchadeer_spec.rb

@@ -5,18 +5,15 @@ describe Luchadeer do
 
   describe '.configure' do
     it 'returns a Luchadeer::Client' do
-      expect(described_class.configure).to be_instance_of Luchadeer::Client
+      expect(described_class.configure).to be_a 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
+      expect(described_class.configure(api_key: api_key).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 }
-
+      proc = ->(c) { c.api_key = api_key }
       expect(described_class.configure(&proc).api_key).to eq api_key
     end
   end

data/spec/spec_helper.rb

@@ -3,3 +3,6 @@ Coveralls.wear!
 
 require 'luchadeer'
 require 'webmock/rspec'
+
+require 'support/shared_resource'
+require 'support/shared_searchable'

data/spec/support/shared_resource.rb

@@ -0,0 +1,40 @@
+shared_examples 'a resource' do
+  let(:singular) { described_class::SINGULAR }
+  let(:plural)   { described_class::PLURAL }
+  let(:client) { Luchadeer::Client.new }
+
+  before :each do
+    Luchadeer.client = client
+  end
+
+  it 'is a Luchadeer::Resource' do
+    expect(described_class.new).to be_a Luchadeer::Resource
+  end
+
+  describe '.find' do
+    it "forwards to the client find method with arguments" do
+      expect(client).to receive(singular).with(1, true)
+      described_class.find(1, true)
+    end
+
+    it "forwards to the client find method with default refresh" do
+      expect(client).to receive(singular).with(1, false)
+      described_class.find(1)
+    end
+  end
+
+  describe '.search' do
+    let(:query)  { 'chie' }
+
+    it "forwards to the client search method with arguments" do
+      expect(client).to receive(plural).with(query, true)
+      described_class.search(query, true)
+    end
+
+    it "forwards to the client search method with default refresh" do
+      expect(client).to receive(plural).with(query, false)
+      described_class.search(query)
+    end
+  end
+
+end

data/spec/support/shared_searchable.rb

@@ -0,0 +1,65 @@
+# Invoke this shared example group with a let statement passed in a block:
+# let(:described_class) { ... }, the Luchadeer resource class that maps to the resource
+
+shared_examples 'a searchable resource' do
+  let(:client) { Luchadeer::Client.new }
+
+  describe 'find method' do
+    let(:find) { described_class::SINGULAR }
+    let(:id)   { 14850 }
+    let(:path) { %r(#{Luchadeer::Client::GIANT_BOMB}/#{find}/#{described_class::RESOURCE_ID}-#{id}) }
+
+    it 'requests the right url' do
+      stub = stub_request(:get, path).to_return(body: '{ }')
+      client.send(find, "#{id}")
+      expect(stub).to have_been_requested
+    end
+
+    it 'returns the proper type of resource' do
+      stub_request(:get, path).to_return(body: '{ "results": { "key": "value"}}')
+      expect(client.send(find, "#{id}")).to be_instance_of described_class
+    end
+
+    it 'caches responses' do
+      stub_request(:get, path).to_return(body: '{ }')
+      expect(client).to receive :cache
+      client.send(find, "#{id}")
+    end
+  end
+
+  describe 'search method' do
+    let(:search) { described_class::PLURAL }
+    let(:query) { 'chie' }
+    let(:path)  { %r(#{Luchadeer::Client::GIANT_BOMB}/#{search}) }
+
+    context 'when invoked with a query' do
+      it 'requests the right url' do
+        stub = stub_request(:get, path)
+          .with(query: hash_including(filter: "name:#{query}"))
+          .to_return(body: '{ }')
+        client.send(search, query)
+        expect(stub).to have_been_requested
+      end
+    end
+
+    context 'when invoked without a query' do
+      it 'requests the right url' do
+        stub = stub_request(:get, path).to_return(body: '{ }')
+        client.send(search)
+        expect(stub).to have_been_requested
+      end
+    end
+
+    it 'returns the proper type of resource' do
+      stub_request(:get, path).to_return(body: '{ "results": { "key": "value"}}')
+      expect(client.send(search, query)).to be_instance_of described_class
+    end
+
+    it 'caches responses' do
+      stub_request(:get, path).to_return(body: '{ }')
+      expect(client).to receive :cache
+      client.send(search, query)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luchadeer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Paul Friedman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -111,59 +111,27 @@ files:
 - 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/resources.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/resources_spec.rb
 - spec/luchadeer/search_spec.rb
-- spec/luchadeer/video_spec.rb
 - spec/luchadeer_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_resource.rb
+- spec/support/shared_searchable.rb
 homepage: https://github.com/paulfri/luchadeer
 licenses:
 - MIT
@@ -184,33 +152,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 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/resources_spec.rb
 - spec/luchadeer/search_spec.rb
-- spec/luchadeer/video_spec.rb
 - spec/luchadeer_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_resource.rb
+- spec/support/shared_searchable.rb
+has_rdoc: 

data/lib/luchadeer/api/characters.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Characters
-
-      def character(id, refresh = false)
-        fetch("character/3005-#{id}", refresh, Luchadeer::Character)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/companies.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Companies
-
-      def company(id, refresh = false)
-        fetch("company/3010-#{id}", refresh, Luchadeer::Company)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/concepts.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Concepts
-
-      def concept(id, refresh = false)
-        fetch("concept/3015-#{id}", refresh, Luchadeer::Concept)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/franchises.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Franchises
-
-      def franchise(id, refresh = false)
-        fetch("franchise/3025-#{id}", refresh, Luchadeer::Franchise)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/games.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Games
-
-      def game(id, refresh = false)
-        fetch("game/3030-#{id}", refresh, Luchadeer::Game)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/locations.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Locations
-
-      def location(id, refresh = false)
-        fetch("location/3035-#{id}", refresh, Luchadeer::Location)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/objects.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Objects
-
-      def object(id, refresh = false)
-        fetch("object/3055-#{id}", refresh, Luchadeer::Object)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/people.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module People
-
-      def person(id, refresh = false)
-        fetch("person/3040-#{id}", refresh, Luchadeer::Person)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/api/videos.rb

@@ -1,11 +0,0 @@
-module Luchadeer
-  module API
-    module Videos
-
-      def video(id, refresh = false)
-        fetch("video/2300-#{id}", refresh, Luchadeer::Video)
-      end
-
-    end
-  end
-end

data/lib/luchadeer/character.rb

@@ -1,13 +0,0 @@
-require 'luchadeer/resource'
-
-module Luchadeer
-  class Character < Resource
-
-    class << self
-      def find(id, refresh = false)
-        Luchadeer.client.character(id, refresh)
-      end
-    end
-
-  end
-end

data/lib/luchadeer/company.rb

@@ -1,13 +0,0 @@
-require 'luchadeer/resource'
-
-module Luchadeer
-  class Company < Resource
-
-    class << self
-      def find(id, refresh = false)
-        Luchadeer.client.company(id, refresh)
-      end
-    end
-
-  end
-end

data/lib/luchadeer/concept.rb

@@ -1,13 +0,0 @@
-require 'luchadeer/resource'
-
-module Luchadeer
-  class Concept < Resource
-
-    class << self
-      def find(id, refresh = false)
-        Luchadeer.client.concept(id, refresh)
-      end
-    end
-
-  end
-end

data/lib/luchadeer/franchise.rb

@@ -1,13 +0,0 @@
-require 'luchadeer/resource'
-
-module Luchadeer
-  class Franchise < Resource
-
-    class << self
-      def find(id, refresh = false)
-        Luchadeer.client.franchise(id, refresh)
-      end
-    end
-
-  end
-end

data/lib/luchadeer/game.rb

@@ -1,13 +0,0 @@
-require 'luchadeer/resource'
-
-module Luchadeer
-  class Game < Resource
-
-    class << self
-      def find(id, refresh = false)
-        Luchadeer.client.game(id, refresh)
-      end
-    end
-
-  end
-end