cuboid 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0686605598011432eb7f38026c2b2c4cc5c76e6272ecd38b2132a2c382114ab6'
-  data.tar.gz: c7c2e338fcd17aa6cc07c4902528bb1d7b9be3d01c5f3b30fffbbc6e40377dec
+  metadata.gz: 5b9121b12ad9684342c07f1f103a7ceccaf7a5fc4726aff0f869c004eb0609c6
+  data.tar.gz: 8bc40ef564aa932c948acb929e9ebd41e97fe3f684326db9a13095fc321a9049
 SHA512:
-  metadata.gz: 00a62cc9358e08fab9f11fdea832f1b95f540529e1099a6a697aacc7dfe6bbfef7f3c6b24ec240d6e10e9d4331e03d1b03fb335906bb4aeafbc64bc3beacee8c
-  data.tar.gz: 211cd5f371b8b6bfdde1050d90253c2a408d4b532b98fd54eaa908c95ca28678bf5d8914a18a16da4fe8af467998bc321b419e963a045851729b7934f91b6068
+  metadata.gz: 803d5ae299c9af535d49172cb9dcf1c4d91567d40a0a6e981223f3fb7de7a16869449d30d9f2f81de01f35ae2e6ee9c1e40d7f517c9781ae3c29a82c9f070c2c
+  data.tar.gz: fdb7bb6c4fa8c9bb97338d78f6e53671789aa1c1624653bab2794754cbcade7c6a915a1c5a39bbbaab983a182a4d220d82ee36cfe8037271ed2eacf514f8e420

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.1.5
+
+* Fixed relative path for application source path detection.
+
+# 0.1.3
+
+* Replaced `Arachni::RPC` and `Arachni::Reactor` with `Toq` and `Raktr`.
+
 # 0.1.0
 
 * `Dispatcher` => `Agent`

data/README.md

@@ -30,7 +30,7 @@ It offers:
 * Developer freedom.
   * Apart from keeping _Data_ and _State_ separate not many other rules to follow.
     * Only if interested in _suspensions_ and can also be left to the last minute
-      if necessary -- in cases of Ractor enforced isolation  for example.
+      if necessary -- in cases of `Ractor` enforced isolation for example.
 
 ## Entities
 
@@ -144,7 +144,7 @@ _**Application**_ itself.
 
 A simple RPC is employed, specs for 3rd party implementations can be found at:
 
-https://github.com/Arachni/arachni-rpc/wiki
+https://github.com/toq/arachni-rpc/wiki
 
 Each _**Application**_ can extend upon this and expose an API via its _**Instance**_'s 
 RPC interface.
@@ -162,13 +162,130 @@ service's interface.
 
 ## Examples
 
-See `examples/`.
-
 ### MyApp
 
 Tutorial application going over different APIs and **Cuboid** _**Application**_
 options and specification.
 
+See `examples/my_app`.
+
+### Parallel code on same host
+
+To run code in parallel on the same machine utilising multiple cores, with each
+instance isolated to its own process, you can use something like the following:
+
+```ruby
+require 'cuboid'
+
+class Sleeper < Cuboid::Application
+
+    def run
+        sleep options['time']
+    end
+
+end
+
+return if $0 != __FILE__
+
+sleepers = []
+sleepers << Sleeper.spawn( :instance )
+sleepers << Sleeper.spawn( :instance )
+sleepers << Sleeper.spawn( :instance )
+
+sleepers.each do |sleeper|
+    sleeper.run( time: 5 )
+end
+
+sleep 0.1 while sleepers.map(&:busy?).include?( true )
+```
+
+    time bundle exec ruby same_host.rb
+    [...]
+    real    0m6,506s
+    user    0m0,423s
+    sys     0m0,063s
+
+### Parallel code on different hosts
+
+In this example we'll be using `Agents` to spawn instances from 3 different hosts.
+
+#### Host 1
+
+```ruby
+require 'cuboid'
+
+class Sleeper < Cuboid::Application
+
+    def run
+        sleep options['time']
+    end
+
+end
+
+return if $0 != __FILE__
+
+Sleeper.spawn( :agent, port: 7331 )
+```
+
+    bundle exec ruby multiple_hosts_1.rb
+
+#### Host 2
+
+```ruby
+require 'cuboid'
+
+class Sleeper < Cuboid::Application
+
+    def run
+        sleep options['time']
+    end
+
+end
+
+return if $0 != __FILE__
+
+Sleeper.spawn( :agent, port: 7332, peer: 'host1:7331' )
+```
+
+    bundle exec ruby multiple_hosts_2.rb
+
+#### Host 3
+
+```ruby
+require 'cuboid'
+
+class Sleeper < Cuboid::Application
+
+    def run
+        sleep options['time']
+    end
+
+end
+
+return if $0 != __FILE__
+
+grid_agent = Sleeper.spawn( :agent, port: 7333, peer: 'host1:7331' )
+
+sleepers = []
+3.times do
+    connection_info = grid_agent.spawn
+    sleepers << Sleeper.connect( connection_info )
+end
+
+sleepers.each do |sleeper|
+    sleeper.run( time: 5 )
+end
+
+sleep 0.1 while sleepers.map(&:busy?).include?( true )
+```
+
+    time bundle exec ruby multiple_hosts_3.rb
+    real    0m7,318s
+    user    0m0,426s
+    sys     0m0,091s
+
+
+_You can replace `host1` with `localhost` and run all examples on the same terminal._
 
 ## License
 

data/Rakefile

@@ -55,3 +55,20 @@ task :clean do
     files.each { |file| puts "  * #{file}" }
     FileUtils.rm files
 end
+
+desc 'Build the gem.'
+task build: [ :clean ] do
+    sh "gem build cuboid.gemspec"
+end
+
+desc 'Build and install the gem.'
+task install: [ :build ] do
+    sh "gem install cuboid-#{Cuboid::VERSION}.gem"
+end
+
+desc 'Push a new version to Rubygems'
+task publish: [ :build ] do
+    sh "git tag -a v#{Cuboid::VERSION} -m 'Version #{Cuboid::VERSION}'"
+    sh "gem push cuboid-#{Cuboid::VERSION}.gem"
+end
+task release: [ :publish ]

data/cuboid.gemspec

@@ -53,7 +53,7 @@ Gem::Specification.new do |s|
     s.add_dependency 'sinatra-contrib',     '2.1.0'
 
     # RPC client/server implementation.
-    s.add_dependency 'arachni-rpc',         '~> 0.2.1.4'
+    s.add_dependency 'toq',                 '~> 0.0.1'
 
     s.add_dependency 'vmstat',              '2.3.0'
     s.add_dependency 'sys-proctable',       '1.1.5'

data/lib/cuboid/application.rb

@@ -174,7 +174,7 @@ class Application
                 last_const = last_const.const_get( const_name.to_sym )
             end
 
-            last_const.const_source_location( app.to_sym ).first
+            File.expand_path last_const.const_source_location( app.to_sym ).first
         end
 
         def spawn( type, options = {}, &block )

data/lib/cuboid/option_groups/agent.rb

@@ -5,7 +5,7 @@ module Cuboid::OptionGroups
 # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 class Agent < Cuboid::OptionGroup
 
-    STRATEGIES = Set.new([:horizontal, :vertical])
+    STRATEGIES = Set.new([:horizontal, :vertical, :direct])
 
     # @return   [String]
     #   URL of a {RPC::Server::Agent}.

data/lib/cuboid/processes/agents.rb

@@ -25,7 +25,7 @@ class Agents
     #
     # @return   [RPC::Client::Agent]
     def connect( url, options = nil )
-        Arachni::Reactor.global.run_in_thread if !Arachni::Reactor.global.running?
+        Raktr.global.run_in_thread if !Raktr.global.running?
 
         fresh = false
         if options

data/lib/cuboid/processes/executables/agent.rb

@@ -1,5 +1,5 @@
 require Options.paths.lib  + 'rpc/server/agent'
 
-Arachni::Reactor.global.run do
+Raktr.global.run do
     RPC::Server::Agent.new
 end

data/lib/cuboid/processes/executables/scheduler.rb

@@ -1,5 +1,5 @@
 require Options.paths.lib  + 'rpc/server/scheduler'
 
-Arachni::Reactor.global.run do
+Raktr.global.run do
     RPC::Server::Scheduler.new
 end

data/lib/cuboid/processes/instances.rb

@@ -28,7 +28,7 @@ class Instances
     # @return   [RPC::Client::Instance]
     #
     def connect( url, token = nil )
-        Arachni::Reactor.global.run_in_thread if !Arachni::Reactor.global.running?
+        Raktr.global.run_in_thread if !Raktr.global.running?
 
         token ||= @list[url]
         @list[url] ||= token

data/lib/cuboid/processes/manager.rb

@@ -1,5 +1,5 @@
 require 'singleton'
-require 'arachni/reactor'
+require 'raktr'
 
 module Cuboid
 module Processes
@@ -156,7 +156,7 @@ class Manager
 
     # Stops the Reactor.
     def kill_reactor
-        Arachni::Reactor.stop
+        Raktr.stop
     rescue
         nil
     end

data/lib/cuboid/processes/schedulers.rb

@@ -23,7 +23,7 @@ class Schedulers
     #
     # @return   [RPC::Client::Scheduler]
     def connect( url, options = nil )
-        Arachni::Reactor.global.run_in_thread if !Arachni::Reactor.global.running?
+        Raktr.global.run_in_thread if !Raktr.global.running?
 
         fresh = false
         if options

data/lib/cuboid/rpc/client/agent.rb

@@ -16,14 +16,14 @@ class Agent
 
     def initialize( url, options = nil )
         @client = Base.new( url, nil, options )
-        @node   = Arachni::RPC::Proxy.new( @client, 'node' )
+        @node   = Toq::Proxy.new( @client, 'node' )
 
         Cuboid::Application.application.agent_services.keys.each do |name|
             self.class.send( :attr_reader, name.to_sym )
 
             instance_variable_set(
               "@#{name}".to_sym,
-              Arachni::RPC::Proxy.new( @client, name )
+              Toq::Proxy.new( @client, name )
             )
         end
     end

data/lib/cuboid/rpc/client/base.rb

@@ -1,4 +1,4 @@
-require 'arachni/rpc'
+require 'toq'
 require_relative '../serializer'
 
 module Cuboid
@@ -6,7 +6,7 @@ module RPC
 class Client
 
 # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-class Base < Arachni::RPC::Client
+class Base < Toq::Client
     attr_reader :url
 
     # @param    [String]    url

data/lib/cuboid/rpc/client/instance/service.rb

@@ -5,7 +5,7 @@ class Client
 class Instance
 
 # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-class Proxy < Arachni::RPC::Proxy
+class Proxy < Toq::Proxy
 
     def initialize( client )
         super client, 'instance'

data/lib/cuboid/rpc/client/instance.rb

@@ -24,10 +24,10 @@ class Instance
             )
 
             client = new( url, token, options )
-            Arachni::Reactor.global.delay( 0.1 ) do |task|
+            Raktr.global.delay( 0.1 ) do |task|
                 client.alive? do |r|
                     if r.rpc_exception?
-                        Arachni::Reactor.global.delay( 0.1, &task )
+                        Raktr.global.delay( 0.1, &task )
                         next
                     end
 
@@ -45,7 +45,7 @@ class Instance
         @client   = Base.new( url, token, options )
 
         @instance = Proxy.new( @client )
-        @options  = Arachni::RPC::Proxy.new( @client, 'options' )
+        @options  = Toq::Proxy.new( @client, 'options' )
 
         # map Agent handlers
         Cuboid::Application.application.instance_services.keys.each do |name|
@@ -53,7 +53,7 @@ class Instance
 
             instance_variable_set(
               "@#{name}".to_sym,
-              Arachni::RPC::Proxy.new( @client, name )
+              Toq::Proxy.new( @client, name )
             )
         end
     end

data/lib/cuboid/rpc/server/agent/node.rb

@@ -65,7 +65,7 @@ class Server::Agent::Node
 
         log_updated_peers
 
-        Arachni::Reactor.global.at_interval( @options.agent.ping_interval ) do
+        Raktr.global.at_interval( @options.agent.ping_interval ) do
             ping
             check_for_comebacks
         end
@@ -152,7 +152,7 @@ class Server::Agent::Node
                 block.call( @nodes_info_cache )
             end
 
-            Arachni::Reactor.global.create_iterator( peers ).map( each, after )
+            Raktr.global.create_iterator( peers ).map( each, after )
         else
             block.call( @nodes_info_cache )
         end

data/lib/cuboid/rpc/server/agent/service.rb

@@ -45,7 +45,7 @@ class Server::Agent::Service
     # Performs an asynchronous map operation over all running instances.
     #
     # @param [Proc]  each
-    #   Block to be passed {Client::Instance} and `Arachni::Reactor::Iterator`.
+    #   Block to be passed {Client::Instance} and `Raktr::Iterator`.
     # @param [Proc]  after
     #   Block to be passed the Array of results.
     def map_instances( each, after )
@@ -58,7 +58,7 @@ class Server::Agent::Service
     # Performs an asynchronous iteration over all running instances.
     #
     # @param [Proc]  block
-    #   Block to be passed {Client::Instance} and `Arachni::Reactor::Iterator`.
+    #   Block to be passed {Client::Instance} and `Raktr::Iterator`.
     def each_instance( &block )
         wrap = proc do |instance, iterator|
             block.call( connect_to_instance( instance ), iterator )
@@ -88,15 +88,15 @@ class Server::Agent::Service
     #
     # @param    [Block] block
     def run_asap( &block )
-        Arachni::Reactor.global.next_tick( &block )
+        Raktr.global.next_tick( &block )
     end
 
     # @param    [Array]    list
     #
-    # @return   [Arachni::Reactor::Iterator]
+    # @return   [Raktr::Iterator]
     #   Iterator for the provided array.
     def iterator_for( list, max_concurrency = 10 )
-        Arachni::Reactor.global.create_iterator( list, max_concurrency )
+        Raktr.global.create_iterator( list, max_concurrency )
     end
 
     # @return   [Array<Hash>]

data/lib/cuboid/rpc/server/agent.rb

@@ -82,6 +82,7 @@ class Agent
     # @param    [Symbol]    strategy
     #   `:horizontal` -- Pick the Agent with the least amount of workload.
     #   `:vertical` -- Pick the Agent with the most amount of workload.
+    #   `:direct` -- Bypass the grid and get an Instance directly from this agent.
     #
     # @return   [String, nil]
     #   Depending on strategy and availability:
@@ -97,7 +98,7 @@ class Agent
             raise ArgumentError, "Unknown strategy: #{strategy}"
         end
 
-        if !@node.grid_member?
+        if strategy == :direct || !@node.grid_member?
             block.call( self.utilization == 1 ? nil : @url )
             return
         end
@@ -136,10 +137,10 @@ class Agent
             block.call nodes.sort_by { |_, score| adjust_score_by_strategy.call score }[0][0]
         end
 
-        Arachni::Reactor.global.create_iterator( @node.peers ).map( each, after )
+        Raktr.global.create_iterator( @node.peers ).map( each, after )
     end
 
-    # Dispatches an {Instance}.
+    # Spawns an {Instance}.
     #
     # @param    [String]  options
     # @option    [String]  strategy
@@ -147,22 +148,24 @@ class Agent
     #   An owner to assign to the {Instance}.
     # @option    [Hash]    helpers
     #   Hash of helper data to be added to the instance info.
-    # @option    [Boolean]    load_balance
-    #   Use the Grid (when available) or this one directly?
     #
     # @return   [Hash, nil]
     #   Depending on availability:
     #
     #   * `Hash`: Connection and proc info.
-    #   * `nil`: Max utilization, wait for one of the instances to finish and retry.
+    #   * `nil`: Max utilization or currently spawning, wait and retry.
     def spawn( options = {}, &block )
+        if @spawning
+            block.call nil
+            return
+        end
+
         options      = options.my_symbolize_keys
         strategy     = options.delete(:strategy)
         owner        = options[:owner]
         helpers      = options[:helpers] || {}
-        load_balance = options[:load_balance].nil? ? true : options[:load_balance]
 
-        if load_balance && @node.grid_member?
+        if strategy != 'direct' && @node.grid_member?
             preferred *[strategy].compact do |url|
                 if !url
                     block.call
@@ -175,8 +178,8 @@ class Agent
                 end
 
                 connect_to_peer( url ).spawn( options.merge(
-                      helpers: helpers.merge( via: @url ),
-                      load_balance: false
+                      helpers:  helpers.merge( via: @url ),
+                      strategy: :direct
                     ),
                     &block
                 )
@@ -189,6 +192,7 @@ class Agent
             return
         end
 
+        @spawning = true
         spawn_instance do |info|
             info['owner']   = owner
             info['helpers'] = helpers
@@ -196,6 +200,8 @@ class Agent
             @instances << info
 
             block.call info
+
+            @spawning = false
         end
     end
 
@@ -288,7 +294,7 @@ class Agent
 
     # Starts the agent's server
     def run
-        Arachni::Reactor.global.on_error do |_, e|
+        Raktr.global.on_error do |_, e|
             print_error "Reactor: #{e}"
 
             e.backtrace.each do |l|
@@ -308,7 +314,7 @@ class Agent
     def shutdown
         Thread.new do
             print_status 'Shutting down...'
-            Arachni::Reactor.global.stop
+            Raktr.global.stop
         end
     end
 

data/lib/cuboid/rpc/server/base.rb

@@ -1,5 +1,5 @@
 require 'ostruct'
-require 'arachni/rpc'
+require 'toq'
 require_relative '../serializer'
 
 module Cuboid
@@ -10,7 +10,7 @@ class Server
 #
 # @private
 # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-class Base < Arachni::RPC::Server
+class Base < Toq::Server
 
     # @param    [Hash]   options
     # @option options [Integer]  :host

data/lib/cuboid/rpc/server/instance.rb

@@ -74,7 +74,7 @@ class Instance
             trap( signal ){ shutdown if !@options.datastore.do_not_trap }
         end
 
-        Arachni::Reactor.global.run do
+        Raktr.global.run do
             _run
         end
     end
@@ -294,7 +294,7 @@ class Instance
 
     # Starts  RPC service.
     def _run
-        Arachni::Reactor.global.on_error do |_, e|
+        Raktr.global.on_error do |_, e|
             print_error "Reactor: #{e}"
 
             e.backtrace.each do |l|

data/lib/cuboid/rpc/server/scheduler.rb

@@ -399,7 +399,7 @@ class Scheduler
     end
 
     def reactor
-        Arachni::Reactor.global
+        Raktr.global
     end
 
     def trap_interrupts( &block )

data/lib/version

@@ -1 +1 @@
-0.1.2
+0.1.5

data/spec/cuboid/rest/server_spec.rb

@@ -204,7 +204,7 @@ describe Cuboid::Rest::Server do
                 post url, invalid: 'blah'
 
                 expect(response_code).to eq 500
-                expect(response_data['error']).to eq 'Arachni::RPC::Exceptions::RemoteException'
+                expect(response_data['error']).to eq 'Toq::Exceptions::RemoteException'
                 expect(response_data).to include 'backtrace'
             end
 
@@ -658,7 +658,7 @@ describe Cuboid::Rest::Server do
             it 'returns 500' do
                 put url, 'localhost:383838'
                 expect(response_code).to eq 500
-                expect(response_data['error']).to eq 'Arachni::RPC::Exceptions::ConnectionError'
+                expect(response_data['error']).to eq 'Toq::Exceptions::ConnectionError'
             end
         end
     end
@@ -821,7 +821,7 @@ describe Cuboid::Rest::Server do
                     post url, invalid: 'blah'
 
                     expect(response_code).to eq 500
-                    expect(response_data['error']).to eq 'Arachni::RPC::Exceptions::RemoteException'
+                    expect(response_data['error']).to eq 'Toq::Exceptions::RemoteException'
                     expect(response_data).to include 'backtrace'
                 end
             end
@@ -876,7 +876,7 @@ describe Cuboid::Rest::Server do
                 put url, 'localhost:393939'
 
                 expect(response_code).to eq 500
-                expect(response_data['error']).to eq 'Arachni::RPC::Exceptions::ConnectionError'
+                expect(response_data['error']).to eq 'Toq::Exceptions::ConnectionError'
                 expect(response_data['description']).to include 'Connection closed'
             end
         end
@@ -992,7 +992,7 @@ describe Cuboid::Rest::Server do
 
                 get url
                 expect(response_data.size).to be 1
-                expect(response_data[@id]['error']).to eq 'Arachni::RPC::Exceptions::ConnectionError'
+                expect(response_data[@id]['error']).to eq 'Toq::Exceptions::ConnectionError'
                 expect(response_data[@id]['description']).to include 'Connection closed [Connection refused - connect(2) for'
             end
         end

data/spec/cuboid/rpc/client/base_spec.rb

@@ -18,7 +18,7 @@ class Server
     end
 
     def start
-        Arachni::Reactor.global.run_in_thread if !Arachni::Reactor.global.running?
+        Raktr.global.run_in_thread if !Raktr.global.running?
         @server.start
         sleep( 0.1 ) while !@server.ready?
     end
@@ -86,7 +86,7 @@ describe Cuboid::RPC::Client::Base do
                         begin
                             client = described_class.new( server.url, nil, client_ssl_options )
                             client.call( "foo.bar" )
-                        rescue Arachni::RPC::Exceptions::ConnectionError
+                        rescue Toq::Exceptions::ConnectionError
                             raised = true
                         end
 
@@ -102,7 +102,7 @@ describe Cuboid::RPC::Client::Base do
                         begin
                             client = described_class.new( server.url, nil, empty_options )
                             client.call( "foo.bar" )
-                        rescue Arachni::RPC::Exceptions::ConnectionError
+                        rescue Toq::Exceptions::ConnectionError
                             raised = true
                         end
 
@@ -137,7 +137,7 @@ describe Cuboid::RPC::Client::Base do
                         begin
                             client = described_class.new( server.url, nil, empty_options )
                             client.call( "foo.bar" )
-                        rescue Arachni::RPC::Exceptions::InvalidToken
+                        rescue Toq::Exceptions::InvalidToken
                             raised = true
                         end
 

data/spec/cuboid/rpc/client/instance_spec.rb

@@ -16,7 +16,7 @@ describe Cuboid::RPC::Client::Instance do
                 it 'should fail to connect' do
                     expect do
                         described_class.new( subject.url, 'blah' ).alive?
-                    end.to raise_error Arachni::RPC::Exceptions::InvalidToken
+                    end.to raise_error Toq::Exceptions::InvalidToken
                 end
             end
         end