hugs 2.6.0 → 2.7.0

data/README.md

@@ -41,9 +41,3 @@ ruby 1.9.2
 Tests can run offline thanks to [webmock](https://github.com/bblimke/webmock).
 
     $ bundle exec rake
-
-## TODOs
-
-* avoid the parse (eg client.raw)
-* override type per request
-* support hased query params

data/hugs.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "hugs"
   s.version     = Hugs::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["John Dewey"]
-  s.email       = ["john@dewey.ws"]
+  s.authors     = ["John Dewey", "Josh Kleinpeter"]
+  s.email       = ["john@dewey.ws", "josh@kleinpeter.org"]
   s.homepage    = %q{http://github.com/retr0h/hugs}
   s.summary     = %q{Hugs net-http-persistent with convenient get, delete, post, and put methods.}
 
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
   s.add_dependency "yajl-ruby", "~> 0.7.9"
   s.add_dependency "nokogiri", "~> 1.4.4"
   s.add_dependency "net-http-persistent", "~> 1.4.1"
-  s.add_dependency "multipart-post", "~> 1.0.1"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "webmock"

data/lib/hugs/client.rb

@@ -11,6 +11,7 @@ module Hugs
       :binary => "application/octet-stream",
       :json   => "application/json",
       :xml    => "application/xml",
+      :none   => "text/plain"
     }.freeze
 
     CLASSES = [
@@ -25,24 +26,22 @@ module Hugs
     # Required options:
     #   +host+: A String with the host to connect.
     # Optional:
-    #   +user+:    A String containing the username for use in HTTP Basic Authentication.
-    #   +pass+:    A String containing the password for use in HTTP Basic Authentication.
-    #   +port+:    An Integer containing the port to connect.
-    #   +scheme+:  A String containing the HTTP scheme.
-    #   +type+:    A Symbol containing (:json or :xml) for automatic content-type parsing
-    #              and encoding.
-    #   +headers+: A Hash containing HTTP headers.
-    #   +raises+:  A boolean if HTTP 4xx and 5xx status codes should be raised.
+    #   +user+: A String containing the username for use in HTTP Basic Authentication.
+    #   +pass+: A String containing the password for use in HTTP Basic Authentication.
+    #   +port+: An Integer containing the port to connect.
+    #   +scheme+: A String containing the HTTP scheme.
+    #   +type+: A Symbol containing (:json or :xml) for automatic content-type parsing
+    #           and encoding.
+    #   +raises+: A boolean if HTTP 4xx and 5xx status codes should be raised.
 
     def initialize options
       @user    = options[:user]
       @pass    = options[:password]
       host     = options[:host]
       raises   = options[:raise_errors]
-      port     = options[:port]    || 80
-      scheme   = options[:scheme]  || "http"
-      @type    = options[:type]    || :json
-      @headers = options[:headers] || {}
+      port     = options[:port]   || 80
+      scheme   = options[:scheme] || "http"
+      @type    = options[:type]   || :json
 
       @http   = Net::HTTP::Persistent.new
       @errors = Errors::HTTP.new :raise_errors => raises
@@ -53,14 +52,6 @@ module Hugs
 
     ##
     # Perform an HTTP Delete, Head, Get, Post, or Put.
-    #
-    # +path+: A String with the path to the HTTP resource.
-    # +params+: A Hash with the following keys:
-    #   +:query+:    A String with the format "foo=bar".
-    #   +:body+:     A String containing the message body for Put and Post requests.
-    #   +:upload+:   A Hash with the following keys:
-    #     +file+:    The file to be HTTP chunked uploaded.
-    #     +headers+: A Hash containing additional HTTP headers.
 
     CLASSES.each do |clazz|
       verb = clazz.to_s.split("::").last.downcase
@@ -92,74 +83,102 @@ module Hugs
     ##
     # Worker method to be called by #delete, #get, #head, #post, or #put.
     #
-    # Method arguments have been documented in the callers.
+    # +clazz+: A Net::HTTP request Object.
+    # +path+: A String with the path to the HTTP resource.
+    # +params+: A Hash containing the following keys:
+    #   +:query+: A String with the format "foo=bar".
+    #   +:type+: A Symbol with the mime_type.
+    #   +:body+: A String containing the message body for Put and Post requests.
+    #   +:upload+: A sub-Hash with the following keys:
+    #     +:file+: The file to be HTTP chunked uploaded.
+    #     +:headers+: A Hash containing additional HTTP headers.
 
     def response_for clazz, path, params
       request      = clazz.new path_with_query path, params[:query]
-      request.body = encode params[:body]
+      request.body = encode params[:body], params[:type]
 
-      handle_request request, params[:upload]
+      handle_request request, params[:upload], params[:type], params[:headers] || {}
     end
 
     ##
     # Handles setting headers, performing the HTTP connection, parsing the
     # response, and checking for any response errors (if configured).
     #
-    # +request+: A net/http request Object.
+    # +request+: A Net::HTTP request Object.
+    # +:upload+: A sub-Hash with the following keys:
+    #   +:file+: The file to be HTTP chunked uploaded.
+    #   +:headers+: A Hash containing additional HTTP headers.
+    # +:type+: A Symbol with the mime_type.
+    # +:headers+: A Hash containing additional HTTP headers.
 
-    def handle_request request, upload
-      uploads request, upload
-      headers request, upload
+    def handle_request request, upload, type, headers
+      handle_uploads request, upload, type
+      handle_headers request, upload, type, headers
 
       response      = @http.request @uri, request
-      response.body = parse response.body
+      response.body = parse response.body, type
 
-      request.body_stream.close if request.body_stream
+      finish_uploads request
 
-      @errors.errors response
+      @errors.on response
     end
 
     ##
     # Handle chunked uploads.
     #
-    # +request+: A net/http request Object.
-    # +upload+:  A Hash containing :file and :headers for uploading.
+    # +request+: A Net::HTTP request Object.
+    # +upload+: A Hash with the following keys:
+    #   +:file+: The file to be HTTP chunked uploaded.
+    #   +:headers+: A Hash containing additional HTTP headers.
+    # +:type+: A Symbol with the mime_type.
 
-    def uploads request, upload
+    def handle_uploads request, upload, type
       return unless upload
 
-      @headers.merge! chunked_headers upload if upload
-
       request.body_stream = File.open upload[:file]
     end
 
+    ##
+    # Close filehandles used for chunked uploads.
+    #
+    # +request+: A Net::HTTP request Object.
+
+    def finish_uploads request
+      request.body_stream.close if request.body_stream
+    end
+
     ##
     # Handles the setting of various default and custom headers.
     # Headers set in initialize can override all others.
     #
-    # +request+: A net/http request Object.
+    # +request+: A Net::HTTP request Object.
+    # +upload+: A Hash with the following keys:
+    # +:type+: A Symbol with the mime_type.
+    # +:headers+: A Hash containing additional HTTP headers.
 
-    def headers request, upload
+    def handle_headers request, upload, type, headers
       request.basic_auth(@user, @pass) if requires_authentication?
 
-      request.add_field "Accept", MIME_TYPES[@type]
-      request.add_field "Content-Type", MIME_TYPES[@type] if requires_content_type? request
+      request.add_field "Accept", mime_type(type)
+      request.add_field "Content-Type", mime_type(type) if requires_content_type? request
 
-      @headers.each do |header, value|
+      headers.merge! chunked_headers upload
+      headers.each do |header, value|
         request[header] = value
-      end if @headers
+      end
     end
 
     ##
     # Setting of chunked upload headers.
     #
-    # +:upload+:   A Hash with the following keys:
-    #   +file+:    The file to be HTTP chunked uploaded.
-    #   +headers+: A Hash containing additional HTTP headers.
+    # +upload+: A Hash with the following keys:
+    #   +:file+: The file to be HTTP chunked uploaded.
 
     def chunked_headers upload
+      return {} unless upload
+
       chunked_headers = {
-        "Content-Type"      => MIME_TYPES[:binary],
+        "Content-Type"      => mime_type(:binary),
         "Content-Length"    => File.size(upload[:file]),
         "Transfer-Encoding" => "chunked"
       }.merge upload[:headers] || {}
@@ -169,22 +188,22 @@ module Hugs
       [path, query].compact.join "?"
     end
 
-    def parse data
+    def parse data, type
       return unless data
 
-      if is_json?
+      if is_json? type
         Yajl::Parser.parse data
-      elsif is_xml?
+      elsif is_xml? type
         Nokogiri::XML.parse data
       else
         data
       end
     end
 
-    def encode body
+    def encode body, type
       return unless body
 
-      is_json? ? (Yajl::Encoder.encode body) : body
+      (is_json? type) ? (Yajl::Encoder.encode body) : body
     end
 
     def requires_authentication?
@@ -195,12 +214,16 @@ module Hugs
       [Net::HTTP::Post, Net::HTTP::Put].include? request.class
     end
 
-    def is_xml?
-      @type == :xml
+    def is_xml? type
+      (mime_type type) =~ %r{/xml$}
+    end
+
+    def is_json? type
+      (mime_type type) =~ %r{/json$}
     end
 
-    def is_json?
-      @type == :json
+    def mime_type type
+      MIME_TYPES[type] || MIME_TYPES[@type]
     end
   end
 end

data/lib/hugs/errors.rb

@@ -42,11 +42,11 @@ module Hugs
     class HTTP
       def initialize options
         @raise_errors = options[:raise_errors]
-        
+
         initialize_errors
       end
 
-      def errors response
+      def on response
         case response.code
           when @raise_errors && %r{^[45]{1}[0-9]{2}$} ; raise_for(response)
         end

data/lib/hugs/version.rb

@@ -1,3 +1,3 @@
 module Hugs
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

data/test/lib/hugs/client_test.rb

@@ -69,29 +69,44 @@ describe Hugs::Client do
       end
     end
 
-    describe "custom" do
+    describe "override :headers per request" do
       before do
         @client = Hugs::Client.new(
-          :host    => @uri.host,
-          :headers => { "foo" => "bar", "baz" => "xyzzy" }
+          :host => @uri.host
         )
       end
 
       it "adds headers" do
-        must_have_headers_for :get, {}, "foo" => "bar", "baz" => "xyzzy"
+        must_have_headers_for :get, { :headers => { "foo" => "bar" } }, "foo" => "bar"
+      end
+
+      it "overrides default headers" do
+        must_have_headers_for :get, { :headers => { "Accept" => "foo bar" } }, "Accept" => "foo bar"
       end
     end
 
-    describe "custom override defaults" do
+    describe "override :type per request" do
       before do
         @client = Hugs::Client.new(
-          :host    => @uri.host,
-          :headers => { "Accept" => "foo bar" }
+          :host => @uri.host
         )
       end
 
-      it "replaces headers" do
-        must_have_headers_for :get, {}, "Accept" => "foo bar"
+      it "adds Accept header" do
+        must_have_headers_for_get :xml, :type => :xml
+      end
+
+      it "adds Content-Type header" do
+        must_have_headers_for_put :xml, :type => :xml
+        must_have_headers_for_post :xml, :type => :xml
+      end
+
+      it "doesn't parse body" do
+        stub_request(:get, @uri.to_s).to_return :body => "raw body"
+
+        response = @client.get @uri.path, :type => :none
+
+        response.body.must_equal "raw body"
       end
     end
   end
@@ -139,6 +154,20 @@ describe Hugs::Client do
         response.body.xpath('foo').text.must_equal "bar"
       end
     end
+
+    describe "none" do
+      before do
+        @client = Hugs::Client.new :host => @uri.host, :type => :none
+      end
+
+      it "doesn't parse body" do
+        stub_request(:get, @uri.to_s).to_return :body => "raw body"
+
+        response = @client.get @uri.path, :type => :none
+
+        response.body.must_equal "raw body"
+      end
+    end
   end
 
   describe "encode body" do
@@ -182,7 +211,7 @@ describe Hugs::Client do
         }
       end
 
-      it "has chunked headers" do
+      it "has headers" do
         must_have_headers_for :post, @upload, {
           "Content-Type"      => "application/octet-stream",
           ###"Content-Length"    => "0",
@@ -190,7 +219,7 @@ describe Hugs::Client do
         }
       end
 
-      it "upload headers override default headers" do
+      it "overrides default headers" do
         must_have_headers_for :post, @upload_with_headers, "Accept" => "foo bar"
       end
 
@@ -257,16 +286,16 @@ describe Hugs::Client do
     assert_requested verb, @uri.to_s
   end
 
-  def must_have_headers_for_get type
-    must_have_headers_for :get, {}, "Accept" => ["*/*", "application/#{type}"]
+  def must_have_headers_for_get type, options = {}
+    must_have_headers_for :get, options, "Accept" => ["*/*", "application/#{type}"]
   end
 
-  def must_have_headers_for_put type
-    must_have_headers_for :put, {}, "Content-Type" => "application/#{type}"
+  def must_have_headers_for_put type, options = {}
+    must_have_headers_for :put, options, "Content-Type" => "application/#{type}"
   end
 
-  def must_have_headers_for_post type
-    must_have_headers_for :post, {}, "Content-Type" => "application/#{type}"
+  def must_have_headers_for_post type, options = {}
+    must_have_headers_for :post, options, "Content-Type" => "application/#{type}"
   end
 
   def must_have_headers_for verb, options, headers

metadata

@@ -2,15 +2,16 @@
 name: hugs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors: 
 - John Dewey
+- Josh Kleinpeter
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-05-17 00:00:00 -07:00
+date: 2011-06-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,53 +47,43 @@ dependencies:
         version: 1.4.1
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: multipart-post
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.1
-  type: :runtime
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: minitest
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id007
+  version_requirements: *id006
 description: 
 email: 
 - john@dewey.ws
+- josh@kleinpeter.org
 executables: []
 
 extensions: []