marvelite 0.0.5 → 0.0.6.a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 984423d6566dfc1729975c08cda31745a35afe55
-  data.tar.gz: 4ad394d4c98726d62f5e465e5e7bd7898390febb
+  metadata.gz: 9f5021f591254b35d1aa7a672d428f10d7d6a027
+  data.tar.gz: ac7b2af321f54b2f7865af4d019c55784413f707
 SHA512:
-  metadata.gz: 32bb4d940672d707a0ddb92ba322fafc3b6fa93796b8f7ee3bbe5f58657e3bf7572d6d425cd77a24913f939c82a9ea123f2e9778981132d4ca12b0bf22168a1d
-  data.tar.gz: 90af92a8e7c9fd53aead7ec8c3eb8c34db2d1e2755afbce35ed5bfbb636da59e54c790deba64f259e5381d32f113b960d1c363e6c45792f783049e8c28eec5f4
+  metadata.gz: bd7170f1d3f353a2fb890e38d31d2d286728272df87cd1904aeb8d95eea39c1249423dc32967f63cf5ca076bc0a040110194a2301e51c07b269050b155304554
+  data.tar.gz: 7fabd1e5145ef5ebabfa04068fcc15be5bf18306a63e2d36154bbbc6e7e55a3a25ef6b493ca0ef132e76d7784de9590d03712fa63eb04f9b605c5a734e1b6cc3

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## Changelog
 
+### 0.0.6
+* Rewrites `Marvelite::API::Client` to allow for self discovery of available methods, depending on the `Marvelite::API::Router` injected at initialization.
+* Adds the following endpoints:
+  * retrieve series by connecting to the API's `/series` endpoint
+  * retieve a serie by connecting to the API's `/series/:id` enpoint
+  * retrieve serie characters by connecting to the API's `/series/:id/characters` endpoint.
+  * retrieve serie comics by connecting to the API's `/series/:id/comics` endpoint.
+  * retrieve serie creators by connecting to the API's `/series/:id/creators` endpoint.
+  * retrieve serie events by connecting to the API's `/series/:id/events` endpoint.
+  * retrieve serie stories by connecting to the API's `/series/:id/stories` endpoint.
+
+
 ### 0.0.5
 * Rewrites `Marvelite::API::Router` class to make flexible to future API versioning changes from Marvel.
 * Adds the following endpoints:

data/README.md

@@ -22,7 +22,6 @@ Or install it yourself as:
 ## Contents
 
 * [Usage](#usage)
-  * [Methods](#methods)
 * [Responses](#responses)
 
 
@@ -37,264 +36,56 @@ client = Marvelite::API::Client.new(
   :public_key => 'abcd1234',
   :private_key => '5678efgh'
 )
-```
 
-### Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [#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. |
-| [#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. |
-| [#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
-Fetches a list of comic characters. Can receive optional params.
-```ruby
+# fetch a list of characters
 client.characters
 client.characters(:name => 'Spider-Man')
 client.characters(:limit => 10, :offset => 400, :orderBy => 'name')
-```
-
-
-See the [Marvel Comics Interactive API Tester](http://developer.marvel.com/docs#!/public/getCreatorCollection_get_0) for a complete list of params that you can pass to the `#characters` method.
-
-#### character
-
-Fetches a single character resource. Accepts an integer or string value as character id.
 
-```ruby
+# fetch a single character
 client.character(1009610)
 client.character('Spider-Man')
-```
-
-#### character_comics
-
-Fetches a list of comics containing a specific character. Requires a character id value (integer or string). Accepts optional params.
-
-```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 => 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 or string). Accepts optional params.
-
-```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' }
-)
-```
-
-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 or string). Accepts optional params.
-
-```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' }
-)
-```
-
-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 or string). Accepts optional params.
-
-```ruby
-client.character_stories(1009610)
-client.character_stories('Spider-Man')
-client.character_stories(1009610, { :limit => 10, :offset => 20 })
-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
+# fetch a list of comics
 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
+# fetch a single comic
 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
+# fetch a list of comic characters
 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.
-
-#### events
-
-Fetches a list of events. Accepts optional params.
-
-```ruby
+# fetch a list of events
 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
+# fetch a single event
 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.
+client.event('Acts of Vengeance!')
 
-#### event_comics
-
-Fetches a list of comics which take place during a specific event. Requires an event id value (integer). Accepts optional params.
-
-```ruby
+# fetch a list of comics in an event
 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)
 
-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.
+# fetch a list of series
+client.series
+client.series(:title => 'Spider-Man')
+client.series(:orderBy => 'title')
 
-#### event_series
+# fetch a single serie
+client.serie(2069)
 
-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)
+# fetch a list of comics in a serie
+client.series_comics(2069)
+client.series_comics(2069, :format => 'graphic novel', :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.
-
+See the list of [available methods](https://github.com/antillas21/marvelite/wiki/Documentation) in the wiki.
 
 
 ## Responses

data/Rakefile

@@ -3,4 +3,11 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new("spec")
 
-task :default => :spec
+task :default => :spec
+
+task :console do
+  require 'pry'
+  require 'marvelite'
+  ARGV.clear
+  Pry.start
+end

data/lib/marvelite.rb

@@ -1,13 +1,10 @@
 require 'active_model'
-require 'digest'
+require 'digest/md5'
 require 'httparty'
 require 'hashie'
 
 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"
 

data/lib/marvelite/api/client.rb

@@ -2,11 +2,6 @@ module Marvelite
   module API
     class Client
       include ActiveModel::Model
-      
-      include Marvelite::API::CharacterMethods
-      include Marvelite::API::ComicMethods
-      include Marvelite::API::EventMethods
-
       include HTTParty
       base_uri 'http://gateway.marvel.com'
 
@@ -19,6 +14,7 @@ module Marvelite
         super
         @api_version = attrs.fetch(:api_version) { 'v1' }
         @router = attrs.fetch(:router) { Marvelite.router(:api_version => @api_version) }
+        build_methods
       end
 
       private
@@ -45,6 +41,57 @@ module Marvelite
           ErrorResponse.new(response)
         end
       end
+
+      def find_by_name_or_title(endpoint, column, value)
+        response = self.send(endpoint, { column.to_sym => value })
+        return false unless response[:data][:count] > 0
+        response.id = response[:data][:results][0][:id]
+        response
+      end
+
+      def process_arguments(*args)
+        temp_id, temp_options = *args
+        if temp_id && temp_id.is_a?(Hash)
+          id = nil
+          options = temp_id || {}
+        elsif temp_id
+          id = temp_id
+          options = temp_options || {}
+        else
+          options = {}
+        end
+        { id: id, options: options}
+      end
+
+      def fetch_response(route, params_hash = {})
+        id = params_hash[:id]
+        options = params_hash[:options]
+
+        if id.nil?
+          self.class.get(router.send("#{route}_path".to_sym), :query => params(options))
+        else
+          id = fetch_resource_id(route, id) if id.is_a?(String)
+          self.class.get(router.send("#{route}_path".to_sym, {:id => id}), :query => params(options))
+        end
+      end
+
+      def fetch_resource_id(route, id)
+        endpoint = route.split("_")[0]+"s"
+        resource = find_by_name_or_title(endpoint.to_sym, :name, id)
+        return false unless resource
+        resource.id
+      end
+
+      def build_methods
+        @router.routes.each do |name, _|
+          self.class.send(:define_method, name) do |*args|
+            params = process_arguments(*args)
+            response = fetch_response(name, params)
+            build_response_object(response)
+          end
+        end
+      end
+
     end
   end
 end

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

@@ -54,4 +54,25 @@
   path: '/public/events/:id/stories'
 19:
   name: 'event_series'
-  path: '/public/events/:id/series'
+  path: '/public/events/:id/series'
+20:
+  name: 'series'
+  path: '/public/series'
+21:
+  name: 'serie'
+  path: '/public/series/:id'
+22:
+  name: 'series_characters'
+  path: '/public/series/:id/characters' 
+23:
+  name: 'series_comics'
+  path: '/public/series/:id/comics'
+24:
+  name: 'series_creators'
+  path: '/public/series/:id/creators'
+25:
+  name: 'series_events'
+  path: '/public/series/:id/events'
+26:
+  name: 'series_stories'
+  path: '/public/series/:id/stories'