comic_vine 0.0.3 → 0.0.4

data/README.md

@@ -63,26 +63,35 @@ video_types
 volumes
 
 
-Calls to plurals return arrays of CVObjects:
+Calls to plurals return a CVObjectList:
 
-ComicVine::API.characters
+    chars = ComicVine::API.characters
+    
+Pagination will return nil if you are at either end of the list, otherwise it will update the object allowing for looping
+    
+    chars.next_page
+    chars.prev_page
 
 Calls to singulars require an id and return a CVObject:
 
-ComicVine::API.volume 766
+    ComicVine::API.volume 766
 
-Search takes a resource type and a query string and returns an array of CVObjects
+Search takes a resource type or types, separated by a comma(ex. "volume,issue"), and a query string and returns a CVSearchList (also with pagination)
 
-ComicVine::API.search 'volume', 'batman'
+    results = ComicVine::API.search 'volume', 'batman'
+    
+Call fetch to retrieve the full object
+    
+    results.first.fetch
 
 Pass in options as a hash
 
-ComicVine::API.characters :limit=>5, :offset=>10
+    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]
 
-volume = ComicVine::API.volume 766
-issues = volume.get_issues
+    volume = ComicVine::API.volume 766
+    issues = volume.get_issues
 
 Error responses from the API will raise a CVError with the error message
 

data/changelog

@@ -1,3 +1,5 @@
+0.0.4 - Add CVObjectList to carry count vars from result.  Add simple pagination.  Include enumerable in the list classes
+
 0.0.3 - Add simple associations, remove initializer and do that work in the railtie class, error check on CV response, allow options
 
 0.0.2 - Create CVObjects from resource returns

data/lib/comic_vine.rb

@@ -4,14 +4,94 @@ require "net/http"
 module ComicVine
   class Railtie < Rails::Railtie
     config.after_initialize do
-      keyfile = YAML::load(File.open(Rails.root.join('config', 'cv_key.yml')))
-      ComicVine::API.key = keyfile['cvkey']
+      if File.exists? Rails.root.join('config', 'cv_key.yml')
+        keyfile = YAML::load(File.open(Rails.root.join('config', 'cv_key.yml')))
+        ComicVine::API.key = keyfile['cvkey']
+      else
+        ComicVine::API.key = 'no_keyfile_found'
+      end
     end
   end
   
   class CVError < StandardError  
   end
   
+  class CVList
+    include Enumerable
+    
+    attr_reader :total_count
+    attr_reader :offset
+    attr_reader :limit
+    attr_reader :cvos
+    
+    def initialize(resp)      
+      @total_count = resp['number_of_total_results']
+      @offset = resp['offset']
+      @limit = resp['limit']
+    end
+    
+    def each
+      @cvos.each { |c| yield c }
+    end
+    
+    def last
+      @cvos.last
+    end
+    
+    protected
+      def update_ivals(new_cvol)
+        @total_count = new_cvol.total_count
+        @offset = new_cvol.offset
+        @limit = new_cvol.limit
+
+        @cvos = new_cvol.cvos
+      end
+  end
+  
+  class CVObjectList < CVList
+    attr_reader :resource
+    
+    def initialize(resp, resc)      
+      super(resp)
+      
+      @resource = resc
+      @cvos = resp['results'].map{ |r| ComicVine::CVObject.new(r)}
+    end
+    
+    def next_page
+      return nil if (@offset + count) == @total_count
+      update_ivals(ComicVine::API.send(@resource, {:limit => @limit, :offset => (@offset + count)}))
+    end
+    
+    def prev_page
+      return nil if @offset == 0
+      update_ivals(ComicVine::API.send(@resource, {:limit => @limit, :offset => (@offset - count)}))
+    end
+  end
+  
+  class CVSearchList < CVList
+    attr_reader :resource
+    attr_reader :query
+    
+    def initialize(resp, resc, query)      
+      super(resp)
+      
+      @resource = resc
+      @query = query
+      @cvos = resp['results'].map{ |r| ComicVine::CVSearchObject.new(r)}
+    end
+    
+    def next_page
+      return nil if (@offset + count) == @total_count
+      update_ivals(ComicVine::API.search(@resource, @query, {:limit => @limit, :offset => (@offset + count)}))
+    end
+    
+    def prev_page
+      return nil if @offset == 0
+      update_ivals(ComicVine::API.search(@resource, @query, {:limit => @limit, :offset => (@offset - count)}))
+    end
+  end
+  
   class CVObject
     def initialize(args)
       args.each do |k,v|
@@ -43,6 +123,12 @@ module ComicVine
     end
   end
   
+  class CVSearchObject < CVObject
+    def fetch
+      ComicVine::API.send(@resource_type, @id)
+    end
+  end
+  
   class API
     cattr_accessor :key
     
@@ -67,7 +153,8 @@ module ComicVine
                       :volumes ].freeze
     
     def self.search res, query, opts={}
-      hit_api(build_url("search", opts)+"&resources=#{res}&query=#{query}")
+      resp = hit_api(build_url("search", opts)+"&resources=#{res}&query=#{query}")
+      ComicVine::CVSearchList.new(resp, res, query)
     end
     
     def self.method_missing(method_sym, *arguments, &block)
@@ -82,11 +169,13 @@ module ComicVine
     
     private
       def self.get_list list_type, opts={}
-        hit_api(build_url(list_type, opts))
+        resp = hit_api(build_url(list_type, opts))
+        ComicVine::CVObjectList.new(resp, list_type)
       end
       
       def self.get_item item_type, id, opts={}
-        hit_api(build_url("#{item_type}/#{id}", opts))
+        resp = hit_api(build_url("#{item_type}/#{id}", opts))
+        ComicVine::CVObject.new(resp['results'])
       end
       
       def self.hit_api url
@@ -94,11 +183,7 @@ module ComicVine
         resp = Net::HTTP.get(url)
         presp = JSON.parse(resp)
         raise CVError, presp['error'] unless presp['status_code'] == 1
-        if presp['results'].kind_of?(Array)
-          presp['results'].map{ |r| ComicVine::CVObject.new(r)}
-        else
-          ComicVine::CVObject.new(presp['results'])
-        end
+        presp
       end
       
       def self.build_url action, opts={}

data/lib/comic_vine/version.rb

@@ -1,3 +1,3 @@
 module ComicVine
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comic_vine
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000Z
+date: 2012-04-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70251308181480 !ruby/object:Gem::Requirement
+  requirement: &70341716356020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70251308181480
+  version_requirements: *70341716356020
 description: Simple api interface to Comic Vine.  Allows for searches and returning
   specific information on resources.
 email: jakanapes@gmail.com