carrot_rpc 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db8c95c8b6b864d2c0af65ec4387ec19f890c73a
-  data.tar.gz: 3ee199f732826c03aaaa9cdbd480da06a0f8fda8
+  metadata.gz: 99b2493a7ffe385eee686f6d78b57e7e2240d370
+  data.tar.gz: 6839c61baeafbeb0097bf89badd080d1d05c480d
 SHA512:
-  metadata.gz: 8f69595a1d3fde344503ac5dc1c10b812fa805745d1c107a7bf60955f7b5f6fcff651c5537cf91973f945b98436d7c56394c3eebb081062878e1eefc0b59f323
-  data.tar.gz: f4cfde4d0993018cfecf9d6507e18e4496cda93fa5826d4ecbc663a56f331cc28ec0da96299e50d98f90c11dcbe69626d44779f5d113d6726d57ec9d661336ad
+  metadata.gz: e611390a7dbc157412efbdd2c472c1358b1a7f6a62ca69e9637f010d46cf4382ec2a7f545e1279189aa4b1dac5426b74f7f30b7fdc326788069669470fd44d88
+  data.tar.gz: c6ccb1a6315f64c9180b938d551a1d38ea174ff95bc2dd48d729efe9dfa162f78069e4f7a10131f96de735bcd35eb4535afd989931684ce37d026686b67e11d9

data/CHANGELOG.md

@@ -3,22 +3,25 @@
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
 - [Changelog](#changelog)
-  - [v0.2.3](#v023)
+  - [v0.3.0](#v030)
     - [Enhancements](#enhancements)
     - [Bug Fixes](#bug-fixes)
+  - [v0.2.3](#v023)
+    - [Enhancements](#enhancements-1)
+    - [Bug Fixes](#bug-fixes-1)
     - [Upgrading](#upgrading)
   - [v0.2.1](#v021)
-    - [Bug Fixes](#bug-fixes-1)
-  - [v0.2.0](#v020)
-    - [Enhancements](#enhancements-1)
     - [Bug Fixes](#bug-fixes-2)
-    - [Incompatible Changes](#incompatible-changes)
-  - [v0.1.2](#v012)
+  - [v0.2.0](#v020)
     - [Enhancements](#enhancements-2)
     - [Bug Fixes](#bug-fixes-3)
-  - [v0.1.1](#v011)
+    - [Incompatible Changes](#incompatible-changes)
+  - [v0.1.2](#v012)
     - [Enhancements](#enhancements-3)
     - [Bug Fixes](#bug-fixes-4)
+  - [v0.1.1](#v011)
+    - [Enhancements](#enhancements-4)
+    - [Bug Fixes](#bug-fixes-5)
     - [Incompatible Changes](#incompatible-changes-1)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -26,11 +29,22 @@
 # Changelog
 All significant changes in the project are documented here.
 
-## v0.2.3
+## v0.3.0
+
+### Enhancements
+* [#11](https://githb.com/C-S-D/carrot_rpc/pull/11) - Add CodeClimate badge to README - [thewalkingtoast](https://github.com/thewalkingtoast)
+* [#13](https://githb.com/C-S-D/carrot_rpc/pull/13) - Document `queue_name` - [shamil614](https://github.com/shamil614)
+* [#14](https://githb.com/C-S-D/carrot_rpc/pull/14) - Pass `rpc_request: true` in the `JSONAPI::Request` `context`, so resources can differentiate between API and RPC calls - [shamil614](https://github.com/shamil614)
 
+### Bug Fixes
+* [#12](https://githb.com/C-S-D/carrot_rpc/pull/12) - Pass `request` to `render_errors` when handling exceptions in `CarrotRpc::RpcServer::JSONAPIResources` - [shamil614](https://github.com/shamil614)
+* [#15](https://githb.com/C-S-D/carrot_rpc/pull/15) - Fix argument error bug when passing block to `CarrotRpc::TaggedLog` methods by allowing either a message or a block like standard `Logger` interface - [shamil614](https://github.com/shamil614)
+* [#17](https://githb.com/C-S-D/carrot_rpc/pull/17) - New rubocop versions add new cops or deprecate old config settings, so it is not safe to have `"rubocop"` without a version in the gemspec. - [KronicDeth](http://github.com/kronicdeth)
+
+## v0.2.3
 
 ### Enhancements
-* [#9](https://github.com/C-S-D/carrot_rpc/pull/9) - [KronicDeth](http://github.com/KronicDeth)
+* [#9](https://github.com/C-S-D/carrot_rpc/pull/9) - [KronicDeth](http://github.com/kronicdeth)
   * `CarrotRpc::RpcServer` subclasses can `include CarrotRpc::RpcServer::JSONAPIResources` to get
     [`JSONAPI::ActsAsResourceController`](https://github.com/cerebris/jsonapi-resources/blob/8e85d68dfbaf9181344c7618b0b29b4cfd362034/lib/jsonapi/acts_as_resource_controller.rb)
     helper methods for processing JSONAPI requests in server methods.

data/README.md

@@ -19,6 +19,7 @@
 
 An opinionated approach to doing Remote Procedure Call (RPC) with RabbitMQ and the bunny gem. CarrotRpc serves as a way to streamline the RPC workflow so developers can focus on the implementation and not the plumbing when working with RabbitMQ.
 
+[![Code Climate](https://codeclimate.com/github/C-S-D/carrot_rpc/badges/gpa.svg)](https://codeclimate.com/github/C-S-D/carrot_rpc)
 [![Circle CI](https://circleci.com/gh/C-S-D/carrot_rpc.svg?style=svg)](https://circleci.com/gh/C-S-D/carrot_rpc)
 
 ## Installation
@@ -42,7 +43,7 @@ There's two modes for CarrotRpc: server and client. The server is run via comman
 ### Server
 The server is configured via command line and run in it's own process.
 
-Carrot is easy to run via command line: 
+Carrot is easy to run via command line:
 ```bash
 carrot_rpc
 ```
@@ -75,15 +76,15 @@ Clients are configured by initializing `CarrotRpc::Configuration`. The most comm
 
 ```ruby
 CarrotRpc.configure do |config|
-  # Required on the client to connect to RabbitMQ. 
+  # Required on the client to connect to RabbitMQ.
   # Bunny defaults to connecting to ENV['RABBITMQ_URL']. See Bunny docs.
   config.bunny = Bunny.new.start
   # Set the log level. Ruby Logger Docs http://ruby-doc.org/stdlib-2.2.0/libdoc/logger/rdoc/Logger.html
   config.loglevel = Logger::INFO
-  # Create a new logger or use the Rails logger. 
+  # 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"])
-  
+
   # Don't use. Server implementation only. The values below are set via CLI:
   # config.pidfile = nil
   # config.runloop_sleep = 0
@@ -93,12 +94,14 @@ end
 
 ## Usage
 ### Writing Servers
-Carrot CLI will look for your servers in `app/servers` directory. This directory should not be autoloaded by the host application.
+Carrot CLI will look for your servers in `app/servers` directory. This directory should not be autoloaded by the host application. Very important to declare the name of the queue with `queue_name`. The name must be the same as what's implemented in the `Client`.
 
 
 Example Server: `app/servers/car_server.rb`
 ```ruby
 class CarServer < CarrotRpc::RpcServer
+  queue_name "car_queue"
+
   def show(params)
     # ...do something
     Car.find(params[:id]).to_json
@@ -127,11 +130,13 @@ end
 ```
 
 ### Writing Clients
-Clients are not run in the CLI, and are typlically invoked during a request / response lifecycle in a web application. In the case of Rails, Clients would most likely be used in a controller action. Clients should be written in the `app/clients` directory of the host application, and should be autoloaded by Rails.
+Clients are not run in the CLI, and are typlically invoked during a request / response lifecycle in a web application. In the case of Rails, Clients would most likely be used in a controller action. Clients should be written in the `app/clients` directory of the host application, and should be autoloaded by Rails. The name of the queue to send messages to must be declared with `queue_name`.
 
 Example Client: `app/clients/cars_client.rb`
 ```ruby
   class CarClient < CarrotRpc::RpcClient
+    queue_name "car_queue"
+
     # By default RpcClient defines the following Railsy inspired methods:
     # def show(params)
     # def index(params)
@@ -147,6 +152,8 @@ Example Client: `app/clients/cars_client.rb`
 Example Rails Controller:
 ```ruby
 class CarsController < ApplicationController
+  queue_name "car_queue"
+
   def show
     car_client = CarClient.new
     car_client.start
@@ -157,6 +164,42 @@ class CarsController < ApplicationController
 end
 ```
 
+### 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.
+
+Example Server with JSONAPI functionality:
+```ruby
+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)
+    # ...do something
+    Car.find(params[:id]).to_json
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/carrot_rpc.gemspec

@@ -43,7 +43,7 @@ Gem::Specification.new do |spec|
   # Unit test framework
   spec.add_development_dependency "rspec"
   # Style-checker
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop", "~> 0.36.0"
 
   spec.required_ruby_version = "~> 2.2"
 end

data/lib/carrot_rpc/rpc_server/jsonapi_resources.rb

@@ -77,7 +77,7 @@ module CarrotRpc::RpcServer::JSONAPIResources
       logger.error { # rubocop:disable Style/BlockDelimiters
         "Internal Server Error: #{exception.message} #{exception.backtrace.join("\n")}"
       }
-      render_errors(internal_server_error.errors)
+      render_errors(internal_server_error.errors, request: request)
     end
   end
 
@@ -101,7 +101,7 @@ module CarrotRpc::RpcServer::JSONAPIResources
   def process_request_params(params) # rubocop:disable Metrics/MethodLength
     request = JSONAPI::Request.new(
       params,
-      context: {},
+      context: { rpc_request: true },
       key_formatter: key_formatter,
       server_error_callbacks: []
     )

data/lib/carrot_rpc/tagged_log.rb

@@ -17,8 +17,8 @@ class CarrotRpc::TaggedLog
 
   # Dyanmically define logger methods with a tagged reference. Makes filtering of logs possible.
   %i(debug info warn error fatal unknown).each do |level|
-    define_method(level) do |msg|
-      logger.tagged(tags) { logger.send(level, msg) }
+    define_method(level) do |msg = nil, &block|
+      logger.tagged(tags) { logger.send(level, msg || block.call) }
     end
   end
 end

data/lib/carrot_rpc/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrot_rpc
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Scott Hamilton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -99,16 +99,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.36.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.36.0
 description: Streamlined approach to setting up RPC over RabbitMQ.
 email:
 - shamil614@gmail.com