percy-common 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe94763bb303e12d788d293e1b2a1947fccfb61a1334a04c71179f99590ab639
-  data.tar.gz: 113a9533d5286c9753d21df7d631b2f6c64601680cd698db5600503d9e638c23
+  metadata.gz: e5f341799d420673ccbf3e89c87071851ba6de8f8511f3db298caf0d301e21b2
+  data.tar.gz: 9f9ef8f3f3f488ef54fceff7c492e52294e75e66a892a3816a1699c09ac2c48b
 SHA512:
-  metadata.gz: 6ea47390164289c6a3402ce8f108f19ba698a69d1b2fb50dcaa58d12961ab10c18a74e1d54ed47e268a827b9851986136766ab436397b5bf475d690631a65f09
-  data.tar.gz: 1ae7c46e24ff481bb6d986d0cdfdca18450c27b350cb89d0938cd54101f4fc8f8edcd518220b64339edbb14b9846beb7390bffab59f2c94100350614ca736f24
+  metadata.gz: 7448ce54194d6faf1a413f667411f1ae8b37979d1f804aa5cfac36e4dbf9fe4208e40fc55c39b142672e39403b7a61d6334d39138c7c510d8b403f62dfbc84d2
+  data.tar.gz: d3a713c1ef85413520241bcb5f93db074eeacfe14e3f60c702cf46e4487d0e781c28dedcc8a47b96f1ac39e5957f823a600d348a83d2ac4c3247fd6d6283fbf6

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   percy-style:
     - default.yml

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-04-30 16:00:36 -0700 using RuboCop version 0.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/percy/keyword_struct_spec.rb'

data/RELEASING.md

@@ -1,16 +1,13 @@
 # Releasing
 
-1. `git pull origin master`
-1. Bump the version number in `lib/percy/common/version.rb`
-1. `git add lib/percy/common/version.rb`
-1. `git commit -m "version bump to X.X.X"`
-1. `git push origin master`
-1. `git tag vX.X.X`
-1. `git push --tags`
-1. `bundle exec rake build`
-1. `gem push pkg/percy-common-X.X.X.gem`
+1. Ensure you are on the expected branch (presumably `master`) and the current branch is up-to-date.
+1. Run `./release.sh`
 1. Visit [RubyGems.org](https://rubygems.org/gems/percy-common) and see the gem has been published
-1. Document the release on Github by first [creating a new release](https://github.com/percy/percy-common/releases/new)
+
+# Creating a Release on GitHub
+
+Finish the pre-started release opened by the script, or [create a new release](https://github.com/percy/percy-common/releases/new):
+
 1. Enter "vX.X.X" as the tag version. It should auto complete to say "Existing Tag"
 1. Enter "vX.X.X" as the release title
 1. Write a brief description as to what is included in this release. Linking to specific PRs is great.

data/lib/percy/common/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Common
-    VERSION = '3.1.0'.freeze
+    VERSION = '3.1.2'.freeze
   end
 end

data/lib/percy/redis_client.rb

@@ -4,17 +4,15 @@ require 'redis'
 
 module Percy
   class RedisClient
-    attr_reader :options
+    class InvalidConfiguration < ArgumentError
+    end
     attr_reader :client
+    attr_reader :options
 
-    def initialize(options = {})
-      @options = options
-      @client = ::Redis.new(
-        options.merge(
-          ssl: ssl_enabled?,
-          ssl_params: ssl_params,
-        ),
-      )
+    def initialize(given_options = {})
+      @provided_options = given_options
+      @options = ssl_options.merge(given_options)
+      @client = ::Redis.new(options)
     end
 
     private def ssl_enabled?
@@ -22,59 +20,77 @@ module Percy
     end
 
     private def provided_url
-      options.dig(:url)
+      @provided_options&.dig(:url)
+    end
+
+    private def ssl_options
+      {
+        ssl: ssl_enabled?,
+        ssl_params: ssl_params,
+      }
     end
 
     private def ssl_params
       return {} unless ssl_enabled?
 
       {
-        ca_file: certificate_authority_file,
+        ca_file: certificate_authority,
         cert: OpenSSL::X509::Certificate.new(client_certificate),
         key: OpenSSL::PKey::RSA.new(private_key),
       }
     end
 
     private def client_certificate
-      ENV.fetch(
-        'REDIS_SSL_CLIENT_CERTIFICATE',
-        File.read(client_certificate_path),
-      )
+      @provided_options&.dig(:ssl_params, :cert) ||
+        client_certificate_from_env ||
+        client_certificate_from_path
     end
 
-    private def client_certificate_path
-      ENV.fetch(
-        'REDIS_SSL_CLIENT_CERTIFICATE_PATH',
-        File.join(cert_path, 'user.crt'),
-      )
+    private def client_certificate_from_env
+      ENV['REDIS_SSL_CLIENT_CERTIFICATE']
+    end
+
+    private def client_certificate_from_path
+      File.read(fetch_key('REDIS_SSL_CLIENT_CERTIFICATE_PATH'))
     end
 
     private def private_key
-      ENV.fetch(
-        'REDIS_SSL_PRIVATE_KEY',
-        File.read(private_key_path),
-      )
+      provided_private_key ||
+        private_key_from_env ||
+        private_key_from_path
+    end
+
+    private def provided_private_key
+      @provided_options&.dig(:ssl_params, :key)
+    end
+
+    private def private_key_from_env
+      ENV['REDIS_SSL_PRIVATE_KEY']
+    end
+
+    private def private_key_from_path
+      File.read(fetch_key('REDIS_SSL_PRIVATE_KEY_PATH'))
+    end
+
+    private def certificate_authority
+      provided_certificate_authority ||
+        certificate_authority_from_path
+    end
+
+    private def provided_certificate_authority
+      @provided_options&.dig(:ssl_params, :ca_file)
     end
 
-    private def private_key_path
-      ENV.fetch(
-        'REDIS_SSL_PRIVATE_KEY_PATH',
-        File.join(cert_path, 'user_private.key'),
-      )
+    private def certificate_authority_from_path
+      fetch_key('REDIS_SSL_CERTIFICATE_AUTHORITY_PATH')
     end
 
-    private def certificate_authority_file
-      ENV.fetch(
-        'REDIS_SSL_CERTIFICATE_AUTHORITY_PATH',
-        File.join(cert_path, 'server_ca.pem'),
-      )
+    private def fetch_key(key)
+      ENV.fetch(key) { missing_key(key) }
     end
 
-    private def cert_path
-      ENV.fetch(
-        'REDIS_SSL_CERTIFICATE_PATH',
-        File.expand_path('../../redis', __dir__),
-      )
+    private def missing_key(key)
+      raise InvalidConfiguration, "#{key} is not defined"
     end
   end
 end

data/percy-common.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dogstatsd-ruby', '~> 4.4.0'
   spec.add_dependency 'excon', '~> 0.57'
-  spec.add_dependency 'redis', '~> 4.1.3'
+  spec.add_dependency 'redis', '>= 4.1.3', '< 5.0.0'
 
   spec.add_development_dependency 'bundler', '~> 2.1.4'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'percy-style', '~> 0.6.0'
+  spec.add_development_dependency 'percy-style', '~> 0.7.0'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
 end

data/release.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")" || exit 1
+CURDIR="$(pwd)"
+
+PERCY_COMMON_VERSION="$(grep "VERSION" lib/percy/common/version.rb | awk -F "'" '{print $2}')"
+
+echo "Current percy-common version: $PERCY_COMMON_VERSION"
+
+if [[ $# -lt 1 ]]; then
+  echo "Usage $0 <version>"
+  exit 1
+fi
+
+rm "$CURDIR/"percy-common*.gem >/dev/null 2>&1 || true
+
+delete_existing_version() {
+  git tag -d "v$1" || true
+  git push origin ":v$1" || true
+  gem yank percy-common -v "$1" || true
+}
+
+if [[ $1 =~ ^.*delete$ ]]; then
+  shift
+  echo "Preparing to delete $1"
+  sleep 3
+  delete_existing_version "$PERCY_COMMON_VERSION"
+else
+  CLEAN=$(
+    git diff-index --quiet HEAD --
+    echo $?
+  )
+  if [[ "$CLEAN" == "0" ]]; then
+    if [[ $1 == '--force' ]]; then
+      shift
+      if [[ -n $1 ]]; then
+        echo "Deleting version $1"
+        sleep 1
+        delete_existing_version "$1"
+      else
+        echo "Missing release version"
+        exit 1
+      fi
+    fi
+    VERSION=$1
+    echo "Releasing $VERSION"
+    sleep 1
+
+    sed -i "" -e "s/$PERCY_COMMON_VERSION/$VERSION/g" "lib/percy/common/version.rb"
+    git add "lib/percy/common/version.rb"
+    git commit -a -m "Release $VERSION" || true
+
+    git tag -a "v$VERSION" -m "$1" || true
+    git push origin "v$VERSION" || true
+
+    bundle exec rake build
+    gem push "$CURDIR/pkg/percy-common-"*.gem
+    open "https://github.com/percy/percy-common/releases/new?tag=v$VERSION&title=$VERSION"
+    rm "$CURDIR/pkg/percy-common-"*.gem
+  else
+    echo "Please commit your changes and try again"
+    exit 1
+  fi
+fi
+echo "Done"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-common
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -42,16 +42,22 @@ dependencies:
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +139,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -149,6 +156,7 @@ files:
 - lib/percy/redis_client.rb
 - lib/percy/stats.rb
 - percy-common.gemspec
+- release.sh
 homepage: ''
 licenses: []
 metadata: {}