marvelite 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16d19808169b8963aa3ebea4bd9cfdb47c752c5b
-  data.tar.gz: 5d16ff33769cd4f3febb31ef18d27b424acc2b2e
+  metadata.gz: 1a25275235911ff6c298db40d9a53cbdba48da58
+  data.tar.gz: 704f6f949a889ed333d996af13223fcda8a96b06
 SHA512:
-  metadata.gz: 4d53422e7d9b2a5c9587fe6c47c47bab17588d7b198817dc6ac63673b9d121e2485ca28042166f1d094e6d1c9c242a65e4144870340c7c17ed67c0f879c65505
-  data.tar.gz: 3f1d488133bf1dc17d83a78afa8d94498809df61e07c370980d4668308a90e3527a85e66730f97d6a9ff1cafbf2f2b7451f5cd1a5d6a5d778768f52925949a37
+  metadata.gz: 9057f0a8b511dced1d1865cca70270c80c86ac8befdad542e2592b8c5b37b0be845e318b7c43a5fbcf61f3a3e85a15e72baadff99905e991ec920ab470bc78f5
+  data.tar.gz: 265c411137e5af68cd206be287ba5c50bbf2874dec5a4703a2a6463f0259bc64021be5ea8e93e0bd8ba4c9771a9b308b1464b74ad1094f3ec68aff456cd137c9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 0.1.0
+* Adds Travis CI support.
+* Support for Etags and Gzip compression. Infinite thanks to [Jon Allured](https://github.com/jonallured) for this contribution.
+* Refactorings and cleanups, courtesy of [Jon Allured](https://github.com/jonallured)
+
 ### 0.0.9
 * Adds the following endpoints (contributed by: [Patrick Hereford (@phereford)](https://github.com/phereford)):
   * retrieve creators by connecting to the API's `/creators` endpoint

data/README.md

@@ -1,4 +1,7 @@
-# Marvelite
+# Marvelite [![Build Status][travis-badge]][travis]
+
+[travis-badge]: https://travis-ci.org/antillas21/marvelite.png
+[travis]: http://travis-ci.org/antillas21/marvelite
 
 Simple Ruby wrapper to communicate with the Marvel Comics API.
 
@@ -21,18 +24,16 @@ Or install it yourself as:
 * [Usage](#usage)
 * [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).
+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'
-)
+client = Marvelite::API::Client.new( :public_key => 'abcd1234', :private_key => '5678efgh')
 
 # fetch a list of characters
 client.characters
@@ -104,12 +105,16 @@ client.story_comics(2210)
 client.story_comics(2210, :format => 'graphic novel', :orderBy => 'title', :limit => 10)
 ```
 
-See the list of [available methods](https://github.com/antillas21/marvelite/wiki/Documentation) in the wiki.
-
+See the list of [available
+methods](https://github.com/antillas21/marvelite/wiki/Documentation) in the
+wiki.
 
 ## Responses
 
-All requests to the API, return a `Marvelite::API::Response` object if successful or a `Marvelite::API::ErrorResponse` if API response returns an error. These objects are nothing more than the raw API response enhanced with Hashie methods.
+Most requests to the API, return a `Marvelite::API::Response` object if
+successful or a `Marvelite::API::ErrorResponse` if API response returns an
+error. These objects are nothing more than the raw API response enhanced with
+Hashie methods.
 
 This way you gain several adavantages to manipulate the response, like:
 
@@ -123,11 +128,22 @@ response.data
 response.data[:results]
 ```
 
+## Etags and Gzip support
+
+Support for Etags is built into every endpoint:
 
+```ruby
+first_response = client.series
+first_response.status # => 200
 
-## Todo
+second_response = client.series headers: { 'If-None-Match' => first_response.etag }
+second_response.status # => 304
+```
 
-* Add more endpoints
+```ruby
+gzipped_response = client.series(:headers => {'Accept-Encoding' => 'gzip'})
+#=> Faster response hash from Marvel's API series endpoint. :)
+```
 
 
 ## Contributing

data/lib/marvelite.rb

@@ -1,4 +1,3 @@
-require 'active_model'
 require 'digest/md5'
 require 'httparty'
 require 'hashie'

data/lib/marvelite/api/client.rb

@@ -1,23 +1,29 @@
 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
+      class InvalidClientError < StandardError; end
 
       def initialize(attrs)
-        super
+        check_for_errors(attrs)
+        @public_key = attrs.fetch(:public_key)
+        @private_key = attrs.fetch(:private_key)
         @api_version = attrs.fetch(:api_version) { 'v1' }
         @router = attrs.fetch(:router) { Marvelite.router(:api_version => @api_version) }
         build_methods
       end
 
       private
+      def check_for_errors(attrs)
+        [:public_key, :private_key].each do |key|
+          raise InvalidClientError, "You need to provide a :#{key} param." unless attrs[key]
+        end
+      end
+
       def params(additional_params = {})
         base_hash = { :apikey => public_key, :ts => ts, :hash => request_hash }
         additional_params.merge(base_hash)
@@ -34,9 +40,11 @@ module Marvelite
       end
 
       def build_response_object(response)
-        case response["code"]
+        case response.code
         when 200
           Response.new(response)
+        when 304
+          NotModifiedResponse.new(response)
         else
           ErrorResponse.new(response)
         end
@@ -49,6 +57,11 @@ module Marvelite
         response
       end
 
+      def pull_headers(options)
+        headers = options.delete(:headers) || {}
+        [options, headers]
+      end
+
       def process_arguments(*args)
         temp_id, temp_options = *args
         if temp_id && temp_id.is_a?(Hash)
@@ -60,18 +73,24 @@ module Marvelite
         else
           options = {}
         end
-        { id: id, options: options}
+        params, headers = pull_headers(options)
+        [{ id: id, options: params}, headers]
       end
 
-      def fetch_response(route, params_hash = {})
+      def fetch_response(route, params_hash = {}, headers = {})
         id = params_hash[:id]
         options = params_hash[:options]
+        path = find_path(route, id)
+
+        self.class.get(path, query: params(options), headers: headers)
+      end
 
+      def find_path(route, id)
         if id.nil?
-          self.class.get(router.send("#{route}_path".to_sym), :query => params(options))
+          router.send("#{route}_path".to_sym)
         else
           id = fetch_resource_id(route, id) if id.is_a?(String)
-          self.class.get(router.send("#{route}_path".to_sym, {:id => id}), :query => params(options))
+          router.send("#{route}_path".to_sym, {:id => id})
         end
       end
 
@@ -86,8 +105,8 @@ module Marvelite
         @router.routes.each do |_, hash|
           name = hash[:name]
           self.class.send(:define_method, name) do |*args|
-            params = process_arguments(*args)
-            response = fetch_response(name, params)
+            params, headers = process_arguments(*args)
+            response = fetch_response(name, params, headers)
             build_response_object(response)
           end
         end
@@ -95,4 +114,4 @@ module Marvelite
 
     end
   end
-end
+end

data/lib/marvelite/api/response.rb

@@ -7,11 +7,17 @@ module Marvelite
       include Hashie::Extensions::IndifferentAccess
     end
 
-    class ErrorResponse < Hash
-      include Hashie::Extensions::MergeInitializer
-      include Hashie::Extensions::KeyConversion
-      include Hashie::Extensions::MethodAccess
-      include Hashie::Extensions::IndifferentAccess
+    class ErrorResponse < Response; end
+
+    class NotModifiedResponse < Response
+      def initialize(response)
+        super({
+          status: 'Not Modified',
+          code: 304,
+          data: {},
+          etag: response.headers['etag']
+        })
+      end
     end
   end
-end
+end

data/lib/marvelite/version.rb

@@ -1,3 +1,3 @@
 module Marvelite
-  VERSION = "0.0.9"
+  VERSION = '0.1.0'
 end

data/spec/marvelite/api/client_spec.rb

@@ -3,13 +3,15 @@ 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
+      expect{ Marvelite::API::Client.new(:private_key => '12345') }.to raise_error(
+        Marvelite::API::Client::InvalidClientError, "You need to provide a :public_key param."
+      )
     end
 
     it 'requires a :private_key to be set' do
-      client = Marvelite::API::Client.new(:public_key => '1234')
-      expect(client).to_not be_valid
+      expect{ Marvelite::API::Client.new(:public_key => '1234') }.to raise_error(
+        Marvelite::API::Client::InvalidClientError, "You need to provide a :private_key param."
+      )
     end
 
     context 'valid' do
@@ -17,7 +19,9 @@ describe Marvelite::API::Client do
 
       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 => 'v1')
+          client = Marvelite::API::Client.new(
+            :public_key => '1234', :private_key => 'abcd', :api_version => 'v1'
+          )
           expect(client.api_version).to eq('v1')
         end
 
@@ -27,7 +31,7 @@ describe Marvelite::API::Client do
       end
 
       it 'is an instance of Marvelite::Client' do
-        expect(client).to be_valid
+        expect{ client }.to_not raise_error
         expect(client).to be_a(Marvelite::API::Client)
       end
 
@@ -38,6 +42,26 @@ describe Marvelite::API::Client do
     end
   end
 
+  describe 'etags' do
+    let(:client) { marvelite_test_client }
+    let(:etag) { '64aceb407b735957130fce343bf4933ed21a7cfc' }
+
+    before do
+      stub_304('series?apikey=123456&ts=1&hash=d4f1bab013916a533ef31e3ad5fb0887', etag)
+    end
+
+    it 'returns a NotModifiedResponse' do
+      headers = { 'If-None-Match' => "\"#{etag}\"" }
+      response = client.series(headers: headers)
+
+      expect(response).to be_a Marvelite::API::NotModifiedResponse
+      expect(response.code).to eq(304)
+      expect(response.status).to eq("Not Modified")
+      expect(response.etag).to eq(etag)
+      expect(response.data).to eq({})
+    end
+  end
+
   context "private methods" do
     describe '#ts' do
       let(:client) { Marvelite::API::Client.new(:public_key => '1234', :private_key => 'abcd') }
@@ -57,8 +81,10 @@ describe Marvelite::API::Client do
 
       it 'passes required API params to all requests' do
         client.stub(:ts).and_return('1')
-        expect(client.send(:params)).to eq({:apikey => client.public_key, :ts => '1', :hash => 'ffd275c5130566a2916217b101f26150'})
+        expect(client.send(:params)).to eq(
+          {:apikey => client.public_key, :ts => '1', :hash => 'ffd275c5130566a2916217b101f26150'}
+        )
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -34,4 +34,8 @@ RSpec.configure do |config|
     }.merge(options)
     FakeWeb.register_uri(:get, marvel_url(url), opts)
   end
-end
+
+  def stub_304(url, etag)
+    FakeWeb.register_uri(:get, marvel_url(url), status: 304, body: '', etag: etag)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marvelite
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Antonio Antillon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,20 +38,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.5
-- !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
@@ -201,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -209,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Simple wrapper around the Marvel Comics API