can-do 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eb5a19ab6f14a1d63e0d490b212ce57da941430
-  data.tar.gz: 2a53db2847e808306c426853d767a8f2319a62de
+  metadata.gz: a0ea512e8449c21e74af8d3d8f0d025b549c43e5
+  data.tar.gz: ba1daeabb76c50d8337a36a1833b7bf3394f8ed3
 SHA512:
-  metadata.gz: 335a1d55bbc0ada21058946bf487a46915ed944e93c8d3bc007f0600277f30b656a8b1a324d37bb482a5263c39deff677b9b02e410693baa5b4b8b671e7132f2
-  data.tar.gz: 356dfff84096d84920547a38c5787d6d3a58027189cf0d8d3c1b7471a1e7d5b4b71a4ea47491fae93790563e3e68af5e187f8944f15c1dcbda0f49a468ff56cc
+  metadata.gz: 66bf959f3b5f28b13f11589c2b485066b28d3d493bd2d2ddf675de2290640bc6c49579083c3b5fdc738216fe71adb1bf2d6c5bc51874b2f26830f2dbbeb36631
+  data.tar.gz: d1a7991590354dd293c68608163437fdad126bc9ebd5138363279c26ddeeb9fdda6830244fb946ce170a310d9ef0642d332b9240ee455bc418b50a0e900d9df6

data/.gitignore

@@ -9,3 +9,5 @@
 /tmp/
 
 .ruby-version
+.DS_Store
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/blacklane/rubocop/master/rubocop.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+before_script:
+  - bundle install
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Gemfile

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

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/can-do.svg)](http://badge.fury.io/rb/can-do)
 
-Flips your features based on a `config/features.yml` file or environment variables. No data store required.
+Flips your features based on a redis key, a `config/features.yml` file or environment variables.
 
 ## Usage
 
@@ -14,6 +14,36 @@ Add `can-do` to your Gemfile:
 gem "can-do", require: "can_do"
 ```
 
+## Redis values
+
+To use redis as a storage set the environment variable `CANDO_REDIS_URL` with your redis instance.
+
+The keys have to be prefixed with 'features:'.
+
+So to set and use the feature `experiment-1` set the key like
+
+```sh
+$ redis-cli SET features:experiment_1 true
+```
+
+and use it like
+
+```ruby
+require "can_do"
+
+CanDo.feature?(:experiment_1)
+```
+
+Any unset key will fall back to either the environment variable or the yaml variable and `false` if none is set.
+
+```ruby
+require "can_do"
+
+CanDo.feature?(:experiment_1)
+```
+
+## Yaml File
+
 Inside the `config` folder relative to your working directory create a file called `features.yml`. Within this file,
 place your *default feature flags* within the `defaults` key. All available features should be listed here, together with
 their default values. Add *environment-specific* feature flags under the environment name.
@@ -48,7 +78,7 @@ CanDo.feature?(:some_feature) do
 end
 ```
 
-If a feature is not found, `CanDo::NotAFeature` is raised.
+If a feature is not found, `false` is returned.
 
 ## Environment variables
 

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "can_do"
+
+require "pry"
+Pry.start

data/can_do.gemspec

@@ -3,12 +3,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "can-do"
-  spec.version       = "0.1.1"
-  spec.authors       = ["Florin Lipan", "Yuri Veremeyenko"]
-  spec.email         = ["florin.lipan@blacklane.com", "yuri.veremeyenko@blacklane.com"]
+  spec.version       = "1.0.0"
+  spec.authors       = ["Blacklane"]
 
   spec.summary       = %q{Simple feature flags.}
-  spec.description   = %q{Simple feature flags based on a YAML config file and/or environment variables.}
+  spec.description   = %q{Simple feature flags based on a redis instance, a YAML config file and/or environment variables.}
   spec.homepage      = "https://github.com/blacklane/can-do"
   spec.license       = "MIT"
 
@@ -17,5 +16,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "redis"
+  spec.add_dependency "connection_pool"
+
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rspec-mocks"
 end

data/lib/can_do.rb

@@ -1,8 +1,10 @@
+require "connection_pool"
+require "redis"
 require "singleton"
 require "yaml"
 
-# Flips your features based on a config/features.yml file or environment variables.
-# Environment variables always take precedence over the settings in your YAML file.
+# Flips your features based on either a redis key, a config/features.yml file or environment variables.
+# Redis keys always take precedence over Environment variables and the settings in your YAML file.
 #
 # @example config/features.yml
 #   defaults:
@@ -26,8 +28,11 @@ require "yaml"
 #
 class CanDo
   include Singleton
-
-  NotAFeature = Class.new(StandardError)
+  FEATURE_KEY_PREFIX = "features:"
+  CONNECTION_POOL_SIZE = ENV.fetch("CANDO_CONNECTION_POOL_SIZE", 5)
+  CONNECTION_POOL = ConnectionPool.new(size: CONNECTION_POOL_SIZE, timeout: 5) do
+    Redis.new(url: ENV["CANDO_REDIS_URL"])
+  end
 
   THE_TRUTH = /^(true|t|yes|y|1)$/i
   DEFAULT_NAMESPACE = "defaults".freeze
@@ -38,18 +43,29 @@ class CanDo
     instance.features
   end
 
-  def self.feature?(name, &block)
+  def self.shared_features(name)
+    CONNECTION_POOL.with do |redis|
+      begin
+        redis.get(FEATURE_KEY_PREFIX + name.to_s)
+      rescue Redis::BaseError
+        nil
+      end
+    end
+  end
+
+  def self.feature?(name)
     name     = name.to_s
     env_name = name.upcase
-
-    fail NotAFeature.new(name) unless features.key?(name)
+    shared_feature = shared_features(name)
 
     is_enabled =
-      if ENV.key?(env_name)
+      if !shared_feature.nil?
+        !!(shared_feature =~ THE_TRUTH)
+      elsif ENV.key?(env_name)
         !!(ENV[env_name] =~ THE_TRUTH)
-       else
-         features[name] == true
-       end
+      else
+        features[name] == true
+      end
 
     # If no block is passed, return true or false
     return is_enabled unless block_given?
@@ -61,10 +77,15 @@ class CanDo
   private
 
   def initialize
-    yaml = File.read(File.expand_path("config/features.yml", Dir.pwd))
-    data = YAML.load(yaml)
-
-    @features = (data.fetch(DEFAULT_NAMESPACE, {})).merge(data.fetch(env, {}))
+    yaml_file = File.expand_path("config/features.yml", Dir.pwd)
+
+    @features =
+      if File.exist?(yaml_file)
+        data = YAML.safe_load(File.read(yaml_file))
+        data.fetch(DEFAULT_NAMESPACE, {}).merge(data.fetch(env, {}))
+      else
+        {}
+      end
   end
 
   def env

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: can-do
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Florin Lipan
-- Yuri Veremeyenko
+- Blacklane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,18 +52,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple feature flags based on a YAML config file and/or environment variables.
-email:
-- florin.lipan@blacklane.com
-- yuri.veremeyenko@blacklane.com
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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: Simple feature flags based on a redis instance, a YAML config file and/or
+  environment variables.
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
+- bin/console
 - can_do.gemspec
 - lib/can_do.rb
 homepage: https://github.com/blacklane/can-do
@@ -59,8 +144,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple feature flags.
 test_files: []
+has_rdoc: