productwars-api 0.1.0

data/spec/product_wars_spec.rb

@@ -0,0 +1,337 @@
+require 'spec_helper'
+require 'product_wars'
+require 'errors'
+
+PRODUCT_KEYS = [
+                 "active",
+                 "asset_url",
+                 "created_at",
+                 "description",
+                 "dp_id",
+                 "fights",
+                 "global_rank",
+                 "image_url",
+                 "manufacturer",
+                 "name",
+                 "permalink",
+                 "updated_at",
+                 "wins"
+               ]
+
+WAR_KEYS = [ 
+            'name', 
+            'created_at', 
+            'updated_at', 
+            'id', 
+            'fights', 
+            'description', 
+            'active' 
+           ]
+
+STATS_KEYS = [
+              'dp_id',
+              'fights',
+              'global_rank',
+              'name',
+              'manufacturer',
+              'wins',
+              'win_rate'
+             ]
+
+describe 'ProductWars' do
+  describe "::product" do
+
+    context "successful request" do
+      use_vcr_cassette
+
+      it "should retrieve a ProductWars::Product" do
+        response = ProductWars.product(42067)
+        response.class.should == ProductWars::Product
+      end
+
+      it "the reponse should contain the keys specified in the API docs" do 
+        product = ProductWars.product(42067)
+
+         for key in PRODUCT_KEYS do
+           product.has_key?(key).should == true
+           #TODO This fails because the "id" attribute isn't accounted for.
+           # This is because the dp_id takes the place of the product id in
+           # all circumstances. In other words, the Product Wars app has a bug.
+           product.keys.count.should == PRODUCT_KEYS.count
+         end
+      end
+    end
+
+    context "unsuccessful request" do
+      use_vcr_cassette
+
+      it "should raise a NotFound error if the specified resource doesn't exist" do
+        lambda{ 
+          ProductWars.product('bad_id') 
+        }.should raise_error(ProductWars::Errors::NotFound)
+      end
+    end
+  end
+
+  describe "::wars_containing_product" do
+    context "successful request" do
+      use_vcr_cassette
+
+      it "should retrieve an Array" do
+        wars_array = ProductWars.wars_containing_product(42067)
+        wars_array.class.should == Array
+      end
+
+      it "should retrieve an Array containing ProductWars::War objects" do
+        wars_array = ProductWars.wars_containing_product(42067)
+
+        for h in wars_array do
+          h.class.should == ProductWars::War
+        end
+      end
+
+      it "should contain properly formatted war hashes" do
+        wars_array = ProductWars.wars_containing_product(42067)
+
+        for w in wars_array
+           for key in WAR_KEYS do
+             w.has_key?(key).should == true
+             w.keys.count.should == WAR_KEYS.count
+           end
+        end
+      end
+    end
+
+    context "unsuccessful request" do
+      use_vcr_cassette
+
+      it "should raise a NotFound error if the specified resource doesn't exist" do
+        lambda{ 
+          ProductWars.wars_containing_product('bad_id') 
+        }.should raise_error(ProductWars::Errors::NotFound)
+      end
+    end
+  end
+
+  describe "::all_wars" do
+    context "successful wars index request" do
+      use_vcr_cassette
+
+      it "should retrieve an Array" do
+        wars_array = ProductWars.all_wars
+        wars_array.class.should == Array
+      end
+
+      it "should retrieve an Array containing ProductWars::War objects" do
+        wars_array = ProductWars.all_wars
+
+        for h in wars_array do
+          h.class.should == ProductWars::War
+        end
+      end
+
+      it "should contain properly formatted war hashes" do
+        wars_array = ProductWars.all_wars
+
+        for w in wars_array
+           for key in WAR_KEYS do
+             w.has_key?(key).should == true
+             w.keys.count.should == WAR_KEYS.count
+           end
+        end
+      end
+    end
+
+    # There are currently no exceptions this can raise
+    #context "unsuccessful request" do
+    #  use_vcr_cassette
+
+    #  it "should raise a NotFound error if the specified resource doesn't exist" do
+    #    lambda{ 
+    #      ProductWars.all_wars
+    #    }.should raise_error(ProductWars::Errors::NotFound)
+    #  end
+    #end
+  end
+
+  describe "::product_stats" do
+    context "successful request" do
+      use_vcr_cassette
+
+      it "should retrieve a ProductWars::Stats" do
+        response = ProductWars.product_stats(42067)
+        response.class.should == ProductWars::Stats
+      end
+
+      it "the reponse should contain the keys specified in the API docs" do 
+        stats = ProductWars.product_stats(42067)
+
+         for key in STATS_KEYS do
+           stats.has_key?(key).should == true
+           stats.keys.count.should == STATS_KEYS.count
+         end
+      end
+    end
+
+    context "unsuccessful request" do
+      use_vcr_cassette
+
+      it "should raise a NotFound error if the specified resource doesn't exist" do
+        lambda{ 
+          ProductWars.product_stats('bad_id') 
+        }.should raise_error(ProductWars::Errors::NotFound)
+      end
+    end
+  end
+
+  describe "::war" do
+    context "successful request" do
+      use_vcr_cassette
+
+      it "should retrieve a ProductWars::War" do
+        response = ProductWars.war(1)
+        response.class.should == ProductWars::War
+      end
+
+      it "the reponse should contain the keys specified in the API docs" do 
+        war = ProductWars.war(1)
+
+         for key in WAR_KEYS do
+           war.has_key?(key).should == true
+           war.keys.count.should == WAR_KEYS.count
+         end
+      end
+    end
+
+    context "unsuccessful request" do
+      use_vcr_cassette
+
+      it "should raise a NotFound error if the specified resource doesn't exist" do
+        lambda{ 
+          ProductWars.war('bad_id') 
+        }.should raise_error(ProductWars::Errors::NotFound)
+      end
+    end
+  end
+
+  describe "::products_in_war" do
+    context "successful products index request" do
+      use_vcr_cassette
+
+      it "should retrieve an Array" do
+        products_array = ProductWars.products_in_war(1)
+        products_array.class.should == Array
+      end
+
+      it "should retrieve an Array containing ProductWars::Product objects" do
+        products_array = ProductWars.products_in_war(1)
+
+        for h in products_array do
+          h.class.should == ProductWars::Product
+        end
+      end
+
+      it "should contain properly formatted product hashes" do
+        products_array = ProductWars.products_in_war(1)
+
+        for p in products_array
+           for key in PRODUCT_KEYS do
+             p.has_key?(key).should == true
+             p.keys.count.should == PRODUCT_KEYS.count
+           end
+        end
+      end
+    end
+
+    context "unsuccessful request" do
+      use_vcr_cassette
+
+      it "should raise a NotFound error if the specified resource doesn't exist" do
+        lambda{ 
+          ProductWars.products_in_war('bad_id') 
+        }.should raise_error(ProductWars::Errors::NotFound)
+      end
+    end
+  end
+
+  describe "::global_leaders" do
+    context "successful products index request" do
+      use_vcr_cassette
+
+      it "should retrieve an Array" do
+        products_array = ProductWars.global_leaders
+        products_array.class.should == Array
+      end
+
+      it "should retrieve an Array containing ProductWars::Product objects" do
+        products_array = ProductWars.global_leaders
+
+        for h in products_array do
+          h.class.should == ProductWars::Product
+        end
+      end
+
+      it "should contain properly formatted product hashes" do
+        products_array = ProductWars.global_leaders
+
+        for p in products_array
+           for key in PRODUCT_KEYS do
+             p.has_key?(key).should == true
+             p.keys.count.should == PRODUCT_KEYS.count
+           end
+        end
+      end
+    end
+
+    #There are currently no exceptions this will raise directly
+    #context "unsuccessful request" do
+    #  use_vcr_cassette
+
+    #  it "should raise a NotFound error if the specified resource doesn't exist" do
+    #    lambda{ 
+    #      ProductWars.global_leaders
+    #    }.should raise_error(ProductWars::Errors::NotFound)
+    #  end
+    #end
+  end
+
+  describe "::leaders_in_war" do
+    context "successful request" do
+      use_vcr_cassette
+
+      it "should retrieve an Array" do
+        products_array = ProductWars.leaders_in_war(1)
+        products_array.class.should == Array
+      end
+
+      it "should retrieve an Array containing ProductWars::Product objects" do
+        products_array = ProductWars.leaders_in_war(1)
+
+        for h in products_array do
+          h.class.should == ProductWars::Product
+        end
+      end
+
+      it "should contain properly formatted product hashes" do
+        products_array = ProductWars.leaders_in_war(1)
+
+        for p in products_array
+           for key in PRODUCT_KEYS do
+             p.has_key?(key).should == true
+             p.keys.count.should == PRODUCT_KEYS.count
+           end
+        end
+      end
+    end
+
+    context "unsuccessful request" do
+      use_vcr_cassette
+
+      it "should raise a NotFound error if the specified resource doesn't exist" do
+        lambda{ 
+          ProductWars.leaders_in_war('bad_id') 
+        }.should raise_error(ProductWars::Errors::NotFound)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'vcr'
+require 'ruby-debug'
+
+VCR.config do |c|
+  c.cassette_library_dir     = 'spec/cassettes'
+  c.stub_with                :fakeweb
+  c.default_cassette_options = { :record => :once }
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification 
+name: productwars-api
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Spencer Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 7
+        - 4
+        version: 0.7.4
+  name: httparty
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: hashie
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 7
+        - 0
+        version: 1.7.0
+  name: vcr
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: fakeweb
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  name: rspec
+  version_requirements: *id009
+  prerelease: false
+description: This gem provides object-like functionality for retrieving and manipulating data from the Product Wars API
+email: spencer@designerpages.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/productwars.rb
+- lib/productwars/client.rb
+- lib/productwars/errors.rb
+- lib/productwars/product.rb
+- lib/productwars/response.rb
+- lib/productwars/stats.rb
+- lib/productwars/war.rb
+- productwars-api.gemspec
+- spec/cassettes/ProductWars/_all_wars/successful_wars_index_request.yml
+- spec/cassettes/ProductWars/_global_leaders/successful_products_index_request.yml
+- spec/cassettes/ProductWars/_leaders_in_war/successful_request.yml
+- spec/cassettes/ProductWars/_leaders_in_war/unsuccessful_request.yml
+- spec/cassettes/ProductWars/_product/successful_request.yml
+- spec/cassettes/ProductWars/_product/unsuccessful_request.yml
+- spec/cassettes/ProductWars/_product_stats/successful_request.yml
+- spec/cassettes/ProductWars/_product_stats/unsuccessful_request.yml
+- spec/cassettes/ProductWars/_products_in_war/successful_products_index_request.yml
+- spec/cassettes/ProductWars/_products_in_war/unsuccessful_request.yml
+- spec/cassettes/ProductWars/_war/successful_request.yml
+- spec/cassettes/ProductWars/_war/unsuccessful_request.yml
+- spec/cassettes/ProductWars/_wars_containing_product/successful_request.yml
+- spec/cassettes/ProductWars/_wars_containing_product/unsuccessful_request.yml
+- spec/product_wars_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/spencer1248/product-wars-ruby-api-wrapper
+licenses: 
+- MIT
+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: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: API wrapper for productwars.com
+test_files: 
+- spec/product_wars_spec.rb
+- spec/spec_helper.rb