marver 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbf8f57412fffbdad133f75f085aee5884fac3ac
-  data.tar.gz: 159ecf070992f3aa39fe0c5816d004c10469ab93
+  metadata.gz: 6749397ee2f275b76c39a716ebd42e4352b258cd
+  data.tar.gz: f5d09a4721ceb7ad5a748a7d2995babe02449068
 SHA512:
-  metadata.gz: 765d37edbb611c578372a73c360aa267489422827eea9693fcfaae436ee22124a7e2a4dde661e62f5e84cb76c484315bfd54f6e5c03984e29a04aeec53bc4948
-  data.tar.gz: 6c59c053d464407e0dfaa6a8895370534fe627195dadd0eb9914791277504415131f0cb27bd133dd364b95a73e74afb6acbfc11766a15003f899c5d76cf882cf
+  metadata.gz: e14a63ed2ad301af75265219df20773f8dca10b53e0b75f9f8fd9bbd1ead3f00c025a798eef6d3f68a94c02475feca7115b530bb85c52851a95326b4fcad3e23
+  data.tar.gz: ed49c11bc4f0241e859e294e9f70c348e0b2ec4e0a5eb0afecb80b22b6b6a6f3c151330d85aac545273c391178233f87bd0634b2f243d503ce87a2c46a5af941

data/README.md

@@ -29,11 +29,11 @@ Marver.configure do |config|
 end
 
 client = Marver::Client.new
-client.characters.find({ name: 'Hulk' })
-client.series.find({ title: 'The Avengers' })
-client.events.find({ title: 'Fall of the mutants' })
-client.stories.find({ title: 'Name of a story' }) 
-client.comics.find({ title: 'Spiderman' }) 
+client.characters.find_by_name 'Hulk'
+client.series.find_by_title 'The Avengers'
+client.events.find_by_title 'Fall of the mutants'
+client.stories.find_by_title 'Name of a story'
+client.comics.find_by_title 'Spiderman'
 ```
 
 Also, you can inspect summary (trimmed) objects of the associated entities to one entity.
@@ -45,7 +45,7 @@ Marver.configure do |config|
 end
 
 client = Marver::Client.new
-hulk = client.characters.find({ name: 'Hulk' })
+hulk = client.characters.find_by_name 'Hulk'
 hulk.comics  # Returns an array of comics summaries
 hulk.stories # Returns an array of stories where Hulk appears
 ```
@@ -58,14 +58,8 @@ comic.full # This will issue an API call and grab the full object with all data
 ```
 
 ### TO DO:
-
-##### Entity Finder classes
-Should be implemented within the Marver::Client class.
-
-CreatorFinder
+Inspect dependency graph?
 
 #### Author
 Ile Eftimov <br/>
-[twitter](http://twitter.com/fteem)  [website](http://eftimov.net)
-
-Any kind of contribution is welcomed & encouraged :)
+[twitter](http://twitter.com/fteem)  [website](http://eftimov.net)

data/lib/marver.rb

@@ -3,6 +3,7 @@ require 'time'
 require 'marver/version'
 
 module Marver
+  FINDER_FILTERS = [ :orderBy, :limit, :offset ]
 
   # Base Classes
   autoload :Client,                 'marver/client'
@@ -15,12 +16,26 @@ module Marver
   autoload :ComicFinder,            'marver/finders/comic_finder'
   autoload :EventFinder,            'marver/finders/event_finder'
   autoload :StoryFinder,            'marver/finders/story_finder'
+  autoload :CreatorFinder,          'marver/finders/creator_finder'
+
+  #Factories
+  autoload :Factory, 'marver/factories/factory'
 
   # API
   autoload :API,                   'marver/api'
 
   # Helpers & builders
-  autoload :StringHelper,           'marver/helpers/string_helper'
+  autoload :StringHelper,           'marver/utils/string_helper'
+  autoload :FinderParamFilter,      'marver/utils/finder_param_filter'
+
+  # Mappers
+  autoload :Mappable,                   'marver/mappers/mappable'
+  autoload :ComicAttributesMapper,      'marver/mappers/comic_attributes_mapper'
+  autoload :CharacterAttributesMapper,  'marver/mappers/character_attributes_mapper'
+  autoload :CreatorAttributesMapper,    'marver/mappers/creator_attributes_mapper'
+  autoload :EventAttributesMapper,      'marver/mappers/event_attributes_mapper'
+  autoload :SerieAttributesMapper,      'marver/mappers/serie_attributes_mapper'
+  autoload :StoryAttributesMapper,      'marver/mappers/story_attributes_mapper'
 
   # Common Entities
   autoload :TextObject,   'marver/entities/text_object'
@@ -42,7 +57,6 @@ module Marver
 
   autoload :Summarizable, 'marver/entities/summarizable'
   autoload :Commonable,   'marver/entities/commonable'
-  autoload :Queryable,   'marver/entities/queryable'
 
 
   class << self

data/lib/marver/api.rb

@@ -3,6 +3,14 @@ module Marver
     autoload :Client,      'marver/api/client'
     autoload :Response,    'marver/api/response'
     autoload :Credentials, 'marver/api/credentials'
-    autoload :Error,       'marver/api/error'
+    autoload :ErrorHandler, 'marver/api/errors'
+  end
+
+  module Error
+    autoload :Conflict, 'marver/api/errors'
+    autoload :NotFound, 'marver/api/errors'
+    autoload :CredentialsFault, 'marver/api/errors'
+    autoload :MethodNotAllowed, 'marver/api/errors'
+    autoload :Forbidden, 'marver/api/errors'
   end
 end

data/lib/marver/api/client.rb

@@ -4,19 +4,22 @@ require 'digest/md5'
 module Marver
   module API
     class Client
-      include Marver::Queryable
-
       API_VERSION = "v1"
       API_ENDPOINT = "http://gateway.marvel.com"
 
       def get(entity, options)
-        query_string = options.empty? ? "" : hash_to_querystring(options)
-        url = endpoint + "#{entity.to_s}?" + query_string + credentials
-        Marver::API::Response.new(RestClient.get(url))
+        url = "#{endpoint}/#{entity.to_s}"
+        json = RestClient.get url, { params: options.merge(credentials) }
+        Marver::API::Response.new(json)
+      end
+
+      def get_uri(uri)
+        response = RestClient.get uri, { params: credentials }
+        Marver::API::Response.new(response)
       end
 
       def endpoint
-        "#{API_ENDPOINT}/#{API_VERSION}/public/"
+        "#{API_ENDPOINT}/#{API_VERSION}/public"
       end
 
       def credentials

data/lib/marver/api/credentials.rb

@@ -12,7 +12,7 @@ module Marver
           timestamp = Time.now.to_i.to_s
           hash = Digest::MD5.hexdigest(timestamp + private_key + public_key)
 
-          "&ts=#{timestamp}&apikey=#{public_key}&hash=#{hash}"
+          { ts: timestamp, apikey: public_key, hash: hash }
         end
       end
 

data/lib/marver/api/errors.rb

@@ -0,0 +1,33 @@
+module Marver
+  module API
+    class ErrorHandler
+      def initialize(ex)
+        @message = ex.response['status']
+      end
+
+      def handle!
+        case @code
+        when 401
+          raise Marver::Error::CredentialsFault.new(@message)
+        when 403
+          raise Marver::Error::MethodNotAllowed.new(@message)
+        when 404
+          raise Marver::Error::NotFound.new(@message)
+        when 405
+          raise Marver::Error::Forbidden.new(@message)
+        when 409
+          raise Marver::Error::Conflict.new(@message)
+        end
+      end
+    end
+
+  end
+
+  module Error
+    class Conflict < Exception; end
+    class NotFound < Exception; end
+    class CredentialsFault < Exception; end
+    class MethodNotAllowed < Exception; end
+    class Forbidden < Exception; end
+  end
+end

data/lib/marver/client.rb

@@ -2,13 +2,15 @@ require './lib/marver.rb'
 
 module Marver
   class Client
-    attr_reader :characters, :series, :comics, :stories
+    attr_reader :characters, :series, :comics, :stories, :creators, :events
 
     def initialize
       @characters = Marver::CharacterFinder.new
       @series = Marver::SerieFinder.new
       @comics = Marver::ComicFinder.new
       @stories = Marver::StoryFinder.new
+      @creators = Marver::CreatorFinder.new
+      @events = Marver::EventFinder.new
     end
 
   end

data/lib/marver/entities/character.rb

@@ -2,32 +2,20 @@ require './lib/marver.rb'
 
 module Marver
   class Character
-    include Marver::Summarizable
-    include Marver::Commonable
+    attr_reader :id, :resource_uri, :description, :thumbnail, :urls, :name, 
+                :series, :stories, :events, :comics, :full_path
 
-    attr_reader :json, :id, :resource_uri, :description, :name
+    def initialize(args)
+      @series   = args[:series]
+      @stories  = args[:stories]
+      @events   = args[:events]
+      @comics   = args[:comics]
+      @urls     = args[:urls]
+      @thumbnail = args[:thumbnail]
 
-    class << self
-      def build(results)
-        if results.kind_of?(Array)
-          results.collect do |character|
-            Marver::Character.new(character)
-          end
-        else
-          new(results)
-        end
+      args[:attributes].each do |name, value|
+        instance_variable_set("@#{name}", value)
       end
     end
-
-    def initialize(json)
-      @json = json
-
-      @description = json['description']
-
-      @id = json['id'].to_i
-      @name = json['name']
-      @resource_uri = json['resourceURI']
-    end
-
   end
 end

data/lib/marver/entities/comic.rb

@@ -2,43 +2,27 @@ require './lib/marver.rb'
 
 module Marver
   class Comic
-    include Marver::Summarizable
-    include Marver::Commonable
+    attr_reader :id, :title, :stories, :series, :events, :characters, :variant_description,
+      :images, :ean, :format, :resource_uri, :stories, :text_objects, :digital_id,
+      :isbn, :diamond_code, :thumbnail, :upc, :issue_number, :prices, :issn, :dates,
+      :urls, :page_count, :description, :creators
 
-    attr_reader :json, :id, :digital_id, :title, :issue_number,
-                :variant_description, :description, :isbn,
-                :upc, :diamond_code, :ean, :issn, :format,
-                :page_count, :resource_uri
+    def initialize(args)
+      @series     = args[:series]
+      @stories    = args[:stories]
+      @creators   = args[:creators]
+      @events     = args[:events]
+      @characters = args[:characters]
+      @urls       = args[:urls]
+      @prices     = args[:prices]
+      @images     = args[:images]
+      @thumbnail  = args[:thumbnail]
+      @text_objects = args[:text_objects]
+      @dates = args[:dates]
 
-    class << self
-      def build(results)
-        if results.kind_of?(Array)
-          results.collect do |comic|
-            Marver::Comic.new(comic)
-          end
-        else
-          new(results)
-        end
+      args[:attributes].each do |name, value|
+        instance_variable_set("@#{name}", value)
       end
     end
-
-    def initialize(json)
-      @json = json
-      @title = json['title']
-      @resource_uri = json['resourceURI']
-      @id = json['id'].to_i
-      @digital_id = json['digitalId']
-      @issue_number = json['issueNumber']
-      @variant_description = json['variantDescription']
-      @description = json['description']
-      @isbn = json['isbn']
-      @upc = json['upc']
-      @diamond_code = json['diamondCode']
-      @ean = json['ean']
-      @issn = json['issn']
-      @format = json['format']
-      @page_count = json['pageCount']
-    end
-
   end
-end
+end

data/lib/marver/entities/creator.rb

@@ -1,33 +1,12 @@
 module Marver
   class Creator
-    include Marver::Summarizable
-    include Marver::Commonable
+    attr_reader :id, :first_name, :middle_name, :last_name, :full_name, :urls,
+                :suffix, :resource_uri, :series, :stories, :comics, :events, :thumbnail
 
-    attr_reader :id, :first_name, :middle_name, :last_name, :full_name,
-                :suffix, :resource_uri, :json
-
-    class << self
-      def build(results)
-        if results.kind_of?(Array)
-          results.collect do |creator|
-            Marver::Creator.new(creator)
-          end
-        else
-          new(results)
-        end
+    def initialize(attributes)
+      attributes.each do |name, value|
+        instance_variable_set("@#{name}", value)
       end
     end
-
-    def initialize(json)
-      @json = json
-      @id = @json['id']
-      @first_name = @json['firstName']
-      @middle_name = @json['middleName']
-      @last_name = @json['lastName']
-      @full_name = @json['fullName']
-      @suffix = @json['suffix']
-      @resource_uri = @json['resourceURI']
-    end
-
   end
 end

data/lib/marver/entities/event.rb

@@ -1,34 +1,25 @@
 module Marver
   class Event
-    include Marver::Summarizable
-    include Marver::Commonable
+    attr_reader :title, :resource_uri, :description, :start, :end, :next, :previous,
+      :series, :stories, :events, :comics, :characters, :creators, :urls, :thumbnail
 
-    attr_reader :json, :title, :resource_uri,
-                :description, :start, :end, :next, :previous
+    def initialize(args)
+      @next = args[:next]
+      @previous = args[:previous]
+      @creators = args[:creators]
+      @characters = args[:characters]
+      @series = args[:series]
+      @stories = args[:stories]
+      @events = args[:events]
+      @comics = args[:comics]
+      @urls   = args[:urls]
+      @thumbnail = args[:thumbnail]
+      @start = args[:start]
+      @end = args[:_end]
 
-    class << self
-      def build(results)
-        if results.kind_of?(Array)
-          results.collect do |event|
-            Marver::Event.new(event)
-          end
-        else
-          new(results)
-        end
+      args[:attributes].each do |name, value|
+        instance_variable_set("@#{name}", value)
       end
     end
-
-    def initialize(json)
-      @json = json
-
-      @title = @json['title']
-      @resource_uri = @json['resourceURI']
-
-      @description = @json['description']
-      @start = DateTime.parse(@json['start'])
-      @end = DateTime.parse(@json['end'])
-      @next = Marver::Summary::Event.new(@json['next'])
-      @previous = Marver::Summary::Event.new(@json['previous'])
-    end
   end
 end

data/lib/marver/entities/serie.rb

@@ -1,37 +1,23 @@
 module Marver
   class Serie
-    include Marver::Summarizable
-    include Marver::Commonable
+    attr_reader :id, :title, :resource_uri, :description, :start_year, :end_year, :comics,
+                :rating, :previous, :stories, :events, :creators, :characters, :next,
+                :urls, :thumbnail
 
-    attr_reader :json, :id, :title, :resource_uri, :description,
-                :start_year, :end_year, :rating, :next, :previous
+    def initialize(args)
+      @stories = args[:stories]
+      @events = args[:events]
+      @creators = args[:creators]
+      @characters = args[:characters]
+      @next = args[:next_serie]
+      @previous = args[:prev_serie]
+      @comics = args[:comics]
+      @urls = args[:urls]
+      @thumbnail = args[:thumbnail]
 
-    class << self
-      def build(results)
-        if results.kind_of?(Array)
-          results.collect do |serie|
-            Marver::Serie.new(serie)
-          end
-        else
-          new(results)
-        end
+      args[:attributes].each do |name, value|
+        instance_variable_set("@#{name}", value)
       end
     end
-
-    def initialize(json)
-      @json = json
-
-      @id = @json['id']
-      @title = @json['title']
-      @resource_uri = @json['resourceURI']
-      @description = @json['description']
-      @start_year = @json['startYear']
-      @end_year = @json['endYear']
-      @rating = @json['rating']
-
-      @next = Marver::Summary::Serie.new(@json['next'])
-      @previous = Marver::Summary::Serie.new(@json['previous'])
-    end
-
   end
 end