unleash 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a663c0d8983975b2c2488dd98d415e1a48e476d8
-  data.tar.gz: 2d8c0f1f01682d649cd263c6a42f0cf4fa31829c
+SHA256:
+  metadata.gz: 3e17e0aeb7e67031de9d1088f574059c27e897f7a4d1e14106274f4b2aed5b14
+  data.tar.gz: c12cf65f061e004f8b040b4bffa09c1515d432d678ed8e12d4baabf5ef36ba5c
 SHA512:
-  metadata.gz: 1d865e04c9b67fc9eceb20036590d2e6260299a878e8e84ec762cbde7cc1262ee2792ede6c5f2b8ac4ac1990af3d33f756a0512dc4bae65db7fb3bea433581ee
-  data.tar.gz: 51bcb1800b7ae75289d6f2676e5d57152f8e0fb0f458cd63255aaae835b9998b53cbe1a5147f1d4272666c928be59456c45cfcbb81ae6385160f8dd5196a63b3
+  metadata.gz: d76a97471f879db4a8458f916833923e31e6ea2b671d5d9421122bf54275ca27183ee18b064eae61e7a406b268d6a4c58cdc8ac2b617f00d67dc7c2015c0ceff
+  data.tar.gz: ed965bd8bb3c3d561e7eb93a0c44f91f9186fddb7b2932da025bc571ffdf3a4d9691a41a112375df51a01f19a22b81c4c1b849eccf00ba6ed5baed45020c6393

data/.travis.yml

@@ -1,5 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - jruby
 before_install: gem install bundler -v 1.14.6

data/README.md

@@ -1,5 +1,8 @@
 # Unleash::Client
 
+[![Build Status](https://travis-ci.org/Unleash/unleash-client-ruby.svg?branch=master)](https://travis-ci.org/Unleash/unleash-client-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-client-ruby/badge.svg?branch=master)](https://coveralls.io/github/Unleash/unleash-client-ruby?branch=master)
+
 Unleash client so you can roll out your features with confidence.
 
 Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful feature toggling in your ruby/rails applications.
@@ -9,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.0'
+gem 'unleash', '~> 0.1.1'
 ```
 
 And then execute:
@@ -22,15 +25,15 @@ Or install it yourself as:
 
 ## Configure
 
-It is **required** to configure the `hostname` of the unleash server.
+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 **highly recommended** to configure `app_name` and the `instance_id`.
 
 For other options please see `lib/unleash/configuration.rb`.
 
 ```ruby
-Unleash::Client.configure do |config|
-  config.hostname = 'host.domain'
+Unleash.configure do |config|
+  config.url      = 'http://unleash.herokuapp.com/api'
   config.app_name = 'my_ruby_app'
 end
 ```
@@ -38,7 +41,7 @@ end
 or instantiate the client with the valid configuration:
 
 ```ruby
-UNLEASH = Unleash::Client.new(hostname: 'host.domain', app_name: 'my_ruby_app')
+UNLEASH = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app')
 ```
 
 ## Usage in a plain Ruby Application
@@ -47,7 +50,7 @@ UNLEASH = Unleash::Client.new(hostname: 'host.domain', app_name: 'my_ruby_app')
 require 'unleash'
 require 'unleash/context'
 
-@unleash = Unleash::Client.new(hostname: 'host.domain', app_name: 'my_ruby_app')
+@unleash = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app')
 
 feature_name = "AwesomeFeature"
 unleash_context = Unleash::Context.new
@@ -62,22 +65,41 @@ end
 
 ## Usage in a Rails Application
 
-Note: known to not work currently with [puma](https://github.com/puma/puma).
-
 #### Add Initializer
 
 Put in `config/initializers/unleash.rb`:
 
 ```ruby
-Unleash::Client.configure do |config|
-  config.hostname = 'host.domain'
-  config.app_name = Rails.application.class.parent
+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}"
 end
+
+UNLEASH = Unleash::Client.new
 ```
 For `config.instance_id` use a string with a unique identification for the running instance. For example: it could be the hostname, if you only run one App per host. Or the docker container id, if you are running in docker. If it is not set the client will generate an unique UUID for each execution.
 
 
+#### Add Initializer if using [Puma](https://github.com/puma/puma)
+
+In `puma.rb` ensure that the unleash client is configured and instantiated as below, inside the `on_worker_boot` code block:
+
+```ruby
+on_worker_boot do
+  # ...
+
+  Unleash.configure do |config|
+    config.url      = 'http://unleash.herokuapp.com/api'
+    config.app_name = Rails.application.class.parent.to_s
+  end
+  Rails.configuration.unleash = Unleash::Client.new
+end
+```
+
+Instead of the configuration in `config/initializers/unleash.rb`.
+
+
 #### Set Unleash::Context
 
 Be sure to add the following method and callback in the application controller to have `@unleash_context` set for all requests:
@@ -97,13 +119,23 @@ Add in `app/controllers/application_controller.rb`:
   end
 ```
 
+Or if you see better fit, only in the controllers that you will be using unleash.
+
 #### Sample usage
 
 Then wherever in your application that you need a feature toggle, you can use:
 
 ```ruby
 if UNLEASH.is_enabled? "AwesomeFeature", @unleash_context
-  puts "enabled"
+  puts "AwesomeFeature is enabled"
+end
+```
+
+or if client is set in `Rails.configuration.unleash`:
+
+```ruby
+if Rails.configuration.unleash.is_enabled? "AwesomeFeature", @unleash_context
+  puts "AwesomeFeature is enabled"
 end
 ```
 
@@ -115,7 +147,7 @@ bundle exec examples/simple.rb
 
 ## Available Strategies
 
-This client comes with these strategies out of the box:
+This client comes with the all the required strategies out of the box:
 
  * ApplicationHostnameStrategy
  * DefaultStrategy
@@ -133,7 +165,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) for known limitations, and feature roadmap.
 
 
 ## Contributing

data/TODO.md

@@ -6,7 +6,6 @@ The Ruby client should be pretty stable now. But no warranty is given, and some
 
 Implement:
 ----------
- * Support for allowing custom strategies.
  * Possibility for custom HTTP headers when interacting with unleash server.
 
 To test: (and write tests for)
@@ -34,4 +33,5 @@ DONE:
  * Configurable Logging (logger + level)
  * Switch hashing function to use murmurhash3 as per https://github.com/Unleash/unleash/issues/247
  * Document usage with Rails
+ * Support for allowing custom strategies.
 

data/lib/unleash.rb

@@ -1,12 +1,24 @@
 require 'unleash/version'
 require 'unleash/configuration'
+require 'unleash/strategy/base'
 require 'unleash/context'
 require 'unleash/client'
 require 'logger'
 
+Gem.find_files('unleash/strategy/**/*.rb').each { |path| require path }
+
 module Unleash
   TIME_RESOLUTION = 3
 
+  STRATEGIES = Unleash::Strategy.constants
+    .select { |c| Unleash::Strategy.const_get(c).is_a? Class }
+    .map { |c|
+      lowered_c = c.to_s
+      lowered_c[0] = lowered_c[0].downcase
+      [lowered_c.to_sym, Object::const_get("Unleash::Strategy::#{c}").new]
+    }
+    .to_h
+
   class << self
     attr_accessor :configuration, :toggle_fetcher, :toggles, :toggle_metrics, :reporter, :logger
   end

data/lib/unleash/activation_strategy.rb

@@ -9,7 +9,7 @@ module Unleash
       if params.is_a?(Hash)
         self.params = params
       else
-        Unleash.logger.warning "Invalid params provided for ActivationStrategy #{params}"
+        Unleash.logger.warn "Invalid params provided for ActivationStrategy #{params}"
         self.params = {}
       end
     end

data/lib/unleash/configuration.rb

@@ -53,7 +53,7 @@ module Unleash
     end
 
     def fetch_toggles_url
-      self.url + '/features'
+      self.url + '/client/features'
     end
 
     def client_metrics_url

data/lib/unleash/feature_toggle.rb

@@ -1,27 +1,6 @@
 require 'unleash/activation_strategy'
-require 'unleash/strategy/base'
-require 'unleash/strategy/default'
-require 'unleash/strategy/application_hostname'
-require 'unleash/strategy/gradual_rollout_random'
-require 'unleash/strategy/gradual_rollout_sessionid'
-require 'unleash/strategy/gradual_rollout_userid'
-require 'unleash/strategy/remote_address'
-require 'unleash/strategy/user_with_id'
-require 'unleash/strategy/unknown'
 
 module Unleash
-  STRATEGIES = {
-    applicationHostname: Unleash::Strategy::ApplicationHostname.new,
-    gradualRolloutRandom: Unleash::Strategy::GradualRolloutRandom.new,
-    gradualRolloutSessionId: Unleash::Strategy::GradualRolloutSessionId.new,
-    gradualRolloutUserId: Unleash::Strategy::GradualRolloutUserId.new,
-    remoteAddress: Unleash::Strategy::RemoteAddress.new,
-    userWithId: Unleash::Strategy::UserWithId.new,
-    unknown: Unleash::Strategy::Unknown.new,
-    default: Unleash::Strategy::Default.new,
-  }
-
-
   class FeatureToggle
     attr_accessor :name, :enabled, :strategies, :choices, :choices_lock
 

data/lib/unleash/version.rb

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

data/unleash-client.gemspec

@@ -21,10 +21,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = "~> 2.2"
 
   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"
+  spec.add_development_dependency "coveralls"
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: |-
   Unleash is a feature toggle system, that gives you a great overview
       over all feature toggles across all your applications and services.
@@ -118,9 +132,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -128,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Unleash feature toggle client.