rest 1.0.0 → 1.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    rest (1.0.0)
+      rest-client (>= 0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.0.11)
+    mime-types (1.18)
+    net-http-persistent (2.7)
+    rake (0.9.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    test-unit (2.5.0)
+    typhoeus (0.4.2)
+      ffi (~> 1.0)
+      mime-types (~> 1.18)
+    uber_config (0.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  net-http-persistent
+  rake
+  rest!
+  test-unit
+  typhoeus
+  uber_config

data/README.md

@@ -0,0 +1,66 @@
+Rest Wrapper
+-------------
+
+HTTP/REST client wrapper that provides a standard interface for making http requests using different http clients.
+If no client is specified it will choose the best one you have installed.
+
+Getting Started
+==============
+
+Install the gem:
+
+    gem install rest
+
+Create an Rest client:
+
+    @rest = Rest::Client.new()
+
+To choose a specific underlying http client lib:
+
+    @rest = Rest::Client.new(:gem=>:typhoeus)
+
+Supported http libraries are:
+
+* rest-client
+* net-http-persistent
+* typhoeus
+
+Then use it:
+
+GET
+=========
+
+    @rest.get(url, options...)
+
+options:
+
+- :params => query params for url
+- :headers => headers
+
+POST
+======
+
+    @rest.post(url, options...)
+
+options:
+
+- :body => POST body
+- :headers => headers
+
+PUT
+======
+
+    @rest.put(url, options...)
+
+options:
+
+- :body => POST body
+- :headers => headers
+
+DELETE
+======
+
+    @rest.delete(url, options...)
+
+
+

data/lib/rest/client.rb

@@ -20,33 +20,12 @@ module Rest
   end
 
   def self.puts(s)
-    Kernel.puts(s)
-  end
-
-
-  def self.gem=(g)
-    @gem = g
-  end
-
-  def self.gem
-    @gem
-  end
-
-  begin
-    require 'typhoeus'
-    Rest.gem = :typhoeus
-    Rest.puts "Using typhoeus gem."
-    require_relative 'wrappers/typhoeus_wrapper'
-  rescue LoadError => ex
-    Rest.puts "Please install 'typhoeus' gem for best performance."
-    require 'rest_client'
-    Rest.gem = :rest_client
-    require_relative 'wrappers/rest_client_wrapper'
+    Kernel.puts("rest gem: #{s}")
   end
 
   class Client
 
-    attr_accessor :options
+    attr_accessor :options, :logger, :gem
     # options:
     # - :gem => specify gem explicitly
     #
@@ -55,14 +34,43 @@ module Rest
       @logger.level=Logger::INFO
       @options = options
 
-      Rest.gem = options[:gem] if options[:gem]
+      @gem = options[:gem] if options[:gem]
 
-      if Rest.gem == :typhoeus
+      if @gem.nil?
+        choose_best_gem()
+      end
+
+      if @gem == :typhoeus
+        require_relative 'wrappers/typhoeus_wrapper'
         @wrapper = Rest::Wrappers::TyphoeusWrapper.new
+        Rest.puts "Using typhoeus gem."
+      elsif @gem == :net_http_persistent
+        require_relative 'wrappers/net_http_persistent_wrapper'
+        @wrapper = Rest::Wrappers::NetHttpPersistentWrapper.new(self)
+        Rest.puts "Using net-http-persistent gem."
       else
+        require_relative 'wrappers/rest_client_wrapper'
         @wrapper = Rest::Wrappers::RestClientWrapper.new
+        Rest.puts "Using rest-client gem. Please install 'typhoeus' or net-http-persistent gem for best performance."
       end
+    end
 
+    def choose_best_gem
+      begin
+        raise LoadError
+        require 'typhoeus'
+        @gem = :client
+      rescue LoadError => ex
+        begin
+          # try net-http-persistent
+          require 'net/http/persistent'
+          @gem = :net_http_persistent
+
+        rescue LoadError => ex
+         require 'rest_client'
+          @gem = :rest_client
+        end
+      end
     end
 
     def get(url, req_hash={})
@@ -84,11 +92,11 @@ module Rest
         #p res.code
         if res.code == 503
           pow = (4 ** (current_retry)) * 100 # milliseconds
-          #puts 'pow=' + pow.to_s
+                                             #puts 'pow=' + pow.to_s
           s = Random.rand * pow
-          #puts 's=' + s.to_s
+                                             #puts 's=' + s.to_s
           sleep_secs = 1.0 * s / 1000.0
-          #puts 'sleep for ' + sleep_secs.to_s
+                                             #puts 'sleep for ' + sleep_secs.to_s
           current_retry += 1
           @logger.debug "503 Error. Retrying #{current_retry} out of #{max_retries} max."
           sleep sleep_secs
@@ -125,5 +133,10 @@ module Rest
       end
       return res
     end
+
+    def close
+      @wrapper.close
+    end
+
   end
 end

data/lib/rest/version.rb

@@ -1,3 +1,3 @@
 module Rest
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/rest/wrappers/base_wrapper.rb

@@ -0,0 +1,7 @@
+class BaseWrapper
+
+  # if wrapper has a close/shutdown, override this
+  def close
+
+  end
+end

data/lib/rest/wrappers/net_http_persistent_wrapper.rb

@@ -0,0 +1,158 @@
+require 'net/http/persistent'
+require_relative 'base_wrapper'
+
+module Rest
+
+  module Wrappers
+    class NetHttpPersistentExceptionWrapper < ClientError
+      def initialize(ex)
+        super(ex.message)
+        @ex = ex
+      end
+    end
+
+    class NetHttpPersistentResponseWrapper
+      def initialize(response)
+        @response = response
+      end
+
+      def code
+        @response.code.to_i
+      end
+
+      def body
+        @response.body
+      end
+
+    end
+
+    class NetHttpPersistentWrapper < BaseWrapper
+
+      attr_reader :http
+
+      def initialize(client)
+        @client = client
+        @http = Net::HTTP::Persistent.new 'rest_gem'
+      end
+
+      def default_headers
+        {}
+      end
+
+      def add_headers(post, req_hash, default_headers)
+        headers = {}
+        headers.merge!(default_headers)
+        headers.merge!(req_hash[:headers]) if req_hash[:headers]
+        headers.each_pair do |k, v|
+          post[k] = v
+        end
+      end
+
+      def get(url, req_hash={}, options={})
+        @client.logger.debug "limit #{options[:limit]}"
+        options[:limit] ||= 10
+        response = nil
+        begin
+
+          uri = URI(url)
+          #p uri
+          #p uri.path
+          post = Net::HTTP::Get.new fix_path(uri.path)
+          add_headers(post, req_hash, default_headers)
+          response = http.request uri, post
+          @client.logger.debug response.class.name
+          case response
+            when Net::HTTPRedirection
+              @client.logger.debug "moved to #{response['location']}"
+              response = get(response['location'], req_hash, {limit: options[:limit]-1})
+            when Net::HTTPMovedPermanently
+              @client.logger.debug "moved to #{response['location']}"
+              response = get(response['location'], req_hash, {limit: options[:limit]-1})
+          end
+          response = NetHttpPersistentResponseWrapper.new(response)
+        rescue Net::HTTPClientError => ex
+          if ex.code == 404
+            return NetHttpPersistentResponseWrapper.new(ex)
+          end
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        rescue Net::HTTPServerError => ex
+          if ex.code == 404
+            return NetHttpPersistentResponseWrapper.new(ex)
+          end
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        end
+        response
+      end
+
+      def fix_path(path)
+        return "/" if path.nil? || path == ""
+        path
+      end
+
+
+      def post(url, req_hash={})
+        response = nil
+        begin
+          uri = URI(url)
+          post = Net::HTTP::Post.new uri.path
+          add_headers(post, req_hash, default_headers)
+          post.body = stringed_body(req_hash[:body]) if req_hash[:body]
+          response = http.request uri, post
+          response = NetHttpPersistentResponseWrapper.new(response)
+        rescue Net::HTTPClientError => ex
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        rescue Net::HTTPServerError => ex
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        end
+        response
+      end
+
+      def stringed_body(body)
+        return nil unless body
+        if body.is_a?(Hash)
+          return body.to_json
+        end
+        body
+      end
+
+      def put(url, req_hash={})
+        response = nil
+        begin
+          uri = URI(url)
+          post = Net::HTTP::Put.new uri.path
+          add_headers(post, req_hash, default_headers)
+          post.body = stringed_body(req_hash[:body]) if req_hash[:body]
+          response = http.request uri, post
+          response = NetHttpPersistentResponseWrapper.new(response)
+        rescue Net::HTTPClientError => ex
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        rescue Net::HTTPServerError => ex
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        end
+        response
+      end
+
+      def delete(url, req_hash={})
+        response = nil
+        begin
+          uri = URI(url)
+          post = Net::HTTP::Delete.new uri.path
+          add_headers(post, req_hash, default_headers)
+          response = http.request uri, post
+          response = NetHttpPersistentResponseWrapper.new(response)
+        rescue Net::HTTPClientError => ex
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        rescue Net::HTTPServerError => ex
+          raise NetHttpPersistentExceptionWrapper.new(ex)
+        end
+        response
+      end
+
+      def close
+        http.shutdown
+      end
+    end
+
+  end
+
+end

data/lib/rest/wrappers/typhoeus_wrapper.rb

@@ -35,9 +35,17 @@ module Rest
         response
       end
 
+      # if body is a hash, it will convert it to json
+      def to_json_parts(h)
+        h[:body] = h[:body].to_json if h[:body] && h[:body].is_a?(Hash)
+      end
+
       def post(url, req_hash={})
         req_hash = default_typhoeus_options.merge(req_hash)
         # puts "REQ_HASH=" + req_hash.inspect
+
+        # Convert body to json - NEED TO TEST THIS MORE
+        to_json_parts(req_hash)
         response = Typhoeus::Request.post(url, req_hash)
         #p response
         if response.timed_out?

data/rest.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "test-unit"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "uber_config"
+  gem.add_development_dependency "typhoeus"
+  gem.add_development_dependency "net-http-persistent"
 
 end
 

data/test/test_performance.rb

@@ -0,0 +1,43 @@
+# Put config.yml file in ~/Dropbox/configs/ironmq_gem/test/config.yml
+
+gem 'test-unit'
+require 'test/unit'
+require 'yaml'
+require_relative 'test_base'
+
+class TestTests < TestBase
+  def setup
+    super
+
+  end
+
+  def test_get_performance
+
+    times = 100
+
+    collector = []
+
+    collector << run_perf(times, :typhoeus)
+    collector << run_perf(times, :rest_client)
+    collector << run_perf(times, :net_http_persistent)
+
+    collector.each do |c|
+      p c
+    end
+
+  end
+
+  def run_perf(times, gem)
+    puts "Starting #{gem} test..."
+    t = Time.now
+    client = Rest::Client.new(:gem => gem)
+    times.times do |i|
+      client.get("http://requestb.in/ydyd4nyd")
+    end
+    duration = Time.now.to_f - t.to_f
+    puts "#{times} posts took #{duration}"
+    {:gem=>gem, :duration=>duration}
+  end
+
+end
+

data/test/test_rest.rb

@@ -14,11 +14,35 @@ class TestTests < TestBase
 
   def test_basics
     response = @rest.get("http://www.github.com")
+    p response
+    p response.code
     assert response.code == 200
     #p response.body
     assert response.body.include?("Social Coding")
 
   end
 
+  def test_post_with_headers
+
+    @token = "abctoken"
+    headers = {
+        'Content-Type' => 'application/json',
+        'Authorization' => "OAuth #{@token}",
+        'User-Agent' => "someagent"
+    }
+    body = {"foo" => "bar"}
+    response = @rest.post("http://requestb.in/ydyd4nyd",
+                          :body => body,
+                          :headers => headers)
+    p response
+
+    response = @rest.post("http://requestb.in/ydyd4nyd",
+                          :body => "some string body",
+                          :headers => headers)
+    p response
+
+
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2012-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -75,6 +75,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rest client wrapper that chooses best installed client.
 email:
 - treeder@gmail.com
@@ -83,17 +115,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
-- VERSION.yml
 - lib/rest.rb
 - lib/rest/client.rb
 - lib/rest/version.rb
+- lib/rest/wrappers/base_wrapper.rb
+- lib/rest/wrappers/net_http_persistent_wrapper.rb
 - lib/rest/wrappers/rest_client_wrapper.rb
 - lib/rest/wrappers/typhoeus_wrapper.rb
 - rest.gemspec
 - test/test_base.rb
+- test/test_performance.rb
 - test/test_rest.rb
 homepage: https://github.com/iron-io/rest
 licenses: []
@@ -121,4 +157,5 @@ specification_version: 3
 summary: Rest client wrapper that chooses best installed client.
 test_files:
 - test/test_base.rb
+- test/test_performance.rb
 - test/test_rest.rb

data/README.markdown

@@ -1,43 +0,0 @@
-Rest Wrapper
--------------
-
-Getting Started
-==============
-
-Install the gem:
-
-    gem install rest
-
-Create an IronMQ client object:
-
-    @rest = Rest::Client.new()
-
-Then use it.
-
-GET
-=========
-
-    @rest.get(url, options...)
-
-options:
-
-- :params => query params for url
-- :headers => headers
-
-POST
-======
-
-    @rest.post(url, options...)
-
-options:
-
-- :body => POST body
-- :headers => headers
-
-DELETE
-======
-
-    @rest.delete(url, options...)
-
-
-

data/VERSION.yml

@@ -1,5 +0,0 @@
----
-:major: 0
-:minor: 3
-:patch: 0
-:build: