galactus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25d5eb99be8dc6d153dd2641cb1768eb66eed734
-  data.tar.gz: 599eefd97c55c111b80006a2cd52bb6c14c2d7db
+  metadata.gz: 58b5b3aecfe031faf4b900744ed4d20a6c7eb7a2
+  data.tar.gz: 554573e2e6dd89c8bcb89a66e84f5e27856d2081
 SHA512:
-  metadata.gz: 26e9e35afbef504614fdb163ce34e10b1a5aa329b3b7b4a959f121adb2c6baedaf009893e5f9c8bd61d730e0d8990d0396967b65a41b7f9f6f55c130573799b6
-  data.tar.gz: 359ab4fd1a8475b2e248f14e6e3eefc160f184f317f06bae25af79263586f432d567b829c4185115d8c9111c4d37ada4c8ac24163e98d2b451a01f268bf8df84
+  metadata.gz: 8020c45d56b4c4807d029c7b630621bc747f767edd92da93318329d8e8152ef96f027ba6b99f2d620b64eeecbd61dcbd168d79717c402abf8213fbd3779d2470
+  data.tar.gz: 24dd3580b6b32ef13654f6d8254151af1f549977a2dd518618d94df9cf7240b324a37b506c696ce0a3e4d3d3fdbd814f33f4eb528b7aaebea7ba5b5ec08ebf93

data/.gitignore

@@ -5,6 +5,10 @@
 /_yardoc/
 /coverage/
 /doc/
+/rdoc/
 /pkg/
+/spec/examples.txt
 /spec/reports/
 /tmp/
+.DS_Store
+/spikes/api_keys.yml

data/.hound.yml

@@ -0,0 +1,61 @@
+AllCops:
+  Exclude:
+    - galactus.gemspec
+    - spikes/*.rb
+    - spec/**/*
+
+# C: Missing top-level module documentation comment.
+Style/Documentation:
+  Enabled: false
+
+# C: Prefer reduce over inject.
+Style/CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# C: Use each_with_object instead of inject.
+Style/EachWithObject:
+  Enabled: false
+
+# C: Removing the preference for string single quotes
+Style/StringLiterals:
+  Enabled: false
+
+#C: Prefer fail over raise
+Style/SignalException:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+# This never works for validations
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# align multi-line params with previous line
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# indent `when` clause one step from `case`
+Style/CaseIndentation:
+  IndentOneStep: true
+
+# don't force crappy var names for reduce/inject loops...
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# for method chains, keep the dot with the method name
+Style/DotPosition:
+  EnforcedStyle: leading
+
+# stop nesting so hard.
+Metrics/BlockNesting:
+  Max: 2
+
+# short methods, man...
+Metrics/MethodLength:
+  Max: 15
+
+# fewer parameters
+Metrics/ParameterLists:
+  Max: 3

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
 --color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .hound.yml

data/README.md

@@ -1,31 +1,570 @@
+![Galactus](http://static.comicvine.com/uploads/square_medium/3/31666/3230561-tumblr_mqd1qnuvu71qknht2o2_1280.jpg)
+
 # Galactus
 
-Galactus provides a simple wrapper for the [Marvel API](http://developer.marvel.com/).
+On 31 January 2014 Marvel Comics [put out a press release](http://marvel.com/news/comics/21871/marvel_announces_the_release_of_the_api_program) announcing an API connecting to Marvel's database of comics, characters, and creators.
+
+Galactus provides a very simple wrapper for the [Marvel API](http://developer.marvel.com/) and attempts to make that API easily queryable by providing qualifier objects that allows a consumer of the API to drill down into specific details.
+
+Galactus is a [Marvel super-villain](https://en.wikipedia.org/wiki/Galactus) who was apparently the sole survivor of a universe that existed before the 'Big Bang' that created our own universe. As accomplishments go, that's moderately impressive, to say the least.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To get the latest stable release, add this line to your application's Gemfile:
 
 ```ruby
 gem 'galactus'
 ```
 
-And then execute:
+To get the latest code:
+
+```ruby
+gem 'galactus', git: https://github.com/jnyman/galactus
+```
+
+After doing one of the above, execute the following command:
 
     $ bundle
 
-Or install it yourself as:
+You can, of course, just install the gem directly like this:
 
     $ gem install galactus
 
+## Contents
+
+* [Usage](#usage)
+* [Endpoints](#endpoints)
+
 ## Usage
 
-Usage instructions will be coming soon.
+### Setting Up the Client
+
+You need API credentials, which is a public and private key pair. You can get yours at the [Marvel Developer Portal](http://developer.marvel.com). These are required to configure and instantiate a Galactus client.
+
+```ruby
+require 'galactus'
+
+client = Galactus::Client.new(
+  public_api_key: 'your public api key',
+  private_api_key: 'your private api key')
+```
+
+Make sure you put in your own public and private keys that you were assigned. The `client` variable will now hold a `Galactus::Client` instance that you can call endpoint methods on.
+
+## Endpoints
+
+Most requests to the API, return a `Galactus::Response` object if there was a successful response or a `Galactus::ErrorResponse` if API response returns an error. These objects are the raw API response enhanced with Hashie methods.
+
+Just about all endpoints can receive optional parameters to narrow down results and those will be documented below. Each endpoint described below links to the associated call in Marvel's interactive API tester. That link will show you a complete list of the parameters that you can pass to the relevant method.
+
+### Character Endpoints
+
+#### Characters
+
+Allows you to get a list of comic characters.
+
+See [`GET /v1/public/characters`](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_0).
+
+```ruby
+client.characters
+client.characters(name: 'Spider-Man')
+client.characters(limit: 10, offset: 400, orderBy: 'name')
+client.characters(name: 'Thanos')
+client.characters(nameStartsWith: 'Th', orderBy: 'modified')
+```
+
+#### Character
+
+Allows you to get a single character resource. This endpoint accepts an integer or string value as the character id.
+
+See [`GET /v1/public/characters/{characterId}`](http://developer.marvel.com/docs#!/public/getCharacterIndividual_get_1). 
+
+```ruby
+client.character(1009610)
+client.character('Spider-Man')
+```
+
+#### Character Comics
+
+Allows you to get a list of comics containing a specific character. This endpoint requires a character id value (integer or string).
+
+See [`GET /v1/public/characters/{characterId}/comics`](http://developer.marvel.com/docs#!/public/getComicsCharacterCollection_get_2).
+
+```ruby
+client.character_comics(1009610)
+client.character_comics('Spider-Man')
+client.character_comics(1009610, { format: 'graphic novel', limit: 10, orderBy: 'title' })
+client.character_comics('Spider-Man', { format: 'graphic novel', limit:, orderBy: 'title' } )
+client.character_comics(1009652, titleStartsWith: 'Infinity', hasDigitalIssue: true)
+```
+
+#### Character Events
+
+Allows you to get a list of events in which a specific character appears. This endpoint requires a character id value (integer or string).
+
+See [`GET /v1/public/characters/{characterId}/events`](http://developer.marvel.com/docs#!/public/getCharacterEventsCollection_get_3).
+
+```ruby
+client.character_events(1009610)
+client.character_events('Spider-Man')
+client.character_events(1009610, { limit: 10, orderBy: 'name' })
+client.character_events('Spider-Man', { limit: 10, orderBy: 'name' })
+client.character_events(1009652, name: 'Infinity Gauntlet')
+```
+
+#### Character Series
+
+Allows you to get a list of comic series in which a specific character appears. This endpoint requires a character id value (integer or string).
+
+See [`GET /v1/public/characters/{characterId}/series`](http://developer.marvel.com/docs#!/public/getCharacterSeriesCollection_get_4).
+
+```ruby
+client.character_series(1009610)
+client.character_series('Spider-Man')
+client.character_series(1009610, { seriesType: 'ongoing', limit: 10, orderBy: 'title' })
+client.character_series('Spider-Man', { seriesType: 'ongoing', limit: 10, orderBy: 'title' }
+client.character_series(1009652, contains: 'hardcover')
+```
+
+#### Character Stories
+
+Allows you to get a list of comic stories featuring a specific character. This endpoint requires a character id value (integer or string).
+
+See [`GET /v1/public/characters/{characterId}/stories`](http://developer.marvel.com/docs#!/public/getCharacterStoryCollection_get_5).
+
+```ruby
+client.character_stories(1009610)
+client.character_stories('Spider-Man')
+client.character_stories(1009610, { limit: 10, offset: 20 })
+client.character_stories('Spider-Man', { limit:, offset: 20 })
+client.character_stories(1009652, limit: 50)
+```
+
+### Comic Endpoints
+
+#### Comics
+
+Allows you to get a list of comics.
+
+See [`GET /v1/public/comics`](http://developer.marvel.com/docs#!/public/getComicsCollection_get_6).
+
+```ruby
+client.comics
+client.comics(format: 'graphic novel', limit: 10, offset: 20 })
+client.comics(title: 'Daredevil')
+client.comics(startYear: 1950, issueNumber: 1)
+```
+
+#### Comic
+
+Allows you to get a a single comic resource. This endpoint requires a comic id value, which must be an integer.
+
+See [`GET /v1/public/comics/{comicId}`](http://developer.marvel.com/docs#!/public/getComicIndividual_get_7).
+
+```ruby
+client.comic(40128)
+```
+
+#### Comic Characters
+
+Allows you to get a list of characters which appear in a specific comic. This endpoint requires a comic id value, which must be an integer.
+
+See [`GET /v1/public/comics/{comicId}/characters`](http://developer.marvel.com/docs#!/public/getComicCharacterCollection_get_8).
+
+```ruby
+client.comic_characters(40128)
+client.comic_characters(40128, orderBy: 'name', limit:, offset: 20)
+client.comic_characters(34249, orderBy: 'name')
+```
+
+#### Comic Creators
+
+Allows you to get a list of comic creators whose work appears in a specific comic. This endpoint requires a comic id value, which must be an integer.
+
+See [`GET /v1/public/comics/{comicId}/creators`](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_9).
+
+```ruby
+client.comic_creators(40128)
+client.comic_creators(40128, lastName: 'Romita')
+client.comic_creators(34249, lastNameStartsWith: 'V')
+```
+
+#### Comic Events
+
+Allows you to get a list of events in which a comic appears. This endpoint requires a comic id value, which must be an integer.
+
+See [`GET /v1/public/comics/{comicId}/events`](http://developer.marvel.com/docs#!/public/getIssueEventsCollection_get_10).
+
+```ruby
+client.comic_events(40128)
+client.comic_events(40128, orderBy: 'name', limit: 10)
+client.comic_events(27272, orderBy: '-startDate')
+```
+
+#### Comic Stories
+
+Allows you to get a list of comic stories in a specific comic issue. This endpoint requires a comic id value, which must be an integer.
+
+See [`GET /v1/public/comics/{comicId}/stories`](http://developer.marvel.com/docs#!/public/getComicStoryCollection_get_11).
+
+```ruby
+client.comic_stories(40128)
+client.comic_stories(40128, orderBy: 'name', limit: 10)
+client.comic_stories(27272, creators: [600, 801])
+```
+
+### Creator Endpoints
+
+#### Creators
+
+Allows you to get a lists of creators.
+
+See [`GET /v1/public/creators`](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_12).
+
+```ruby
+client.creators
+client.creators(firstName: 'Frank', lastName: 'Miller')
+client.creators(lastNameStartsWith: 'Mo', limit: 20, offset: 20)
+```
+
+#### Creator
+
+Allows you to get a single creator resource. This endpoint requires a creator id value, which must be an integer.
+
+See [`GET /v1/public/creators/{creatorId}`](http://developer.marvel.com/docs#!/public/getCreatorIndividual_get_13).
+
+```ruby
+client.creator(15)
+```
+
+### Creator Comics
+
+Allows you to get a list of comics from a given creator. This endpoint requires a creator id value, which must be an integer.
+
+See [`GET /v1/public/creators/{creatorId}/comics`](http://developer.marvel.com/docs#!/public/getComicsCollection_get_14).
+
+```ruby
+client.creator_comics(15)
+client.creator_comics(15, format: 'trade paperback')
+```
+
+#### Creator Events
+
+Allows you to get a list of events from a given creator. This endpoint requires a creator id value, which must be an integer.
+
+See [`GET /v1/public/creators/{creatorId}/events`](http://developer.marvel.com/docs#!/public/getCreatorEventsCollection_get_15).
+
+```ruby
+client.creator_events(30)
+client.creator_events(30, nameStartsWith: 'Civil')
+```
+
+#### Creator Series
+
+Allows you to get a list of series from a given creator. This endpoint requires a creator id value, which must be an integer.
+
+See [`GET /v1/public/creators/{creatorId}/series`](http://developer.marvel.com/docs#!/public/getCreatorSeriesCollection_get_16).
+
+```ruby
+client.creator_series(30)
+client.creator_series(30, seriesType: 'limited')
+```
+
+#### Creator Stories
+
+Allows you to get a list of stories from a given creator. This endpoint requires a creator id value, which must be an integer.
+
+See [`GET /v1/public/creators/{creatorId}/stories`](http://developer.marvel.com/docs#!/public/getCreatorStoryCollection_get_17).
+
+```ruby
+client.creator_stories(30)
+client.creator_stories(30, limit: 40, offset: 7750)
+```
+
+### Event Endpoints
+
+#### Events
+
+Allows you to get a list of events.
+
+See [`GET /v1/public/events`](http://developer.marvel.com/docs#!/public/getEventsCollection_get_18).
+
+```ruby
+client.events
+client.events(name: 'Acts of Vengeance')
+client.events(orderBy: 'name')
+client.events(name: 'Infinity Gauntlet')
+client.events(characters: [1009156, 1009652])
+```
+
+#### Event
+
+Allows you to get a single comic resource. This endpoint requires an event id value (integer or string).
+
+See [`GET /v1/public/events/{eventId}`](http://developer.marvel.com/docs#!/public/getEventIndividual_get_19).
+
+```ruby
+client.event(116)
+client.event('Acts of Vengeance!')
+```
+
+#### Event Characters
+
+Allows you to get a list of characters which appear in a specific event. This endpoint requires an event id value (integer or string).
+
+See [`GET /v1/public/events/{eventId}/characters`](http://developer.marvel.com/docs#!/public/getEventCharacterCollection_get_20).
+
+```ruby
+client.event_characters(116)
+client.event_characters('Acts of Vengeance!')
+client.event_characters(116, orderBy: 'name', limit: 30, offset: 20)
+client.event_characters('Acts of Vengeance!', orderBy: 'name', limit: 30, offset: 20)
+client.event_characters(227, modifiedSince: '2014-04-29')
+```
+
+#### Event Comics
+
+Allows you to get a list of comics which take place during a specific event. This endpoint requires an event id value (integer or string).
+
+See [`GET /v1/public/events/{eventId}/comics`](http://developer.marvel.com/docs#!/public/getComicsCollection_get_21).
+
+```ruby
+client.event_comics(116)
+client.event_comics('Acts of Vengeance!')
+client.event_comics(116, format: 'graphic novel', orderBy: 'title', limit: 10)
+client.event_comics('Acts of Vengeance!', format: 'graphic novel', orderBy: 'title', limit: 10)
+client.event_comics(227, hasDigitalIssue: true, orderBy: 'onsaleDate')
+```
+
+#### Event Creators
+
+Allows you to get a list of comic creators whose work appears in a specific event. This endpoint requires an event id value (integer or string).
+
+See [`GET /v1/public/events/{eventId}/creators`](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_22).
+
+```ruby
+client.event_creators(116)
+client.event_creators('Acts of Vengeance!')
+client.event_creators(116, lastName: 'Albrecht')
+client.event_creators('Acts of Vengeance!', lastName: 'Albrecht')
+client.event_creators(227, lastNameStartsWith: 'Lar')
+```
+
+#### Event Series
+
+Allows you to get a list of comic series in which a specific event takes place. This endpoint requires an event id value (integer or string).
+
+See [`GET /v1/public/events/{eventId}/series`](http://developer.marvel.com/docs#!/public/getEventSeriesCollection_get_23).
+
+```ruby
+client.event_series(116)
+client.event_series('Acts of Vengeance!')
+client.event_series(116, orderBy: 'title', limit: 10)
+client.event_series('Acts of Vengeance!', orderBy: 'title', limit: 10)
+client.event_series(227, startYear: 1995, seriesType: 'limited')
+```
+
+#### Event Stories
+
+Allows you to get a list of comic stories from a specific event. This endpoint requires an event id value (integer or string).
+
+See [`GET /v1/public/events/{eventId}/stories`](http://developer.marvel.com/docs#!/public/getEventStoryCollection_get_24).
+
+```ruby
+client.event_stories(116)
+client.event_stories(116, limit: 10)
+client.event_stories('Acts of Vengeance!')
+client.event_stories('Acts of Vengeance!', limit: 10)
+client.event_stories(227, orderBy: 'id', limit: 30, offset: 20)
+```
+
+### Series Endpoints
+
+#### Series
+
+Allows you to get a list of series.
+
+See [`GET /v1/public/series`](http://developer.marvel.com/docs#!/public/getSeriesCollection_get_25).
+
+```ruby
+client.series
+client.series(name: 'Spider-Man')
+client.series(orderBy: 'title')
+client.series(title: 'Uncanny X-Men')
+client.series(titleStartsWith: 'Astonishing', orderBy: 'startDate', limit: 100)
+```
+
+#### Serie
+
+Do note the particular spelling here!
+
+Allows you to get a single series resource. This endpoint requires an serie id value (integer).
+
+See [`GET /v1/public/series/{seriesId}`](http://developer.marvel.com/docs#!/public/getSeriesIndividual_get_26).
+
+```ruby
+client.serie(2069)
+```
+
+#### Series Characters
+
+Allows you to get a list of characters which appear in a specific series. This endpoint requires an serie id value (integer).
+
+See [`GET /v1/public/series/{seriesId}/characters`](http://developer.marvel.com/docs#!/public/getSeriesCharacterWrapper_get_27).
+
+```ruby
+client.series_characters(2069)
+client.series_characters(2069, orderBy: 'name', limit: 30, offset: 20)
+client.series_characters(354, nameStartsWith: 'Iron')
+```
+
+#### Series Comics
+
+Allows you to get a list of comics which are published as part of a specific series. This endpoint requires an serie id value (integer).
+
+See [`GET /v1/public/series/{seriesId}/comics`](http://developer.marvel.com/docs#!/public/getComicsCollection_get_28).
+
+```ruby
+client.series_comics(2069)
+client.series_comics(2069, format: 'graphic novel', orderBy: 'title', limit: 10)
+client.series_comics(354, issueNumber: 1)
+```
+
+#### Series Creators
+
+Allows you to get a list of comic creators whose work appears in a specific series. This endpoint requires an serie id value (integer).
+
+See [`GET /v1/public/series/{seriesId}/creators`](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_29).
+
+```ruby
+client.series_creators(354)
+client.series_creators(354, lastName: 'Kirby')
+```
+
+#### Series Events
+
+Allows you to get a list of comic events which occur in a specific series. This endpoint requires an serie id value (integer).
+
+See [`GET /v1/public/series/{seriesId}/events`](http://developer.marvel.com/docs#!/public/getEventsCollection_get_30).
+
+```ruby
+client.series_events(2069)
+client.series_events(2069, orderBy: 'name', limit: 10)
+client.series_events(354, orderBy: 'startDate')
+```
+
+#### Series Stories
+
+Allows you to get a list of comic stories from a specific series. This endpoint requires an serie id value (integer).
+
+See [`GET /v1/public/series/{seriesId}/stories`](http://developer.marvel.com/docs#!/public/getSeriesStoryCollection_get_31).
+
+```ruby
+client.series_stories(2069)
+client.series_stories(2069, limit: 10)
+client.series_stories(354, modifiedSince: '2013-06-01')
+```
+
+### Story Endpoints
+
+#### Stories
+
+Allows you to get a list of stories.
+
+See [`GET /v1/public/stories`](http://developer.marvel.com/docs#!/public/getStoryCollection_get_32).
+
+```ruby
+client.stories
+client.stories(limit: 50, offset: 100)
+client.stories(orderBy: 'id')
+client.stories(creators: 15)
+client.stories(characters: [1009156, 1009652], orderBy: '-modified')
+```
+
+#### Story
+
+Allows you to get a single story resource. This endpoint requires an story id value (integer).
+
+See [`GET /v1/public/stories/{storyId}`](http://developer.marvel.com/docs#!/public/getStoryIndividual_get_33).
+
+```ruby
+client.story(2210)
+```
+
+#### Story Characters
+
+Allows you to get a list of characters which appear in a specific story. This endpoint requires a story id value (integer).
+
+See [`GET /v1/public/stories/{storyId}/characters`](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_34).
+
+```ruby
+client.story_characters(2210)
+client.story_characters(2210, orderBy: 'name', limit: 30, offset: 20)
+client.story_characters(14410, nameStartsWith: 'D')
+```
+
+#### Story Comics
+
+Allows you to get a list of comics in which a specific story appears. This endpoint requires an story id value (integer).
+
+See [`GET /v1/public/stories/{storyId}/comics`](http://developer.marvel.com/docs#!/public/getComicsCollection_get_35).
+
+```ruby
+client.story_comics(2210)
+client.story_comics(2210, format: 'graphic novel', orderBy: 'title', limit: 10)
+client.story_comics(126, format: 'trade paperback')
+```
+
+#### Story Creators
+
+Allows you to get a list of comic creators whose work appears in a specific story. This endpoint requires an story id value (integer).
+
+See [`GET /v1/public/stories/{storyId}/creators`](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_36).
+
+```ruby
+client.story_creators(2210)
+client.story_creators(2210, lastName: 'Albrecht')
+client.story_creators(126, lastNameStartsWith: 'S')
+```
+
+#### Story Events
+
+Allows you to get a list of comic events in which a specific story appears. This endpoint requires an story id value (integer).
+
+See [`GET /v1/public/stories/{storyId}/events`](http://developer.marvel.com/docs#!/public/getEventsCollection_get_37).
+
+```ruby
+client.story_events(2210)
+client.story_events(2210, orderBy: 'name', limit: 10)
+```
+
+#### Story Series
+
+Allows you to get a list of comic series in which the specified story takes place. This endpoint requires a story id value (integer).
+
+See [`GET /v1/public/stories/{storyId}/series`](http://developer.marvel.com/docs#!/public/getStorySeriesCollection_get_38).
+
+```ruby
+client.story_series(2210)
+client.story_series(2210, orderBy: 'title', limit: 10)
+client.story_series(126, titleStartsWith: 'Infinity')
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/jnyman/galactus](https://github.com/jnyman/galactus). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jnyman/galactus](https://github.com/jnyman/galactus). Just as superheroes try to work together for the better good, this project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+To contribute to Galactus:
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create a feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
 
+* [Jeff Nyman](http://testerstories.com)
 
 ## License
 

data/Rakefile

@@ -1,6 +1,16 @@
 require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rubocop/rake_task'
 require 'rspec/core/rake_task'
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.title = "Galactus #{Galactus::VERSION}"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -6,9 +6,8 @@ require 'galactus'
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require 'pry'
+Pry.start
 
-require 'irb'
-IRB.start
+# require 'irb'
+# IRB.start

data/galactus.gemspec

@@ -9,12 +9,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jeff Nyman']
   spec.email         = ['jeffnyman@gmail.com']
 
-  spec.summary       = %q{Consuming the Marvel Comics API}
-  spec.description   = %q{
-    Galactus allows you to consume the API provided by the Marvel
+  spec.summary       = 'Marvel Comics API Entity Wrapper'
+  spec.description   = '
+    Just as Galactus consumes planets in the comics, the galactus
+    gem allows you to consume the API provided by the Marvel
     development team, querying on various aspects of the entire
     Marvel universe.
-  }
+  '
   spec.homepage      = 'https://github.com/jnyman/galactus'
   spec.license       = 'MIT'
 
@@ -28,6 +29,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'fakeweb'
+
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'hashie'
 
   spec.post_install_message = %{
 (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)

data/lib/galactus.rb

@@ -1,4 +1,9 @@
 require 'galactus/version'
+require 'galactus/client'
+require 'galactus/router'
 
 module Galactus
+  def self.router(params = {})
+    Galactus::Router.new(params)
+  end
 end

data/lib/galactus/client.rb

@@ -0,0 +1,121 @@
+require 'httparty'
+require 'digest/md5'
+
+require 'galactus/response'
+
+module Galactus
+  class Client
+    include HTTParty
+
+    class InvalidClientError < StandardError; end
+
+    attr_accessor :api_version, :router
+    attr_reader :public_api_key, :private_api_key
+
+    base_uri 'http://gateway.marvel.com'
+
+    def initialize(settings)
+      validate_client(settings)
+      @public_api_key = settings[:public_api_key]
+      @private_api_key = settings[:private_api_key]
+      @api_version = settings[:api_version] || 'v1'
+      @router = settings[:router] || Galactus.router(api_version: api_version)
+      provide_endpoint_methods
+    end
+
+    private
+
+    def validate_client(settings)
+      [:public_api_key, :private_api_key].each do |param|
+        unless settings[param]
+          raise InvalidClientError, "A :#{param} parameter must be specified."
+        end
+      end
+    end
+
+    def provide_endpoint_methods
+      router.routes.each do |_route_path, route_info|
+        name = route_info[:name]
+        self.class.send(:define_method, name) do |*args|
+          params, headers = process_parameters(*args)
+          response = fetch_response(name, params, headers)
+          Response.create(response)
+        end
+      end
+    end
+
+    def process_parameters(*args)
+      id_holder, options_holder = *args
+
+      if id_holder && id_holder.is_a?(Hash)
+        id = nil
+        options = id_holder || {}
+      elsif id_holder
+        id = id_holder
+        options = options_holder || {}
+      else
+        options = {}
+      end
+
+      params, headers = pull_headers(options)
+
+      [{ id: id, options: params }, headers]
+    end
+
+    def fetch_response(name, params = {}, headers = {})
+      id = params[:id]
+      options = params[:options]
+      path = find_path(name, id)
+
+      self.class.get(path, query: marvel_api_params(options), headers: headers)
+    end
+
+    def fetch_resource_id(name, id)
+      endpoint = name.split('_')[0] + 's'
+      resource = find_by_name_or_title(endpoint.to_sym, :name, id)
+      return false unless resource
+      resource[:id]
+    end
+
+    def pull_headers(options)
+      headers = options.delete(:headers) || {}
+      unless headers['Accept-Encoding']
+        headers.merge!('Accept-Encoding' => 'gzip')
+      end
+      [options, headers]
+    end
+
+    def find_by_name_or_title(endpoint, column, value)
+      response = send(endpoint, column.to_sym => value)
+      return false unless response[:data][:count] > 0
+      response[:id] = response[:data][:results][0][:id]
+      response
+    end
+
+    def find_path(name, id)
+      if id.nil?
+        router.send("#{name}_path".to_sym)
+      else
+        id = fetch_resource_id(name, id) if id.is_a?(String)
+        router.send("#{name}_path".to_sym, id: id)
+      end
+    end
+
+    def marvel_api_params(params = {})
+      base_hash = {
+        apikey: public_api_key,
+        ts: timestamp,
+        hash: api_request_hash }
+
+      params.merge(base_hash)
+    end
+
+    def timestamp
+      Time.now.to_i
+    end
+
+    def api_request_hash
+      Digest::MD5.hexdigest("#{timestamp}#{private_api_key}#{public_api_key}")
+    end
+  end
+end

data/lib/galactus/config/v1.yml

@@ -0,0 +1,117 @@
+1:
+  name: 'characters'
+  path: '/public/characters'
+2:
+  name: 'character'
+  path: '/public/characters/:id'
+3:
+  name: 'character_comics'
+  path: '/public/characters/:id/comics'
+4:
+  name: 'character_events'
+  path: '/public/characters/:id/events'
+5:
+  name: 'character_series'
+  path: '/public/characters/:id/series'
+6:
+  name: 'character_stories'
+  path: '/public/characters/:id/stories'
+7:
+  name: 'comics'
+  path: '/public/comics'
+8:
+  name: 'comic'
+  path: '/public/comics/:id'
+9:
+  name: 'comic_characters'
+  path: '/public/comics/:id/characters'
+10:
+  name: 'comic_creators'
+  path: '/public/comics/:id/creators'
+11:
+  name: 'comic_events'
+  path: '/public/comics/:id/events'
+12:
+  name: 'comic_stories'
+  path: '/public/comics/:id/stories'
+13:
+  name: 'creators'
+  path: '/public/creators'
+14:
+  name: 'creator'
+  path: '/public/creators/:id'
+15:
+  name: 'creator_comics'
+  path: '/public/creators/:id/comics'
+16:
+  name: 'creator_events'
+  path: '/public/creators/:id/events'
+17:
+  name: 'creator_series'
+  path: '/public/creators/:id/series'
+18:
+  name: 'creator_stories'
+  path: '/public/creators/:id/stories'
+19:
+  name: 'events'
+  path: '/public/events'
+20:
+  name: 'event'
+  path: '/public/events/:id'
+21:
+  name: 'event_characters'
+  path: '/public/events/:id/characters'
+22:
+  name: 'event_creators'
+  path: '/public/events/:id/creators'
+23:
+  name: 'event_comics'
+  path: '/public/events/:id/comics'
+24:
+  name: 'event_stories'
+  path: '/public/events/:id/stories'
+25:
+  name: 'event_series'
+  path: '/public/events/:id/series'
+26:
+  name: 'series'
+  path: '/public/series'
+27:
+  name: 'serie'
+  path: '/public/series/:id'
+28:
+  name: 'series_characters'
+  path: '/public/series/:id/characters'
+29:
+  name: 'series_comics'
+  path: '/public/series/:id/comics'
+30:
+  name: 'series_creators'
+  path: '/public/series/:id/creators'
+31:
+  name: 'series_events'
+  path: '/public/series/:id/events'
+32:
+  name: 'series_stories'
+  path: '/public/series/:id/stories'
+33:
+  name: 'stories'
+  path: '/public/stories'
+34:
+  name: 'story'
+  path: '/public/stories/:id'
+35:
+  name: 'story_characters'
+  path: '/public/stories/:id/characters'
+36:
+  name: 'story_comics'
+  path: '/public/stories/:id/comics'
+37:
+  name: 'story_creators'
+  path: '/public/stories/:id/creators'
+38:
+  name: 'story_events'
+  path: '/public/stories/:id/events'
+39:
+  name: 'story_series'
+  path: '/public/stories/:id/series'

data/lib/galactus/response.rb

@@ -0,0 +1,40 @@
+require 'hashie'
+
+module Galactus
+  class Response < Hash
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IndifferentAccess
+    include Hashie::Extensions::KeyConversion
+
+    attr_reader :raw_response
+
+    def self.create(response)
+      case response.code
+        when 200
+          Response.new(response)
+        when 304
+          NotModifiedResponse.new(response)
+        else
+          ErrorResponse.new(response)
+      end
+    end
+
+    def initialize(response)
+      @raw_response = response
+      super(response)
+    end
+  end
+
+  class ErrorResponse < Response; end
+
+  class NotModifiedResponse < Response
+    def initialize(response)
+      super({
+        status: 'Not Modified',
+        code: 304,
+        data: {},
+        etag: response.headers['etag'] })
+    end
+  end
+end

data/lib/galactus/router.rb

@@ -0,0 +1,55 @@
+module Galactus
+  class Router
+    require 'yaml'
+
+    attr_accessor :api_version
+    attr_reader :routes
+
+    def initialize(settings = {})
+      @routes = {}
+      @api_version = settings[:api_version] || 'v1'
+      load_api_routes("#{api_version}.yml")
+    end
+
+    private
+
+    def load_api_routes(file)
+      api_routes_path = check_for_api_file(file)
+      contents = YAML.load(File.read(api_routes_path))
+
+      contents.each do |_route_id, route_info|
+        add_api_route(route_info['name'], route_info['path'])
+      end
+    end
+
+    def add_api_route(name, path)
+      routes["#{name}_path".to_sym] = { name: name, endpoint: path }
+    end
+
+    def check_for_api_file(file)
+      script_path = current_script_path
+      file_path = File.join(script_path, 'config', file)
+      return file_path if File.exist?(file_path)
+      file_path = File.join(File.dirname(__FILE__), 'config', file)
+      file_path if File.exist?(file_path)
+    end
+
+    def current_script_path
+      File.expand_path(File.dirname(File.expand_path $PROGRAM_NAME))
+    end
+
+    def method_missing(method, *args)
+      return unless routes.keys.include?(method)
+      endpoint = "#{routes[method][:endpoint]}"
+      params = *args
+
+      if params.any?
+        params[0].each do |p_key, p_value|
+          endpoint.gsub!(":#{p_key}", p_value.to_s)
+        end
+      end
+
+      "/#{api_version}#{endpoint}"
+    end
+  end
+end

data/lib/galactus/version.rb

@@ -1,3 +1,3 @@
 module Galactus
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spikes/call_marvel_api.rb

@@ -0,0 +1,50 @@
+#! /usr/bin/env ruby
+
+require 'yaml'
+require 'net/http'
+require 'digest/md5'
+
+# http://developer.marvel.com/documentation/authorization
+# Requests on the server side must be of the form:
+# http://gateway.marvel.com/v1/comics/?ts=1&apikey=1234&hash=ffd275c5130566a2916217b101f26150
+
+# `ts` is a timestamp, but it can apparently just be some string which can
+#  change on a request-by-request basis.
+# `apikey` is the public API key
+# `hash` is an md5 digest of the timestamp parameter, the private key and
+#  the public key.
+
+# This test file requires an api_key.yml file with the following:
+# public_api_key: value
+# private_api_key: value
+# This file will not be placed in version control since it will contain the
+# private key.
+
+api_key_file = "#{File.dirname(__FILE__)}/api_keys.yml"
+
+marvel_public_key = YAML.load_file(api_key_file)['public_api_key']
+marvel_private_key = YAML.load_file(api_key_file)['private_api_key']
+
+endpoint = 'http://gateway.marvel.com/v1/public/'
+
+timestamp = '1'
+
+ts_param = '&ts='
+hash_param = '&hash='
+api_param = '&apikey='
+
+search_term = 'characters?name=Spider-Man'
+
+url = endpoint + search_term + ts_param + timestamp + api_param + marvel_public_key + hash_param
+
+hash = timestamp + marvel_private_key + marvel_public_key
+digest = Digest::MD5.hexdigest(hash)
+
+url += digest
+
+puts url
+
+response = Net::HTTP.get_response(URI.parse(url))
+response_text = response.body
+
+puts response_text

data/spikes/call_marvel_via_galactus.rb

@@ -0,0 +1,19 @@
+#! /usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'yaml'
+require 'galactus'
+
+api_key_file = "#{File.dirname(__FILE__)}/api_keys.yml"
+
+public_key = YAML.load_file(api_key_file)['public_api_key']
+private_key = YAML.load_file(api_key_file)['private_api_key']
+
+client = Galactus::Client.new(public_api_key: public_key, private_api_key: private_key)
+
+#puts client.characters['status']
+#puts client.characters[:data][:results].size
+
+#puts client.character(1009652)
+puts client.character('Spider-Man')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: galactus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,9 +52,93 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n    Galactus allows you to consume the API provided by the Marvel\n
-  \   development team, querying on various aspects of the entire\n    Marvel universe.\n
-  \ "
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    Just as Galactus consumes planets in the comics, the galactus\n
+  \   gem allows you to consume the API provided by the Marvel\n    development team,
+  querying on various aspects of the entire\n    Marvel universe.\n  "
 email:
 - jeffnyman@gmail.com
 executables: []
@@ -62,7 +146,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -73,13 +159,19 @@ files:
 - bin/setup
 - galactus.gemspec
 - lib/galactus.rb
+- lib/galactus/client.rb
+- lib/galactus/config/v1.yml
+- lib/galactus/response.rb
+- lib/galactus/router.rb
 - lib/galactus/version.rb
+- spikes/call_marvel_api.rb
+- spikes/call_marvel_via_galactus.rb
 homepage: https://github.com/jnyman/galactus
 licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n
-  \ Galactus 0.1.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::)
+  \ Galactus 0.2.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
@@ -99,5 +191,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Consuming the Marvel Comics API
+summary: Marvel Comics API Entity Wrapper
 test_files: []