oskie_rpc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83c95d50dce23208e4a87cd0fdc01b8e7e02cb3c
+  data.tar.gz: e0b414711d5ab9b51479c149c6bd60e20ce5f5ea
+SHA512:
+  metadata.gz: fca7464ec46d3c3fe859684b1e8deb0e78cb6db969b155cb346d545fff2eb707f2e1385a921bf9efc08b6049013bf389249efa491bf1bd156008f28f27ba86d9
+  data.tar.gz: eb23f34873330d8f7fb78f5e3d327cab75fb59242d3bfd96bd1c0d4a0c0fb5abf636b0b42864041985c6e6c26d23c64e89def2df977391ee16b0e2a72ff8399e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oskie_rpc.gemspec
+gemspec
+
+gem 'filter_chain', :git => 'https://github.com/chadrem/filter_chain.git'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chad Remesch
+
+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,38 @@
+# Oskie RPC [![Build Status](https://travis-ci.org/chadrem/oskie_rpc.svg)](https://travis-ci.org/chadrem/oskie_rpc)
+
+Oskie RPC is an extremely simple and modular RPC library for Ruby.
+Design goals include:
+
+- Transport independent so no dependencies on TCP/IP, IO, or any other classes (it simply takes input and gives back output through callbacks).
+- Modular design using the [Filter Chain](https://github.com/chadrem/filter_chain) gem so that the protocol can be modified if you so desire.
+- Supports both messages and requests (requests can be replied to, messages can't).
+- Very simple binary protocol with data encoded in JSON.
+- Thread safe.
+- Easy to port to other languages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oskie_rpc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oskie_rpc
+
+## Usage
+
+Coming soon.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chadrem/oskie_rpc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oskie_rpc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oskie_rpc/exceptions.rb

@@ -0,0 +1,5 @@
+module OskieRpc
+  class OskieRpcError < RuntimeError; end
+  class MissingCallbackError < OskieRpcError; end
+  class InvalidStateError < OskieRpcError; end
+end

data/lib/oskie_rpc/message.rb

@@ -0,0 +1,23 @@
+module OskieRpc
+  class Message
+    attr_reader :command
+    attr_reader :uuid
+    attr_reader :data
+    attr_reader :processor
+
+    def initialize(command, opts = {})
+      @command = command
+      @uuid = opts[:uuid] || SecureRandom.uuid
+      @data = opts[:data]
+      @parser = opts[:processor]
+    end
+
+    def to_hash
+      {
+        :command => @command,
+        :uuid => @uuid,
+        :data => @data
+      }
+    end
+  end
+end

data/lib/oskie_rpc/processor.rb

@@ -0,0 +1,61 @@
+module OskieRpc
+  class Processor
+    def initialize(opts = {}, &block)
+      @opts = opts
+      @lock = Mutex.new
+      @input_chain = create_input_chain
+      @output_chain = create_output_chain
+      @callbacks = {}
+      @state = :initializing
+      block.call(self) if block
+      raise MissingCallbackError, :message unless @callbacks[:message]
+      raise MissingCallbackError, :output unless @callbacks[:output]
+      @state = :initialized
+    end
+
+    def <<(bytes)
+      @input_chain << bytes
+
+      nil
+    end
+
+    def on(name, &block)
+      @callbacks[name.to_sym] = block
+
+      nil
+    end
+
+    def deliver(message)
+      raise InvalidStateError unless @state == :initialized
+      @output_chain << message.to_hash
+
+      nil
+    end
+
+    private
+
+    def create_input_chain
+      FilterChain::Chain.new do |chain|
+        chain.add(FilterChain::DemultiplexFilter.new)
+        chain.add(FilterChain::DeserializeFilter.new(:format => :json))
+        chain.add(FilterChain::Terminator.new { |message| message_handler(message) })
+      end
+    end
+
+    def create_output_chain
+      FilterChain::Chain.new do |chain|
+        chain.add(FilterChain::SerializeFilter.new(:format => :json))
+        chain.add(FilterChain::MultiplexFilter.new)
+        chain.add(FilterChain::Terminator.new { |bytes| output_handler(bytes) })
+      end
+    end
+
+    def message_handler(message)
+      @callbacks[:message].call(message)
+    end
+
+    def output_handler(bytes)
+      @callbacks[:output].call(bytes)
+    end
+  end
+end

data/lib/oskie_rpc/version.rb

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

data/lib/oskie_rpc.rb

@@ -0,0 +1,12 @@
+require "securerandom"
+require "json"
+
+require "filter_chain"
+
+require "oskie_rpc/version"
+require "oskie_rpc/exceptions"
+require "oskie_rpc/message"
+require "oskie_rpc/processor"
+
+module OskieRpc
+end

data/oskie_rpc.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oskie_rpc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oskie_rpc"
+  spec.version       = OskieRpc::VERSION
+  spec.authors       = ["Chad Remesch"]
+  spec.email         = ["chad@remesch.com"]
+
+  spec.summary       = %q{Simple easy to use transport agnostic RPC gem.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "filter_chain", "~> 0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: oskie_rpc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chad Remesch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: filter_chain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: 
+email:
+- chad@remesch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oskie_rpc.rb
+- lib/oskie_rpc/exceptions.rb
+- lib/oskie_rpc/message.rb
+- lib/oskie_rpc/processor.rb
+- lib/oskie_rpc/version.rb
+- oskie_rpc.gemspec
+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: Simple easy to use transport agnostic RPC gem.
+test_files: []