Project

marver

0.0
No commit activity in last 3 years
No release in over 3 years
Marver is a gem that provides a wrapper to Marvel's API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.5
>= 0
>= 0
>= 0

Runtime

 Project Readme

Marver

TravisCI Code Climate

Marver is an easy to use Ruby gem for Marvel's API. It contains wrappers around the API entities and provides a very easy interface to communicate with the API. You can take a look at the usage examples below on how to use it.

Note: I would recommend waiting for v1.0 before using the gem in production environment.

Installation

Add this line to your application's Gemfile:

gem 'marver'

And then execute:

$ bundle

Or install it yourself as:

$ gem install marver

Usage

Marver.configure do |config|
  config.public_key = 'your_public_key'
  config.private_key = 'your_private_key'
end

client = Marver::Client.new
client.characters.find_by_name 'Hulk'
client.series.find_by_title 'The Avengers'
client.events.find_by_title 'Fall of the mutants'
client.stories.find_by_title 'Name of a story'
client.comics.find_by_title 'Spiderman'

You can read more about using this gem in the wiki.

Still on the TO DO list:

  • Summary collections pagination.
    • Example: For a Comic that more than 20 Event summary objects (default amount fetched) the user should be able to step through them.
  • Error handling.
  • Inspect dependency graph?

Author

Ile Eftimov
twitter website