rodent 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 242d93035344222686b1756ce592417080f9631b
-  data.tar.gz: 40812bd7ee47172f5f3b8785e3f6ed42510fef9c
+  metadata.gz: 9c5f5acd62d35708b4c479376ee213fce72db021
+  data.tar.gz: f5a167799d4f338b0f710bc9b37e0938b0c2218a
 SHA512:
-  metadata.gz: f86582528021e17f9754a258c20c74cdb1a55772b29f1d1d07f53de080c94c91698e25431f6d5f8dc5f3bde7508021adbac595f10dcf1445f4162f04e2af9fed
-  data.tar.gz: 1b50d4dfa8bb5ba18a5553440806f4388789fa3417c229bcd05c0a2b4e938b125b86a84950e6053fec89d6a05af163160ef17f27bf9d7bf7f6c5d2bd570c1682
+  metadata.gz: 1835d65838471df32ea85c56ed15f6cc0fe0bfa2a5ae9aa466179fb829e20f0f33a06faf4b6a64e5be7c7480e305b4db492e4974578978d7e346ceb5dcc67d1f
+  data.tar.gz: dd91fa08ee77cc2196cb8cac75c4dfaa1534e6b8477f273fee6490577dc0b94e33bc3a4f4c3a091fc671da6eda09d34167f7c82351979acbef896d77e0abe724

data/.gitignore

@@ -1,3 +1,5 @@
 Gemfile.lock
 log/*.log
 *.gem
+.yardoc/
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+services:
+  - rabbitmq

data/.yardopts

@@ -0,0 +1,4 @@
+--main README.md
+--no-private
+--markup-provider=redcarpet
+--markup=markdown

data/README.md

@@ -0,0 +1,156 @@
+# Rodent
+
+[![Code Climate](https://codeclimate.com/github/kkdoo/rodent.png)](https://codeclimate.com/github/kkdoo/rodent) [![Build Status](https://travis-ci.org/kkdoo/rodent.png?branch=master)](https://travis-ci.org/kkdoo/rodent) [![Dependency Status](https://gemnasium.com/kkdoo/rodent.png)](https://gemnasium.com/kkdoo/rodent)
+
+Rodent is an open source asynchronous framework for Micro Service Architecture (MSA). It is a lightweight and designed to easily develop APIs. Main goals is scaling, simplicity and perfomance.
+
+The framework uses [Goliath](https://github.com/postrank-labs/goliath) as HTTP proxy and [AMQP](https://github.com/ruby-amqp/amqp) protocol to connect MSA for handling requests. Micro Services can be run separately and multiple times for scaling, hot-reloading or language independence. All requests are load balanced with same MSA.
+
+You can learn more about MSA in great [article](http://yobriefca.se/blog/2013/04/29/micro-service-architecture/) by James Hughes.
+
+## Installation & Prerequisites
+
+Rodent is available as a gem, to install it just install the gem
+
+```bash
+$> gem install rodent
+```
+
+If you're using Bundler, add the gem to Gemfile
+
+```ruby
+gem 'rodent'
+```
+
+## Getting Started: Hello World
+
+Proxy server for sending HTTP requests into Micro Service (based on [Grape](https://github.com/intridea/grape))
+
+```ruby
+# proxy.rb
+
+require 'rodent'
+require 'grape'
+
+class CustomersProxy < Grape::API
+  version 'v1', using: :path
+  format :json
+  default_format :json
+
+  resource :customers do
+    params do
+      requires :name, type: String
+      requires :email, type: String
+    end
+    post '/' do
+      header 'Rodent-Proxy', 'customers.create'
+
+      {name: params[:name], email: params[:email]}
+    end
+  end
+end
+
+class ProxyApp < Goliath::API
+  plugin Rodent::Goliath::Plugin
+  use Rodent::Goliath::Middleware
+
+  def response(env)
+    CustomersProxy.call(env)
+  end
+end
+```
+
+Micro Service for handling requests
+
+```ruby
+# customers.rb
+
+require 'rodent'
+
+class Customer
+  attr_accessor :name, :email
+
+  def initialize(options)
+    @name = options['name']
+    @email = options['email']
+  end
+
+  def as_json
+    {recipient: [name, ' <', email, '>'].join}
+  end
+end
+
+class CustomersAPI < Rodent::Base
+  listen 'customers.create' do
+    self.status = 201
+
+    @customer = Customer.new(params)
+    @customer.as_json
+  end
+end
+
+class CustomersServer < Rodent::Server
+  configure do
+    set :connection, 'amqp://guest:guest@localhost'
+  end
+
+  run do
+    Signal.trap('INT') { Rodent::Server.stop }
+
+    [CustomersAPI]
+  end
+end
+```
+
+Run proxy server
+
+```bash
+$> ruby proxy.rb -v -s -e development -p 3000
+```
+
+Run micro service
+
+```bash
+$> ruby customers.rb
+```
+
+Then you can test it
+```bash
+$> curl -X POST localhost:3000/v1/customers -d "name=Bob" -d "email=bob@example.com"
+```
+
+## Performance
+
+My results is below
+
+```bash
+Server Software:        Goliath
+Server Hostname:        localhost
+Server Port:            3000
+
+Document Path:          /v1/customers
+Document Length:        2 bytes
+
+Concurrency Level:      50
+Time taken for tests:   2.450 seconds
+Complete requests:      1000
+Failed requests:        0
+Write errors:           0
+Total transferred:      126000 bytes
+HTML transferred:       2000 bytes
+Requests per second:    408.18 [#/sec] (mean)
+Time per request:       122.495 [ms] (mean)
+Time per request:       2.450 [ms] (mean, across all concurrent requests)
+Transfer rate:          50.23 [Kbytes/sec] received
+
+Connection Times (ms)
+              min  mean[+/-sd] median   max
+Connect:        0    2   1.0      2       5
+Processing:    51  118  40.5    116     233
+Waiting:       45  116  41.0    115     232
+Total:         51  120  40.7    117     235
+```
+
+## License & Acknowledgments
+
+Rodent is distributed under the MIT license, for full details please see the LICENSE file.

data/lib/rodent/goliath/middleware.rb

@@ -39,23 +39,26 @@ module Rodent
           replies_queue = channel.queue(message_id, exclusive: true, auto_delete: true)
 
           consumer = AMQP::Consumer.new(channel, replies_queue)
-
-          consumer.consume do
-            consumer.on_delivery do |metadata, payload|
-              response = MultiJson.load(payload)
-              response['headers']['Content-Length'] = response['body'].length.to_s
-              response['headers']['Content-Type'] = 'application/json'
-              async_callback.call([response['status'], headers.merge(response['headers']), response['body']])
-              metadata.ack
-              consumer.cancel
-            end
-          end
+          bind_consumer(consumer, async_callback, headers)
 
           channel.direct('rodent.requests').publish(body, routing_key: type, message_id: message_id, reply_to: replies_queue.name)
         end
 
         ::Goliath::Connection::AsyncResponse
       end
+
+      def bind_consumer(consumer, async_callback, headers)
+        consumer.consume do
+          consumer.on_delivery do |metadata, payload|
+            response = MultiJson.load(payload)
+            response['headers']['Content-Length'] = response['body'].length.to_s
+            response['headers']['Content-Type'] = 'application/json'
+            async_callback.call([response['status'], headers.merge(response['headers']), response['body']])
+            metadata.ack
+            consumer.cancel
+          end
+        end
+      end
     end
   end
 end

data/lib/rodent/version.rb

@@ -1,3 +1,3 @@
 module Rodent
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/rodent.gemspec

@@ -28,6 +28,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'em-http-request'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'evented-spec'
+  s.add_development_dependency 'redcarpet'
+  s.add_development_dependency 'yard'
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/rodent/base_spec.rb

@@ -29,7 +29,9 @@ describe Rodent::Base do
       end
     end
 
-    CustomersAPI.bind
+    done do
+      CustomersAPI.bind
+    end
   end
 
   after(:all) do
@@ -40,9 +42,10 @@ describe Rodent::Base do
   it 'should return right response' do
     params = {name: 'Bob Marley', email: 'bob@example.com'}
 
-    @channel.direct('rodent.requests').publish(MultiJson.dump(params), routing_key: 'customers.create', message_id: @message_id, reply_to: @replies_queue.name)
+    @channel.direct('rodent.requests').publish MultiJson.dump(params), routing_key: 'customers.create',
+      message_id: @message_id, reply_to: @replies_queue.name
 
-    done(0.5) do
+    done(2.0) do
       @response.should_not be_nil
       @response['status'].should == 201
       @response['headers'].should == {'API-Version' => 'v1'}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodent
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Artem Maschenko
@@ -150,6 +150,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Framework for micro services
 email:
 - artem.maschenko@gmail.com
@@ -158,8 +186,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - examples/customers.rb
 - examples/proxy.rb