launchdarkly-server-sdk 5.8.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 509c387994cfb92e5d258eeb2190532f87a33805527eeba659a78472efe76831
-  data.tar.gz: edabc361b4728b6228136cd79171e11cd22f05b78453f7b0f4b3b513cf2e0d02
+  metadata.gz: fd5b1ccdc654b9ca033547f366d12fe0dde0d25245459de79f9cf1e3ed0e9b79
+  data.tar.gz: ee6461f8365f0df76055b8c1e5e71b58934df15b24bba22c8b61eb99619b21dc
 SHA512:
-  metadata.gz: 67e083a20014a4e9c9f8b9dbadec403563f2802191f8bdf844da86f7800076ef584c860541c3dc76472b2c79ad289c3558832d50482daa882577e8dc18e5b59f
-  data.tar.gz: c0fcaca18d915e9aadc53bca4ef609aa04da63a0aca5aae6826ee43caa6d2110dc268848fb6886cfdb1b96753dfafa3236162ead4d4e4ab67888f2ef1e89f37f
+  metadata.gz: d6723297fc581f47325f0147f915efa543f1daf27d01af6d63a13546a5d18e800743060478e9f40c62083ceae5bcd8acfaa8c84d83fc870b893069ae51a9f519
+  data.tar.gz: 89b4885e33f1ebf61fd88b4a65c4da060087901aaf9772100875888b0983f420099b23971c6b8ba8d71697da410daf0b43e88c946192cb8899682aff9b77a64d

data/.circleci/config.yml

@@ -1,134 +1,40 @@
-version: 2
-
+# This CircleCI configuration was generated by Releaser for a specific release. It is not to be used
+# for regular CI builds. Be aware that rerunning this build may cause it to repeat release actions
+# such as publishing to a package manager. However, it will not perform any Git actions other than
+# reading the repository.
+version: 2.1
 workflows:
-  version: 2
   test:
     jobs:
-      - test-misc-rubies
-      - test-2.2
-      - test-2.3
-      - test-2.4
-      - test-2.5
-      - test-2.6
-      - test-jruby-9.2
-
-ruby-docker-template: &ruby-docker-template
-  steps:
-    - checkout
-    - run: |
-        if [[ $CIRCLE_JOB == test-jruby* ]]; then
-          gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
-        fi
-    - run: ruby -v
-    - run: gem install bundler -v 1.17.3
-    - run: bundle install
-    - run: mkdir ./rspec
-    - run: bundle exec rspec --format progress --format RspecJunitFormatter -o ./rspec/rspec.xml spec
-    - store_test_results:
-        path: ./rspec
-    - store_artifacts:
-        path: ./rspec
-
+      - release_linux:
+          context: org-global
 jobs:
-  test-2.2:
-    <<: *ruby-docker-template
+  release_linux:
     docker:
-      - image: circleci/ruby:2.2.10-jessie
-      - image: consul
-      - image: redis
-      - image: amazon/dynamodb-local
-  test-2.3:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.3.7-jessie
-      - image: consul
-      - image: redis
-      - image: amazon/dynamodb-local
-  test-2.4:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.4.5-stretch
-      - image: consul
-      - image: redis
-      - image: amazon/dynamodb-local
-  test-2.5:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.5.3-stretch
-      - image: consul
-      - image: redis
-      - image: amazon/dynamodb-local
-  test-2.6:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.6.2-stretch
-      - image: consul
-      - image: redis
-      - image: amazon/dynamodb-local
-  test-jruby-9.2:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/jruby:9-jdk
-      - image: consul
-      - image: redis
-      - image: amazon/dynamodb-local
-
-  # The following very slow job uses an Ubuntu container to run the Ruby versions that
-  # CircleCI doesn't provide Docker images for.
-  test-misc-rubies:
-    machine:
-      image: circleci/classic:latest
+      - image: circleci/ruby:2.6.6-buster
     environment:
-      - RUBIES: "jruby-9.1.17.0"
+      LD_RELEASE_CIRCLECI_TYPE: linux
+      LD_RELEASE_BRANCH: "master"
+      LD_RELEASE_CIRCLECI_BRANCH: ""
+      LD_RELEASE_DOCS_GITHUB_PAGES: "1"
+      LD_RELEASE_DOCS_TITLE: ""
+      LD_RELEASE_PROJECT: "ruby-server-sdk"
+      LD_RELEASE_PROJECT_TEMPLATE: "ruby"
+      LD_RELEASE_VERSION: "6.0.0"
+      LD_SKIP_DATABASE_TESTS: "1"
     steps:
-      - run: sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
-      - run: sudo apt-get -q update
-      - run: sudo apt-get -qy install redis-server
-      - run: sudo apt-cache policy docker-ce
-      - run: sudo apt-get -qy install docker-ce      
       - checkout
       - run:
-          name: install all Ruby versions
-          command: "parallel rvm install ::: $RUBIES"
-      - run:
-          name: bundle install for all versions
-          shell: /bin/bash -leo pipefail # need -l in order for "rvm use" to work
-          command: |
-            set -e;
-            for i in $RUBIES;
-            do
-              rvm use $i;
-              if [[ $i == jruby* ]]; then
-                gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
-              fi
-              # bundler 2.0 may be preinstalled, we need to remove it if so
-              yes | gem uninstall bundler --version '>=2.0' || true;
-              gem install bundler -v 1.17.3;
-              bundle install;
-              mv Gemfile.lock "Gemfile.lock.$i"
-            done
-      - run:
-          name: start DynamoDB
-          command: docker run -p 8000:8000 amazon/dynamodb-local
-          background: true
-      - run:
-          name: download Consul
-          command: wget https://releases.hashicorp.com/consul/0.8.0/consul_0.8.0_linux_amd64.zip
+          name: "Releaser: build"
+          command: .ldrelease/circleci/mac/execute.sh build .ldrelease/circleci/template/build.sh
       - run:
-          name: extract Consul
-          command: unzip consul_0.8.0_linux_amd64.zip
+          name: "Releaser: test"
+          command: .ldrelease/circleci/mac/execute.sh test .ldrelease/circleci/template/test.sh
       - run:
-          name: start Consul
-          command: ./consul agent -dev
-          background: true
+          name: "Releaser: build-docs"
+          command: .ldrelease/circleci/mac/execute.sh build-docs .ldrelease/build-docs.sh
       - run:
-          name: run tests for all versions
-          shell: /bin/bash -leo pipefail
-          command: |
-            set -e;
-            for i in $RUBIES;
-            do
-              rvm use $i;
-              cp "Gemfile.lock.$i" Gemfile.lock;
-              bundle exec rspec spec;
-            done
+          name: "Releaser: publish"
+          command: .ldrelease/circleci/mac/execute.sh publish .ldrelease/circleci/template/publish.sh
+      - store_artifacts:
+          path: artifacts

data/.ldrelease/circleci/linux/execute.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -ue
+
+# Performs a delegated release step in a CircleCI Linux container. This mechanism is described
+# in scripts/circleci/README.md. All of the necessary environment variables should already be
+# in the generated CircleCI configuration.
+
+mkdir -p artifacts
+
+export LD_RELEASE_TEMP_DIR=/tmp/project-releaser-temp
+mkdir -p ${LD_RELEASE_TEMP_DIR}
+
+STEP="$1"
+SCRIPT="$2"
+echo
+echo "[${STEP}] executing ${SCRIPT}"
+"./${SCRIPT}"

data/.ldrelease/circleci/mac/execute.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -ue
+
+# Performs a delegated release step in a CircleCI Mac container. This mechanism is described
+# in scripts/circleci/README.md. All of the necessary environment variables should already be
+# in the generated CircleCI configuration.
+
+mkdir -p artifacts
+
+export LD_RELEASE_TEMP_DIR=/tmp/project-releaser-temp
+mkdir -p ${LD_RELEASE_TEMP_DIR}
+
+STEP="$1"
+SCRIPT="$2"
+echo
+echo "[${STEP}] executing ${SCRIPT}"
+"./${SCRIPT}"

data/.ldrelease/circleci/template/build.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -ue
+
+# Standard build.sh for Ruby-based projects that publish a gem
+
+echo "Using gem $(gem --version)"
+
+#shellcheck source=/dev/null
+source "$(dirname "$0")/set-gem-home.sh"
+
+# If the gemspec specifies a certain version of bundler, we need to make sure we install that version.
+echo "Installing bundler"
+GEMSPEC_BUNDLER_VERSION=$(sed -n -e "s/.*['\"]bundler['\"], *['\"]\([^'\"]*\)['\"]/\1/p" ./*.gemspec | tr -d ' ')
+if [ -n "${GEMSPEC_BUNDLER_VERSION}" ]; then
+  GEMSPEC_OPTIONS="-v ${GEMSPEC_BUNDLER_VERSION}"
+else
+  GEMSPEC_OPTIONS=""
+fi
+gem install bundler ${GEMSPEC_OPTIONS} || { echo "installing bundler failed" >&2; exit 1; }
+
+echo; echo "Installing dependencies"
+bundle install
+
+# Build Ruby Gem - this assumes there is a single .gemspec file in the main project directory
+# Note that the gemspec must be able to get the project version either from $LD_RELEASE_VERSION,
+# or from somewhere in the source code that the project-specific update-version.sh has updated.
+echo "Running gem build"
+gem build ./*.gemspec || { echo "gem build failed" >&2; exit 1; }

data/.ldrelease/circleci/template/publish.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -ue
+
+# Standard publish.sh for Ruby-based projects - we can assume build.sh has already been run
+
+export GEM_HOME="${LD_RELEASE_TEMP_DIR}/gems"
+
+# If we're running in CircleCI, the RubyGems credentials will be in an environment
+# variable and need to be copied to a file
+if [ -n "${LD_RELEASE_RUBYGEMS_API_KEY}" ]; then
+  mkdir -p ~/.gem
+  cat >~/.gem/credentials <<EOF
+---
+:rubygems_api_key: $LD_RELEASE_RUBYGEMS_API_KEY
+EOF
+  chmod 0600 ~/.gem/credentials
+fi
+
+# Since all Releaser builds are clean builds, we can assume that the only .gem file here
+# is the one we just built
+echo "Running gem push"
+gem push ./*.gem || { echo "gem push failed" >&2; exit 1; }

data/.ldrelease/circleci/template/set-gem-home.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# helper script to set GEM_HOME and PATH for Ruby - must be sourced, not executed
+
+mkdir -p "${LD_RELEASE_TEMP_DIR}/gems"
+export GEM_HOME="${LD_RELEASE_TEMP_DIR}/gems"
+export PATH="${GEM_HOME}/bin:${PATH}"

data/.ldrelease/circleci/template/test.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -ue
+
+# Standard test.sh for Ruby-based projects
+
+#shellcheck source=/dev/null
+source "$(dirname "$0")/set-gem-home.sh"
+
+bundle exec rspec spec

data/.ldrelease/circleci/template/update-version.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -ue
+
+# Standard update-version.sh for Ruby-based projects - this will work only if the version string
+# is in a source file under lib/ that has a line like his: VERSION = "2.0.0"
+
+"$(dirname "$0")/../update-version-constant.sh" lib '*.rb'

data/.ldrelease/circleci/windows/execute.ps1

@@ -0,0 +1,19 @@
+param(
+    [string]$step,
+    [string]$script
+)
+
+# Performs a delegated release step in a CircleCI Windows container using PowerShell. This
+# mechanism is described in scripts/circleci/README.md. All of the necessary environment
+# variables should already be in the generated CircleCI configuration.
+
+$ErrorActionPreference = "Stop"
+
+New-Item -Path "./artifacts" -ItemType "directory" -Force | Out-Null
+
+$env:LD_RELEASE_TEMP_DIR = "$env:TEMP\project-releaser-temp"
+New-Item -Path $env:LD_RELEASE_TEMP_DIR -ItemType "directory" -Force | Out-Null
+
+Write-Host
+Write-Host "[$step] executing $script"
+& "./$script"

data/.ldrelease/config.yml

@@ -2,6 +2,10 @@ repo:
   public: ruby-server-sdk
   private: ruby-server-sdk-private
 
+releasableBranches:
+  - name: master
+  - name: 5.x
+
 publications:
   - url: https://rubygems.org/gems/launchdarkly-server-sdk
     description: RubyGems
@@ -10,13 +14,13 @@ publications:
 
 template:
   name: ruby
-  env:
-    LD_SKIP_DATABASE_TESTS: 1  # Don't run Redis/Consul/DynamoDB tests in release; they are run in CI
 
 circleci:
   linux:
-    image: circleci/ruby:2.6.2-stretch
+    image: circleci/ruby:2.6.6-buster
     context: org-global
+    env:
+      LD_SKIP_DATABASE_TESTS: "1"  # Don't run Redis/Consul/DynamoDB tests in release; they are run in CI
 
 documentation:
   githubPages: true

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [6.0.0] - 2021-01-26
+### Added:
+- Added a `socket_factory` configuration option which can be used for socket creation by the HTTP client if provided. The value of `socket_factory` must be an object providing an `open(uri, timeout)` method and returning a connected socket.
+
+### Changed:
+- Switched to the `http` gem instead of `socketry` (with a custom http client) for streaming, and instead of `Net::HTTP` for polling / events.
+- Dropped support for Ruby < version 2.5
+- Dropped support for JRuby < version 9.2
+
 ## [5.8.2] - 2021-01-19
 ### Fixed:
 - Fixed a warning within the Redis integration when run with version 4.3 or later of the `redis` gem. (Thanks, [emancu](https://github.com/launchdarkly/ruby-server-sdk/pull/167)!)

data/CONTRIBUTING.md

@@ -18,7 +18,7 @@ Build instructions
 
 ### Prerequisites
 
-This SDK is built with [Bundler](https://bundler.io/). To install Bundler, run `gem install bundler -v 1.17.3`. You might need `sudo` to execute the command successfully. As of this writing, the SDK does not support being built with Bundler 2.0.
+This SDK is built with [Bundler](https://bundler.io/). To install Bundler, run `gem install bundler`. You might need `sudo` to execute the command successfully.
 
 To install the runtime dependencies:
 

data/Gemfile.lock

@@ -1,89 +1,116 @@
 PATH
   remote: .
   specs:
-    launchdarkly-server-sdk (5.8.2)
-      concurrent-ruby (~> 1.0)
+    launchdarkly-server-sdk (6.0.0)
+      concurrent-ruby (~> 1.1)
+      http (~> 4.4.1)
       json (~> 2.3.1)
-      ld-eventsource (= 1.0.3)
+      ld-eventsource (~> 2.0)
       semantic (~> 1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    ast (2.4.2)
     aws-eventstream (1.1.0)
-    aws-partitions (1.388.0)
-    aws-sdk-core (3.109.1)
+    aws-partitions (1.418.0)
+    aws-sdk-core (3.111.2)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.55.0)
+    aws-sdk-dynamodb (1.58.0)
       aws-sdk-core (~> 3, >= 3.109.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.2.2)
       aws-eventstream (~> 1, >= 1.0.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     connection_pool (2.2.3)
     deep_merge (1.2.1)
     diff-lcs (1.4.4)
     diplomat (2.4.2)
       deep_merge (~> 1.0, >= 1.0.1)
       faraday (>= 0.9, < 1.1.0)
-    faraday (0.17.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    ffi (1.12.0)
-    hitimes (1.3.1)
-    http_tools (0.4.5)
+    ffi (1.14.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
     jmespath (1.4.0)
     json (2.3.1)
-    ld-eventsource (1.0.3)
+    ld-eventsource (2.0.0)
       concurrent-ruby (~> 1.0)
-      http_tools (~> 0.4.5)
-      socketry (~> 0.5.1)
-    listen (3.2.1)
+      http (~> 4.4.1)
+    listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     multipart-post (2.1.1)
+    oga (2.15)
+      ast
+      ruby-ll (~> 2.1)
+    public_suffix (4.0.6)
+    rake (13.0.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    redis (3.3.5)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.3)
+    redis (4.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    rspec_junit_formatter (0.3.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
+    ruby-ll (2.1.2)
+      ansi
+      ast
     semantic (1.6.1)
-    socketry (0.5.1)
-      hitimes (~> 1.2)
     timecop (0.9.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    webrick (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aws-sdk-dynamodb (~> 1.18)
-  bundler (~> 1.17)
-  connection_pool (>= 2.1.2)
-  diplomat (>= 2.0.2)
-  faraday (~> 0.17)
-  ffi (<= 1.12)
+  aws-sdk-dynamodb (~> 1.57)
+  bundler (~> 2.1)
+  connection_pool (~> 2.2.3)
+  diplomat (~> 2.4.2)
   launchdarkly-server-sdk!
-  listen (~> 3.0)
-  redis (~> 3.3.5)
-  rspec (~> 3.2)
-  rspec_junit_formatter (~> 0.3.0)
-  timecop (~> 0.9.1)
+  listen (~> 3.3)
+  oga (~> 2.2)
+  redis (~> 4.2)
+  rspec (~> 3.10)
+  rspec_junit_formatter (~> 0.4)
+  timecop (~> 0.9)
+  webrick (~> 1.7)
 
 BUNDLED WITH
-   1.17.3
+   2.2.6