feature_toggle_service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69e04610330c60056641ffeb2adda8447e4fce10
+  data.tar.gz: 30cb79cde24af32b240f087648bf125c182f8a83
+SHA512:
+  metadata.gz: ce08d5daeb1bf3b5d9249d92ceee43c04aef9cc2961c193a2c21f2c2185dd7b63f3eb6eb121753a2884df5f6937427b3039db58dd189a57ca206db45e0435c17
+  data.tar.gz: 00c6b39126820d30cd6fb41046c0ac92bb7856ed2961a964b96664cce86780d4c33279104bb0ba437edcb09a9135c1facefd4d5ccdae2f710fa18ad4d1ca8af7

data/.gitignore

@@ -0,0 +1,10 @@
+/.idea
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache: bundler
+
+addons:
+  code_climate:
+    repo_token: a2a9d06575f1e096805e0fe260e3f0c7e740e23de2a89afe7d07761e486ac5a1
+
+rvm:
+  - 2.1.6
+  - 2.2.2
+
+script: 'bundle exec rake spec'
+
+notifications:
+  email:
+    recipients:
+      - eturino@eturino.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in feature_toggle_service.gemspec
+gemspec
+gem 'codeclimate-test-reporter', group: :test, require: nil
+gem 'webmock', group: :test

data/README.md

@@ -0,0 +1,133 @@
+# FeatureToggleService
+
+[![Gem Version](https://badge.fury.io/rb/feature_toggle_service.svg)](http://badge.fury.io/rb/feature_toggle_service)
+[![Build Status](https://travis-ci.org/eturino/feature_toggle_service.svg?branch=master)](https://travis-ci.org/eturino/feature_toggle_service)
+[![Code Climate](https://codeclimate.com/github/eturino/feature_toggle_service/badges/gpa.svg)](https://codeclimate.com/github/eturino/feature_toggle_service)
+[![Test Coverage](https://codeclimate.com/github/eturino/feature_toggle_service/badges/coverage.svg)](https://codeclimate.com/github/eturino/feature_toggle_service/coverage)
+
+A client for Feature Toggles. It uses [hobknob](https://github.com/opentable/hobknob) and [etcd](https://github.com/coreos/etcd) as data source.
+
+It also supports overrides and defaults.
+
+## Basic use
+
+We use `on?` and `off?` methods, to check if a feature is enabled or disabled in hobknob. We use a simple String or Symbol as the key. It performs a `to_s` to the key so using `:feature` or `'feature'` is the same.
+
+```ruby
+
+if FeatureToggleService.on? :my_feature
+  do_something_that_needs_my_feature
+end
+
+if FeatureToggleService.off? 'other_feature'
+  do_something_that_assumes_other_feature_is_not_enabled
+end
+
+```
+
+## Override
+
+If an override is set, either ON or OFF, then we don't look into etcd, and we return the override value directly.
+ 
+An override is set to ON with `FeatureToggleService.override_on(key)`, and to OFF with `FeatureToggleService.override_off(key)`.
+ 
+We can remove an override with `FeatureToggleService.unset_override(key)`, or all of hem with `FeatureToggleService.clear_override`.
+
+
+## Default
+
+If there is no override for the given key, and it's not set in hobknob to either ON or OFF, then the default value is used. By default, the default value is `nil` which count as falsey.
+ 
+A default is set to ON with `FeatureToggleService.default_on(key)`, and to OFF with `FeatureToggleService.default_off(key)`.
+ 
+We can remove a default with `FeatureToggleService.unset_default(key)`, or all of hem with `FeatureToggleService.clear_default`.
+
+
+## Config parameters
+
+We can set parameters for config.
+
+* `app_name`: required. It's the App name in hobknob.
+* `logger`: logger to be used in the client. Defaults to `nil`
+* `logger_level`: if no `logger` is passed, then a new `Logger` will be created to `STDOUT` and this level will be used. Defaults to `nil` 
+* `key_suffix`: a suffix on the key, used as the discriminator in hobknob. Can be the environment, or the domain...  Defaults to `nil`
+* `enabled`: if false, then etcd calls are skipped, and only overrides and defaults are used. Defaults to `true`
+* `etcd_client`: parameters for the etcd client. It's a hash. Defaults to `{ port: 4001 }`
+
+*important: The config has to be set before using the service*
+
+We can set the configs with `FeatureToggleService.config_params[:enabled] = true`.
+
+ 
+## Example
+
+if in Rails, this would be in an initializer. This example sets the config from SimpleConfig.
+
+```ruby
+require 'feature_toggle_service'
+
+# config
+FeatureToggleService.config_params[:enabled]            = SimpleConfig.for(:site).feature_toggle.enabled
+FeatureToggleService.config_params[:app_name]           = SimpleConfig.for(:site).feature_toggle.app_name
+FeatureToggleService.config_params[:etcd_client][:port] = SimpleConfig.for(:site).feature_toggle.etcd_client.port
+FeatureToggleService.config_params[:logger]             = Rails.logger
+FeatureToggleService.config_params[:key_suffix]         = Rails.env
+
+# specific defaults on this project
+FeatureToggleService.default_on :one_feature
+FeatureToggleService.default_off :another_feature
+
+# specific overrides on this project
+FeatureToggleService.override_on :third_feature
+FeatureToggleService.override_off 'other_stuff'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'feature_toggle_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feature_toggle_service
+
+## Usage
+
+### Setup
+
+Example of configuration in an Rails initializer, using SimpleConfig. We're setting up some config params, and also enabling by default a feature `'my_feature'`
+
+```ruby
+require 'feature_toggle_service'
+
+# config
+FeatureToggleService.config_params[:enabled]            = SimpleConfig.for(:site).feature_toggle.enabled
+FeatureToggleService.config_params[:app_name]           = SimpleConfig.for(:site).feature_toggle.app_name
+FeatureToggleService.config_params[:etcd_client][:port] = SimpleConfig.for(:site).feature_toggle.etcd_client.port
+FeatureToggleService.config_params[:logger]             = Rails.logger
+FeatureToggleService.config_params[:key_suffix]         = Rails.env
+
+# specific defaults on this project
+FeatureToggleService.default_on :my_feature
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/eturino/feature_toggle_service/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

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task default: :spec
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "feature_toggle_service"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/feature_toggle_service.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feature_toggle_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'feature_toggle_service'
+  spec.version       = FeatureToggleService::VERSION
+  spec.authors       = ['Eduardo Turiño']
+  spec.email         = ['eturino@eturino.com']
+
+  spec.summary       = %q{Service for using feature toggles in your ruby code (true/false by a specific key). It supports overrides, defaults, and it gets the information from etcd.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/eturino/feature_toggle_service'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  # end
+
+  spec.add_dependency 'etcd'
+  spec.add_dependency 'activesupport', '~> 4'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'naught'
+end

data/lib/feature_toggle_service/config.rb

@@ -0,0 +1,25 @@
+module FeatureToggleService
+  class Config
+
+    attr_reader :enabled, :app_name, :etcd_client, :logger, :key_suffix
+
+    def initialize(logger: nil, logger_level: nil, key_suffix: 'suffix', enabled: true, app_name:, etcd_client: { port: 4001 })
+      @enabled     = enabled
+      @app_name    = app_name
+      @etcd_client = etcd_client
+      @key_suffix  = key_suffix
+      @logger      = logger || build_logger(logger_level)
+    end
+
+    def enabled?
+      !!enabled
+    end
+
+    private
+    def build_logger(logger_level)
+      Logger.new(STDOUT).tap do |log|
+        log.level = logger_level if logger_level.present?
+      end
+    end
+  end
+end

data/lib/feature_toggle_service/repository.rb

@@ -0,0 +1,74 @@
+module FeatureToggleService
+  class Repository
+    DEFAULT_VALUE = nil
+
+    attr_reader :config
+
+    def initialize(config)
+      @config    = config
+      @overrides = {}
+      @defaults  = {}
+    end
+
+    def get(key)
+      @overrides.fetch(key.to_s) { load_value(key) }
+    end
+
+    def default_value_for(key)
+      @defaults.fetch(key.to_s, DEFAULT_VALUE)
+    end
+
+    def set_override(key, value)
+      @overrides[key.to_s] = value
+    end
+
+    def unset_override(key)
+      @overrides.delete key.to_s
+    end
+
+    def clear_overrides
+      @overrides.clear
+    end
+
+    def set_default(key, value)
+      @defaults[key.to_s] = value
+    end
+
+    def unset_default(key)
+      @defaults.delete key.to_s
+    end
+
+    def clear_defaults
+      @defaults.clear
+    end
+
+    delegate :key_suffix, :enabled?, :app_name, to: :config
+
+    private
+    delegate :logger, to: :config
+
+    def load_value(key)
+      enabled? ? retrieve_value(key) : default_value_for(key)
+    end
+
+    def retrieve_value(key)
+      fk = final_key(key)
+      etcd_client.get(fk).value
+    rescue Etcd::KeyNotFound => e
+      logger.error { "Feature Toggle without key #{key.inspect}, final key #{fk.inspect}." }
+      default_value_for(key)
+    rescue Errno::ECONNREFUSED => e
+      logger.error { "Cannot connect with Feature Toggle Repository! #{key.inspect}, final key #{fk.inspect}." }
+      Airbrake.notify(e)
+      default_value_for(key)
+    end
+
+    def final_key(key)
+      "/v1/toggles/#{app_name}/#{key}/#{key_suffix}"
+    end
+
+    def etcd_client
+      @etc_client ||= Etcd.client(config.etcd_client)
+    end
+  end
+end

data/lib/feature_toggle_service/service.rb

@@ -0,0 +1,54 @@
+module FeatureToggleService
+  class Service
+
+    FALSE_VALUES = [:false, 'false', false, 0]
+    TRUE_VALUES  = [:true, 'true', true, 1]
+
+    # Instance
+    def config_params
+      @config_params ||= { key_suffix: 'suffix', enabled: true, app_name: 'Default App', etcd_client: { port: 4001 } }
+    end
+
+    def off?(key)
+      !on? key
+    end
+
+    def on?(key)
+      case repository.get(key)
+      when *TRUE_VALUES
+        true
+      else
+        false
+      end
+    end
+
+    # FOR TESTS, DEFAULTS and OVERRIDES
+    delegate :unset_override, :clear_overrides, :unset_default, :clear_defaults, to: :repository
+
+    # helper methods
+    def default_on(key)
+      repository.set_default key, true
+    end
+
+    def default_off(key)
+      repository.set_default key, false
+    end
+
+    def override_on(key)
+      repository.set_override key, true
+    end
+
+    def override_off(key)
+      repository.set_override key, false
+    end
+
+    def config
+      @config ||= Config.new config_params
+    end
+
+    private
+    def repository
+      @repository ||= Repository.new config
+    end
+  end
+end

data/lib/feature_toggle_service/version.rb

@@ -0,0 +1,3 @@
+module FeatureToggleService
+  VERSION = '0.1.0'
+end

data/lib/feature_toggle_service.rb

@@ -0,0 +1,26 @@
+require 'etcd'
+require 'active_support/all'
+require 'feature_toggle_service/version'
+require 'feature_toggle_service/service'
+require 'feature_toggle_service/config'
+require 'feature_toggle_service/repository'
+
+module FeatureToggleService
+
+  # Delegation of static methods to the Service instance
+  class << self
+    delegate :on?, :off?, :config_params, :config_params=,
+             :override_on, :override_off, :unset_override, :clear_overrides,
+             :default_on, :default_off, :unset_default, :clear_defaults,
+             to: :service
+  end
+
+  def self.service
+    @service ||= reload_service
+  end
+
+  def self.reload_service
+    @service = Service.new
+  end
+
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: feature_toggle_service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eduardo Turiño
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: etcd
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rspec-nc
+  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: 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: pry-nav
+  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: pry-rescue
+  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: pry-stack_explorer
+  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: pry-doc
+  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: naught
+  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: 
+email:
+- eturino@eturino.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- feature_toggle_service.gemspec
+- lib/feature_toggle_service.rb
+- lib/feature_toggle_service/config.rb
+- lib/feature_toggle_service/repository.rb
+- lib/feature_toggle_service/service.rb
+- lib/feature_toggle_service/version.rb
+homepage: https://github.com/eturino/feature_toggle_service
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Service for using feature toggles in your ruby code (true/false by a specific
+  key). It supports overrides, defaults, and it gets the information from etcd.
+test_files: []
+has_rdoc: