Contents

# 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.

## 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 a CVObjectList:

    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

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)

    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}

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

Error responses from the API will raise a CVError with the error message

## ToDos
More 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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
comic_vine-0.0.4	README.md