marvelite 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5869a9c08209ca2f9f7e12da466a094c90896c8b
-  data.tar.gz: 223abc8115a7c6f52e49f336ab552dfede7bdd2f
+  metadata.gz: 984423d6566dfc1729975c08cda31745a35afe55
+  data.tar.gz: 4ad394d4c98726d62f5e465e5e7bd7898390febb
 SHA512:
-  metadata.gz: ecea6aebd6822352fc79508ec0871782276fe4e8296d43f97686a274e37bd4316a06eb2be6324c1c7aa47409de0faa29e61cd6003034d2288974f45a54871dff
-  data.tar.gz: e8b51d2cc3bdd8f347b081a1e0837a755a41052c9a1064003f7b44c9c8d5fcfaa1dcd49a0f8a70c6132def107c10d93ade4ecc80640f95bffd71069b2afff8ef
+  metadata.gz: 32bb4d940672d707a0ddb92ba322fafc3b6fa93796b8f7ee3bbe5f58657e3bf7572d6d425cd77a24913f939c82a9ea123f2e9778981132d4ca12b0bf22168a1d
+  data.tar.gz: 90af92a8e7c9fd53aead7ec8c3eb8c34db2d1e2755afbce35ed5bfbb636da59e54c790deba64f259e5381d32f113b960d1c363e6c45792f783049e8c28eec5f4

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Changelog
 
+### 0.0.5
+* Rewrites `Marvelite::API::Router` class to make flexible to future API versioning changes from Marvel.
+* Adds the following endpoints:
+  * retrieve events by connecting to the API's `/events` endpoint
+  * retieve a event by connecting to the API's `/events/:id` enpoint
+  * retrieve event characters by connecting to the API's `/events/:id/characters` endpoint.
+  * retrieve event comics by connecting to the API's `/events/:id/comics` endpoint.
+  * retrieve event creators by connecting to the API's `/events/:id/creators` endpoint.
+  * retrieve event series by connecting to the API's `/events/:id/series` endpoint.
+  * retrieve event stories by connecting to the API's `/events/:id/stories` endpoint.
+* Adds helper method to retrieve event sub-resources passing an event name instead of a numeric id.
+
+
 ### 0.0.4
 * Adds the following endpoints:
   * retrieve comics by connecting to the API's `/comics` endpoint

data/README.md

@@ -55,6 +55,13 @@ client = Marvelite::API::Client.new(
 | [#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. |
+| [#events](#events) | Fetches a list of events. |
+| [#event](#event) | Fetches a single event resource. |
+| [#event_characters](#event_characters) | Fetches a list of characters which appear in a specific event. |
+| [#event_comics](#event_comics) | Fetches a list of comics which take place during a specific event. |
+| [#event_creators](#event_creators) | Fetches a list of event creators whose work appears in a specific event. |
+| [#event_series](#event_series) | Fetches a list of comic series in which a specific event takes place. |
+| [#event_stories](#event_stories) | Fetches a list of comic stories from a specific event. |
 
 
 #### characters
@@ -213,6 +220,82 @@ 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.
 
+#### events
+
+Fetches a list of events. Accepts optional params.
+
+```ruby
+client.events
+client.events(:name => 'Acts of Vengeance')
+client.events(:orderBy => 'name')
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getEventsCollection_get_18) for a complete list of params that you can pass to the `#events` method.
+
+#### event
+
+Fetches a single comic resource. Requires an event id value (integer).
+
+```ruby
+client.event(116)
+```
+
+#### event_characters
+
+Fetches a list of characters which appear in a specific event. Requires an event id value (integer). Accepts optional params.
+
+```ruby
+client.event_characters(116)
+client.event_characters(116, :orderBy => 'name', :limit => 30, :offset => 20)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getEventCharacterCollection_get_20) for a complete list of params that you can pass to the `#event_characters` method.
+
+#### event_creators
+
+Fetches a list of comic creators whose work appears in a specific event. Requires an event id value (integer). Accepts optional params.
+
+```ruby
+client.event_creators(116)
+client.event_creators(116, :lastName => 'Romita')
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_22) for a complete list of params that you can pass to the `#event_creators` method.
+
+#### event_comics
+
+Fetches a list of comics which take place during a specific event. Requires an event id value (integer). Accepts optional params.
+
+```ruby
+client.event_comics(116)
+client.event_comics(116, :format => 'graphic novel', :orderBy => 'title', :limit => 10)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getComicsCollection_get_21) for a complete list of params that you can pass to the `#event_comics` method.
+
+#### event_series
+
+Fetches a list of comic series in which a specific event takes place. Requires an event id value (integer). Accepts optional params.
+
+```ruby
+client.event_series(116)
+client.event_series(116, :orderBy => 'title', :limit => 10)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getCreatorSeriesCollection_get_23) for a complete list of params that you can pass to the `#event_series` method.
+
+#### event_stories
+
+Fetches a list of comic stories from a specific event. Requires an event id value (integer). Accepts optional params.
+
+```ruby
+client.event_stories(116)
+client.event_stories(116, :limit => 10)
+```
+
+See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getEventStoryCollection_get_24) for a complete list of params that you can pass to the `#event_stories` method.
+
+
 
 ## Responses
 

data/lib/marvelite.rb

@@ -7,11 +7,12 @@ require "marvelite/version"
 require "marvelite/api/router"
 require "marvelite/api/character_methods"
 require "marvelite/api/comic_methods"
+require "marvelite/api/event_methods"
 require "marvelite/api/client"
 require "marvelite/api/response"
 
 module Marvelite
-  def self.router
-    Marvelite::API::Router.new
+  def self.router(attrs = {})
+    Marvelite::API::Router.new(attrs)
   end
 end

data/lib/marvelite/api/character_methods.rb

@@ -2,7 +2,7 @@ module Marvelite
   module API
     module CharacterMethods
       def characters(query_params = {})
-        response = self.class.get("/#{api_version}/#{router.characters_path}", :query => params(query_params))
+        response = self.class.get(router.characters_path, :query => params(query_params))
         build_response_object(response)
       end
 
@@ -11,7 +11,7 @@ module Marvelite
         response = if by_name
           find_character_by_name(value)
         else
-          self.class.get("/#{api_version}/#{router.character_path(value)}", :query => params)
+          self.class.get(router.character_path(:id => value), :query => params)
         end
 
         build_response_object(response)
@@ -24,7 +24,7 @@ module Marvelite
           id = character.id
         end
 
-        response = self.class.get("/#{api_version}/#{router.character_comics_path(id)}", :query => params(query_params))
+        response = self.class.get(router.character_comics_path(:id => id), :query => params(query_params))
         build_response_object(response)
       end
 
@@ -34,7 +34,7 @@ module Marvelite
           return false unless character
           id = character.id
         end
-        response = self.class.get("/#{api_version}/#{router.character_events_path(id)}", :query => params(query_params))
+        response = self.class.get(router.character_events_path(:id => id), :query => params(query_params))
         build_response_object(response)
       end
 
@@ -44,7 +44,7 @@ module Marvelite
           return false unless character
           id = character.id
         end
-        response = self.class.get("/#{api_version}/#{router.character_series_path(id)}", :query => params(query_params))
+        response = self.class.get(router.character_series_path(:id => id), :query => params(query_params))
         build_response_object(response)
       end
       
@@ -54,9 +54,17 @@ module Marvelite
           return false unless character
           id = character.id
         end
-        response = self.class.get("/#{api_version}/#{router.character_stories_path(id)}", :query => params(query_params))
+        response = self.class.get(router.character_stories_path(:id => id), :query => params(query_params))
         build_response_object(response)
       end
+
+      def find_character_by_name(name)
+        response = self.characters(:name => name)
+        return false unless response[:data][:results].size > 0
+
+        response.id = response[:data][:results][0][:id]
+        response
+      end
     end
   end
 end

data/lib/marvelite/api/client.rb

@@ -5,6 +5,7 @@ module Marvelite
       
       include Marvelite::API::CharacterMethods
       include Marvelite::API::ComicMethods
+      include Marvelite::API::EventMethods
 
       include HTTParty
       base_uri 'http://gateway.marvel.com'
@@ -16,8 +17,8 @@ module Marvelite
 
       def initialize(attrs)
         super
-        @router = attrs.fetch(:router) { Marvelite.router }
         @api_version = attrs.fetch(:api_version) { 'v1' }
+        @router = attrs.fetch(:router) { Marvelite.router(:api_version => @api_version) }
       end
 
       private
@@ -36,14 +37,6 @@ module Marvelite
         end
       end
 
-      def find_character_by_name(name)
-        response = self.characters(:name => name)
-        return false unless response[:data][:results].size > 0
-
-        response.id = response[:data][:results][0][:id]
-        response
-      end
-
       def build_response_object(response)
         case response["code"]
         when 200

data/lib/marvelite/api/comic_methods.rb

@@ -2,32 +2,32 @@ module Marvelite
   module API
     module ComicMethods
       def comics(query_params = {})
-        response = self.class.get("/#{api_version}/#{router.comics_path}", :query => params(query_params))
+        response = self.class.get(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)
+        response = self.class.get(router.comic_path(:id => 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))
+        response = self.class.get(router.comic_characters_path(:id => 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))
+        response = self.class.get(router.comic_events_path(:id => 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))
+        response = self.class.get(router.comic_creators_path(:id => 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))
+        response = self.class.get(router.comic_stories_path(:id => id), :query => params(query_params))
         build_response_object(response)
       end
     end

data/lib/marvelite/api/config/v1.yml

@@ -0,0 +1,57 @@
+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: 'events'
+  path: '/public/events'
+14:
+  name: 'event'
+  path: '/public/events/:id'
+15:
+  name: 'event_characters'
+  path: '/public/events/:id/characters'
+16:
+  name: 'event_creators'
+  path: '/public/events/:id/creators'
+17:
+  name: 'event_comics'
+  path: '/public/events/:id/comics'
+18:
+  name: 'event_stories'
+  path: '/public/events/:id/stories'
+19:
+  name: 'event_series'
+  path: '/public/events/:id/series'

data/lib/marvelite/api/event_methods.rb

@@ -0,0 +1,80 @@
+module Marvelite
+  module API
+    module EventMethods
+      def events(query_params = {})
+        response = self.class.get(router.events_path, :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def event(id)
+        by_name = id.is_a?(String) ? true : false
+        response = if by_name
+          find_event_by_name(id)
+        else
+          # self.class.get(router.character_path(:id => value), :query => params)
+          self.class.get(router.event_path(:id => id), :query => params)
+        end
+        build_response_object(response)
+      end
+
+      def event_characters(id, query_params = {})
+        if id.is_a?(String)
+          event = find_event_by_name(id)
+          return false unless event
+          id = event.id
+        end
+        response = self.class.get(router.event_characters_path(:id => id), :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def event_comics(id, query_params = {})
+        if id.is_a?(String)
+          event = find_event_by_name(id)
+          return false unless event
+          id = event.id
+        end
+        response = self.class.get(router.event_comics_path(:id => id), :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def event_creators(id, query_params = {})
+        if id.is_a?(String)
+          event = find_event_by_name(id)
+          return false unless event
+          id = event.id
+        end
+        response = self.class.get(router.event_creators_path(:id => id), :query => params(query_params))
+        build_response_object(response)
+      end
+      
+      def event_series(id, query_params = {})
+        if id.is_a?(String)
+          event = find_event_by_name(id)
+          return false unless event
+          id = event.id
+        end
+        response = self.class.get(router.event_series_path(:id => id), :query => params(query_params))
+        build_response_object(response)
+      end
+
+      def event_stories(id, query_params = {})
+        if id.is_a?(String)
+          event = find_event_by_name(id)
+          return false unless event
+          id = event.id
+        end
+        response = self.class.get(router.event_stories_path(:id => id), :query => params(query_params))
+        build_response_object(response)
+      end
+
+      protected
+      def find_event_by_name(name)
+        response = self.events(:name => name)
+        return false unless response[:data][:results].size > 0
+
+        response.id = response[:data][:results][0][:id]
+        response
+      end
+    end
+  end
+end

data/lib/marvelite/api/router.rb

@@ -1,52 +1,47 @@
 module Marvelite
   module API
     class Router
-      def characters_path
-        'public/characters'
-      end
-
-      def character_path(id)
-        "public/characters/#{id}"
-      end
-
-      def character_comics_path(id)
-        "public/characters/#{id}/comics"
-      end
-
-      def character_events_path(id)
-        "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
+      require 'yaml'
+      attr_accessor :api_version
 
-      def comics_path
-        "public/comics"
+      def initialize(attrs = {})
+        @api_version = attrs.fetch(:api_version) { 'v1' }
+        @routes = []
+        load_routes_from_file("#{api_version}.yml")
+        map_routes
       end
 
-      def comic_path(id)
-        "public/comics/#{id}"
+      def inspect
+        "#<#{self.class}:#{self.object_id}>"
       end
 
-      def comic_characters_path(id)
-        "public/comics/#{id}/characters"
+      def load_routes_from_file(filename)
+        file_path =  File.join(File.dirname(__FILE__), "config", filename)
+        f = YAML.load(File.read(file_path))
+        f.each do |_, route|
+          add_route(route['name'], route['path'])
+        end
       end
 
-      def comic_creators_path(id)
-        "public/comics/#{id}/creators"
+      def routes
+        @routes
       end
 
-      def comic_events_path(id)
-        "public/comics/#{id}/events"
+      def add_route(name, endpoint)
+        route = [name, endpoint]
+        routes << route
       end
 
-      def comic_stories_path(id)
-        "public/comics/#{id}/stories"
+      def map_routes
+        routes.each do |name, endpoint|
+          self.class.send(:define_method, "#{name}_path") do |params = {}|
+            params
+            params.each do |p_key, p_value|
+              endpoint.gsub!(":#{p_key.to_s}", p_value.to_s)
+            end
+            "/#{api_version}#{endpoint}"
+          end
+        end
       end
     end
   end