time_pilot 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbeca7afffcc0db740f30a3337ad4fc3b0841586
-  data.tar.gz: 22c08aef2488cdcdc7b85d2fb7a79c140ea3139a
+  metadata.gz: 8265534aac5fa5aaa1b563c34c8f1f18c6085c00
+  data.tar.gz: 3a4bf6338d822b708b9c85f26c462a827ab6cba2
 SHA512:
-  metadata.gz: 374d7cf4de3ea502124796c2f45a78f2341e7d1a875683b5f0e94c12905d5dc7395f4c08a9bdf5e9547fc3bf158e196179fe899c8b48e9808d0455c12c1200cf
-  data.tar.gz: 4307f16f7c2d6a361405b6b2b2334bd168fcc056d8f6755a5ed918120769d0bac8739af1fe7cb2c68db9c888ffada1ae036df5a82f61d92a46922040bbbd3689
+  metadata.gz: 757a1a9f389f4ee6db56a2aa14936ebd5a7baf29068f5c6c6db7b31c924e701f03473567fee938282acf4decf05dc6dbb179daa6fe4c963163b2c3ccac318fdb
+  data.tar.gz: 7d54911d42b93a522aeeb27846017dbf12588d8dc2f4a7c3d0f08cffdada7b3b26bfd92a5dca8b8963571cbc3a25c46376582284039ca196e245b4bcf697d64a

data/README.md

@@ -79,6 +79,8 @@ TimePilot.configure do |c|
 end
 ```
 
+TimePilot assumes you put in an object that responds to `#sadd`, `#srem`, `#sismember` and `#scard`.
+
 ## Multiple configure blocks
 
 TimePilot allows you to specify more than one configure block. This allows you to specify features at multiple levels. For example, you could specify features in a Rails Engine located in a separate gem, as well as the host application. It's easy as this:
@@ -95,7 +97,23 @@ TimePilot.configure do |c|
 end
 ```
 
-TimePilot assumes you put in an object that responds to `#sadd`, `#srem` and `#sismember`.
+## TimePilot Web
+
+TimePilot provides a dashboard that is mountable inside a Rails app.
+```ruby
+# in config/initializers/time_pilot.rb
+require 'time_pilot/web'
+TimePilot::Web.use(Rack::Auth::Basic) do |user, password|
+  username == ENV["TIME_PILOT_USERNAME"] && password == ENV["TIME_PILOT_PASSWORD"]
+end
+
+# in routes.rb
+Application.routes.draw do
+  mount TimePilot::Web => '/time_pilot'
+end
+```
+
+`TimePilot::Web` is just a Rack app. You can use it outside Rails.
 
 # Usage
 

data/lib/time_pilot/configuration.rb

@@ -1,5 +1,4 @@
 module TimePilot
-
   class Configuration
     attr_reader :features, :redis_store
 
@@ -8,13 +7,12 @@ module TimePilot
       @redis_store = Redis.new
     end
 
-    def feature feature_name
+    def feature(feature_name)
       @features.push(feature_name)
     end
 
-    def redis redis_store
+    def redis(redis_store)
       @redis_store = redis_store
     end
   end
-
 end

data/lib/time_pilot/time_pilot.rb

@@ -1,22 +1,36 @@
 module TimePilot
   NAMESPACE = 'timepilot'
+  @group_classes = []
+  @mutex = Mutex.new
+
+  def self.register_class(klass)
+    @mutex.synchronize do
+      @group_classes << klass
+    end
+  end
+
+  class << self
+    attr_reader :group_classes
+  end
 
   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
+    @config.features.each { |f| define_feature_method(f) }
+  end
 
-        define_method "disable_#{feature_name}" do
-          pilot_disable_feature(feature_name)
-        end
+  def self.define_feature_method(feature_name)
+    Features.module_eval do
+      define_method "enable_#{feature_name}" do
+        pilot_enable_feature(feature_name)
+      end
 
-        define_method "#{feature_name}_enabled?" do
-          pilot_feature_enabled?(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
@@ -33,6 +47,7 @@ module TimePilot
     "#{NAMESPACE}:#{name}"
   end
 
+  # Including this module makes a class a TimePilot class
   module Features
     def self.included(base)
       base.send :extend, ClassMethods
@@ -40,26 +55,35 @@ module TimePilot
 
     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.to_s.underscore]
+      def is_pilot_group(options = {})
+        TimePilot.register_class(self)
+        @time_pilot_groups = Array(options[:overridden_by]).map(&:to_s) +
+                             [to_s.underscore]
+      end
+
+      def pilot_feature_cardinality(feature_name)
+        key_name = "#{feature_name}:#{to_s.underscore}_ids"
+        TimePilot.redis.scard TimePilot.key(key_name)
       end
     end
 
     def pilot_enable_feature(feature_name)
-      TimePilot.redis.sadd TimePilot.key("#{feature_name}:#{self.class.to_s.underscore}_ids"), id
+      key_name = "#{feature_name}:#{self.class.to_s.underscore}_ids"
+      TimePilot.redis.sadd TimePilot.key(key_name), id
     end
 
     def pilot_disable_feature(feature_name)
-      TimePilot.redis.srem TimePilot.key("#{feature_name}:#{self.class.to_s.underscore}_ids"), id
+      key_name = "#{feature_name}:#{self.class.to_s.underscore}_ids"
+      TimePilot.redis.srem TimePilot.key(key_name), id
     end
 
     def pilot_feature_enabled?(feature_name)
-      TimePilot.redis.pipelined {
+      TimePilot.redis.pipelined do
         self.class.time_pilot_groups.each do |group|
           method = group.to_s == self.class.to_s.underscore ? 'id' : group + '_id'
           TimePilot.redis.sismember TimePilot.key("#{feature_name}:#{group}_ids"), send(method)
         end
-      }.include? true
+      end.include? true
     end
 
   end

data/lib/time_pilot/version.rb

@@ -1,3 +1,3 @@
 module TimePilot
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/lib/time_pilot/web.rb

@@ -0,0 +1,74 @@
+require 'erb'
+
+module TimePilot
+  # Rack application displaying member counts
+  class Web
+    def call(env)
+      dup.call!(env)
+    end
+
+    def call!(env)
+      req = Rack::Request.new(env)
+      case req.path_info
+      when '/'
+        dashboard
+      else
+        not_found
+      end
+    end
+
+    # TODO: use Redis pipelining
+    def dashboard
+      @total_count = TimePilot.features.map do |feature_name|
+        counts = TimePilot.group_classes.map do |klass|
+          [klass.to_s, klass.pilot_feature_cardinality(feature_name)]
+        end.to_h
+        [feature_name, counts]
+      end.to_h
+      erb :index
+    end
+
+    def not_found
+      [404, { 'Content-Type' => 'text/html' }, ['Not Found']]
+    end
+
+    def erb(view)
+      [
+        200,
+        { 'Content-Type' => 'text/html' },
+        [ERB.new(read_template(view)).result(binding)]
+      ]
+    end
+
+    def read_template(view)
+      File.read(File.join(__dir__, '..', '..', 'web', "#{view}.html.erb"))
+    end
+
+    class << self
+      def app
+        @app ||= instance
+      end
+
+      def call(env)
+        app.call(env)
+      end
+
+      def use(middleware, *args, &block)
+        @app = nil
+        @middleware << [middleware, args, block]
+      end
+
+      def instance
+        builder = Rack::Builder.new
+        @middleware.each { |c, a, b| builder.use(c, *a, &b) }
+        builder.run new
+        builder.to_app
+      end
+
+      def reset!
+        @middleware = []
+      end
+    end
+    reset!
+  end
+end

data/myapp/Gemfile

@@ -0,0 +1,2 @@
+gem 'rack'
+gem 'time_pilot', path: '..'

data/myapp/simple.ru

@@ -0,0 +1,42 @@
+require 'time_pilot'
+
+TimePilot.configure do |c|
+  c.feature :planning
+  c.feature :private_messaging
+end
+
+class Team
+  attr_accessor :id
+  include TimePilot::Features
+  is_pilot_group
+end
+
+class Employee
+  attr_accessor :id, :team_id
+  include TimePilot::Features
+  is_pilot_group overridden_by: [:team]
+end
+
+healthcare = Team.new
+healthcare.id = 1
+healthcare.enable_planning
+
+john = Employee.new
+john.id = 1
+john.team_id = healthcare.id
+john.enable_planning
+john.enable_private_messaging
+
+jane = Employee.new
+jane.id = 2
+jane.team_id = healthcare.id
+jane.enable_planning
+jane.disable_planning
+jane.enable_private_messaging
+
+require 'time_pilot/web'
+TimePilot::Web.use(Rack::Auth::Basic) do
+  true
+end
+
+run TimePilot::Web

data/myapp/start.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+rerun -d '..' 'rackup simple.ru'

data/test/time_pilot_test.rb

@@ -107,6 +107,21 @@ describe TimePilot do
     @jane.planning_enabled?.must_equal false
   end
 
+  it 'defines a cardinality count on the classes' do
+    @nedap.enable_planning
+    @john.enable_planning
+    @jane.enable_planning
+    Company.pilot_feature_cardinality(:planning).must_equal 1
+    Team.pilot_feature_cardinality(:planning).must_equal 0
+    Employee.pilot_feature_cardinality(:planning).must_equal 2
+  end
+
+  it 'registers classes that include TimePilot::Features' do
+    TimePilot.group_classes.must_include Company
+    TimePilot.group_classes.must_include Team
+    TimePilot.group_classes.must_include Employee
+  end
+
   specify 'company overrides team' do
     @nedap.enable_planning
     @retail.planning_enabled?.must_equal true

data/web/index.html.erb

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Time Pilot Web</title>
+  <link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.6.0/pure-min.css">
+  <style type="text/css">
+    h1 {
+      text-align: center;
+    }
+    body {
+      font-family: "HelveticaNeue-Light", "Helvetica Neue Light", "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;
+      font-weight: 300;
+    }
+    .centered {
+      margin-left: auto;
+      margin-right: auto;
+    }
+  </style>
+</head>
+<body>
+<div class="pure-g-r">
+  <div class="pure-u-1-1">
+    <h1>Time Pilot Web</h1>
+    <table class="pure-table pure-table-horizontal pure-table-striped centered">
+      <thead>
+        <tr>
+          <th>Feature</th><th>Group</th><th>Count</th>
+        </tr>
+      </thead>
+      <tbody>
+<% @total_count.each do |feature, groups| %>
+  <% groups.each do |group, count| %>
+        <tr>
+          <td><%= feature %></td>
+          <td><%= group %></td>
+          <td><%= count %></td>
+        </tr>
+  <% end %>
+<% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_pilot
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - "@mlangenberg"
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -72,8 +72,13 @@ files:
 - lib/time_pilot/configuration.rb
 - lib/time_pilot/time_pilot.rb
 - lib/time_pilot/version.rb
+- lib/time_pilot/web.rb
+- myapp/Gemfile
+- myapp/simple.ru
+- myapp/start.sh
 - test/time_pilot_test.rb
 - time_pilot.gemspec
+- web/index.html.erb
 homepage: https://github.com/nedap/time_pilot
 licenses:
 - MIT
@@ -94,9 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Configure enabled features for a specific set of users.
 test_files: []
-has_rdoc: