giantbomb 0.1.0 → 0.5.0

data/.gitignore

@@ -2,3 +2,5 @@ pkg/*
 *.gem
 .bundle
 .DS_Store
+*.tmproj
+tmtags

data/Gemfile

@@ -1,5 +1,4 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in giantbomb.gemspec
-gemspec
-httparty
+gemspec

data/README.textile

@@ -0,0 +1,41 @@
+h1. A Ruby wrapper for the GiantBomb API
+
+h2. Configuration
+
+GiantBomb::Api.key(API_KEY_HERE)
+
+h2. Resources
+
+Current available resources:
+* Game
+* Company
+* Character
+
+All resources have access to Resource#list, Resource#detail, and Resource#search.
+
+h3. Example
+
+<pre>
+@game = Game.detail(1)
+@games = Game.find("Duke Nukem")
+@games = Game.list
+</pre>
+
+h2. Search
+
+GiantBomb::Search defaults to using the GiantBomb search resource and is the basis for all other resource requests. The implementation is inspired by jnunemaker's Twitter library.
+
+All of the "filter" methods in GiantBomb::Search are chainable.
+
+h3. Usage
+
+<pre>
+@search = GiantBomb::Search.new
+@search.limit(10) # limits number of returned resources
+@search.resources('game') # determines type(s) of resources
+@search.fields('name,deck') # limits fields returned
+@search.offset(100) # sets the offset
+@search.query('duke nukem') # the query to search against
+@search.fetch # makes request
+</pre>
+

data/giantbomb.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Robert Coker"]
   s.email       = ["rob@robertsays.com"]
   s.homepage    = "http://rubygems.org/gems/giantbomb"
-  s.summary     = %q{A Ruby wrapper for the GiantBomb API.}
-  s.description = %q{Provides a simple, easy to use interface for the GiantBomb API.}
+  s.summary     = %q{A Ruby wrapper for the Giant Bomb video game wiki API.}
+  s.description = %q{Provides a simple, easy to use interface for the Giant Bomb video game wiki API.}
 
   s.rubyforge_project = "giantbomb"
 
@@ -18,4 +18,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  
+  s.add_dependency('httparty')
 end

data/lib/giantbomb.rb

@@ -1,10 +1,14 @@
 require 'rubygems'
 require 'httparty'
 
-["api", "search", "resource", "game", "company", "character"].each do |inc|
+["api","search","resource"].each do |inc|
+  require File.join(File.dirname(__FILE__), "giantbomb", inc)
+end
+
+["game","company","character","franchise","concept","object","location","person","video"].each do |inc|
   require File.join(File.dirname(__FILE__), "giantbomb", inc)
 end
 
 module GiantBomb
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

data/lib/giantbomb/concept.rb

@@ -0,0 +1,36 @@
+module GiantBomb
+  class Concept < Resource
+    has_resource 'concept', :plural => 'concepts'
+
+    # http://api.giantbomb.com/documentation/#concept
+    @@fields = [
+      :aliases, # List of aliases the concept is known by. A \n (newline) separates each alias.
+      :api_detail_url, # URL pointing to the concept detail resource
+      :characters, # Characters related to the concept
+      :companies, # Companies related to the concept
+      :concepts, # Other concepts related to the concept
+      :date_added, # Date the concept was added to Giant Bomb
+      :date_last_updated, # Date the concept was last updated on Giant Bomb
+      :deck, # Brief summary of the concept
+      :description, # Description of the concept
+      :first_appeared_in_franchise, # Franchise that the concept first appeared in
+      :first_appeared_in_game, # Game that the concept first appeared in
+      :franchises, # Franchises related to the concept
+      :games, # Games related to the concept
+      :id, # Unique ID of the concept
+      :image, # Main Image of the concept
+      :locations, # Locations related to the concept
+      :name, # Name of the concept
+      :objects, # Objects related to the concept
+      :people, # People related to the concept
+      :platforms, # Platforms related to the concept
+      :related_concepts, # Other concepts related to the concept
+      :site_detail_url # URL pointing to the concept on Giant Bomb
+    ]
+    
+    @@fields.each do |field|
+      attr_accessor field
+    end
+    
+  end
+end

data/lib/giantbomb/franchise.rb

@@ -0,0 +1,30 @@
+module GiantBomb
+  class Franchise < Resource
+    has_resource 'franchise', :plural => 'franchises'
+
+    # http://api.giantbomb.com/documentation/#franchise
+    @@fields = [
+      :aliases, # List of aliases the franchise is known by. A \n (newline) separates each alias.
+      :api_detail_url, # URL pointing to the franchise detail resource
+      :characters, # Characters related to the franchise
+      :concepts, # Concepts related to the franchise
+      :date_added, # Date the franchise was added to Giant Bomb
+      :date_last_updated, # Date the franchise was last updated on Giant Bomb
+      :deck, # Brief summary of the franchise
+      :description, # Description of the franchise
+      :games, # Games related to the franchise
+      :id, # Unique ID of the franchise
+      :image, # Main Image of the franchise
+      :locations, # Locations related to the franchise
+      :name, # Name of the franchise
+      :objects, # Objects related to the franchise
+      :people, # People related to the franchise
+      :site_detail_url # URL pointing to the franchise on Giant Bomb
+    ]
+    
+    @@fields.each do |field|
+      attr_accessor field
+    end
+    
+  end
+end

data/lib/giantbomb/location.rb

@@ -0,0 +1,25 @@
+module GiantBomb
+  class Location < Resource
+    has_resource 'location', :plural => 'locations'
+
+    # http://api.giantbomb.com/documentation/#location
+    @@fields = [
+      :aliases, # List of aliases the location is known by. A \n (newline) separates each alias.
+      :api_detail_url, # URL pointing to the location detail resource
+      :date_added, # Date the location was added to Giant Bomb
+      :date_last_updated, # Date the location was last updated on Giant Bomb
+      :deck, # Brief summary of the location
+      :description, # Description of the location
+      :first_appeared_in_game, # Game the location first appeared in
+      :id, # Unique ID of the location
+      :image, # Main Image of the location
+      :name, # Name of the location
+      :site_detail_url # URL pointing to the location on Giant Bomb
+    ]
+    
+    @@fields.each do |field|
+      attr_accessor field
+    end
+    
+  end
+end

data/lib/giantbomb/object.rb

@@ -0,0 +1,34 @@
+module GiantBomb
+  class GameObject < Resource
+    has_resource 'object', :plural => 'objects'
+
+    # http://api.giantbomb.com/documentation/#object
+    @@fields = [
+      :aliases, # List of aliases the object is known by. A \n (newline) separates each alias.
+      :api_detail_url, # URL pointing to the object detail resource
+      :characters, # Characters related to the object
+      :companies, # Companies related to the object
+      :concepts, # Concepts related to the object
+      :date_added, # Date the object was added to Giant Bomb
+      :date_last_updated, # Date the object was last updated on Giant Bomb
+      :deck, # Brief summary of the object
+      :description, # Description of the object
+      :first_appeared_in_game, # Game the object first appeared in
+      :franchises, # Franchises related to the object
+      :games, # Games related to the object
+      :id, # Unique ID of the object
+      :image, # Main Image of the object
+      :locations, # Locations related to the object
+      :name, # Name of the object
+      :objects, # Other objects related to the object
+      :people, # People related to the object
+      :platforms, # Platforms related to the object
+      :site_detail_url # URL pointing to the object on Giant Bomb
+    ]
+    
+    @@fields.each do |field|
+      attr_accessor field
+    end
+    
+  end
+end

data/lib/giantbomb/person.rb

@@ -0,0 +1,39 @@
+module GiantBomb
+  class Person < Resource
+    has_resource 'person', :plural => 'people'
+
+    # http://api.giantbomb.com/documentation/#person
+    @@fields = [
+      :aliases, # List of aliases the person is known by. A \n (newline) separates each alias.
+      :api_detail_url, # URL pointing to the person detail resource
+      :birth_date, # Date the person was born
+      :characters, # Characters related to the person
+      :companies, # Companies the person has worked with
+      :concepts, # Concepts related to the person
+      :country, # Country the person resides in
+      :date_added, # Date the person was added to Giant Bomb
+      :date_last_updated, # Date the person was last updated on Giant Bomb
+      :death_date, # Date the person died
+      :deck, # Brief summary of the person
+      :description, # Description of the person
+      :first_credited_game, # Game the person was first credited in
+      :franchises, # Franchises the person has worked on
+      :games, # Games the person has worked on
+      :gender, # Gender of the person. Available options are: Male, Female, Other
+      :hometown, # City or town the person resides in
+      :id, # Unique ID of the person
+      :image, # Main Image of the person
+      :locations, # Locations related to the person
+      :name, # Name of the person
+      :objects, # Objects related to the person
+      :people, # Other people related to the person
+      :platforms, # Platforms related to the person
+      :site_detail_url # URL pointing to the person on Giant Bomb
+    ]
+    
+    @@fields.each do |field|
+      attr_accessor field
+    end
+    
+  end
+end

data/lib/giantbomb/resource.rb

@@ -1,26 +1,26 @@
 module GiantBomb
   class Resource
-    @@resource = {}
+    @@endpoints = {}
     
     def self.has_resource(singular=nil, opts={})
-      @@resource[self.name.downcase] = { 
+      @@endpoints[self.name.downcase] = { 
         :singular => singular.nil? ? "#{self.name.downcase}" : singular, 
         :plural => opts[:plural].nil? ? "#{self.name.downcase}s" : opts[:plural]
       }
     end
     
-    def self.resources
-      @@resource[self.name.downcase]
+    def self.endpoints
+      @@endpoints[self.name.downcase]
     end
     
     def self.detail(id, conditions={})
-      search = GiantBomb::Search.new("/#{self.resources[:singular]}/#{id}/")
+      search = GiantBomb::Search.new("/#{self.endpoints[:singular]}/#{id}/")
       search.filter(conditions)
       self.new(search.fetch)
     end
     
     def self.list(conditions={})
-      search = GiantBomb::Search.new("/#{self.resources[:plural]}")
+      search = GiantBomb::Search.new("/#{self.endpoints[:plural]}")
       search.filter(conditions)
       search.fetch.collect do |result|
         self.new(result)
@@ -29,7 +29,7 @@ module GiantBomb
     
     def self.search(query)
       search = GiantBomb::Search.new
-      search.resources("#{self.resources[:singular]}")
+      search.resources("#{self.endpoints[:singular]}")
       search.query(query)
       search.fetch.collect do |result|
         self.new(result)

data/lib/giantbomb/search.rb

@@ -1,46 +1,72 @@
 module GiantBomb
+  # Wrapper for the Giant Bomb Search resource
+  # 
+  # @see http://api.giantbomb.com/documentation/#search
   class Search
     include GiantBomb::Api
     
+    # @private
     attr_reader :query, :resource
     
+    # Creates a new search
+    #
+    # @example Initialize a Giant Bomb search
+    #   search = GiantBomb::Search.new
+    #   search = GiantBomb::Search.new('game')
     def initialize(resource=nil)
       @params = {}
       @resource = resource.nil? ? '/search' : resource
       self
     end
     
-    # GiantBomb::Search.new.fields('name,deck')
+    # @group Generic filters
+    
+    # Only return the specified fields for the given resource
+    # 
+    # @param fields [String] A comma delimited list of fields to return.
+    # @return [GiantBomb::Search] self
     def fields(fields)
       @params[:field_list] = "#{fields}"
       self
     end
     
-    # GiantBomb::Search.new.limit(1)
+    # Only return a limited number of resources
+    # 
+    # @param limit [Integer] Nmber of items to limit by.
+    # @return [GiantBomb::Search] self
     def limit(limit)
       @params[:limit] = "#{limit}"
       self
     end
     
-    # GiantBomb::Search.new.offset(100)
+    # Only include resources starting from a given offset
+    # 
+    # @param limit [Integer] Number of items to skip.
+    # @return [GiantBomb::Search] self
     def offset(offset)
       @params[:offset] = "#{offset}"
       self
     end
     
-    # GiantBomb::Search.new.query('duke nukem')
+    # Search query
+    # 
+    # @param query [String] The search query.
+    # @return [GiantBomb::Search] self
     def query(query)
       @params[:query] = "#{query}"
       self
     end
     
-    # GiantBomb::Search.new.resources('game')
+    # Only include items of the specified resources
+    # 
+    # @param resources [String] A comma delimited list of resources to search.
+    # @return [GiantBomb::Search] self
     def resources(resources)
       @params[:resources] = "#{resources}"
       self
     end
 
-    # a convenience method that takes a hash where each key is 
+    # A convenience method that takes a hash where each key is 
     # the symbol of a method, and each value is the parameters
     # passed to that method.
     def filter(conditions)
@@ -53,7 +79,11 @@ module GiantBomb
       end
     end
     
-    # GiantBomb::Search.new.query('duke nukem').fetch
+    # Fetch the results of the query
+    #
+    # @return [Array] Items that match the specified query.
+    # @example
+    #   search = GiantBomb::Search.new.query("Duke Nukem").fetch
     def fetch
       options = @params.merge(Api.config)
       response = Api.get(@resource, :query => options)

data/lib/giantbomb/video.rb

@@ -0,0 +1,23 @@
+module GiantBomb
+  class Video < Resource
+    has_resource 'video', :plural => 'videos'
+
+    # http://api.giantbomb.com/documentation/#video
+    @@fields = [
+      :api_detail_url, # URL pointing to the video detail resource
+      :deck, # Brief summary of the video
+      :id, # Unique ID of the video
+      :image, # Image associated with the video
+      :name, # Title of the video
+      :publish_date, # Date the video was published on Giant Bomb
+      :site_detail_url, # URL pointing to the video on Giant Bomb
+      :url, # The video's filename
+      :user # Author of the video
+    ]
+    
+    @@fields.each do |field|
+      attr_accessor field
+    end
+    
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: giantbomb
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 5
   - 0
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Robert Coker
@@ -17,9 +17,22 @@ cert_chain: []
 
 date: 2011-01-11 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
-description: Provides a simple, easy to use interface for the GiantBomb API.
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Provides a simple, easy to use interface for the Giant Bomb video game wiki API.
 email: 
 - rob@robertsays.com
 executables: []
@@ -31,16 +44,22 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README
+- README.textile
 - Rakefile
 - giantbomb.gemspec
 - lib/giantbomb.rb
 - lib/giantbomb/api.rb
 - lib/giantbomb/character.rb
 - lib/giantbomb/company.rb
+- lib/giantbomb/concept.rb
+- lib/giantbomb/franchise.rb
 - lib/giantbomb/game.rb
+- lib/giantbomb/location.rb
+- lib/giantbomb/object.rb
+- lib/giantbomb/person.rb
 - lib/giantbomb/resource.rb
 - lib/giantbomb/search.rb
+- lib/giantbomb/video.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/giantbomb
 licenses: []
@@ -74,6 +93,6 @@ rubyforge_project: giantbomb
 rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: A Ruby wrapper for the GiantBomb API.
+summary: A Ruby wrapper for the Giant Bomb video game wiki API.
 test_files: []
 

data/README

@@ -1,18 +0,0 @@
-A Ruby wrapper for the GiantBomb API.
-
-Configuration:
-
-GiantBomb::Api.key(API_KEY_HERE)
-
-
-Usage:
-
-search = GiantBomb::Search.new
-search.limit(10) # optional - limits number of items returned 
-search.resources('game') # optional - specifies types of resource to search
-search.fields('name,deck') # optional - specifies fields to return
-search.offset(100) # optional - number of items to offset by
-search.query('duke nukem') # required - the search term
-
-results = search.fetch
-