feature_flagger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74316fc70e25aa5098d8e500a59b1a983dabff2d
-  data.tar.gz: 98f838a09eb04c89b5f5f36b4b3a84859de36b14
+  metadata.gz: 62073fceeca45388c4bd40ce2a3829766ba0f4d8
+  data.tar.gz: 7b4b54a2c3167009654572bae7b5f6bac32d2430
 SHA512:
-  metadata.gz: f9b56d90d8bda18e090fb81b84387aef0c9bc053e09c758b2cbe3ebc38103b2a7208049c5bb822dfe036750ffde5ed4736341956234b8bb0bc4f083f342622e2
-  data.tar.gz: a00d2a9aac2e8ab2082f7ec6950a73f0d1653a9497ea0ee7b69adf15e8f0ee8311d82c0dd0e2fbcefc1437cf4618de0325432fb4e6f7a23db49b6567e8d4ae87
+  metadata.gz: b0107beb5008bf298cb25bff915a8aa077ca119bca202985509062276f06e2d4a8632552c37f8e06b0da72f2bbd63a3c7c4c33578fbe9e2ad474fbe5fd3e78f3
+  data.tar.gz: 392188e411e2017fd906df2eef539af7a52cc82229bddba4280373a548dc8a84cb32263a2072b43cef2849d603a310f901c12abe39eac6313b7cfcaa914c57fb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011-2016 Resultados Digitais. http://resultadosdigitais.com.br
+
+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

@@ -18,11 +18,17 @@ Or install it yourself as:
 
     $ gem install feature_flagger
 
-## Usage
 
-### Rails
+## Configuration
+
+1. Configure redis by adding `config/initializers/feature_flagger.rb`:
+```ruby
+FeatureFlagger.configure do |config|
+  config.redis = $redis
+end
+```
 
-1. Create a `rollout.yml` in _config_ path and declare a rollout:
+2. Create a `rollout.yml` in _config_ path and declare a rollout:
 ```yml
 account: # model name
   email_marketing: # namespace (optional)
@@ -31,7 +37,7 @@ account: # model name
         @dispatch team uses this rollout to introduce a new email flow for certains users. Read more at [link]
 ```
 
-2. Adds rollout funcionality to your model:
+3. Adds rollout funcionality to your model:
 ```ruby
 class Account < ActiveRecord::Base
   include FeatureFlagger::Model
@@ -39,22 +45,27 @@ class Account < ActiveRecord::Base
 end
 ```
 
+## Usage
 
-3. Check;
 ```ruby
-class DashboardController < ApplicationController
-  def index
-    if current_user.account.rollout?([:email_marketing, :new_email_flow])
-      # render something
-    else
-      # render something else
-    end
-  end
-end
-```
+account = Account.first
+
+# Release feature for account
+account.release!([:email_marketing, :new_email_flow])
+#=> true
 
-P.S: If you try to check a inexistent rollout key will raise an error.
+# Check feature for a given account
+account.rollout?([:email_marketing, :new_email_flow])
+#=> true
 
+# Remove feature for given account
+account.unrelease!([:email_marketing, :new_email_flow])
+#=> true
+
+# If you try to check an existent rollout key it will raise an error.
+account.rollout?([:email_marketing, :new_email_flo])
+FeatureFlagger::KeyNotFoundError: ["account", "email_marketing", "new_email_flo"]
+```
 
 ## Contributing
 

data/feature_flagger.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = FeatureFlagger::VERSION
   spec.authors       = ["Nando Sousa"]
   spec.email         = ["nandosousafr@gmail.com"]
+  spec.licenses      = ['MIT']
 
-  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
+  spec.summary       = %q{Partial release your features.}
+  spec.description   = %q{Management tool to make it easier rollouting features to customers.}
   spec.homepage      = "http://github.com/ResultadosDigitais/feature_flagger"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/feature_flagger/model.rb

@@ -8,31 +8,43 @@ module FeatureFlagger
   # Account.first.rollout?([:email_marketing, :new_awesome_feature])
   # #=> true
   module Model
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
     def rollout?(feature_key)
-      Feature.new(feature_key, rollout_resource_name).fetch!
-      Control.rollout?(feature_key, id, rollout_resource_name)
+      resource_name = self.class.rollout_resource_name
+      Feature.new(feature_key, resource_name).fetch!
+      Control.rollout?(feature_key, id, resource_name)
     end
 
     def release!(feature_key)
-      Feature.new(feature_key, rollout_resource_name).fetch!
-      Control.release!(feature_key, id, rollout_resource_name)
+      resource_name = self.class.rollout_resource_name
+      Feature.new(feature_key, resource_name).fetch!
+      Control.release!(feature_key, id, resource_name)
     end
 
     def unrelease!(feature_key)
-      Feature.new(feature_key, rollout_resource_name).fetch!
-      Control.unrelease!(feature_key, id, rollout_resource_name)
+      resource_name = self.class.rollout_resource_name
+      Feature.new(feature_key, resource_name).fetch!
+      Control.unrelease!(feature_key, id, resource_name)
     end
 
-    private
+    module ClassMethods
+      def all_released_ids_for(feature_key)
+        Feature.new(feature_key, rollout_resource_name).fetch!
+        Control.resource_ids(feature_key, rollout_resource_name)
+      end
 
-    def rollout_resource_name
-      klass_name = self.class.name
-      klass_name.gsub!(/::/, '_')
-      klass_name.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-      klass_name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-      klass_name.tr!("-", "_")
-      klass_name.downcase!
-      klass_name
+      def rollout_resource_name
+        klass_name = self.to_s
+        klass_name.gsub!(/::/, '_')
+        klass_name.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+        klass_name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        klass_name.tr!("-", "_")
+        klass_name.downcase!
+        klass_name
+      end
     end
   end
 end

data/lib/feature_flagger/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlagger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nando Sousa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Write a longer description or delete this line.
+description: Management tool to make it easier rollouting features to customers.
 email:
 - nandosousafr@gmail.com
 executables: []
@@ -77,6 +77,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- MIT-LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -88,7 +89,8 @@ files:
 - lib/feature_flagger/model.rb
 - lib/feature_flagger/version.rb
 homepage: http://github.com/ResultadosDigitais/feature_flagger
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -109,6 +111,6 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because Rubygems requires one.
+summary: Partial release your features.
 test_files: []
 has_rdoc: