carrot_rpc 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97329124a088c7a7628e5613ce2059874097a8db
-  data.tar.gz: 216bf02e2bf6e657c1a3938329069af10f6380c2
+  metadata.gz: 4ba255fb6d2e277988ef84326c30193fe9dc0ca7
+  data.tar.gz: 7c8a26c482a1041887f7ac73eb5bd9396966a3fe
 SHA512:
-  metadata.gz: 8f6171315d5e230225a1062be1e46d97fe102f942407c0725c8331734137be6428598d675021ff808a2428009397c2beee07031632dbc0745bcb1c5fd7b70864
-  data.tar.gz: 4abfd002d0ea5d4b5c5704dac547c0076143c2dcfbbc3c46a7cf030b6105d275977ec95c649778ea08269aaae5b310b73cf00948257e8ac7a48951af76cb0aa3
+  metadata.gz: ca9b37d0788166fe678d7281cfeac3846f662370b6a5ac6de02fc3567df59ddce010999f61555603ba7c0170f338ee5f32a9d70e7e7f71f2bc86e0cac7bf358b
+  data.tar.gz: 71d2becd5fa8dab667c8b82c3e98e194c29cd46ab95d1997304597aa929741cb2a7287fdb936d46d991c160e06642fde18b504953c868e628329a71fb8d9ad7e

data/.rubocop.yml

@@ -2,6 +2,9 @@ AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.2
 
+Metrics/ClassLength:
+  Max: 120
+  
 Metrics/LineLength:
   Max: 120
 

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.1
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0

data/CHANGELOG.md

@@ -3,52 +3,69 @@
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
 - [Changelog](#changelog)
+  - [v1.0.0](#v100)
+    - [Incompatible Changes](#incompatible-changes)
+  - [v0.8.1](#v081)
+    - [Enhancements](#enhancements)
+  - [v0.8.0](#v080)
+    - [Enhancements](#enhancements-1)
   - [v0.7.1](#v071)
     - [Bug Fixes](#bug-fixes)
   - [v0.7.0](#v070)
     - [Bug Fixes](#bug-fixes-1)
-    - [Incompatible Changes](#incompatible-changes)
+    - [Incompatible Changes](#incompatible-changes-1)
   - [v0.6.0](#v060)
-    - [Enhancements](#enhancements)
+    - [Enhancements](#enhancements-2)
   - [v0.5.1](#v051)
     - [Bug Fixes](#bug-fixes-2)
   - [v0.5.0](#v050)
-    - [Enhancements](#enhancements-1)
-    - [Incompatible Changes](#incompatible-changes-1)
+    - [Enhancements](#enhancements-3)
+    - [Incompatible Changes](#incompatible-changes-2)
   - [v0.4.1](#v041)
     - [Bug Fixes](#bug-fixes-3)
   - [v0.4.0](#v040)
-    - [Enhancements](#enhancements-2)
+    - [Enhancements](#enhancements-4)
     - [Bug Fixes](#bug-fixes-4)
-    - [Incompatible Changes](#incompatible-changes-2)
+    - [Incompatible Changes](#incompatible-changes-3)
   - [v0.3.0](#v030)
-    - [Enhancements](#enhancements-3)
+    - [Enhancements](#enhancements-5)
     - [Bug Fixes](#bug-fixes-5)
   - [v0.2.3](#v023)
-    - [Enhancements](#enhancements-4)
+    - [Enhancements](#enhancements-6)
     - [Bug Fixes](#bug-fixes-6)
     - [Upgrading](#upgrading)
   - [v0.2.1](#v021)
     - [Bug Fixes](#bug-fixes-7)
   - [v0.2.0](#v020)
-    - [Enhancements](#enhancements-5)
+    - [Enhancements](#enhancements-7)
     - [Bug Fixes](#bug-fixes-8)
-    - [Incompatible Changes](#incompatible-changes-3)
+    - [Incompatible Changes](#incompatible-changes-4)
   - [v0.1.2](#v012)
-    - [Enhancements](#enhancements-6)
+    - [Enhancements](#enhancements-8)
     - [Bug Fixes](#bug-fixes-9)
   - [v0.1.1](#v011)
-    - [Enhancements](#enhancements-7)
+    - [Enhancements](#enhancements-9)
     - [Bug Fixes](#bug-fixes-10)
-    - [Incompatible Changes](#incompatible-changes-4)
+    - [Incompatible Changes](#incompatible-changes-5)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 # Changelog
 All significant changes in the project are documented here.
 
+## v1.0.0
+### Incompatible Changes
+* [#48](https://github.com/C-S-D/carrot_rpc/pull/48) - Remove queue for correlation_id when RpcClient#wait_for_result raises an exception. -[@nward](https://github.com/nward)
+* [#50](https://github.com/C-S-D/carrot_rpc/pull/50) - Raise an exception for error responses to let consuming application handle response. -[@nward](https://github.com/nward)
+* [#52](https://github.com/C-S-D/carrot_rpc/pull/52) - Allow custom queue options to be set -[@nward](https://github.com/nward)
+* [#53](https://github.com/C-S-D/carrot_rpc/pull/53) - Rename keys for any hashes inside arrays. Fixes issue [#35](https://github.com/C-S-D/carrot_rpc/issues/35) -[@thewalkingtoast](https://github.com/thewalkingtoast)
+
+## v0.8.1
+### Enhancements
+* Update to Ruby 2.2.6 and have tests run for Ruby 2.3 and 2.4.
+
 ## v0.8.0
-### Enchancements
+### Enhancements
 * Don't assume that Bunny already has a connection to RabbitMQ.
 * Attempt to start Bunny for the servers
 * This allows the implementing application to decide when to start the connection when using a forking web server

data/CODE_OF_CONDUCT.md

@@ -1,3 +1,11 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Contributor Code of Conduct](#contributor-code-of-conduct)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 
 # Contributor Code of Conduct
 

data/Gemfile

@@ -1,6 +1,5 @@
 source "https://rubygems.org"
 
-ruby "2.2.5"
 # Specify your gem's dependencies in carrot_rpc.gemspec
 gemspec
 

data/README.md

@@ -11,6 +11,8 @@
     - [Writing Servers](#writing-servers)
     - [Writing Clients](#writing-clients)
       - [Using request threading in clients](#using-request-threading-in-clients)
+    - [Custom Queue Options](#custom-queue-options)
+      - [Errors](#errors)
     - [Support for JSONAPI::Resources](#support-for-jsonapiresources)
   - [Development](#development)
   - [Contributing](#contributing)
@@ -249,6 +251,21 @@ class ProfileClient < CarrotRpc::RpcClient
 end
 ```
 
+### Custom Queue Options
+By default, client queues are defined with `auto_delete: false`, and server queues are defined with no parameters, so use the Bunny/RabbitMQ defaults. These can be customised by calling the `queue_options` class method to add to or override these options on either a RpcClient or RpcServer subclass. This method takes any queue parameter accepted by Bunny.
+Care should be taken when setting these options, as CarrotRPC does not attempt to fix mistakes here. The defaults are typically what you want.
+
+The following overrides the default CarrotRpc auto_delete option, and sets durable to true:
+```ruby
+  class CarClient < CarrotRpc::RpcClient
+    queue_name "car_queue"
+    queue_options auto_delete: true, durable: true
+  end
+```
+
+#### Errors
+If a JSON-RPC error is returned, a CarrotRpc::Error exception is raised with the appropriate attributes set. If a malformed JSON-RPC error is returned (i.e. code or message are missing), an CarrotRpc::Exception::InvalidResponse exception is raised.
+
 ### Support for JSONAPI::Resources
 In the case that you're writing an application that uses the `jsonapi-resources` gem and you want the `RpcServer` to have the same functionality, then we got you covered. All you need to do is import a few modules. See [jsonapi-resources](https://github.com/cerebris/jsonapi-resources) for details on how to implement resources for your models.
 
@@ -257,25 +274,25 @@ Example Server with JSONAPI functionality:
 class CarServer < CarrotRpc::RpcServer
   extend CarrotRpc::RpcServer::JSONAPIResources::Actions
   include CarrotRpc::RpcServer::JSONAPIResources
-  
+
   # declare the actions to enable
   actions: :create, :destroy, :index, :show, :update
- 
+
   # Context so it can build urls
   def base_url
     "http://foo.com"
   end
-  
+
   # Context to find the resource and create links.
   def controller
     "api/cars"
   end
- 
+
   # JSONAPI::Resource example: `app/resources/car_resource.rb`
   def resource_klass
     CarResource
   end
-  
+
   queue_name "car_queue"
 
   def show(params)

data/carrot_rpc.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   # Production requirements
 
   # Common extensions from Rails
-  spec.add_dependency "activesupport", "~> 4.2"
+  spec.add_dependency "activesupport", ">= 4.2", "< 6.x"
   # The RabbitMQ library
   spec.add_dependency "bunny", "~> 2.2"
 

data/circle.yml

@@ -1,8 +1,15 @@
 machine:
   services:
     - rabbitmq-server
+dependencies:
+  override:
+    - 'rvm-exec 2.2.6 bundle install'
+    - 'rvm-exec 2.3.3 bundle install'
+    - 'rvm-exec 2.4.0 bundle install'
 test:
   override:
-    - RAILS_ENV=test bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+    - 'RAILS_ENV=test rvm-exec 2.2.6 bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml'
+    - 'RAILS_ENV=test rvm-exec 2.3.3 bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml'
+    - 'RAILS_ENV=test rvm-exec 2.4.0 bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml'
   post:
-    - bundle exec rubocop
+    - 'rvm-exec 2.2.6 bundle exec rubocop'

data/lib/carrot_rpc/client_server.rb

@@ -19,7 +19,30 @@ module CarrotRpc::ClientServer
       @queue_name = args[0]
     else
       fail ArgumentError,
-           "queue_name(new_name) :: new_name or queue_name() :: current_name are the only ways to call queue_name"
+           "queue_name(new_name) :: new_name or queue_name() :: " \
+           "current_name are the only ways to call queue_name"
+    end
+  end
+
+  # @overload queue_options(options)
+  #
+  #   Allows for custom queue options, such as durable.
+  #
+  #   @options params [Hash] a hash of options to pass to bunny.
+  #
+  # @overload queue_options
+  #   The current queue options previously set with `#queue_options(options)`.
+  #
+  #   @return [Hash]
+  def queue_options(*args)
+    if args.length == 0
+      @queue_options || {}
+    elsif args.length == 1
+      @queue_options = args[0]
+    else
+      fail ArgumentError,
+           "queue_options(options) :: options or queue_options() :: " \
+           "current_options are the only ways to call queue_options"
     end
   end
 

data/lib/carrot_rpc/exception.rb

@@ -3,4 +3,5 @@ module CarrotRpc::Exception
   # Exception to be raised when the client timesout waiting for a response.
   class RpcClientTimeout < StandardError; end
   class InvalidQueueName < StandardError; end
+  class InvalidResponse < StandardError; end
 end

data/lib/carrot_rpc/hash_extensions.rb

@@ -5,11 +5,13 @@ module CarrotRpc::HashExtensions
     # @param [String] find the text to look for in a keys
     # @param [String] replace the text to replace the found text
     # @return [Hash] a new hash
-    def rename_keys(find, replace, new_hash = {})
+    def rename_keys(find, replace, new_hash = {}) # rubocop:disable Metrics/MethodLength
       each do |k, v|
         new_key = k.to_s.gsub(find, replace)
 
-        new_hash[new_key] = if v.is_a? Hash
+        new_hash[new_key] = if v.is_a? Array
+                              v.map { |t| t.rename_keys(find, replace) }
+                            elsif v.is_a? Hash
                               v.rename_keys(find, replace)
                             else
                               v
@@ -17,6 +19,6 @@ module CarrotRpc::HashExtensions
       end
 
       new_hash
-    end
+    end # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/carrot_rpc/rpc_client.rb

@@ -40,7 +40,8 @@ class CarrotRpc::RpcClient
 
     queue_name = self.class.test_queue_name(self.class.queue_name, @config.client_test_mode)
     # auto_delete => false keeps the queue around until RabbitMQ restarts or explicitly deleted
-    @server_queue = @channel.queue(queue_name, auto_delete: false)
+    options = { auto_delete: false }.merge(self.class.queue_options)
+    @server_queue = @channel.queue(queue_name, options)
 
     # Setup a direct exchange.
     @exchange = @channel.default_exchange
@@ -87,10 +88,16 @@ class CarrotRpc::RpcClient
       # and this must happend before the `Hash.delete` or
       # the receiving thread won't be able to find the correlation_id in @results
       result = @results[correlation_id].pop
-      @results.delete correlation_id # remove item from hash. prevents memory leak.
+
+      # If we get an exception, raise it in this thread, so the application can deal with it.
+      if result.is_a? Exception
+        fail result
+      end
+
       result
     end
   ensure
+    @results.delete correlation_id # remove item from hash. prevents memory leak.
     @channel.close
   end
 
@@ -151,12 +158,30 @@ class CarrotRpc::RpcClient
       response[:result]
     # data is the key holding the error information
     elsif response.key?(:error)
-      response[:error][:data]
+      parse_error_result(response)
     else
       response
     end
   end
 
+  # Build an CarrotRpc::Error based on an error response or throw CarrotRpc::Exception::InvalidResponse if
+  # the response error itself is invalid.
+  # @param [Hash] response from rpc call
+  # @return [CarrotRpc::Error, CarrotRpc::Exception::InvalidResponse]
+  def parse_error_result(response)
+    # If we don't have a code, throw an exception.
+    unless response[:error].key?(:code) &&
+           response[:error].key?(:message)
+      return CarrotRpc::Exception::InvalidResponse.new
+    end
+
+    CarrotRpc::Error.new(
+      code: response[:error][:code],
+      data: response[:error].key?(:data) ? response[:error][:data] : nil,
+      message: response[:error][:message]
+    )
+  end
+
   def publish_payload(payload, correlation_id:)
     # Reply To => make sure the service knows where to send it's response.
     # Correlation ID => identify the results that belong to the unique call made

data/lib/carrot_rpc/rpc_server.rb

@@ -18,8 +18,7 @@ class CarrotRpc::RpcServer
     @channel = config.bunny.create_channel
     @logger = config.logger
     @block = block
-    queue_name = self.class.test_queue_name(self.class.queue_name, config.server_test_mode)
-    @server_queue = @channel.queue(queue_name)
+    setup_queue(config)
     @exchange = @channel.default_exchange
   end
 
@@ -92,6 +91,11 @@ class CarrotRpc::RpcServer
     end
   end
 
+  def setup_queue(config)
+    queue_name = self.class.test_queue_name(self.class.queue_name, config.server_test_mode)
+    @server_queue = @channel.queue(queue_name, self.class.queue_options)
+  end
+
   def thread_request(request_message:)
     logger.debug "Threading request (#{request_message.inspect}) " \
                    "in Thread.current.thread_variable_get(#{thread_request_variable.inspect})"

data/lib/carrot_rpc/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module CarrotRpc
-  VERSION = "0.8.0".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrot_rpc
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Scott Hamilton
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.x
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement