unleash 3.2.2 → 4.3.0

data/lib/unleash/toggle_fetcher.rb

@@ -1,4 +1,5 @@
 require 'unleash/configuration'
+require 'unleash/bootstrap/handler'
 require 'net/http'
 require 'json'
 
@@ -13,10 +14,15 @@ module Unleash
       self.toggle_resource = ConditionVariable.new
       self.retry_count = 0
 
-      # start by fetching synchronously, and failing back to reading the backup file.
       begin
-        fetch
+        # if bootstrap configuration is available, initialize. An immediate API read is also triggered
+        if Unleash.configuration.use_bootstrap?
+          bootstrap
+        else
+          fetch
+        end
       rescue StandardError => e
+        # fail back to reading the backup file
         Unleash.logger.warn "ToggleFetcher was unable to fetch from the network, attempting to read from backup file."
         Unleash.logger.debug "Exception Caught: #{e}"
         read!
@@ -36,7 +42,9 @@ module Unleash
     # rename to refresh_from_server!  ??
     def fetch
       Unleash.logger.debug "fetch()"
-      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_url, etag)
+      return if Unleash.configuration.disable_client
+
+      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_uri, etag)
 
       if response.code == '304'
         Unleash.logger.debug "No changes according to the unleash server, nothing to do."
@@ -46,14 +54,7 @@ module Unleash
       end
 
       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
+      features = get_features(response.body)
 
       # always synchronize with the local cache when fetching:
       synchronize_with_local_cache!(features)
@@ -64,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
@@ -106,24 +103,36 @@ module Unleash
 
     def read!
       Unleash.logger.debug "read!()"
-      return nil unless File.exist?(Unleash.configuration.backup_file)
+      backup_file = Unleash.configuration.backup_file
+      return nil unless File.exist?(backup_file)
 
-      begin
-        file = File.new(Unleash.configuration.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
+      bootstrap_payload = Unleash::Bootstrap::Handler.new(Unleash.configuration.bootstrap_config).retrieve_toggles
+      synchronize_with_local_cache! get_features bootstrap_payload
+      update_running_client!
+
+      # reset Unleash.configuration.bootstrap_data to free up memory, as we will never use it again
+      Unleash.configuration.bootstrap_config = nil
+    end
+
+    # @param response_body [String]
+    def get_features(response_body)
+      response_hash = JSON.parse(response_body)
+      return response_hash['features'] if response_hash['version'] >= 1
+
+      raise NotImplemented, "Version of features provided by unleash server" \
+        " is unsupported by this client."
     end
   end
 end

data/lib/unleash/util/http.rb

@@ -4,17 +4,15 @@ require 'uri'
 module Unleash
   module Util
     module Http
-      def self.get(url, etag = nil)
-        uri = URI(url)
+      def self.get(uri, etag = nil, headers_override = nil)
         http = http_connection(uri)
 
-        request = Net::HTTP::Get.new(uri.request_uri, http_headers(etag))
+        request = Net::HTTP::Get.new(uri.request_uri, http_headers(etag, headers_override))
 
         http.request(request)
       end
 
-      def self.post(url, body)
-        uri = URI(url)
+      def self.post(uri, body)
         http = http_connection(uri)
 
         request = Net::HTTP::Post.new(uri.request_uri, http_headers)
@@ -32,10 +30,13 @@ module Unleash
         http
       end
 
-      def self.http_headers(etag = nil)
+      # @param etag [String, nil]
+      # @param headers_override [Hash, nil]
+      def self.http_headers(etag = nil, headers_override = nil)
         Unleash.logger.debug "ETag: #{etag}" unless etag.nil?
 
         headers = (Unleash.configuration.http_headers || {}).dup
+        headers = headers_override if headers_override.is_a?(Hash)
         headers['Content-Type'] = 'application/json'
         headers['If-None-Match'] = etag unless etag.nil?
 

data/lib/unleash/variant_definition.rb

@@ -2,13 +2,13 @@ require 'unleash/variant_override'
 
 module Unleash
   class VariantDefinition
-    attr_accessor :name, :weight, :payload, :overrides
+    attr_accessor :name, :weight, :payload, :overrides, :stickiness
 
-    def initialize(name, weight = 0, payload = nil, overrides = [])
+    def initialize(name, weight = 0, payload = nil, stickiness = nil, overrides = [])
       self.name = name
       self.weight = weight
       self.payload = payload
-      # self.overrides = overrides
+      self.stickiness = stickiness
       self.overrides = (overrides || [])
         .select{ |v| v.is_a?(Hash) && v.has_key?('contextName') }
         .map{ |v| VariantOverride.new(v.fetch('contextName', ''), v.fetch('values', [])) } || []
@@ -19,7 +19,8 @@ module Unleash
     end
 
     def to_s
-      "<VariantDefinition: name=#{self.name},weight=#{self.weight},payload=#{self.payload},overrides=#{self.overrides}>"
+      "<VariantDefinition: name=#{self.name},weight=#{self.weight},payload=#{self.payload},stickiness=#{self.stickiness}" \
+          ",overrides=#{self.overrides}>"
     end
   end
 end

data/lib/unleash/version.rb

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

data/lib/unleash.rb

@@ -24,11 +24,6 @@ module Unleash
     attr_accessor :configuration, :toggle_fetcher, :toggles, :toggle_metrics, :reporter, :logger
   end
 
-  def self.initialize
-    self.toggles = []
-    self.toggle_metrics = {}
-  end
-
   # Support for configuration via yield:
   def self.configure
     self.configuration ||= Unleash::Configuration.new

data/unleash-client.gemspec

@@ -31,6 +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 "coveralls", "~> 0.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: 3.2.2
+  version: 4.3.0
 platform: ruby
 authors:
 - Renato Arruda
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -95,33 +95,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 0.8.0
 description: |-
   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.
@@ -132,10 +146,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/add-to-project.yml"
+- ".github/workflows/pull_request.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -143,9 +158,16 @@ files:
 - bin/console
 - bin/setup
 - bin/unleash-client
+- examples/bootstrap.rb
+- examples/default-toggles.json
 - examples/simple.rb
 - lib/unleash.rb
 - lib/unleash/activation_strategy.rb
+- lib/unleash/bootstrap/configuration.rb
+- lib/unleash/bootstrap/handler.rb
+- lib/unleash/bootstrap/provider/base.rb
+- lib/unleash/bootstrap/provider/from_file.rb
+- lib/unleash/bootstrap/provider/from_url.rb
 - lib/unleash/client.rb
 - lib/unleash/configuration.rb
 - lib/unleash/constraint.rb
@@ -175,7 +197,7 @@ homepage: https://github.com/unleash/unleash-client-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -190,8 +212,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.3.6
+signing_key: 
 specification_version: 4
 summary: Unleash feature toggle client.
 test_files: []

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-- jruby
-- 3.0
-- 2.7
-- 2.6
-- 2.5
-before_install:
-- gem install bundler -v 2.1.4
-- git clone --depth 5 --branch v3.3.0 https://github.com/Unleash/client-specification.git client-specification
-
-notifications:
-  slack:
-    secure: x593zOjdl2yVB8uP54v8CmuCOat8GFHnK99NPvPHKvif5U7PGe0YOgYh4DC1+Jc9vfjn1ke+0++m+Gif4quowpeOaA/t45xpB494lyziXsBulYml245jRp9yzoUmIIt7KxHhv4rlo3Q1ztMJgh6a5yDCornKHW2bKTkLsvqVTwxBRatLOrt6K9O8FivO/NaqgcoXl7Rw0fOx/bsZtx2IAFueTCH19NoqW1mk9KFEZ96YqJSvuqmfDC0AO7siq03WKlB++nPlKe1QcrlPalCrcsSzrYNhYJ3akBTt/ZbE1v6YJv2L+zUqRnAPTY2H+qp8WejFQtdhIjfeJ/SWox0iWv/Wy/mTFfj+EhFO9Aq+xhMjJ1OOLtNAPoYJyatEVgJkILb6M26igTFcuI60xBbGNmh5ZYeyRdn5/xFb7G2zyJ2Swc3PvN1uLzMHfTF0R7WzGq4CRNGIOjrHTGncyB3IGAONOdJdM3iT9XKY6cdlRK0VkQjEsEMe0eNv2fxxLVSGna4sdJoTND6LhJ6qCfuS9DEDXwoRdLxAXxefycCh9VNp7gloMJx8IbHYxOW0BFZqc3hxNU9X2SwOj6j72DZMrdYDg2aPAW69HG0iMontQ37Di87JEW2F2Cpgb49+4twByrQNIx+st+DGNce1vpc0DN+KuJVdIcmha654lT7Ffe8=