comic_vine 0.0.4 → 0.0.5

data/README.md

@@ -18,13 +18,11 @@ Or install it yourself as:
     
 You will also need to have a ComicVine API key.
 
-After installing gem run the generator
-
-rails g comic_vine:install
+## Usage
 
-This will install a keyfile at config/cv_key.yml.  Update this file with your own API key.
+Requires that API key be set manually.  This is a breaking change from 0.0.4.
 
-## Usage
+    ComicVine::API.key = xxxxxx
 
 works on a subset of the api actions
 

data/changelog

@@ -1,3 +1,5 @@
+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
 
 0.0.3 - Add simple associations, remove initializer and do that work in the railtie class, error check on CV response, allow options

data/lib/comic_vine/cv_list.rb

@@ -0,0 +1,77 @@
+module ComicVine
+  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
+end

data/lib/comic_vine/cv_object.rb

@@ -0,0 +1,38 @@
+module ComicVine
+  class CVObject
+    def initialize(args)
+      args.each do |k,v|
+        self.class.class_eval { attr_accessor k }
+        instance_variable_set "@#{k}", v
+      end
+    end
+    
+    def method_missing(method_sym, *arguments, &block)
+      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)
+            res = []
+            send(key).each do |i|
+              res << ComicVine::API.send(type['detail_resource_name'], i['id'])
+            end
+            return res
+          end
+          if ComicVine::API.find_detail(key)
+            return ComicVine::API.send(key, send(key)['id'])
+          end
+        else
+          super
+        end
+      elsif
+        super
+      end
+    end
+  end
+  
+  class CVSearchObject < CVObject
+    def fetch
+      ComicVine::API.send(@resource_type, @id)
+    end
+  end
+end

data/lib/comic_vine/version.rb

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

data/lib/comic_vine.rb

@@ -1,195 +1,94 @@
 require "comic_vine/version"
 require "net/http"
+require "json"
 
 module ComicVine
-  class Railtie < Rails::Railtie
-    config.after_initialize do
-      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
+  class API
+    @@key = nil
     
-    def last
-      @cvos.last
-    end
+    @@types = nil
+    @@last_type_check = nil
     
-    protected
-      def update_ivals(new_cvol)
-        @total_count = new_cvol.total_count
-        @offset = new_cvol.offset
-        @limit = new_cvol.limit
+    @@API_BASE_URL = "http://api.comicvine.com/"
 
-        @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)}
+    def self.search res, query, opts={}
+      resp = hit_api(build_url("search", opts)+"&resources=#{res}&query=#{query}")
+      ComicVine::CVSearchList.new(resp, res, query)
     end
     
-    def next_page
-      return nil if (@offset + count) == @total_count
-      update_ivals(ComicVine::API.send(@resource, {:limit => @limit, :offset => (@offset + count)}))
+    def self.find_list type
+      types.find { |t| t['list_resource_name'] == type }
     end
     
-    def prev_page
-      return nil if @offset == 0
-      update_ivals(ComicVine::API.send(@resource, {:limit => @limit, :offset => (@offset - count)}))
+    def self.find_detail type
+      types.find { |t| t['detail_resource_name'] == type }
     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)}
+    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
+      end
     end
     
-    def next_page
-      return nil if (@offset + count) == @total_count
-      update_ivals(ComicVine::API.search(@resource, @query, {:limit => @limit, :offset => (@offset + count)}))
+    def self.key
+      @@key
     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|
-        class_eval { attr_accessor k }
-        instance_variable_set "@#{k}", v
-      end
+    def self.key= key
+      @@key = key
     end
     
-    def method_missing(method_sym, *arguments, &block)
-      if method_sym.to_s =~ /^get_(.*)$/
-        key = method_sym.to_s.sub "get_", ""
-        if instance_variable_defined?("@#{key}")
-          if ComicVine::API::LIST_ACTIONS.include?(key.to_sym)
-            res = []
-            send(key).each do |i|
-              res << ComicVine::API.send(key.singularize, i['id'])
-            end
-            return res
-          end
-          if ComicVine::API::LIST_ACTIONS.include?(key.pluralize.to_sym)
-            return ComicVine::API.send(key, send(key)['id'])
-          end
-        else
-          super
-        end
-      elsif
-        super
+    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']
       end
+      @@types
     end
-  end
   
-  class CVSearchObject < CVObject
-    def fetch
-      ComicVine::API.send(@resource_type, @id)
+    def self.get_list list_type, opts=nil
+      resp = hit_api(build_url(list_type, opts))
+      ComicVine::CVObjectList.new(resp, list_type)
     end
-  end
-  
-  class API
-    cattr_accessor :key
-    
-    API_BASE_URL = "http://api.comicvine.com/"
     
-    LIST_ACTIONS = [ :characters,
-                      :chats,
-                      :concepts,
-                      :issues,
-                      :locations,
-                      :movies,
-                      :objects,
-                      :origins,
-                      :persons,
-                      :powers,
-                      :promos,
-                      :publishers,
-                      :story_arcs,
-                      :teams,
-                      :videos,
-                      :video_types,
-                      :volumes ].freeze
-    
-    def self.search res, query, opts={}
-      resp = hit_api(build_url("search", opts)+"&resources=#{res}&query=#{query}")
-      ComicVine::CVSearchList.new(resp, res, query)
+    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.method_missing(method_sym, *arguments, &block)
-      if LIST_ACTIONS.include?(method_sym)
-        self.get_list method_sym.to_s, arguments.first
-      elsif LIST_ACTIONS.include?(method_sym.to_s.pluralize.to_sym)
-        self.get_item method_sym, *arguments
-      elsif
-        super
-      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
     
-    private
-      def self.get_list 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={}
-        resp = hit_api(build_url("#{item_type}/#{id}", opts))
-        ComicVine::CVObject.new(resp['results'])
-      end
-      
-      def self.hit_api url
-        url = URI.parse(url)
-        resp = Net::HTTP.get(url)
-        presp = JSON.parse(resp)
-        raise CVError, presp['error'] unless presp['status_code'] == 1
-        presp
-      end
-      
-      def self.build_url action, opts={}
-        query = ''
-        query = "&#{opts.to_query}" if !opts.nil?
-        API_BASE_URL+action+"/?format=json&api_key=#{@@key}#{query}"
+    def self.build_url action, opts=nil
+      query = ''
+      if !opts.nil? && !opts.empty?
+        opts.each do |k,v|
+          query << "&#{k.to_s}=#{v}"
+        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
+
+require 'comic_vine/cv_object'
+require 'comic_vine/cv_list'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comic_vine
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-11 00:00:00.000000000Z
+date: 2012-04-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70341716356020 !ruby/object:Gem::Requirement
+  requirement: &70119669944600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70341716356020
+  version_requirements: *70119669944600
 description: Simple api interface to Comic Vine.  Allows for searches and returning
   specific information on resources.
 email: jakanapes@gmail.com
@@ -37,9 +37,9 @@ files:
 - changelog
 - comic_vine.gemspec
 - lib/comic_vine.rb
+- lib/comic_vine/cv_list.rb
+- lib/comic_vine/cv_object.rb
 - lib/comic_vine/version.rb
-- lib/generators/comic_vine/install/install_generator.rb
-- lib/generators/comic_vine/install/templates/cv_key.yml
 homepage: https://github.com/Jakanapes/ComicVine
 licenses: []
 post_install_message: 

data/lib/generators/comic_vine/install/install_generator.rb

@@ -1,17 +0,0 @@
-module ComicVine
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
-
-      desc "This generator installs the blank keyfile for ComicVine and copies the initializer"
-      def copy_the_keyfile
-        copy_file "cv_key.yml", "config/cv_key.yml"
-      end
-      
-      #def copy_the_init
-      #  copy_file "initializer.rb", "config/initializers/comic_vine.rb"
-      #end
-
-    end
-  end
-end

data/lib/generators/comic_vine/install/templates/cv_key.yml

@@ -1,2 +0,0 @@
-# Add your ComicVine API key here
-cvkey: XXXXXX