percy-common 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e83edb8522d97d14d009c557cc1cf30e9dfb8e14
-  data.tar.gz: ed41e132239c852c14c9db2387f075cf200ec694
+SHA256:
+  metadata.gz: fe94763bb303e12d788d293e1b2a1947fccfb61a1334a04c71179f99590ab639
+  data.tar.gz: 113a9533d5286c9753d21df7d631b2f6c64601680cd698db5600503d9e638c23
 SHA512:
-  metadata.gz: 20290f9419c06622b11192f2a40de6265593e868d2ee70cf9d9cd5a4443fb9c38db76246f75ca95438e4a405f399c3bf4c0267ddd3daca2676990d87ece77905
-  data.tar.gz: ba60224166e45dbd34f6919d27b2bff99c4d660d78dab56002240a358678d43fe02f30b22ed9fa8107eb1ca04f2fb796f0ce9c48b9d718d9c6193cba9fa1ff74
+  metadata.gz: 6ea47390164289c6a3402ce8f108f19ba698a69d1b2fb50dcaa58d12961ab10c18a74e1d54ed47e268a827b9851986136766ab436397b5bf475d690631a65f09
+  data.tar.gz: 1ae7c46e24ff481bb6d986d0cdfdca18450c27b350cb89d0938cd54101f4fc8f8edcd518220b64339edbb14b9846beb7390bffab59f2c94100350614ca736f24

data/.circleci/config.yml

@@ -0,0 +1,18 @@
+version: 2.1
+
+jobs:
+  ruby_25:
+    docker:
+      - image: circleci/ruby:2.5-node-browsers
+    steps:
+      - checkout
+      - run: gem update --system
+      - run: gem install bundler
+      - run: bundle install
+      - run: bundle exec rubocop -D
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - ruby_25

data/.rubocop.yml

@@ -2,6 +2,14 @@ inherit_gem:
   percy-style:
     - default.yml
 
+inherit_mode:
+  merge:
+    - Include
+
 RSpec/DescribeClass:
   Exclude:
     - spec/percy/logger_spec.rb
+
+AllCops:
+  Exclude:
+    - spec/support/redis_mock.rb

data/lib/percy/common/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Common
-    VERSION = '2.1.0'.freeze
+    VERSION = '3.1.0'.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,80 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+module Percy
+  class RedisClient
+    attr_reader :options
+    attr_reader :client
+
+    def initialize(options = {})
+      @options = options
+      @client = ::Redis.new(
+        options.merge(
+          ssl: ssl_enabled?,
+          ssl_params: ssl_params,
+        ),
+      )
+    end
+
+    private def ssl_enabled?
+      provided_url.to_s.start_with?('rediss://')
+    end
+
+    private def provided_url
+      options.dig(:url)
+    end
+
+    private def ssl_params
+      return {} unless ssl_enabled?
+
+      {
+        ca_file: certificate_authority_file,
+        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),
+      )
+    end
+
+    private def client_certificate_path
+      ENV.fetch(
+        'REDIS_SSL_CLIENT_CERTIFICATE_PATH',
+        File.join(cert_path, 'user.crt'),
+      )
+    end
+
+    private def private_key
+      ENV.fetch(
+        'REDIS_SSL_PRIVATE_KEY',
+        File.read(private_key_path),
+      )
+    end
+
+    private def private_key_path
+      ENV.fetch(
+        'REDIS_SSL_PRIVATE_KEY_PATH',
+        File.join(cert_path, 'user_private.key'),
+      )
+    end
+
+    private def certificate_authority_file
+      ENV.fetch(
+        'REDIS_SSL_CERTIFICATE_AUTHORITY_PATH',
+        File.join(cert_path, 'server_ca.pem'),
+      )
+    end
+
+    private def cert_path
+      ENV.fetch(
+        'REDIS_SSL_CERTIFICATE_PATH',
+        File.expand_path('../../redis', __dir__),
+      )
+    end
+  end
+end

data/lib/percy/stats.rb

@@ -3,41 +3,74 @@ require 'time'
 
 module Percy
   class Stats < ::Datadog::Statsd
-    def initialize(host = nil, port = nil, opts = {}, max_buffer_size = 50)
-      host ||= ENV.fetch('DATADOG_AGENT_HOST', ::Datadog::Statsd::DEFAULT_HOST)
-      port ||= Integer(ENV.fetch('DATADOG_AGENT_PORT', ::Datadog::Statsd::DEFAULT_PORT))
-      opts[:tags] ||= []
-      opts[:tags] << "env:#{ENV['PERCY_ENV'] || 'development'}"
-      retry_delay = opts[:retry_delay] || 1
-      retry_count = opts[:retry_count] || 3
-      retries = 0
-
-      begin
-        super(host, port, opts, max_buffer_size)
-      rescue SocketError
-        host = 'localhost' if retries >= retry_count
-        sleep retry_delay
-        retries += 1
-        retry
-      end
+    DEFAULT_HOST = ENV.fetch(
+      'DATADOG_AGENT_HOST',
+      ::Datadog::Statsd::Connection::DEFAULT_HOST,
+    )
+
+    DEFAULT_PORT = Integer(
+      ENV.fetch(
+        'DATADOG_AGENT_PORT',
+        ::Datadog::Statsd::Connection::DEFAULT_PORT,
+      ),
+    )
+
+    DEFAULT_TAGS = %W[
+      env:#{ENV.fetch('PERCY_ENV', 'development')}
+    ].freeze
+
+    def initialize(
+      host = DEFAULT_HOST,
+      port = DEFAULT_PORT,
+      tags: DEFAULT_TAGS,
+      **kwargs
+    )
+      super(host, port, tags: tags, **kwargs)
     end
 
-    # Equivalent to stats.time, but without wrapping in blocks and dealing with var scoping issues.
+    # Equivalent to stats.time, but without wrapping in blocks and dealing with
+    # var scoping issues.
     #
     # @example Report the time taken to activate an account.
     #   stats.start_timing
     #   account.activate!
     #   stats.stop_timing('account.activate')
     def start_timing
-      @_timing_start = Time.now
+      @_timing_start = now
       true
     end
 
     def stop_timing(stat, options = {})
-      raise 'no timing started' unless @_timing_start # Programmer mistake, so raise an error.
-      time_since(stat, @_timing_start, options)
+      # Programmer mistake, so raise an error.
+      raise 'no timing started' unless @_timing_start
+
+      time_since_monotonic(stat, @_timing_start, options)
       @_timing_start = nil
       true
     end
+
+    # 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
   end
 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', '~> 3.1'
+  spec.add_dependency 'dogstatsd-ruby', '~> 4.4.0'
   spec.add_dependency 'excon', '~> 0.57'
+  spec.add_dependency 'redis', '~> 4.1.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  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'
+  spec.add_development_dependency 'percy-style', '~> 0.6.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-common
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -38,76 +38,90 @@ 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        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.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.6.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'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 description: ''
 email:
 - team@percy.io
@@ -115,10 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -132,6 +146,7 @@ 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
 homepage: ''
@@ -152,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Server-side common library for Percy.

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-rvm:
-  - 2.4
-  - ruby-head
-before_install:
-  - gem update --system
-  - gem update bundler
-script:
-  - bundle exec rubocop -D
-  - bundle exec rspec