marvelite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79f53a7757f023b10894b8e6ed848fb12391cd92
+  data.tar.gz: b040915a1836fc80ab2264f1e0a7d382e4b83285
+SHA512:
+  metadata.gz: 3ad69674271a377ca1e63f9cd4ccba4f8dfcbad3c3c354a2487392cf2841fc2bce905f0c90b66a0250e2014cec5fcf42908c2dda2d537b2bdcb7db58855dc2a4
+  data.tar.gz: 78a1f01d3a93eb825cd0977e193f063883b94d2201878dae979c9e905fae3ac5eba577b54719ddbd5705b5d26a19cd3004c2256d124518ff10f81ea6d40c5a53

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Antonio Antillon
+
+MIT License
+
+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,93 @@
+# Marvelite
+
+Simple wrapper to communicate with the Marvel Comics API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'marvelite'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marvelite
+
+## Contents
+
+* [Usage](#usage)
+  * [Methods](#methods)
+* [Responses](#responses)
+
+
+## Usage
+
+Please register first in the [Marvel Comics Developer Portal](http://developer.marvel.com/) to get your API credentials (a public key and a private key, you'll need them both to configure and instantiate a client).
+
+### Instantiate a client
+
+```ruby
+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. |
+
+
+#### characters
+Fetches a list of comic characters. Can receive optional params.
+```ruby
+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.
+
+```ruby
+client.character(1009368)
+client.character('Iron Man')
+```
+
+## Responses
+
+All requests to the API, return a `Marvelite::API::Response` object, that is nothing more than the raw API response enhanced with Hashie methods.
+
+This way you gain several adavantages to manipulate the response, like:
+
+```ruby
+# HashWithIndifferentAccess like functionality
+response[:data][:results][0][:name]
+response["data"]["results"][0]["name"]
+
+# Top level methods
+response.data
+response.data[:results]
+```
+
+
+
+## Todo
+
+* Add more endpoints
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/marvelite/api/client.rb

@@ -0,0 +1,52 @@
+module Marvelite
+  module API
+    class Client
+      include ActiveModel::Model
+      include HTTParty
+      base_uri 'http://gateway.marvel.com'
+
+      attr_accessor :public_key, :private_key, :router, :api_version
+
+      validates_presence_of :public_key
+      validates_presence_of :private_key
+
+      def initialize(attrs)
+        super
+        @router = attrs.fetch(:router) { Marvelite.router }
+        @api_version = attrs.fetch(:api_version) { 'v1' }
+      end
+
+      def characters(query_params = {})
+        response = self.class.get("/#{api_version}/#{router.characters_path}", :query => params(query_params))
+        Response.new(response)
+      end
+
+      def character(value)
+        by_name = value.is_a?(String) ? true : false
+        response = if by_name
+          self.characters(:name => value)
+        else
+          self.class.get("/#{api_version}/#{router.character_path(value)}", :query => params)
+        end
+
+        Response.new(response)
+      end
+
+      private
+      def params(additional_params = {})
+        base_hash = { :apikey => public_key, :ts => ts, :hash => request_hash }
+        additional_params.merge(base_hash)
+      end
+
+      def request_hash
+        Digest::MD5.hexdigest("#{ts}#{private_key}#{public_key}")
+      end
+
+      def ts
+        begin
+          Time.now.to_i
+        end
+      end
+    end
+  end
+end

data/lib/marvelite/api/response.rb

@@ -0,0 +1,10 @@
+module Marvelite
+  module API
+    class Response < Hash
+      include Hashie::Extensions::MergeInitializer
+      include Hashie::Extensions::KeyConversion
+      include Hashie::Extensions::MethodAccess
+      include Hashie::Extensions::IndifferentAccess
+    end
+  end
+end

data/lib/marvelite/api/router.rb

@@ -0,0 +1,25 @@
+module Marvelite
+  module API
+    class Router
+      def characters_path
+        'public/characters'
+      end
+
+      def character_path(id)
+        "public/characters/#{id}"
+      end
+
+      def character_comics_path(id)
+        "public/characters/#{id}/comics"
+      end
+
+      def character_events_path(id)
+        "public/characters/#{id}/events"
+      end
+
+      def character_stories_path(id)
+        "public/characters/#{id}/stories"
+      end
+    end
+  end
+end

data/lib/marvelite/version.rb

@@ -0,0 +1,3 @@
+module Marvelite
+  VERSION = "0.0.1"
+end

data/lib/marvelite.rb

@@ -0,0 +1,15 @@
+require 'active_model'
+require 'digest'
+require 'httparty'
+require 'hashie'
+
+require "marvelite/version"
+require "marvelite/api/router"
+require "marvelite/api/client"
+require "marvelite/api/response"
+
+module Marvelite
+  def self.router
+    Marvelite::API::Router.new
+  end
+end

data/spec/marvelite/api/client_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Marvelite::API::Client do
+  describe 'initialization' do
+    it 'requires a :public_key to be set' do
+      client = Marvelite::API::Client.new(:private_key => '12345')
+      expect(client).to_not be_valid
+    end
+
+    it 'requires a :private_key to be set' do
+      client = Marvelite::API::Client.new(:public_key => '1234')
+      expect(client).to_not be_valid
+    end
+
+    context 'valid' do
+      let(:client) { Marvelite::API::Client.new(:public_key => '1234', :private_key => 'abcd') }
+
+      describe '#api_version' do
+        it 'receives an :api_version optional param' do
+          client = Marvelite::API::Client.new(:public_key => '1234', :private_key => 'abcd', :api_version => 'v2')
+          expect(client.api_version).to eq('v2')
+        end
+
+        it 'defaults to v1' do
+          expect(client.api_version).to eq('v1')
+        end
+      end
+
+      it 'is an instance of Marvelite::Client' do
+        expect(client).to be_valid
+        expect(client).to be_a(Marvelite::API::Client)
+      end
+
+      it 'has an API Router instance in its config' do
+        expect(client.router).to_not be_nil
+        expect(client.router).to be_a(Marvelite::API::Router)
+      end
+    end
+  end
+
+  describe '#ts' do
+    let(:client) { Marvelite::API::Client.new(:public_key => '1234', :private_key => 'abcd') }
+
+    it 'calls Time.now' do
+      Time.should_receive(:now)
+      client.ts
+    end
+    
+    it 'represents a timestamp converted to integer' do
+      expect(client.ts).to be_a(Integer)
+    end
+  end
+
+  describe '#params' do
+    let(:client) { Marvelite::API::Client.new(:public_key => '1234', :private_key => 'abcd') }
+
+    it 'passes required API params to all requests' do
+      expect(client.params).to eq('?apikey=1234&ts=1&hash=ffd275c5130566a2916217b101f26150')
+    end
+  end
+
+  describe '#characters' do
+    let(:client) { Marvelite::API::Client.new(:public_key => '1234', :private_key => 'abcd') }
+
+    it 'returns a JSON response from the characters endpoint' do
+      expect(client.characters).to eq('http://gateway.marvel.com/v1/public/characters?apikey=1234&ts=1&hash=ffd275c5130566a2916217b101f26150')
+    end
+  end
+end

data/spec/marvelite/api/router_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Marvelite::API::Router do
+  it 'stores Marvel Comics API endpoints'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'marvelite'
+require 'pry'

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: marvelite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antonio Antillon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple wrapper around the Marvel Comics API
+email:
+- antillas21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/marvelite/api/client.rb
+- lib/marvelite/api/response.rb
+- lib/marvelite/api/router.rb
+- lib/marvelite/version.rb
+- lib/marvelite.rb
+- spec/marvelite/api/client_spec.rb
+- spec/marvelite/api/router_spec.rb
+- spec/spec_helper.rb
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- README.md
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Simple wrapper around the Marvel Comics API
+test_files:
+- spec/marvelite/api/client_spec.rb
+- spec/marvelite/api/router_spec.rb
+- spec/spec_helper.rb