hugs 1.0.0

data/.bundle/config

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p0@hugs

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "yajl-ruby", "~> 0.7.8"
+gem "net-http-persistent", "~> 1.4.1"
+
+group :development do
+  gem "rake"
+  gem "jeweler", "~> 1.5.1"
+  gem "minitest", "~> 2.0.0"
+  gem "mocha", "~> 0.9.10"
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.0.0)
+    mocha (0.9.10)
+      rake
+    net-http-persistent (1.4.1)
+    rake (0.8.7)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.5.1)
+  minitest (~> 2.0.0)
+  mocha (~> 0.9.10)
+  net-http-persistent (~> 1.4.1)
+  rake
+  yajl-ruby (~> 0.7.8)

data/LICENSE

@@ -0,0 +1,4 @@
+"THE BEER-WARE LICENSE" (Revision 42):
+<john@dewey.ws> wrote this file. As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer in return John-B Dewey Jr.

data/README.md

@@ -0,0 +1,34 @@
+# Hugs
+
+Hugs net-http-persistent with convenient get, delete, post, and put methods.
+
+Opted to write this gem for two 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.
+
+## Assumptions
+
+* The webservice returns JSON.
+* You want to objectify the returned JSON.
+* The message body is JSON.
+* The webservice requires basic auth (will remove this requirement shortly).
+
+## Usage
+
+### Bundler
+
+    gem "hugs"
+
+### Examples
+
+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/Rakefile

@@ -0,0 +1,25 @@
+require "rubygems"
+require "rake"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hugs"
+    gem.summary = %Q{Hugs net-http-persistent with convenient get, delete, post, and put methods.}
+    gem.email = "john@dewey.ws"
+    gem.homepage = "http://github.com/retr0h/hugs"
+    gem.authors = ["retr0h"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs   << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/hugs.rb

@@ -0,0 +1,93 @@
+require "net/http/persistent"
+require "yajl"
+
+class Hugs
+  Headers = {
+    :json => "application/json"
+  }.freeze
+
+  ##
+  # Required options:
+  #   +user+: A String containing the username for use in HTTP Basic auth.
+  #   +password+: A String containing the password for use in HTTP Basic auth.
+  #   +host+: A String with the host to connect.
+  # Optional:
+  #   +port+: An Integer containing the port to connect.
+  #   +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"
+  end
+
+  ##
+  # Perform an HTTP get, delete, post, or put.
+  # +path+: A String with the path to the HTTP resource.
+  # +params+: A Hash with the following keys:
+  #   - +:query+: Query String in the format "foo=bar"
+  #   - +:body+: A sub Hash to be JSON encoded, and  posted in
+  #     the message body.
+
+  %w(get delete post put).each do |verb|
+    define_method verb do |*args|
+      path   = args[0]
+      params = args[1] || {}
+      clazz  = eval "Net::HTTP::#{verb.capitalize}"
+
+      parse response_for(clazz, path, params)
+    end
+  end
+
+  ##
+  # :method: get
+
+  ##
+  # :method: delete
+
+  ##
+  # :method: post
+
+  ##
+  # :method: put
+
+private
+  ##
+  # Worker method to be called by #get, #delete, #post, #put.
+  # 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)
+
+    @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
+
+    @http.request(@url, @request).body
+  end
+
+  def common_headers request
+    request.basic_auth @user, @password
+    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]
+    end
+  end
+
+  def parse data
+    ::Yajl::Parser.parse data
+  end
+
+  def encode hash
+    ::Yajl::Encoder.encode hash
+  end
+end

data/test/support.rb

@@ -0,0 +1,13 @@
+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
+end
+
+MiniTest::Unit.autorun

data/test/test_hugs.rb

@@ -0,0 +1,91 @@
+require "support"
+require "base64"
+require "hugs"
+
+describe Hugs do
+  before do
+    @user          = "user",
+    @password      = "credentials"
+    @valid_options = {
+      :user     => @user,
+      :password => @password,
+      :host     => "example.com",
+      :port     => 80,
+      :scheme   => "https",
+    }
+
+    @instance = Hugs.new @valid_options
+  end
+
+  describe "#response_for" do
+    before do
+      @http    = mock(:request => mock(:body => :body))
+      @request = Net::HTTP::Get
+
+      Net::HTTP::Persistent.stubs :new => @http
+    end
+
+    it "generates a path" do
+      @instance.send :response_for, @request, "/", {}
+
+      @instance.instance_variable_get(:@request).path.must_equal "/"
+    end
+
+    it "generates a path when a valid :query exists" do
+      @instance.send :response_for, @request, "/", :query => "foo=bar"
+
+      @instance.instance_variable_get(:@request).path.must_equal "/?foo=bar"
+    end
+
+    it "generates a path when a nil :query exists" do
+      @instance.send :response_for, @request, "/", :query => nil
+
+      @instance.instance_variable_get(:@request).path.must_equal "/"
+    end
+
+    it "sets the body as JSON when a valid :body exists" do
+      @instance.send :response_for, @request, "/", :body => {:foo => :bar}
+
+      @instance.instance_variable_get(:@request).body.must_equal '{"foo":"bar"}'
+    end
+
+    it "doesn't set the body when an invalid :body exists" do
+      @instance.send :response_for, @request, "/", :body => nil
+
+      @instance.instance_variable_get(:@request).body.must_be_nil
+    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")}}
+      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
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: hugs
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- retr0h
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 8
+        version: 0.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: net-http-persistent
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 10
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: 
+email: john@dewey.ws
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .bundle/config
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/hugs.rb
+- test/support.rb
+- test/test_hugs.rb
+has_rdoc: true
+homepage: http://github.com/retr0h/hugs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Hugs net-http-persistent with convenient get, delete, post, and put methods.
+test_files: 
+- test/support.rb
+- test/test_hugs.rb