hyperclient 0.0.4 → 0.0.5

data/Readme.md

@@ -1,10 +1,13 @@
-# Hyperclient [![Build Status](https://secure.travis-ci.org/codegram/hyperclient.png)](http://travis-ci.org/codegram/hyperclient) [![Dependency Status](https://gemnasium.com/codegram/hyperclient.png)](http://gemnasium.com/codegram/hyperclient)
+# Hyperclient 
+[![Build Status](https://secure.travis-ci.org/codegram/hyperclient.png)](http://travis-ci.org/codegram/hyperclient) 
+[![Dependency Status](https://gemnasium.com/codegram/hyperclient.png)](http://gemnasium.com/codegram/hyperclient)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/codegram/hyperclient)
 
 Hyperclient is a Ruby Hypermedia API client written in Ruby.
 
 ## Documentation
 
-[Hyperclient on documentup][documentup] and [Hyperclient API documentation on rdoc.info][rdoc]
+[Hyperclient API documentation on rdoc.info][rdoc]
 
 ## Usage
 
@@ -16,6 +19,7 @@ class MyAPIClient
 
   entry_point 'http://myapp.com/api'
   auth :digest, 'user', 'password'
+  http_options {headers: {'accept-encoding' => 'deflate, gzip'}}
 end
 ````
 

data/examples/{cs.rb → cyberscore.rb}

@@ -1,9 +1,29 @@
 require 'hyperclient'
 
-class HalShop
+class Cyberscore
   include Hyperclient
 
   entry_point 'http://cs-api.heroku.com/api/'
+
+  def news
+    links.feeds.links.submissions.resources.news
+  end
+
+  def submissions
+    links.feeds.links.submissions.resources.submissions
+  end
+
+  def games
+    links.feeds.links.games.resources.games
+  end
+
+  def add_game(name)
+    links.feeds.links.submissions.post({name: name})
+  end
+
+  def motd
+    attributes['motd']
+  end
 end
 
 def print_resources(resources)
@@ -23,7 +43,7 @@ def print_games(games)
 end
 
 
-api = HalShop.new
+api = Cyberscore.new
 
 puts "Let's inspect the API:"
 puts "\n"
@@ -33,7 +53,7 @@ print_resources(api.links)
 puts "\n"
 
 puts 'How is the server feeling today?'
-puts api.attributes['motd']
+puts api.motd
 puts "\n"
 
 puts "Let's read the feeds:"
@@ -41,4 +61,4 @@ print_resources(api.links.feeds.links)
 puts "\n"
 
 puts "I like games!"
-print_games(api.links.feeds.links.games.resources.games)
+print_games(api.games)

data/lib/hyperclient/http.rb

@@ -25,6 +25,7 @@ module Hyperclient
     def initialize(resource, options = {})
       @resource = resource
       authenticate(options[:auth]) if options && options.include?(:auth)
+      headers(options[:headers]) if options && options.include?(:headers)
     end
 
     # Public: Sends a GET request the the resource url.
@@ -74,7 +75,7 @@ module Hyperclient
     end
 
     private
-    # Internal: Sets the authenitcation method for HTTParty.
+    # Internal: Sets the authentication method for HTTParty.
     #
     # options - An options Hash to set the authentication options.
     #           :type        - A String or Symbol to set the authentication type.
@@ -86,5 +87,17 @@ module Hyperclient
       auth_method = options[:type].to_s + '_auth'
       self.class.send(auth_method, *options[:credentials])
     end
+
+    # Internal: Adds default headers for all the requests.
+    #
+    # headers - A Hash with the header.
+    #
+    # Example:
+    #   headers({'accept-encoding' => 'deflate, gzip'})
+    #
+    # Returns nothing.
+    def headers(headers)
+      self.class.send(:headers, headers)
+    end
   end
 end

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/hyperclient.rb

@@ -52,8 +52,16 @@ module Hyperclient
       http_options({auth: {type: type, credentials: [user, password]}})
     end
 
-    # Public: Returns a Hash with the HTTP options that will be used to
-    # initialize Hyperclient::HTTP.
+    # Public: Sets the HTTP options that will be used to initialize
+    # Hyperclient::HTTP.
+    #
+    # options - A Hash with options to pass to HTTP.
+    #
+    # Example:
+    #
+    #   http_options {headers: {'accept-encoding' => 'deflate, gzip'}}
+    #
+    # Returns a Hash.
     def http_options(options = {})
       @@http_options ||= {}
       @@http_options.merge!(options)

data/test/hyperclient/http_test.rb

@@ -23,6 +23,18 @@ module Hyperclient
       end
     end
 
+    describe 'headers' do
+      it 'sets headers from the given option' do
+        http = HTTP.new(resource, {headers: {'accept-encoding' => 'deflate, gzip'}})
+
+        stub_request(:get, 'api.example.org/productions/1').
+          with(headers: {'Accept-Encoding' => 'deflate, gzip'}).
+          to_return(body: 'This is the resource')
+
+        http.get
+      end
+    end
+
     describe 'get' do
       it 'sends a GET request and returns the response body' do
         stub_request(:get, 'api.example.org/productions/1').

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -92,7 +92,7 @@ files:
 - MIT-LICENSE
 - Rakefile
 - Readme.md
-- examples/cs.rb
+- examples/cyberscore.rb
 - examples/hal_shop.rb
 - hyperclient.gemspec
 - lib/hyperclient.rb
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 12208377733581260
+      hash: -2046368484385540531
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 12208377733581260
+      hash: -2046368484385540531
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23