giantbomb 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.DS_Store

data/Gemfile

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

data/README

@@ -0,0 +1,18 @@
+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
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/giantbomb.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "giantbomb"
+
+Gem::Specification.new do |s|
+  s.name        = "giantbomb"
+  s.version     = GiantBomb::VERSION
+  s.platform    = Gem::Platform::RUBY
+  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.rubyforge_project = "giantbomb"
+
+  s.files         = `git ls-files`.split("\n")
+  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"]
+end

data/lib/giantbomb.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'httparty'
+
+["api", "search", "game"].each do |inc|
+  require File.join(File.dirname(__FILE__), "giantbomb", inc)
+end
+
+module GiantBomb
+  VERSION = "0.0.1"
+end

data/lib/giantbomb/api.rb

@@ -0,0 +1,11 @@
+module GiantBomb
+  class Api
+    include HTTParty
+    base_uri 'api.giantbomb.com'
+    
+    def self.key(api_key)
+      @@config = { :api_key => api_key, :format => 'json' }
+    end
+    
+  end
+end

data/lib/giantbomb/game.rb

@@ -0,0 +1,83 @@
+module GiantBomb
+  class Game < Api
+    # http://api.giantbomb.com/documentation/#game
+    @@fields = [
+      :aliases, # List of aliases the game is known by. A \n (newline) separates each alias.
+      :api_detail_url, # URL pointing to the game detail resource
+      :characters, # Characters related to the game
+      :concepts, # Concepts related to the game
+      :date_added, # Date the game was added to Giant Bomb
+      :date_last_updated, # Date the game was last updated on Giant Bomb
+      :deck, # Brief summary of the game
+      :description, # Description of the game
+      :developers, # Companies that developed the game
+      :expected_release_month, # Expected month the game will be released in. The month is represented numerically.
+      :expected_release_quarter, # Expected quarter game will be released in. The quarter is represented numerically, where 1 = Q1, 2 = Q2, 3 = Q3, and 4 = Q4.
+      :expected_release_year, # Expected year the game will be released in.
+      :first_appearance_characters, # Characters that first appeared in the game
+      :first_appearance_concepts, # Concepts that first appeared in the game
+      :first_appearance_locations, # Locations that first appeared in the game
+      :first_appearance_objects, # Objects that first appeared in the game
+      :first_appearance_people, # People that were first credited in the game
+      :franchises, # Franchises the game is a part of
+      :genres, # Genres that encompass the game
+      :id, # Unique ID of the game
+      :image, # Main Image of the game
+      :images, # List of images associated to the game
+      :killed_characters, # Characters killed in the game
+      :locations, # Locations related to the game
+      :name, # Name of the game
+      :number_of_user_reviews, # Number of user reviews of the game on Giant Bomb
+      :objects, # Objects related to the game
+      :original_game_rating, # Rating of the first release of the game
+      :original_release_date, # Date the game was first released
+      :people, # People related to the game
+      :platforms, # Platforms the game can be played on
+      :publishers, # Companies that published the game
+      :releases, # Releases of the game
+      :reviews, # Staff reviews of the game
+      :similar_games, # Other games that are similar to the game
+      :site_detail_url, # URL pointing to the game on Giant Bomb
+      :themes, # Themes that encompass the game
+      :videos # Videos associated to the game
+    ]
+    
+    @@fields.each do |field|
+      attr_accessor field
+    end
+    
+    def initialize(attributes={})
+      attributes.each do |key, value|
+        if self.respond_to?(key.to_sym)
+          self.instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+    
+    def self.detail(id, conditions={})
+      search = GiantBomb::Search.new("/game/#{id}/")
+      search.filter(conditions)
+      Game.new(search.fetch)
+    end
+    
+    def self.list(conditions={})
+      search = GiantBomb::Search.new("/games")
+      search.filter(conditions)
+      search.fetch.collect do |result|
+        Game.new(result)
+      end
+    end
+    
+    def self.search(query)
+      search = GiantBomb::Search.new
+      search.resources('game')
+      search.query(query)
+      search.fetch
+    end
+    
+    class << self
+      alias_method :find, :search
+    end
+
+  end
+end

data/lib/giantbomb/search.rb

@@ -0,0 +1,62 @@
+module GiantBomb
+  class Search < Api
+    attr_reader :query, :resource
+    
+    def initialize(resource=nil)
+      @params = {}
+      @resource = resource.nil? ? '/search' : resource
+      self
+    end
+    
+    # GiantBomb::Search.new.fields('name,deck')
+    def fields(fields)
+      @params[:field_list] = "#{fields}"
+      self
+    end
+    
+    # GiantBomb::Search.new.limit(1)
+    def limit(limit)
+      @params[:limit] = "#{limit}"
+      self
+    end
+    
+    # GiantBomb::Search.new.offset(100)
+    def offset(offset)
+      @params[:offset] = "#{offset}"
+      self
+    end
+    
+    # GiantBomb::Search.new.query('duke nukem')
+    def query(query)
+      @params[:query] = "#{query}"
+      self
+    end
+    
+    # GiantBomb::Search.new.resources('game')
+    def resources(resources)
+      @params[:resources] = "#{resources}"
+      self
+    end
+
+    # 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)
+      if conditions
+        conditions.each do |key, value|
+          if self.respond_to?(key)
+            self.send(key, value)
+          end
+        end
+      end
+    end
+    
+    # GiantBomb::Search.new.query('duke nukem').fetch
+    def fetch
+      options = @params.merge(@@config)
+      response = self.class.get(@resource, :query => options)
+      response['results']
+    end
+        
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: giantbomb
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robert Coker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-10 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Provides a simple, easy to use interface for the GiantBomb API.
+email: 
+- rob@robertsays.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- giantbomb.gemspec
+- lib/giantbomb.rb
+- lib/giantbomb/api.rb
+- lib/giantbomb/game.rb
+- lib/giantbomb/search.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/giantbomb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: giantbomb
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the GiantBomb API.
+test_files: []
+