uatu-marvel 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 330a8356b2d7b0966db9894575503533baaaeeb2
-  data.tar.gz: b1d0e32f6c552458b8e2ee146d071ae28e43cba0
+  metadata.gz: 12cb79ee340c489b05fa468e7f63ed1ec925ad41
+  data.tar.gz: d8492dfd4266976a1e7561be0071fe4341b79029
 SHA512:
-  metadata.gz: 497fed44e916e0f6527ac0786e1bdb6b5ba7c4c58c0510f3c31323f689f116da0dc7dc1e4336f260342dbe9624a8c60e019046fa8ecbeb0d507817eb71734b65
-  data.tar.gz: 37f432df0a3fe7ceba0d92fd44e5ab4d7487c7006c91b113a91aa0c30bda9a0b0e786c4bddcda7359aa29f8d58a884318db731e35ea7e53b5f29e246f0bc3e73
+  metadata.gz: 63608df002443e53cc4788fe4b1dde3507b26d60c8176d7a2cd1cecfed934d6b439badd8d9bb24ddda774ad791ecd4e488ff85a42dac730f7ba28dc6a538b1e9
+  data.tar.gz: c539f388152af2778f090ae1a36f2cc698fef51a76c42a43c803d06c4a5b7d0cf8e9b7b5af1457fab4e08f1a8de86258d5ac86d7560a420989351b90c129b004

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .ruby-version
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -1,3 +1,6 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.4.1
+  - 2.2
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in uatu.gemspec
 gemspec
+
+gem 'pry'

data/README.md

@@ -1,6 +1,8 @@
+[![Build Status](https://travis-ci.org/eltercero/uatu.png)](https://travis-ci.org/eltercero/uatu)
+
 # Uatu
 
-Uatu is a Wrapper for the Marvel API. See [the API](http://developer.marvel.com) for more details. It relies on OpenStruct to build ruby objects with the API response. 
+Uatu is a Wrapper for the Marvel API. See [the API](http://developer.marvel.com) for more details. It relies on OpenStruct to build ruby objects with the API response.
 
 Uatu is [also](http://en.wikipedia.org/wiki/Uatu) a member of The Watchers, that nice extraterrestrial race who monitor life of other species.
 
@@ -45,14 +47,14 @@ random_hero = watcher.characters(limit: 1, offset: rand(1000)).first.name
 random_heroes_team = watcher.characters(limit: 20, offset: rand(1000)).map(&:name)
 => ["Rumiko Fujikawa", "Runaways", "Russian", "S.H.I.E.L.D.", "Sabra", "Sabretooth", "Sabretooth (Age of Apocalypse)", "Sabretooth (House of M)", "Sabretooth (Ultimate)", "Sage", "Salem's Seven (Ultimate)", "Sally Floyd", "Salo", "Sandman", "Santa Claus", "Saracen (Muzzafar Lambert)", "Sasquatch (Walter Langkowski)", "Satana", "Sauron", "Scalphunter"]
 
-# Parameters are in ruby style. This means no camel case like firstName 
+# Parameters are in ruby style. This means no camel case like firstName
 irish_fella = watcher.creators(first_name: 'Garth', last_name: 'Ennis').first
 irish_fella.comics.available
 => 103
 
 #You can also search by id
 character = watcher.character(1009262)
-character.thumbnail 
+character.thumbnail
 => "http://i.annihil.us/u/prod/marvel/i/mg/d/50/50febb79985ee.jpg"
 
 #There is also a handy method for checking out the last url you requested

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uatu"
+
+require "pry"
+Pry.start

data/lib/uatu.rb

@@ -3,13 +3,24 @@ require 'digest/md5'
 require 'json'
 require 'hashie/mash'
 require 'active_support/inflector'
+require 'faraday'
 
-require 'uatu/configuration'
 require 'uatu/version'
+require 'uatu/resources'
+
+require 'uatu/endpoints/single'
+require 'uatu/endpoints/collection'
+require 'uatu/endpoints/nested'
 
 require 'uatu/base'
 
+require 'uatu/response'
+require 'uatu/configuration'
+require 'uatu/connection'
+require 'uatu/resource'
+require 'uatu/error'
+
 module Uatu
-  extend Configuration
+  extend Uatu::Configuration
 end
 

data/lib/uatu/base.rb

@@ -1,70 +1,25 @@
-require 'uatu/connection'
-require 'uatu/resource'
-require 'pry'
-
 module Uatu
   class Base
-    include Uatu::Connection
+    include Uatu::Endpoints::Single
+    include Uatu::Endpoints::Collection
+    include Uatu::Endpoints::Nested
 
-    attr_accessor *Configuration::VALID_CONFIG_KEYS
     attr_accessor :last_request_url
-    RESOURCES = %w(comic serie character event story creator)
-
-    def initialize
-      Configuration::VALID_CONFIG_KEYS.each do |key|
-        send("#{key}=", Uatu.options[key])
-      end
-    end
 
-    RESOURCES.each do |method_name|
-      # Singular
-      # example: GET /v1/public/characters/{characterId} => Uatu::Base.new.character
-      define_method method_name do |id, options={}|
-        raise Uatu::Error::BadRequest.new('options must be in a Hash') unless options.is_a?(Hash)
-        options.merge!("#{method_name}_id".to_sym => id)
-        output = request_and_build(method_name, options)
-        output.first
-      end
-
-      # Plural
-      # example: GET /v1/public/characters => Uatu::Base.new.characters
-      define_method method_name.pluralize do |options={}|
-        raise Uatu::Error::BadRequest.new('options must be in a Hash') unless options.is_a?(Hash)
-        request_and_build(method_name, options)
-      end
+  private
 
-      # Combined
-      # example: GET /v1/public/characters/{characterId}/comics => Uatu::Base.new.character_comics
-      RESOURCES.each do |combined|
-        unless combined == method_name
-          define_method "#{method_name}_#{combined.pluralize}" do |id, options={}|
-            raise Uatu::Error::BadRequest.new('options must be in a Hash') unless options.is_a?(Hash)
-            options.merge!("#{method_name}_id".to_sym => id)
-            request_and_build("#{method_name}_#{combined.pluralize}", options) 
-          end
-        end
-      end
-    end
-
-    def request_and_build(method_name, options)
-      response = request(method_name, options, conn_options)
+    def request_and_build connection
+      response = connection.request
       parsed_body = JSON.parse(response.body)
 
-      self.last_request_url = response.env.url.to_s
+      @last_request_url = response.to_hash[:url].to_s
 
       output = parsed_body['data']['results'].map do |resource_hash|
-        "Uatu::#{method_name.split('_').last.classify}".constantize.new(resource_hash)
+        "Uatu::#{connection.resource.split('_').last.classify}".constantize.new(resource_hash)
       end
 
-      output 
+      output
     end
 
-    def conn_options
-      _conn_options = Hashie::Mash.new
-      Configuration::VALID_CONFIG_KEYS.each{|key| _conn_options[key] = send(key)}
-      _conn_options
-    end
-
-
   end
-end
+end

data/lib/uatu/configuration.rb

@@ -1,12 +1,11 @@
 module Uatu
   module Configuration
 
-    VALID_CONFIG_KEYS = [:base_url, :public_key, :private_key]
+    VALID_CONFIG_KEYS = [:public_key, :private_key]
 
-    BASE_URL        = "http://gateway.marvel.com"
     PUBLIC_KEY      = ENV["MARVEL_PUBLIC_KEY"]
     PRIVATE_KEY     = ENV["MARVEL_PRIVATE_KEY"]
-    
+
     attr_accessor *VALID_CONFIG_KEYS
 
     def self.extended(base)
@@ -17,12 +16,11 @@ module Uatu
       yield self
     end
 
-    def options
+    def credentials
       Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
     end
 
     def reset
-      self.base_url     = BASE_URL
       self.public_key   = PUBLIC_KEY
       self.private_key  = PRIVATE_KEY
     end

data/lib/uatu/connection.rb

@@ -1,75 +1,82 @@
-require 'faraday'
-require 'uatu/response'
-
 module Uatu
-  module Connection
-    
-    def request(method, options, conn_options)
-      conn = build_connection(conn_options)
-      conn_params = prepare_options(options).merge(mandatory_params(conn_options))
-      conn_route = build_route(method, options)
-
-      conn.get conn_route, conn_params
+  class Connection
+
+    BASE_URL = "http://gateway.marvel.com"
+
+    attr_reader :resource, :options
+
+    def initialize resource, options
+      @resource = resource
+      @options  = options
     end
 
-    def build_connection(conn_options)
-      Faraday.new(url: conn_options.base_url) do |faraday|
-        faraday.use Uatu::Response::RaiseMarvelError
+    def request
+      connection.get path, params
+    end
+
+  private
 
-        faraday.request  :url_encoded             
-        faraday.adapter  Faraday.default_adapter  
+    def connection
+      @connection ||= Faraday.new(url: BASE_URL) do |faraday|
+        faraday.use Uatu::Response::RaiseMarvelError
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
       end
     end
 
-    def build_route(method, options={})
-      route = "/v1/public/#{valid_method(method)}"
-      if resource_id = options["#{valid_method(method).singularize}_id".to_sym]
+    def path
+      route = "/v1/public/#{resource_path}"
+      if resource_id = options["#{resource_path.singularize}_id".to_sym]
         route += "/#{resource_id}"
       end
 
-      # If it is combined, it comes afet the '_'
-      if method.split('_').count>1 && combined_path = method.split('_').last
+      # If it is combined, it comes after the '_'
+      if resource.split('_').count>1 && combined_path = resource.split('_').last
         route += "/#{combined_path}"
       end
 
       route
     end
 
-    def prepare_options(options)
-      valid_opts = {}
-      
-      # We remove innecessary keys that should go on the route
-      _options = options.reject{|key, value| key.to_s.match(/.*_id/)}
+    def params
+      request_params = {}
+
+      # We remove unnecessary keys that should go on the route
+      temp_params = options.reject{|key, value| key.to_s.match(/.*_id/)}
 
-      # We change the names, so 'format_type' becomes 'formatType' 
-      _options.each{|key, value| valid_opts[key.to_s.camelize(:lower).to_sym] = value }
+      # We change the names, so 'format_type' becomes 'formatType'
+      temp_params.each{|key, value| request_params[key.to_s.camelize(:lower).to_sym] = value }
 
       # An array should become a string with comma separated values
-      valid_opts.each{|key, value| valid_opts[key] = value.join(',') if value.is_a?(Array) }
+      request_params.each{|key, value| request_params[key] = value.join(',') if value.is_a?(Array) }
 
-      valid_opts
+      request_params.merge(mandatory_params)
     end
 
     # character => characters
     # characters => characters
     # character_comics => characters
-    def valid_method(method)
-      _method = method.split('_').first.pluralize
-      raise Uatu::Error.new('InvalidMethod') unless Uatu::Base::RESOURCES.map(&:pluralize).include?(_method)
-      _method
+    def resource_path
+      @resource_path ||= resource.split('_').first.pluralize.tap do |path|
+        raise Uatu::Error.new('InvalidMethod') unless Uatu::RESOURCES.map(&:pluralize).include?(path)
+      end
     end
 
-    def current_timestamp
-      @ts ||= DateTime.now.to_s
+    def mandatory_params
+      {
+        :apikey => Uatu.public_key,
+        :ts     => current_timestamp,
+        :hash   => hash(current_timestamp)
+      }
     end
 
-    def hash(timestamp, conn_options)
-      Digest::MD5.hexdigest("#{timestamp}#{conn_options.private_key}#{conn_options.public_key}")      
+    def current_timestamp
+      @ts ||= DateTime.now.to_s
     end
 
-    def mandatory_params(conn_options)
-      {apikey: conn_options.public_key, ts: current_timestamp, hash: hash(current_timestamp, conn_options)}
+    def hash timestamp
+      Digest::MD5.hexdigest("#{timestamp}#{Uatu.private_key}#{Uatu.public_key}")
     end
 
   end
-end
+end

data/lib/uatu/endpoints/collection.rb

@@ -0,0 +1,16 @@
+module Uatu
+  module Endpoints
+    module Collection
+
+      Uatu::RESOURCES.each do |resource|
+        # example: GET /v1/public/characters => Uatu::Base.new.characters
+        define_method resource.pluralize do |options={}|
+          raise Uatu::Error::BadRequest.new('options must be in a Hash') unless options.is_a?(Hash)
+          connection = Uatu::Connection.new resource, options
+          request_and_build connection
+        end
+      end
+
+    end
+  end
+end

data/lib/uatu/endpoints/nested.rb

@@ -0,0 +1,23 @@
+module Uatu
+  module Endpoints
+    module Nested
+
+      Uatu::RESOURCES.each do |resource|
+        # example: GET /v1/public/characters/{characterId}/comics => Uatu::Base.new.character_comics
+        RESOURCES.each do |nested_resource|
+          unless nested_resource == resource
+            define_method "#{resource}_#{nested_resource.pluralize}" do |id, options={}|
+              raise Uatu::Error::BadRequest.new('options must be in a Hash') unless options.is_a?(Hash)
+              options.merge!("#{resource}_id".to_sym => id)
+              resource = "#{resource}_#{nested_resource.pluralize}"
+              connection = Uatu::Connection.new resource, options
+
+              request_and_build connection
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/uatu/endpoints/single.rb

@@ -0,0 +1,17 @@
+module Uatu
+  module Endpoints
+    module Single
+
+      Uatu::RESOURCES.each do |resource|
+        # example: GET /v1/public/characters/{characterId} => Uatu::Base.new.character
+        define_method resource do |id, options={}|
+          raise Uatu::Error::BadRequest.new('options must be in a Hash') unless options.is_a?(Hash)
+          options.merge!("#{resource}_id".to_sym => id)
+          connection = Uatu::Connection.new resource, options
+          request_and_build(connection).first
+        end
+      end
+
+    end
+  end
+end

data/lib/uatu/resource.rb

@@ -5,16 +5,18 @@ module Uatu
       super(improve_values(underscore_keys(original_hash)))
     end
 
+  private
+
     # Underscore names of the Hash. I mean... this is Ruby, right?.
     def underscore_keys(hash)
       _hash = {}
-      hash.each do |k, v|
-        _hash[k.to_s.underscore] = if v.is_a?(Hash)
-          underscore_keys(v)
-        elsif v.is_a?(Array) and v.first.is_a?(Hash)
-          v.map{|h| underscore_keys(h)}
+      hash.each do |key, value|
+        _hash[key.to_s.underscore] = if value.is_a?(Hash)
+          underscore_keys(value)
+        elsif value.is_a?(Array) and value.first.is_a?(Hash)
+          value.map{|h| underscore_keys(h)}
         else
-          v
+          value
         end
       end
       _hash
@@ -24,24 +26,24 @@ module Uatu
     # The 'thumbnail' hash drives me crazy, we convert it to a single value.
     def improve_values(hash)
       _hash = {}
-      hash.each do |k,v|
-        _hash[k] = if k.to_s=='thumbnail'
-          [v['path'],v['extension']].join('.')
-        elsif v.is_a?(Hash)
-          Hashie::Mash.new(v)
+      hash.each do |key, value|
+        _hash[key] = if key.to_s=='thumbnail' && !value.nil?
+          [value['path'],value['extension']].join('.')
+        elsif value.is_a?(Hash)
+          Hashie::Mash.new(value)
         else
-          v
+          value
         end
       end
       _hash
     end
 
   end
+end
 
-  class Character < Resource ; end  
-  class Event < Resource ; end  
-  class Comic < Resource ; end  
-  class Story < Resource ; end  
-  class Serie < Resource ; end  
-  class Creator < Resource ; end  
-end
+class Uatu::Character < Uatu::Resource ; end
+class Uatu::Event < Uatu::Resource     ; end
+class Uatu::Comic < Uatu::Resource     ; end
+class Uatu::Story < Uatu::Resource     ; end
+class Uatu::Serie < Uatu::Resource     ; end
+class Uatu::Creator < Uatu::Resource   ; end