growthforecast-client 0.62.3 → 0.62.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aa8e954466d6a600a54404856ea29e0acf5a1cb
-  data.tar.gz: 613aef8e40914d64cac2dfba25734435dea1d6d3
+  metadata.gz: 5672c5c83ce2b178ace118ac1e6f291346681f41
+  data.tar.gz: 70a5147e382bb3cef90197db057be8ce9d9ede99
 SHA512:
-  metadata.gz: 0c1a97d6d60df53dcae6e2d34954d985799295269148fdc6d8da5e1cc37c6756989741477c41b1b6ef4d2c8b1c9f295d6478f64e9cbe651c5f04e997b860c76e
-  data.tar.gz: 36bfaf46fc2fe603f4df520cd1d5b7aee52792212be118c9cd63e48215b9509b3df9e3fa0c9cb997097faabbb7903d86879c17608486fd171b00218f4372495a
+  metadata.gz: 1f4245db2673db3389d1b99d8ce23dba339fc8979ca56ec6a5493cb2d5bd27f1c041d2e93370b2c78f1674d9973caf9e74177e5e686448674daa844aa3f615dc
+  data.tar.gz: c51644b5a8782c676719e0920c96e858630a116324701b23d5852472c2a9ac4f9d456b0aabdca0f82ba03889abe46e789bec00a35ece9411bff1fc4b1b3f5d86

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.62.4 (2014/02/01)
+
+Features:
+
+  - Add `keepalive` option
+  - Proxy httpclient parameters
+
 # 0.62.3 (2013/09/20)
 
 Features:

data/README.md

@@ -1,4 +1,4 @@
-# GrowthForecast Client [![Build Status](https://secure.travis-ci.org/sonots/growthforecast-client.png?branch=master)](http://travis-ci.org/sonots/growthforecast-client) [![Dependency Status](https://gemnasium.com/sonots/growthforecast-client.png)](https://gemnasium.com/sonots/growthforecast-client)
+# GrowthForecast Client [![Build Status](https://secure.travis-ci.org/sonots/growthforecast-client.png?branch=master)](http://travis-ci.org/sonots/growthforecast-client)
 
 testing ruby: 1.9.2, 1.9.3, 2.0.0; GrowthForecast: >= 0.62 (Jun 27, 2013 released)
 

data/VERSION

@@ -1 +1 @@
-0.62.3
+0.62.4

data/bin/growthforecast-client

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 # -*- encoding: utf-8 -*-
 
-require 'growthforecast-client'
+require_relative '../lib/growthforecast-client'
 GrowthForecast::CLI.start(ARGV)

data/lib/growthforecast-client.rb

@@ -1,2 +1,2 @@
-require 'growthforecast/client'
-require 'growthforecast/cli'
+require_relative 'growthforecast/client'
+require_relative 'growthforecast/cli'

data/lib/growthforecast/client.rb

@@ -12,22 +12,125 @@ module GrowthForecast
   class Client
     attr_accessor :debug
     attr_accessor :client
-    attr_reader   :debug_dev
     attr_reader   :base_uri
+    attr_accessor :keepalive
 
     # @param [String] base_uri The base uri of GrowthForecast
-    def initialize(base_uri = 'http://127.0.0.1:5125')
+    def initialize(base_uri = 'http://127.0.0.1:5125', opts = {})
+      @client = HTTPClient.new
       @base_uri = base_uri
+      opts = stringify_keys(opts)
+      @keepalive = opts.delete('keepalive') # bool
+      self.debug_dev  = opts.delete('debug_dev') # IO object such as STDOUT
+      # cf. https://github.com/nahi/httpclient/blob/0a16401e7892fbbd195a0254344bd48ac8a8bb26/lib/httpclient/session.rb#L133-L139
+      # self.connect_timeout = 60
+      # self.connect_retry = 1
+      # self.send_timeout = 120
+      # self.receive_timeout = 60        # For each read_block_size bytes
+      # self.keep_alive_timeout = 15     # '15' is from Apache 2 default
+      # self.read_block_size = 1024 * 16 # follows net/http change in 1.8.7
+      # self.protocol_retry_count = 5
     end
 
-    def client
-      @client ||= HTTPClient.new
+    def stringify_keys(hash)
+      {}.tap {|h| hash.each {|key, val| h[key.to_s] = val } }
     end
 
-    # set the `debug_dev` attribute of HTTPClient
-    # @param [IO] debug_dev such as STDOUT
-    def debug_dev=(debug_dev)
-      client.debug_dev = debug_dev
+    class << self
+      def attr_proxy_reader(symbol)
+        attr_proxy(symbol)
+      end
+
+      def attr_proxy_accessor(symbol)
+        attr_proxy(symbol, true)
+      end
+
+      def attr_proxy(symbol, assignable = false)
+        name = symbol.to_s
+        define_method(name) {
+          @client.__send__(name)
+        }
+        if assignable
+          aname = name + '='
+          define_method(aname) { |rhs|
+            @client.__send__(aname, rhs)
+          }
+        end
+      end
+    end
+
+    # cf. https://github.com/nahi/httpclient/blob/0a16401e7892fbbd195a0254344bd48ac8a8bb26/lib/httpclient.rb#L309-L355
+    # cf. https://github.com/nahi/httpclient/blob/0a16401e7892fbbd195a0254344bd48ac8a8bb26/lib/httpclient/session.rb#L89-L158
+    # proxy::SSLConfig:: SSL configurator.
+    attr_proxy_reader :ssl_config
+    # WebAgent::CookieManager:: Cookies configurator.
+    attr_proxy_accessor :cookie_manager
+    # An array of response HTTP message body String which is used for loop-back
+    # test.  See test/* to see how to use it.  If you want to do loop-back test
+    # of HTTP header, use test_loopback_http_response instead.
+    attr_proxy_reader :test_loopback_response
+    # An array of request filter which can trap HTTP request/response.
+    # See proxy::WWWAuth to see how to use it.
+    attr_proxy_reader :request_filter
+    # proxy::ProxyAuth:: Proxy authentication handler.
+    attr_proxy_reader :proxy_auth
+    # proxy::WWWAuth:: WWW authentication handler.
+    attr_proxy_reader :www_auth
+    # How many times get_content and post_content follows HTTP redirect.
+    # 10 by default.
+    attr_proxy_accessor :follow_redirect_count
+
+    # Set HTTP version as a String:: 'HTTP/1.0' or 'HTTP/1.1'
+    attr_proxy(:protocol_version, true)
+    # Connect timeout in sec.
+    attr_proxy(:connect_timeout, true)
+    # Request sending timeout in sec.
+    attr_proxy(:send_timeout, true)
+    # Response receiving timeout in sec.
+    attr_proxy(:receive_timeout, true)
+    # Reuse the same connection within this timeout in sec. from last used.
+    attr_proxy(:keep_alive_timeout, true)
+    # Size of reading block for non-chunked response.
+    attr_proxy(:read_block_size, true)
+    # Negotiation retry count for authentication.  5 by default.
+    attr_proxy(:protocol_retry_count, true)
+    # if your ruby is older than 2005-09-06, do not set socket_sync = false to
+    # avoid an SSL socket blocking bug in openssl/buffering.rb.
+    attr_proxy(:socket_sync, true)
+    # User-Agent header in HTTP request.
+    attr_proxy(:agent_name, true)
+    # From header in HTTP request.
+    attr_proxy(:from, true)
+    # An array of response HTTP String (not a HTTP message body) which is used
+    # for loopback test.  See test/* to see how to use it.
+    attr_proxy(:test_loopback_http_response)
+    # Decompress a compressed (with gzip or deflate) content body transparently. false by default.
+    attr_proxy(:transparent_gzip_decompression, true)
+    # Local socket address. Set HTTPClient#socket_local.host and HTTPClient#socket_local.port to specify local binding hostname and port of TCP socket.
+    attr_proxy(:socket_local, true)
+
+    # cf. https://github.com/nahi/httpclient/blob/0a16401e7892fbbd195a0254344bd48ac8a8bb26/lib/httpclient.rb#L416-L569
+    attr_proxy_accessor :debug_dev
+    attr_proxy_accessor :proxy
+    attr_proxy_accessor :no_proxy
+    def set_auth(domain, user, passwd)
+      @client.set_auth(domain, user, passwd)
+    end
+    def set_basic_auth(domain, user, passwd)
+      @client.set_basic_auth(domain, user, passwd)
+    end
+    def set_proxy_auth(user, passwd)
+      @client.set_proxy_auth(user, passwd)
+    end
+    def set_cookie_store(filename)
+      @client.set_cookie_store(filename)
+    end
+    attr_proxy_reader :save_cookie_store
+    attr_proxy_reader :cookies
+    attr_proxy_accessor :redirect_uri_callback
+
+    def last_request_uri
+      @request_uri
     end
 
     def last_response
@@ -38,7 +141,10 @@ module GrowthForecast
     # @param [String] path
     # @return [Hash] response body
     def get_json(path)
-      @res = client.get("#{@base_uri}#{path}")
+      @request_uri = "#{@base_uri}#{path}" 
+      query = nil
+      extheader = @keepalive ? { 'Connection' => 'Keep-Alive' } : {}
+      @res = client.get(@request_uri, query, extheader)
       handle_error(@res)
       JSON.parse(@res.body)
     end
@@ -49,8 +155,10 @@ module GrowthForecast
     # @return [Hash] response body
     def post_json(path, data = {})
       pp data if @debug
+      @request_uri = "#{@base_uri}#{path}" 
       json = JSON.generate(data)
-      @res = client.post("#{@base_uri}#{path}", json)
+      extheader = @keepalive ? { 'Connection' => 'Keep-Alive' } : {}
+      @res = client.post(@request_uri, json, extheader)
       handle_error(@res)
       JSON.parse(@res.body)
     end
@@ -61,7 +169,9 @@ module GrowthForecast
     # @return [String] response body
     def post_query(path, data = {})
       pp data if @debug
-      @res = client.post("#{@base_uri}#{path}", data)
+      @request_uri = "#{@base_uri}#{path}" 
+      extheader = @keepalive ? { 'Connection' => 'Keep-Alive' } : {}
+      @res = client.post(@request_uri, data, extheader)
       handle_error(@res)
       JSON.parse(@res.body)
     end

data/spec/growthforecast/client_spec.rb

@@ -164,6 +164,13 @@ describe GrowthForecast::Client do
       subject { @client.last_response }
       it { should be_kind_of HTTP::Message }
     end
+
+    context "#last_request_uri" do
+      include_context "stub_list_graph" if ENV['MOCK'] == 'on'
+      before { @client.list_graph }
+      subject { @client.last_request_uri }
+      it { should == "http://localhost:5125/json/list/graph" }
+    end
   end
 end
 

data/spec/support/setup.rb

@@ -36,14 +36,16 @@ shared_context "setup_growthforecast_client" do
 
   include_context "stub_post_graph" if ENV['MOCK'] == 'on'
   include_context "stub_delete_graph" if ENV['MOCK'] == 'on'
-  before {
-    client.delete_graph("app name", "host name", "<1sec count") rescue nil
-    client.delete_graph("app name", "host name", "<2sec count") rescue nil
-    client.post_graph("app name", "host name", "<1sec count", { 'number' => 0 }) rescue nil
-    client.post_graph("app name", "host name", "<2sec count", { 'number' => 0 }) rescue nil
-  }
-  after {
-    client.delete_graph("app name", "host name", "<1sec count") rescue nil
-    client.delete_graph("app name", "host name", "<2sec count") rescue nil
-  }
+  unless ENV['MOCK'] == 'on'
+    before {
+      client.delete_graph("app name", "host name", "<1sec count") rescue nil
+      client.delete_graph("app name", "host name", "<2sec count") rescue nil
+      client.post_graph("app name", "host name", "<1sec count", { 'number' => 0 }) rescue nil
+      client.post_graph("app name", "host name", "<2sec count", { 'number' => 0 }) rescue nil
+    }
+    after {
+      client.delete_graph("app name", "host name", "<1sec count") rescue nil
+      client.delete_graph("app name", "host name", "<2sec count") rescue nil
+    }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: growthforecast-client
 version: !ruby/object:Gem::Version
-  version: 0.62.3
+  version: 0.62.4
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient