elementary-rpc 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f92f4aa5b2489be4f30f3bd8f1c36a005f59b554
-  data.tar.gz: f876e99e9f8851fdb23802492f7f66428e0ab38e
+  metadata.gz: 69b9b5d2909967aae631ba36ee3209ada7a5f139
+  data.tar.gz: ee1e219ebba8f88da2da2d9141cd26166c97e497
 SHA512:
-  metadata.gz: 5d3994a1a15f0313ab25ab9ff820a29076de9a88c852df1a7e4c1a1bb768e28359d1c6ad7bb7609581bab8b0cacb03d8f079492c33c4fc5692f6f29ef3d1e492
-  data.tar.gz: fe24f7fc72437bf9bbd54fd394ee4448b44582449b8483af0fe3af0a00cd8bb8c4bd02273aa2ec857ca8bd7bbd616d69755542de82b9265cb139ef4d6f51fba4
+  metadata.gz: 171be7ee2734311afa37c71fa8f71ed65908c8aafc859988c226789272485c6d86f74d08e5cdadb4fe061fff057fdaea01a3c2240cc370547e1f5e69e5da9a9c
+  data.tar.gz: 6f25161ef2b97092eb75442d167b2a42289e55047d766b754b835714ef6b994a72db3dd78173daf321c8af192bbfc66337631fb80a8fd9b23d5a609fc0cb4241

data/lib/elementary/connection.rb

@@ -18,6 +18,9 @@ module Elementary
     #   in the +Elementary::Transport+ module
     # @optiosn opts [Array] :hosts An array of {:host => 'localhost', :port =>
     #   8080} hashes to instruct the connection
+    # @option opts [Hash] :transport_options A +Hash+ of request options that
+    #   will be passed down to the transport layer. This will depend on what
+    #   options are available by the underlying transport
     def initialize(service, opts={})
       if service.nil? || service.superclass != Protobuf::Rpc::Service
         raise ArgumentError,
@@ -27,6 +30,7 @@ module Elementary
       @service = service
       @transport = opts[:transport]
       @hosts = opts[:hosts] || DEFAULT_HOSTS
+      @transport_opts = opts[:transport_options] || {}
     end
 
     def rpc
@@ -34,7 +38,7 @@ module Elementary
     end
 
     def select_transport
-      Elementary::Transport::HTTP.new(@hosts)
+      Elementary::Transport::HTTP.new(@hosts, @transport_opts)
     end
   end
 end

data/lib/elementary/transport/http.rb

@@ -12,8 +12,15 @@ module Elementary
       ERROR_HEADER_MSG = 'x-protobuf-error'
       ERROR_HEADER_CODE = 'x-protobuf-error-reason'
 
-      def initialize(hosts)
+      # Create a HTTP transport object for sending protobuf objects to the
+      # service host names enumerated in +hosts+
+      #
+      # @param [Array] hosts A collection of host declarations ({:host => '',
+      #   :port => 0, :prefix => '/'})
+      # @param [Hash] opts Options to be passed directly into Faraday.
+      def initialize(hosts, opts={})
         @hosts = hosts
+        @options = opts
       end
 
       def call(service, rpc_method, *params)
@@ -51,7 +58,8 @@ module Elementary
       def client
         return @client if @client
 
-        @client = Faraday.new(:url => host_url) do |f|
+        faraday_options = @options.merge({:url => host_url})
+        @client = Faraday.new(faraday_options) do |f|
           f.response :logger
           f.adapter :net_http_persistent
         end

data/lib/elementary/version.rb

@@ -1,4 +1,4 @@
 
 module Elementary
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/connection_spec.rb

@@ -21,60 +21,77 @@ describe Elementary::Connection do
     end
   end
 
-  let(:connection) do
-    described_class.new(Elementary::Rspec::Simple)
-  end
+  context 'with a simple RPC service' do
+    let(:opts) { {} }
+    let(:connection) do
+      described_class.new(Elementary::Rspec::Simple, opts)
+    end
+    describe '#select_transport' do
+      subject(:transport) { connection.select_transport }
+
+      context 'by default' do
+        it { should be_instance_of Elementary::Transport::HTTP }
+      end
 
-  describe '#select_transport' do
-    subject(:transport) { connection.select_transport }
+      context 'with transport_options' do
+        let(:opts) { {:transport_options => transport_opts} }
+        let(:transport_opts) do
+          {
+            :timeout => 3,
+            :open_timeout => 1,
+          }
+        end
 
-    context 'by default' do
-      it { should be_instance_of Elementary::Transport::HTTP }
+        it 'should pass request_options to the transport' do
+          expect(Elementary::Transport::HTTP).to receive(:new).with(anything, transport_opts).and_call_original
+          expect(transport).to be_instance_of Elementary::Transport::HTTP
+        end
+      end
     end
-  end
 
 
-  describe 'an error request', :type => :integration do
-    describe 'rpc' do
-      describe '#error' do
-        subject(:response) { connection.rpc.error(request) }
-        let(:request) { Elementary::Rspec::String.new(:data => 'rspec') }
+    describe 'an error request', :type => :integration do
+      describe 'rpc' do
+        describe '#error' do
+          subject(:response) { connection.rpc.error(request) }
+          let(:request) { Elementary::Rspec::String.new(:data => 'rspec') }
 
-        before :each do
-          response.value
-        end
+          before :each do
+            response.value
+          end
 
-        it { should be_rejected }
+          it { should be_rejected }
+        end
       end
     end
-  end
 
-  describe 'an echo request', :type => :integration do
-    after :each do
-      Elementary.flush_middleware
-    end
+    describe 'an echo request', :type => :integration do
+      after :each do
+        Elementary.flush_middleware
+      end
 
-    describe 'rpc' do
-      describe '#echo' do
-        let(:request) { Elementary::Rspec::String.new(:data => 'rspec') }
-        subject(:response) { connection.rpc.echo(request) }
+      describe 'rpc' do
+        describe '#echo' do
+          let(:request) { Elementary::Rspec::String.new(:data => 'rspec') }
+          subject(:response) { connection.rpc.echo(request) }
 
-        before :each do
-          Elementary.use Elementary::Middleware::Dummy, :rspec => true
-          expect_any_instance_of(Elementary::Middleware::Dummy).to \
-                  receive(:call).and_call_original
-        end
+          before :each do
+            Elementary.use Elementary::Middleware::Dummy, :rspec => true
+            expect_any_instance_of(Elementary::Middleware::Dummy).to \
+                    receive(:call).and_call_original
+          end
 
-        it 'should have a value containing the echoed string' do
-          puts "Sending req #{Time.now.to_f}"
-          expect(response).to be_instance_of Elementary::Future
+          it 'should have a value containing the echoed string' do
+            puts "Sending req #{Time.now.to_f}"
+            expect(response).to be_instance_of Elementary::Future
 
-          puts "Waiting for future #{Time.now.to_f}"
-          value = response.value # Wait on the future
-          puts "Future responded: #{Time.now.to_f}"
+            puts "Waiting for future #{Time.now.to_f}"
+            value = response.value # Wait on the future
+            puts "Future responded: #{Time.now.to_f}"
 
-          expect(response).not_to be_rejected
-          expect(value.data).to eql('rspec')
+            expect(response).not_to be_rejected
+            expect(value.data).to eql('rspec')
+          end
         end
       end
     end

data/spec/transport/http_spec.rb

@@ -3,7 +3,8 @@ require 'elementary/transport/http'
 
 describe Elementary::Transport::HTTP do
   let(:hosts) { [] }
-  let(:http) { described_class.new(hosts) }
+  let(:opts) { {} }
+  let(:http) { described_class.new(hosts, opts) }
 
   describe '#host_url' do
     subject(:host_url) { http.send(:host_url) }
@@ -56,5 +57,18 @@ describe Elementary::Transport::HTTP do
       # Object identity!
       expect(first).to be second
     end
+
+    context 'with options passed to the initializer' do
+      let(:opts) do
+        {
+          :request => {:timeout => 3, :open_timeout => 1},
+        }
+      end
+
+      it 'should pass options to Faraday.new' do
+        expect(Faraday).to receive(:new).with(hash_including(opts)).and_call_original
+        expect(client).to be_instance_of Faraday::Connection
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elementary-rpc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - R. Tyler Croy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler