luchadeer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d28c953c62036e898630d204bd3e630ecc90e5
-  data.tar.gz: 675625e43a2d925c7e1697d37ff5563a91536eb0
+  metadata.gz: bfbc3969949f80b2c6fe14722317f9b88cbdb31e
+  data.tar.gz: f1ad8f45243b83a111039bbf6dc5263f6342edb2
 SHA512:
-  metadata.gz: 53d5e8f133ffabf11316572708618b7a937c374647b30d09ed0fd6ea142f8a99b8a2862cb4f9d8b1e27707f4f731c9ae8ad10a80ad7c76b86b72c4d28814990d
-  data.tar.gz: dc98a568a7fb9af7c92ddcac6b99e7744f0ceae2f9c34466484c4e5d91762f893a6c1d6632a728c044ac4bc978dab654d92bc4b881d9262945d07166a918031a
+  metadata.gz: 769594975368dc99024b093ae1027068e8d659c43833f6d4b8e47b702959e9dcd696bbd6a483251a3b13dae49b7fbf6367f5a1934f4cc50aa145b419ca381b63
+  data.tar.gz: 8124aef0e0a7062d4d5ee373ab196d1a34f64381fb9cf748d228acbd432be0a816802987a08249c14cf7ebc475119131c14f6aea4020ff3ddcf288f84471edbf

data/README.md

@@ -4,7 +4,7 @@
 [![Coverage Status](https://coveralls.io/repos/paulfri/luchadeer/badge.png?branch=master)][coverage]
 [![Code Climate](https://codeclimate.com/github/paulfri/luchadeer.png)][grade]
 
-[build]: (https://travis-ci.org/paulfri/luchadeer)
+[build]: https://travis-ci.org/paulfri/luchadeer
 [coverage]: https://coveralls.io/r/paulfri/luchadeer?branch=master
 [grade]: https://codeclimate.com/github/paulfri/luchadeer
 
@@ -18,16 +18,13 @@ The bombingest Giant Bomb API client library for Ruby.
 5. Thread-ready (thready?): no global or class state. Use convenience methods to use a default client per-thread, or use an alternate syntax for full control.
 
 ## Configuration
-Get your API key [here](http://www.giantbomb.com/api).
+Get your API key [here](http://www.giantbomb.com/api). If you have a premium account, your API key should give you access to subscriber-only video resources, as well as links to HD-quality videos.
 
 ```ruby
 Luchadeer.configure(api_key: 'my_api_key') # default client for this thread
 Luchadeer::Client.new(api_key: 'my_api_key')
-```
-
-You can also pass a block to either method, and it will yield the client object to configure to your liking.
 
-```ruby
+# You can also pass a block to either method, and it will yield the client object to configure to your liking.
 Luchadeer.configure do |client|
   client.api_key = 'my_api_key'
 end
@@ -47,12 +44,29 @@ end
 ## Usage
 
 ```ruby
+# Resources
 Luchadeer::Game.find(21373) # or...
 my_client.game(21373) # => #<Luchadeer::Game name="Shin Megami Tensei: Persona 4" ...>
+
+# Search: mix and match whatever syntax you like
+Luchadeer::Search.new(page: 1, limit: 50, query: 'valkyria').fetch
+
+search = Luchadeer::Search.new
+search.page(1).limit(50).sort('name', :desc)
+search.resources([Luchadeer::Game, Luchadeer::Character])
+search.query('valkyria')
+search.fetch
+
+Luchadeer::Search.new { |s|
+  s.query = 'valkyria'
+  s.page = 1
+  s.limit = 50
+}.fetch
 ```
 
 ## TODO
-1. Add filtering to search.
+1. Add custom filtering to search (i.e., the 'filter' request parameter).
 2. Add per-resource searching class methods on each resource object.
 3. Refactor the test suite with shared example groups.
 4. Make the caching layer more flexible - more options besides in-memory store. Add a null store, too.
+5. Add remaining missing resources: accessory, chat, game_rating, genre, platform, promo, rating_board, region, release, review, theme, types, user_review, video_type. None of these show up in search. Refactoring is probably necessary.

data/lib/luchadeer/client.rb

@@ -12,10 +12,7 @@ module Luchadeer
     GIANT_BOMB = 'http://www.giantbomb.com/api'
 
     def initialize(opts = {})
-      opts.each do |key, value|
-        send(:"#{key}=", value)
-      end
-
+      @api_key = opts[:api_key] if opts[:api_key]
       yield self if block_given?
     end
 

data/lib/luchadeer/search.rb

@@ -10,8 +10,6 @@ require 'luchadeer/video'
 
 module Luchadeer
   class Search
-    attr_accessor :query
-
     RESOURCE_TYPES = {
       'character' => Luchadeer::Character,
       'company'   => Luchadeer::Company,
@@ -24,8 +22,12 @@ module Luchadeer
       'video'     => Luchadeer::Video
     }
 
-    def initialize(query)
-      @query = query
+    def initialize(opts = {})
+      opts.each do |key, value|
+        send(:"#{key}=", value)
+      end
+
+      yield self if block_given?
     end
 
     def fetch
@@ -35,10 +37,49 @@ module Luchadeer
       end.compact
     end
 
+    QUERY_PARAMS = [:query, :limit, :page, :fields, :resources, :sort]
+    attr_writer *QUERY_PARAMS
+
+    QUERY_PARAMS.each do |method|
+      define_method("#{method}") do |param = nil|
+        ivar = "@#{method.to_s}"
+        return instance_variable_get(ivar) unless param
+        instance_variable_set(ivar, param)
+        self
+      end
+    end
+
+    def resources(resources = nil)
+      return @resources unless resources
+      append_resources(resources)
+      self
+    end
+
+    def sort(attribute = nil, dir = :asc)
+      return @sort unless attribute
+      @sort = "#{attribute}:#{dir}"
+      self
+    end
+
   private
 
     def search_params
-      { query: @query }
+      { query: @query, limit: @limit, resources: @resources, page: @page,
+        sort: @sort }.delete_if { |_, v| v.nil? }
+    end
+
+    def append_resources(resources)
+      @resources ||= ''
+      resources = (RESOURCE_TYPES.invert[resources] || '') if resources.is_a? Class
+
+      rx = resources.is_a?(Array) ? resources : resources.split(',')
+      rx.each do |r|
+        r = (RESOURCE_TYPES.invert[r] || '') if r.is_a? Class        
+        RESOURCE_TYPES[r] or raise(ArgumentError, 'Invalid resource type supplied')
+        @resources << ",#{r}"
+      end
+
+      @resources.sub!(/\A,+/, '')
     end
 
   end

data/lib/luchadeer/version.rb

@@ -1,3 +1,3 @@
 module Luchadeer
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/luchadeer/search_spec.rb

@@ -2,26 +2,161 @@ require 'spec_helper'
 
 describe Luchadeer::Search do
   let(:query) { 'Chie Satonaka' }
+  let(:limit) { 10 }
+  let(:page)  { 1 }
+  let(:sort)  { 'name' }
+  let(:search) { described_class.new }
   let(:search_path) { %r(#{Luchadeer::Client::GIANT_BOMB}/search) }
+  let(:empty_body) { { body: '{ "results": [] }' } }
 
   describe '#initialize' do
-    it 'instantiates with a search query' do
-      expect(described_class.new(query).query).to eq query
+    it 'instantiates with no arguments' do
+      expect(described_class.new).to be_instance_of described_class
+    end
+
+    it 'instantiates with an options hash' do
+      expect(described_class.new(query: query).query).to eq query
+    end
+
+    it 'yields self if block given' do
+      expect { |b| described_class.new(&b) }.to yield_control
+    end
+  end
+
+  describe '#query' do
+    it 'sets the query' do
+      expect(search.query(query).query).to eq query
+    end
+
+    it 'returns the search instance' do
+      expect(search.query(query)).to eq search
+    end
+  end
+
+  describe '#limit' do
+    it 'sets the limit' do
+      expect(search.limit(limit).limit).to eq limit
+    end
+
+    it 'returns the search instance' do
+      expect(search.limit(limit)).to eq search
+    end
+  end
+
+  describe '#page' do
+    it 'sets the page' do
+      expect(search.page(page).page).to eq page
+    end
+
+    it 'returns the search instance' do
+      expect(search.page(page)).to eq search
+    end
+  end
+
+  describe '#sort' do
+    it 'sets the sort to the given parameter and defaults to ascending' do
+      expect(search.sort(sort).sort).to eq "#{sort}:asc"
+    end
+
+    it 'allows changing the sort direction' do
+      expect(search.sort(sort, :desc).sort).to eq "#{sort}:desc"
+    end
+
+    it 'allows changing the sort with a string' do
+      expect(search.sort(sort, 'desc').sort).to eq "#{sort}:desc"
+    end
+
+    it 'returns the search instance' do
+      expect(search.sort(sort)).to eq search
+    end
+  end
+
+  describe '#resources' do
+    context 'when called with a valid string' do
+      it 'sets resources to the given string' do
+        expect(search.resources('person,location').resources).to eq 'person,location'
+      end
+    end
+
+    context 'when called with an invalid string' do
+      it 'raises ArgumentError' do
+        expect { search.resources('naoto,yosuke,kanji').resources }.to raise_error ArgumentError
+      end
+    end
+
+    context 'when called with class' do
+      it 'maps the class to a string' do
+        expect(search.resources(Luchadeer::Person).resources).to eq 'person'
+      end
+    end
+
+    context 'when called with array' do
+      context 'of valid' do
+        context 'strings' do
+          it 'sets resources to comma-delimited string of given strings' do
+            expect(search.resources(['person', 'location']).resources).to eq 'person,location'
+          end
+        end
+
+        context 'classes' do
+          it 'maps the classes to strings' do
+            expect(search.resources([Luchadeer::Person, Luchadeer::Location]).resources).to eq 'person,location'
+          end
+        end
+      end
+
+      context 'of invalid' do
+        context 'strings' do
+          it 'raises ArgumentError' do
+            expect { search.resources ['person', 'naoto'] }.to raise_error ArgumentError
+          end
+        end
+
+        context 'classes' do
+          it 'raises ArgumentError' do
+            expect { search.resources [String, BasicObject, Luchadeer::Search] }.to raise_error ArgumentError
+          end
+        end
+      end
     end
   end
 
   describe '#fetch' do
+    let(:search) { described_class.new(query: query).fetch }
+
     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": [] }')
+      stub = stub_request(:get, search_path).to_return(empty_body)
 
-      described_class.new(query).fetch
+      search
       expect(stub).to have_been_requested
     end
 
+    describe 'request parameters' do
+      it 'includes supplied parameters' do
+        params = { query: query, limit: 10, page: 1, resources: 'video', sort: 'name:asc' }
+
+        stub = stub_request(:get, "http://www.giantbomb.com/api/search")
+          .with(query: { api_key: nil, format: 'json' }.merge(params))
+          .to_return(empty_body)
+
+        described_class.new(params).fetch
+        expect(stub).to have_been_requested
+      end
+
+      it 'omits nil parameters' do
+        stub = stub_request(:get, "http://www.giantbomb.com/api/search")
+          .with(query: { api_key: nil, format: 'json', query: query })
+          .to_return(empty_body)
+
+        described_class.new(query: query, limit: nil, page: nil).fetch
+        expect(stub).to have_been_requested
+      end
+    end
+
     describe 'generates the proper class based on the result type' do
       subject do
         stub_request(:get, search_path).to_return(body:
@@ -36,7 +171,7 @@ describe Luchadeer::Search do
                                 {"resource_type": "person"},
                                 {"resource_type": "video"}
                             ] }')
-        described_class.new(query).fetch
+        search
       end
 
       its([0]) { should be_instance_of Luchadeer::Character }
@@ -50,18 +185,18 @@ describe Luchadeer::Search do
       its([8]) { should be_instance_of Luchadeer::Video }
     end
 
-    context 'when there are no results' do
-      it 'returns an empty array' do
+    context 'when the resource type isn\'t mapped' do
+      it 'skips modeling the resource' do
         stub_request(:get, search_path).to_return(body:
           '{ "results": [{ "resource_type": "banana"}] }')
-        expect(described_class.new(query).fetch).to eq []
+        expect(search).to be_empty
       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 []
+    context 'when there are no results' do
+      it 'returns an empty array' do
+        stub_request(:get, search_path).to_return(empty_body)
+        expect(search).to be_empty
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luchadeer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Friedman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: The bombingest Giant Bomb API client library for Ruby.