comic_vine 0.0.2 → 0.0.3

data/README.md

@@ -24,8 +24,6 @@ rails g comic_vine:install
 
 This will install a keyfile at config/cv_key.yml.  Update this file with your own API key.
 
-The generator also installs an initializer to capture the api key in a class variable for ComicVine::API
-
 ## Usage
 
 works on a subset of the api actions
@@ -77,12 +75,19 @@ Search takes a resource type and a query string and returns an array of CVObject
 
 ComicVine::API.search 'volume', 'batman'
 
-## ToDos
-Limits and Offsets
+Pass in options as a hash
+
+ComicVine::API.characters :limit=>5, :offset=>10
 
-Filtering
+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]
 
-Error checking
+volume = ComicVine::API.volume 766
+issues = volume.get_issues
+
+Error responses from the API will raise a CVError with the error message
+
+## ToDos
+More Error checking
 
 Documentation
 

data/changelog

@@ -0,0 +1,5 @@
+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
+
+0.0.1 - First check-in

data/lib/comic_vine/version.rb

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

data/lib/comic_vine.rb

@@ -2,6 +2,16 @@ require "comic_vine/version"
 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']
+    end
+  end
+  
+  class CVError < StandardError  
+  end
+  
   class CVObject
     def initialize(args)
       args.each do |k,v|
@@ -9,6 +19,28 @@ module ComicVine
         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 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
+      end
+    end
   end
   
   class API
@@ -34,33 +66,34 @@ module ComicVine
                       :video_types,
                       :volumes ].freeze
     
-    def self.search res, query
-      hit_api(build_url("search")+"&resources=#{res}&query=#{query}")
+    def self.search res, query, opts={}
+      hit_api(build_url("search", opts)+"&resources=#{res}&query=#{query}")
     end
     
     def self.method_missing(method_sym, *arguments, &block)
       if LIST_ACTIONS.include?(method_sym)
-        self.get_list method_sym.to_s
+        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.first
+        self.get_item method_sym, *arguments
       elsif
         super
       end
     end
     
     private
-      def self.get_list list_type
-        hit_api(build_url(list_type))
+      def self.get_list list_type, opts={}
+        hit_api(build_url(list_type, opts))
       end
       
-      def self.get_item item_type, id
-        hit_api(build_url("#{item_type}/#{id}"))
+      def self.get_item item_type, id, opts={}
+        hit_api(build_url("#{item_type}/#{id}", opts))
       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
         if presp['results'].kind_of?(Array)
           presp['results'].map{ |r| ComicVine::CVObject.new(r)}
         else
@@ -68,8 +101,10 @@ module ComicVine
         end
       end
       
-      def self.build_url action
-        API_BASE_URL+action+"/?api_key=#{@@key}&format=json"
+      def self.build_url action, opts={}
+        query = ''
+        query = "&#{opts.to_query}" if !opts.nil?
+        API_BASE_URL+action+"/?format=json&api_key=#{@@key}#{query}"
       end
   end
 end

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

@@ -8,9 +8,9 @@ module ComicVine
         copy_file "cv_key.yml", "config/cv_key.yml"
       end
       
-      def copy_the_init
-        copy_file "initializer.rb", "config/initializers/comic_vine.rb"
-      end
+      #def copy_the_init
+      #  copy_file "initializer.rb", "config/initializers/comic_vine.rb"
+      #end
 
     end
   end

metadata

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

data/lib/generators/comic_vine/install/templates/initializer.rb

@@ -1,5 +0,0 @@
-
-
-keyfile = YAML::load(File.open(Rails.root.join('config', 'cv_key.yml')))
-
-ComicVine::API.key = keyfile['cvkey']