comic_vine 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in comic_vine.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# ComicVine
+
+VERY simple first cut at a gem to interface with the ComicVine api.  http://api.comicvine.com/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'comic_vine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install comic_vine
+    
+You will also need to have a ComicVine API key.
+
+After installing gem run the generator
+
+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
+
+characters
+
+chats
+
+concepts
+
+issues
+
+locations
+
+movies
+
+objects
+
+origins
+
+persons
+
+powers
+
+promos
+
+publishers
+
+story_arcs
+
+teams
+
+videos
+
+video_types
+
+volumes
+
+
+Calls to plurals return arrays of CVObjects:
+
+ComicVine::API.characters
+
+Calls to singulars require an id and return a CVObject:
+
+ComicVine::API.volume 766
+
+Search takes a resource type and a query string and returns an array of CVObjects
+
+ComicVine::API.search 'volume', 'batman'
+
+## ToDos
+Limits and Offsets
+
+Filtering
+
+Error checking
+
+Documentation
+
+Tests
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/comic_vine.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/comic_vine/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = "Patrick Sharp"
+  gem.email         = "jakanapes@gmail.com"
+  gem.description   = %q{Simple api interface to Comic Vine.  Allows for searches and returning specific information on resources.}
+  gem.summary       = %q{Interface to ComicVine API}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "comic_vine"
+  gem.require_paths = ["lib"]
+  gem.version       = ComicVine::VERSION
+  
+  gem.add_dependency 'json'
+end

data/lib/comic_vine/version.rb

@@ -0,0 +1,3 @@
+module ComicVine
+  VERSION = "0.0.1"
+end

data/lib/comic_vine.rb

@@ -0,0 +1,75 @@
+require "comic_vine/version"
+require "net/http"
+
+module ComicVine
+  class CVObject
+    def initialize(args)
+      args.each do |k,v|
+        class_eval { attr_accessor k }
+        instance_variable_set "@#{k}", v
+      end
+    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
+      hit_api(build_url("search")+"&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
+      elsif LIST_ACTIONS.include?(method_sym.to_s.pluralize.to_sym)
+        self.get_item method_sym, arguments.first
+      elsif
+        super
+      end
+    end
+    
+    private
+      def self.get_list list_type
+        hit_api(build_url(list_type))
+      end
+      
+      def self.get_item item_type, id
+        hit_api(build_url("#{item_type}/#{id}"))
+      end
+      
+      def self.hit_api url
+        url = URI.parse(url)
+        resp = Net::HTTP.get(url)
+        presp = JSON.parse(resp)
+        if presp['results'].kind_of?(Array)
+          presp['results'].map{ |r| ComicVine::CVObject.new(r)}
+        else
+          ComicVine::CVObject.new(presp['results'])
+        end
+      end
+      
+      def self.build_url action
+        API_BASE_URL+action+"/?api_key=#{@@key}&format=json"
+      end
+  end
+end

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

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

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

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

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

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: comic_vine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Patrick Sharp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70163194218340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70163194218340
+description: Simple api interface to Comic Vine.  Allows for searches and returning
+  specific information on resources.
+email: jakanapes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- 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: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Interface to ComicVine API
+test_files: []