unleash 4.2.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c185b4a8d20c33f221a482a9f2b58fbf028c019513a89b528a491f738ec1308b
-  data.tar.gz: 8283a887720d6c8f9a72719a8ff4ff800fd88f3941d5f7d5cea83e4ea079a414
+  metadata.gz: f05a01bdf6013184b6948fb5c38f6b1da1cde9d18f9a0eeecd69b54cbed8ff18
+  data.tar.gz: 6343830fd945d00decd331acade205d605e0d496ed1d4afd4736affcb2f538ca
 SHA512:
-  metadata.gz: 614df5b819537826bc575a1b6b061ca17561d2108c12e9b32581e458f37ca24beccc83046b1b59c9be0d2f2904087b92f6410f3d31bfa57b176228611a55d96e
-  data.tar.gz: 35528c4f4f5d39db50c13c7266ac620dec6cdb21154b6f0736dea2946e22b81270737d9085144894d7c1b96c858364ce44f5f948ba24f731e2f033ee0677d67c
+  metadata.gz: 1ac4a4b89f787b5ae27acda02865def0eb68f261da10b83c01a6b34f6706b1b29443375eb82418b9834db555fbe54c1a1dfe49e9bf4c761556145edce88f76c9
+  data.tar.gz: c7a2332c7e6ab54872b08432af4c5c2cf092b7586664eb0267e45e416fb9a72c46246dd6cdedf68b4a9421678e4cb9f9507365e40fc5c2113b9fba8e703a19dd

data/.github/workflows/add-to-project.yml

@@ -0,0 +1,14 @@
+name: Add new item to project board
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+      uses: unleash/.github/.github/workflows/add-item-to-project.yml@main
+      secrets: inherit

data/.github/workflows/pull_request.yml

@@ -5,8 +5,21 @@ on:
   pull_request:
 
 jobs:
-  test:
+  lint:
+    name: RuboCop
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "2.7"
+        bundler-cache: true
+    - name: Run RuboCop
+      run: bundle exec rubocop
 
+  test:
     runs-on: ${{ matrix.os }}-latest
 
     strategy:
@@ -18,7 +31,7 @@ jobs:
           - jruby-9.2
           - jruby-9.3
           - 3.1
-          - 3.0
+          - '3.0'
           - 2.7
           - 2.6
           - 2.5
@@ -34,13 +47,6 @@ jobs:
         run: bundle install
       - name: Download test cases
         run: git clone --depth 5 --branch v4.1.0 https://github.com/Unleash/client-specification.git client-specification
-      - name: rubocop
-        uses: reviewdog/action-rubocop@v2
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          rubocop_version: gemfile
-          rubocop_extensions: rubocop-rspec:gemfile
-          reporter: github-pr-review # Default is github-pr-check
       - name: Run tests
         run: bundle exec rake
         env:

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -14,6 +13,7 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock
 
 # Clone of the client-specification
 /client-specification/

data/README.md

@@ -41,7 +41,7 @@ It is **required** to configure:
 - `app_name` with the name of the runninng application.
 - `custom_http_headers` with `{'Authorization': '<API token>'}` when using Unleash v4.0.0 and later.
 
-Please substitute the example `'http://unleash.herokuapp.com/api'` for the url of your own instance.
+Please substitute the example `'https://unleash.herokuapp.com/api'` for the url of your own instance.
 
 It is **highly recommended** to configure:
 - `instance_id` parameter with a unique identifier for the running instance.
@@ -50,7 +50,7 @@ It is **highly recommended** to configure:
 ```ruby
 Unleash.configure do |config|
   config.app_name            = 'my_ruby_app'
-  config.url                 = 'http://unleash.herokuapp.com/api'
+  config.url                 = 'https://unleash.herokuapp.com/api'
   config.custom_http_headers = {'Authorization': '<API token>'}
 end
 ```
@@ -58,7 +58,23 @@ end
 or instantiate the client with the valid configuration:
 
 ```ruby
-UNLEASH = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app', custom_http_headers: {'Authorization': '<API token>'})
+UNLEASH = Unleash::Client.new(url: 'https://unleash.herokuapp.com/api', app_name: 'my_ruby_app', custom_http_headers: {'Authorization': '<API token>'})
+```
+
+## Dynamic custom HTTP headers
+If you need custom HTTP headers that change during the lifetime of the client, the `custom_http_headers` can be given as a `Proc`.
+
+```ruby
+Unleash.configure do |config|
+  config.app_name            = 'my_ruby_app'
+  config.url                 = 'https://unleash.herokuapp.com/api'
+  config.custom_http_headers =  proc do
+    {
+      'Authorization': '<API token>',
+      'X-Client-Request-Time': Time.now.iso8601
+    }
+  end
+end
 ```
 
 #### List of Arguments
@@ -74,7 +90,7 @@ Argument | Description | Required? |  Type |  Default Value|
 `metrics_interval` | How often the unleash client should send metrics to server. | N | Integer | 60 |
 `disable_client` | Disables all communication with the Unleash server, effectively taking it *offline*. 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 | `false` |
 `disable_metrics` | Disables sending metrics to Unleash server. | N | Boolean | `false` |
-`custom_http_headers` | Custom headers to send to Unleash. As of Unleash v4.0.0, the `Authorization` header is required. For example: `{'Authorization': '<API token>'}` | N | Hash | {} |
+`custom_http_headers` | Custom headers to send to Unleash. As of Unleash v4.0.0, the `Authorization` header is required. For example: `{'Authorization': '<API token>'}` | N | Hash/Proc | {} |
 `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. The default is to retry indefinitely. | N | Float::INFINITY | 5 |
 `backup_file` | Filename to store the last known state from the Unleash server. Best to not change this from the default. | N | String | `Dir.tmpdir + "/unleash-#{app_name}-repo.json` |
@@ -95,7 +111,7 @@ Environment Variable | Description
 require 'unleash'
 require 'unleash/context'
 
-@unleash = Unleash::Client.new(app_name: 'my_ruby_app', url: 'http://unleash.herokuapp.com/api', custom_http_headers: { 'Authorization': '<API token>' })
+@unleash = Unleash::Client.new(app_name: 'my_ruby_app', url: 'https://unleash.herokuapp.com/api', custom_http_headers: { 'Authorization': '<API token>' })
 
 feature_name = "AwesomeFeature"
 unleash_context = Unleash::Context.new
@@ -117,7 +133,7 @@ Put in `config/initializers/unleash.rb`:
 ```ruby
 Unleash.configure do |config|
   config.app_name = Rails.application.class.parent.to_s
-  config.url      = 'http://unleash.herokuapp.com/api'
+  config.url      = 'https://unleash.herokuapp.com/api'
   # config.instance_id = "#{Socket.gethostname}"
   config.logger   = Rails.logger
   config.environment = Rails.env
@@ -156,7 +172,7 @@ Then you may keep the client configuration still in `config/initializers/unleash
 Unleash.configure do |config|
   config.app_name    = Rails.application.class.parent.to_s
   config.environment = Rails.env
-  config.url                 = 'http://unleash.herokuapp.com/api'
+  config.url                 = 'https://unleash.herokuapp.com/api'
   config.custom_http_headers = {'Authorization': '<API token>'}
 end
 ```
@@ -204,7 +220,7 @@ on_worker_boot do
   ::UNLEASH = Unleash::Client.new(
     app_name: 'my_rails_app',
     environment: 'development',
-    url: 'http://unleash.herokuapp.com/api',
+    url: 'https://unleash.herokuapp.com/api',
     custom_http_headers: {'Authorization': '<API token>'},
   )
 end
@@ -230,7 +246,7 @@ PhusionPassenger.on_event(:starting_worker_process) do |forked|
       # config.instance_id = "#{Socket.gethostname}"
       config.logger      = Rails.logger
       config.environment = Rails.env
-      config.url                 = 'http://unleash.herokuapp.com/api'
+      config.url                 = 'https://unleash.herokuapp.com/api'
       config.custom_http_headers = {'Authorization': '<API token>'}
     end
 
@@ -365,11 +381,11 @@ Bootstrap configuration allows the client to be initialized with a predefined se
 Bootstrapping can be configured by providing a bootstrap configuration when initializing the client.
 ```ruby
 @unleash = Unleash::Client.new(
-    url: 'http://unleash.herokuapp.com/api',
+    url: 'https://unleash.herokuapp.com/api',
     app_name: 'my_ruby_app',
     custom_http_headers: { 'Authorization': '<API token>' },
     bootstrap_config: Unleash::Bootstrap::Configuration.new({
-        url: "http://unleash.herokuapp.com/api/client/features",
+        url: "https://unleash.herokuapp.com/api/client/features",
         url_headers: {'Authorization': '<API token>'}
     })
 )
@@ -395,7 +411,7 @@ Example usage:
 
 First saving the toggles locally:
 ```shell
-curl -H 'Authorization: <API token>' -XGET 'http://unleash.herokuapp.com/api' > ./default-toggles.json
+curl -H 'Authorization: <API token>' -XGET 'https://unleash.herokuapp.com/api' > ./default-toggles.json
 ```
 
 Now using them on start up:
@@ -408,7 +424,7 @@ custom_boostrapper = lambda {
 
 @unleash = Unleash::Client.new(
     app_name: 'my_ruby_app',
-    url: 'http://unleash.herokuapp.com/api',
+    url: 'https://unleash.herokuapp.com/api',
     custom_http_headers: { 'Authorization': '<API token>' },
     bootstrap_config: Unleash::Bootstrap::Configuration.new({
         block: custom_boostrapper

data/examples/bootstrap.rb

@@ -7,7 +7,7 @@ require 'unleash/bootstrap/configuration'
 puts ">> START bootstrap.rb"
 
 @unleash = Unleash::Client.new(
-  url: 'http://unleash.herokuapp.com/api',
+  url: 'https://unleash.herokuapp.com/api',
   custom_http_headers: { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' },
   app_name: 'bootstrap-test',
   instance_id: 'local-test-cli',

data/examples/simple.rb

@@ -6,7 +6,7 @@ require 'unleash/context'
 puts ">> START simple.rb"
 
 # Unleash.configure do |config|
-#   config.url = 'http://unleash.herokuapp.com/api'
+#   config.url = 'https://unleash.herokuapp.com/api'
 #   config.custom_http_headers = { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' }
 #   config.app_name = 'simple-test'
 #   config.refresh_interval = 2
@@ -18,7 +18,7 @@ puts ">> START simple.rb"
 # or:
 
 @unleash = Unleash::Client.new(
-  url: 'http://unleash.herokuapp.com/api',
+  url: 'https://unleash.herokuapp.com/api',
   custom_http_headers: { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' },
   app_name: 'simple-test',
   instance_id: 'local-test-cli',

data/lib/unleash/configuration.rb

@@ -23,7 +23,7 @@ module Unleash
       :bootstrap_config
 
     def initialize(opts = {})
-      ensure_valid_opts(opts)
+      validate_custom_http_headers!(opts[:custom_http_headers]) if opts.has_key?(:custom_http_headers)
       set_defaults
 
       initialize_default_logger if opts[:logger].nil?
@@ -40,7 +40,8 @@ module Unleash
       return if self.disable_client
 
       raise ArgumentError, "URL and app_name are required parameters." if self.app_name.nil? || self.url.nil?
-      raise ArgumentError, "custom_http_headers must be a hash." unless self.custom_http_headers.is_a?(Hash)
+
+      validate_custom_http_headers!(self.custom_http_headers)
     end
 
     def refresh_backup_file!
@@ -51,7 +52,7 @@ module Unleash
       {
         'UNLEASH-INSTANCEID' => self.instance_id,
         'UNLEASH-APPNAME' => self.app_name
-      }.merge(custom_http_headers.dup)
+      }.merge!(generate_custom_http_headers)
     end
 
     def fetch_toggles_uri
@@ -78,12 +79,6 @@ module Unleash
 
     private
 
-    def ensure_valid_opts(opts)
-      unless opts[:custom_http_headers].is_a?(Hash) || opts[:custom_http_headers].nil?
-        raise ArgumentError, "custom_http_headers must be a hash."
-      end
-    end
-
     def set_defaults
       self.app_name         = nil
       self.environment      = 'default'
@@ -118,6 +113,18 @@ module Unleash
       self
     end
 
+    def validate_custom_http_headers!(custom_http_headers)
+      return if custom_http_headers.is_a?(Hash) || custom_http_headers.respond_to?(:call)
+
+      raise ArgumentError, "custom_http_headers must be a Hash or a Proc."
+    end
+
+    def generate_custom_http_headers
+      return self.custom_http_headers.call if self.custom_http_headers.respond_to?(:call)
+
+      self.custom_http_headers
+    end
+
     def set_option(opt, val)
       __send__("#{opt}=", val)
     rescue NoMethodError

data/lib/unleash/toggle_fetcher.rb

@@ -65,24 +65,20 @@ module Unleash
 
     def save!
       Unleash.logger.debug "Will save toggles to disk now"
-      begin
-        backup_file = Unleash.configuration.backup_file
-        backup_file_tmp = "#{backup_file}.tmp"
 
-        self.toggle_lock.synchronize do
-          file = File.open(backup_file_tmp, "w")
+      backup_file = Unleash.configuration.backup_file
+      backup_file_tmp = "#{backup_file}.tmp"
+
+      self.toggle_lock.synchronize do
+        File.open(backup_file_tmp, "w") do |file|
           file.write(self.toggle_cache.to_json)
-          file.close
-          File.rename(backup_file_tmp, backup_file)
         end
-      rescue StandardError => e
-        # This is not really the end of the world. Swallowing the exception.
-        Unleash.logger.error "Unable to save backup file. Exception thrown #{e.class}:'#{e}'"
-        Unleash.logger.error "stacktrace: #{e.backtrace}"
-      ensure
-        file&.close if defined?(file)
-        self.toggle_lock.unlock if self.toggle_lock.locked?
+        File.rename(backup_file_tmp, backup_file)
       end
+    rescue StandardError => e
+      # This is not really the end of the world. Swallowing the exception.
+      Unleash.logger.error "Unable to save backup file. Exception thrown #{e.class}:'#{e}'"
+      Unleash.logger.error "stacktrace: #{e.backtrace}"
     end
 
     private
@@ -110,22 +106,15 @@ module Unleash
       backup_file = Unleash.configuration.backup_file
       return nil unless File.exist?(backup_file)
 
-      begin
-        file = File.new(backup_file, "r")
-        file_content = file.read
-
-        backup_as_hash = JSON.parse(file_content)
-        synchronize_with_local_cache!(backup_as_hash)
-        update_running_client!
-      rescue IOError => e
-        Unleash.logger.error "Unable to read the backup_file: #{e}"
-      rescue JSON::ParserError => e
-        Unleash.logger.error "Unable to parse JSON from existing backup_file: #{e}"
-      rescue StandardError => e
-        Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown: #{e}"
-      ensure
-        file&.close
-      end
+      backup_as_hash = JSON.parse(File.read(backup_file))
+      synchronize_with_local_cache!(backup_as_hash)
+      update_running_client!
+    rescue IOError => e
+      Unleash.logger.error "Unable to read the backup_file: #{e}"
+    rescue JSON::ParserError => e
+      Unleash.logger.error "Unable to parse JSON from existing backup_file: #{e}"
+    rescue StandardError => e
+      Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown: #{e}"
     end
 
     def bootstrap

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "4.2.1".freeze
+  VERSION = "4.3.0".freeze
 end

data/unleash-client.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-json_expectations", "~> 2.2"
   spec.add_development_dependency "webmock", "~> 3.8"
 
-  spec.add_development_dependency "rubocop", "~> 0.80"
+  spec.add_development_dependency "rubocop", "< 1.0.0"
   spec.add_development_dependency "simplecov", "~> 0.21.2"
   spec.add_development_dependency "simplecov-lcov", "~> 0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -98,16 +98,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +146,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/add-to-project.yml"
 - ".github/workflows/pull_request.yml"
 - ".gitignore"
 - ".rspec"