unleash 6.1.2 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6bd9703fdba109b3d5a0e22153ab9e04b25afb855641b955d02cee2d3a1cf9e
-  data.tar.gz: 4df84602002a6968fe115ae490b463da9cfbbf7e2524f2bbaff1dc838cb9adf2
+  metadata.gz: 4370c29490f14c2ece25f21614db57de48b748cea8215da748d7635bd9d27bbf
+  data.tar.gz: eb2cdff78e994647a70fca33497d144f0e4366d75612670077c1689d6d37dcac
 SHA512:
-  metadata.gz: a9b8dcd7e176a3e7356a8b516f664ca24d7ac99e5b2d93f38e80ce2835417a7a5ab9e8b9c5e61433a5500889db23dcdbaa8b96f468bdebd55aa4235f045b3256
-  data.tar.gz: f37909173947cf1e59840efc0449dd19e7a83b7b03aed69ccd875c2c9df7e926d72f845cdfebb6dd263d66265a3c90e882a4097d7d408e10ff86336246535e22
+  metadata.gz: 63a24dbca52e439f57c24a4c1f6894f172386ee898704e4570877c59b3a2b542e98eff9463b75a01fb54f5aa37ecab43e98b12119dbe03cf87be4e0e6792cae6
+  data.tar.gz: caa9b7b541d60b3ab99f5cbf270adac69211fe4424e80202ad12c4882f49295829a3aeb267cd7400fee5dbe393fcd355cc8db7fb9ebf419ee04a31dc1c0840ba

data/.github/workflows/pull_request.yml

@@ -30,11 +30,15 @@ jobs:
           - windows
         ruby-version:
           - jruby-9.4
+          - 3.4
           - 3.3
           - 3.2
           - 3.1
           - '3.0'
           - 2.7
+        exclude:
+          - os: windows
+            ruby-version: jruby-9.4
 
     needs:
       - lint
@@ -66,15 +70,6 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           flag-name: run-${{ matrix.test_number }}
           parallel: true
-      - name: Notify Slack of pipeline completion
-        uses: 8398a7/action-slack@v3
-        if: ${{ github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name }}
-        with:
-          status: ${{ job.status }}
-          text: Built on ${{ matrix.os }} - Ruby ${{ matrix.ruby-version }}
-          fields: repo,message,commit,author,action,eventName,ref,workflow,job,took
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
   finish:
     needs: test

data/CHANGELOG.md

@@ -13,6 +13,14 @@ Note: These changes are not considered notable:
 
 ## [Unreleased]
 
+## [6.2.0] - 2024-02-28
+### Added
+- unleash-interval header (#236)
+- connectionId in metrics and registration payload (#236)
+- default interval changed from 10s to 15s (#236)
+- update Yggdrasil engine (#228)
+- delta API configuration option (#228)
+
 ## [6.1.2] - 2024-01-30
 ### Fixed
 - drop x- header prefix (#229)

data/README.md

@@ -13,6 +13,7 @@ Ruby client for the [Unleash](https://github.com/Unleash/unleash) feature manage
 
 ## Supported Ruby interpreters
 
+- MRI 3.4
 - MRI 3.3
 - MRI 3.2
 - MRI 3.1
@@ -25,7 +26,7 @@ Ruby client for the [Unleash](https://github.com/Unleash/unleash) feature manage
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 6.1.0'
+gem 'unleash', '~> 6.1.2'
 ```
 
 And then execute:

data/lib/unleash/client.rb

@@ -116,6 +116,7 @@ module Unleash
       {
         'appName': Unleash.configuration.app_name,
         'instanceId': Unleash.configuration.instance_id,
+        'connectionId': Unleash.configuration.connection_id,
         'sdkVersion': "unleash-client-ruby:" + Unleash::VERSION,
         'strategies': Unleash.strategies.known_strategies,
         'started': Time.now.iso8601(Unleash::TIME_RESOLUTION),

data/lib/unleash/configuration.rb

@@ -21,7 +21,9 @@ module Unleash
       :logger,
       :log_level,
       :bootstrap_config,
-      :strategies
+      :strategies,
+      :use_delta_api
+    attr_reader :connection_id
 
     def initialize(opts = {})
       validate_custom_http_headers!(opts[:custom_http_headers]) if opts.has_key?(:custom_http_headers)
@@ -50,18 +52,27 @@ module Unleash
     end
 
     def http_headers
-      {
+      headers = {
         'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
         'UNLEASH-INSTANCEID' => self.instance_id,
         'UNLEASH-APPNAME' => self.app_name,
-        'UNLEASH-CONNECTION-ID' => @connection_id,
-        'UNLEASH-SDK' => "unleash-client-ruby:#{Unleash::VERSION}",
-        'Unleash-Client-Spec' => CLIENT_SPECIFICATION_VERSION
+        'Unleash-Client-Spec' => CLIENT_SPECIFICATION_VERSION,
+        'UNLEASH-SDK' => "unleash-client-ruby:#{Unleash::VERSION}"
       }.merge!(generate_custom_http_headers)
+      headers['UNLEASH-CONNECTION-ID'] = @connection_id
+      headers
     end
 
     def fetch_toggles_uri
-      uri = URI("#{self.url_stripped_of_slash}/client/features")
+      uri = nil
+      ## Personal feeling but Rubocop's suggestion here is too dense to be properly readable
+      # rubocop:disable Style/ConditionalAssignment
+      if self.use_delta_api
+        uri = URI("#{self.url_stripped_of_slash}/client/delta")
+      else
+        uri = URI("#{self.url_stripped_of_slash}/client/features")
+      end
+      # rubocop:enable Style/ConditionalAssignment
       uri.query = "project=#{self.project_name}" unless self.project_name.nil?
       uri
     end
@@ -92,7 +103,7 @@ module Unleash
       self.project_name     = nil
       self.disable_client   = false
       self.disable_metrics  = false
-      self.refresh_interval = 10
+      self.refresh_interval = 15
       self.metrics_interval = 60
       self.timeout          = 30
       self.retry_limit      = Float::INFINITY
@@ -100,6 +111,7 @@ module Unleash
       self.log_level        = Logger::WARN
       self.bootstrap_config = nil
       self.strategies       = Unleash::Strategies.new
+      self.use_delta_api    = false
 
       self.custom_http_headers = {}
       @connection_id = SecureRandom.uuid

data/lib/unleash/metrics_reporter.rb

@@ -23,6 +23,7 @@ module Unleash
         'specVersion': Unleash::CLIENT_SPECIFICATION_VERSION,
         'appName': Unleash.configuration.app_name,
         'instanceId': Unleash.configuration.instance_id,
+        'connectionId': Unleash.configuration.connection_id,
         'bucket': metrics || {}
       }
     end
@@ -37,7 +38,9 @@ module Unleash
         return
       end
 
-      response = Unleash::Util::Http.post(Unleash.configuration.client_metrics_uri, report.to_json)
+      headers = (Unleash.configuration.http_headers || {}).dup
+      headers.merge!({ 'UNLEASH-INTERVAL' => Unleash.configuration.metrics_interval.to_s })
+      response = Unleash::Util::Http.post(Unleash.configuration.client_metrics_uri, report.to_json, headers)
 
       if ['200', '202'].include? response.code
         Unleash.logger.debug "Report sent to unleash server successfully. Server responded with http code #{response.code}"

data/lib/unleash/spec_version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  CLIENT_SPECIFICATION_VERSION = "5.1.9".freeze
+  CLIENT_SPECIFICATION_VERSION = "5.2.0".freeze
 end

data/lib/unleash/toggle_fetcher.rb

@@ -37,13 +37,16 @@ module Unleash
       Unleash.logger.debug "fetch()"
       return if Unleash.configuration.disable_client
 
-      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_uri, etag)
+      headers = (Unleash.configuration.http_headers || {}).dup
+      headers.merge!({ 'UNLEASH-INTERVAL' => Unleash.configuration.refresh_interval.to_s })
+      response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_uri, etag, headers)
 
       if response.code == '304'
         Unleash.logger.debug "No changes according to the unleash server, nothing to do."
         return
       elsif response.code != '200'
-        raise IOError, "Unleash server returned a non 200/304 HTTP result."
+        raise IOError, "Unleash server returned unexpected HTTP response code #{response.code}."\
+          " Only handle response codes 200 (indicates changes) or 304 (no changes)."
       end
 
       self.etag = response['ETag']
@@ -81,6 +84,8 @@ module Unleash
 
       # notify all threads waiting for this resource to no longer wait
       self.toggle_resource.broadcast
+    rescue StandardError => e
+      Unleash.logger.error "Failed to hydrate state: #{e.backtrace}"
     end
 
     def read!

data/lib/unleash/util/http.rb

@@ -12,10 +12,10 @@ module Unleash
         http.request(request)
       end
 
-      def self.post(uri, body)
+      def self.post(uri, body, headers_override = nil)
         http = http_connection(uri)
 
-        request = Net::HTTP::Post.new(uri.request_uri, http_headers)
+        request = Net::HTTP::Post.new(uri.request_uri, http_headers(nil, headers_override))
         request.body = body
 
         http.request(request)

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "6.1.2".freeze
+  VERSION = "6.2.0".freeze
 end

data/unleash-client.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.7"
 
-  spec.add_dependency "yggdrasil-engine", "~> 1.0.1"
+  spec.add_dependency "yggdrasil-engine", "~> 1.0.3"
+
+  spec.add_dependency "base64", "~> 0.2.0"
+  spec.add_dependency "logger", "~> 1.6.5"
 
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 6.1.2
+  version: 6.2.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yggdrasil-engine
@@ -16,14 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement