freno-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad998991ce9e268582944b14bcad1f95b3f256ae
-  data.tar.gz: 858a1e5eab82112e90e44559cc64f14a57eef065
+  metadata.gz: fe5c746dd4f13a74f1d005ef02525980186175a2
+  data.tar.gz: b77184aa9a5e0a98116e6444d61405cf2f0a5cc2
 SHA512:
-  metadata.gz: d550f31be8158f7ec916d3b76475c8ec15e04e6039cc34473049ad276097397df72c1139bfd421175b1792eba997763fffadcd9023d4860eef6096f23040d024
-  data.tar.gz: c6c3826a47449958d2030fc8f8904eeba9cee2aeb72890fa6803d0c287542c13814df6934b0b47d03cb418544cef7a856623591700b4d149ca5ba4df0edd261b
+  metadata.gz: e969f338ff696426546ea5c1906f8665b77ba8088aa1ed7146b8e9e4d701e42b779b8834ca92060e0c4bd322e9c7ccbaf4405bea7cde6abe0a7177a91c12fd24
+  data.tar.gz: 7a2f7982b3027e94a4bf02b340a8cf538f7f26cfd8cbd1916591de9083afec49ccd4a7752634ca85bdf29805ddb7855da01eade6d3cd254c8a21e0182eec77a8

data/.rubocop.yml

@@ -0,0 +1,317 @@
+AllCops:
+  DisabledByDefault: true
+
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: true
+
+Lint/BlockAlignment:
+  Enabled: true
+
+Lint/CircularArgumentReference:
+  Enabled: true
+
+Lint/ConditionPosition:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Lint/DefEndAlignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/DuplicatedKey:
+  Enabled: true
+
+Lint/EachWithObjectArgument:
+  Enabled: true
+
+Lint/ElseLayout:
+  Enabled: true
+
+Lint/EmptyEnsure:
+  Enabled: true
+
+Lint/EndInMethod:
+  Enabled: true
+
+Lint/EmptyInterpolation:
+  Enabled: true
+
+Lint/EndAlignment:
+  Enabled: false
+
+Lint/EnsureReturn:
+  Enabled: true
+
+Lint/FloatOutOfRange:
+  Enabled: true
+
+Lint/FormatParameterMismatch:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: ruby19
+
+Lint/InvalidCharacterLiteral:
+  Enabled: true
+
+Lint/LiteralInCondition:
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Enabled: true
+
+Lint/Loop:
+  Enabled: true
+
+Lint/NextWithoutAccumulator:
+  Enabled: true
+
+Lint/RandOne:
+  Enabled: true
+
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/RescueException:
+  Enabled: true
+
+Lint/StringConversionInInterpolation:
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Lint/UnneededDisable:
+  Enabled: true
+
+Lint/UnneededSplatExpansion:
+  Enabled: true
+
+Lint/UnreachableCode:
+  Enabled: true
+
+Lint/UselessComparison:
+  Enabled: true
+
+Lint/UselessSetterCall:
+  Enabled: true
+
+Lint/Void:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Performance/CaseWhenSplat:
+  Enabled: false
+
+Performance/Count:
+  Enabled: true
+
+Performance/Detect:
+  Enabled: true
+
+Performance/DoubleStartEndWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/HashEachMethods:
+  Enabled: true
+
+Performance/LstripRstrip:
+  Enabled: true
+
+Performance/RangeInclude:
+  Enabled: false
+
+Performance/RedundantMatch:
+  Enabled: false
+
+Performance/RedundantMerge:
+  Enabled: true
+  MaxKeyValuePairs: 1
+
+Performance/RedundantSortBy:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/Sample:
+  Enabled: true
+
+Performance/Size:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Security/Eval:
+  Enabled: true
+
+Style/ArrayJoin:
+  Enabled: true
+
+Style/AsciiIdentifiers:
+  Enabled: true
+
+Style/BeginBlock:
+  Enabled: true
+
+Style/BlockComments:
+  Enabled: true
+
+Layout/BlockEndNewline:
+  Enabled: true
+
+Style/CaseEquality:
+  Enabled: true
+
+Style/CharacterLiteral:
+  Enabled: true
+
+Style/ClassAndModuleCamelCase:
+  Enabled: true
+
+Style/ClassMethods:
+  Enabled: true
+
+Style/Copyright:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/EndBlock:
+  Enabled: true
+
+Layout/EndOfLine:
+  Enabled: true
+
+Style/FileName:
+  Enabled: true
+
+Style/FlipFlop:
+  Enabled: true
+
+Style/For:
+  Enabled: true
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Style/LambdaCall:
+  Enabled: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/MethodName:
+  Enabled: true
+
+Style/MultilineIfThen:
+  Enabled: true
+
+Style/NilComparison:
+  Enabled: true
+
+Style/Not:
+  Enabled: true
+
+Style/OneLineConditional:
+  Enabled: true
+
+Layout/SpaceAfterMethodName:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterNot:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: true
+
+Layout/SpaceInsideBrackets:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+
+Style/StabbyLambdaParentheses:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/Tab:
+  Enabled: true
+
+Layout/TrailingBlankLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true

data/.travis.yml

@@ -1,5 +1,16 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
 before_install: gem install bundler -v 1.14.6
+script:
+  - bundle exec script/cibuild
+  - bundle exec script/cibuild-lint

data/Gemfile

@@ -1,3 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
+
+group :test do
+  gem "rubocop", require: false
+end

data/README.md

@@ -1,4 +1,4 @@
-# Freno::Client
+# Freno Client [![Build Status](https://travis-ci.org/github/freno-client.svg)](https://travis-ci.org/github/freno-client)
 
 A ruby client for [Freno](https://github.com/github/freno): the cooperative, highly available throttler service.
 
@@ -29,7 +29,7 @@ Or install it yourself as:
 To start using the client, give it a faraday instance pointing to Freno's base URL.
 
 ```ruby
-require 'freno/client'
+require "freno/client"
 
 FRENO_URL = "http://freno.domain.com:8111"
 faraday   = Faraday.new(FRENO_URL)

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/freno-client.gemspec

@@ -1,6 +1,6 @@
 # -- encoding: utf-8 --
-$:.unshift File.expand_path('../lib', __FILE__)
-require_relative 'lib/freno/client/version'
+$:.unshift File.expand_path("../lib", __FILE__)
+require_relative "lib/freno/client/version"
 
 Gem::Specification.new do |spec|
   spec.name                  = "freno-client"
@@ -16,10 +16,10 @@ Gem::Specification.new do |spec|
   spec.license               = "MIT"
   spec.required_ruby_version = ">= 2.0.0"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."

data/lib/freno/client.rb

@@ -40,7 +40,7 @@ module Freno
       yield self if block_given?
     end
 
-    # Provides an interface to Freno's check request
+    # Provides an interface to Freno"s check request
     #
     # See https://github.com/github/freno/blob/master/doc/http.md#check-request
     #
@@ -50,7 +50,7 @@ module Freno
       perform :check, app: app, store_type: store_type, store_name: store_name, options: options
     end
 
-    # Provides an interface to Freno's check-read request
+    # Provides an interface to Freno"s check-read request
     #
     # See https://github.com/github/freno/blob/master/doc/http.md#specialized-requests
     #
@@ -72,7 +72,7 @@ module Freno
     end
 
 
-    # Determines whether Freno considers it's OK to write to masters
+    # Determines whether Freno considers it"s OK to write to masters
     #
     # Returns true or false.
     #
@@ -80,7 +80,7 @@ module Freno
       check(app: app, store_type: store_type, store_name: store_name, options: options).ok?
     end
 
-    # Determines whether it's OK to read from replicas as replication delay is below
+    # Determines whether it"s OK to read from replicas as replication delay is below
     # the given threshold.
     #
     # Returns true or false.

data/lib/freno/client/errors.rb

@@ -0,0 +1,3 @@
+module Freno
+  Error = Class.new(StandardError)
+end

data/lib/freno/client/request.rb

@@ -1,5 +1,6 @@
-require_relative 'preconditions'
-require_relative 'result'
+require_relative "preconditions"
+require_relative "result"
+require_relative "errors"
 
 module Freno
   class Client
@@ -24,14 +25,13 @@ module Freno
       end
 
       def perform
-        begin
-          response = request(verb, path)
-        rescue Faraday::TimeoutError => ex
-          raise ex if raise_on_timeout
-          Result.from_meaning(:request_timeout)
-        else
-          process_response(response)
-        end
+        response = request(verb, path)
+        process_response(response)
+      rescue Faraday::TimeoutError => ex
+        raise Freno::Error.new(ex) if raise_on_timeout
+        Result.from_meaning(:request_timeout)
+      rescue => ex
+        raise Freno::Error.new(ex)
       end
 
       protected

data/lib/freno/client/requests/check.rb

@@ -1,4 +1,4 @@
-require_relative '../request'
+require_relative "../request"
 
 module Freno
   class Client

data/lib/freno/client/requests/check_read.rb

@@ -1,4 +1,4 @@
-require_relative '../request'
+require_relative "../request"
 
 module Freno
   class Client

data/lib/freno/client/requests/replication_delay.rb

@@ -1,4 +1,4 @@
-require_relative '../request'
+require_relative "../request"
 
 module Freno
   class Client

data/lib/freno/client/result.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Freno
   class Client

data/lib/freno/client/version.rb

@@ -1,5 +1,5 @@
 module Freno
   class Client
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/script/cibuild-lint

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+set -eu
+
+test -d "/usr/share/rbenv/shims" && {
+  export PATH="/usr/share/rbenv/shims:$PATH"
+  export RBENV_VERSION="2.4.1"
+}
+
+set -x
+git log -n 1 HEAD | cat
+ruby -v
+bundle -v
+set +x
+
+git clean -fd
+
+script/bootstrap
+bundle exec rubocop

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freno-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Miguel Fernández
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -88,6 +89,7 @@ files:
 - bin/setup
 - freno-client.gemspec
 - lib/freno/client.rb
+- lib/freno/client/errors.rb
 - lib/freno/client/preconditions.rb
 - lib/freno/client/request.rb
 - lib/freno/client/requests/check.rb
@@ -97,6 +99,7 @@ files:
 - lib/freno/client/version.rb
 - script/bootstrap
 - script/cibuild
+- script/cibuild-lint
 - script/console
 homepage: https://github.com/github/freno-client
 licenses: