freno-client 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad998991ce9e268582944b14bcad1f95b3f256ae
+  data.tar.gz: 858a1e5eab82112e90e44559cc64f14a57eef065
+SHA512:
+  metadata.gz: d550f31be8158f7ec916d3b76475c8ec15e04e6039cc34473049ad276097397df72c1139bfd421175b1792eba997763fffadcd9023d4860eef6096f23040d024
+  data.tar.gz: c6c3826a47449958d2030fc8f8904eeba9cee2aeb72890fa6803d0c287542c13814df6934b0b47d03cb418544cef7a856623591700b4d149ca5ba4df0edd261b

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/
+/vendor/gems
+.ruby-version

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource+freno-client@github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+## Contributing
+
+[fork]: https://github.com/github/freno-client/fork
+[pr]: https://github.com/github/freno-client/compare
+[style]: https://github.com/styleguide/ruby
+[code-of-conduct]: CODE_OF_CONDUCT.md
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
+
+## Submitting a pull request
+
+0. [Fork][fork] and clone the freno-clientsitory
+0. Configure and install the dependencies: `script/bootstrap`
+0. Make sure the tests pass on your machine: `rake`
+0. Create a new branch: `git checkout -b my-branch-name`
+0. Make your change, add tests, and make sure the tests still pass
+0. Push to your fork and [submit a pull request][pr]
+0. Pat your self on the back and wait for your pull request to be reviewed and merged.
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Write tests.
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,202 @@
+# Freno::Client
+
+A ruby client for [Freno](https://github.com/github/freno): the cooperative, highly available throttler service.
+
+## Current status
+
+`Freno::Client`, as [Freno](https://github.com/github/freno) itself, is in active development and its API can still change.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "freno-client"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freno-client
+
+## Usage
+
+`Freno::Client` uses [faraday](https://github.com/lostisland/faraday) to abstract the http client of your choice:
+
+To start using the client, give it a faraday instance pointing to Freno's base URL.
+
+```ruby
+require 'freno/client'
+
+FRENO_URL = "http://freno.domain.com:8111"
+faraday   = Faraday.new(FRENO_URL)
+freno     = Freno::Client.new(faraday)
+
+freno.check?(app: :my_app, store_name: :my_cluster)
+# => true
+
+freno.replication_delay(app: :my_app, store_name: :my_cluster)
+# => 0.125
+```
+
+### Providing sensible defaults
+
+If most of the times you are going to ask Freno about the same app and/or storage name, you can tell the client to use some defaults, and override them as necessary.
+
+```ruby
+freno = Freno::Client.new(faraday) do |client|
+  client.default_store_name = :my_cluster
+  client.default_app        = :my_app
+end
+
+freno.check?
+# => true (Freno thinks that `my_app` can write to `main` storage)
+
+freno.check?(app: :another_app, store_name: :another_storage)
+# => false (Freno thinks that `another_app` should not write to `another_storage`)
+```
+
+### What can I do with the client?
+
+#### Asking whether an app can write to a certain storage. ([`check` requests](https://github.com/github/freno/blob/master/doc/http.md#check-requests))
+
+If we want to get a deep sense on why freno allowed or not, writing to a certain storage.
+
+```ruby
+result = freno.check(app: :my_app, store_name: :my_cluster)
+# => #<Freno::Client::Requests::Result ...>
+
+result.ok?
+# => false
+
+result.failed?
+# => true
+
+result.code
+# => 429
+
+result.meaning
+# => :too_many_requests
+```
+
+Or if we only want to know if we can write:
+
+```ruby
+result = freno.check?(app: :my_app, store_name: :my_cluster)
+# => true or false (a shortcut for `check.ok?`)
+```
+
+#### Asking whether replication delay is below a certain threshold. ([`check-read` requests](https://github.com/github/freno/blob/master/doc/http.md#specialized-requests))
+
+```ruby
+result = freno.check_read(threshold: 0.5, app: :my_app, store_name: :my_cluster)
+# => #<Freno::Client::Requests::Result ...>
+
+result.ok?
+# => true
+
+result.failed?
+# => false
+
+result.code
+# => 200
+
+result.meaning
+# => :ok
+```
+
+Or if we only want to know if we can read:
+
+```ruby
+freno.check?(threshold: 0.5, app: :my_app, store_name: :my_cluster)
+# => true or false (a shortcut for `check_read.ok?`)
+```
+
+#### Asking what's the replication delay
+
+Freno's response to [`GET /check`](https://github.com/github/freno/blob/master/doc/http.md#get-method) includes the replication delay value in seconds. The `replication_delay` method in the client returns this information.
+
+```ruby
+freno.replication_delay(app: :my_app, store_name: :my_cluster)
+# => 0.125
+```
+
+#### Cross-cutting concerns with decorators
+
+Decorators can be used augment the client with custom features.
+
+A decorator is anything that has a `:request` accessor and can forward the execution of `perform` to it.
+
+The following is an example of a decorator implementing a read-trough cache.
+
+```ruby
+class Cache
+  attr_accessor :request
+
+  def initialize(cache, ttl)
+    @cache = cache
+    @ttl = ttl
+  end
+
+  def perform(**kwargs)
+    @cache.fetch("freno:client:v1:#{args.hash}", ttl: @ttl) do
+      request.perform(kwargs)
+    end
+  end
+end
+```
+
+You can use it to decorate a single kind of request to freno:
+
+```ruby
+freno = Freno::Client.new(faraday) do |client|
+  client.decorate :replication_delay, with: Cache.new(App.cache, App.config.ttl)
+end
+```
+
+Or every kind of request:
+
+```ruby
+freno = Freno::Client.new(faraday) do |client|
+  client.decorate :all, with: Cache.new(App.cache, App.config.ttl)
+end
+```
+
+Additionally, decorators can be composed in multiple ways. The following client
+applies logging and instrumentation to all the requests, and it also applies caching, **before** the previous concerns, to `replication_delay` requests.
+
+```ruby
+freno = Freno::Client.new(faraday) do |client|
+  client.decorate :replication_delay, with: caching
+  client.decorate :all, with: [logging, instrumentation]  
+end
+```
+
+
+## Development
+
+After checking out the repo, run `script/bootstrap` to install dependencies. Then, run `script/test` to run the tests. You can also run `script/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+This repository is open to [contributions](CONTRIBUTING.md). Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Releasing
+
+If you are the current maintainer of this gem:
+
+1. Create a branch for the release: `git checkout -b cut-release-vx.y.z`
+1. Make sure your local dependencies are up to date: `script/bootstrap`
+1. Ensure that tests are green: `bundle exec rake test`
+1. Bump gem version in `lib/freno/client/version.rb`
+1. Merge a PR to github/freno-client containing the changes in the version file
+1. Tag and push: `git tag vx.xx.xx; git push --tags`
+1. Build the gem: `gem build freno-client`
+1. Push to rubygems.org: `gem push freno-client-x.y.z.gem`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/freno-client.gemspec

@@ -0,0 +1,38 @@
+# -- encoding: utf-8 --
+$:.unshift File.expand_path('../lib', __FILE__)
+require_relative 'lib/freno/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = "freno-client"
+  spec.version               = Freno::Client::VERSION
+  spec.authors               = ["Miguel Fernández"]
+  spec.email                 = ["opensource+freno-client@github.com"]
+
+  spec.summary               = %q{A library for interacting with freno, the throttler service}
+  spec.description           = %q{freno-client is a ruby library that interacts with
+                                  Freno using HTTP. Freno is a throttling service and its
+                                  source code is available at https://github.com/github/freno}
+  spec.homepage              = "https://github.com/github/freno-client"
+  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'
+  # 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"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "faraday", "~> 0"
+end

data/lib/freno/client.rb

@@ -0,0 +1,182 @@
+require "freno/client/version"
+require "freno/client/requests/check_read"
+require "freno/client/requests/check"
+require "freno/client/requests/replication_delay"
+
+module Freno
+  class Client
+
+    REQUESTS = {
+      check:             Requests::Check,
+      check_read:        Requests::CheckRead,
+      replication_delay: Requests::ReplicationDelay,
+    }
+
+    attr_reader   :faraday, :decorators, :decorated_requests
+    attr_accessor :default_app, :default_store_name, :default_store_type, :options
+
+    # Creates a new instance of the client, that uses faraday to make http calls.
+    #
+    # If most of the times you are going to ask Freno about the same app and/or storage name,
+    # you can tell the client to use some defaults, and override them as necessary.
+    #
+    # Examples a ruby client that by default asks Freno for throttling information
+    # about `:my_app` accessing `:my_cluster` storage.
+    #
+    #  ```ruby
+    #  freno = Freno::Client.new(faraday) do |client|
+    #    client.default_store_name = :my_cluster
+    #    client.default_app        = :my_app
+    #  end
+    #  ```
+    #
+    def initialize(faraday)
+      @faraday            = faraday
+      @default_store_type = :mysql
+      @options            = {}
+      @decorators         = {}
+      @decorated_requests = {}
+
+      yield self if block_given?
+    end
+
+    # Provides an interface to Freno's check request
+    #
+    # See https://github.com/github/freno/blob/master/doc/http.md#check-request
+    #
+    # Returns Result
+    #
+    def check(app: default_app, store_type: default_store_type, store_name: default_store_name, options: self.options)
+      perform :check, app: app, store_type: store_type, store_name: store_name, options: options
+    end
+
+    # Provides an interface to Freno's check-read request
+    #
+    # See https://github.com/github/freno/blob/master/doc/http.md#specialized-requests
+    #
+    # Returns Result
+    #
+    def check_read(threshold:, app: default_app, store_type: default_store_type, store_name: default_store_name, options: self.options)
+      perform :check_read, app: app, store_type: store_type, store_name: store_name, threshold: threshold, options: options
+    end
+
+    # Implements a specific check request to retrieve the consolidated replication
+    # delay
+    #
+    # See https://github.com/github/freno/blob/master/doc/http.md#get-method
+    #
+    # Returns Float indicating the replication delay in seconds as reported by Freno.
+    #
+    def replication_delay(app: default_app, store_type: default_store_type, store_name: default_store_name, options: self.options)
+      perform :replication_delay, app: app, store_type: store_type, store_name: store_name, options: options
+    end
+
+
+    # Determines whether Freno considers it's OK to write to masters
+    #
+    # Returns true or false.
+    #
+    def check?(app: default_app, store_type: default_store_type, store_name: default_store_name, options: self.options)
+      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
+    # the given threshold.
+    #
+    # Returns true or false.
+    #
+    def check_read?(threshold:, app: default_app, store_type: default_store_type, store_name: default_store_name, options: self.options)
+      check_read(threshold: threshold, app: app, store_type: store_type, store_name: store_name, options: options).ok?
+    end
+
+    # Configures the client to extend the functionality of part or all the API
+    # by means of decorators.
+    #
+    # A decorator is any object that has a `:request` accessor and can forward
+    # the execution of `perform` to it.
+    #
+    # Examples:
+    #
+    # The following is a decorator implementing a read-trough cache.
+    #
+    # ```ruby
+    # class Cache
+    #   attr_accessor :request
+    #
+    #   def initialize(cache, ttl)
+    #     @cache = cache
+    #     @ttl = ttl
+    #   end
+    #
+    #   def perform(**kwargs)
+    #     @cache.fetch("freno:client:v1:#{args.hash}", ttl: @ttl) do
+    #       request.perform(kwargs)
+    #     end
+    #   end
+    # end
+    # ```
+    #
+    # You can use it to decorate a single kind of request to freno:
+    #
+    # ```ruby
+    # freno = Freno::Client.new(faraday) do |client|
+    #   client.decorate :replication_delay, with: Cache.new(App.cache, App.config.ttl)
+    # end
+    # ```
+    #
+    # Or every kind of request:
+    #
+    # ```ruby
+    # freno = Freno::Client.new(faraday) do |client|
+    #   client.decorate :all, with: Cache.new(App.cache, App.config.ttl)
+    # end
+    # ```
+    #
+    # Additionally, decorators can be composed in multiple ways. The following client
+    # applies logging and instrumentation to all the requests, and it also applies caching,
+    # **before** the previous concerns, to `replication_delay` requests.
+    #
+    # ```ruby
+    # freno = Freno::Client.new(faraday) do |client|
+    #   client.decorate :replication_delay, with: caching
+    #   client.decorate :all, with: [logging, instrumentation]
+    # end
+    # ```
+    #
+    def decorate(request, with:)
+      if request == :all
+        requests = REQUESTS.keys
+      else
+        requests = Array(request)
+      end
+
+      requests.each do |request|
+        decorators[request] ||= []
+        decorators[request] += Array(with)
+        decorated_requests[request] = nil
+      end
+    end
+
+    private
+
+    def perform(request, **kwargs)
+      decorated(request).perform(kwargs.merge(faraday: faraday))
+    end
+
+    def decorated(request)
+      decorated_requests[request] ||= begin
+        to_decorate = Array(decorators[request]) + Array(REQUESTS[request])
+
+        outermost = to_decorate[0]
+        current = outermost
+
+        (to_decorate[1..-1]).each do |decorator|
+          current.request = decorator
+          current = current.request
+        end
+
+        outermost
+      end
+    end
+  end
+end

data/lib/freno/client/preconditions.rb

@@ -0,0 +1,35 @@
+module Freno
+  class Client
+    module Preconditions
+      extend self
+
+      PreconditionNotMet = Class.new(ArgumentError)
+
+      class Checker
+        attr_reader :errors
+
+        def initialize
+          @errors = []
+        end
+
+        def present(args = {})
+          args.each do |arg, value|
+            unless value
+              errors << "#{arg} should be present"
+            end
+          end
+        end
+
+        def report
+          raise PreconditionNotMet.new(errors.join("\n")) unless errors.empty?
+        end
+      end
+
+      def check(&block)
+        checker = Checker.new
+        checker.instance_eval(&block)
+        checker.report
+      end
+    end
+  end
+end

data/lib/freno/client/request.rb

@@ -0,0 +1,60 @@
+require_relative 'preconditions'
+require_relative 'result'
+
+module Freno
+  class Client
+    class Request
+
+      include Freno::Client::Preconditions
+
+      attr_reader :faraday, :args, :options
+      attr_reader :raise_on_timeout
+
+      def self.perform(**kwargs)
+        new(kwargs).perform
+      end
+
+      def initialize(**kwargs)
+        @args    = kwargs
+        @faraday = kwargs.delete(:faraday) || nil
+        @options = kwargs.delete(:options) || Hash.new
+
+        @raise_on_timeout = options.fetch(:raise_on_timeout, true)
+        @verb = options.fetch(:verb, :head)
+      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
+      end
+
+      protected
+
+      def request(verb, path)
+        faraday.send(verb, path)
+      end
+
+      def path
+        @path || begin
+          raise NotImplementedError("must be overriden in specific requests, or memoized in @path")
+        end
+      end
+
+      def verb
+        @verb || begin
+          raise NotImplementedError("must be overriden in specific requests, or memoized in @verb")
+        end
+      end
+
+      def process_response(response)
+        Result.from_faraday_response(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative '../request'
+
+module Freno
+  class Client
+    module Requests
+      class Check < Request
+
+        def initialize(**kwargs)
+          super
+
+          app        = kwargs.fetch(:app)
+          store_type = kwargs.fetch(:store_type)
+          store_name = kwargs.fetch(:store_name)
+
+          check do
+            present app: app, store_type: store_type, store_name: store_name
+          end
+
+          @path = "check/#{app}/#{store_type}/#{store_name}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative '../request'
+
+module Freno
+  class Client
+    module Requests
+      class CheckRead < Request
+
+        def initialize(**kwargs)
+          super
+
+          app        = kwargs.fetch(:app)
+          store_type = kwargs.fetch(:store_type)
+          store_name = kwargs.fetch(:store_name)
+          threshold  = kwargs.fetch(:threshold)
+
+          check do
+            present app: app, store_type: store_type, store_name: store_name, threshold: threshold
+          end
+
+          @path = "check-read/#{app}/#{store_type}/#{store_name}/#{threshold.to_f.round(3)}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative '../request'
+
+module Freno
+  class Client
+    module Requests
+      class ReplicationDelay < Check
+
+        protected
+
+        def process_response(*)
+          response = super
+          response.body["Value"]
+        end
+
+        def verb
+          :get
+        end
+      end
+    end
+  end
+end

data/lib/freno/client/result.rb

@@ -0,0 +1,62 @@
+require 'json'
+
+module Freno
+  class Client
+    class Result
+
+      # https://github.com/github/freno/blob/master/doc/http.md#status-codes
+      FRENO_STATUS_CODE_MEANINGS = {
+        200 => :ok,
+        404 => :not_found,
+        417 => :expectation_failed,
+        429 => :too_many_requests,
+        500 => :internal_server_error
+      }.freeze
+
+      # these are included to add resiliency to freno-client
+      ADDITIONAL_STATUS_CODE_MEANINGS = {
+        408 => :request_timeout
+      }.freeze
+
+      CODE_MEANINGS = FRENO_STATUS_CODE_MEANINGS.merge(ADDITIONAL_STATUS_CODE_MEANINGS).freeze
+      MEANING_CODES = CODE_MEANINGS.invert.freeze
+
+      def self.from_faraday_response(response)
+        new(response.status, response.body)
+      end
+
+      def self.from_meaning(meaning)
+        new(MEANING_CODES[meaning] || 0)
+      end
+
+      attr_reader :code, :meaning, :raw_body
+
+      def initialize(code, body = nil)
+        @code = code
+        @meaning = CODE_MEANINGS[code] || :unknown
+        @raw_body = body
+      end
+
+      def ok?
+        meaning == :ok
+      end
+
+      def failed?
+        !ok?
+      end
+
+      def unkown?
+        meaning == :unkown
+      end
+
+      def body
+        @body ||= JSON.parse(raw_body) if raw_body
+      end
+
+      def ==(other)
+        return meaning == other if other.is_a? Symbol
+        code == other
+      end
+    end
+  end
+end

data/lib/freno/client/version.rb

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

data/script/bootstrap

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+bundle config --local path vendor/gems
+
+bundle check > /dev/null 2>&1 || bundle install

data/script/cibuild

@@ -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 rake

data/script/console

@@ -0,0 +1,2 @@
+#!/bin/sh
+exec bundle exec irb -r "freno/client" "$@"

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: freno-client
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Miguel Fernández
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  freno-client is a ruby library that interacts with
+                                    Freno using HTTP. Freno is a throttling service and its
+                                    source code is available at https://github.com/github/freno
+email:
+- opensource+freno-client@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freno-client.gemspec
+- lib/freno/client.rb
+- lib/freno/client/preconditions.rb
+- lib/freno/client/request.rb
+- lib/freno/client/requests/check.rb
+- lib/freno/client/requests/check_read.rb
+- lib/freno/client/requests/replication_delay.rb
+- lib/freno/client/result.rb
+- lib/freno/client/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+homepage: https://github.com/github/freno-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A library for interacting with freno, the throttler service
+test_files: []