luchadeer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfbc3969949f80b2c6fe14722317f9b88cbdb31e
-  data.tar.gz: f1ad8f45243b83a111039bbf6dc5263f6342edb2
+  metadata.gz: 1b94d3d201a337e35c0fbaf18442c990fcafd6f2
+  data.tar.gz: a95e9980249f97ff68359c88d5e9c186ecdef4b2
 SHA512:
-  metadata.gz: 769594975368dc99024b093ae1027068e8d659c43833f6d4b8e47b702959e9dcd696bbd6a483251a3b13dae49b7fbf6367f5a1934f4cc50aa145b419ca381b63
-  data.tar.gz: 8124aef0e0a7062d4d5ee373ab196d1a34f64381fb9cf748d228acbd432be0a816802987a08249c14cf7ebc475119131c14f6aea4020ff3ddcf288f84471edbf
+  metadata.gz: 7d362a2e26b74fe5fffd0f50053ea848a21257b12bc702e953a7bea2f473d9673b1310908a89f436a66d177578366fe398e9b1a474df544ea76d937a4661aa13
+  data.tar.gz: 2fdb677622f7c27dae3da5549b23e8e73035e845a983d0eb5af6b630304faceb80c4386fe1ea1c2aedd1c8db5e3a958536df0ba99d903804dea91d7b2f58d819

data/.travis.yml

@@ -2,5 +2,7 @@ language: ruby
 
 rvm:
   - 2.0.0
+  - 2.1.0
+  - 2.1.1
 
 script: bundle exec rspec

data/Gemfile.lock

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

data/README.md

@@ -11,11 +11,14 @@
 The bombingest Giant Bomb API client library for Ruby.
 
 ## Features
-1. Fully unit-tested.
+1. Supports all resources exposed by the Giant Bomb API. For a full list, see the [documentation][docs].
 2. Caches API responses.
-3. fully.recursive.dot.syntax, no random hash[:syntax] cutoff point
-4. Fetch full details for partial objects (e.g. embedded results) with object.detail.
-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.
+3. Fully unit-tested.
+4. fully.recursive.dot.syntax, no random hash[:syntax] cutoff point
+5. Fetch full details for partial objects (e.g. embedded results) with object.detail.
+6. Use convenience methods on a default client per-thread, or use an alternate syntax for full control of the client object.
+
+[docs]: http://www.giantbomb.com/api/documentation
 
 ## Configuration
 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.
@@ -23,50 +26,43 @@ Get your API key [here](http://www.giantbomb.com/api). If you have a premium acc
 ```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.
-Luchadeer.configure do |client|
-  client.api_key = 'my_api_key'
-end
 ```
 
-## Supported resources
-* game
-* franchise
-* character
-* concept
-* object
-* location
-* person
-* company
-* video
-
 ## Usage
 
 ```ruby
-# Resources
-Luchadeer::Game.find(21373) # or...
-my_client.game(21373) # => #<Luchadeer::Game name="Shin Megami Tensei: Persona 4" ...>
+# Resources by name
+# (you can omit the search query if you like)
+Luchadeer::Game.search 'persona 4'
+my_client.games 'persona 4'
+Luchadeer::Video.search 'unprofessional'
+my_client.videos 'unprofessional'
 
-# Search: mix and match whatever syntax you like
+# Resources by ID
+Luchadeer::Game.find 21373
+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
 
 search = Luchadeer::Search.new
-search.page(1).limit(50).sort('name', :desc)
-search.resources([Luchadeer::Game, Luchadeer::Character])
-search.query('valkyria')
+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
 
-Luchadeer::Search.new { |s|
+search = Luchadeer::Search.new do |s|
   s.query = 'valkyria'
   s.page = 1
   s.limit = 50
-}.fetch
+end
+
+results = search.fetch
 ```
 
 ## TODO
 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.
+2. Make the caching layer more flexible - more options besides in-memory store. Add a null store, too.
+3. 'ghost' object pattern - lazy-load details for partial models when they're accessed, instead of requiring manual '.detail' invocation

data/lib/luchadeer.rb

@@ -1,20 +1,8 @@
-require 'luchadeer/version'
-
 require 'luchadeer/api'
 require 'luchadeer/client'
 require 'luchadeer/error'
 require 'luchadeer/search'
 
-require 'luchadeer/character'
-require 'luchadeer/company'
-require 'luchadeer/concept'
-require 'luchadeer/franchise'
-require 'luchadeer/game'
-require 'luchadeer/location'
-require 'luchadeer/object'
-require 'luchadeer/person'
-require 'luchadeer/video'
-
 module Luchadeer
   class << self
     def configure(opts = {}, &blk)

data/lib/luchadeer/api.rb

@@ -1,32 +1,47 @@
-require 'luchadeer/api/characters'
-require 'luchadeer/api/companies'
-require 'luchadeer/api/concepts'
-require 'luchadeer/api/franchises'
-require 'luchadeer/api/games'
-require 'luchadeer/api/locations'
-require 'luchadeer/api/objects'
-require 'luchadeer/api/people'
-require 'luchadeer/api/videos'
+require 'luchadeer/resources'
 
 module Luchadeer
   module API
-    API_MODULES = [
-      Luchadeer::API::Characters,
-      Luchadeer::API::Companies,
-      Luchadeer::API::Concepts,
-      Luchadeer::API::Franchises,
-      Luchadeer::API::Games,
-      Luchadeer::API::Locations,
-      Luchadeer::API::Objects,
-      Luchadeer::API::People,
-      Luchadeer::API::Videos
+    attr_writer :cache
+
+    RESOURCES = [
+      Luchadeer::Accessory,
+      Luchadeer::Character,
+      Luchadeer::Chat,
+      Luchadeer::Company,
+      Luchadeer::Concept,
+      Luchadeer::Franchise,
+      Luchadeer::Game,
+      Luchadeer::GameRating,
+      Luchadeer::Genre,
+      Luchadeer::Location,
+      Luchadeer::Object,
+      Luchadeer::Person,
+      Luchadeer::Platform,
+      Luchadeer::Promo,
+      Luchadeer::RatingBoard,
+      Luchadeer::Region,
+      Luchadeer::Release,
+      Luchadeer::Review,
+      Luchadeer::Theme,
+      Luchadeer::UserReview,
+      Luchadeer::Video,
+      Luchadeer::VideoType
     ]
 
-    API_MODULES.each do |mod|
-      include mod
+    RESOURCES.each do |resource|
+      define_method resource::SINGULAR do |id, refresh = false|
+        fetch("#{resource::SINGULAR}/#{resource::RESOURCE_ID}-#{id}", refresh, resource)
+      end
+
+      define_method resource::PLURAL do |query = nil, refresh = false|
+        search_resource(resource::PLURAL, query, refresh, resource)
+      end
     end
 
-    attr_writer :cache
+    def search(*args, &blk)
+      Luchadeer::Search.new(*args, &blk).fetch
+    end
 
     def cache(key, refresh = false, &blk)
       @cache ||= {}
@@ -47,5 +62,10 @@ 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,5 @@
 require 'faraday'
+require 'luchadeer/version'
 require 'luchadeer/middleware/follow_redirects'
 require 'luchadeer/middleware/parse_json'
 require 'luchadeer/middleware/parse_http_error'
@@ -45,8 +46,7 @@ module Luchadeer
     end
 
     def middleware
-      Faraday::RackBuilder.new do |builder|
-        # order is important
+      Faraday::RackBuilder.new do |builder| # order is important
         builder.response :parse_api_error
         builder.response :parse_json
         builder.response :parse_http_error

data/lib/luchadeer/error.rb

@@ -34,17 +34,10 @@ module Luchadeer
       }
     end
 
-  private
-
-    class RedirectLimitReached < Luchadeer::Error; end
-    class RequestTimeout < Luchadeer::Error; end
+    %w[RedirectLimitReached RequestTimeout InvalidAPIKey URLFormatError FilterError
+    SubscriberOnly BadRequest NotFound InternalServerError ].each do |e|
+      const_set e, Class.new(Luchadeer::Error)
+    end
 
-    class InvalidAPIKey < Luchadeer::Error; end
-    class URLFormatError < Luchadeer::Error; end
-    class FilterError < Luchadeer::Error; end
-    class SubscriberOnly < Luchadeer::Error; end
-    class BadRequest < Luchadeer::Error; end
-    class NotFound < Luchadeer::Error; end
-    class InternalServerError < Luchadeer::Error; end
   end
 end

data/lib/luchadeer/resource.rb

@@ -1,5 +1,17 @@
+require 'ostruct'
+
 module Luchadeer
-  class Resource < OpenStruct
+  class Resource < ::OpenStruct
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.send(self::SINGULAR, id, refresh)
+      end
+
+      def search(query = nil, refresh = false)
+        Luchadeer.client.send(self::PLURAL, query, refresh)
+      end
+    end
 
     # http://andreapavoni.com/blog/2013/4/create-recursive-openstruct-from-a-ruby-hash
     def initialize(hash = nil)
@@ -27,7 +39,7 @@ module Luchadeer
 
     def deep_structify(k, v)
       case v
-      when Hash then Luchadeer::Resource.new(v)
+      when Hash  then Luchadeer::Resource.new(v)
       when Array then v.map { |n| Luchadeer::Resource.new(n) }
       else v
       end

data/lib/luchadeer/resources.rb

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

data/lib/luchadeer/search.rb

@@ -1,12 +1,4 @@
-require 'luchadeer/character'
-require 'luchadeer/company'
-require 'luchadeer/concept'
-require 'luchadeer/franchise'
-require 'luchadeer/game'
-require 'luchadeer/location'
-require 'luchadeer/object'
-require 'luchadeer/person'
-require 'luchadeer/video'
+require 'luchadeer/resources'
 
 module Luchadeer
   class Search

data/lib/luchadeer/version.rb

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