comic_vine 0.0.5 → 0.0.6

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -61,9 +61,13 @@ video_types
 volumes
 
 
-Calls to plurals return a CVObjectList:
+Calls to plurals return a CVObjectList, which contains the result array as well as the values from the return (total_count, offset, limit, resource).
 
     chars = ComicVine::API.characters
+
+CVObjectLists include enumerable, so they can be looped.
+
+    chars.each do |c|
     
 Pagination will return nil if you are at either end of the list, otherwise it will update the object allowing for looping
     
@@ -86,10 +90,11 @@ Pass in options as a hash
 
     ComicVine::API.characters {:limit=>5, :offset=>10}
 
-There are limited associations.  If the name of the association matches the resource name, then you can get the array of CVObjects by calling get_[resource]
+There are associations.  Call the association by the key name, prefaced by get_ and the gem will return either a CVList or a CVObject from the API.
 
     volume = ComicVine::API.volume 766
     issues = volume.get_issues
+    chars = volume.get_character_credits
 
 Error responses from the API will raise a CVError with the error message
 

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/changelog

@@ -1,3 +1,5 @@
+0.0.6 - Expose the helper methods, add get_details_by_url, allow get_* for ANY of the resource items returned in the body
+
 0.0.5 - Behind the scenes cleanup.  Change gem to work as a pure ruby implementation.  API.key is now manually set as opposed to reading from a config file.  Removed generator and railties.
 
 0.0.4 - Add CVObjectList to carry count vars from result.  Add simple pagination.  Include enumerable in the list classes

data/comic_vine.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
   gem.version       = ComicVine::VERSION
   
   gem.add_dependency 'json'
+  gem.add_development_dependency "rspec", ">= 2.0.0"
 end

data/lib/comic_vine/cv_object.rb

@@ -11,15 +11,16 @@ module ComicVine
       if method_sym.to_s =~ /^get_(.*)$/
         key = method_sym.to_s.sub "get_", ""
         if instance_variable_defined?("@#{key}")
-          if type = ComicVine::API.find_list(key)
+          item = instance_variable_get("@#{key}")
+          if item.kind_of?(Array) && item.first.key?("api_detail_url")
             res = []
-            send(key).each do |i|
-              res << ComicVine::API.send(type['detail_resource_name'], i['id'])
+            item.each do |i|
+              res << ComicVine::API.get_details_by_url(i["api_detail_url"])
             end
             return res
           end
-          if ComicVine::API.find_detail(key)
-            return ComicVine::API.send(key, send(key)['id'])
+          if item.kind_of?(Hash) && item.key?("api_detail_url")
+            return ComicVine::API.get_details_by_url(item["api_detail_url"])
           end
         else
           super

data/lib/comic_vine/version.rb

@@ -1,3 +1,3 @@
 module ComicVine
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/comic_vine.rb

@@ -15,78 +15,86 @@ module ComicVine
     
     @@API_BASE_URL = "http://api.comicvine.com/"
 
-    def self.search res, query, opts={}
-      resp = hit_api(build_url("search", opts)+"&resources=#{res}&query=#{query}")
-      ComicVine::CVSearchList.new(resp, res, query)
-    end
+    class << self
+      def search res, query, opts={}
+        resp = hit_api(build_url("search", opts)+"&resources=#{res}&query=#{query}")
+        ComicVine::CVSearchList.new(resp, res, query)
+      end
     
-    def self.find_list type
-      types.find { |t| t['list_resource_name'] == type }
-    end
+      def find_list type
+        types.find { |t| t['list_resource_name'] == type }
+      end
     
-    def self.find_detail type
-      types.find { |t| t['detail_resource_name'] == type }
-    end
+      def find_detail type
+        types.find { |t| t['detail_resource_name'] == type }
+      end
     
-    def self.method_missing(method_sym, *arguments, &block)
-      if find_list(method_sym.to_s)
-        get_list method_sym.to_s, arguments.first
-      elsif find_detail(method_sym.to_s)
-        get_details method_sym.to_s, *arguments
-      elsif
-        super
+      def method_missing(method_sym, *arguments, &block)
+        if find_list(method_sym.to_s)
+          get_list method_sym.to_s, arguments.first
+        elsif find_detail(method_sym.to_s)
+          get_details method_sym.to_s, *arguments
+        elsif
+          super
+        end
       end
-    end
     
-    def self.key
-      @@key
-    end
+      def key
+        @@key
+      end
     
-    def self.key= key
-      @@key = key
-    end
+      def key= key
+        @@key = key
+      end
     
-    def self.types
-      if @@types.nil? || (@@last_type_check + (4 *60 *60)) > Time.now
-        @@last_type_check = Time.now
-        @@types = hit_api(build_url('types'))['results']
+      def types
+        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
+        @@types
+      end
+
+      def get_list list_type, opts=nil
+        resp = hit_api(build_base_url(list_type), build_query(opts))
+        ComicVine::CVObjectList.new(resp, list_type)
       end
-      @@types
-    end
   
-    def self.get_list list_type, opts=nil
-      resp = hit_api(build_url(list_type, opts))
-      ComicVine::CVObjectList.new(resp, list_type)
-    end
-    
-    def self.get_details item_type, id, opts=nil
-      resp = hit_api(build_url("#{item_type}/#{id}", opts))
-      ComicVine::CVObject.new(resp['results'])
-    end
-    
-    def self.hit_api url
-      uri = URI.parse(url)
-      resp = Net::HTTP.get(uri)
-      presp = JSON.parse(resp)
-      raise CVError, presp['error'] unless presp['status_code'] == 1
-      presp
-    end
+      def get_details item_type, id, opts=nil
+        resp = hit_api(build_base_url("#{item_type}/#{id}"), build_query(opts))
+        ComicVine::CVObject.new(resp['results'])
+      end
+      
+      def get_details_by_url url
+        resp = hit_api(url)
+        ComicVine::CVObject.new(resp['results'])
+      end
     
-    def self.build_url action, opts=nil
-      query = ''
-      if !opts.nil? && !opts.empty?
-        opts.each do |k,v|
-          query << "&#{k.to_s}=#{v}"
+      private
+        def hit_api base_url, query=""
+          url = base_url<<"?format=json&api_key=#{@@key}"<<query
+          uri = URI.parse(url)
+          resp = Net::HTTP.get(uri)
+          presp = JSON.parse(resp)
+          raise CVError, presp['error'] unless presp['status_code'] == 1
+          presp
+        end
+      
+        def build_base_url action
+          @@API_BASE_URL+action+"/"
+        end
+        
+        def build_query opts=nil
+          query = ''
+          if !opts.nil? && !opts.empty?
+            opts.each do |k,v|
+              query << "&#{k.to_s}=#{v}"
+            end
+          end
+          query
         end
-      end
-      @@API_BASE_URL+action+"/?format=json&api_key=#{@@key}#{query}"
-    end
 
-    private_class_method :types
-    private_class_method :get_list
-    private_class_method :get_details
-    private_class_method :hit_api
-    private_class_method :build_url
+    end
   end
 end
 

data/spec/comic_vine_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+describe ComicVine do
+  it "should allow the user to set the API key" 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)
+  end
+end

data/spec/cv_object_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'comic_vine'
+
+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
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comic_vine
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-12 00:00:00.000000000Z
+date: 2012-04-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70119669944600 !ruby/object:Gem::Requirement
+  requirement: &70331646007340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70119669944600
+  version_requirements: *70331646007340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70331646006800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70331646006800
 description: Simple api interface to Comic Vine.  Allows for searches and returning
   specific information on resources.
 email: jakanapes@gmail.com
@@ -30,6 +41,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -40,6 +52,9 @@ files:
 - lib/comic_vine/cv_list.rb
 - 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: []
 post_install_message: 
@@ -64,4 +79,7 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Interface to ComicVine API
-test_files: []
+test_files:
+- spec/comic_vine_spec.rb
+- spec/cv_object_spec.rb
+- spec/spec_helper.rb