time_pilot 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e30816cd185929b8db4677c3eeba8d1200f4acdf
+  data.tar.gz: 7885bfb2cddd2862470aa34d38df4ed0179793ec
+SHA512:
+  metadata.gz: b67e44321f7a86052d17c0bb73ca1a43eaa435b88b8c6bda7cef90f215efa627f9defbd6febdf27f705f0221730c45906c411569d29948b0fc2cf28d12f112d1
+  data.tar.gz: 9924dcfc8baf230d40fa53b5935d5f635bfb9e73b3c451ec9636726afa4d01acffc8d070a5011c72a328625c9d351237dc43c93cbec2d6b16bae0e1c1329e9d4

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+services:
+  - redis-server

data/AUTHORS

@@ -0,0 +1,2 @@
+Matthijs Langenberg
+Mark Oude Veldhuis

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gem 'rake'
+gem 'redis'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Matthijs Langenberg and Mark Oude Veldhuis
+
+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,102 @@
+# TimePilot ![Build Status](https://magnum.travis-ci.com/nedap/time_pilot.svg?token=xp5ywq16hRcpzRui8vVa&branch=master) ![Code Climate](https://codeclimate.com/repos/538c225ae30ba00d55006394/badges/1741b217ec9818699a37/gpa.png)
+
+TimePilot is a RubyGem that makes it possible to define features that can be enabled for a certain group of users. It requires very little configuration, and is designed to work stand-alone on any object. TimePilot uses Redis for storage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'time_pilot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_pilot
+
+# Configuration
+
+The features that you want to specify need to be added in an initializer as such:
+
+```ruby
+# config/initializers/time_pilot.rb
+TimePilot.configure do |c|
+  c.feature :planning
+  c.feature :private_messaging
+end
+```
+
+Using this configuration, the `TimePilot::Features` module is enriched with three methods per feature at boot time: `{feature}_enabled?`, `enable_{feature}` and `disable_{feature}`. In every model that you would want to invoke these methods, i.e. check if a feature is enabled or either enable or disable it for that group you need to `include TimePilot::Features`.
+
+After including `TimePilot::Features` add: `is_pilot_group`. You can specify an `overridden_by: [:foo, :bar, ...]` to specify any relations that override the setting for the object itself. See the example below for `Team` and `User`.
+
+```ruby
+# app/model/organization.rb
+class Organization
+  attr_accessor :id
+
+  include TimePilot::Features
+  is_pilot_group
+end
+
+# app/model/team.rb
+class Team
+  attr_accessor :organization_id, :id
+
+  include TimePilot::Features
+  is_pilot_group overridden_by: :organization
+end
+
+# app/model/user.rb
+class User
+  attr_accessor :organization_id, :team_id, :id
+
+  include TimePilot::Features
+  is_pilot_group overridden_by: [:organization, :team]
+end
+
+# app/model/person.rb
+class Person
+  attr_accessor :id
+
+  include TimePilot::Features
+  is_pilot_group
+end
+```
+
+When you invoke `user.planning_enabled?`, TimePilot fill first check if the feature has been enabled for the organization with the ID obtained from `user.organization_id`. If that evaluates to `false`, TimePilot continues checking the feature, but now using `user.team_id`. Then, if that fails too, it checks whether the feature is enabled for the user itself.
+
+## Configuring Redis
+
+TimePilot uses `localhost:6379` by default for Redis. To connect to a Redis instance on a different port or host, provide a Redis client in `TimePilot.configure` block.
+
+```
+# config/initializers/time_pilot.rb
+TimePilot.configure do |c|
+  c.redis Redis.new(...)
+end
+```
+
+TimePilot assumes you put in an object that responds to `#sadd`, `#srem` and `#sismember`.
+
+# Usage
+
+The configuration above allows you to invoke the following methods on a `Organization`, `Team`, `User` and `Person`:
+
+```ruby
+# Methods for feature 'planning'
+user.planning_enabled?
+user.enable_planning
+user.disable_planning
+
+# Methods for feature 'private_messaging'
+user.private_messaging_enabled?
+user.enable_private_messaging
+user.disable_private_messaging
+
+# The same methods can be invoked on an instance of Organization,
+# Team and Person provided the example above, since they all include
+# the `Features` module.
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/lib/time_pilot/configuration.rb

@@ -0,0 +1,20 @@
+module TimePilot
+
+  class Configuration
+    attr_reader :features, :redis_store
+
+    def initialize
+      @features = []
+      @redis_store = Redis.new
+    end
+
+    def feature feature_name
+      @features.push(feature_name)
+    end
+
+    def redis redis_store
+      @redis_store = redis_store
+    end
+  end
+
+end

data/lib/time_pilot/time_pilot.rb

@@ -0,0 +1,67 @@
+module TimePilot
+  NAMESPACE = 'timepilot'
+
+  def self.configure
+    @config = Configuration.new
+    yield @config
+    @config.features.each do |feature_name|
+      Features.module_eval do
+        define_method "enable_#{feature_name}" do
+          pilot_enable_feature(feature_name)
+        end
+
+        define_method "disable_#{feature_name}" do
+          pilot_disable_feature(feature_name)
+        end
+
+        define_method "#{feature_name}_enabled?" do
+          pilot_feature_enabled?(feature_name)
+        end
+      end
+    end
+  end
+
+  def self.features
+    @config.features
+  end
+
+  def self.redis
+    @config.redis_store
+  end
+
+  def self.key(name)
+    "#{NAMESPACE}:#{name}"
+  end
+
+  module Features
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      attr_reader :time_pilot_groups
+      def is_pilot_group options={}
+        @time_pilot_groups = Array(options[:overridden_by]).map { |e| e.to_s } + [self.name.downcase.to_s]
+      end
+    end
+
+    def pilot_enable_feature(feature_name)
+      TimePilot.redis.sadd TimePilot.key("#{feature_name}:#{self.class.to_s.downcase}_ids"), id
+    end
+
+    def pilot_disable_feature(feature_name)
+      TimePilot.redis.srem TimePilot.key("#{feature_name}:#{self.class.to_s.downcase}_ids"), id
+    end
+
+    def pilot_feature_enabled?(feature_name)
+      TimePilot.redis.pipelined {
+        self.class.time_pilot_groups.each do |group|
+          method = group.to_s == self.class.to_s.downcase ? 'id' : group + '_id'
+          TimePilot.redis.sismember TimePilot.key("#{feature_name}:#{group}_ids"), send(method)
+        end
+      }.include? true
+    end
+
+  end
+
+end

data/lib/time_pilot.rb

@@ -0,0 +1,3 @@
+require 'redis'
+require_relative 'time_pilot/time_pilot'
+require_relative 'time_pilot/configuration'

data/test/time_pilot_test.rb

@@ -0,0 +1,114 @@
+require_relative '../lib/time_pilot'
+require 'minitest/autorun'
+
+class Company
+  include TimePilot::Features
+  is_pilot_group
+  attr_reader :id
+  def initialize(id)
+    @id = id
+  end
+end
+
+class Team
+  include TimePilot::Features
+  is_pilot_group overridden_by: :company
+  attr_reader :company_id, :id
+  def initialize(company_id, id)
+    @company_id = company_id
+    @id = id
+  end
+end
+
+class Employee
+  include TimePilot::Features
+  is_pilot_group overridden_by: [:company, :team]
+  attr_reader :company_id, :team_id, :id
+  def initialize(company_id, team_id, id)
+    @company_id = company_id
+    @team_id = team_id
+    @id = id
+  end
+end
+
+TimePilot.configure do |c|
+  c.feature 'planning'
+end
+
+describe TimePilot do
+  before do
+    TimePilot.redis.flushdb
+    @acme = Company.new(1)
+    @nedap = Company.new(2)
+    @healthcare = Team.new(@nedap.id, 11)
+    @retail = Team.new(@nedap.id, 12)
+    @john = Employee.new(@nedap.id, @healthcare.id, 21)
+    @jane = Employee.new(@nedap.id, @healthcare.id, 22)
+  end
+
+  it 'defines a getter on company' do
+    TimePilot.redis.sadd 'timepilot:planning:company_ids', @acme.id
+    @acme.planning_enabled?.must_equal true
+  end
+
+  it 'defines an enabler on company' do
+    @nedap.enable_planning
+    TimePilot.redis.sismember("timepilot:planning:company_ids", @nedap.id).must_equal true
+  end
+
+  it 'defines a disabler on employee' do
+    @nedap.enable_planning
+    @nedap.planning_enabled?.must_equal true
+    @nedap.disable_planning
+    @nedap.planning_enabled?.must_equal false
+  end
+
+  it 'defines a getter on team' do
+    TimePilot.redis.sadd 'timepilot:planning:team_ids', @healthcare.id
+    @healthcare.planning_enabled?.must_equal true
+  end
+
+  it 'defines an enabler on team' do
+    @retail.enable_planning
+    TimePilot.redis.sismember("timepilot:planning:team_ids", @retail.id).must_equal true
+  end
+
+  it 'defines a disabler on team' do
+    @retail.enable_planning
+    @retail.planning_enabled?.must_equal true
+    @retail.disable_planning
+    @retail.planning_enabled?.must_equal false
+  end
+
+  it 'defines a getter on employee' do
+    TimePilot.redis.sadd 'timepilot:planning:employee_ids', @john.id
+    @john.planning_enabled?.must_equal true
+  end
+
+  it 'defines an enabler on employee' do
+    @jane.enable_planning
+    TimePilot.redis.sismember("timepilot:planning:employee_ids", @jane.id).must_equal true
+  end
+
+  it 'defines a disabler on employee' do
+    @jane.enable_planning
+    @jane.planning_enabled?.must_equal true
+    @jane.disable_planning
+    @jane.planning_enabled?.must_equal false
+  end
+
+  specify 'company overrides team' do
+    @nedap.enable_planning
+    @retail.planning_enabled?.must_equal true
+  end
+
+  specify 'team overrides employee' do
+    @healthcare.enable_planning
+    @john.planning_enabled?.must_equal true
+  end
+
+  specify 'company overrides employee' do
+    @nedap.enable_planning
+    @jane.planning_enabled?.must_equal true
+  end
+end

data/time_pilot.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name         = 'time_pilot'
+  s.summary      = 'Configure enabled features for a specific set of users.'
+  s.description  = ''
+  s.version      = '0.0.2'
+  s.platform     = Gem::Platform::RUBY
+  s.license      = 'MIT'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test}/*`.split("\n")
+  s.require_path = 'lib'
+
+  s.authors     = ['@mlangenberg', '@markoudev']
+  s.email       = ['matthijs.langenberg@nedap.com', 'mark.oudeveldhuis@nedap.com']
+  s.homepage    = 'https://github.com/nedap/time_pilot'
+
+  s.add_dependency 'redis', '>= 3.0.0'
+  s.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: time_pilot
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- "@mlangenberg"
+- "@markoudev"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.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:
+- matthijs.langenberg@nedap.com
+- mark.oudeveldhuis@nedap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- AUTHORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/time_pilot.rb
+- lib/time_pilot/configuration.rb
+- lib/time_pilot/time_pilot.rb
+- test/time_pilot_test.rb
+- time_pilot.gemspec
+homepage: https://github.com/nedap/time_pilot
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Configure enabled features for a specific set of users.
+test_files: []