carrot_rpc 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99b2493a7ffe385eee686f6d78b57e7e2240d370
-  data.tar.gz: 6839c61baeafbeb0097bf89badd080d1d05c480d
+  metadata.gz: fa0a0dee401c7064c07550c3c601e23353d2a88c
+  data.tar.gz: 6994fbf5613108aed02b583bfa4f900ac2311ea5
 SHA512:
-  metadata.gz: e611390a7dbc157412efbdd2c472c1358b1a7f6a62ca69e9637f010d46cf4382ec2a7f545e1279189aa4b1dac5426b74f7f30b7fdc326788069669470fd44d88
-  data.tar.gz: c6ccb1a6315f64c9180b938d551a1d38ea174ff95bc2dd48d729efe9dfa162f78069e4f7a10131f96de735bcd35eb4535afd989931684ce37d026686b67e11d9
+  metadata.gz: 96d9d94ac495890858a71d5cf6bb5fb87390c123217c40220070cc2c56a27a67757fcd79b66041db1a9f588976b9135289b48a6c92e30f67d350f7affc47ec30
+  data.tar.gz: c57f379c26ea30abf880ea0c0b44d1303ab5635aad92bb7ecef87ac9e1ed6cee4e8ef1c1e8f8b49d8571481ca1792b1db5c658416ad70516136fa39de34702c3

data/CHANGELOG.md

@@ -29,6 +29,16 @@
 # Changelog
 All significant changes in the project are documented here.
 
+## v0.4.0
+
+### Enhancements
+* [#20](https://githb.com/C-S-D/carrot_rpc/pull/20) - `config.before_request` may be set with a `#call(params) :: params` that is passed the `params` and returns altered `params` that are published to the queue. - [shamil614](https://github.com/shamil614)
+
+### Bug Fixes
+* [#19](https://githb.com/C-S-D/carrot_rpc/pull/19) - [KronicDeth](http://github.com/kronicdeth)
+  * Put JSONAPI errors documents into the JSONRPC error fields instead of returning as normal results as consumers, such as `Rpc.Generic.Client` are expecting all errors to be in JSONRPC's error field and not have to check if the non-error `result` contains a JSONAPI level error.  This achieves parity with the behavior in the Elixir `Rpc.Generic.Server`.
+  * Scrub JSONAPI error fields that are `nil` so they don't get transmitted as `null`.  JSONAPI spec is quite clear that `null` columns shouldn't be transmitted except in the case of `null` data to signal a missing singleton resource.  This achieves compatibility with the error parsing in `Rpc.Generic.Client` in Elixir.
+
 ## v0.3.0
 
 ### Enhancements

data/README.md

@@ -84,6 +84,8 @@ CarrotRpc.configure do |config|
   # Create a new logger or use the Rails logger.
   # When using Rails, use a tagged log to make it easier to track RPC.
   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") }
 
   # Don't use. Server implementation only. The values below are set via CLI:
   # config.pidfile = nil
@@ -136,6 +138,8 @@ Example Client: `app/clients/cars_client.rb`
 ```ruby
   class CarClient < CarrotRpc::RpcClient
     queue_name "car_queue"
+    # optional hook to modify params before submission
+    before_request proc { |params| params.merge(foo: "bar") }
 
     # By default RpcClient defines the following Railsy inspired methods:
     # def show(params)

data/lib/carrot_rpc/configuration.rb

@@ -1,6 +1,7 @@
 # Global configuration for {CarrotRpc}.  Access with {CarrotRpc.configuration}.
 class CarrotRpc::Configuration
-  attr_accessor :logger, :logfile, :loglevel, :daemonize, :pidfile, :runloop_sleep, :autoload_rails, :bunny
+  attr_accessor :logger, :logfile, :loglevel, :daemonize, :pidfile, :runloop_sleep, :autoload_rails, :bunny,
+                :before_request
 
   # logfile - set logger to a file. overrides rails logger.
 
@@ -13,5 +14,6 @@ class CarrotRpc::Configuration
     @runloop_sleep = 0
     @autoload_rails = true
     @bunny = nil
+    @before_request = nil
   end
 end

data/lib/carrot_rpc/rpc_client.rb

@@ -10,6 +10,16 @@ class CarrotRpc::RpcClient
 
   extend CarrotRpc::ClientServer
 
+  def self.before_request(*proc)
+    if proc.length == 0
+      @before_request
+    elsif proc.length == 1
+      @before_request = proc.first || CarrotRpc.configuration.before_request
+    else
+      fail ArgumentError
+    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)
@@ -50,6 +60,7 @@ class CarrotRpc::RpcClient
   # @return [Object] the result of the method call.
   def remote_call(remote_method, params)
     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("_", "-"))
     wait_for_result(correlation_id)
   end

data/lib/carrot_rpc/rpc_server/jsonapi_resources.rb

@@ -51,7 +51,7 @@ module CarrotRpc::RpcServer::JSONAPIResources
       primary_resource_klass: resource_klass,
       include_directives: request ? request.include_directives : nil,
       fields: request ? request.fields : nil,
-      base_url: base_url,
+      base_url: base_url(operation_results, request),
       key_formatter: key_formatter,
       route_formatter: route_formatter,
       base_meta: base_meta(request),

data/lib/carrot_rpc/rpc_server.rb

@@ -67,11 +67,42 @@ class CarrotRpc::RpcServer
 
   # See http://www.jsonrpc.org/specification#response_object
   def reply_result(result, properties:, request_message:)
-    response_message = { id: request_message[:id], result: result, jsonrpc: "2.0" }
+    if result["errors"]
+      reply_result_with_errors(result, properties: properties, request_message: request_message)
+    else
+      reply_result_without_errors(result, properties: properties, request_message: request_message)
+    end
+  end
+
+  def reply_result_with_errors(result, properties:, request_message:)
+    scrubbed_result = result.merge(
+      "errors" => scrub_errors(result.fetch("errors"))
+    )
+    reply_error({ code: 422, data: scrubbed_result, message: "JSONAPI error" },
+                properties: properties,
+                request_message: request_message)
+  end
+
+  def reply_result_without_errors(result, properties:, request_message:)
+    response_message = { id: request_message[:id], jsonrpc: "2.0", result: result }
 
     logger.debug "Publishing result: #{result} to #{response_message}"
 
     reply properties: properties,
           response_message: response_message
   end
+
+  # Removes `nil` values as JSONAPI spec expects unset keys not to be transmitted
+  def scrub_error(error)
+    error.reject { |_, value|
+      value.nil?
+    }
+  end
+
+  # Removes `nil` values as JSONAPI spec expects unset keys not to be transmitted
+  def scrub_errors(errors)
+    errors.map { |error|
+      scrub_error(error)
+    }
+  end
 end

data/lib/carrot_rpc/version.rb

@@ -1,3 +1,3 @@
 module CarrotRpc
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrot_rpc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Scott Hamilton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport