carrot_rpc 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b572d5d0139ae2c92283f32b320f917135f44dfd
-  data.tar.gz: 26e9cf234ef9c0f34c2856735424e2ffa43aa9b7
+  metadata.gz: 7021e60c18d67242d796d0a7989d0b6ba411bd2f
+  data.tar.gz: 2a857193768aafda74326c94339132e71d30ba65
 SHA512:
-  metadata.gz: db094e71f16fed9739c59444b294121db35813ccab080569779da8c63593f3d2732007fceb4efd955542a988896514c3c2b5dac06a5a51aa4005321140eec46a
-  data.tar.gz: 9f3a627db5a911aa7a8171ff0acf0671624d7c832f6de2420448493d3e19f4b6b05912e53511b0fed3b76535637f4f43755b602bc9475f9f5233e24557632d3f
+  metadata.gz: d244349b6f223b3bc3104075a766084054d7e15aab8d419c7e2a0c12c8cc63ac9b2554366ad56975dff3972463d40867aaa1a931c608a661695e25f6c358168f
+  data.tar.gz: 3f74c94e6af796112817eb92de1401767e837fe06ee4d9356473cffabdecb8ce8e896a16f86c3c74d007cd3f1fab899c8bbcca9a8f0f4f020031a6f35f60f248

data/CHANGELOG.md

@@ -34,6 +34,36 @@
 # Changelog
 All significant changes in the project are documented here.
 
+## v.0.5.0
+### Enhancements
+* [#25](https://github.com/C-S-D/carrot_rpc/pull/25) - [shamil614](https://github.com/shamil614)
+  * Timeout RpcClient requests when response is not received. 
+  * Default timeout is 5 seconds.
+  * Timeout is configurable.
+* [#27](https://github.com/C-S-D/carrot_rpc/pull/27) - [shamil614](https://github.com/shamil614)
+  * Simplify RpcClient usage.
+  * Each request which goes through `RpcClient.remote_request` ultimately needs to use a unique `reply_queue` on eqch request.
+  * By closing the channel and opening a new channel on each request we ensure that cleanup takes place by the deletion of the `reply_queue`.
+* [#29](https://github.com/C-S-D/carrot_rpc/pull/29) - [shamil614](https://github.com/shamil614)
+  * Implementations of the RpcClient need to be flexible with the key formatter.
+  * Formatting can be set globally via `Configuration`, overridden via passing Configuration object upon initializing client, or redefine `response_key_formatter` `request_key_formatter` methods.
+
+### Incompatible Changes
+* [#27](https://github.com/C-S-D/carrot_rpc/pull/27) - [shamil614](https://github.com/shamil614)
+  * Calling `rpc_client.start` and `rpc_client.channel.close` are no longer required when calling `rpc_client.remote_call` or the methods that call it (`index` `create`, etc).
+  * Calling `rpc_client.channel.close` after `rpc_client.remote_call` will cause an Exception to be raised as the channel is already closed.
+* [#29](https://github.com/C-S-D/carrot_rpc/pull/29) - [shamil614](https://github.com/shamil614)
+  * Replaced hard coded key formatter in place of a configurable option. 
+  * Need to set the following in config to maintain previous behavior
+  ```ruby
+   CarrotRpc.configure do |config|
+     # RpcServers expect the params to be dashed.
+     config.rpc_client_request_key_format = :dasherize
+     # In most cases the RpcClient instances use JSONAPI::Resource classes and the keys need to be transformed.
+     config.rpc_client_response_key_format = :underscore
+   end
+  ```
+
 ## v0.4.1
 ### Bug Fixes
 * [#23](https://githb.com/C-S-D/carrot_rpc/pull/23) - [shamil614](https://github.com/shamil614)

data/README.md

@@ -86,6 +86,12 @@ CarrotRpc.configure do |config|
   config.logger = CarrotRpc::TaggedLog.new(logger: Rails.logger, tags: ["Carrot RPC Client"])
   # Set a Proc to allow manipulation of the params on the RpcClient before the request is sent.
   config.before_request = proc { |params| params.merge(foo: "bar") }
+  # Number of seconds to wait before a RPC Client request timesout. Default 5 seconds.
+  config.rpc_client_timeout = 5
+  # Formats hash keys to stringified and replaces "_" with "-". Default is `:none` for no formatting.
+  config.rpc_client_request_key_format = :dasherize
+  # Formats hash keys to stringified and replaces "-" with "_". Default is `:none` for no formatting.
+  config.rpc_client_response_key_format = :underscore
 
   # Don't use. Server implementation only. The values below are set via CLI:
   # config.pidfile = nil
@@ -160,14 +166,21 @@ class CarsController < ApplicationController
 
   def show
     car_client = CarClient.new
-    car_client.start
     result = car_client.show({id: 1})
-    # Good idea to clean up connections when finished.
-    car_client.channel.close
   end
 end
 ```
 
+One way to implement a RpcClient is to override the default configuration.
+```ruby
+config = CarrotRPC.configuration.clone
+# Now only this one object will format keys as dashes
+config.rpc_client_response_key_format = :dasherize
+
+car_client = CarClient.new(config)
+```
+By duplicating the `Configuration` instance you can override the global configuration and pass a custom configuration to the RpcClient instance.
+
 ### 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.
 

data/carrot_rpc.gemspec

@@ -44,6 +44,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   # Style-checker
   spec.add_development_dependency "rubocop", "~> 0.36.0"
+  # Documentation
+  spec.add_development_dependency "yard", "~> 0.8"
 
   spec.required_ruby_version = "~> 2.2"
 end

data/lib/carrot_rpc/client_actions.rb

@@ -0,0 +1,34 @@
+# Methods similar to rails controller actions for RpcClient
+module CarrotRpc::ClientActions
+  # Convience method as a resource alias for index action.
+  # To customize, override the method in your class.
+  #
+  # @param params [Hash] the arguments for the method being called.
+  def index(params)
+    remote_call("index", params)
+  end
+
+  # Convience method as a resource alias for show action.
+  # To customize, override the method in your class.
+  #
+  # @param params [Hash] the arguments for the method being called.
+  def show(params)
+    remote_call("show", params)
+  end
+
+  # Convience method as a resource alias for create action.
+  # To customize, override the method in your class.
+  #
+  # @param params [Hash] the arguments for the method being called.
+  def create(params)
+    remote_call("create", params)
+  end
+
+  # Convience method as a resource alias for update action.
+  # To customize, override the method in your class.
+  #
+  # @param params [Hash] the arguments for the method being called.
+  def update(params)
+    remote_call("update", params)
+  end
+end

data/lib/carrot_rpc/configuration.rb

@@ -1,11 +1,11 @@
 # Global configuration for {CarrotRpc}.  Access with {CarrotRpc.configuration}.
 class CarrotRpc::Configuration
   attr_accessor :logger, :logfile, :loglevel, :daemonize, :pidfile, :runloop_sleep, :autoload_rails, :bunny,
-                :before_request
+                :before_request, :rpc_client_timeout, :rpc_client_response_key_format, :rpc_client_request_key_format
 
   # logfile - set logger to a file. overrides rails logger.
 
-  def initialize
+  def initialize # rubocop:disable Metrics/MethodLength
     @logfile = nil
     @loglevel = Logger::DEBUG
     @logger = nil
@@ -15,5 +15,8 @@ class CarrotRpc::Configuration
     @autoload_rails = true
     @bunny = nil
     @before_request = nil
-  end
+    @rpc_client_timeout = 5
+    @rpc_client_response_key_format = :none
+    @rpc_client_request_key_format = :none
+  end # rubocop:enable Metrics/MethodLength
 end

data/lib/carrot_rpc/error/code.rb

@@ -1,4 +1,4 @@
-# An enum of predefined {RpcServer::Server#code}
+# An enum of predefined error codes.
 module CarrotRpc::Error::Code
   # Internal JSON-RPC error.
   INTERNAL_ERROR   = -32_603

data/lib/carrot_rpc/exception.rb

@@ -0,0 +1,5 @@
+# Various exceptions that can be invoked for CarrotRpc gem.
+module CarrotRpc::Exception
+  # Exception to be raised when the client timesout waiting for a response.
+  class RpcClientTimeout < StandardError; end
+end

data/lib/carrot_rpc/rpc_client.rb

@@ -9,6 +9,7 @@ class CarrotRpc::RpcClient
   attr_reader :channel, :server_queue, :logger
 
   extend CarrotRpc::ClientServer
+  include CarrotRpc::ClientActions
 
   def self.before_request(*proc)
     if proc.length == 0
@@ -20,12 +21,44 @@ class CarrotRpc::RpcClient
     end
   end
 
-  # Use defaults for application level connection to RabbitMQ
-  # All RPC data goes over the same queue. I think that's ok....
-  def initialize(config: nil)
-    config ||= CarrotRpc.configuration
-    @channel = config.bunny.create_channel
-    @logger = config.logger
+  # Logic to process the renaming of keys in a hash.
+  # @param format [Symbol] :dasherize changes keys that have "_" to "-"
+  # @param format [Symbol] :underscore changes keys that have "-" to "_"
+  # @param format [Symbol] :skip, will not rename the keys
+  # @param data [Hash] data structure to be transformed
+  # @return [Hash] the transformed data
+  def self.format_keys(format, data)
+    case format
+    when :dasherize
+      data.rename_keys("_", "-")
+    when :underscore
+      data.rename_keys("-", "_")
+    when :none
+      data
+    else
+      data
+    end
+  end
+
+  # Use defaults for application level connection to RabbitMQ.
+  #
+  # @example pass custom {Configuration} class as an argument to override.
+  #   config = CarrotRpc::Configuration.new
+  #   config.rpc_client_timeout = 10
+  #   CarrotRpc::RpcClient.new(config)
+  def initialize(config = nil)
+    @config = config || CarrotRpc.configuration
+    @logger = @config.logger
+  end
+
+  # Starts the connection to listen for messages.
+  #
+  # All RpcClient requests go to the a single @server_queue
+  # Responses come back over a unique queue name.
+  def start
+    # Create a new channel on each request because the channel should be closed after each request.
+    @channel = @config.bunny.create_channel
+
     # auto_delete => false keeps the queue around until RabbitMQ restarts or explicitly deleted
     @server_queue = @channel.queue(self.class.queue_name, auto_delete: false)
 
@@ -33,8 +66,7 @@ class CarrotRpc::RpcClient
     @exchange = @channel.default_exchange
   end
 
-  # Starts the connection to listen for messages.
-  def start
+  def subscribe
     # Empty queue name ends up creating a randomly named queue by RabbitMQ
     # Exclusive => queue will be deleted when connection closes. Allows for automatic "cleanup".
     @reply_queue = @channel.queue("", exclusive: true)
@@ -45,9 +77,10 @@ class CarrotRpc::RpcClient
     # setup subscribe block to Service
     # block => false is a non blocking IO option.
     @reply_queue.subscribe(block: false) do |_delivery_info, properties, payload|
-      response = JSON.parse(payload).rename_keys("-", "_").with_indifferent_access
+      response = JSON.parse(payload).with_indifferent_access
 
       result = parse_response(response)
+      result = response_key_formatter(result).with_indifferent_access if result.is_a? Hash
       @results[properties[:correlation_id]].push(result)
     end
   end
@@ -61,20 +94,44 @@ class CarrotRpc::RpcClient
   # @param params [Hash] the arguments for the method being called.
   # @return [Object] the result of the method call.
   def remote_call(remote_method, params)
+    start
+    subscribe
     correlation_id = SecureRandom.uuid
     params = self.class.before_request.call(params) if self.class.before_request
-    publish(correlation_id: correlation_id, method: remote_method, params: params.rename_keys("_", "-"))
+    publish(correlation_id: correlation_id, method: remote_method, params: request_key_formatter(params))
     wait_for_result(correlation_id)
   end
 
   def wait_for_result(correlation_id)
-    # `pop` is `Queue#pop`, so it is blocking on the receiving thread 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.
-    result
+    # Should be good to timeout here because we're blocking in the main thread here.
+    Timeout.timeout(@config.rpc_client_timeout, CarrotRpc::Exception::RpcClientTimeout) do
+      # `pop` is `Queue#pop`, so it is blocking on the receiving thread
+      # 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.
+      result
+    end
+  ensure
+    @channel.close
+  end
+
+  # Formats keys in the response data.
+  # @param payload [Hash] response data received from the remote server.
+  # @return [Hash] formatted data structure.
+  def response_key_formatter(payload)
+    self.class.format_keys @config.rpc_client_response_key_format, payload
+  end
+
+  # Formats keys in the request data.
+  # @param payload [Hash] request data to be sent to the remote server.
+  # @return [Hash] formatted data structure.
+  def request_key_formatter(params)
+    self.class.format_keys @config.rpc_client_request_key_format, params
   end
 
+  # A @reply_queue is deleted when the channel is closed.
+  # Closing the channel accounts for cleanup of the client @reply_queue.
   def publish(correlation_id:, method:, params:)
     message = message(
       correlation_id: correlation_id,
@@ -96,38 +153,6 @@ class CarrotRpc::RpcClient
     }
   end
 
-  # Convience method as a resource alias for index action.
-  # To customize, override the method in your class.
-  #
-  # @param params [Hash] the arguments for the method being called.
-  def index(params)
-    remote_call("index", params)
-  end
-
-  # Convience method as a resource alias for show action.
-  # To customize, override the method in your class.
-  #
-  # @param params [Hash] the arguments for the method being called.
-  def show(params)
-    remote_call("show", params)
-  end
-
-  # Convience method as a resource alias for create action.
-  # To customize, override the method in your class.
-  #
-  # @param params [Hash] the arguments for the method being called.
-  def create(params)
-    remote_call("create", params)
-  end
-
-  # Convience method as a resource alias for update action.
-  # To customize, override the method in your class.
-  #
-  # @param params [Hash] the arguments for the method being called.
-  def update(params)
-    remote_call("update", params)
-  end
-
   private
 
   # Logic to find the data from the RPC response.

data/lib/carrot_rpc/server_runner/pid.rb

@@ -75,7 +75,7 @@ class CarrotRpc::ServerRunner::Pid
 
   ## Instance Methods
 
-  # Exits if {#status} indicates server is already running, otherwise deletes {#path}.
+  # Exits if status indicates server is already running, otherwise deletes {#path}.
   #
   # @return [void]
   def check

data/lib/carrot_rpc/server_runner/signals.rb

@@ -1,4 +1,4 @@
-# Traps all {the signals NAMES} that should be intercepted by a long-running background process.
+# Traps all the signals {NAMES} that should be intercepted by a long-running background process.
 module CarrotRpc::ServerRunner::Signals
   # CONSTANTS
 

data/lib/carrot_rpc/version.rb

@@ -1,3 +1,3 @@
 module CarrotRpc
-  VERSION = "0.4.1".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/carrot_rpc.rb

@@ -18,9 +18,11 @@ module CarrotRpc
   extend ActiveSupport::Autoload
 
   autoload :CLI
+  autoload :ClientActions
   autoload :ClientServer
   autoload :Configuration
   autoload :Error
+  autoload :Exception
   autoload :HashExtensions
   autoload :RpcClient
   autoload :RpcServer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrot_rpc
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Scott Hamilton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,6 +109,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.36.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Streamlined approach to setting up RPC over RabbitMQ.
 email:
 - shamil614@gmail.com
@@ -138,10 +152,12 @@ files:
 - circle.yml
 - lib/carrot_rpc.rb
 - lib/carrot_rpc/cli.rb
+- lib/carrot_rpc/client_actions.rb
 - lib/carrot_rpc/client_server.rb
 - lib/carrot_rpc/configuration.rb
 - lib/carrot_rpc/error.rb
 - lib/carrot_rpc/error/code.rb
+- lib/carrot_rpc/exception.rb
 - lib/carrot_rpc/hash_extensions.rb
 - lib/carrot_rpc/rpc_client.rb
 - lib/carrot_rpc/rpc_server.rb