octoparts 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17d05e5117d19c25f74463c3aeae163725ddbd98
-  data.tar.gz: 428bf3e2d09ef65d32b6358ac71432e30e5be179
+  metadata.gz: 2c9c0489fcb40ffc84c23c381544c54eb5f9b7fa
+  data.tar.gz: f5859dfaffceaa5a020beeae377b63b094d99403
 SHA512:
-  metadata.gz: b02d084a1a122380bb16439b7a3a16e47fe7b3e3c68341a5ba73561bbeb834014b18f7755d4fbdd89b932d7ab597b355fc7045573cea312ccda740164e8a3065
-  data.tar.gz: 5787486dca931f6d3c84ae53dca6c456857e87953f2be122c83b65487a60fa197ffe4a5ac48f0f6fd04d26554eba21533ba2b15e566743ebabfd568e15a83496
+  metadata.gz: ca03ed6a4484042a147b8faf8fa25cd7b2876819203aeaf5e05bd94395857e1b7850cb0285fc59c133782aa2d7cfdd6ab732b6cbc0d4e199ede84e3ed29a3733
+  data.tar.gz: 5c92e83194b68abde9ddc8e85964039a1e5d0f25642c594dd01572b0519e4fa8324fc58ec91ad671d7a27691799cc7a602a3a36099fa114f44e5e329959c252f

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/README.md

@@ -1,5 +1,11 @@
 # Octoparts
 
+[![Gem Version](https://badge.fury.io/rb/octoparts.svg)](http://badge.fury.io/rb/octoparts)
+[![Build Status](https://travis-ci.org/ma2gedev/octoparts-rb.svg)](https://travis-ci.org/ma2gedev/octoparts-rb)
+[![Coverage Status](https://img.shields.io/coveralls/ma2gedev/octoparts-rb.svg)](https://coveralls.io/r/ma2gedev/octoparts-rb)
+[![Code Climate](https://codeclimate.com/github/ma2gedev/octoparts-rb/badges/gpa.svg)](https://codeclimate.com/github/ma2gedev/octoparts-rb)
+[![endorse](https://api.coderwall.com/ma2gedev/endorsecount.png)](https://coderwall.com/ma2gedev)
+
 Octoparts Client for Ruby
 
 Octoparts is the backend services aggregator. See more details [here](http://m3dev.github.io/octoparts/).
@@ -26,6 +32,8 @@ Or install it yourself as:
 # configuration
 Octoparts.configure do |config|
   config.endpoint = 'http://localhost:9000'
+  config.timeout_sec = 3       # open/read timeout in seconds
+  config.open_timeout_sec = 1  # connection open timeout in seconds
 end
 
 # create client
@@ -66,7 +74,7 @@ response = client.invoke(aggregate_request)
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/octoparts/fork )
+1. Fork it ( https://github.com/ma2gedev/octoparts/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/octoparts/client.rb

@@ -6,31 +6,24 @@ module Octoparts
     OCTOPARTS_API_ENDPOINT_PATH = '/octoparts/2'
     CACHE_API_ENDPOINT_PATH = "#{OCTOPARTS_API_ENDPOINT_PATH}/cache"
 
-    def initialize(endpoint: nil, headers: {})
+    def initialize(endpoint: nil, headers: {}, timeout_sec: nil, open_timeout_sec: nil)
       @endpoint = endpoint || Octoparts.configuration.endpoint
+      @timeout_sec = timeout_sec || Octoparts.configuration.timeout_sec
+      @open_timeout_sec = open_timeout_sec || Octoparts.configuration.open_timeout_sec
       @headers = Octoparts.configuration.headers.merge(headers)
     end
 
-    def get(path, params = nil, headers = {})
-      process(:get, path, params, headers)
+    def get(path, params = {}, headers = {})
+      process(:get, path, params, nil, headers)
     end
 
-    def post(path, params = nil, headers = {})
-      process(:post, path, params, headers)
+    def post(path, body = nil, headers = {})
+      process(:post, path, {}, body, headers)
     end
 
     # TODO: doc
     def invoke(params)
-      aggregate_request = case params
-                          when Hash
-                            stringify_params = params.deep_stringify_keys
-                            Model::AggregateRequest.new.extend(Representer::AggregateRequestRepresenter).from_hash(stringify_params)
-                          when Octoparts::Model::AggregateRequest
-                            params.extend(Representer::AggregateRequestRepresenter)
-                          else
-                            raise Octopart::ArgumentError
-                          end
-      body = aggregate_request.to_json(camelize: true)
+      body = create_request_body(params)
       headers = { content_type: 'application/json' }
       resp = post(OCTOPARTS_API_ENDPOINT_PATH, body, headers)
       Response.new(
@@ -72,15 +65,34 @@ module Octoparts
       )
     end
 
-    def process(method, path, params, headers)
+    def process(method, path, params, body, headers)
       @connection ||= Faraday.new(url: @endpoint) do |connection|
         connection.adapter Faraday.default_adapter
       end
-      response = @connection.send(method, path, params, @headers.merge(headers || {}))
+      response = @connection.send(method) do |request|
+        request.url(path, params)
+        request.body = body if body
+        request.headers.merge!(headers)
+        request.options.timeout = @timeout_sec if @timeout_sec
+        request.options.open_timeout = @open_timeout_sec if @open_timeout_sec
+      end
       if error = Octoparts::ResponseError.from_response(response)
         raise error
       end
       response
     end
+
+    def create_request_body(model)
+      aggregate_request = case model
+                          when Hash
+                            stringify_params = model.deep_stringify_keys
+                            Model::AggregateRequest.new.extend(Representer::AggregateRequestRepresenter).from_hash(stringify_params)
+                          when Octoparts::Model::AggregateRequest
+                            model.extend(Representer::AggregateRequestRepresenter)
+                          else
+                            raise Octopart::ArgumentError
+                          end
+      aggregate_request.to_json(camelize: true)
+    end
   end
 end

data/lib/octoparts/configuration.rb

@@ -2,7 +2,7 @@ module Octoparts
   class Configuration
     USER_AGENT = "Octoparts client ruby/#{Octoparts::VERSION}"
 
-    attr_accessor :endpoint, :headers
+    attr_accessor :endpoint, :headers, :timeout_sec, :open_timeout_sec
 
     def initialize
       # set default values
@@ -10,6 +10,8 @@ module Octoparts
       @headers = {
         'User-Agent' => USER_AGENT
       }
+      @timeout_sec = nil
+      @open_timeout_sec = nil
     end
   end
 end

data/lib/octoparts/version.rb

@@ -1,3 +1,3 @@
 module Octoparts
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/octoparts.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "test-unit", "~> 3.0"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "vcr"
+  spec.add_development_dependency "coveralls"
 end

data/test/helper.rb

@@ -1,9 +1,12 @@
+require 'coveralls'
+Coveralls.wear!
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'octoparts'
 
 require 'pry'
 require 'test/unit'
-require 'webmock'
+require 'webmock/test_unit'
 require 'vcr'
 
 VCR.configure do |c|

data/test/test_client.rb

@@ -41,6 +41,7 @@ class TestClient < Test::Unit::TestCase
             part_request(part_id: 'echo').add_param('fooValue', 'test')
           end
         end
+        stub_request(:post, 'localhost:9000')
         response = @client.invoke(aggregate_request)
         body = response.body
         assert { body.class == Octoparts::Model::AggregateResponse }
@@ -49,6 +50,9 @@ class TestClient < Test::Unit::TestCase
         assert { body.responses.first.cache_control.class == Octoparts::Model::CacheControl }
         assert { body.responses.size == 1 }
         assert { body.responses.first.contents =~ /"test"/ }
+        assert_requested(:post, "http://localhost:9000/octoparts/2") do |req|
+          req.body == '{"requestMeta":{"id":"test","timeout":500},"requests":[{"partId":"echo","params":[{"key":"fooValue","value":"test"}]}]}'
+        end
       end
     end
 
@@ -103,4 +107,27 @@ class TestClient < Test::Unit::TestCase
       end
     end
   end
+
+  sub_test_case "timeout" do
+    teardown do
+      Octoparts.configure do |c|
+        c.timeout_sec = nil
+      end
+    end
+
+    test "timeout_sec option" do
+      assert_raise Faraday::TimeoutError do
+        Octoparts::Client.new(timeout_sec: 0).get('/')
+      end
+    end
+
+    test "open_timeout_sec option" do
+      Octoparts.configure do |c|
+        c.timeout_sec = 0
+      end
+      assert_raise Faraday::TimeoutError do
+        Octoparts::Client.new.get('/')
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octoparts
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Takayuki Matsubara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " Ruby client library for the Octoparts API "
 email:
 - takayuki.1229@gmail.com
@@ -144,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md