giant_bomb 0.1.1 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/giant_bomb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{giant_bomb}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jon Maddox"]
-  s.date = %q{2009-10-21}
+  s.date = %q{2009-10-27}
   s.description = %q{Simple library to talkto the awesome GiantBomb data}
   s.email = %q{jon@fanzter.com}
   s.extra_rdoc_files = [
@@ -25,9 +25,15 @@ Gem::Specification.new do |s|
      "VERSION",
      "giant_bomb.gemspec",
      "lib/giant_bomb.rb",
+     "lib/giant_bomb/attributes.rb",
+     "lib/giant_bomb/core_extensions.rb",
+     "lib/giant_bomb/developer.rb",
      "lib/giant_bomb/game.rb",
+     "lib/giant_bomb/genre.rb",
      "lib/giant_bomb/httparty_icebox.rb",
+     "lib/giant_bomb/publisher.rb",
      "lib/giant_bomb/search.rb",
+     "test/fixtures/get_info.json",
      "test/fixtures/search.json",
      "test/fixtures/sketchy_results.json",
      "test/giant_bomb_test.rb",

data/lib/giant_bomb/attributes.rb

@@ -0,0 +1,52 @@
+module GiantBomb
+  module Attributes
+    # based on http://github.com/nullstyle/ruby-satisfaction
+    
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+        attr_reader :attributes
+      end
+    end
+
+    module ClassMethods
+      def attributes(*names)
+        options = names.extract_options!
+
+        names.each do |name|
+          attribute name, options unless name.blank?
+        end
+      end
+
+      def attribute(name, options)
+        options.replace({:type => 'nil', :lazy=>false}.merge(options))
+        raise "Name can't be empty" if name.blank?
+        lazy_load = "self.#{options[:lazy]} unless self.loaded?" if options[:lazy]
+        class_eval <<-EOS
+  def #{name}
+    #{lazy_load}
+    @#{name} ||= decode_raw_attribute(@attributes['#{name}'], #{options[:type]}) if @attributes
+  end
+  EOS
+      end
+
+    end
+
+    module InstanceMethods
+      def attributes=(value)
+        @attributes = value
+      end
+      
+      def loaded?
+        @loaded
+      end
+
+      private
+      def decode_raw_attribute(value, type)
+        return nil unless value
+        type.respond_to?(:parse) ? type.parse(value) : value
+      end
+    end
+  end
+end

data/lib/giant_bomb/core_extensions.rb

@@ -0,0 +1,18 @@
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+  
+end
+
+class Float
+  def self.parse(val)
+    Float(val)
+  end
+end
+
+class Integer
+  def self.parse(val)
+    Integer(val)
+  end
+end

data/lib/giant_bomb/developer.rb

@@ -0,0 +1,21 @@
+module GiantBomb
+  class Developer
+    include Attributes
+    attributes :name, :id
+    
+    def initialize(values)
+      self.attributes = values
+    end
+    
+    def self.parse(data)
+      return unless data
+      if data.is_a?(Array)
+        data.collect do |g|
+          Developer.new(g)
+        end
+      else
+        [Developer.new(data)]
+      end
+    end
+  end
+end

data/lib/giant_bomb/game.rb

@@ -1,26 +1,34 @@
 module GiantBomb
   class Game
-    attr_accessor :id, :name, :deck, :description, :date_last_updated, :original_release_date, :site_detail_url,
-                  :number_of_user_reviews, :date_added, :original_game_rating, :image
+    include Attributes
+    attr_reader :client
     
-    def initialize(options={})
-      @image = {}
+    attributes :id, :name, :deck, :description, :original_game_rating, :image
 
-      @id = options["id"]
-      @name = options["name"]
-      @deck = options["deck"]
-      @description = options["description"]
-      @site_detail_url = options["site_detail_url"]
-      @number_of_user_reviews = options["number_of_user_reviews"]
-      @original_game_rating = options["original_game_rating"]
+    attributes :number_of_user_reviews, :type => Integer
+    attributes :date_last_updated, :original_release_date, :date_added, :type => Date
 
-      @date_last_updated = DateTime.parse(options["date_last_updated"]) if options["date_last_updated"]
-      @original_release_date = DateTime.parse(options["original_release_date"]) if options["original_release_date"]
-      @date_added = DateTime.parse(options["date_added"]) if options["date_added"]
+    attributes :genres, :lazy => :get_info!, :type => Genre
+    attributes :publishers, :lazy => :get_info!, :type => Publisher
+    attributes :developers, :lazy => :get_info!, :type => Developer
 
-      options["image"].each{|key,value| @image[key.gsub('_url', '').to_sym] = value } if options["image"]
+    attributes :images, :lazy => :get_info!
+
+    alias_method :cover, :image
+    
+    def initialize(values, client)
+      @client = client
+      self.attributes = values
+    end
+    
+    def get_info!
+      game = client.get_game_info(self.id)
+      @attributes.merge!(game.attributes) if game
+      @loaded = true
     end
     
+    
+    
   end
 
 end

data/lib/giant_bomb/genre.rb

@@ -0,0 +1,21 @@
+module GiantBomb
+  class Genre
+    include Attributes
+    attributes :name, :id
+    
+    def initialize(values)
+      self.attributes = values
+    end
+    
+    def self.parse(data)
+      return unless data
+      if data.is_a?(Array)
+        data.collect do |g|
+          Genre.new(g)
+        end
+      else
+        [Genre.new(data)]
+      end
+    end
+  end
+end

data/lib/giant_bomb/publisher.rb

@@ -0,0 +1,21 @@
+module GiantBomb
+  class Publisher
+    include Attributes
+    attributes :name, :id
+    
+    def initialize(values)
+      self.attributes = values
+    end
+    
+    def self.parse(data)
+      return unless data
+      if data.is_a?(Array)
+        data.collect do |g|
+          Publisher.new(g)
+        end
+      else
+        [Publisher.new(data)]
+      end
+    end
+  end
+end

data/lib/giant_bomb/search.rb

@@ -2,8 +2,8 @@ module GiantBomb
   class Search
     include HTTParty
     format :json
-    include HTTParty::Icebox
-    cache :store => 'file', :timeout => 120, :location => Dir.tmpdir
+    # include HTTParty::Icebox
+    # cache :store => 'file', :timeout => 120, :location => Dir.tmpdir
     
     base_uri 'api.giantbomb.com'
 
@@ -21,7 +21,15 @@ module GiantBomb
       options = {"query" => keywords, "resources" => "game"}
       options.merge!(default_query_options)
       response = self.class.get("/search", :query => options)
-      response["results"].collect{|r| Game.new(r)}
+      response["results"].collect{|r| Game.new(r, self)}
+    end
+
+    def get_game_info(game_id)
+      field_list = %w{developers genres images publishers}
+      options = {"field_list" => field_list.join(',')}
+      options.merge!(default_query_options)
+      response = self.class.get("/game/#{game_id}/", :query => options)
+      Game.new(response["results"], self)
     end
 
   end

data/lib/giant_bomb.rb

@@ -2,5 +2,10 @@ require 'httparty'
 
 directory = File.expand_path(File.dirname(__FILE__))
 require File.join(directory, 'giant_bomb', 'httparty_icebox')
+require File.join(directory, 'giant_bomb', 'core_extensions')
+require File.join(directory, 'giant_bomb', 'attributes')
 require File.join(directory, 'giant_bomb', 'search')
+require File.join(directory, 'giant_bomb', 'genre')
+require File.join(directory, 'giant_bomb', 'developer')
+require File.join(directory, 'giant_bomb', 'publisher')
 require File.join(directory, 'giant_bomb', 'game')

data/test/fixtures/get_info.json

@@ -0,0 +1,117 @@
+{
+    "number_of_page_results": 1,
+    "status_code": 1,
+    "error": "OK",
+    "results": {
+        "images": [{
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141522-odst_campaign_onialphasite_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141522-odst_campaign_onialphasite_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141522-odst_campaign_onialphasite_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141522-odst_campaign_onialphasite_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141522-odst_campaign_onialphasite_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141521-odst_campaign_kizingo04_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141521-odst_campaign_kizingo04_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141521-odst_campaign_kizingo04_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141521-odst_campaign_kizingo04_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141521-odst_campaign_kizingo04_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141520-odst_campaign_kizingo03_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141520-odst_campaign_kizingo03_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141520-odst_campaign_kizingo03_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141520-odst_campaign_kizingo03_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141520-odst_campaign_kizingo03_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141518-odst_campaign_kizingo02_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141518-odst_campaign_kizingo02_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141518-odst_campaign_kizingo02_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141518-odst_campaign_kizingo02_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141518-odst_campaign_kizingo02_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141517-odst_campaign_kizingo01_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141517-odst_campaign_kizingo01_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141517-odst_campaign_kizingo01_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141517-odst_campaign_kizingo01_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141517-odst_campaign_kizingo01_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141516-odst_campaign_kikowani03_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141516-odst_campaign_kikowani03_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141516-odst_campaign_kikowani03_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141516-odst_campaign_kikowani03_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141516-odst_campaign_kikowani03_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141515-odst_campaign_kikowani02_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141515-odst_campaign_kikowani02_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141515-odst_campaign_kikowani02_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141515-odst_campaign_kikowani02_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141515-odst_campaign_kikowani02_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141514-odst_campaign_kikowani01_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141514-odst_campaign_kikowani01_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141514-odst_campaign_kikowani01_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141514-odst_campaign_kikowani01_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141514-odst_campaign_kikowani01_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141511-odst_firefight_lostplatoon08_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141511-odst_firefight_lostplatoon08_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141511-odst_firefight_lostplatoon08_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141511-odst_firefight_lostplatoon08_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141511-odst_firefight_lostplatoon08_super.jpg"
+        },
+        {
+            "screen_url": "http://media.giantbomb.com/uploads/0/26/1141504-odst_firefight_lostplatoon06_screen.jpg",
+            "small_url": "http://media.giantbomb.com/uploads/0/26/1141504-odst_firefight_lostplatoon06_small.jpg",
+            "thumb_url": "http://media.giantbomb.com/uploads/0/26/1141504-odst_firefight_lostplatoon06_thumb.jpg",
+            "tiny_url": "http://media.giantbomb.com/uploads/0/26/1141504-odst_firefight_lostplatoon06_tiny.jpg",
+            "super_url": "http://media.giantbomb.com/uploads/0/26/1141504-odst_firefight_lostplatoon06_super.jpg"
+        }],
+        "publishers": [{
+            "api_detail_url": "http://api.giantbomb.com/company/6753/",
+            "id": 6753,
+            "name": "343 Industries"
+        },
+        {
+            "api_detail_url": "http://api.giantbomb.com/company/340/",
+            "id": 340,
+            "name": "Microsoft Game Studios"
+        }],
+        "genres": [{
+            "api_detail_url": "http://api.giantbomb.com/genre/11/",
+            "id": 11,
+            "name": "Shooter"
+        },
+        {
+            "api_detail_url": "http://api.giantbomb.com/genre/1/",
+            "id": 1,
+            "name": "Action"
+        },
+        {
+            "api_detail_url": "http://api.giantbomb.com/genre/32/",
+            "id": 32,
+            "name": "First-Person Shooter"
+        }],
+        "developers": [{
+            "api_detail_url": "http://api.giantbomb.com/company/476/",
+            "id": 476,
+            "name": "Bungie Studios"
+        }],
+        "image": {
+            "screen_url": "http://media.giantbomb.com/uploads/1/14735/1101733-20090611232449_halo_3_odst_box_art_screen.png",
+            "small_url": "http://media.giantbomb.com/uploads/1/14735/1101733-20090611232449_halo_3_odst_box_art_small.png",
+            "thumb_url": "http://media.giantbomb.com/uploads/1/14735/1101733-20090611232449_halo_3_odst_box_art_thumb.png",
+            "tiny_url": "http://media.giantbomb.com/uploads/1/14735/1101733-20090611232449_halo_3_odst_box_art_tiny.png",
+            "super_url": "http://media.giantbomb.com/uploads/1/14735/1101733-20090611232449_halo_3_odst_box_art_super.png"
+        }
+    },
+    "limit": 1,
+    "offset": 0,
+    "number_of_total_results": 1
+}

data/test/giant_bomb_test.rb

@@ -6,104 +6,131 @@ class GiantBombTest < Test::Unit::TestCase
     setup do 
       @gb = GiantBomb::Search.new("key")
     end
-
+    
     context 'searching' do
       context 'for a game' do
         setup do
-          stub_get('/search/?api_key=key&query=halo&resources=game&format=json', 'search.json')
+          stub_get('/search?format=json&api_key=key&resources=game&query=halo', 'search.json')
           @results = @gb.find_game('halo')
         end
         
         should "return an array" do
           assert_equal Array, @results.class
         end
-
+    
         should "return an array of Games" do
           assert_equal GiantBomb::Game, @results.first.class
         end
       end
     end
-
+    
     context 'Games' do
       context 'with good data' do
         setup do
-          stub_get('/search/?api_key=key&query=halo&resources=game&format=json', 'search.json')
+          stub_get('/search?format=json&api_key=key&resources=game&query=halo', 'search.json')
+          stub_get('/game/24035/?format=json&api_key=key&field_list=developers%2Cgenres%2Cimages%2Cpublishers', 'get_info.json')
+                    
           @game = @gb.find_game('halo').first
         end
-
+    
         should "have a name" do
           assert_equal 'Halo 3: ODST', @game.name
         end
-
+    
         should "have a deck" do
           assert_not_nil @game.deck
         end
-
+    
         should "have a description" do
           assert_not_nil @game.deck
         end
-
+    
         should "have parsed date_last_updated to be a real date" do
-          assert_equal DateTime, @game.date_last_updated.class
+          assert_equal Date, @game.date_last_updated.class
         end
-
+    
         should "have parsed original_release_date to be a real date" do
-          assert_equal DateTime, @game.original_release_date.class
+          assert_equal Date, @game.original_release_date.class
         end
-
+    
         should "have parsed date_added to be a real date" do
-          assert_equal DateTime, @game.date_added.class
+          assert_equal Date, @game.date_added.class
         end
-
+    
         context 'with an image' do
+    
+          should 'cover should be an alias to image' do
+            assert_equal @game.image, @game.cover
+          end
 
           should 'have an image hash' do
             assert_equal Hash, @game.image.class
           end
-
+    
           should 'have multiple sizes for the image' do
             assert_equal 5, @game.image.keys.size
           end
-
+              
           should 'have these sizes with symbols for keys' do
-            assert_not_nil @game.image[:super]
-            assert_not_nil @game.image[:small]
-            assert_not_nil @game.image[:thumb]
-            assert_not_nil @game.image[:tiny]
-            assert_not_nil @game.image[:screen]
+            assert_not_nil @game.image["super_url"]
+            assert_not_nil @game.image["small_url"]
+            assert_not_nil @game.image["thumb_url"]
+            assert_not_nil @game.image["tiny_url"]
+            assert_not_nil @game.image["screen_url"]
+          end
+        end
+
+        context 'lazy loaded attrs' do
+          
+          should 'have a genres array' do
+            assert_equal Array, @game.genres.class
+          end
+
+          should 'have a developers array' do
+            assert_equal Array, @game.developers.class
+          end
+
+          should 'have a publishers array' do
+            assert_equal Array, @game.publishers.class
+          end
+
+          should 'have an images array' do
+            assert_equal Array, @game.images.class
           end
 
+          should 'have an images array of hashes' do
+            assert_equal Hash, @game.images.first.class
+          end
+          
         end
+
       end
       
       
       context 'with sketchy data' do
         setup do
-          stub_get('/search/?api_key=key&query=halo2&resources=game&format=json', 'sketchy_results.json')
+          stub_get('/search?format=json&api_key=key&resources=game&query=halo2', 'sketchy_results.json')
           @game = @gb.find_game('halo2').first
-          puts @game.name
         end
         
         should 'handle not having date_added' do
           assert_nil @game.date_added
         end
-
+          
         should 'handle not having original_release_date' do
           assert_nil @game.original_release_date
         end
-
+          
         should 'handle not having date_last_updated' do
           assert_nil @game.date_last_updated
         end
-
+          
         should 'handle not having image urls' do
-          assert_equal Hash, @game.image.class
-          assert_equal 0, @game.image.keys.size
+          assert_nil @game.image
         end
-
       end
-
-
+    
+    
     end
     
   end

data/test/test_helper.rb

@@ -8,6 +8,8 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'giant_bomb'
 
+# FakeWeb.allow_net_connect = false
+
 class Test::Unit::TestCase
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: giant_bomb
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jon Maddox
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-21 00:00:00 -04:00
+date: 2009-10-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,9 +60,15 @@ files:
 - VERSION
 - giant_bomb.gemspec
 - lib/giant_bomb.rb
+- lib/giant_bomb/attributes.rb
+- lib/giant_bomb/core_extensions.rb
+- lib/giant_bomb/developer.rb
 - lib/giant_bomb/game.rb
+- lib/giant_bomb/genre.rb
 - lib/giant_bomb/httparty_icebox.rb
+- lib/giant_bomb/publisher.rb
 - lib/giant_bomb/search.rb
+- test/fixtures/get_info.json
 - test/fixtures/search.json
 - test/fixtures/sketchy_results.json
 - test/giant_bomb_test.rb