marver 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a429ebb07df62f8290bad6d714177c7dccfc63fd
-  data.tar.gz: 800a8e3a54a341ac5a2e145395aea0c27de03c16
+  metadata.gz: fd4c0d07e5c64d82c439ce0e0dfa39fde695ec10
+  data.tar.gz: eeccacdfd8ae9c5494d4f9cb5e8d5ff967faa338
 SHA512:
-  metadata.gz: 718e41cc32a28c9077895c4966120fb0b8dfb9991f70aead3ad73a2ac2de093595ad26378d2b420c914d63ac795d08c7c7faf7dcffc7d6cb05e1da800bccb5c3
-  data.tar.gz: 6ef523f611f82bd7ea8c2b88347d0106537bc7e34ce93db782339091648ecc7caba9760c94b21c3ccee2c4376a70d628d27a2f8959921abbe039bb8aad232eb2
+  metadata.gz: 8ba5b9c60dfc3c054e6e6f1df6456bbd0910341737948e2d3ee158e48e9d65a67274b64588187f00ac407a9946cafd9b2c7c1fab0a460e3b35f1986a100f9fe0
+  data.tar.gz: ef5b9b289ebb6bd66fd1f4372ad8a1f376d4197eaf3c807b4854a9d475e05e120f5697337d577267094cf2290f9597797225e95758145e26270d2be28393e05f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -1,13 +1,4 @@
 source "https://rubygems.org/"
 
-gem 'rest-client'
-
-group :development do
-  gem 'pry'
-end
-
-group :test do
-  gem 'rspec'
-  gem 'webmock'
-end
-
+# Specify your gem's dependencies in forecastr.gemspec
+gemspec

data/README.md

@@ -1,17 +1,58 @@
 Marver
 ======
 
-Marver is (going to be an) easy to use Ruby gem for [Marvel's API](http://developer.marvel.com/). It is still in development and any contribution is welcomed.
+Marver is (going to be an) easy to use Ruby gem for [Marvel's API](http://developer.marvel.com/).
+It is **still VERY MUCH in development** and it doesn't really do much right now. Also, any kind of contribution is **welcomed**.
 
+## Installation
 
-### TO DO:
+Add this line to your application's Gemfile:
+
+    gem 'marver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marver
+
+## Usage
+
+```ruby
+Marver.configure do |config|
+  config.public_key = 'your_public_key'
+  config.private_key = 'your_private_key'
+end
+
+client = Marver::Client.new
+client.characters.find({ name: 'Hulk' }) # Returns Hulk
+client.serie.find({ name: 'The Avengers' }) # Returns The Avengers
+```
 
-##### Write core classes
-* Serie
-* Event
-* Creator
-* More?  
+Also, you can inspect summary (trimmed) objects of the associated entities to one entity.
 
+```ruby
+Marver.configure do |config|
+  config.public_key = 'your_public_key'
+  config.private_key = 'your_private_key'
+end
+
+client = Marver::Client.new
+hulk = client.characters.find({ name: 'Hulk' })
+hulk.comics  # Returns an array of comics summaries
+hulk.stories # Returns an array of stories where Hulk appears
+```
+
+A summary object can also morph into a "full view" object.
+
+```ruby
+comic = hulk.comics.first  # Take first comic where Hulk appears
+comic.full # This will issue an API call and grab the full object with all data for that comic
+```
+
+### TO DO:
 
 ##### Entity Finder classes
 Should be implemented within the Marver::Client class.
@@ -23,10 +64,6 @@ Should be implemented within the Marver::Client class.
 * EventFinder
 * More?
 
-
-Refactor generation of resource lists for core classes, maybe add a builder module?
-
-
-
 #### Author
-Ile Eftimov - [@fteem](http://twitter.com/fteem)
+Ile Eftimov <br/>
+[twitter](http://twitter.com/fteem)  [website](http://eftimov.net)

data/TODO

@@ -0,0 +1,3 @@
+1. Fix grouping of classes by directory. Should be in context of namespacing.
+3. Build objects when data is parsed.
+4. Improve Marver::REST::Client by returning parsed JSON.

data/lib/marver.rb

@@ -1,42 +1,52 @@
 require 'rest_client'
+require 'marver/version'
+
+module Marver
+
+  # Base Classes
+  autoload :Client,                 'marver/client'
+  autoload :Configuration,          'marver/configuration'
+  autoload :DataContainer,          'marver/data_container'
+
+  # Finders
+  autoload :CharacterFinder,        'marver/finders/character_finder'
+
+  # API
+  autoload :API,                   'marver/api'
+
+  # Helpers & builders
+  autoload :StringHelper,           'marver/helpers/string_helper'
+
+  # Common Entities
+  autoload :TextObject,   'marver/entities/text_object'
+  autoload :Image,        'marver/entities/image'
+  autoload :Url,          'marver/entities/url'
+  autoload :KeyDate,      'marver/entities/key_date'
+  autoload :Price,        'marver/entities/price'
+
+  # Core Entities
+  autoload :Event,     'marver/entities/event'
+  autoload :Serie,     'marver/entities/serie'
+  autoload :Story,     'marver/entities/story'
+  autoload :Character, 'marver/entities/character'
+  autoload :Creator,   'marver/entities/creator'
+  autoload :Comic,     'marver/entities/comic'
+
+  # Summary Entities
+  autoload :Summary,    'marver/entities/summary'
+
+  autoload :Summarizable, 'marver/entities/summarizable'
+  autoload :Commonable,   'marver/entities/commonable'
+  autoload :Queryable,   'marver/entities/queryable'
+
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end
 
-# Base Classes
-require './lib/marver/client.rb'
-require './lib/marver/version.rb'
-require './lib/marver/credentials.rb'
-require './lib/marver/data_container.rb'
-
-# Finders
-require './lib/marver/finders/character_finder.rb'
-
-# REST
-require './lib/marver/rest/client.rb'
-require './lib/marver/rest/response.rb'
-
-# Helpers & builders
-require './lib/marver/helpers/string_helper.rb'
-require './lib/marver/builders/core_entities_builder.rb'
-require './lib/marver/builders/common_entities_builder.rb'
-
-# Common Entities
-require './lib/marver/entities/common/text_object.rb'
-require './lib/marver/entities/common/image.rb'
-require './lib/marver/entities/common/url.rb'
-require './lib/marver/entities/common/key_date.rb'
-require './lib/marver/entities/common/price.rb'
-
-# Core Entities
-require './lib/marver/entities/core/event.rb'
-require './lib/marver/entities/core/serie.rb'
-require './lib/marver/entities/core/story.rb'
-require './lib/marver/entities/core/character.rb'
-require './lib/marver/entities/core/creator.rb'
-require './lib/marver/entities/core/comic.rb'
-
-# Summary Entities
-require './lib/marver/entities/summaries/character_summary.rb'
-require './lib/marver/entities/summaries/comic_summary.rb'
-require './lib/marver/entities/summaries/story_summary.rb'
-require './lib/marver/entities/summaries/event_summary.rb'
-require './lib/marver/entities/summaries/serie_summary.rb'
-require './lib/marver/entities/summaries/creator_summary.rb'

data/lib/marver/api.rb

@@ -0,0 +1,8 @@
+module Marver
+  module API
+    autoload :Client,      'marver/api/client'
+    autoload :Response,    'marver/api/response'
+    autoload :Credentials, 'marver/api/credentials'
+    autoload :Error,       'marver/api/error'
+  end
+end

data/lib/marver/api/client.rb

@@ -0,0 +1,28 @@
+require './lib/marver.rb'
+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))
+      end
+
+      def endpoint
+        "#{API_ENDPOINT}/#{API_VERSION}/public/"
+      end
+
+      def credentials
+        Credentials.get
+      end
+
+    end
+  end
+end

data/lib/marver/api/credentials.rb

@@ -0,0 +1,21 @@
+require 'digest/md5'
+require 'marver/configuration'
+
+module Marver
+  module API
+    class Credentials
+
+      class << self
+        def get
+          public_key  = Marver.configuration.public_key
+          private_key = Marver.configuration.private_key
+          timestamp = Time.now.to_i.to_s
+          hash = Digest::MD5.hexdigest(timestamp + private_key + public_key)
+
+          "&ts=#{timestamp}&apikey=#{public_key}&hash=#{hash}"
+        end
+      end
+
+    end
+  end
+end

data/lib/marver/{rest → api}/error.rb

@@ -1,5 +1,5 @@
 module Marver
-  module REST
+  module API
     class Error
       attr_reader :code, :status
 

data/lib/marver/{rest → api}/response.rb

@@ -1,8 +1,7 @@
 require 'json'
-require './lib/marver.rb'
 
 module Marver
-  module REST
+  module API
     class Response
       attr_reader :code, :status, :data, :results
 

data/lib/marver/client.rb

@@ -4,9 +4,8 @@ module Marver
   class Client
     attr_reader :characters
 
-    def initialize(private_key, public_key)
-      @credentials = Marver::Credentials.new(private_key, public_key)
-      @characters = Marver::CharacterFinder.new(@credentials)
+    def initialize
+      @characters = Marver::CharacterFinder.new
     end
 
   end

data/lib/marver/configuration.rb

@@ -0,0 +1,10 @@
+module Marver
+  class Configuration
+    attr_accessor :public_key, :private_key
+
+    def initialize
+      @public_key  = 'your_public_key_here'
+      @private_key  = 'your_private_key_here'
+    end
+  end
+end

data/lib/marver/entities/character.rb

@@ -0,0 +1,33 @@
+require './lib/marver.rb'
+
+module Marver
+  class Character
+    include Marver::Summarizable
+    include Marver::Commonable
+
+    attr_reader :json, :id, :resource_uri, :description, :name
+
+    class << self
+      def build(results)
+        if results.kind_of?(Array)
+          results.collect do |character|
+            Marver::Character.new(character)
+          end
+        else
+          new(results)
+        end
+      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/{core/comic.rb → comic.rb}

@@ -2,29 +2,30 @@ require './lib/marver.rb'
 
 module Marver
   class Comic
-    attr_reader :json, :credentials, :id, :digital_id, :title, :issue_number,
+    include Marver::Summarizable
+    include Marver::Commonable
+
+    attr_reader :json, :id, :digital_id, :title, :issue_number,
                 :variant_description, :description, :isbn,
                 :upc, :diamond_code, :ean, :issn, :format,
-                :page_count, :resource_uri, :thumbnail, :text_objects
-
+                :page_count, :resource_uri
 
     class << self
-      def build(response, credentials)
+      def build(response)
         if response.kind_of?(Array)
           response.collect do |comic|
-            new(comic, credentials)
+            new(comic)
           end
         else
-          new(response.results, credentials)
+          new(response.results)
         end
       end
     end
 
-    def initialize(json, credentials)
+    def initialize(json)
       @json = json
-      @credentials = credentials
       @title = json['title']
-      @resource_uri = "#{json['resourceURI']}?#{@credentials.to_s}"
+      @resource_uri = json['resourceURI']
       @id = json['id'].to_i
       @digital_id = json['digitalId']
       @issue_number = json['issueNumber']
@@ -37,9 +38,6 @@ module Marver
       @issn = json['issn']
       @format = json['format']
       @page_count = json['pageCount']
-
-      CoreEntitiesBuilder.build!(self)
-      CommonEntitiesBuilder.build!(self)
     end
 
   end

data/lib/marver/entities/commonable.rb

@@ -0,0 +1,37 @@
+module Marver
+  module Commonable
+    def prices
+      @prices ||= entity_items('prices').collect do |price|
+        Marver::Price.new(price)
+      end
+    end
+
+    def images
+      @images ||= entity_items('images').collect do |image|
+        Marver::Image.new(image)
+      end
+    end
+
+    def urls
+      @urls ||= entity_items('urls').collect do |url|
+        Marver::Url.new(url)
+      end
+    end
+
+    def text_objects
+      @text_objects ||= entity_items('textObjects').collect do |text_object|
+        Marver::TextObject.new(text_object)
+      end
+    end
+
+    def thumbnail
+      @thumbnail ||= Marver::Image.new(json['thumbnail'])
+    end
+
+    def dates
+      @dates ||= entity_items('dates').collect do |date|
+        Marver::KeyDate.new(date)
+      end
+    end
+  end
+end

data/lib/marver/entities/{core/creator.rb → creator.rb}

@@ -1,35 +1,32 @@
 module Marver
   class Creator
+    include Marver::Summarizable
+    include Marver::Commonable
+
     attr_reader :id, :first_name, :middle_name, :last_name, :full_name,
-                :suffix, :resource_uri, :json, :credentials
+                :suffix, :resource_uri, :json
 
     class << self
-      def build(response, credentials)
-        if response.kind_of?(Array)
-          response.collect do |creator|
-            Marver::Creator.new(creator, credentials)
+      def build(results)
+        if results.kind_of?(Array)
+          results.collect do |creator|
+            Marver::Creator.new(creator)
           end
         else
-          new(response.results, credentials)
+          new(results)
         end
       end
     end
 
-    def initialize(json, credentials)
+    def initialize(json)
       @json = json
-      @credentials = credentials
-
       @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']
-
-      CommonEntitiesBuilder.build!(self)
-      CoreEntitiesBuilder.build!(self)
     end
 
   end