percy-common 3.0.0 → 3.1.2.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0fe4132dddef08590d485a30d755fa43e95bc0cc4569b0f716e25c756c5dca5
-  data.tar.gz: 9de9dbc2f26404e03f22175bfc742080df122824d9510197a23a0f55c8ca0c65
+  metadata.gz: 71a703d0ab1210e46a8650fca96cbba72578e3d95d68825ff7c415d2c4ac89b7
+  data.tar.gz: 3b66f2835412dfb59009fe71f7dd983b04e05921fabd204ce1fafab6a14742c0
 SHA512:
-  metadata.gz: 4063a9ab97a6a5e30774733dbe8922dc690b6556f80f6a3c28651043e050043ea5a76b4de1220a2e3f3fa0688968a259fe9eaba7a77f11699fb9a9e5348f68ab
-  data.tar.gz: 89cb3605660c98e521e3f08c72be55b3517236ee3702dda10c65d09c35eaa855b5b6715d2e349359c34e8fdb41020139dce834e8a3acb2ff7457e0bfe4e6b641
+  metadata.gz: 9ecdee8f494735c6865d6fc75d059db6dd2a04d68a6988483145c8b03100b39a8e5b02a5b01167b5bdbc131881da528995515a10967259dca3d39a8814d1966d
+  data.tar.gz: 54401332070ec4a7c5c6fd3427447237578cb557c862d56177150fec97b7c69d3552d4d81ea93a27c2ba5940c392315ba862a5c4ea1b145f28a0a7b9555c1c69

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   percy-style:
     - default.yml
@@ -9,3 +11,7 @@ inherit_mode:
 RSpec/DescribeClass:
   Exclude:
     - spec/percy/logger_spec.rb
+
+AllCops:
+  Exclude:
+    - spec/support/redis_mock.rb

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.0.0'.freeze
+    VERSION = '3.1.2.rc.1'.freeze
   end
 end

data/lib/percy/logger.rb

@@ -2,7 +2,8 @@ require 'logger'
 
 module Percy
   def self.logger
-    @logger if defined?(@logger)
+    return @logger if defined?(@logger)
+
     @logger ||= Logger.new(STDOUT)
     @logger.level = Logger::INFO if ENV['PERCY_ENV'] == 'production'
     @logger.formatter = proc do |severity, _datetime, _progname, msg|

data/lib/percy/redis_client.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+module Percy
+  class RedisClient
+    class InvalidConfiguration < ArgumentError
+    end
+    attr_reader :client
+    attr_reader :options
+
+    def initialize(given_options = {})
+      @provided_options = given_options
+      @options = ssl_params.merge(given_options)
+      @client = ::Redis.new(options)
+    end
+
+    private def ssl_enabled?
+      provided_url.to_s.start_with?('rediss://')
+    end
+
+    private def provided_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,
+        cert: OpenSSL::X509::Certificate.new(client_certificate),
+        key: OpenSSL::PKey::RSA.new(private_key),
+      }
+    end
+
+    private def client_certificate
+      @provided_options&.dig(:ssl_params, :cert) ||
+        client_certificate_from_env ||
+        client_certificate_from_path
+    end
+
+    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
+      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_env ||
+        certificate_authority_from_path
+    end
+
+    private def provided_certificate_authority
+      @provided_options&.dig(:ssl_params, :ca_file)
+    end
+
+    private def certificate_authority_from_env
+      ENV['REDIS_SSL_CERTIFICATE_AUTHORITY']
+    end
+
+    private def certificate_authority_from_path
+      File.read(fetch_key('REDIS_SSL_CERTIFICATE_AUTHORITY_PATH'))
+    end
+
+    private def fetch_key(key)
+      ENV.fetch(key) { missing_key(key) }
+    end
+
+    private def missing_key(key)
+      raise InvalidConfiguration, "#{key} is not defined"
+    end
+  end
+end

data/lib/percy/stats.rb

@@ -44,15 +44,31 @@ module Percy
       # Programmer mistake, so raise an error.
       raise 'no timing started' unless @_timing_start
 
-      time_since(stat, @_timing_start, options)
+      time_since_monotonic(stat, @_timing_start, options)
       @_timing_start = nil
       true
     end
 
-    def time_since(stat, start, opts = {})
+    # dogstatsd uses a monotonic (linearly increasing) clock to calculate time
+    # intervals, so this should be used where necessary. However, it's not
+    # possible to compare monotonic time values with fixed times, so both are
+    # available.
+    def time_since_monotonic(stat, start, opts = {})
+      unless start.instance_of? Float
+        raise ArgumentError, 'start value must be Float'
+      end
+
       timing(stat, ((now.to_f - start.to_f) * 1000).round, opts)
     end
 
+    def time_since(stat, start, opts = {})
+      unless start.instance_of? Time
+        raise ArgumentError, 'start value must be Time'
+      end
+
+      timing(stat, ((Time.now.to_f - start.to_f) * 1000).round, opts)
+    end
+
     private def now
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end

data/percy-common.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'percy/common/version'
 
@@ -9,19 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Perceptual Inc.']
   spec.email         = ['team@percy.io']
 
-  spec.summary       = %q{Server-side common library for Percy.}
-  spec.description   = %q{}
+  spec.summary       = 'Server-side common library for Percy.'
+  spec.description   = ''
   spec.homepage      = ''
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end
   spec.require_paths = ['lib']
 
   spec.add_dependency 'dogstatsd-ruby', '~> 4.4.0'
   spec.add_dependency 'excon', '~> 0.57'
+  spec.add_dependency 'redis', '>= 4.1.3', '< 5.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.0.2'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.2'
+  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,64 @@
+#!/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$1.gem" || true
+}
+
+if [[ $1 == 'delete' ]]; then
+  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-$VERSION.gem"
+    open "https://github.com/percy/percy-common/releases/new?tag=v$VERSION&title=$VERSION"
+    rm "$CURDIR/pkg/percy-common-$VERSION.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.0.0
+  version: 3.1.2.rc.1
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -38,76 +38,96 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.57'
+- !ruby/object:Gem::Dependency
+  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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: percy-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: percy-style
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '3.2'
 description: ''
 email:
 - team@percy.io
@@ -119,6 +139,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -132,8 +153,10 @@ files:
 - lib/percy/logger.rb
 - lib/percy/network_helpers.rb
 - lib/percy/process_helpers.rb
+- lib/percy/redis_client.rb
 - lib/percy/stats.rb
 - percy-common.gemspec
+- release.sh
 homepage: ''
 licenses: []
 metadata: {}
@@ -148,12 +171,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Server-side common library for Percy.