comic_vine 0.0.8 → 0.1.0

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage
+.DS_Store

data/comic_vine.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |gem|
   
   gem.add_dependency 'json'
   gem.add_development_dependency "rspec", ">= 2.0.0"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "simplecov"
 end

data/lib/comic_vine/version.rb

@@ -1,3 +1,3 @@
 module ComicVine
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/lib/comic_vine.rb

@@ -50,7 +50,7 @@ module ComicVine
       end
     
       def types
-        if @@types.nil? || (@@last_type_check + (4 *60 *60)) > Time.now
+        if @@types.nil? || (@@last_type_check + (4 *60 *60)) < Time.now
           @@last_type_check = Time.now
           @@types = hit_api(build_base_url('types'))['results']
         end

data/spec/comic_vine_spec.rb

@@ -1,11 +1,122 @@
 require 'spec_helper'
 describe ComicVine do
-  it "should allow the user to set the API key" do
+  before(:all) do
     ComicVine::API.key = "some_api_key"
-    ComicVine::API.key.should == "some_api_key"
   end
   
-  it "should raise a ComicVine::CVError on an API call without the key set" do
-    expect{ ComicVine::API.issues }.to raise_error(ComicVine::CVError)
+  specify { ComicVine::API.key.should == "some_api_key" }
+  
+  context "when has invalid api key" do
+    it "should get a CVError" do
+      WebMock.allow_net_connect!
+      lambda { ComicVine::API.issues }.should raise_error(ComicVine::CVError)
+      WebMock.disable_net_connect!
+    end
+  end
+  
+  context "when has valid api key" do
+    before { stub_request(:get, "http://api.comicvine.com/types/").with(:query => {:format => 'json', :api_key => ComicVine::API.key}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => TYPES_BODY, :headers => {}) }
+    
+    describe "invalid method" do
+      it "should raise NoMethodError" do
+        lambda { ComicVine::API.something }.should raise_error(NoMethodError)
+      end
+    end
+    
+    describe "types_detail" do
+      before { @types_detail = ComicVine::API.find_detail "issue" }
+      subject { @types_detail }
+      
+      specify { @types_detail["list_resource_name"].should == "issues" }
+      specify { @types_detail["detail_resource_name"].should == "issue" }
+    end
+    
+    describe "types_list" do
+      before { @types_list = ComicVine::API.find_list "issues" }
+      subject { @types_list }
+      
+      specify { @types_list["list_resource_name"].should == "issues" }
+      specify { @types_list["detail_resource_name"].should == "issue" }
+    end
+    
+    describe "ComicVine search" do
+      before do
+        stub_request(:get, "http://api.comicvine.com/search/").with(:query => {:format => 'json', :api_key => ComicVine::API.key, :limit => 1, :resources => "volume", :query => "gizmo"}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => SEARCH_BODY_1, :headers => {})
+        stub_request(:get, "http://api.comicvine.com/search/").with(:query => {:format => 'json', :api_key => ComicVine::API.key, :limit => 1, :offset => 0, :resources => "volume", :query => "gizmo"}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => SEARCH_BODY_1, :headers => {})
+        stub_request(:get, "http://api.comicvine.com/search/").with(:query => {:format => 'json', :api_key => ComicVine::API.key, :limit => 1, :offset => 1, :resources => "volume", :query => "gizmo"}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => SEARCH_BODY_2, :headers => {})
+        @results = ComicVine::API.search "volume", "gizmo", {:limit => 1}
+      end
+      subject { @results }
+      
+      it { should be_a_kind_of ComicVine::CVSearchList }
+      it { should respond_to("total_count", "offset", "limit", "resource", "query")}
+      specify { @results.first.should be_a_kind_of ComicVine::CVSearchObject }
+      specify { @results.first.should == @results.last }
+      specify { @results.prev_page.should be_nil }
+      
+      context "when on last page" do
+        before { @results.next_page }
+        
+        specify { @results.should be_a_kind_of ComicVine::CVSearchList }
+        specify { @results.next_page.should be_nil }
+        it "should update the list on prev_page" do
+          @results.prev_page
+          @results.should be_a_kind_of ComicVine::CVSearchList
+        end
+      end
+      
+      it "should fetch the full CVObject" do
+        stub_request(:get, "http://api.comicvine.com/volume/24708/").with(:query => {:format => 'json', :api_key => ComicVine::API.key}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => VOLUME_BODY, :headers => {})
+        vol = @results.first.fetch
+        vol.should be_a_kind_of ComicVine::CVObject
+      end
+    end
+    
+    describe "ComicVine list" do
+      before do
+        stub_request(:get, "http://api.comicvine.com/issues/").with(:query => {:format => 'json', :api_key => ComicVine::API.key}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => ISSUES_BODY_1, :headers => {})
+        stub_request(:get, "http://api.comicvine.com/issues/").with(:query => {:format => 'json', :api_key => ComicVine::API.key, :limit => 2, :offset => 0}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => ISSUES_BODY_1, :headers => {})
+        stub_request(:get, "http://api.comicvine.com/issues/").with(:query => {:format => 'json', :api_key => ComicVine::API.key, :limit => 2, :offset => 2}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => ISSUES_BODY_2, :headers => {})
+        @issues = ComicVine::API.issues
+      end
+      subject { @issues }
+      
+      it { should be_a_kind_of ComicVine::CVList }
+      it { should respond_to("total_count", "offset", "limit", "resource")}
+      specify { @issues.prev_page.should be_nil }
+      
+      context "when on last page" do
+        before { @issues.next_page }
+        
+        specify { @issues.should be_a_kind_of ComicVine::CVList }
+        specify { @issues.next_page.should be_nil }
+        it "should update the list on prev_page" do
+          @issues.prev_page
+          @issues.should be_a_kind_of ComicVine::CVList
+        end
+      end
+    end
+    
+    describe "ComicVine detail" do
+      before do
+        stub_request(:get, "http://api.comicvine.com/issue/145830/").with(:query => {:format => 'json', :api_key => ComicVine::API.key}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => ISSUE_BODY, :headers => {})
+        @issue = ComicVine::API.issue 145830
+      end
+      subject { @issue }
+      
+      it { should be_a_kind_of ComicVine::CVObject }
+      it { should respond_to("site_detail_url", "publish_year")}
+      specify { lambda { @issue.something }.should raise_error(NoMethodError) }
+      specify { lambda { @issue.get_something }.should raise_error(NoMethodError) }
+      
+      it "should have a detail and list association" do
+        stub_request(:get, "http://api.comicvine.com/volume/24708/").with(:query => {:format => 'json', :api_key => ComicVine::API.key}, :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => VOLUME_BODY, :headers => {})
+        vol = @issue.get_volume
+        vol.should be_a_kind_of ComicVine::CVObject
+        iss = vol.get_issues
+        iss.should be_a_kind_of Array
+        iss.first.should be_a_kind_of ComicVine::CVObject
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -4,11 +4,31 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+SimpleCov.start
 
 require 'comic_vine'
+#require 'webmock'
+require 'webmock/rspec'
+
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+  #config.filter_run :focus
 end
+
+TYPES_BODY = '{"number_of_page_results": 17, "status_code": 1, "error": "OK", "results": [{"detail_resource_name": "issue", "id": 37, "list_resource_name": "issues"}, {"detail_resource_name": "volume", "id": 49, "list_resource_name": "volumes"}], "limit": 17, "offset": 0, "number_of_total_results": 17}'
+
+ISSUE_BODY = '{"number_of_page_results": 1, "status_code": 1, "error": "OK", "results": {"site_detail_url": "http://www.comicvine.com/gizmo-/37-145830/", "id": 145830, "volume": {"api_detail_url": "http://api.comicvine.com/volume/24708/", "id": 24708, "name": "Gizmo"}, "publish_year": null}, "limit": 1, "offset": 0, "number_of_total_results": 1}'
+
+ISSUES_BODY_1 = '{"number_of_page_results": 2, "status_code": 1, "error": "OK", "results": [{"api_detail_url": "http://api.comicvine.com/issue/6/", "site_detail_url": "http://www.comicvine.com/chamber-of-chills-magazine-man-in-the-hood-the-lost-race-the-man-germ-the-things/37-6/", "description": "", "deck": "", "aliases": "", "issue_number": "13.00", "publish_year": 1952, "has_staff_review": false, "date_added": "2008-06-06 11:10:16", "publish_day": null, "publish_month": 10, "id": 6, "name": "Man In the Hood;  The Lost Race; The Man Germ;  The Things; "}, {"api_detail_url": "http://api.comicvine.com/issue/7/", "site_detail_url": "http://www.comicvine.com/fighting-fronts-/37-7/", "description": "", "deck": "", "aliases": "", "issue_number": "3.00", "publish_year": 0, "has_staff_review": false, "date_added": "2008-06-06 11:10:16", "publish_day": null, "publish_month": 0, "id": 7, "name": ""}], "limit": 2, "offset": 0, "number_of_total_results": 4}'
+
+ISSUES_BODY_2 = '{"number_of_page_results": 2, "status_code": 1, "error": "OK", "results": [{"api_detail_url": "http://api.comicvine.com/issue/6/", "site_detail_url": "http://www.comicvine.com/chamber-of-chills-magazine-man-in-the-hood-the-lost-race-the-man-germ-the-things/37-6/", "description": "", "deck": "", "aliases": "", "date_last_updated": "2009-01-27 12:47:44", "volume": {"api_detail_url": "http://api.comicvine.com/volume/1487/", "id": 1487, "name": "Chamber of Chills Magazine"}, "issue_number": "13.00", "publish_year": 1952, "has_staff_review": false, "date_added": "2008-06-06 11:10:16", "publish_day": null, "publish_month": 10, "id": 6, "name": "Man In the Hood;  The Lost Race; The Man Germ;  The Things; "}, {"api_detail_url": "http://api.comicvine.com/issue/7/", "site_detail_url": "http://www.comicvine.com/fighting-fronts-/37-7/", "description": "", "deck": "", "aliases": "", "date_last_updated": "2008-06-06 11:32:53", "volume": {"api_detail_url": "http://api.comicvine.com/volume/1488/", "id": 1488, "name": "Fighting Fronts!"}, "issue_number": "3.00", "publish_year": 0, "has_staff_review": false, "date_added": "2008-06-06 11:10:16", "publish_day": null, "publish_month": 0, "id": 7, "name": ""}], "limit": 2, "offset": 2, "number_of_total_results": 4}'
+
+VOLUME_BODY = '{"number_of_page_results": 1, "status_code": 1, "error": "OK", "results": {"id": 24708, "issues": [{"api_detail_url": "http://api.comicvine.com/issue/145830/", "issue_number": "1.00", "id": 145830, "name": " "}]}, "limit": 1, "offset": 0, "number_of_total_results": 1}'
+
+
+SEARCH_BODY_1 = '{"number_of_page_results": 1, "status_code": 1, "error": "OK", "results": [{"publisher": {"api_detail_url": "http://api.comicvine.com/publisher/517/", "id": 517, "name": "Mirage"}, "start_year": 1985, "description": "", "deck": "", "last_issue": null, "date_last_updated": "2010-07-04 20:51:17", "first_issue": null, "api_detail_url": "http://api.comicvine.com/volume/24708/", "count_of_issues": 6, "id": 24708, "date_added": "2008-12-12 16:58:16", "aliases": "", "site_detail_url": "http://www.comicvine.com/gizmo/49-24708/", "resource_type": "volume", "name": "Gizmo"}], "limit": 1, "offset": 0, "number_of_total_results": 2}'
+
+SEARCH_BODY_2 = '{"number_of_page_results": 1, "status_code": 1, "error": "OK", "results": [{"publisher": {"api_detail_url": "http://api.comicvine.com/publisher/517/", "id": 517, "name": "Mirage"}, "start_year": null, "description": "", "deck": "Mirage volume starring Fugitoid and Gizmo", "last_issue": null, "date_last_updated": "2010-04-28 14:24:46", "first_issue": null, "api_detail_url": "http://api.comicvine.com/volume/32839/", "count_of_issues": 2, "id": 32839, "date_added": "2010-04-28 14:22:46", "aliases": "", "site_detail_url": "http://www.comicvine.com/gizmo-and-the-fugitoid/49-32839/", "resource_type": "volume", "name": "Gizmo and the Fugitoid"}], "limit": 1, "offset": 1, "number_of_total_results": 2}'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comic_vine
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000Z
+date: 2012-04-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70126999503740 !ruby/object:Gem::Requirement
+  requirement: &70268024176560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70126999503740
+  version_requirements: *70268024176560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70126999502720 !ruby/object:Gem::Requirement
+  requirement: &70268024175620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,29 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70126999502720
+  version_requirements: *70268024175620
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70268024174900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70268024174900
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70268024174020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70268024174020
 description: Simple api interface to Comic Vine.  Allows for searches and returning
   specific information on resources.
 email: jakanapes@gmail.com
@@ -53,7 +75,6 @@ files:
 - lib/comic_vine/cv_object.rb
 - lib/comic_vine/version.rb
 - spec/comic_vine_spec.rb
-- spec/cv_object_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Jakanapes/ComicVine
 licenses: []
@@ -81,5 +102,4 @@ specification_version: 3
 summary: Interface to ComicVine API
 test_files:
 - spec/comic_vine_spec.rb
-- spec/cv_object_spec.rb
 - spec/spec_helper.rb

data/spec/cv_object_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-describe ComicVine::CVObject do
-  it "should inialize instance variables from a hash" do
-    h = {'something' => 'something', 'blah' => 'blah', 'number' => 100}
-    cvo = ComicVine::CVObject.new h
-    cvo.something.should == 'something'
-    cvo.blah.should == 'blah'
-    cvo.number.should == 100
-  end
-end