enabler 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81a5568c263c249d5c68726e559979f77c71d85c
-  data.tar.gz: 8e2c9dec31542bc566abdde1dbf2bd4c2e6b455c
+  metadata.gz: 7292b10984446825ad2199ad40de2589136c203b
+  data.tar.gz: 9ef0a852a2c72b8a1dec129969731e6525946834
 SHA512:
-  metadata.gz: b879b9fa5f9480de357d9bd6f1972a66ad7c428874358d118e5fa593ec41e83f7250290c9a56833f3be10fc340aeaf94bbdd5ebcadfbedfd4b15f87be53f24f6
-  data.tar.gz: bdc32849784e5138dc7e7b59d09318775b41a92c03de83e07a22096b8644c47278470b51cf8a0afd4a60eba25aac37aea5190fb43d6f3d9fd8390d95ce752993
+  metadata.gz: 27d862408a5fb3547f41365ef5cd4e562302e2a5f6e69e9642147a522f8f9bf45d1e6f3bd938d3f27a3d4433c37d9a86579ac70942548d22e0a24dbc0ccb671a
+  data.tar.gz: 94f7ff34fbaaabd17e1f5535a6e4b4e969503234219ce54157b9aa3f553ce437dc7d0c266a07ab1d415a9cf418a0bebb37b2e87bc9f92b2a72acbd4ad60b845a

data/.gitignore

@@ -32,3 +32,5 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.DS_STORE

data/README.md

@@ -1,6 +1,11 @@
 # Enabler
 
-Feature enabler
+### Granular Feature Enabling For Ruby Apps
+
+There are a fair few feature flip gems out there. None of them had *exactly* the feature set I needed. Most either flipped features globally or worked only on the basis of a user class. I needed to be able to switch features on for users, teams of users OR entirely different models altogether E.G companies
+
+The goal of this gem is to enable very *granular* control of which users/teams/companies/customers/cats have access to which features. 
+
 
 ## Installation
 
@@ -18,7 +23,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+Currently there is only one storage adapter - Redis
+
+```Ruby
+Enabler.store = Enabler::Storage::Redis.new($redis)
+```
+
+### Rules
+
+```Ruby
+Enabler.define_rule! :dance do |object|
+  object.is_cool?
+end
+```
+
+### Specific Models
+
+```Ruby
+Enabler.enable! :dance, User.first
+```
+
+### Check if feature enabled for object
+
+```Ruby
+class NewFeatureController < ActionController::Base
+  def show
+    redirect_to '/home' unless Enabler.enabled? :new_feature, current_user
+    render_super_secret_awesome_new_feature
+  end
+end
+```
+
+
+
+## TODO
+* caching
+* group definitions
+* rake task to add feature for percentage of users
+* ActiveRecord storage
+* Mongo storage
+* In memory storage
+
 
 ## Contributing
 

data/lib/enabler/version.rb

@@ -1,3 +1,3 @@
 module Enabler
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/enabler.rb

@@ -26,7 +26,7 @@ module Enabler
 		sym = feature.to_sym
 		r = self.rule(sym)
 		return false unless r
-		r.enabled?(model)
+		r.enabled?(object)
 	end
 
 	def self.enable!(feature, object)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enabler
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Luke Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis