hugs 1.1.0 → 1.2.0

data/README.md

@@ -2,19 +2,21 @@
 
 Hugs net-http-persistent with convenient get, delete, post, and put methods.
 
-Opted to write this gem for two reasons:
+Opted to write this gem for four reasons:
 
 * [Ganeti's API](http://docs.ganeti.org/ganeti/2.2/html/rapi.html), required
   the sending of a message body with the HTTP Get request, which
   [rest-client](https://github.com/archiloque/rest-client) does not do.
 * Wanted a [fast](http://blog.segment7.net/articles/2010/05/07/net-http-is-not-slow),
   thread-safe, and persistent client.
+* [Excon](https://github.com/geemus/excon) does most everything right, but is not
+  compatible with [VCR](https://github.com/myronmarston/vcr).
+* Wanted to learn how to handle this pattern.
 
 ## Assumptions
 
-* The webservice returns JSON.
+* The webservice returns JSON or XML.
 * You want to objectify the returned JSON.
-* The message body is JSON.
 
 ## Usage
 
@@ -28,6 +30,5 @@ See the 'Examples' section in the [wiki](http://github.com/retr0h/rubineti/wiki/
 
 ### TODO
 
-* Remove HTTP Auth requirement, as mentioned in the 'Assumptions' section.
 * Move @request instance method in #response_for to local.  It was set to an instance
   for ease of testing but it bothers me.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/hugs.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hugs}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["retr0h"]
@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".bundle/config",
     ".rvmrc",
     "Gemfile",
     "Gemfile.lock",

data/lib/hugs.rb

@@ -3,7 +3,8 @@ require "yajl"
 
 class Hugs
   Headers = {
-    :json => "application/json"
+    :json => "application/json",
+    :xml  => "application/xml",
   }.freeze
 
   ##
@@ -16,11 +17,12 @@ class Hugs
   #   +scheme+: A String containing the HTTP scheme.
 
   def initialize options
-    @user        = options[:user]
-    @password    = options[:password]
-    @host        = options[:host]
-    @port        = options[:port]   || 80
-    @scheme      = options[:scheme] || "https"
+    @user     = options[:user]
+    @password = options[:password]
+    @host     = options[:host]
+    @port     = options[:port]   || 80
+    @scheme   = options[:scheme] || "https"
+    @type     = options[:type]   || :json
   end
 
   ##
@@ -35,7 +37,7 @@ class Hugs
     define_method verb do |*args|
       path   = args[0]
       params = args[1] || {}
-      clazz  = eval "Net::HTTP::#{verb.capitalize}"
+      clazz  = eval "::Net::HTTP::#{verb.capitalize}"
 
       parse response_for(clazz, path, params)
     end
@@ -62,8 +64,8 @@ private
     query = params[:query] && params.delete(:query)
     body  = params[:body] && params.delete(:body)
 
-    @http ||= Net::HTTP::Persistent.new
-    @url  ||= URI.parse "#{@scheme}://#{@host}:#{@port}"
+    @http ||= ::Net::HTTP::Persistent.new
+    @url  ||= ::URI.parse "#{@scheme}://#{@host}:#{@port}"
 
     @request      = request.new [path, query].compact.join "?"
     @request.body = encode(body) if body
@@ -73,21 +75,33 @@ private
   end
 
   def common_headers request
-    request.basic_auth(@user, @password) if @user && @password
+    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[:json]
-      when Net::HTTP::Post.to_s, Net::HTTP::Put.to_s
-        request.add_field "accept", Headers[:json]
-        request.add_field "content-type", Headers[:json]
+      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]
     end
   end
 
   def parse data
-    ::Yajl::Parser.parse data
+    ::Yajl::Parser.parse data if is_json?
   end
 
   def encode hash
-    ::Yajl::Encoder.encode hash
+    ::Yajl::Encoder.encode hash if is_json?
+  end
+
+  def requires_authentication?
+    @user && @password
+  end
+
+  def is_xml?
+    @type == :xml
+  end
+
+  def is_json?
+    @type == :json
   end
 end

data/test/support.rb

@@ -3,8 +3,6 @@ Bundler.setup :default, :test
 require "minitest/spec"
 require "mocha"
 
-#Dir[File.join "./lib", "**", "*.rb"].each { |f| require f }
-
 require "./lib/hugs"
 
 class MiniTest::Unit::TestCase

data/test/test_hugs.rb

@@ -14,15 +14,15 @@ describe Hugs do
       :scheme   => "https",
     }
 
-    @instance = Hugs.new @valid_options
+    @instance = ::Hugs.new @valid_options
   end
 
   describe "#response_for" do
     before do
       @http    = mock(:request => mock(:body => :body))
-      @request = Net::HTTP::Get
+      @request = ::Net::HTTP::Get
 
-      Net::HTTP::Persistent.stubs :new => @http
+      ::Net::HTTP::Persistent.stubs :new => @http
     end
 
     it "generates a path" do
@@ -56,19 +56,17 @@ describe Hugs do
     end
 
     describe "headers" do
-      Json_Headers_Matcher = %r{#{"application/json"}}
-
       it "has authentication" do
         @instance.send :response_for, @request, "/", {}
 
         @instance.instance_variable_get(:@request).get_fields("authorization").join.
-          must_match %r{Basic #{Base64.encode64("#{@user}:#{@password}").delete("\r\n")}}
+          must_match %r{Basic #{::Base64.encode64("#{@user}:#{@password}").delete("\r\n")}}
       end
 
       [:user, :password].each do |option|
         it "doesn't authenticate when '#{option}' missing" do
           invalid_options = @valid_options.reject { |k,v| k == option }
-          @instance       = Hugs.new invalid_options
+          @instance       = ::Hugs.new invalid_options
 
           @instance.send :response_for, @request, "/", {}
 
@@ -76,25 +74,36 @@ describe Hugs do
         end
       end
 
-      [Net::HTTP::Post, Net::HTTP::Put].each do |clazz|
-        it "has content-type and accept for '#{clazz}'" do
-          @instance.send :response_for, clazz, "/", {}
-
-          @instance.instance_variable_get(:@request).get_fields("content-type").join.
-            must_match Json_Headers_Matcher
-          @instance.instance_variable_get(:@request).get_fields("accept").join.
-            must_match Json_Headers_Matcher
-        end
-      end
-
-      [Net::HTTP::Get, Net::HTTP::Delete].each do |clazz|
-        it "has accept for '#{clazz}'" do
-          @instance.send :response_for, clazz, "/", {}
-
-          @instance.instance_variable_get(:@request).get_fields("accept").join.
-            must_match Json_Headers_Matcher
-          @instance.instance_variable_get(:@request).get_fields("content-type").
-            must_be_nil
+      [
+        { :json => "application/json" },
+        { :xml  => "application/xml" },
+      ].each do |pair|
+        pair.each_pair do |type, subtype|
+          [::Net::HTTP::Post, ::Net::HTTP::Put].each do |clazz|
+            it "has '#{subtype}' content-type and accept for '#{clazz}'" do
+              @instance = ::Hugs.new @valid_options.merge(:type => type)
+
+              @instance.send :response_for, clazz, "/", {}
+
+              @instance.instance_variable_get(:@request).get_fields("content-type").join.
+                must_match %r{#{subtype}}
+              @instance.instance_variable_get(:@request).get_fields("accept").join.
+                must_match %r{#{subtype}}
+            end
+          end
+
+          [::Net::HTTP::Get, ::Net::HTTP::Delete].each do |clazz|
+            it "has '#{subtype}' accept for '#{clazz}'" do
+              @instance = ::Hugs.new @valid_options.merge(:type => type)
+
+              @instance.send :response_for, clazz, "/", {}
+
+              @instance.instance_variable_get(:@request).get_fields("accept").join.
+                must_match %r{#{subtype}}
+              @instance.instance_variable_get(:@request).get_fields("content-type").
+                must_be_nil
+            end
+          end
         end
       end
     end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - retr0h
@@ -115,7 +115,6 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
-- .bundle/config
 - .rvmrc
 - Gemfile
 - Gemfile.lock

data/.bundle/config

@@ -1,2 +0,0 @@
---- 
-BUNDLE_DISABLE_SHARED_GEMS: "1"