marvelite 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcf2ccb0ede4085ab09804bc5d5cf1510d75a382
-  data.tar.gz: 7ade97ec9ff11f4880ce79ee2ca4a4751cf9eb1a
+  metadata.gz: 5869a9c08209ca2f9f7e12da466a094c90896c8b
+  data.tar.gz: 223abc8115a7c6f52e49f336ab552dfede7bdd2f
 SHA512:
-  metadata.gz: e0284135f3777d78c31ecd91dcb3f2f2c15d2744cfa28a21286211a03f5ec8f60f84625c873d16d12d1483ec537524ffb1498512df6ef9e88bede7f683f71d79
-  data.tar.gz: 151a57db1addd05f107654ca8b504cd199060432df8b714dfd4374be79e4634d117dc5a6e8671ab4dc65299e22a23a608f05c9f16b962da5fa1bab2d9ca8718d
+  metadata.gz: ecea6aebd6822352fc79508ec0871782276fe4e8296d43f97686a274e37bd4316a06eb2be6324c1c7aa47409de0faa29e61cd6003034d2288974f45a54871dff
+  data.tar.gz: e8b51d2cc3bdd8f347b081a1e0837a755a41052c9a1064003f7b44c9c8d5fcfaa1dcd49a0f8a70c6132def107c10d93ade4ecc80640f95bffd71069b2afff8ef

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Changelog
 
+### 0.0.4
+* Adds the following endpoints:
+  * retrieve comics by connecting to the API's `/comics` endpoint
+  * retieve a comic by connecting to the API's `/comics/:id` enpoint
+  * retrieve comic characters by connecting to the API's `/comics/:id/characters` endpoint.
+  * retrieve comic creators by connecting to the API's `/comics/:id/creators` endpoint.
+  * retrieve comic events by connecting to the API's `/comics/:id/events` endpoint.
+  * retrieve comic stories by connecting to the API's `/comics/:id/stories` endpoint.
+
 ### 0.0.3
 * Adds basic testing setup
 * Adds the ability to retrieve:

data/README.md

@@ -49,6 +49,13 @@ client = Marvelite::API::Client.new(
 | [#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. |
+| [#comics](#comics) | Fetches a list of comics. |
+| [#comic](#comic) | Fetches a single comic resource. |
+| [#comic_characters](#comic_characters) | Fetches a list of characters which appear in a specific comic. |
+| [#comic_creators](#comic_creators) | Fetches a list of comic creators whose work appears in a specific comic. |
+| [#comic_events](#comic_events) | Fetches a list of events in which a comic appears. |
+| [#comic_stories](#comic_stories) | Fetches a list of comic stories in a specific comic issue. |
+
 
 #### characters
 Fetches a list of comic characters. Can receive optional params.
@@ -142,6 +149,71 @@ client.character_stories('Spider-Man', { :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.
 
+
+#### comics
+
+Fetches a list of comics. Accepts optional params.
+
+```ruby
+client.comics
+client.comics(:format => 'graphic novel', :limit => 10, :offset => 20 })
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getComicsCollection_get_6) for a complete list of params that you can pass to the `#comics` method.
+
+#### comic
+
+Fetches a single comic resource. Requires a comic id value (integer).
+
+```ruby
+client.comic(40128)
+```
+
+#### comic_characters
+
+Fetches a list of characters which appear in a specific comic. Requires a comic id value (integer). Accepts optional params.
+
+```ruby
+client.comic_characters(40128)
+client.comic_characters(40128, :orderBy => 'name', :limit => 30, :offset => 20)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getComicCharacterCollection_get_8) for a complete list of params that you can pass to the `#comic_characters` method.
+
+#### comic_creators
+
+Fetches a list of comic creators whose work appears in a specific comic. Requires a comic id value (integer). Accepts optional params.
+
+```ruby
+client.comic_creators(40128)
+client.comic_creators(40128, :lastName => 'Romita')
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_9) for a complete list of params that you can pass to the `#comic_creators` method.
+
+#### comic_events
+
+Fetches a list of events in which a comic appears. Requires a comic id value (integer). Accepts optional params.
+
+```ruby
+client.comic_events(40128)
+client.comic_events(40128, :orderBy => 'name', :limit => 10)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getIssueEventsCollection_get_10) for a complete list of params that you can pass to the `#comic_events` method.
+
+#### comic_stories
+
+Fetches a list of comic stories in a specific comic issue. Requires a comic id value (integer). Accepts optional params.
+
+```ruby
+client.comic_stories(40128)
+client.comic_stories(40128, :orderBy => 'name', :limit => 10)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getComicStoryCollection_get_11) for a complete list of params that you can pass to the `#comic_stories` method.
+
+
 ## Responses
 
 All requests to the API, return a `Marvelite::API::Response` object if successful or a `Marvelite::API::ErrorResponse` if API response returns an error. These objects are nothing more than the raw API response enhanced with Hashie methods.

data/lib/marvelite.rb

@@ -5,6 +5,8 @@ require 'hashie'
 
 require "marvelite/version"
 require "marvelite/api/router"
+require "marvelite/api/character_methods"
+require "marvelite/api/comic_methods"
 require "marvelite/api/client"
 require "marvelite/api/response"
 

data/lib/marvelite/api/character_methods.rb

@@ -0,0 +1,62 @@
+module Marvelite
+  module API
+    module CharacterMethods
+      def characters(query_params = {})
+        response = self.class.get("/#{api_version}/#{router.characters_path}", :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def character(value)
+        by_name = value.is_a?(String) ? true : false
+        response = if by_name
+          find_character_by_name(value)
+        else
+          self.class.get("/#{api_version}/#{router.character_path(value)}", :query => params)
+        end
+
+        build_response_object(response)
+      end
+
+      def character_comics(id, query_params = {})
+        if id.is_a?(String)
+          character = find_character_by_name(id)
+          return false unless character
+          id = character.id
+        end
+
+        response = self.class.get("/#{api_version}/#{router.character_comics_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def character_events(id, query_params = {})
+        if id.is_a?(String)
+          character = find_character_by_name(id)
+          return false unless character
+          id = character.id
+        end
+        response = self.class.get("/#{api_version}/#{router.character_events_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def character_series(id, query_params = {})
+        if id.is_a?(String)
+          character = find_character_by_name(id)
+          return false unless character
+          id = character.id
+        end
+        response = self.class.get("/#{api_version}/#{router.character_series_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+      
+      def character_stories(id, query_params = {})
+        if id.is_a?(String)
+          character = find_character_by_name(id)
+          return false unless character
+          id = character.id
+        end
+        response = self.class.get("/#{api_version}/#{router.character_stories_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+    end
+  end
+end

data/lib/marvelite/api/client.rb

@@ -2,6 +2,10 @@ module Marvelite
   module API
     class Client
       include ActiveModel::Model
+      
+      include Marvelite::API::CharacterMethods
+      include Marvelite::API::ComicMethods
+
       include HTTParty
       base_uri 'http://gateway.marvel.com'
 
@@ -16,63 +20,6 @@ module Marvelite
         @api_version = attrs.fetch(:api_version) { 'v1' }
       end
 
-      def characters(query_params = {})
-        response = self.class.get("/#{api_version}/#{router.characters_path}", :query => params(query_params))
-        build_response_object(response)
-      end
-
-      def character(value)
-        by_name = value.is_a?(String) ? true : false
-        response = if by_name
-          find_character_by_name(value)
-        else
-          self.class.get("/#{api_version}/#{router.character_path(value)}", :query => params)
-        end
-
-        build_response_object(response)
-      end
-
-      def character_comics(id, query_params = {})
-        if id.is_a?(String)
-          character = find_character_by_name(id)
-          return false unless character
-          id = character.id
-        end
-
-        response = self.class.get("/#{api_version}/#{router.character_comics_path(id)}", :query => params(query_params))
-        build_response_object(response)
-      end
-
-      def character_events(id, query_params = {})
-        if id.is_a?(String)
-          character = find_character_by_name(id)
-          return false unless character
-          id = character.id
-        end
-        response = self.class.get("/#{api_version}/#{router.character_events_path(id)}", :query => params(query_params))
-        build_response_object(response)
-      end
-
-      def character_series(id, query_params = {})
-        if id.is_a?(String)
-          character = find_character_by_name(id)
-          return false unless character
-          id = character.id
-        end
-        response = self.class.get("/#{api_version}/#{router.character_series_path(id)}", :query => params(query_params))
-        build_response_object(response)
-      end
-
-      def character_stories(id, query_params = {})
-        if id.is_a?(String)
-          character = find_character_by_name(id)
-          return false unless character
-          id = character.id
-        end
-        response = self.class.get("/#{api_version}/#{router.character_stories_path(id)}", :query => params(query_params))
-        build_response_object(response)
-      end
-
       private
       def params(additional_params = {})
         base_hash = { :apikey => public_key, :ts => ts, :hash => request_hash }

data/lib/marvelite/api/comic_methods.rb

@@ -0,0 +1,35 @@
+module Marvelite
+  module API
+    module ComicMethods
+      def comics(query_params = {})
+        response = self.class.get("/#{api_version}/#{router.comics_path}", :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def comic(id)
+        response = self.class.get("/#{api_version}/#{router.comic_path(id)}", :query => params)
+        build_response_object(response)
+      end
+
+      def comic_characters(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.comic_characters_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def comic_events(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.comic_events_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def comic_creators(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.comic_creators_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+      
+      def comic_stories(id, query_params = {})
+        response = self.class.get("/#{api_version}/#{router.comic_stories_path(id)}", :query => params(query_params))
+        build_response_object(response)
+      end
+    end
+  end
+end

data/lib/marvelite/api/router.rb

@@ -24,6 +24,30 @@ module Marvelite
       def character_stories_path(id)
         "public/characters/#{id}/stories"
       end
+
+      def comics_path
+        "public/comics"
+      end
+
+      def comic_path(id)
+        "public/comics/#{id}"
+      end
+
+      def comic_characters_path(id)
+        "public/comics/#{id}/characters"
+      end
+
+      def comic_creators_path(id)
+        "public/comics/#{id}/creators"
+      end
+
+      def comic_events_path(id)
+        "public/comics/#{id}/events"
+      end
+
+      def comic_stories_path(id)
+        "public/comics/#{id}/stories"
+      end
     end
   end
 end

data/lib/marvelite/version.rb

@@ -1,3 +1,3 @@
 module Marvelite
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/fixtures/comics/comic.json

@@ -0,0 +1,259 @@
+{
+  "code": 200,
+  "status": "Ok",
+  "etag": "7dff68517455de2200bde0216974bf20ae7f3dc3",
+  "data": {
+    "offset": 0,
+    "limit": 20,
+    "total": 1,
+    "count": 1,
+    "results": [
+      {
+        "id": 40128,
+        "digitalId": 28117,
+        "title": "Amazing Spider-Man (1999) #700",
+        "issueNumber": 700,
+        "variantDescription": "",
+        "description": null,
+        "modified": "2013-02-01T15:45:55-0500",
+        "isbn": "",
+        "upc": 75960604716170000,
+        "diamondCode": "OCT120626",
+        "ean": "",
+        "issn": "0274-5232",
+        "format": "Comic",
+        "pageCount": 104,
+        "textObjects": [],
+        "resourceURI": "http://gateway.marvel.com/v1/public/comics/40128",
+        "urls": [
+          {
+            "type": "detail",
+            "url": "http://marvel.com/comics/issue/40128/amazing_spider-man_1999_700?utm_campaign=apiRef&utm_source=85ec0830b5958f4f46ea2fa898a76ef2"
+          },
+          {
+            "type": "purchase",
+            "url": "http://comicstore.marvel.com/Amazing-Spider-Man-700/digital-comic/28117?utm_campaign=apiRef&utm_source=85ec0830b5958f4f46ea2fa898a76ef2"
+          },
+          {
+            "type": "reader",
+            "url": "http://marvel.com/digitalcomics/view.htm?iid=28117&utm_campaign=apiRef&utm_source=85ec0830b5958f4f46ea2fa898a76ef2"
+          },
+          {
+            "type": "inAppLink",
+            "url": "http://applink.marvel.com/issue/28117?utm_campaign=apiRef&utm_source=85ec0830b5958f4f46ea2fa898a76ef2"
+          }
+        ],
+        "series": {
+          "resourceURI": "http://gateway.marvel.com/v1/public/series/454",
+          "name": "Amazing Spider-Man (1999 - 2013)"
+        },
+        "variants": [
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/49353",
+            "name": "Amazing Spider-Man (1999) #700 (Ramos 5th Printing Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/47884",
+            "name": "Amazing Spider-Man (1999) #700 (4th Printing Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/47631",
+            "name": "Amazing Spider-Man (1999) #700 (Camuncoli 3rd Printing Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/47350",
+            "name": "Amazing Spider-Man (1999) #700 (Ramos 2nd Printing Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/44623",
+            "name": "Amazing Spider-Man (1999) #700 (Martin Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/42440",
+            "name": "Amazing Spider-Man (1999) #700 (Asm 50th Anniversary Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/44620",
+            "name": "Amazing Spider-Man (1999) #700 (Ramos Wraparound Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/44621",
+            "name": "Amazing Spider-Man (1999) #700 (Quesada Wraparound Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/44622",
+            "name": "Amazing Spider-Man (1999) #700 (Ditko Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/44624",
+            "name": "Amazing Spider-Man (1999) #700 (Coipel Variant)"
+          },
+          {
+            "resourceURI": "http://gateway.marvel.com/v1/public/comics/46995",
+            "name": "Amazing Spider-Man (1999) #700 (Quesada Wraparound Sketch Variant)"
+          }
+        ],
+        "collections": [],
+        "collectedIssues": [],
+        "dates": [
+          {
+            "type": "onsaleDate",
+            "date": "2012-12-26T00:00:00-0500"
+          },
+          {
+            "type": "focDate",
+            "date": "2012-12-04T00:00:00-0500"
+          },
+          {
+            "type": "unlimitedDate",
+            "date": "2013-06-24T13:04:49-0400"
+          },
+          {
+            "type": "digitalPurchaseDate",
+            "date": "2012-12-26T00:00:00-0500"
+          }
+        ],
+        "prices": [
+          {
+            "type": "printPrice",
+            "price": 7.99
+          },
+          {
+            "type": "digitalPurchasePrice",
+            "price": 3.99
+          }
+        ],
+        "thumbnail": {
+          "path": "http://i.annihil.us/u/prod/marvel/i/mg/3/b0/510c2957c9b75",
+          "extension": "jpg"
+        },
+        "images": [
+          {
+            "path": "http://i.annihil.us/u/prod/marvel/i/mg/3/b0/510c2957c9b75",
+            "extension": "jpg"
+          },
+          {
+            "path": "http://i.annihil.us/u/prod/marvel/i/mg/3/60/508841f5f024d",
+            "extension": "jpg"
+          },
+          {
+            "path": "http://i.annihil.us/u/prod/marvel/i/mg/e/60/504fb308babca",
+            "extension": "jpg"
+          },
+          {
+            "path": "http://i.annihil.us/u/prod/marvel/i/mg/9/b0/504fb2946ee9a",
+            "extension": "jpg"
+          },
+          {
+            "path": "http://i.annihil.us/u/prod/marvel/i/mg/5/f0/504fb1d794b20",
+            "extension": "jpg"
+          }
+        ],
+        "creators": {
+          "available": 12,
+          "collectionURI": "http://gateway.marvel.com/v1/public/comics/40128/creators",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/105",
+              "name": "Sal Buscema",
+              "role": "inker"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/447",
+              "name": "Victor Olazaba",
+              "role": "inker"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/9461",
+              "name": "Stephanie Buscema",
+              "role": "artist"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/1141",
+              "name": "Giuseppe Camuncoli",
+              "role": "penciler"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/72",
+              "name": "Humberto Ramos",
+              "role": "penciler"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/430",
+              "name": "Edgar Delgado",
+              "role": "colorist"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/428",
+              "name": "Antonio Fabela",
+              "role": "colorist"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/6986",
+              "name": "J. M. DeMatteis",
+              "role": "writer"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/626",
+              "name": "Dan Slott",
+              "role": "writer"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/11788",
+              "name": "Jennifer Van Meter",
+              "role": "writer"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/452",
+              "name": "Chris Eliopoulos",
+              "role": "letterer"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/creators/11879",
+              "name": "Stephen Wacker",
+              "role": "editor"
+            }
+          ],
+          "returned": 12
+        },
+        "characters": {
+          "available": 1,
+          "collectionURI": "http://gateway.marvel.com/v1/public/comics/40128/characters",
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/characters/1009610",
+              "name": "Spider-Man"
+            }
+          ],
+          "returned": 1
+        },
+        "stories": {
+          "available": 2,
+          "collectionURI": {
+            "service": "comic_issueStories",
+            "id": 40128
+          },
+          "items": [
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/stories/91053",
+              "name": "Cover #91053",
+              "type": "cover"
+            },
+            {
+              "resourceURI": "http://gateway.marvel.com/v1/public/stories/91054",
+              "name": "Interior #91054",
+              "type": "interiorStory"
+            }
+          ],
+          "returned": 2
+        },
+        "events": {
+          "available": 0,
+          "collectionURI": "http://gateway.marvel.com/v1/public/comics/40128/events",
+          "items": [],
+          "returned": 0
+        }
+      }
+    ]
+  }
+}