https://github.com/eltercero/uatu
Lightweight Marvel API Wrapper for Ruby.
https://github.com/eltercero/uatu
marvel-api ruby wrapper
Last synced: 27 days ago
JSON representation
Lightweight Marvel API Wrapper for Ruby.
- Host: GitHub
- URL: https://github.com/eltercero/uatu
- Owner: eltercero
- License: mit
- Created: 2014-02-08T17:35:20.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-12-14T14:05:59.000Z (over 7 years ago)
- Last Synced: 2025-04-14T20:07:52.056Z (about 1 month ago)
- Topics: marvel-api, ruby, wrapper
- Language: Ruby
- Homepage:
- Size: 60.5 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/eltercero/uatu)
# Uatu
Uatu is a Wrapper for the Marvel API. See [the API](http://developer.marvel.com) for more details. It relies on OpenStruct to build ruby objects with the API response.
Uatu is [also](http://en.wikipedia.org/wiki/Uatu) a member of The Watchers, that nice extraterrestrial race who monitor life of other species.
## Installation
To get the latest stable:
gem 'uatu-marvel'
To get the latest code:
gem 'uatu-marvel', git: https://github.com/eltercero/uatu
And then execute:
$ bundle
## Usage
```ruby
require 'uatu'
# You can also have them in your env => ENV["MARVEL_PUBLIC_KEY"] - ENV["MARVEL_PRIVATE_KEY"]
Uatu.configure do |config|
config.public_key = 'your_api_key'
config.private_key = 'your_private_api_key'
end
watcher = Uatu::Base.new
# Examples
#####################################################
# Searching by characters return an Array of results
character = watcher.characters(name: 'Daredevil').first
character.name
=> 'Daredevil'
character.description
=> "Abandoned by his mother, Matt Murdock was raised by his father, boxer \"Battling Jack\" Murdock, in Hell's Kitchen. Realizing that rules were needed to prevent people from behaving badly, young Matt decided to study law; however, when he saved a man from an oncoming truck, it spilled a radioactive cargo that rendered Matt blind while enhancing his remaining senses. Under the harsh tutelage of blind martial arts master Stick, Matt mastered his heightened senses and became a formidable fighter."
random_hero = watcher.characters(limit: 1, offset: rand(1000)).first.name
=> "Dreaming Celestial"
random_heroes_team = watcher.characters(limit: 20, offset: rand(1000)).map(&:name)
=> ["Rumiko Fujikawa", "Runaways", "Russian", "S.H.I.E.L.D.", "Sabra", "Sabretooth", "Sabretooth (Age of Apocalypse)", "Sabretooth (House of M)", "Sabretooth (Ultimate)", "Sage", "Salem's Seven (Ultimate)", "Sally Floyd", "Salo", "Sandman", "Santa Claus", "Saracen (Muzzafar Lambert)", "Sasquatch (Walter Langkowski)", "Satana", "Sauron", "Scalphunter"]
# Parameters are in ruby style. This means no camel case like firstName
irish_fella = watcher.creators(first_name: 'Garth', last_name: 'Ennis').first
irish_fella.comics.available
=> 103
#You can also search by id
character = watcher.character(1009262)
character.thumbnail
=> "http://i.annihil.us/u/prod/marvel/i/mg/d/50/50febb79985ee.jpg"
#There is also a handy method for checking out the last url you requested
watcher.last_request_url
=> "http://gateway.marvel.com/v1/public/characters/1009262?apikey=xxx&hash=xxx&ts=2014-02-08T18%3A52%3A25%2B01%3A00"
#For combined calls (like, comics in a character => GET /v1/public/characters/{characterId}/comics), you make them like this
asgardian_god_comics = watcher.character_comics(1009664)
asgardian_god_comics.first.title
"Thor: God of Thunder (2012) #2" # Which is, by the way, an amazing comic.
```
## Contributing
Please, be my guest!
1. Fork it ( http://github.com/eltercero/uatu/fork )
2. Create your feature branch (`git checkout -b nuff-said`)
3. Commit your changes (`git commit -am 'Excelsior!'`)
4. Push to the branch (`git push origin nuff-said`)
5. Create new Pull Request
## License
Released under the [MIT License](http://opensource.org/licenses/MIT).