unleash 0.1.1

data/lib/unleash/strategy/application_hostname.rb

@@ -0,0 +1,24 @@
+require 'socket'
+
+module Unleash
+  module Strategy
+    class ApplicationHostname < Base
+      attr_accessor :hostname
+
+      def initialize
+        self.hostname = Socket.gethostname || 'undefined'
+      end
+
+      def name
+        'applicationHostname'
+      end
+
+      # need: :params[:hostnames]
+      def is_enabled?(params = {}, context = nil)
+        return false unless params.is_a?(Hash) && params.has_key?('hostnames')
+
+        params['hostnames'].split(",").map(&:strip).map{|h| h.downcase }.include?(self.hostname)
+      end
+    end
+  end
+end

data/lib/unleash/strategy/base.rb

@@ -0,0 +1,16 @@
+module Unleash
+  module Strategy
+    class NotImplemented < Exception
+    end
+
+    class Base
+      def name
+        raise NotImplemented, "Strategy is not implemented"
+      end
+
+      def is_enabled?(params = {}, context = nil)
+        raise NotImplemented, "Strategy is not implemented"
+      end
+    end
+  end
+end

data/lib/unleash/strategy/default.rb

@@ -0,0 +1,13 @@
+module Unleash
+  module Strategy
+    class Default < Base
+      def name
+        'default'
+      end
+
+      def is_enabled?(params = {}, context = nil)
+        true
+      end
+    end
+  end
+end

data/lib/unleash/strategy/gradual_rollout_random.rb

@@ -0,0 +1,26 @@
+require 'unleash/strategy/util'
+
+module Unleash
+  module Strategy
+    class GradualRolloutRandom < Base
+      def name
+        'gradualRolloutRandom'
+      end
+
+      # need: params['percentage']
+      def is_enabled?(params = {}, context = nil)
+        return false unless params.is_a?(Hash) && params.has_key?('percentage')
+
+        begin
+          percentage = Integer(params['percentage'] || 0)
+        rescue ArgumentError => e
+          return false
+        end
+
+        randomNumber = Random.rand(100) + 1
+
+        (percentage >= randomNumber)
+      end
+    end
+  end
+end

data/lib/unleash/strategy/gradual_rollout_sessionid.rb

@@ -0,0 +1,20 @@
+require 'unleash/strategy/util'
+
+module Unleash
+  module Strategy
+    class GradualRolloutSessionId < Base
+      def name
+        'gradualRolloutSessionId'
+      end
+
+      # need: params['percentage'], params['groupId'], context.user_id,
+      def is_enabled?(params = {}, context)
+        return false unless params.is_a?(Hash) && params.has_key?('percentage')
+        return false unless context.class.name == 'Unleash::Context'
+
+        percentage = Integer(params['percentage'] || 0)
+        (percentage > 0 && Util.get_normalized_number(context.session_id, params['groupId'] || "") <= percentage)
+      end
+    end
+  end
+end

data/lib/unleash/strategy/gradual_rollout_userid.rb

@@ -0,0 +1,20 @@
+require 'unleash/strategy/util'
+
+module Unleash
+  module Strategy
+    class GradualRolloutUserId < Base
+      def name
+        'gradualRolloutUserId'
+      end
+
+      # need: params['percentage'], params['groupId'], context.user_id,
+      def is_enabled?(params = {}, context)
+        return false unless params.is_a?(Hash) && params.has_key?('percentage')
+        return false unless context.class.name == 'Unleash::Context'
+
+        percentage = Integer(params['percentage'] || 0)
+        (percentage > 0 && Util.get_normalized_number(context.user_id, params['groupId'] || "") <= percentage)
+      end
+    end
+  end
+end

data/lib/unleash/strategy/remote_address.rb

@@ -0,0 +1,18 @@
+module Unleash
+  module Strategy
+    class RemoteAddress < Base
+      def name
+        'remoteAddress'
+      end
+
+      # need: params['ips'], context.remote_address
+      def is_enabled?(params = {}, context = nil)
+        return false unless params.is_a?(Hash) && params.has_key?('ips')
+        return false unless params.fetch('ips', nil).is_a? String
+        return false unless context.class.name == 'Unleash::Context'
+
+        params['ips'].split(',').map(&:strip).include?( context.remote_address )
+      end
+    end
+  end
+end

data/lib/unleash/strategy/unknown.rb

@@ -0,0 +1,13 @@
+module Unleash
+  module Strategy
+    class Unknown < Base
+      def name
+        'unknown'
+      end
+
+      def is_enabled?(params = {})
+        false
+      end
+    end
+  end
+end

data/lib/unleash/strategy/user_with_id.rb

@@ -0,0 +1,18 @@
+module Unleash
+  module Strategy
+    class UserWithId < Base
+      def name
+        'userWithId'
+      end
+
+      # requires: params['userIds'], context.user_id,
+      def is_enabled?(params = {}, context = nil)
+        return false unless params.is_a?(Hash) && params.has_key?('userIds')
+        return false unless params.fetch('userIds', nil).is_a? String
+        return false unless context.class.name == 'Unleash::Context'
+
+        params['userIds'].split(",").map(&:strip).include?(context.user_id)
+      end
+    end
+  end
+end

data/lib/unleash/strategy/util.rb

@@ -0,0 +1,16 @@
+require 'murmurhash3'
+
+module Unleash
+  module Strategy
+    module Util
+      module_function
+
+      NORMALIZER = 100
+
+      # convert the two strings () into a number between 1 and 100
+      def get_normalized_number(identifier, group_id)
+        MurmurHash3::V32.str_hash("#{group_id}:#{identifier}") % NORMALIZER + 1
+      end
+    end
+  end
+end

data/lib/unleash/toggle_fetcher.rb

@@ -0,0 +1,144 @@
+require 'unleash/configuration'
+require 'unleash/scheduled_executor'
+require 'net/http'
+require 'json'
+require 'thread'
+
+module Unleash
+
+  class ToggleFetcher
+    attr_accessor :toggle_cache, :toggle_lock, :toggle_resource, :etag, :retry_count
+
+    def initialize
+      self.etag = nil
+      self.toggle_cache = nil
+      self.toggle_lock = Mutex.new
+      self.toggle_resource = ConditionVariable.new
+      self.retry_count = 0
+
+      # start by fetching synchronously, and failing back to reading the backup file.
+      begin
+        fetch
+      rescue Exception => e
+        Unleash.logger.warn "ToggleFetcher was unable to fetch from the network, attempting to read from backup file."
+        read!
+        raise e
+      end
+
+      # once we have initialized, start the fetcher loop
+      scheduledExecutor = Unleash::ScheduledExecutor.new('ToggleFetcher', Unleash.configuration.refresh_interval)
+      scheduledExecutor.run { remote_toggles = fetch() }
+    end
+
+    def toggles
+      self.toggle_lock.synchronize do
+        # wait for resource, only if it is null
+        self.toggle_resource.wait(self.toggle_lock) if self.toggle_cache.nil?
+        return self.toggle_cache
+      end
+    end
+
+    # rename to refresh_from_server!  ??
+    def fetch
+      Unleash.logger.debug "fetch()"
+      Unleash.logger.debug "ETag: #{self.etag}" unless self.etag.nil?
+
+      uri = URI(Unleash.configuration.fetch_toggles_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.open_timeout = Unleash.configuration.timeout # in seconds
+      http.read_timeout = Unleash.configuration.timeout # in seconds
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request['If-None-Match'] = self.etag unless self.etag.nil?
+
+      response = http.request(request)
+
+      Unleash.logger.debug "No changes according to the unleash server, nothing to do." if response.code == '304'
+      return if response.code == '304'
+
+      raise IOError, "Unleash server returned a non 200/304 HTTP result." if response.code != '200'
+
+      self.etag = response['ETag']
+      response_hash = JSON.parse(response.body)
+
+      if response_hash['version'] == 1
+        features = response_hash['features']
+      else
+        raise NotImplemented, "Version of features provided by unleash server" \
+          " is unsupported by this client."
+      end
+
+      # always synchronize with the local cache when fetching:
+      synchronize_with_local_cache!(features)
+
+      Unleash.logger.info "Flush changes to running client variable"
+      update_client!
+
+      Unleash.logger.info "Saved to toggle cache, will save to disk now"
+      save!
+    end
+
+    private
+
+    def synchronize_with_local_cache!(features)
+      if self.toggle_cache != features
+        self.toggle_lock.synchronize do
+          self.toggle_cache = features
+        end
+
+        # notify all threads waiting for this resource to no longer wait
+        self.toggle_resource.broadcast
+      end
+    end
+
+    def update_client!
+      if Unleash.toggles != self.toggles
+        Unleash.logger.info "Updating toggles to main client, there has been a change in the server."
+        Unleash.toggles = self.toggles
+      end
+    end
+
+    def backup_file_exists?
+      File.exists?(backup_file)
+    end
+
+    def save!
+      begin
+        file = File.open(Unleash.configuration.backup_file, "w")
+
+        self.toggle_lock.synchronize do
+          file.write(self.toggle_cache.to_json)
+        end
+      rescue Exception => e
+        # This is not really the end of the world. Swallowing the exception.
+        Unleash.logger.error "Unable to save backup file."
+      ensure
+        file.close unless file.nil?
+      end
+    end
+
+    def read!
+      Unleash.logger.debug "read!()"
+      return nil unless File.exists?(Unleash.configuration.backup_file)
+
+      begin
+        file = File.open(Unleash.configuration.backup_file, "r")
+        line_cache = ""
+        file.each_line do |line|
+          line_cache += line
+        end
+
+        backup_as_hash = JSON.parse(line_cache)
+        synchronize_with_local_cache!(backup_as_hash)
+
+      rescue IOError => e
+        Unleash.logger.error "Unable to read the backup_file."
+      rescue JSON::ParserError => e
+        Unleash.logger.error "Unable to parse JSON from existing backup_file."
+      rescue Exception => e
+        Unleash.logger.error "Unable to extract valid data from backup_file."
+      ensure
+        file.close unless file.nil?
+      end
+    end
+  end
+end

data/lib/unleash/version.rb

@@ -0,0 +1,3 @@
+module Unleash
+  VERSION = "0.1.1"
+end

data/unleash-client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unleash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unleash"
+  spec.version       = Unleash::VERSION
+  spec.authors       = ["Renato Arruda"]
+  spec.email         = ["rarruda@rarruda.org"]
+  spec.licenses      = ["Apache-2.0"]
+
+  spec.summary       = %q{Unleash feature toggle client.}
+  spec.description   = %q{Unleash is a feature toggle system, that gives you a great overview
+    over all feature toggles across all your applications and services.}
+  spec.homepage      = "https://github.com/unleash/unleash-client-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "murmurhash3", "~> 0.1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: unleash
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Renato Arruda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: murmurhash3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Unleash is a feature toggle system, that gives you a great overview
+      over all feature toggles across all your applications and services.
+email:
+- rarruda@rarruda.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- examples/simple.rb
+- lib/unleash.rb
+- lib/unleash/activation_strategy.rb
+- lib/unleash/client.rb
+- lib/unleash/configuration.rb
+- lib/unleash/context.rb
+- lib/unleash/feature_toggle.rb
+- lib/unleash/metrics.rb
+- lib/unleash/metrics_reporter.rb
+- lib/unleash/scheduled_executor.rb
+- lib/unleash/strategy/application_hostname.rb
+- lib/unleash/strategy/base.rb
+- lib/unleash/strategy/default.rb
+- lib/unleash/strategy/gradual_rollout_random.rb
+- lib/unleash/strategy/gradual_rollout_sessionid.rb
+- lib/unleash/strategy/gradual_rollout_userid.rb
+- lib/unleash/strategy/remote_address.rb
+- lib/unleash/strategy/unknown.rb
+- lib/unleash/strategy/user_with_id.rb
+- lib/unleash/strategy/util.rb
+- lib/unleash/toggle_fetcher.rb
+- lib/unleash/version.rb
+- unleash-client.gemspec
+homepage: https://github.com/unleash/unleash-client-ruby
+licenses:
+- Apache-2.0
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Unleash feature toggle client.
+test_files: []