featureswitches 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee74f39270d0d3c7a4dd1693098902de7115694b
+  data.tar.gz: 59c16ebdd822a0f138ea9d5133e16f43ad297947
+SHA512:
+  metadata.gz: 0369a8e947e190a753f45f0cd7ccd9906b54cc81c51f4a708c8647555ff883422251f10365268ef5b19abee33674c691094b00d49c78a3db5749260a0580e3aa
+  data.tar.gz: 169427bdd5448049f7a759d2f3ea3bf21f243866e10d1cb8179d898e5267e8bbbd02e116b1b28c941e010a2bfc1cc94dad8a85b75f27a5b96808acec5a2d855a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in featureswitches.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joel Weirauch
+
+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

@@ -0,0 +1,65 @@
+# Featureswitches
+
+A Ruby gem for interacting with [FeatureSwitches.com](https://featureswitches.com).  This library is under active development and is likely to change frequently.  Bug reports and pull requests are welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'featureswitches'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install featureswitches
+
+## Usage
+
+```ruby
+fs = FeatureSwitches.new('customer_api_key', 'environment_api_key', {options})
+
+# Ensure that the API credentials are valid
+result = fs.authenticate  # result will be true/false to indicate success
+
+# Add a user
+result = fs.add_user('user_identifier', 'optional_customer_identifier', 'optional_name', 'optional_email')
+
+# Check if a feature is enabled
+result = fs.is_enabled('feature_key', 'optional_user_identifier', default_return_value(true/false, default=false))
+
+if result
+    # Feature enabled, do something
+else
+    # Feature disabled, do something else
+end
+```
+
+### Configuration Options
+A few options are available to be tweaked if you so choose. The library makes use of a local cache to minimize requests back to the FeatureSwitches server. Additionally, a check it performed at an interval to automatically re-sync feature state when changes are made in the dashboard.
+
+```ruby
+{
+    :cache_timeout => SECONDS, # optional, defaults to 300 seconds
+    :check_interval => SECONDS # optional, defaults to 10 seconds
+}
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/featureswitches/featureswitches-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "featureswitches"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/featureswitches.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'featureswitches/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "featureswitches"
+  spec.version       = Featureswitches::VERSION
+  spec.authors       = ["Joel Weirauch"]
+  spec.email         = ["joel@featureswitches.com"]
+
+  spec.summary       = %q{Ruby client for FeatureSwitches.com, feature flags as a service.}
+  spec.homepage      = "https://github.com/featureswitches/featureswitches-ruby"
+  spec.license       = "MIT"
+
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "ruby-cache", "~> 0.3"
+  spec.add_dependency "nestful", "~> 1.1"
+end

data/lib/featureswitches/version.rb

@@ -0,0 +1,3 @@
+class Featureswitches
+  VERSION = "0.8.1"
+end

data/lib/featureswitches.rb

@@ -0,0 +1,188 @@
+require "featureswitches/version"
+require "thread"
+require "cache"
+require "nestful"
+
+class Featureswitches
+    def initialize(customer_key, environment_key, options={})
+        @customer_key = customer_key
+        @environment_key = environment_key
+        @cache_timeout = options[:cache_timeout] ||= 300
+        @check_interval = options[:check_interval] ||= 10
+        @last_update = 0
+        @last_dirty_check = 0
+        @api = options[:api] ||= 'https://api.featureswitches.com/v1/'
+
+        @cache = Cache.new
+
+        @dirty_check_thread = do_dirty_check
+    end
+
+    def authenticate
+        endpoint = 'authenticate'
+        response = api_request(endpoint)
+
+        return response
+    end
+
+    def sync
+        endpoint = 'features'
+        response = api_request(endpoint)
+
+        features = response[:data]['features']
+
+        features.each do |feature|
+            feature['last_sync'] = Time.now.to_i
+            @cache[feature['feature_key']] = feature
+        end
+    end
+
+    def is_enabled(feature_key, user_identifier=nil, default=false)
+        feature = @cache[feature_key]
+        if feature and not cache_is_stale(feature)
+            return enabled_for_user(feature, user_identifier)
+        else
+            feature = get_feature(feature_key)
+            if feature
+                return enabled_for_user(feature, user_identifier)
+            end
+        end
+        return default
+    end
+
+    def add_user(user_identifier, customer_identifier=nil, name=nil, email=nil)
+        endpoint = 'user/add'
+        params = {
+            'user_identifier' => user_identifier,
+            'customer_identifier' => customer_identifier,
+            'name' => name,
+            'email' => email
+        }
+        response = api_request(endpoint, params, :post)
+
+        if response[:success]
+            return true
+        end
+        return false
+    end
+
+    def dirty_check
+        endpoint = 'dirty-check'
+        response = api_request(endpoint)
+        
+        if response[:success]
+            @last_dirty_check = Time.now.to_i
+
+            if response[:data]['last_update'] > @last_update
+                @last_update = response[:data]['last_update']
+                sync()
+            end
+        end
+    end
+
+    private
+
+    def get_feature(feature_key)
+        endpoint = 'feature'
+        params = {'feature_key' => feature_key}
+        response = api_request(endpoint, params)
+
+        if response[:success]
+            feature = response[:data]['feature']
+
+            feature['last_sync'] = Time.now.to_i
+            @cache[feature['feature_key']] = feature
+
+            return feature
+        end
+
+        return nil
+    end
+
+    def enabled_for_user(feature, user_identifier)
+        if feature['enabled'] and user_identifier
+            if feature['include_users'].length > 0
+                if feature['include_users'].include? user_identifier
+                    return true
+                else
+                    return false
+                end
+            elsif feature['exclude_users'].length > 0
+                if feature['exclude_users'].include? user_identifier
+                    return false
+                else
+                    return true
+                end
+            end
+        elsif not user_identifier and (feature['include_users'].length > 0 or feature['exclude_users'].length > 0)
+            return false
+        end
+
+        return feature['enabled']
+    end
+
+    def cache_is_stale(feature)
+        cache_expiration = (Time.now.to_i - @cache_timeout)
+        if feature['last_sync'] > cache_expiration and @last_dirty_check > cache_expiration
+            return false
+        end
+
+        if @last_dirty_check < cache_expiration
+            return true
+        end
+
+        return false
+    end
+
+    def api_request(endpoint, params={}, method=:get)
+        headers = {
+            'Authorization' => "#{@customer_key}:#{@environment_key}"
+        }
+
+        begin
+            request = Nestful::Request.new(@api + endpoint, :headers => headers, :params => params, :method => method)
+            response = request.execute
+
+            if response.status == 200
+                data = response.decoded
+                result = {
+                    'success': true,
+                    'message': '',
+                    'data': data
+                }
+            else
+                data = response.decoded
+                result = {
+                    'success': false,
+                    'message': data['message'],
+                    'status': response.status
+                }
+            end
+
+            return result
+        rescue Nestful::ForbiddenAccess
+            result = {
+                'success': false,
+                'message': 'Authentication Error',
+                'status': 403
+            }
+            return result
+        rescue Nestful::ConnectionError
+            result = {
+                'success': false,
+                'message': 'Error communicating with FeatureSwitches',
+                'status': -1
+            }
+            return result
+        end
+    end
+
+    def do_dirty_check
+        Thread.new do
+            loop do
+                dirty_check()
+                sleep(@check_interval)
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: featureswitches
+version: !ruby/object:Gem::Version
+  version: 0.8.1
+platform: ruby
+authors:
+- Joel Weirauch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: ruby-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: nestful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- joel@featureswitches.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- featureswitches.gemspec
+- lib/featureswitches.rb
+- lib/featureswitches/version.rb
+homepage: https://github.com/featureswitches/featureswitches-ruby
+licenses:
+- MIT
+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: Ruby client for FeatureSwitches.com, feature flags as a service.
+test_files: []