cellect-server 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 657a00e07c83dc7a24a12ff3d2f72bbbab448287
-  data.tar.gz: 606329efd415d12823c4eb461038b47ec4975eec
+  metadata.gz: ce5ed6155919dbcb28b9deed2f937b67dbe726e0
+  data.tar.gz: b08a7bf06a958740ff668b927a970be4f6b17b9d
 SHA512:
-  metadata.gz: 429415d08872e3f592fc48880d65841fc398a598d7697de7f783dd434b717e33ba48007d17fa45f5ae6d8dde39f9e8271e013b843258de77b8d6b03495b16072
-  data.tar.gz: aced297af8c2dbc0ddf11f8b3835d09dc2a5ef5368deeccb23d6b2817a02b0739f9647add457d9b8d1a796e8fb583e2346e57adc4cc06696b2057afaecb6019b
+  metadata.gz: 278e910a81b231c326267c2a8be769c7759f3ec815a1fd95e9ced36a26be3e838642746832a5d6c646d3ee78b7e8f0337af860d55e2d297b054b5a3102e8f579
+  data.tar.gz: 86e06b066a4d8a308949cc23356f3dac6f06d2acd5341196cbd1007c9bb964dae696fa23539b3951e10c55c050b8c1c0aebd8b381199b80d5c63c74bb770d01a

data/.gitignore

@@ -1,7 +1,7 @@
 .bundle
 .DS_Store
 .rvmrc
-.ruby-version
+.ruby-*
 /data/*
 /ext/*.o
 /ext/Makefile
@@ -15,3 +15,4 @@ tmp/*
 pkg/*
 *.swp
 ext/
+/coverage

data/.travis.yml

@@ -15,10 +15,6 @@ before_script:
 
 rvm:
   - 2.1.5
-  - 2.1.2
-  - 2.2.0
-
-jdk:
-  - openjdk7
+  - 2.2.1
 
 script: ZK_URL=localhost:2181 bundle exec rake

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [2014-2015] by [The Zooniverse]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,19 +1,57 @@
-# Cellect [![Build Status](https://travis-ci.org/zooniverse/Cellect.svg?branch=master)](https://travis-ci.org/zooniverse/Cellect)
+# Cellect
+
+A scalable subject selector for [Panoptes](https://github.com/zooniverse/panoptes)
+
+[![Build Status](https://travis-ci.org/zooniverse/Cellect.svg?branch=master)](https://travis-ci.org/zooniverse/Cellect)
+[![Test Coverage](https://codeclimate.com/github/zooniverse/Cellect/badges/coverage.svg)](https://codeclimate.com/github/zooniverse/Cellect)
+[![Code Climate](https://codeclimate.com/github/zooniverse/Cellect/badges/gpa.svg)](https://codeclimate.com/github/zooniverse/Cellect)
+[![Gem Version](https://img.shields.io/gem/v/cellect.svg)](https://rubygems.org/gems/cellect)
+
+Available as
+  - [cellect-server](https://rubygems.org/gems/cellect-server)
+  - [cellect-client](https://rubygems.org/gems/cellect-client)
+  - [cellect](https://rubygems.org/gems/cellect)(combined)
+
+## Cellect::Server
+
+An actor based system that provides an API around subject selection actions.  Server nodes are discovered via [ZooKeeper](http://zookeeper.apache.org/).
+
+### Cellect::Server::Adapters
+
+[An adapter](lib/cellect/server/adapters/default.rb) provides an API for defining the data to be used with the system.
+
+We're overriding the default adapter with a customization in [cellect_panoptes](https://github.com/zooniverse/cellect_panoptes).
+
+
+## Cellect::Client
+
+Provides a mix of asynchronous and synchronous operations for server awareness and API communication.
 
-This is a work in progress
 
 ## Building
 
-1. Install [Boost V1.55](http://www.boost.org/): OS X: `brew update && brew install boost`, Ubuntu: `sudo apt-get update && sudo apt-get install libboost-all-dev`
+1. Install [Boost V1.55+](http://www.boost.org/): OS X: `brew update && brew install boost`, Ubuntu: `sudo apt-get update && sudo apt-get install libboost-all-dev`
 2. Install gem dependencies: `bundle` (See Note)
 
 
 ### Note
-To install rice your Ruby must be compiled with shared libraries enabled, from the rice docs: 
+To install rice your Ruby must be compiled with shared libraries enabled, from the rice docs:
 * rvm:   `rvm reinstall [version] -- --enable-shared`
 * rbenv: `CONFIGURE_OPTS="--enable-shared" rbenv install [version]`
 
 
 ## Testing
 
+* You'll need a local Zookeeper server to run the specs (they will auto start / stop the server for you).
+  * `brew install zookeeper`
+  * Note: this may require a Java Runtime (JRE) install, `brew cask install java`
+
 Run the specs with `rake`
+
+## Start server:
+
+`rackup # uses config.ru file`
+
+## Versions
+
+See .travis.yml for supported ruby versions

data/cellect.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'puma', '~> 2.8'
   spec.add_development_dependency 'pg', '~> 0.17'
   spec.add_development_dependency 'connection_pool', '~> 2.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
   
   spec.add_runtime_dependency 'cellect-server', Cellect::VERSION
   spec.add_runtime_dependency 'cellect-client', Cellect::VERSION

data/lib/cellect/node_set.rb

@@ -7,12 +7,14 @@ module Cellect
     
     attr_accessor :zk, :state
     
+    # Sets up the node set and starts connecting to ZooKeeper
     def initialize(zk_url = nil)
       @zk_url = zk_url
       self.state = :initializing
       after(0.001){ async.initialize_zk } # don't block waiting for ZK to connect
     end
     
+    # Connect to ZooKeeper, setup this node, and change state
     def initialize_zk
       # don't let ZK hang the thread, just retry connection on restart
       Timeout::timeout(5) do
@@ -33,7 +35,7 @@ module Cellect
     end
     
     def setup
-      
+      # Specialized in subclasses
     end
   end
 end

data/lib/cellect/server/adapters/postgres.rb

@@ -10,7 +10,7 @@ module Cellect
             PG.connect connection_options
           end
         end
-
+        
         def workflow_list(*names)
           with_pg do |pg|
             statement = 'SELECT * FROM workflows'
@@ -33,7 +33,7 @@ module Cellect
             end
           end
         end
-
+        
         def load_data_for(workflow_name)
           with_pg do |pg|
             statement = <<-SQL
@@ -52,7 +52,7 @@ module Cellect
             end
           end
         end
-
+        
         def load_user(workflow_name, id)
           with_pg do |pg|
             statement = <<-SQL
@@ -64,11 +64,11 @@ module Cellect
             end
           end
         end
-
+        
         def with_pg
           @pg.with{ |pg| yield pg }
         end
-
+        
         def connection_options
           {
             host: ENV.fetch('PG_HOST', '127.0.0.1'),

data/lib/cellect/server/api/helpers.rb

@@ -34,10 +34,6 @@ module Cellect
           val = params[param].try conversion
           params[param] && val && val > 0 ? val : default
         end
-        
-        def to_query(hash)
-          hash.select{ |k, v| v }.collect{ |k, v| "#{ k }=#{ v }" }.join '&'
-        end
       end
     end
   end

data/lib/cellect/server/api/sets.rb

@@ -2,15 +2,35 @@ module Cellect
   module Server
     class API
       class Sets < Grape::API
+        # GET /workflows/:workflow_id
+        # 
+        # Returns a sample from the specified workflow
+        # Accepts params
+        #   limit: integer, default 5
+        #   user_id: integer, optional
+        #   group_id: integer, optional
         get do
           workflow.sample selector_params
         end
         
+        # PUT /workflows/:workflow_id/add
+        # 
+        # Adds a subject to a workflow or updates the priority
+        # Accepts params
+        #   subject_id: integer
+        #   group_id: integer, required if grouped
+        #   priority: float, required if prioritized
         put :add do
           workflow.add update_params
           nil
         end
         
+        # PUT /workflows/:workflow_id/remove
+        # 
+        # Removes a subject from a workflow
+        # Accepts params
+        #   subject_id: integer
+        #   group_id: integer, required if grouped
         put :remove do
           workflow.remove update_params
           nil

data/lib/cellect/server/api/users.rb

@@ -4,6 +4,11 @@ module Cellect
       class Users < Grape::API
         resources :users do
           segment '/:user_id' do
+            # PUT /workflows/:workflow_id/users/:user_id/add_seen
+            # 
+            # Adds a subject to a user's seen set for a workflow
+            # Accepts params
+            #   subject_id: integer, required
             put :add_seen do
               user_id = param_to_int :user_id
               subject_id = param_to_int :subject_id
@@ -15,6 +20,9 @@ module Cellect
               nil
             end
             
+            # POST /workflows/:workflow_id/users/:user_id/load
+            # 
+            # Preloads a user for a workflow
             post :load do
               user_id = param_to_int :user_id
               

data/lib/cellect/server/api.rb

@@ -9,6 +9,9 @@ module Cellect
       require 'cellect/server/api/sets'
       require 'cellect/server/api/users'
       
+      # GET /stats
+      # 
+      # Provides system load information
       get :stats do
         usage = ->(keyword) do
           `ps axo #{ keyword }`.chomp.split("\n")[1..-1].collect(&:to_f).inject :+
@@ -21,6 +24,10 @@ module Cellect
       end
       
       resources :workflows do
+        
+        # GET /workflows
+        # 
+        # Returns a list of available workflows
         get do
           Cellect::Server.adapter.workflow_list
         end
@@ -30,14 +37,23 @@ module Cellect
           mount Sets
           mount Users
           
+          # GET /workflows/:workflow_id/status
+          # 
+          # Returns the workflow's status
           get :status do
             workflow.status
           end
           
+          # POST /workflows/:workflow_id/reload
+          # 
+          # Reloads the workflow from the adapter
           post :reload do
             workflow.async.load_data
           end
           
+          # DELETE /workflows/:workflow_id
+          # 
+          # Not implemented
           delete do
             # delete a workflow (maybe?)
           end

data/lib/cellect/server/grouped_workflow.rb

@@ -3,11 +3,13 @@ module Cellect
     class GroupedWorkflow < Workflow
       attr_accessor :groups
       
+      # Sets up the new workflow
       def initialize(name, pairwise: false, prioritized: false)
         self.groups = { }
         super
       end
       
+      # Load subjects from the adapter into their groups
       def load_data
         self.state = :initializing
         self.groups = { }
@@ -19,14 +21,24 @@ module Cellect
         self.state = :ready
       end
       
+      # Returns a group by id or samples one randomly
       def group(group_id = nil)
         groups[group_id] || groups.values.sample
       end
       
+      # Get unseen subjects from a group for a user
       def unseen_for(user_name, group_id: nil, limit: 5)
         group(group_id).subtract user(user_name).seen, limit
       end
       
+      # Get a sample of subjects from a group for a user
+      # 
+      # Accepts a hash in the form:
+      #   {
+      #     user_id: 123,
+      #     group_id: 2,
+      #     limit: 5
+      #   }
       def sample(opts = { })
         if opts[:user_id]
           unseen_for opts[:user_id], group_id: opts[:group_id], limit: opts[:limit]
@@ -35,6 +47,14 @@ module Cellect
         end
       end
       
+      # Adds or updates a subject in a group
+      # 
+      # Accepts a hash in the form:
+      # {
+      #   subject_id: 1,
+      #   group_id: 2,
+      #   priority: 0.5  # (if the workflow is prioritized)
+      # }
       def add(opts = { })
         if prioritized?
           groups[opts[:group_id]].add opts[:subject_id], opts[:priority]
@@ -43,11 +63,20 @@ module Cellect
         end
       end
       
+      # Removes a subject from a group
+      # 
+      # Accepts a hash in the form:
+      # {
+      #   group_id: 1,
+      #   subject_id: 2
+      # }
       def remove(opts = { })
         groups[opts[:group_id]].remove opts[:subject_id]
       end
       
+      # General information about this workflow
       def status
+        # Get the number of subjects in each group
         group_counts = Hash[*groups.collect{ |id, set| [id, set.size] }.flatten]
         
         super.merge({

data/lib/cellect/server/node_set.rb

@@ -8,10 +8,13 @@ module Cellect
       
       protected
       
+      # Registers this server instance with ZooKeeper
       def setup
         zk.mkdir_p '/nodes'
+        # Find the local ipv4 address
         address = Socket.ip_address_list.find{ |address| address.ipv4? && !address.ipv4_loopback? }
         raise "Cannot identify IP address" unless address
+        # Register this instance with an autoincrementing id
         path = zk.create '/nodes/node', data: address.ip_address, mode: :ephemeral_sequential
         self.id = path.sub /^\/nodes\//, ''
       end

data/lib/cellect/server/user.rb

@@ -4,12 +4,14 @@ module Cellect
       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
         self.workflow_name = workflow_name
@@ -19,6 +21,7 @@ module Cellect
         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) || []
         data.each do |subject_id|
@@ -28,25 +31,25 @@ module Cellect
         restart_ttl_timer
       end
       
+      # Returns the seen subjects set
       def seen
         restart_ttl_timer
         @seen
       end
       
-      def state_changed(topic, state)
-        restart_ttl_timer if state == :ready && ttl
-      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
@@ -57,6 +60,7 @@ module Cellect
         @ttl || 60 * 15 # 15 minutes
       end
       
+      # Handle errors and let the actor die
       def workflow_crashed(actor, reason)
         cancel_ttl_timer
         terminate

data/lib/cellect/server/workflow.rb

@@ -6,25 +6,30 @@ module Cellect
       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
         self.users = { }
@@ -34,6 +39,7 @@ module Cellect
         load_data
       end
       
+      # Loads subjects from the adapter
       def load_data
         self.state = :initializing
         self.subjects = set_klass.new
@@ -43,26 +49,37 @@ module Cellect
         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:
+      #   {
+      #     user_id: 123,
+      #     limit: 5
+      #   }
       def sample(opts = { })
         if opts[:user_id]
           unseen_for opts[:user_id], limit: opts[:limit]
@@ -71,6 +88,13 @@ module Cellect
         end
       end
       
+      # Adds or updates a subject
+      # 
+      # Accepts a hash in the form:
+      # {
+      #   subject_id: 1,
+      #   priority: 0.5  # (if the workflow is prioritized)
+      # }
       def add(opts = { })
         if prioritized?
           subjects.add opts[:subject_id], opts[:priority]
@@ -79,6 +103,12 @@ module Cellect
         end
       end
       
+      # Removes a subject
+      # 
+      # Accepts a hash in the form:
+      # {
+      #   subject_id: 1
+      # }
       def remove(opts = { })
         subjects.remove opts[:subject_id]
       end
@@ -99,6 +129,7 @@ module Cellect
         state == :ready
       end
       
+      # Provide a lookup for matching sets to workflow criteria
       SET_KLASS = {
         # priority, pairwise
         [    false, false  ] => DiffSet::RandomSet,
@@ -107,10 +138,12 @@ module Cellect
         [     true, true   ] => DiffSet::PairwisePrioritySet
       }
       
+      # Looks up the set class
       def set_klass
         SET_KLASS[[prioritized, pairwise]]
       end
       
+      # General information about this workflow
       def status
         {
           state: state,

data/lib/cellect/server.rb

@@ -15,6 +15,7 @@ module Cellect
       attr_accessor :node_set
     end
     
+    # The server is ready when all workflows have finished loading
     def self.ready?
       Workflow.all.each do |workflow|
         return false unless workflow.ready?

data/lib/cellect/version.rb

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

data/spec/server/workflow_spec.rb

@@ -55,7 +55,7 @@ module Cellect::Server
           id = user.id
           workflow.remove_user id
           expect(workflow.users).to_not have_key id
-          expect{ user.id }.to raise_error
+          expect{ user.id }.to raise_error Celluloid::DeadActorError
         end
         
         it 'should not be grouped' do

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
 CELLECT_ROOT = File.expand_path File.join(File.dirname(__FILE__), '../')
 
 %w(lib ext).each do |name|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cellect-server
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Parrish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -231,6 +231,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - cellect-server.gemspec
@@ -303,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: ''