restful_celluloid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 731ddae66a593df21315d3db3ba7c3b0a7986583
+  data.tar.gz: 61d64be771428bd901bcc275e1664c0f90093ecf
+SHA512:
+  metadata.gz: 704b32c361cc54ba7b4216aa0606e10593bf343bfff54b6d2d0d94eec95417809f87efb936464576e7d3ce7f786ebf676639cbd0b92d1eb76c026a38bf173abb
+  data.tar.gz: b664d1fb37b463bfb8ea1d4b912dbec7967f1e25a85b78e40d12ff910bd767df82fef22895fda0b63d39172d958eefdc292d7c1ef0261310eee0be9ca1f073ee

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook :initialize do |at|
+  %w{.git vendor spec/integration coverage}.each {|exception| at.add_exception(exception)}
+end

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in restful_celluloid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dragan Milic
+
+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,53 @@
+# RestfulCelluloid
+
+RestfulCelluloid is a simple RESTful interface to the celluloid actors. It offers a technology independent communication layer (JSON over HTTP) that can interact directly with Celluloid actors.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'restful_celluloid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restful_celluloid
+
+## Usage
+Minimal example:
+
+    require 'restful_celluloid'
+    
+    class MyActor
+      include Celluloid
+
+      def simple_method
+        "some_result"
+      end
+
+    end
+
+    MyActor.supervise_as :my_actor
+
+    RestfulCelluloid.start! 12345
+
+Now you can call the service:
+
+    curl http://localhost:12345/actor/my_actor/simple_method
+
+Result:
+
+    "some_result"
+    
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/cucumber.yml

@@ -0,0 +1 @@
+default: --color --strict

data/features/invoke_method_using_get.feature

@@ -0,0 +1,26 @@
+Feature: invoking actor methods using GET requests
+
+Scenario: invoking method without parameters - happy path
+  Given there is an actor registered
+  When I call an existing method without parameters using GET method
+  Then I should receive result of the method call in the response
+
+Scenario: invoking method with parameters - happy path
+  Given there is an actor registered
+  When I call an existing method with parameters using GET method
+  Then I should receive result of the parametrized method call in the response
+
+Scenario: invoking method that raises exception
+  Given there is an actor registered
+  When I call an existing method that raises an exception using GET method
+  Then I should receive 500 status code and an error object containing message "Method execution raised exception."
+  And the response should contain exception message and back trace
+
+Scenario: reporting error when actor is not registered  
+  When I call a method without parameters on a non-existing actor using GET method
+  Then I should receive 404 status code and an error object containing message "Actor 'wrong_actor' not found."
+
+Scenario: invoking method when method does not exist
+  Given there is an actor registered
+  When I call an non-existing method without parameters using GET method
+  Then I should receive 404 status code and an error object containing message "Method 'wrong_method' not found on actor 'my_actor'."

data/features/list_of_actors.feature

@@ -0,0 +1,6 @@
+Feature: list of actors
+
+Scenario: list of actors
+  Given there is an actor registered
+  When I request list of actors
+  Then the registered actor should be in the list

data/features/step_definitions/invoke_method_using_get_steps.rb

@@ -0,0 +1,46 @@
+When(/^I call an existing method without parameters using GET method$/) do
+  invoke_on_actor :my_actor, :simple_method 
+end
+
+Then(/^I should receive result of the method call in the response$/) do
+  @result.code.should == 200
+  @result.body.should == "\"some_result\""
+end
+
+Then(/^I should receive result of the parametrized method call in the response$/) do
+  @result.code.should == 200
+  @result['param1'].should == 'abc'
+end
+
+
+When(/^I call a method without parameters on a not\-existing actor using GET method$/) do
+  invoke_on_actor :wrong_actor, :simple_method 
+end
+
+Then(/^I should receive (\d+) status code and an error object containing message "(.*?)"$/) do |expected_code, expected_message|
+  @result.code.should == expected_code.to_i
+  JSON.parse(@result.body)['error'].should == expected_message
+end
+
+
+When(/^I call an non\-existing method without parameters using GET method$/) do
+  invoke_on_actor :my_actor, :wrong_method 
+end
+
+When(/^I call a method without parameters on a non\-existing actor using GET method$/) do
+  invoke_on_actor :wrong_actor, :simple_method 
+end
+
+When(/^I call an existing method with parameters using GET method$/) do
+  invoke_on_actor :my_actor, :method_with_params, param1: 'abc'
+end
+
+When(/^I call an existing method that raises an exception using GET method$/) do
+  invoke_on_actor :my_actor, :exception_raising_method 
+end
+
+Then(/^the response should contain exception message and back trace$/) do
+  error_body=JSON.parse(@result.body)
+  error_body['message'].should == 'oops!'
+  error_body['backtrace'].should be_a Array
+end

data/features/step_definitions/list_of_actors_steps.rb

@@ -0,0 +1,11 @@
+Given(/^there is an actor registered$/) do
+  register_an_actor
+end
+
+When(/^I request list of actors$/) do
+  @actors=get_list_of_actors
+end
+
+Then(/^the registered actor should be in the list$/) do
+  @actors.should include('my_actor')
+end

data/features/support/env.rb

@@ -0,0 +1,39 @@
+require 'restful_celluloid'
+require 'httparty'
+
+Before do
+  RestfulCelluloid.start 31337
+end
+
+
+After do
+  RestfulCelluloid.stop
+end
+
+class MyActor
+  include Celluloid
+
+  def simple_method
+    "some_result"
+  end
+
+  def method_with_params params
+    params
+  end
+
+  def exception_raising_method
+    raise "oops!"
+  end
+end
+
+def register_an_actor
+  MyActor.supervise_as :my_actor 
+end
+
+def get_list_of_actors
+  HTTParty.get("http://localhost:31337/actors")
+end
+
+def invoke_on_actor actor, method_name, params={}
+  @result=HTTParty.get("http://localhost:31337/actor/%s/%s" % [actor.to_s, method_name.to_s], {query: params})
+end

data/lib/restful_celluloid/version.rb

@@ -0,0 +1,3 @@
+module RestfulCelluloid
+  VERSION = "0.0.1"
+end

data/lib/restful_celluloid.rb

@@ -0,0 +1,69 @@
+require "restful_celluloid/version"
+require 'webrick'
+require 'sinatra/base'
+require 'thread'
+require 'celluloid'
+require 'json'
+
+module RestfulCelluloid
+
+
+  def self.start! port
+    RESTfulServer.port=port
+    RESTfulServer.run!
+  end
+
+  def self.start port
+    @port=port
+    RESTfulServer.port=port
+    server_queue=Queue.new
+    Thread.new do
+      RESTfulServer.run! do |server|
+        server_queue << server
+      end
+    end
+    @server=server_queue.pop
+  end
+
+  def self.stop
+    @server.shutdown
+  end
+
+  class RESTfulServer < ::Sinatra::Base
+    set :server, %w[webrick]
+    set :server_settings, Logger: WEBrick::Log.new("/dev/null")
+
+    get '/actors' do
+      content_type :json
+      Celluloid::Actor.all.map{|actor| actor.name}.to_json
+    end
+
+    get '/actor/:actor_name/:method_name' do
+      content_type :json
+      actor_name=params[:actor_name]
+      method_name=params[:method_name]
+      actor=Celluloid::Actor[actor_name]
+      if actor        
+        if actor.respond_to? method_name
+          begin
+          params=request.env['rack.request.query_hash']
+          result=params.empty? ? actor.send(method_name) : actor.send(method_name,params)
+          result.to_json
+        rescue => ex
+          status 500
+          {error: 'Method execution raised exception.', message: ex.message, backtrace: ex.backtrace}.to_json
+        end
+        else
+        status 404
+        return {error: ("Method '%s' not found on actor '%s'." % [method_name, actor_name])}.to_json          
+        end
+      else
+        status 404
+        return {error: ("Actor '%s' not found." % actor_name)}.to_json
+      end
+    end
+
+
+  end
+
+end

data/restful_celluloid.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restful_celluloid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restful_celluloid"
+  spec.version       = RestfulCelluloid::VERSION
+  spec.authors       = ["Dragan Milic"]
+  spec.email         = ["dragan@netice9.com"]
+  spec.description   = %q{RESTful interface for celluloid actor framework}
+  spec.summary       = %q{RESTful interface for celluloid actor framework}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "autotest"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "httparty"
+  spec.add_development_dependency "simplecov"  
+  spec.add_development_dependency "pry"  
+  spec.add_dependency "sinatra"
+  spec.add_dependency "celluloid"
+end

data/spec/restful_celluloid_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module RestfulCelluloid
+  describe "start/stop methods" do
+    it "should start/stop server on the specified port" do
+      RestfulCelluloid::start 31337
+      socket=TCPSocket.new 'localhost', 31337
+      socket.close
+      RestfulCelluloid::stop
+    end
+  end
+
+
+  class MyActor
+    include Celluloid
+
+    def simple_method
+      "some_result"
+    end
+  end
+
+  describe RESTfulServer do
+    before do 
+      RestfulCelluloid::start 31337
+      MyActor.supervise_as :my_actor 
+    end
+    after {RestfulCelluloid::stop}
+    it "should list actors" do
+      result=HTTParty.get('http://localhost:31337/actors')
+      result.code.should == 200
+      result.content_type.should include 'application/json'
+      result.should include('my_actor')
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+require 'httparty'
+SimpleCov.start
+require 'restful_celluloid'
+
+

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: restful_celluloid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dragan Milic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: autotest
+  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: cucumber
+  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: httparty
+  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: simplecov
+  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: pry
+  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: sinatra
+  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: celluloid
+  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: RESTful interface for celluloid actor framework
+email:
+- dragan@netice9.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cucumber.yml
+- features/invoke_method_using_get.feature
+- features/list_of_actors.feature
+- features/step_definitions/invoke_method_using_get_steps.rb
+- features/step_definitions/list_of_actors_steps.rb
+- features/support/env.rb
+- lib/restful_celluloid.rb
+- lib/restful_celluloid/version.rb
+- restful_celluloid.gemspec
+- spec/restful_celluloid_spec.rb
+- spec/spec_helper.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.0.3
+signing_key: 
+specification_version: 4
+summary: RESTful interface for celluloid actor framework
+test_files:
+- features/invoke_method_using_get.feature
+- features/list_of_actors.feature
+- features/step_definitions/invoke_method_using_get_steps.rb
+- features/step_definitions/list_of_actors_steps.rb
+- features/support/env.rb
+- spec/restful_celluloid_spec.rb
+- spec/spec_helper.rb