praetor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e766c0c764dc7a7c5c4eeb8783e80dbbf9aaaa7
+  data.tar.gz: 0890736ceb2ff8f79d4fed123e9946e3586947d0
+SHA512:
+  metadata.gz: 9cc8b688b40364c94075100b99965a563c2436a7a57c169fe6d4e01bfae4da8698ee44ecddd87c1483980211205636f5d1fcb606d4fcc7d21be9a7d851a09e1e
+  data.tar.gz: 98a5866a157a5787a047cc6054e513b751d4567d2770f599c945f3c7f6a8cfee6e81f48a3a102ddc159757b634d6cffb09eaac5552b72ee4f94a0c0e8f3b4901

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+ruby '2.2.0'
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in praetor.gemspec
+gemspec
+
+# Until 0.10 is released, we need to use the git repo
+gem 'active_model_serializers', github: 'rails-api/active_model_serializers'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nick DeMonner
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Praetor [![Circle CI](https://circleci.com/gh/SenecaSystems/praetor.svg?style=svg)](https://circleci.com/gh/SenecaSystems/praetor)
+
+Lightweight microservices for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'praetor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install praetor
+
+## Usage
+
+You'll need to have a Redis instance running. Praetor checks for `REDIS_PROVIDER`
+by default to find a connection URL. Otherwise, it just uses `Redis.new`.
+
+See `spec/support/echo_service` for an example service implementation.
+
+See `spec/service_client_spec.rb` for an example of how clients can consume Services.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/praetor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/praetor/service.rb

@@ -0,0 +1,87 @@
+require 'redis'
+require 'json'
+require_relative 'service_controller'
+
+module Praetor
+  class Service
+    class << self
+      attr_reader :_controllers
+
+      def controller(klass)
+        klass.include ServiceController
+        (@_controllers ||= []) << klass
+      end
+
+      def endpoint
+        @endpoint ||= name.underscore
+      end
+    end
+
+    attr_accessor :redis
+
+    def run
+      client_options = ENV['REDIS_PROVIDER'] ? { url: ENV['REDIS_PROVIDER'] } : {}
+      @redis = Redis.new client_options
+
+      loop do
+        # Pop off the next request (or block until one arrives)
+        _, request = @redis.brpop self.class.endpoint
+
+        # You can shut down a service by issuing a stop command; useful for testing
+        break if request == 'stop'
+        handle_request JSON.parse(request)
+      end
+    end
+
+    def dispatch!(request)
+      controller = request['controller']
+      action     = request['action']
+      params     = request['params'] || {}
+
+      check_controller! controller
+
+      klass = controller.constantize
+      check_action! klass, action
+
+      instance = klass.new
+      instance.instance_variable_set :@params, params
+      instance.send action
+    end
+
+    private
+
+    def check_controller!(controller)
+      unless self.class._controllers.map(&:name).include? controller
+        raise "No controller that matches `#{controller}`"
+      end
+    end
+
+    def check_action!(controller, action)
+      unless controller.method_defined? action
+        raise "No action `#{action}` for controller `#{controller}`"
+      end
+    end
+
+    def handle_request(request)
+      response = begin
+        data = dispatch! request
+        { 'status' => 'ok', 'data' => data }
+      rescue Exception => e
+        {
+          'status' => 'error',
+          'data'   => { 'message' => e.message, 'backtrace' => e.backtrace }
+        }
+      end
+
+      respond response.merge('key' => request['key'])
+    end
+
+    def respond(response)
+      # Push the response onto a new list using the request/response key
+      @redis.rpush response['key'], JSON.generate(response)
+
+      # Set an expire time for our list to make sure we don't leak
+      @redis.expire response['key'], 30
+    end
+  end
+end

data/lib/praetor/service_client.rb

@@ -0,0 +1,40 @@
+require 'rubyflake'
+require 'hashie'
+
+module Praetor
+  class ServiceClient
+    attr_accessor :redis, :service_endpoint
+
+    def initialize(service_endpoint)
+      @service_endpoint = service_endpoint
+
+      client_options = ENV['REDIS_PROVIDER'] ? { url: ENV['REDIS_PROVIDER'] } : {}
+      @redis = Redis.new client_options
+    end
+
+    def request(path, params = {})
+      path_parts = path.split '#'
+      req = {
+        'key'        => Rubyflake.generate.to_s(32),
+        'controller' => "#{path_parts.first.camelize}Controller",
+        'action'     => path_parts.last,
+        'params'     => params
+      }
+
+      redis.lpush service_endpoint, JSON.generate(req)
+      _, response = redis.brpop req['key']
+      parsed_response = Hashie::Mash.new JSON.parse(response)
+
+      if parsed_response.status == 'ok'
+        parsed_response.data
+      else
+        raise "Service error: #{parsed_response.data.message} #{parsed_response.data.backtrace.join("\n")}"
+      end
+    end
+
+    # Used primarily during testing to stop the run loop of a service
+    def stop_service
+      redis.lpush service_endpoint, 'stop'
+    end
+  end
+end

data/lib/praetor/service_controller.rb

@@ -0,0 +1,28 @@
+require 'active_support/concern'
+
+module Praetor
+  module ServiceController
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :params
+    end
+
+    def serialize_collection(collection)
+      serializer = ActiveModel::Serializer::ArraySerializer.new collection
+      serialize_with serializer
+    end
+
+    def serialize(resource)
+      serializer = "#{resource.class.name}Serializer".constantize.new resource
+      serialize_with serializer
+    end
+
+    private
+
+    def serialize_with(serializer)
+      adapter = ActiveModel::Serializer::Adapter.create serializer
+      adapter.as_json
+    end
+  end
+end

data/lib/praetor/version.rb

@@ -0,0 +1,3 @@
+module Praetor
+  VERSION = "0.1.0"
+end

data/lib/praetor.rb

@@ -0,0 +1,6 @@
+require "praetor/version"
+require "praetor/service"
+require "praetor/service_client"
+
+module Praetor
+end

data/praetor.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'praetor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "praetor"
+  spec.version       = Praetor::VERSION
+  spec.authors       = ["Nick DeMonner"]
+  spec.email         = ["nick@seneca.systems"]
+  spec.summary       = "Lightweight microservices for Ruby"
+  spec.description   = "Lightweight microservices for Ruby"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "activemodel"
+  spec.add_runtime_dependency "hashie"
+  spec.add_runtime_dependency "rubyflake"
+  spec.add_runtime_dependency "redis"
+  spec.add_runtime_dependency "oj"
+  spec.add_runtime_dependency "oj_mimic_json"
+  spec.add_runtime_dependency "activesupport"
+end

data/spec/service_client_spec.rb

@@ -0,0 +1,21 @@
+require './lib/praetor/service_client'
+require './lib/praetor/service'
+require './spec/support/echo_service/service'
+
+RSpec.describe Praetor::ServiceClient do
+  let(:client) { Praetor::ServiceClient.new 'echo_service' }
+  before { Thread.new { EchoService.new.run } }
+  after { client.stop_service }
+
+  it 'can call an action on the service' do
+    response = client.request('echo#echo', 'hi there')
+    expect(response).to eq 'hi there'
+
+    response = client.request('double_echo#echo', 'hi')
+    expect(response).to eq 'hihi'
+  end
+
+  it 'propagates exceptions raised in the service' do
+    expect { client.request('echo#nope') }.to raise_error
+  end
+end

data/spec/service_controller_spec.rb

@@ -0,0 +1,32 @@
+require 'active_model'
+require 'active_model_serializers'
+require './lib/praetor/service_controller'
+
+class SomeModel
+  include ActiveModel::Model
+  include ActiveModel::Serialization
+  attr_accessor :id
+end
+
+class SomeModelSerializer < ActiveModel::Serializer
+  attributes :id
+end
+
+class SomeController
+  include Praetor::ServiceController
+end
+
+RSpec.describe Praetor::ServiceController do
+  subject { SomeController.new }
+
+  it 'serializes collections' do
+    collection = 3.times.map { |i| SomeModel.new(id: i) }
+    expect(subject.serialize_collection(collection)).to eq [{id: 0}, {id: 1}, {id: 2}]
+  end
+
+  it 'serializes resources' do
+    resource = SomeModel.new(id: 0)
+    expect(subject.serialize(resource)).to eq({ id: 0 })
+  end
+end
+

data/spec/service_spec.rb

@@ -0,0 +1,62 @@
+require './lib/praetor/service'
+
+def run_service(klass, r)
+  redis = Redis.new
+  redis.del klass.endpoint
+  redis.lpush klass.endpoint, JSON.generate(r)
+  redis.lpush klass.endpoint, 'stop'
+  klass.new.run
+  _, response = redis.brpop r['key']
+  JSON.parse response
+end
+
+RSpec.describe Praetor::Service do
+  class SomeController
+    def show
+      'Hi there'
+    end
+  end
+
+  class SomeService < Praetor::Service
+    controller SomeController
+  end
+
+  let(:service) { SomeService.new }
+  let(:req) do
+    {
+      'controller' => 'SomeController',
+      'action' => 'show'
+    }
+  end
+
+  context '#dispatch!' do
+    it 'dispatches messages to the correct controller' do
+      result = service.dispatch! req
+      expect(result).to eq 'Hi there'
+    end
+
+    it "raises an error if the controller doesn't exist" do
+      r = req.merge('controller' => 'NilController')
+      expect { service.dispatch! r }.to raise_error
+    end
+
+    it "raises an error if the action doesn't exist" do
+      r = req.merge('action' => 'create')
+      expect { service.dispatch! r }.to raise_error
+    end
+  end
+
+  context '#run' do
+    it 'grabs the first request waiting on the queue' do
+      r = req.merge 'key' => Rubyflake.generate.to_s(32)
+      response = run_service SomeService, r
+      expect(response['data']).to eq 'Hi there'
+    end
+
+    it 'returns responses with errors' do
+      r = req.merge 'key' => Rubyflake.generate.to_s(32), 'controller' => 'NilController'
+      response = run_service SomeService, r
+      expect(response['status']).to eq 'error'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end
+
+def inject_params(controller, params)
+  controller.instance_variable_set(:@params, params)
+end

data/spec/support/echo_service/controllers/double_echo_controller.rb

@@ -0,0 +1,5 @@
+class DoubleEchoController
+  def echo
+    params * 2
+  end
+end

data/spec/support/echo_service/controllers/echo_controller.rb

@@ -0,0 +1,5 @@
+class EchoController
+  def echo
+    params
+  end
+end

data/spec/support/echo_service/service.rb

@@ -0,0 +1,7 @@
+require_relative 'controllers/echo_controller'
+require_relative 'controllers/double_echo_controller'
+
+class EchoService < Praetor::Service
+  controller EchoController
+  controller DoubleEchoController
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: praetor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick DeMonner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activemodel
+  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: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyflake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj_mimic_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lightweight microservices for Ruby
+email:
+- nick@seneca.systems
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/praetor.rb
+- lib/praetor/service.rb
+- lib/praetor/service_client.rb
+- lib/praetor/service_controller.rb
+- lib/praetor/version.rb
+- praetor.gemspec
+- spec/service_client_spec.rb
+- spec/service_controller_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+- spec/support/echo_service/controllers/double_echo_controller.rb
+- spec/support/echo_service/controllers/echo_controller.rb
+- spec/support/echo_service/service.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Lightweight microservices for Ruby
+test_files:
+- spec/service_client_spec.rb
+- spec/service_controller_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+- spec/support/echo_service/controllers/double_echo_controller.rb
+- spec/support/echo_service/controllers/echo_controller.rb
+- spec/support/echo_service/service.rb