unleash 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8abfb2ccb4ad16fa7842a94c42c715bc28e2b61e9e9ce4b7875a8ad92f47a696
-  data.tar.gz: 59708b33a865480b75f7ffac3e153f32e7a2c19a0ad8338b0ef3872feaf57e8a
+  metadata.gz: 7d8661e45cf753ab1c4ffdda0c4445657237cf0dafb26c1f701e258a3fe8c28f
+  data.tar.gz: 440ddb7d149983453cbda346264e12510fb97a3372ac99bcb5e5e8d60e25df7d
 SHA512:
-  metadata.gz: 47562d77f0847992c11e3b9f6a504bddc3eb057c62c9bd41f229bd9ddd73d9437f5736f9125790e5b6e9d10d2e6be7f383dee57a6bd33c13c42e58d8837931f7
-  data.tar.gz: 3e081ffa547d95dca4e08030d21b7948ac5bf6d6af81fda91d37c2b328cd84a56f091ad3a83329bb5f86d5caf30e4befdb9d07eb3622e7439d2d5141df79718a
+  metadata.gz: d913c18a4dc0894b19a6281dfb6112891bcb296725afd75aa84172fc7849b36c87962f55151094820d0951c0ea5ec2dd4c8e0e9ce946cc99e2747c9b41e94472
+  data.tar.gz: bcd865ead7231ea7dbc24b3318498ccbddaab5a7032375c8d25f603952b094141126ebae8e0cf668e74d7ba9e6c73be27f083175211529714967e941d0744521

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Clone of the client-specification
+/client-specification/

data/.travis.yml

@@ -1,9 +1,12 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
   - jruby
-before_install: gem install bundler -v 1.14.6
+before_install:
+  - gem install bundler -v 2.0.1
+  # install client spec from official repository:
+  - git clone --depth 5 https://github.com/Unleash/client-specification.git client-specification

data/README.md

@@ -12,7 +12,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 0.1.4'
+gem 'unleash', '~> 0.1.5'
 ```
 
 And then execute:
@@ -25,16 +25,15 @@ Or install it yourself as:
 
 ## Configure
 
-It is **required** to configure the `url` of the unleash server. Please substitute the sample `'http://unleash.herokuapp.com/api'` for the url of your own instance.
+It is **required** to configure the `url` of the unleash server and `app_name` with the name of the runninng application. Please substitute the sample `'http://unleash.herokuapp.com/api'` for the url of your own instance.
 
-It is **highly recommended** to configure `app_name` and the `instance_id`.
+It is **highly recommended** to configure the `instance_id` parameter as well.
 
-For other options please see `lib/unleash/configuration.rb`.
 
 ```ruby
 Unleash.configure do |config|
-  config.url      = 'http://unleash.herokuapp.com/api'
-  config.app_name = 'my_ruby_app'
+  config.url         = 'http://unleash.herokuapp.com/api'
+  config.app_name    = 'my_ruby_app'
 end
 ```
 
@@ -44,6 +43,27 @@ or instantiate the client with the valid configuration:
 UNLEASH = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app')
 ```
 
+#### List of Arguments
+
+Argument | Description | Required? |  Type |  Default Value|
+---------|-------------|-----------|-------|---------------|
+`url`      | Unleash server URL. | Y | String | N/A |
+`app_name` | Name of your program. | Y | String | N/A |
+`instance_id` | Identifier for the running instance of program. Important so you can trace back to where metrics are being collected from. **Highly recommended be be set.** | N | String | random UUID |
+`refresh_interval` | How often the unleash client should check with the server for configuration changes. | N | Integer |  15 |
+`metrics_interval` | How often the unleash client should send metrics to server. | N | Integer | 10 |
+`disable_client` | Disables all communication with the Unleash server. If set, `is_enabled?` will always answer with the `default_value` and configuration validation is skipped. Defeats the entire purpose of using unleash, but can be useful in when running tests. | N | Boolean | F |
+`disable_metrics` | Disables sending metrics to Unleash server. | N | Boolean | F |
+`custom_http_headers` | Custom headers to send to Unleash. | N | Hash | {} |
+`timeout` | How long to wait for the connection to be established or wait in reading state (open_timeout/read_timeout) | N | Integer | 30 |
+`retry_limit` | How many consecutive failures in connecting to the Unleash server are allowed before giving up. | N | Integer | 1 |
+`backup_file` | Filename to store the last known state from the Unleash server. Best to not change this from the default. | N | `Dir.tmpdir + "/unleash-#{app_name}-repo.json` |
+`logger` | Specify a custom `Logger` class to handle logs from the client. | N | `Logger.new(STDOUT)` |
+`log_level` | Change the log level for the `Logger` class. | N | `Logger::ERROR` |
+
+For in a more in depth look, please see `lib/unleash/configuration.rb`.
+
+
 ## Usage in a plain Ruby Application
 
 ```ruby
@@ -74,6 +94,7 @@ Unleash.configure do |config|
   config.url      = 'http://unleash.herokuapp.com/api'
   config.app_name = Rails.application.class.parent.to_s
   # config.instance_id = "#{Socket.gethostname}"
+  config.logger   = Rails.logger
 end
 
 UNLEASH = Unleash::Client.new
@@ -139,6 +160,14 @@ if Rails.configuration.unleash.is_enabled? "AwesomeFeature", @unleash_context
 end
 ```
 
+If the feature is not found in the server, it will by default return false. However you can override that by setting the default return value to `true`:
+
+```ruby
+if UNLEASH.is_enabled? "AwesomeFeature", @unleash_context, true
+  puts "AwesomeFeature is enabled by default"
+end
+```
+
 ## Local test client
 
 ```
@@ -155,7 +184,7 @@ This client comes with the all the required strategies out of the box:
  * GradualRolloutSessionIdStrategy
  * GradualRolloutUserIdStrategy
  * RemoteAddressStrategy
- * UnknowndStrategy
+ * UnknownStrategy
  * UserWithIdStrategy
 
 
@@ -165,7 +194,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
-See (TODO.md) for known limitations, and feature roadmap.
+See [TODO.md](TODO.md) for known limitations, and feature roadmap.
 
 
 ## Contributing

data/TODO.md

@@ -6,13 +6,10 @@ The Ruby client should be pretty stable now. But no warranty is given, and some
 
 Implement:
 ----------
- * Possibility for custom HTTP headers when interacting with unleash server.
+ * Document writing of custom strategies.
 
 To test: (and write tests for)
 --------
- * Implement spec test for ruby client specs using https://github.com/Unleash/client-specification/blob/master/05-gradual-rollout-random-strategy.json (similar to the examples below) to ensure consistent client behaviour.
-   * java: https://github.com/Unleash/unleash-client-java/compare/master...integration-spec
-   * node: https://github.com/Unleash/unleash-client-node/compare/client-specification?expand=1
  * MetricsReporter
  * everything else :)
 
@@ -34,4 +31,7 @@ DONE:
  * Switch hashing function to use murmurhash3 as per https://github.com/Unleash/unleash/issues/247
  * Document usage with Rails
  * Support for allowing custom strategies.
-
+ * Possibility for custom HTTP headers when interacting with unleash server.
+ * Implement spec test for ruby client specs using https://github.com/Unleash/client-specification/blob/master/05-gradual-rollout-random-strategy.json (similar to the examples below) to ensure consistent client behaviour.
+   * java: https://github.com/Unleash/unleash-client-java/compare/master...integration-spec
+   * node: https://github.com/Unleash/unleash-client-node/compare/client-specification?expand=1

data/lib/unleash/client.rb

@@ -15,22 +15,31 @@ module Unleash
       Unleash.logger = Unleash.configuration.logger
       Unleash.logger.level = Unleash.configuration.log_level
 
-      Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
-      register
-
-      unless Unleash.configuration.disable_metrics
-        Unleash.toggle_metrics = Unleash::Metrics.new
-        Unleash.reporter = Unleash::MetricsReporter.new
-        scheduledExecutor = Unleash::ScheduledExecutor.new('MetricsReporter', Unleash.configuration.metrics_interval)
-        scheduledExecutor.run do
-          Unleash.reporter.send
+      unless Unleash.configuration.disable_client
+        Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
+        register
+
+        unless Unleash.configuration.disable_metrics
+          Unleash.toggle_metrics = Unleash::Metrics.new
+          Unleash.reporter = Unleash::MetricsReporter.new
+          scheduledExecutor = Unleash::ScheduledExecutor.new('MetricsReporter', Unleash.configuration.metrics_interval)
+          scheduledExecutor.run do
+            Unleash.reporter.send
+          end
         end
+      else
+        Unleash.logger.warn "Unleash::Client is disabled! Will only return default results!"
       end
     end
 
     def is_enabled?(feature, context = nil, default_value = false)
         Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} with context #{context}"
 
+        if Unleash.configuration.disable_client
+          Unleash.logger.warn "unleash_client is disabled! Always returning #{default_value} for feature #{feature}!"
+          return default_value
+        end
+
         toggle_as_hash = Unleash.toggles.select{ |toggle| toggle['name'] == feature }.first if Unleash.toggles
 
         if toggle_as_hash.nil?

data/lib/unleash/configuration.rb

@@ -5,6 +5,7 @@ module Unleash
   class Configuration
     attr_accessor :url, :app_name, :instance_id,
       :custom_http_headers,
+      :disable_client,
       :disable_metrics, :timeout, :retry_limit,
       :refresh_interval, :metrics_interval,
       :backup_file, :logger, :log_level
@@ -19,6 +20,7 @@ module Unleash
       else
         raise ArgumentError, "custom_http_headers must be a hash."
       end
+      self.disable_client   = opts[:disable_client]   || false
       self.disable_metrics  = opts[:disable_metrics]  || false
       self.refresh_interval = opts[:refresh_interval] || 15
       self.metrics_interval = opts[:metrics_interval] || 10
@@ -28,7 +30,7 @@ module Unleash
       self.backup_file   = opts[:backup_file] || nil
 
       self.logger    = opts[:logger] || Logger.new(STDOUT)
-      self.log_level = opts[:log_level] || Logger::ERROR
+      self.log_level = opts[:log_level] || Logger::WARN
 
 
       if opts[:logger].nil?
@@ -47,6 +49,8 @@ module Unleash
     end
 
     def validate!
+      return if self.disable_client
+
       if self.app_name.nil? or self.url.nil?
         raise ArgumentError, "URL and app_name are required parameters."
       end

data/lib/unleash/context.rb

@@ -5,14 +5,35 @@ module Unleash
 
     def initialize(params = {})
       params_is_a_hash = params.is_a?(Hash)
-      self.user_id    = params_is_a_hash ? params.fetch(:user_id, '') : ''
-      self.session_id = params_is_a_hash ? params.fetch(:session_id, '') : ''
-      self.remote_address = params_is_a_hash ? params.fetch(:remote_address, '') : ''
-      self.properties = params_is_a_hash && params[:properties].is_a?(Hash) ? params.fetch(:properties, {}) : {}
+      self.user_id    = fetch(params, 'userId')
+      self.session_id = fetch(params, 'sessionId')
+      self.remote_address = fetch(params, 'remoteAddress')
+      self.properties =
+        if params_is_a_hash && ( params.fetch(:properties, nil) || params.fetch('properties', nil) ).is_a?(Hash)
+          fetch(params, 'properties', {})
+        else
+          {}
+        end
     end
 
     def to_s
       "<Context: user_id=#{self.user_id},session_id=#{self.session_id},remote_address=#{self.remote_address},properties=#{self.properties}>"
     end
+
+    private
+    # Fetch key from hash. Try first with using camelCase, and if not found, try with snake case.
+    # This way we are are idiomatically compliant with ruby, but still giving priority to the same
+    # key names as in the other clients.
+    def fetch(params, camelcase_key, default_ret = '')
+      return default_ret unless params.is_a?(Hash)
+      return default_ret unless camelcase_key.is_a?(String) or camelcase_key.is_a?(Symbol)
+
+      params.fetch(camelcase_key, nil) || params.fetch(snake_sym(camelcase_key), nil) || default_ret
+    end
+
+    # transform CamelCase to snake_case and make it a sym, if it is a string
+    def snake_sym(key)
+      key.is_a?(String) ? key.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym  : key
+    end
   end
-end
+end

data/lib/unleash/feature_toggle.rb

@@ -5,10 +5,12 @@ module Unleash
     attr_accessor :name, :enabled, :strategies, :choices, :choices_lock
 
     def initialize(params={})
-      self.name = params['name'] || nil
-      self.enabled = params['enabled'] || false
+      params = {} if params.nil?
 
-      self.strategies = params['strategies']
+      self.name = params.fetch('name', nil)
+      self.enabled = params.fetch('enabled', false)
+
+      self.strategies = params.fetch('strategies', [])
         .select{|s| ( s.key?('name') && Unleash::STRATEGIES.key?(s['name'].to_sym) ) }
         .map{|s| ActivationStrategy.new(s['name'], s['parameters'])} || []
 
@@ -26,12 +28,12 @@ module Unleash
         context = nil
       end
 
-      result = self.enabled && self.strategies.select{ |s|
+      result = self.enabled && ( self.strategies.select{ |s|
         strategy = Unleash::STRATEGIES.fetch(s.name.to_sym, :unknown)
         r = strategy.is_enabled?(s.params, context)
         Unleash.logger.debug "Strategy #{s.name} returned #{r} with context: #{context}" #"for params #{s.params} "
         r
-      }.any?
+      }.any? || self.strategies.empty? )
       result ||= default_result
 
       Unleash.logger.debug "FeatureToggle (enabled:#{self.enabled} default_result:#{default_result} and Strategies combined returned #{result})"

data/lib/unleash/scheduled_executor.rb

@@ -28,8 +28,12 @@ module Unleash
             Unleash.logger.error "stacktrace: #{e.backtrace}"
           end
 
-          break if self.retry_count > self.max_exceptions
+          if self.retry_count > self.max_exceptions
+            Unleash.logger.info "thread #{name} retry_count (#{self.retry_count}) exceeded max_exceptions (#{self.max_exceptions}). Stopping with retries."
+            break
+          end
         end
+        Unleash.logger.info "thread #{name} ended"
       end
     end
   end

data/lib/unleash/strategy/gradual_rollout_sessionid.rb

@@ -11,6 +11,7 @@ module Unleash
       def is_enabled?(params = {}, context)
         return false unless params.is_a?(Hash) && params.has_key?('percentage')
         return false unless context.class.name == 'Unleash::Context'
+        return false if context.session_id.empty?
 
         percentage = Integer(params['percentage'] || 0)
         (percentage > 0 && Util.get_normalized_number(context.session_id, params['groupId'] || "") <= percentage)

data/lib/unleash/strategy/gradual_rollout_userid.rb

@@ -11,6 +11,7 @@ module Unleash
       def is_enabled?(params = {}, context)
         return false unless params.is_a?(Hash) && params.has_key?('percentage')
         return false unless context.class.name == 'Unleash::Context'
+        return false if context.user_id.empty?
 
         percentage = Integer(params['percentage'] || 0)
         (percentage > 0 && Util.get_normalized_number(context.user_id, params['groupId'] || "") <= percentage)

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/unleash-client.gemspec

@@ -11,8 +11,9 @@ Gem::Specification.new do |spec|
   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.description   = %q{This is the ruby client for Unleash, a powerful 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|
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "murmurhash3", "~> 0.1.6"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,8 +95,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |-
-  Unleash is a feature toggle system, that gives you a great overview
-      over all feature toggles across all your applications and services.
+  This is the ruby client for Unleash, a powerful feature toggle system
+      that gives you a great overview over all feature toggles across all your applications and services.
 email:
 - rarruda@rarruda.org
 executables: []