marvelite 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79f53a7757f023b10894b8e6ed848fb12391cd92
-  data.tar.gz: b040915a1836fc80ab2264f1e0a7d382e4b83285
+  metadata.gz: 78f3523b35c99204782fcc7de772ecb0d3118ee7
+  data.tar.gz: 5aa161a8dd19701b436ab98d1a20f4fd600487e0
 SHA512:
-  metadata.gz: 3ad69674271a377ca1e63f9cd4ccba4f8dfcbad3c3c354a2487392cf2841fc2bce905f0c90b66a0250e2014cec5fcf42908c2dda2d537b2bdcb7db58855dc2a4
-  data.tar.gz: 78a1f01d3a93eb825cd0977e193f063883b94d2201878dae979c9e905fae3ac5eba577b54719ddbd5705b5d26a19cd3004c2256d124518ff10f81ea6d40c5a53
+  metadata.gz: ddba4b3509793d06748f2a46dc48b896cfd41c2bfaa7e94e8e754050fa9f7a8a57b584b3169faafc7bc295b21f45060a0244291a619d99e138c004d3ae3f2bb3
+  data.tar.gz: 12bfc57f6b8ba408aad7b18b10f364ef415f6294e81f9b973561ad541a738cf12f65a68207a0d524c46ec209fc66f96d0d18588ae0371087c3ba284469fb9771

data/README.md

@@ -2,6 +2,9 @@
 
 Simple wrapper to communicate with the Marvel Comics API.
 
+
+> **Important:** This is a work in progress. There's only two endpoints to connect to. I am working into incorporating all of Marvel Comics API endpoints.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,7 +42,10 @@ client = Marvelite::API::Client.new(:public_key => 'abcd1234', :private_key => '
 | ------ | ----------- |
 | [#characters](#characters) | Fetches a list of comic characters. |
 | [#character](#character) | Fetches a single character resource. |
-
+| [#character_comics](#character_comics) | Fetches a list of comics containing a specific character. |
+| [#character_events](#character_events) | Fetches a list of events in which a specific character appears. |
+| [#character_series](#character_series) | Fetches a list of comic series in which a specific character appears. |
+| [#character_stories](#character_stories) | Fetches a list of comic stories featuring a specific character. |
 
 #### characters
 Fetches a list of comic characters. Can receive optional params.
@@ -54,13 +60,68 @@ See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#
 
 #### character
 
-Fetches a single character resource. Accepts an integer or string value.
+Fetches a single character resource. Accepts an integer or string value as character id.
+
+```ruby
+client.character(1009610)
+client.character('Spider-Man')
+```
+
+#### character_comics
+
+Fetches a list of comics containing a specific character. Requires a character id value (integer). Accepts optional params.
 
 ```ruby
-client.character(1009368)
-client.character('Iron Man')
+client.character_comics(1009610)
+client.character_comics(
+  1009610,
+  { :format => 'graphic novel', :limit => 10, :orderBy => 'title' }
+)
 ```
 
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getComicsCharacterCollection_get_2) for a complete list of params that you can pass to the `#character_comics` method.
+
+#### character_events
+
+Fetches a list of events in which a specific character appears. Requires a character id value (integer). Accepts optional params.
+
+```ruby
+client.character_events(1009610)
+client.character_events(
+  1009610,
+  { :limit => 10, :orderBy => 'name' }
+)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getCharacterEventsCollection_get_3) for a complete list of params that you can pass to the `#character_events` method.
+
+
+#### character_series
+
+Fetches a list of comic series in which a specific character appears. Requires a character id value (integer). Accepts optional params.
+
+```ruby
+client.character_series(1009610)
+client.character_series(
+  1009610,
+  { :seriesType => 'ongoing', :limit => 10, :orderBy => 'title' }
+)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getCharacterSeriesCollection_get_4) for a complete list of params that you can pass to the `#character_series` method.
+
+
+#### character_stories
+
+Fetches a list of comic stories featuring a specific character. Requires a character id value (integer). Accepts optional params.
+
+```ruby
+client.character_stories(1009610)
+client.character_stories(1009610, { :limit => 10, :offset => 20 })
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getCharacterStoryCollection_get_5) for a complete list of params that you can pass to the `#character_stories` method.
+
 ## Responses
 
 All requests to the API, return a `Marvelite::API::Response` object, that is nothing more than the raw API response enhanced with Hashie methods.

data/lib/marvelite/api/client.rb

@@ -32,6 +32,26 @@ module Marvelite
         Response.new(response)
       end
 
+      def character_comics(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.character_comics_path(id)}", :query => params(query_params))
+        Response.new(response)
+      end
+
+      def character_events(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.character_events_path(id)}", :query => params(query_params))
+        Response.new(response)
+      end
+
+      def character_series(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.character_series_path(id)}", :query => params(query_params))
+        Response.new(response)
+      end
+
+      def character_stories(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.character_stories_path(id)}", :query => params(query_params))
+        Response.new(response)
+      end
+
       private
       def params(additional_params = {})
         base_hash = { :apikey => public_key, :ts => ts, :hash => request_hash }

data/lib/marvelite/api/router.rb

@@ -17,6 +17,10 @@ module Marvelite
         "public/characters/#{id}/events"
       end
 
+      def character_series_path(id)
+        "public/characters/#{id}/series"
+      end
+
       def character_stories_path(id)
         "public/characters/#{id}/stories"
       end

data/lib/marvelite/version.rb

@@ -1,3 +1,3 @@
 module Marvelite
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marvelite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Antonio Antillon