octoparts 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 158d78c413e947f7fd3f43a8a889e36e7569c2d8
-  data.tar.gz: dad9e133b9fe95ecacc1cb9255a7feb14c6527b1
+  metadata.gz: 17d05e5117d19c25f74463c3aeae163725ddbd98
+  data.tar.gz: 428bf3e2d09ef65d32b6358ac71432e30e5be179
 SHA512:
-  metadata.gz: ef61d18776ed079e6c6793ee627f30cf76575b90aecfaa6e38365d7bab1329ef05bbba4987ebdddc838ea92e3c160bc45117bc0018ae202edb6f875b7ff8b999
-  data.tar.gz: 6db5751507046998c8599835684eb0ca8521937079b2b4f5a91398e6841c46e273c49a1342209038d0d4ef6b6717fd0cef6ed2825101162e2117bb0c6b56d5cf
+  metadata.gz: b02d084a1a122380bb16439b7a3a16e47fe7b3e3c68341a5ba73561bbeb834014b18f7755d4fbdd89b932d7ab597b355fc7045573cea312ccda740164e8a3065
+  data.tar.gz: 5787486dca931f6d3c84ae53dca6c456857e87953f2be122c83b65487a60fa197ffe4a5ac48f0f6fd04d26554eba21533ba2b15e566743ebabfd568e15a83496

data/README.md

@@ -31,7 +31,7 @@ end
 # create client
 client = Octoparts::Client.new
 
-# invoke aggregate request
+# invoke aggregate request with Hash
 response = client.invoke({
   request_meta: {
     id: "test",
@@ -52,6 +52,16 @@ response = client.invoke({
 
 response.status
 response.body.responses.first.contents
+
+# invoke with builder
+aggregate_request = Octoparts.build_aggregate_request do
+  request_meta(id: 'test', timeout: 500)
+  requests do
+    part_request(part_id: 'echo').add_param('fooValue', 'test')
+  end
+end
+response = client.invoke(aggregate_request)
+
 ```
 
 ## Contributing

data/lib/octoparts.rb

@@ -6,6 +6,7 @@ require "octoparts/client"
 require "octoparts/model"
 require "octoparts/representer"
 require "octoparts/response"
+require "octoparts/builder"
 
 module Octoparts
   class << self
@@ -16,5 +17,10 @@ module Octoparts
     def configure(&block)
       configuration.instance_eval(&block)
     end
+
+    def build_aggregate_request(&block)
+      builder = Octoparts::AggregateRequestBuilder.new(&block)
+      builder.build
+    end
   end
 end

data/lib/octoparts/builder.rb

@@ -0,0 +1,32 @@
+module Octoparts
+  class AggregateRequestBuilder
+    def initialize(&block)
+      self.instance_eval(&block)
+    end
+
+    def request_meta(params)
+      @request_meta = Octoparts::Model::RequestMeta.new
+      params.each do |key, value|
+        @request_meta.send("#{key}=", value)
+      end
+    end
+
+    def requests(&block)
+      self.instance_eval(&block)
+    end
+
+    def part_request(params)
+      @requests ||= []
+      part_request = Octoparts::Model::PartRequest.new
+      params.each do |key, value|
+        part_request.send("#{key}=", value)
+      end
+      @requests << part_request
+      part_request
+    end
+
+    def build
+      Octoparts::Model::AggregateRequest.create(@request_meta, @requests)
+    end
+  end
+end

data/lib/octoparts/client.rb

@@ -21,8 +21,15 @@ module Octoparts
 
     # TODO: doc
     def invoke(params)
-      stringify_params = params.deep_stringify_keys
-      aggregate_request = Model::AggregateRequest.new.extend(Representer::AggregateRequestRepresenter).from_hash(stringify_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)
       headers = { content_type: 'application/json' }
       resp = post(OCTOPARTS_API_ENDPOINT_PATH, body, headers)
@@ -70,7 +77,7 @@ module Octoparts
         connection.adapter Faraday.default_adapter
       end
       response = @connection.send(method, path, params, @headers.merge(headers || {}))
-      if error = Octoparts::Error.from_response(response)
+      if error = Octoparts::ResponseError.from_response(response)
         raise error
       end
       response

data/lib/octoparts/error.rb

@@ -1,5 +1,7 @@
 module Octoparts
-  class Error < StandardError
+  class Error < StandardError; end
+
+  class ResponseError < Error
     attr_reader :response
 
     def self.from_response(response)
@@ -22,6 +24,7 @@ module Octoparts
     end
   end
 
-  class ClientError < Error; end
-  class ServerError < Error; end
+  class ClientError < ResponseError; end
+  class ServerError < ResponseError; end
+  class ArgumentError < Error; end
 end

data/lib/octoparts/model/aggregate_request.rb

@@ -2,6 +2,13 @@ module Octoparts
   module Model
     class AggregateRequest
       attr_accessor :request_meta, :requests
+
+      def self.create(request_meta, requests)
+        new.tap do |s|
+          s.request_meta = request_meta
+          s.requests = requests
+        end
+      end
     end
   end
 end

data/lib/octoparts/model/part_request.rb

@@ -2,6 +2,12 @@ module Octoparts
   module Model
     class PartRequest
       attr_accessor :part_id, :id, :params
+
+      def add_param(key, value)
+        @params ||= []
+        @params << Octoparts::Model::PartRequestParam.create(key, value)
+        self
+      end
     end
   end
 end

data/lib/octoparts/model/part_request_param.rb

@@ -2,6 +2,13 @@ module Octoparts
   module Model
     class PartRequestParam
       attr_accessor :key, :value
+
+      def self.create(key, value)
+        new.tap do |s|
+          s.key = key
+          s.value = value
+        end
+      end
     end
   end
 end

data/lib/octoparts/version.rb

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

data/test/fixtures/vcr/invoke_with_aggregate_request.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:9000/octoparts/2
+    body:
+      encoding: UTF-8
+      string: '{"requestMeta":{"id":"test","timeout":500},"requests":[{"partId":"echo","params":[{"key":"fooValue","value":"test"}]}]}'
+    headers:
+      User-Agent:
+      - Octoparts client ruby/0.0.3
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '310'
+    body:
+      encoding: UTF-8
+      string: '{"responseMeta":{"id":"test","processTime":55},"responses":[{"partId":"echo","id":"echo","cookies":[],"statusCode":200,"mimeType":"application/json","charset":"ISO-8859-1","cacheControl":{"noStore":false,"noCache":false},"contents":"{\"foo\":
+        \"test\"}\n","warnings":[],"errors":[],"retrievedFromCache":true}]}'
+    http_version: 
+  recorded_at: Thu, 08 Jan 2015 14:28:44 GMT
+recorded_with: VCR 2.9.3

data/test/test_client.rb

@@ -33,6 +33,25 @@ class TestClient < Test::Unit::TestCase
       end
     end
 
+    test "normal invoke with AggregateRequest model" do
+      VCR.use_cassette 'invoke_with_aggregate_request' do
+        aggregate_request = Octoparts.build_aggregate_request do
+          request_meta(id: 'test', timeout: 500)
+          requests do
+            part_request(part_id: 'echo').add_param('fooValue', 'test')
+          end
+        end
+        response = @client.invoke(aggregate_request)
+        body = response.body
+        assert { body.class == Octoparts::Model::AggregateResponse }
+        assert { body.response_meta.class == Octoparts::Model::ResponseMeta }
+        assert { body.responses.first.class == Octoparts::Model::PartResponse }
+        assert { body.responses.first.cache_control.class == Octoparts::Model::CacheControl }
+        assert { body.responses.size == 1 }
+        assert { body.responses.first.contents =~ /"test"/ }
+      end
+    end
+
     test "normal invoke when 2 requests" do
       VCR.use_cassette 'invoke_with_2_requests' do
         response = @client.invoke({

data/test/test_octoparts.rb

@@ -8,4 +8,11 @@ class TestOctoparts < Test::Unit::TestCase
   def test_it_does_something_useful
     assert { ['exist'].empty? == false }
   end
+
+  test "Octoparts.create_aggregate_request" do
+    aggregate_request = Octoparts.build_aggregate_request do
+      request_meta(id: 'id')
+    end
+    assert { aggregate_request.request_meta.class == Octoparts::Model::RequestMeta }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octoparts
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Takayuki Matsubara
@@ -149,6 +149,7 @@ files:
 - README.md
 - Rakefile
 - lib/octoparts.rb
+- lib/octoparts/builder.rb
 - lib/octoparts/client.rb
 - lib/octoparts/configuration.rb
 - lib/octoparts/error.rb
@@ -170,9 +171,11 @@ files:
 - octoparts.gemspec
 - test/fixtures/vcr/invoke_example.yml
 - test/fixtures/vcr/invoke_with_2_requests.yml
+- test/fixtures/vcr/invoke_with_aggregate_request.yml
 - test/fixtures/vcr/invoke_with_invalid_parameters.yml
 - test/helper.rb
 - test/representer/test_aggregate_request_representer.rb
+- test/test_builder.rb
 - test/test_client.rb
 - test/test_octoparts.rb
 homepage: https://github.com/ma2gedev/octoparts-rb
@@ -202,8 +205,10 @@ summary: Ruby client for the Octoparts API
 test_files:
 - test/fixtures/vcr/invoke_example.yml
 - test/fixtures/vcr/invoke_with_2_requests.yml
+- test/fixtures/vcr/invoke_with_aggregate_request.yml
 - test/fixtures/vcr/invoke_with_invalid_parameters.yml
 - test/helper.rb
 - test/representer/test_aggregate_request_representer.rb
+- test/test_builder.rb
 - test/test_client.rb
 - test/test_octoparts.rb