launchdarkly-server-sdk 5.8.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 70c964dad6b0915f006bee0d90160fe04bdd4853
-  data.tar.gz: f80c3dfe18ad4a70c0d7156ab06b748ffc897ae9
+SHA256:
+  metadata.gz: 631066b2968b323ed2e12aed1565c76cf1f8bb6284e8372121771577b49bda18
+  data.tar.gz: 3e6b7c3b9769c917996e844c598796912f19c20e796692b877a885886d8fa070
 SHA512:
-  metadata.gz: 8a31c4b4a77caec7e64b54b18aabdecb12f2b5a44432d4ef74c94c2a1b57dff8a4cbf38f8dc894be8fec6f999bdc8bb62ff6095d1670ac892969329c435c9ff7
-  data.tar.gz: 2e21c5ad0cb881d99c905eaefc8952024d8fc12a1f28b1b2f4100cb39a95cdfa65d77b4a2067f3843ca9c79a446e6b071dd9c2470f2d0d0afba64d86365eb6cd
+  metadata.gz: 5a885a5714a9cc157e295dd1a88a353a546847a702a771b4edf49f33c081eb19c4141ee7a0b4a8004620c1a4c20ef0111af0c0900ee3a28845f29e2385ebd13c
+  data.tar.gz: 6e604eac4e997431d09257bf97ec115f3a130293e4bc83fa08254baaa921eb28a2230e5bc2bd080c855293e773331e5eed006741db6cd9943132a1f2a1dc243d

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.1.1"
+      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/.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 **Is this a support request?**
-This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the SDK code. If you're not sure whether the problem you are having is specifically related to the SDK, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing support@launchdarkly.com.
+This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the SDK code. If you're not sure whether the problem you are having is specifically related to the SDK, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/hc/en-us/requests/new) or by emailing support@launchdarkly.com.
 
 Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
 

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Support request
+    url: https://support.launchdarkly.com/hc/en-us/requests/new
+    about: File your support requests with LaunchDarkly's support team

data/.gitignore

@@ -2,7 +2,7 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
+/docs/build
 /pkg/
 /spec/reports/
 /tmp/
@@ -13,3 +13,4 @@
 mkmf.log
 *.gem
 .DS_Store
+Gemfile.lock

data/.ldrelease/build-docs.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# doc generation is not part of Releaser's standard Ruby project template
+
+mkdir -p ./artifacts/
+
+cd ./docs
+make
+cd ..
+
+# Releaser will pick up docs generated in CI if we put an archive of them in the
+# artifacts directory and name it docs.tar.gz or docs.zip. They will be uploaded
+# to GitHub Pages and also attached as release artifacts. There's no separate
+# "publish-docs" step because the external service that also hosts them doesn't
+# require an upload, it just picks up gems automatically.
+
+cd ./docs/build/html
+tar cfz ../../../artifacts/docs.tar.gz *

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,8 +14,16 @@ 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.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
 
 sdk:
   displayName: "Ruby"

data/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [6.1.0] - 2021-02-04
+### Added:
+- Added the `alias` method. This can be used to associate two user objects for analytics purposes by generating an alias event.
+
+
+## [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
+- Switched the default polling domain from `app.launchdarkly.com` to `sdk.launchdarkly.com`.
+
+## [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)!)
+
+
+## [5.8.1] - 2020-11-09
+### Fixed:
+- Updated `json` gem to patch [CVE-2020-10663](https://nvd.nist.gov/vuln/detail/CVE-2020-10663).
+
+
+## [5.8.0] - 2020-05-27
+### Added:
+- In `LaunchDarkly::Integrations::Redis::new_feature_store`, if you pass in an externally created `pool`, you can now set the new option `pool_shutdown_on_close` to `false` to indicate that the SDK should _not_ shut down this pool if the SDK is shut down. The default behavior, as before, is that it will be shut down. (Thanks, [jacobthemyth](https://github.com/launchdarkly/ruby-server-sdk/pull/158)!)
+
 ## [5.7.4] - 2020-05-04
 ### Fixed:
 - Setting a user's `custom` property explicitly to `nil`, rather than omitting it entirely or setting it to an empty hash, would cause the SDK to log an error and drop the current batch of analytics events. Now, it will be treated the same as an empty hash. ([#147](https://github.com/launchdarkly/ruby-server-sdk/issues/147))

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: