hugs 2.0.0 → 2.1.0

data/Gemfile

@@ -3,6 +3,7 @@ source "http://rubygems.org"
 gem "yajl-ruby", "~> 0.7.8"
 gem "nokogiri", "~> 1.4.4"
 gem "net-http-persistent", "~> 1.4.1"
+gem "multipart-post", "~> 1.0.1"
 
 group :development do
   gem "rake"

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       git (>= 1.2.5)
       rake
     minitest (2.0.0)
+    multipart-post (1.0.1)
     net-http-persistent (1.4.1)
     nokogiri (1.4.4)
     rake (0.8.7)
@@ -23,6 +24,7 @@ PLATFORMS
 DEPENDENCIES
   jeweler (~> 1.5.1)
   minitest (~> 2.0.0)
+  multipart-post (~> 1.0.1)
   net-http-persistent (~> 1.4.1)
   nokogiri (~> 1.4.4)
   rake

data/README.md

@@ -30,3 +30,7 @@ will be implemented against an XML OCCI API.
 ### Examples
 
 See the 'Examples' section in the [wiki](http://github.com/retr0h/hugs/wiki/).
+
+## Testing
+
+    $ bundle exec rake

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/hugs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hugs}
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["retr0h"]
-  s.date = %q{2010-12-16}
+  s.date = %q{2010-12-23}
   s.email = %q{john@dewey.ws}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<yajl-ruby>, ["~> 0.7.8"])
       s.add_runtime_dependency(%q<nokogiri>, ["~> 1.4.4"])
       s.add_runtime_dependency(%q<net-http-persistent>, ["~> 1.4.1"])
+      s.add_runtime_dependency(%q<multipart-post>, ["~> 1.0.1"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_development_dependency(%q<minitest>, ["~> 2.0.0"])
@@ -53,6 +54,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<yajl-ruby>, ["~> 0.7.8"])
       s.add_dependency(%q<nokogiri>, ["~> 1.4.4"])
       s.add_dependency(%q<net-http-persistent>, ["~> 1.4.1"])
+      s.add_dependency(%q<multipart-post>, ["~> 1.0.1"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_dependency(%q<minitest>, ["~> 2.0.0"])
@@ -62,6 +64,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yajl-ruby>, ["~> 0.7.8"])
     s.add_dependency(%q<nokogiri>, ["~> 1.4.4"])
     s.add_dependency(%q<net-http-persistent>, ["~> 1.4.1"])
+    s.add_dependency(%q<multipart-post>, ["~> 1.0.1"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
     s.add_dependency(%q<minitest>, ["~> 2.0.0"])

data/lib/hugs.rb

@@ -1,6 +1,4 @@
-require "net/http/persistent"
-require "yajl"
-require "nokogiri"
+%w(net/http/persistent net/http/post/multipart yajl nokogiri).each { |r| require r }
 
 class Hugs
   Headers = {
@@ -8,7 +6,12 @@ class Hugs
     :xml  => "application/xml",
   }.freeze
 
-  Verbs = %w(get delete post put).freeze
+  Classes = [
+    Net::HTTP::Get,
+    Net::HTTP::Delete,
+    Net::HTTP::Post,
+    Net::HTTP::Put,
+  ].freeze
 
   ##
   # Required options:
@@ -36,11 +39,12 @@ class Hugs
   #   - +:body+: A sub Hash to be JSON encoded, and  posted in
   #     the message body.
 
-  Verbs.each do |verb|
+  Classes.each do |clazz|
+    verb = clazz.to_s.split("::")[-1].tr 'A-Z', 'a-z'
+
     define_method verb do |*args|
       path   = args[0]
       params = args[1] || {}
-      clazz  = eval "Net::HTTP::#{verb.capitalize}"
 
       response      = response_for(clazz, path, params)
       response.body = parse response.body
@@ -66,27 +70,40 @@ private
   # Method arguments have been documented in the callers.
 
   def response_for request, path, params
-    query = params[:query] && params.delete(:query)
-    body  = params[:body] && params.delete(:body)
+    query  = params[:query]  && params.delete(:query)
+    body   = params[:body]   && params.delete(:body)
+    upload = params[:upload] && params.delete(:upload)
 
     @http ||= Net::HTTP::Persistent.new
     @url  ||= URI.parse "#{@scheme}://#{@host}:#{@port}"
 
-    request      = request.new [path, query].compact.join "?"
-    request.body = encode(body) if body
-    common_headers request
+    if upload && request.class === Net::HTTP::Post
+      parts        = upload[:parts] || {}
+      parts[:file] = UploadIO.new(parts[:file], upload[:content_type]) if parts[:file]
+
+      request = Net::HTTP::Post::Multipart.new path_with_query(path, query), parts
+    else
+      request      = request.new path_with_query path, query
+      request.body = encode(body) if body
+
+      common_headers request
+    end
 
+    request.basic_auth(@user, @password) if requires_authentication?
     @http.request(@url, request)
   end
 
+  def path_with_query path, query
+    [path, query].compact.join "?"
+  end
+
   def common_headers request
-    request.basic_auth(@user, @password) if requires_authentication?
-    case request.class.to_s
-      when Net::HTTP::Get.to_s, Net::HTTP::Delete.to_s
-        request.add_field "accept", Headers[@type]
-      when Net::HTTP::Post.to_s, Net::HTTP::Put.to_s
-        request.add_field "accept", Headers[@type]
-        request.add_field "content-type", Headers[@type]
+    case request
+      when Net::HTTP::Get, Net::HTTP::Delete
+        request.add_field "Accept", Headers[@type]
+      when Net::HTTP::Post, Net::HTTP::Put
+        request.add_field "Accept", Headers[@type]
+        request.add_field "Content-Type", Headers[@type]
     end
   end
 

data/test/test_hugs.rb

@@ -2,10 +2,14 @@
 
 describe Hugs do
   before do
+    @scheme = "https"
+    @host   = "example.com"
+    @port   = 80
+    @base   = "#{@host}:#{@port}"
     @valid_options = {
-      :host     => "example.com",
-      :port     => 80,
-      :scheme   => "https",
+      :host     => @host,
+      :port     => @port,
+      :scheme   => @scheme,
     }
 
     WebMock.reset!
@@ -17,39 +21,91 @@ describe Hugs do
       @request = Net::HTTP::Get
     end
 
-    it "generates a path" do
-      stub_request :get, "https://example.com:80/"
+    describe "path" do
+      it "is valid" do
+        stub_request :get, "#{@scheme}://#{@base}/"
 
-      @instance.send :response_for, @request, "/", {}
+        @instance.send :response_for, @request, "/", {}
 
-      assert_requested :get, "https://example.com:80/"
-    end
+        assert_requested :get, "#{@scheme}://#{@base}/"
+      end
+
+      it "is valid when an invalid :query is supplied" do
+        stub_request :get, "#{@scheme}://#{@base}/"
+
+        @instance.send :response_for, @request, "/", :query => nil
+
+        assert_requested :get, "#{@scheme}://#{@base}/"
+      end
 
-    it "generates a path when a valid :query exists" do
-      stub_request(:get, "https://example.com:80/").with:query => {"foo" => "bar"}
+      it "also has a query string" do
+        stub_request(:get, "#{@scheme}://#{@base}/").with:query => {"foo" => "bar"}
 
-      @instance.send :response_for, @request, "/", :query => "foo=bar"
+        @instance.send :response_for, @request, "/", :query => "foo=bar"
 
-      assert_requested :get, "https://example.com:80/", :query => {"foo" => "bar"}
+        assert_requested :get, "#{@scheme}://#{@base}/", :query => {"foo" => "bar"}
+      end
     end
 
-    it "generates a path when a nil :query exists" do
-      stub_request :get, "https://example.com:80/"
+    describe "multi-part" do
+      Content_Type_Matcher = %r{multipart/form-data}
+
+      before do
+        @request = Net::HTTP::Post
+      end
+
+      it "uploads a file" do
+        stub_request :post, "#{@scheme}://#{@base}/"
 
-      @instance.send :response_for, @request, "/", :query => nil
+        upload = {
+          :upload => {
+            :parts => { :file => "/dev/null" },
+            :content_type => "type/subtype"
+          }
+        }
 
-      assert_requested :get, "https://example.com:80/"
+        @instance.send :response_for, @request, "/", upload
+
+        assert_requested :post, "#{@scheme}://#{@base}/", :body => %r{Content-Type: type/subtype}, :headers => {
+          "Content-Type" => Content_Type_Matcher
+        }
+      end
+
+      it "has parts" do
+        stub_request :post, "#{@scheme}://#{@base}/"
+
+        upload = {
+          :upload => {
+            :parts => { :foo => :bar, :baz => :xyzzy },
+            :content_type => "foo/bar"
+          }
+        }
+
+        @instance.send :response_for, @request, "/", upload
+
+        ### wtf can't use mx together.
+        content_disposition_matcher = %r{^Content-Disposition: form-data; name="foo".*^bar.*^Content-Disposition: form-data; name="baz".*^xyzzy.*}m
+        assert_requested :post, "#{@scheme}://#{@base}/", :body => content_disposition_matcher, :headers => {
+          "Content-Type" => Content_Type_Matcher
+        }
+      end
     end
 
     describe "body" do
       before do
-        stub_request :get, "https://example.com:80/"
+        stub_request :get, "#{@scheme}://#{@base}/"
       end
 
-      it "doesn't set the body when an invalid :body exists" do
+      it "is not set when :body invalid" do
         @instance.send :response_for, @request, "/", :body => nil
 
-        assert_requested :get, "https://example.com:80/", :body => nil
+        assert_requested :get, "#{@scheme}://#{@base}/", :body => nil
+      end
+
+      it "is not set when :body is missing" do
+        @instance.send :response_for, @request, "/", {}
+
+        assert_requested :get, "#{@scheme}://#{@base}/", {}
       end
 
       describe "json" do
@@ -57,10 +113,10 @@ describe Hugs do
           @instance = Hugs.new @valid_options.merge(:type => :json)
         end
 
-        it "sets the body when a valid :body exists" do
+        it "is valid" do
           @instance.send :response_for, @request, "/", :body => {:foo => :bar}
 
-          assert_requested :get, "https://example.com:80/", :body => '{"foo":"bar"}'
+          assert_requested :get, "#{@scheme}://#{@base}/", :body => '{"foo":"bar"}'
         end
       end
 
@@ -69,35 +125,35 @@ describe Hugs do
           @instance = Hugs.new @valid_options.merge(:type => :xml)
         end
 
-        it "sets the body when a valid :body exists" do
+        it "is valid" do
           @instance.send :response_for, @request, "/", :body => "foo bar"
 
-          assert_requested :get, "https://example.com:80/", :body => "foo bar"
+          assert_requested :get, "#{@scheme}://#{@base}/", :body => "foo bar"
         end
       end
     end
 
     describe "headers" do
       it "authenticates" do
-        stub_request :get, "https://user:credentials@example.com:80/"
+        stub_request :get, "#{@scheme}://user:credentials@#{@base}/"
 
         @instance = Hugs.new @valid_options.merge(:user => "user", :password => "credentials")
 
         @instance.send :response_for, @request, "/", {}
 
-        assert_requested :get, "https://user:credentials@example.com:80/"
+        assert_requested :get, "#{@scheme}://user:credentials@#{@base}/"
       end
 
       [:user, :password].each do |option|
         it "doesn't authenticate when '#{option}' missing" do
-          stub_request :get, "https://example.com:80/"
+          stub_request :get, "#{@scheme}://#{@base}/"
 
           invalid_options = @valid_options.reject { |k,v| k == option }
           @instance       = Hugs.new invalid_options
 
           @instance.send :response_for, @request, "/", {}
 
-          assert_requested :get, "https://example.com:80/"
+          assert_requested :get, "#{@scheme}://#{@base}/"
         end
       end
 
@@ -110,13 +166,13 @@ describe Hugs do
             clazz = eval "Net::HTTP::#{verb.capitalize}"
 
             it "has '#{subtype}' Content-Type and Accept for '#{clazz}'" do
-              stub_request verb, "https://example.com:80/"
+              stub_request verb, "#{@scheme}://#{@base}/"
 
               @instance = Hugs.new @valid_options.merge(:type => type)
 
               @instance.send :response_for, clazz, "/", {}
 
-              assert_requested verb, "https://example.com:80/", :headers => {
+              assert_requested verb, "#{@scheme}://#{@base}/", :headers => {
                 "Accept" => ["*/*", subtype], "Content-Type" => subtype }
             end
           end
@@ -125,13 +181,13 @@ describe Hugs do
             clazz = eval "Net::HTTP::#{verb.capitalize}"
 
             it "has '#{subtype}' Accept for '#{clazz}'" do
-              stub_request verb, "https://example.com:80/"
+              stub_request verb, "#{@scheme}://#{@base}/"
 
               @instance = Hugs.new @valid_options.merge(:type => type)
 
               @instance.send :response_for, clazz, "/", {}
 
-              assert_requested verb, "https://example.com:80/", :headers => {
+              assert_requested verb, "#{@scheme}://#{@base}/", :headers => {
                 "Accept" => ["*/*", subtype] }
             end
           end
@@ -146,8 +202,8 @@ describe Hugs do
         @instance = Hugs.new @valid_options.merge(:type => :json)
       end
 
-      it "objectifies the json and returns a hash" do
-        stub_request(:get, "https://example.com:80/").to_return :body => '{"foo":"bar"}'
+      it "objectifies and returns a hash" do
+        stub_request(:get, "#{@scheme}://#{@base}/").to_return :body => '{"foo":"bar"}'
 
         response = @instance.get "/", :body => { :foo => :bar }
 
@@ -160,8 +216,8 @@ describe Hugs do
         @instance = Hugs.new @valid_options.merge(:type => :xml)
       end
 
-      it "parses xml and returns a Nokogiri object" do
-        stub_request(:get, "https://example.com:80/").to_return :body => "<STORAGE></STORAGE>"
+      it "parses and returns a Nokogiri object" do
+        stub_request(:get, "#{@scheme}://#{@base}/").to_return :body => "<STORAGE></STORAGE>"
 
         response = @instance.get "/", :body => { :foo => :bar }
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
+  - 1
   - 0
-  - 0
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - retr0h
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 -08:00
+date: 2010-12-23 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,8 +63,23 @@ dependencies:
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: multipart-post
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,10 +89,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -89,10 +104,10 @@ dependencies:
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: minitest
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -104,10 +119,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: webmock
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -119,7 +134,7 @@ dependencies:
         version: 1.6.1
   type: :development
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 description: 
 email: john@dewey.ws
 executables: []