cellect-server 0.1.3 → 1.0.0

data/lib/cellect/server/node_set.rb

@@ -5,9 +5,9 @@ module Cellect
   module Server
     class NodeSet < Cellect::NodeSet
       attr_accessor :id
-      
+
       protected
-      
+
       # Registers this server instance with ZooKeeper
       def setup
         zk.mkdir_p '/nodes'

data/lib/cellect/server/user.rb

@@ -3,14 +3,14 @@ module Cellect
     class User
       include Celluloid
       include Celluloid::Logger
-      
+
       # Gracefully exit when the actor dies
       trap_exit :workflow_crashed
       finalizer :cancel_ttl_timer
-      
+
       attr_accessor :id, :workflow_name, :seen, :state
       attr_accessor :ttl, :ttl_timer
-      
+
       # Sets up a new user with an empty seen set, then loads the actual data
       def initialize(id, workflow_name: nil, ttl: nil)
         self.id = id
@@ -20,7 +20,7 @@ module Cellect
         @ttl = ttl
         load_data
       end
-      
+
       # Load the seen subjects for a user and restarts the TTL
       def load_data
         data = Cellect::Server.adapter.load_user(workflow_name, id) || []
@@ -30,36 +30,36 @@ module Cellect
         self.state = :ready
         restart_ttl_timer
       end
-      
+
       # Returns the seen subjects set
       def seen
         restart_ttl_timer
         @seen
       end
-      
+
       # (Re)starts the inactivity countdown
       def restart_ttl_timer
         self.ttl_timer ||= after(ttl){ ttl_expired! }
         ttl_timer.reset
       end
-      
+
       # Releases the timer
       def cancel_ttl_timer
         ttl_timer.cancel if ttl_timer
         self.ttl_timer = nil
       end
-      
+
       # Removes the user from inactivity
       def ttl_expired!
         debug "User #{ id } TTL expired"
         cancel_ttl_timer
         Workflow[workflow_name].async.remove_user(id)
       end
-      
+
       def ttl
         @ttl || 60 * 15 # 15 minutes
       end
-      
+
       # Handle errors and let the actor die
       def workflow_crashed(actor, reason)
         cancel_ttl_timer

data/lib/cellect/server/workflow.rb

@@ -2,33 +2,33 @@ module Cellect
   module Server
     class Workflow
       include Celluloid
-      
+
       attr_accessor :name, :users, :subjects, :state
       attr_accessor :pairwise, :prioritized
-      
+
       # Look up and/or load a workflow
       def self.[](name)
         Cellect::Server.adapter.load_workflows(name) unless Actor[name]
         Actor[name].actors.first
       end
-      
+
       # Load a workflow
       def self.[]=(name, opts)
         Actor[name] = supervise name, pairwise: opts['pairwise'], prioritized: opts['prioritized']
       end
-      
+
       # The names of all workflows currently loaded
       def self.names
         actor_names = Celluloid.actor_system.registry.names.collect &:to_s
         workflow_actors = actor_names.select{ |key| key =~ /^workflow_/ }
         workflow_actors.collect{ |name| name.sub(/^workflow_/, '').to_sym }
       end
-      
+
       # All currently loaded workflows
       def self.all
         names.collect{ |name| Workflow[name] }
       end
-      
+
       # Sets up a new workflow and starts the data loading
       def initialize(name, pairwise: false, prioritized: false)
         self.name = name
@@ -38,7 +38,7 @@ module Cellect
         self.subjects = set_klass.new
         load_data
       end
-      
+
       # Loads subjects from the adapter
       def load_data
         self.state = :initializing
@@ -48,31 +48,31 @@ module Cellect
         end
         self.state = :ready
       end
-      
+
       # Look up and/or load a user
       def user(id)
         self.users[id] ||= User.supervise id, workflow_name: name
         users[id].actors.first
       end
-      
+
       # Get unseen subjects for a user
       def unseen_for(user_id, limit: 5)
         subjects.subtract user(user_id).seen, limit
       end
-      
+
       # Add subjects to a users seen set
       def add_seen_for(user_id, *subject_ids)
         [subject_ids].flatten.compact.each do |subject_id|
           user(user_id).seen.add subject_id
         end
       end
-      
+
       # Unload a user
       def remove_user(user_id)
         removed = self.users.delete user_id
         removed.terminate if removed
       end
-      
+
       # Get a sample of subjects for a user
       # 
       # Accepts a hash in the form:
@@ -87,7 +87,7 @@ module Cellect
           subjects.sample opts[:limit]
         end
       end
-      
+
       # Adds or updates a subject
       # 
       # Accepts a hash in the form:
@@ -102,7 +102,7 @@ module Cellect
           subjects.add opts[:subject_id]
         end
       end
-      
+
       # Removes a subject
       # 
       # Accepts a hash in the form:
@@ -112,23 +112,23 @@ module Cellect
       def remove(opts = { })
         subjects.remove opts[:subject_id]
       end
-      
+
       def pairwise?
         !!pairwise
       end
-      
+
       def prioritized?
         !!prioritized
       end
-      
+
       def grouped?
         false
       end
-      
+
       def ready?
         state == :ready
       end
-      
+
       # Provide a lookup for matching sets to workflow criteria
       SET_KLASS = {
         # priority, pairwise
@@ -137,12 +137,12 @@ module Cellect
         [     true, false  ] => DiffSet::PrioritySet,
         [     true, true   ] => DiffSet::PairwisePrioritySet
       }
-      
+
       # Looks up the set class
       def set_klass
         SET_KLASS[[prioritized, pairwise]]
       end
-      
+
       # General information about this workflow
       def status
         {

data/lib/cellect/version.rb

@@ -1,3 +1,3 @@
 module Cellect
-  VERSION = '0.1.3'
+  VERSION = '1.0.0'
 end

data/spec/server/api/add_seen_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Cellect::Server
   describe API do
     include_context 'API'
-    
+
     { 'Ungrouped' => nil, 'Grouped' => 'grouped' }.each_pair do |grouping_type, grouping|
       SET_TYPES.shuffle.each do |set_type|
         context "#{ grouping_type } #{ set_type }" do
@@ -11,7 +11,7 @@ module Cellect::Server
           let(:workflow){ Workflow[workflow_type] }
           let(:user){ workflow.user 123 }
           before(:each){ pass_until workflow, is: :ready }
-          
+
           it 'should add seen subjects' do
             async_workflow = double
             expect(workflow).to receive(:async).and_return async_workflow

data/spec/server/api/add_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Cellect::Server
   describe API do
     include_context 'API'
-    
+
     { 'Ungrouped' => nil, 'Grouped' => 'grouped' }.each_pair do |grouping_type, grouping|
       SET_TYPES.shuffle.each do |set_type|
         context "#{ grouping_type } #{ set_type }" do
@@ -11,14 +11,14 @@ module Cellect::Server
           let(:workflow){ Workflow[workflow_type] }
           let(:user){ workflow.user 123 }
           before(:each){ pass_until workflow, is: :ready }
-          
+
           let(:opts) do
             { subject_id: 123 }.tap do |h|
               h[:priority] = 456.0 if workflow.prioritized?
               h[:group_id] = 1 if workflow.grouped?
             end
           end
-          
+
           it 'should add subjects' do
             if workflow.grouped? && workflow.prioritized?
               expect(workflow).to receive(:add).with subject_id: 123, group_id: 1, priority: 456.0
@@ -29,7 +29,7 @@ module Cellect::Server
             else
               expect(workflow).to receive(:add).with subject_id: 123, group_id: nil, priority: nil
             end
-            
+
             put "/workflows/#{ workflow_type }/add", opts
             expect(last_response.status).to eq 200
           end

data/spec/server/api/remove_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Cellect::Server
   describe API do
     include_context 'API'
-    
+
     { 'Ungrouped' => nil, 'Grouped' => 'grouped' }.each_pair do |grouping_type, grouping|
       SET_TYPES.shuffle.each do |set_type|
         context "#{ grouping_type } #{ set_type }" do
@@ -11,20 +11,20 @@ module Cellect::Server
           let(:workflow){ Workflow[workflow_type] }
           let(:user){ workflow.user 123 }
           before(:each){ pass_until workflow, is: :ready }
-          
+
           let(:opts) do
             { subject_id: 123 }.tap do |h|
               h[:group_id] = 1 if workflow.grouped?
             end
           end
-          
+
           it 'should remove subjects' do
             if workflow.grouped?
               expect(workflow).to receive(:remove).with subject_id: 123, group_id: 1, priority: nil
             else
               expect(workflow).to receive(:remove).with subject_id: 123, group_id: nil, priority: nil
             end
-            
+
             put "/workflows/#{ workflow_type }/remove", opts
             expect(last_response.status).to eq 200
           end

data/spec/server/api/sample_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Cellect::Server
   describe API do
     include_context 'API'
-    
+
     { 'Ungrouped' => nil, 'Grouped' => 'grouped' }.each_pair do |grouping_type, grouping|
       SET_TYPES.shuffle.each do |set_type|
         context "#{ grouping_type } #{ set_type }" do
@@ -11,14 +11,14 @@ module Cellect::Server
           let(:workflow){ Workflow[workflow_type] }
           let(:user){ workflow.user 123 }
           before(:each){ pass_until workflow, is: :ready }
-          
+
           it 'should sample without a user, limit, or group' do
             expect(workflow).to receive(:sample).with(limit: 5, user_id: nil, group_id: nil).and_call_original
             get "/workflows/#{ workflow_type }"
             expect(last_response.status).to eq 200
             expect(json).to be_a Array
           end
-          
+
           shoulda = grouping ? 'limit, group, and user' : 'limit and user'
           it "should sample with a #{ shoulda }" do
             group_id = grouping ? 1 : nil

data/spec/server/api/user_load_spec.rb

@@ -3,14 +3,14 @@ require 'spec_helper'
 module Cellect::Server
   describe API do
     include_context 'API'
-    
+
     { 'Ungrouped' => nil, 'Grouped' => 'grouped' }.each_pair do |grouping_type, grouping|
       SET_TYPES.shuffle.each do |set_type|
         context "#{ grouping_type } #{ set_type }" do
           let(:workflow_type){ [grouping, set_type].compact.join '_' }
           let(:workflow){ Workflow[workflow_type] }
           before(:each){ pass_until workflow, is: :ready }
-          
+
           it 'should load users' do
             async_workflow = double
             expect(workflow).to receive(:async).and_return async_workflow

data/spec/server/grouped_workflow_spec.rb

@@ -9,49 +9,49 @@ module Cellect::Server
         let(:user){ workflow.user 123 }
         let(:set_klass){ workflow.prioritized? ? DiffSet::PrioritySet : DiffSet::RandomSet }
         before(:each){ pass_until workflow, is: :ready }
-        
+
         it 'should provide unseen from a random group for users' do
           workflow.groups = { }
           workflow.groups[1] = set_klass.new
           expect(workflow.groups[1]).to receive(:subtract).with user.seen, 3
           workflow.unseen_for 123, limit: 3
         end
-        
+
         it 'should provide unseen from a specific group for users' do
           3.times{ |i| workflow.groups[i] = set_klass.new }
           expect(workflow.group(1)).to receive(:subtract).with user.seen, 3
           workflow.unseen_for 123, group_id: 1, limit: 3
         end
-        
+
         it 'should sample subjects from a random group without a user' do
           workflow.groups = { }
           workflow.groups[1] = set_klass.new
           expect(workflow.group(1)).to receive(:sample).with 3
           workflow.sample limit: 3
         end
-        
+
         it 'should sample subjects from a specific group without a user' do
           3.times{ |i| workflow.groups[i] = set_klass.new }
           expect(workflow.group(1)).to receive(:sample).with 3
           workflow.sample group_id: 1, limit: 3
         end
-        
+
         it 'should sample subjects from a random group for a user' do
           workflow.groups = { }
           workflow.groups[1] = set_klass.new
           expect(workflow.groups[1]).to receive(:subtract).with user.seen, 3
           workflow.sample user_id: 123, limit: 3
         end
-        
+
         it 'should sample subjects from a specific group for a user' do
           3.times{ |i| workflow.groups[i] = set_klass.new }
           expect(workflow.group(1)).to receive(:subtract).with user.seen, 3
           workflow.sample user_id: 123, group_id: 1, limit: 3
         end
-        
+
         it 'should add subjects' do
           workflow.groups[1] = set_klass.new
-          
+
           if workflow.prioritized?
             expect(workflow.groups[1]).to receive(:add).with 123, 456
             workflow.add subject_id: 123, group_id: 1, priority: 456
@@ -60,13 +60,13 @@ module Cellect::Server
             workflow.add subject_id: 123, group_id: 1
           end
         end
-        
+
         it 'should remove subjects' do
           workflow.groups[1] = set_klass.new
           expect(workflow.groups[1]).to receive(:remove).with 123
           workflow.remove subject_id: 123, group_id: 1
         end
-        
+
         it 'should be grouped' do
           expect(workflow).to be_grouped
         end

data/spec/server/node_set_spec.rb

@@ -4,7 +4,7 @@ module Cellect::Server
   describe NodeSet do
     it_behaves_like 'node set'
     let(:node_set){ Cellect::Server.node_set.actors.first }
-    
+
     it 'should register this node' do
       expect(node_set.id).to eq 'node0000000000'
       expect(node_set.zk.get('/nodes/node0000000000').first).to match /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/