marver 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854ada56d6c71ad17f83f060c7c1bf4a7df48eeb
-  data.tar.gz: 4340aafc9b580846eced5f31b9ad5506835e54dd
+  metadata.gz: a429ebb07df62f8290bad6d714177c7dccfc63fd
+  data.tar.gz: 800a8e3a54a341ac5a2e145395aea0c27de03c16
 SHA512:
-  metadata.gz: 23643c6259ca3c4d7c40f95b7e075ef2d5dd64889fa117e0f17ebf7b23c25583e2d6c4707f6e3e21fef7c31ddc4912f6943ce0c4877e246d6f286c0230545377
-  data.tar.gz: b944dab8e08464804ecd388b7bd15f5834f7bfccefb13c705a2e832bac7dae114b383af937a2bfcad1f56510026dd3be6f612d2bb62349effb356563266736e6
+  metadata.gz: 718e41cc32a28c9077895c4966120fb0b8dfb9991f70aead3ad73a2ac2de093595ad26378d2b420c914d63ac795d08c7c7faf7dcffc7d6cb05e1da800bccb5c3
+  data.tar.gz: 6ef523f611f82bd7ea8c2b88347d0106537bc7e34ce93db782339091648ecc7caba9760c94b21c3ccee2c4376a70d628d27a2f8959921abbe039bb8aad232eb2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org/"
+
+gem 'rest-client'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ile Eftimov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+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.
+
+
+### TO DO:
+
+##### Write core classes
+* Serie
+* Event
+* Creator
+* More?  
+
+
+##### Entity Finder classes
+Should be implemented within the Marver::Client class.
+
+* CharacterFinder (in progress)
+* SerieFinder
+* StoryFinder
+* ComicFinder
+* EventFinder
+* More?
+
+
+Refactor generation of resource lists for core classes, maybe add a builder module?
+
+
+
+#### Author
+Ile Eftimov - [@fteem](http://twitter.com/fteem)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/marver.rb

@@ -1,28 +1,42 @@
 require 'rest_client'
-require 'digest/md5'
 
-class Marver
-  API_VERSION = "v1"
-  API_ENDPOINT = "http://gateway.marvel.com"
+# Base Classes
+require './lib/marver/client.rb'
+require './lib/marver/version.rb'
+require './lib/marver/credentials.rb'
+require './lib/marver/data_container.rb'
 
-  attr_reader :private_key, :public_key
+# Finders
+require './lib/marver/finders/character_finder.rb'
 
-  def initialize(private_key, public_key)
-    @private_key = private_key
-    @public_key = public_key
-  end
+# REST
+require './lib/marver/rest/client.rb'
+require './lib/marver/rest/response.rb'
 
-  def characters(name = "")
-    endpoint = build_url("characters")
-    endpoint = endpoint + "&name=#{name}" unless name.empty?
-    response = RestClient.get endpoint
-  end
+# 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'
 
-  private
+# 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'
 
-  def build_url(noun)
-    ts = Time.now.to_i.to_s
-    hash = Digest::MD5.hexdigest(ts + private_key + public_key)
-    "#{API_ENDPOINT}/#{API_VERSION}/public/#{noun}?ts=#{ts}&apikey=#{public_key}&hash=#{hash}"
-  end
-end
+# 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/builders/common_entities_builder.rb

@@ -0,0 +1,46 @@
+require './lib/marver.rb'
+
+# TODO: Refactor, I guess?
+module Marver
+  module CommonEntitiesBuilder
+    COMMON_ENTITIES = %w(prices images urls textObjects thumbnail dates)
+
+    extend Marver::StringHelper
+
+    def self.build!(object)
+      COMMON_ENTITIES.each do |entity|
+        # If the object's JSON has this entity..
+        if object.json.has_key?(entity)
+          # get the entity lists
+          entities = entity_items(object, entity)
+          # find the class for this type of entity
+          klass = common_class(entity)
+          # parameterize the entity string
+          # i.e. textObjects => TextObject
+          parameterized_entity = parameterize(entity)
+
+          if entities.kind_of?(Array)
+            object.class.send(:define_method, parameterized_entity) do
+              entities.collect do |ent|
+                klass.new(ent)
+              end
+            end
+          else
+            object.class.send(:define_method, parameterized_entity) do
+              klass.new(entities)
+            end
+          end
+        end
+      end
+    end
+
+    def self.entity_items(object, entity)
+      if object.json[entity].kind_of?(Hash) && object.json[entity].has_key?('items')
+        [object.json[entity]['items']].compact.flatten(1)
+      else
+        object.json[entity]
+      end
+    end
+
+  end
+end

data/lib/marver/builders/core_entities_builder.rb

@@ -0,0 +1,34 @@
+require './lib/marver.rb'
+
+# TODO: Refactor, I guess?
+module Marver
+  module CoreEntitiesBuilder
+    CORE_ENTITIES = %w(comics series creators stories characters events)
+
+    extend Marver::StringHelper
+
+    def self.build!(object)
+      CORE_ENTITIES.each do |entity|
+        if object.json.has_key?(entity)
+          klass = self.summary_class(entity)
+          entity_items = self.entity_items(object, entity)
+
+          object.class.send(:define_method, entity) do
+            entity_items.collect do |ent|
+              klass.new(ent, object.credentials)
+            end
+          end
+        end
+      end
+    end
+
+    def self.entity_items(object, entity)
+      if object.json[entity].kind_of?(Hash) && object.json[entity].has_key?('items')
+        [object.json[entity]['items']].compact.flatten(1)
+      else
+        [object.json[entity]].compact.flatten(1)
+      end
+    end
+
+  end
+end

data/lib/marver/client.rb

@@ -0,0 +1,13 @@
+require './lib/marver.rb'
+
+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)
+    end
+
+  end
+end

data/lib/marver/credentials.rb

@@ -0,0 +1,23 @@
+require 'digest/md5'
+
+module Marver
+  class Credentials
+    attr_reader :public_key, :private_key, :timestamp
+
+    def initialize(private_key, public_key)
+      @public_key  = public_key
+      @private_key = private_key
+      @timestamp = Time.now.to_i.to_s
+    end
+
+    def to_s
+      "ts=#{@timestamp}&apikey=#{@public_key}&hash=#{md5_hash(@timestamp)}"
+    end
+
+    private
+
+    def md5_hash(ts)
+      Digest::MD5.hexdigest(@timestamp + @private_key + @public_key)
+    end
+  end
+end

data/lib/marver/data_container.rb

@@ -0,0 +1,18 @@
+module Marver
+  class DataContainer
+    attr_reader :offset, :limit, :total, :results
+
+    def initialize(response)
+      json_results = response.data
+
+      @offset = json_results['offset'].to_i
+      @limit = json_results['limit'].to_i
+      @total = json_results['total'].to_i
+      if @total == 1
+        @results = json_results['results'].first
+      else
+        @results = json_results['results']
+      end
+    end
+  end
+end

data/lib/marver/entities/common/image.rb

@@ -0,0 +1,9 @@
+module Marver
+  class Image
+    attr_reader :full_path
+
+    def initialize(json)
+      @full_path = json['path'] + '.' + json['extension']
+    end
+  end
+end

data/lib/marver/entities/common/key_date.rb

@@ -0,0 +1,10 @@
+module Marver
+  class KeyDate
+    attr_reader :type, :date
+
+    def initialize(json)
+      @type = json['type']
+      @date = Date.parse(json['date'])
+    end
+  end
+end

data/lib/marver/entities/common/price.rb

@@ -0,0 +1,10 @@
+module Marver
+  class Price
+    attr_reader :type, :price
+
+    def initialize(json)
+      @type = json['type']
+      @price = json['price']
+    end
+  end
+end

data/lib/marver/entities/common/text_object.rb

@@ -0,0 +1,11 @@
+module Marver
+  class TextObject
+    attr_reader :type, :language, :text
+
+    def initialize(json)
+      @type = json['type']
+      @language = json['language']
+      @text = json['text']
+    end
+  end
+end

data/lib/marver/entities/common/url.rb

@@ -0,0 +1,10 @@
+module Marver
+  class Url
+    attr_reader :type, :url
+
+    def initialize(json)
+      @type = json['type']
+      @url = json['url']
+    end
+  end
+end

data/lib/marver/entities/core/character.rb

@@ -0,0 +1,35 @@
+require './lib/marver.rb'
+
+module Marver
+  class Character
+    attr_reader :id, :resource_uri, :description, :urls, :name,
+      :thumbnail, :comics, :stories, :events, :series, :json, :credentials
+
+    class << self
+      def build(response, credentials)
+        if response.kind_of?(Array)
+          response.collect do |character|
+            Marver::Character.new(character, credentials)
+          end
+        else
+          new(response.results, credentials)
+        end
+      end
+    end
+
+    def initialize(json, credentials)
+      @credentials = credentials
+      @json = json
+
+      @description = json['description']
+      @id = json['id'].to_i
+      @credentials = credentials
+      @name = json['name']
+      @resource_uri = "#{json['resourceURI']}?#{@credentials.to_s}"
+
+      CoreEntitiesBuilder.build!(self)
+      CommonEntitiesBuilder.build!(self)
+    end
+
+  end
+end

data/lib/marver/entities/core/comic.rb

@@ -0,0 +1,46 @@
+require './lib/marver.rb'
+
+module Marver
+  class Comic
+    attr_reader :json, :credentials, :id, :digital_id, :title, :issue_number,
+                :variant_description, :description, :isbn,
+                :upc, :diamond_code, :ean, :issn, :format,
+                :page_count, :resource_uri, :thumbnail, :text_objects
+
+
+    class << self
+      def build(response, credentials)
+        if response.kind_of?(Array)
+          response.collect do |comic|
+            new(comic, credentials)
+          end
+        else
+          new(response.results, credentials)
+        end
+      end
+    end
+
+    def initialize(json, credentials)
+      @json = json
+      @credentials = credentials
+      @title = json['title']
+      @resource_uri = "#{json['resourceURI']}?#{@credentials.to_s}"
+      @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']
+
+      CoreEntitiesBuilder.build!(self)
+      CommonEntitiesBuilder.build!(self)
+    end
+
+  end
+end