luchadeer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b94d3d201a337e35c0fbaf18442c990fcafd6f2
-  data.tar.gz: a95e9980249f97ff68359c88d5e9c186ecdef4b2
+  metadata.gz: b22250f9c3271c62347190dfd92e2e7789e39943
+  data.tar.gz: de1419a049fc0cea1271c07f1d050edd936ca0fc
 SHA512:
-  metadata.gz: 7d362a2e26b74fe5fffd0f50053ea848a21257b12bc702e953a7bea2f473d9673b1310908a89f436a66d177578366fe398e9b1a474df544ea76d937a4661aa13
-  data.tar.gz: 2fdb677622f7c27dae3da5549b23e8e73035e845a983d0eb5af6b630304faceb80c4386fe1ea1c2aedd1c8db5e3a958536df0ba99d903804dea91d7b2f58d819
+  metadata.gz: cfefb61e51e347137953212ad823fb70875e049f8e07f44c5ed10e93a3a93f8a6162702aaf56f2839774c3c10d174ee11e59c78ea63bd64d70668c893c32aa22
+  data.tar.gz: 982ec4afd6c622a9868af1b05c8cc56b6f59ca15f4ebf62b27a21817063bdecb441aae48ed1e80e1c5b568a283546dfb615aea7160688c2ae05986c478a7fdea

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 
 rvm:
+  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    luchadeer (0.2.0)
+    luchadeer (0.3.1)
       faraday (~> 0.9.0)
 
 GEM

data/README.md

@@ -3,10 +3,12 @@
 [![Build Status](https://travis-ci.org/paulfri/luchadeer.png?branch=master)][build]
 [![Coverage Status](https://coveralls.io/repos/paulfri/luchadeer/badge.png?branch=master)][coverage]
 [![Code Climate](https://codeclimate.com/github/paulfri/luchadeer.png)][grade]
+[![Gem Version](https://badge.fury.io/rb/luchadeer.png)][gem]
 
 [build]: https://travis-ci.org/paulfri/luchadeer
 [coverage]: https://coveralls.io/r/paulfri/luchadeer?branch=master
 [grade]: https://codeclimate.com/github/paulfri/luchadeer
+[gem]: http://badge.fury.io/rb/luchadeer
 
 The bombingest Giant Bomb API client library for Ruby.
 
@@ -44,21 +46,19 @@ my_client.game 21373
 Luchadeer::RatingBoard.find 3
 my_client.rating_board 3
 
-# Custom searches
-Luchadeer::Search.new(page: 1, limit: 50, query: 'valkyria').fetch
+# Custom searches (some random examples, mix and match as you like)
+Luchadeer.search(page: 1, limit: 50, query: 'valkyria')
 
-search = Luchadeer::Search.new
-search.page(1).limit(50).sort('name', :desc) # default is :asc
-search.resources [Luchadeer::Game, Luchadeer::Character] # strings work too
-search.query 'valkyria'
-search.fetch
-
-search = Luchadeer::Search.new do |s|
+Luchadeer.search do |s|
   s.query = 'valkyria'
   s.page = 1
   s.limit = 50
 end
 
+search = Luchadeer::Search.new
+search.page(1).limit(50).sort('name', :desc) # default is :asc
+search.resources [Luchadeer::Game, Luchadeer::Character] # strings work too
+search.query 'valkyria'
 results = search.fetch
 ```
 

data/lib/luchadeer.rb

@@ -1,6 +1,4 @@
-require 'luchadeer/api'
 require 'luchadeer/client'
-require 'luchadeer/error'
 require 'luchadeer/search'
 
 module Luchadeer
@@ -16,5 +14,9 @@ module Luchadeer
     def client=(new_client)
       Thread.current[:luchadeer_client] = new_client
     end
+
+    def search(*args, &blk)
+      Luchadeer::Search.new(*args, &blk).fetch
+    end
   end
 end

data/lib/luchadeer/api.rb

@@ -30,20 +30,17 @@ module Luchadeer
     ]
 
     RESOURCES.each do |resource|
-      define_method resource::SINGULAR do |id, refresh = false|
-        fetch("#{resource::SINGULAR}/#{resource::RESOURCE_ID}-#{id}", refresh, resource)
+      define_method resource::DETAIL do |id, refresh = false|
+        fetch("#{resource::DETAIL}/#{resource::ID}-#{id}", refresh, resource)
       end
 
-      define_method resource::PLURAL do |query = nil, refresh = false|
-        search_resource(resource::PLURAL, query, refresh, resource)
+      define_method resource::LIST do |query = nil, refresh = false|
+        query_string = "?filter=name:#{query}" unless query.nil? or query.length < 1
+        fetch("#{resource::LIST}#{query_string}", refresh, resource)
       end
     end
 
-    def search(*args, &blk)
-      Luchadeer::Search.new(*args, &blk).fetch
-    end
-
-    def cache(key, refresh = false, &blk)
+    def cache(key, refresh = false)
       @cache ||= {}
       @cache.delete(key) if refresh
 
@@ -62,10 +59,5 @@ module Luchadeer
       results.is_a?(Array) ? results.map { |r| klass.new(r) } : klass.new(results)
     end
 
-    def search_resource(endpoint, query, refresh = false, klass = Luchadeer::Resource)
-      query_string = "?filter=name:#{query}" unless query.nil? or query.length < 1
-      fetch("#{endpoint}#{query_string}", refresh, klass)
-    end
-
   end
 end

data/lib/luchadeer/client.rb

@@ -1,4 +1,6 @@
 require 'faraday'
+require 'luchadeer/api'
+require 'luchadeer/error'
 require 'luchadeer/version'
 require 'luchadeer/middleware/follow_redirects'
 require 'luchadeer/middleware/parse_json'
@@ -58,8 +60,8 @@ module Luchadeer
 
     def request(method, path, params = {})
       connection.send(method.to_sym, path, params.merge(default_params))
-    # rescue => e
-    #   raise Luchadeer::Error.new(e)
+    rescue Faraday::Error => e
+      raise Luchadeer::Error.new e
     end
 
     def default_params

data/lib/luchadeer/resource.rb

@@ -5,11 +5,11 @@ module Luchadeer
 
     class << self
       def find(id, refresh = false)
-        Luchadeer.client.send(self::SINGULAR, id, refresh)
+        Luchadeer.client.send(self::DETAIL, id, refresh)
       end
 
       def search(query = nil, refresh = false)
-        Luchadeer.client.send(self::PLURAL, query, refresh)
+        Luchadeer.client.send(self::LIST, query, refresh)
       end
     end
 

data/lib/luchadeer/resources.rb

@@ -2,134 +2,134 @@ require 'luchadeer/resource'
 
 module Luchadeer
   class Accessory < Resource
-    SINGULAR    = :accessory
-    PLURAL      = :accessories
-    RESOURCE_ID = 3000
+    DETAIL = :accessory
+    LIST   = :accessories
+    ID     = 3000
   end
 
   class Character < Resource
-    SINGULAR    = :character
-    PLURAL      = :characters
-    RESOURCE_ID = 3005
+    DETAIL = :character
+    LIST   = :characters
+    ID     = 3005
   end
 
   class Chat < Resource
-    SINGULAR    = :chat
-    PLURAL      = :chats
-    RESOURCE_ID = 2450
+    DETAIL = :chat
+    LIST   = :chats
+    ID     = 2450
   end
 
   class Company < Resource
-    SINGULAR    = :company
-    PLURAL      = :companies
-    RESOURCE_ID = 3010
+    DETAIL = :company
+    LIST   = :companies
+    ID     = 3010
   end
 
   class Concept < Resource
-    SINGULAR    = :concept
-    PLURAL      = :concepts
-    RESOURCE_ID = 3015
+    DETAIL = :concept
+    LIST   = :concepts
+    ID     = 3015
   end
 
   class Franchise < Resource
-    SINGULAR    = :franchise
-    PLURAL      = :franchises
-    RESOURCE_ID = 3025
+    DETAIL  = :franchise
+    LIST    = :franchises
+    ID      = 3025
   end
 
   class Game < Resource
-    SINGULAR    = :game
-    PLURAL      = :games
-    RESOURCE_ID = 3030
+    DETAIL  = :game
+    LIST    = :games
+    ID      = 3030
   end
 
   class GameRating < Resource
-    SINGULAR    = :game_rating
-    PLURAL      = :game_ratings
-    RESOURCE_ID = 3065
+    DETAIL  = :game_rating
+    LIST    = :game_ratings
+    ID      = 3065
   end
 
   class Genre < Resource
-    SINGULAR    = :genre
-    PLURAL      = :genres
-    RESOURCE_ID = 3060
+    DETAIL  = :genre
+    LIST    = :genres
+    ID      = 3060
   end
 
   class Location < Resource
-    SINGULAR    = :location
-    PLURAL      = :locations
-    RESOURCE_ID = 3035
+    DETAIL  = :location
+    LIST    = :locations
+    ID      = 3035
   end
 
   class Object < Resource
-    SINGULAR    = :object
-    PLURAL      = :objects
-    RESOURCE_ID = 3055
+    DETAIL  = :object
+    LIST    = :objects
+    ID      = 3055
   end
 
   class Person < Resource
-    SINGULAR    = :person
-    PLURAL      = :people
-    RESOURCE_ID = 3040
+    DETAIL  = :person
+    LIST    = :people
+    ID      = 3040
   end
 
   class Platform < Resource
-    SINGULAR    = :platform
-    PLURAL      = :platforms
-    RESOURCE_ID = 3045
+    DETAIL  = :platform
+    LIST    = :platforms
+    ID      = 3045
   end
 
   class Promo < Resource
-    SINGULAR    = :promo
-    PLURAL      = :promos
-    RESOURCE_ID = 1700
+    DETAIL  = :promo
+    LIST    = :promos
+    ID      = 1700
   end
 
   class RatingBoard < Resource
-    SINGULAR    = :rating_board
-    PLURAL      = :rating_boards
-    RESOURCE_ID = 3070
+    DETAIL  = :rating_board
+    LIST    = :rating_boards
+    ID      = 3070
   end
 
   class Region < Resource
-    SINGULAR    = :region
-    PLURAL      = :regions
-    RESOURCE_ID = 3075
+    DETAIL  = :region
+    LIST    = :regions
+    ID      = 3075
   end
 
   class Release < Resource
-    SINGULAR    = :release
-    PLURAL      = :releases
-    RESOURCE_ID = 3050
+    DETAIL  = :release
+    LIST    = :releases
+    ID      = 3050
   end
 
   class Review < Resource
-    SINGULAR    = :review
-    PLURAL      = :reviews
-    RESOURCE_ID = 1900
+    DETAIL  = :review
+    LIST    = :reviews
+    ID      = 1900
   end
 
   class Theme < Resource
-    SINGULAR    = :theme
-    PLURAL      = :themes
-    RESOURCE_ID = 3032
+    DETAIL  = :theme
+    LIST    = :themes
+    ID      = 3032
   end
 
   class UserReview < Resource
-    SINGULAR    = :user_review
-    PLURAL      = :user_reviews
-    RESOURCE_ID = 2200
+    DETAIL  = :user_review
+    LIST    = :user_reviews
+    ID      = 2200
   end
 
   class Video < Resource
-    SINGULAR    = :video
-    PLURAL      = :videos
-    RESOURCE_ID = 2300
+    DETAIL  = :video
+    LIST    = :videos
+    ID      = 2300
   end
 
   class VideoType < Resource
-    SINGULAR    = :video_type
-    PLURAL      = :video_types
-    RESOURCE_ID = 2320
+    DETAIL  = :video_type
+    LIST    = :video_types
+    ID      = 2320
   end
 end

data/lib/luchadeer/version.rb

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

data/spec/luchadeer/api_spec.rb

@@ -5,7 +5,11 @@ describe Luchadeer::API do
   let(:key) { 'Chie' }
   let(:val) { 'Tomoe Gozen' }
 
-  describe  '#cache' do
+  it 'defines RESOURCES' do
+    expect(described_class).to be_const_defined :RESOURCES
+  end
+
+  describe '#cache' do
     context 'when value exists for key' do
       it 'returns the value for the given key' do
         client.cache = { key => val }
@@ -89,9 +93,7 @@ describe Luchadeer::API do
 
       context 'with no results' do
         it 'returns nil' do
-          stub_request(:get, %r(http://www.giantbomb.com/api/game-3030/21373))
-            .to_return(body:'{ }')
-
+          stub_request(:get, %r(http://www.giantbomb.com/api/game-3030/21373)).to_return(body:'{ }')
           expect(client.fetch('game-3030/21373')).to be_nil
         end
       end

data/spec/luchadeer/client_spec.rb

@@ -49,6 +49,11 @@ describe Luchadeer::Client do
       client.get("http://laika.io")
       expect(stub).to have_been_requested
     end
+
+    it 'catches and reraises Faraday errors' do
+      allow(client).to receive(:connection).and_raise Faraday::Error
+      expect { client.get('path') }.to raise_error Luchadeer::Error
+    end
   end
 
 end

data/spec/luchadeer/search_spec.rb

@@ -148,7 +148,7 @@ describe Luchadeer::Search do
       end
 
       it 'omits nil parameters' do
-        stub = stub_request(:get, "http://www.giantbomb.com/api/search")
+        stub = stub_request(:get, 'http://www.giantbomb.com/api/search')
           .with(query: { api_key: nil, format: 'json', query: query })
           .to_return(empty_body)
 

data/spec/support/shared_resource.rb

@@ -1,6 +1,6 @@
 shared_examples 'a resource' do
-  let(:singular) { described_class::SINGULAR }
-  let(:plural)   { described_class::PLURAL }
+  let(:detail) { described_class::DETAIL }
+  let(:list)   { described_class::LIST }
   let(:client) { Luchadeer::Client.new }
 
   before :each do
@@ -13,12 +13,12 @@ shared_examples 'a resource' do
 
   describe '.find' do
     it "forwards to the client find method with arguments" do
-      expect(client).to receive(singular).with(1, true)
+      expect(client).to receive(detail).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)
+      expect(client).to receive(detail).with(1, false)
       described_class.find(1)
     end
   end
@@ -27,12 +27,12 @@ shared_examples 'a resource' do
     let(:query)  { 'chie' }
 
     it "forwards to the client search method with arguments" do
-      expect(client).to receive(plural).with(query, true)
+      expect(client).to receive(list).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)
+      expect(client).to receive(list).with(query, false)
       described_class.search(query)
     end
   end

data/spec/support/shared_searchable.rb

@@ -5,9 +5,9 @@ shared_examples 'a searchable resource' do
   let(:client) { Luchadeer::Client.new }
 
   describe 'find method' do
-    let(:find) { described_class::SINGULAR }
+    let(:find) { described_class::DETAIL }
     let(:id)   { 14850 }
-    let(:path) { %r(#{Luchadeer::Client::GIANT_BOMB}/#{find}/#{described_class::RESOURCE_ID}-#{id}) }
+    let(:path) { %r(#{Luchadeer::Client::GIANT_BOMB}/#{find}/#{described_class::ID}-#{id}) }
 
     it 'requests the right url' do
       stub = stub_request(:get, path).to_return(body: '{ }')
@@ -28,7 +28,7 @@ shared_examples 'a searchable resource' do
   end
 
   describe 'search method' do
-    let(:search) { described_class::PLURAL }
+    let(:search) { described_class::LIST }
     let(:query) { 'chie' }
     let(:path)  { %r(#{Luchadeer::Client::GIANT_BOMB}/#{search}) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luchadeer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Paul Friedman