rcurtain 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65e63f659922d0050a7db72ff68f0103ada30e84
-  data.tar.gz: 251c4ac93f27fcdd230404898c3c53ce0969bc15
+  metadata.gz: b3c5aae4847c4ef5864c98f8e18c07f69a686513
+  data.tar.gz: ba76810da71297453711dd3c01ca9c162d950e56
 SHA512:
-  metadata.gz: 85cac5248779c6372cb08828ccdaa91984be5caca803df4aa7b1872fc3817807cf12064109074559e74ce1908e4d918bed3244c3b57b508b41d532960277b5d4
-  data.tar.gz: 03ebfed07264c8cb52c9689efda64488568ed492a9e483e2d931d01feda4c6d8a6e29d484a8d56e5dd4af04d4aecf916dbef344a53e4b0fb59cf33bdbdb98b82
+  metadata.gz: bd8ed380aa872dfc64ce3c30a5d560edf64f792bebd9e1070a759bde0ce4082ab0ebc52d187924298f24a85178cdb76c182f170aec424f5792b5d69f1167d95e
+  data.tar.gz: 904aa233851ae90259dd0acebc59a5f1776b172d1a9c49e8dfdf8ce339daf3d5e7b24a90fae8f88b32ba35be962a98fa269f80efbf46dd26bfbf817dbbac06cd

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    rcurtain (0.0.3)
+      hiredis
+      redis (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    hiredis (0.6.1)
+    redis (3.3.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rcurtain!
+  rspec

data/README.md

@@ -0,0 +1,58 @@
+# RCurtain
+
+Easy way to control your features using [redis](http://redis.io/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rcurtain'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rcurtain
+
+## Usage
+
+* Rcurtain uses redis to control features, which can be checked by a **percentage** or a **set of users**.
+```
+feature:[name-of-feature]:percentage
+```
+```
+feature:[name-of-feature]:users
+```
+
+* To use Rcurtain, create a new object Rcurtain using your redis URL. (password@ip:port/database)
+```ruby
+rcurtain = Rcurtain.new("redis://:p4ssw0rd@10.0.1.1:6380/15")
+``` 
+
+* Consult if a feature is opened using the method "opened?", passing the name of the feature you want to check.
+```ruby
+rcurtain.opened? "feature"
+``` 
+
+* You can also pass a set of users to be checked.
+```ruby
+rcurtain.opened? ("feature", ['user-1','user-2'])
+``` 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moip/rcurtain. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+1. Fork it ( https://github.com/moip/rcurtain/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rcurtain/curtain.rb

@@ -0,0 +1,37 @@
+module Rcurtain
+  class Curtain
+
+    attr_reader :redis
+
+    def initialize (url)
+      @redis = Redis.new(:url => url)
+    end
+
+    def opened? (feature, users = [])
+      feat = get_feature(feature)
+
+      return (compare_percentage?(feat.percentage)) || (users.any? { |user| feat.users.include?(user)}) unless users.empty?
+
+      compare_percentage?(feat.percentage)
+    rescue Redis::CannotConnectError
+      return false
+    end
+
+    private
+      def get_feature (name)
+        percentage = redis.get("feature:#{name}:percentage")
+        percentage ||= 0
+
+        users = redis.smembers("feature:#{name}:users")
+        users ||= []
+
+        return Feature.new(name, percentage, users)
+      end
+
+      def compare_percentage? (percentage)
+        rnd = Random.new
+        rnd.rand(1..100) <= percentage.to_f
+      end
+
+  end
+end

data/lib/rcurtain/feature.rb

@@ -0,0 +1,13 @@
+module Rcurtain
+  class Feature
+
+    attr_accessor :name, :percentage, :users
+
+    def initialize (name, percentage, users)
+      @name = name
+      @percentage = percentage
+      @users = users
+    end
+
+  end
+end

data/rcurtain.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'rcurtain'
+  s.version     = '0.0.3'
+  s.date        = '2016-05-26'
+  s.summary     = "RCurtain"
+  s.description = "Open the curtain and see if your feature is enabled"
+  s.authors     = ["Danillo Souza", "Gabriel Queiroz"]
+  s.email       = ["danillo.souza@moip.com.br", "gabriel.queiroz@moip.com.br"]
+  s.homepage    =
+    'http://github.com/moip/curtain'
+  s.license       = 'MIT'
+
+  s.files       = Dir['**/*'].keep_if { |file| File.file?(file) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency "hiredis"
+  s.add_runtime_dependency "redis", "~>3.2"
+  s.add_development_dependency "rspec"
+end

data/spec/lib/curtain_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+describe Rcurtain do
+
+  subject(:rcurtain) { Rcurtain.new("redis://:p4ssw0rd@10.0.1.1:6380/15") }
+
+  context "is opened" do
+
+    context "when 100%" do
+      before do
+        allow_any_instance_of(Redis).to receive(:get).and_return(100)
+        allow_any_instance_of(Redis).to receive(:smembers).and_return(nil)
+      end
+
+      it { expect(rcurtain.opened? "feature").to be true }
+    end
+
+    context "when user exists" do
+      before do
+        allow_any_instance_of(Redis).to receive(:get).and_return(0)
+        allow_any_instance_of(Redis).to receive(:smembers).and_return(['MPA-123'])
+      end
+
+      it { expect(rcurtain.opened?("feature", ['MPA-123'])).to be true }
+    end
+  end
+
+  context "is closed" do
+    context "when 0%" do
+      before do
+        allow_any_instance_of(Redis).to receive(:get).and_return(0)
+        allow_any_instance_of(Redis).to receive(:smembers).and_return(nil)
+      end
+
+      it { expect(rcurtain.opened? "feature").to be false }
+    end
+
+    context "when user does not exists" do
+      before do
+        allow_any_instance_of(Redis).to receive(:get).and_return(0)
+        allow_any_instance_of(Redis).to receive(:smembers).and_return(["MPA-321"])
+      end
+
+      it { expect(rcurtain.opened?("feature", ['MPA-123'])).to be false }
+    end
+
+    context "when nothing was found on redis" do
+      before do
+        allow_any_instance_of(Redis).to receive(:get).and_return(nil)
+        allow_any_instance_of(Redis).to receive(:smembers).and_return(nil)
+      end
+
+      it { expect(rcurtain.opened? "feature_not_found").to be false }
+    end
+
+    context "when failed connection" do
+      before do
+        allow_any_instance_of(Redis).to receive(:get).and_raise(Redis::CannotConnectError)
+        allow_any_instance_of(Redis).to receive(:smembers).and_raise(Redis::CannotConnectError)
+      end
+
+      it { expect(rcurtain.opened? "feature").to be false }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'rspec'
+
+require "rcurtain"
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcurtain
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Danillo Souza
@@ -61,7 +61,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- README.md
 - lib/rcurtain.rb
+- lib/rcurtain/curtain.rb
+- lib/rcurtain/feature.rb
+- rcurtain.gemspec
+- spec/lib/curtain_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/moip/curtain
 licenses:
 - MIT
@@ -82,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: RCurtain