soar_http_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ec3312c5769249580b806e50ed7aef6797ed006
+  data.tar.gz: 18c1edef34cfa405139f6151db4fd97383a9b6a1
+SHA512:
+  metadata.gz: 195f38d6eabc7bfdfa9562afe2adeedf422685b7003973ba5f188b114079d80e3d741ee5aa22e72f14ddb43658c0d2dd61ea8f60c367b4714548e8051b04e7a2
+  data.tar.gz: 0a31397dd5d9633bf930d6f6021b4cda8e794c887a9c2858ec1d183ff5c2062a5376906b212145d73d6fa99e0c1844c772eef359d628b151d2dc142472c1ecb2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+soar_http_client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tiaanvandeventer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:2.3.0
+
+RUN uname -r
+
+WORKDIR /usr/local/src/
+
+ADD . /usr/local/src/
+RUN cd /usr/local/src/
+RUN gem install bundler
+
+RUN bundler
+
+RUN chmod -R o+rwx /usr/local/bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soar_http_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tiaan van Deventer
+
+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,86 @@
+# SoarHttpClient
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_http_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_http_client
+
+## Usage
+All HTTP verbs are supported.
+### GET
+```ruby
+  client = SoarHttpClient.new(url: "http://localhost")
+  response = client.get(
+    path: '/folder1', params: { 'param1' => 'somedata' }
+  )
+  response.status  #==> 200
+  response.body    #==> 'body data'
+```
+
+### POST
+```ruby
+  client = SoarHttpClient.new(url: "http://localhost")
+  response = client.post(
+    path: '/folder1', body: { 'param1' => 'somedata' }
+  )
+  response.status  #==> 200
+  response.body    #==> 'body data'
+```
+
+### Connection options
+#### persistent_connection
+Persistent connections is support by NetHttpPersistent. By default persistent connections are turned off.
+```ruby
+  client = SoarHttpClient.new(url: "http://localhost", persistent_connection: true)
+```
+#### timeout
+The default timeout value is 5 seconds. This sets the open_timeout and read_timeout value.
+```ruby
+  client = SoarHttpClient.new(url: "http://localhost", timeout: 10)
+```
+#### Retries
+Default retry value is 2
+```ruby
+  client = SoarHttpClient.new(url: "http://localhost", retries: 3)
+```
+#### Auditing
+Retries and Max retries reached can be audited by passing in a configured instance of SoarAuditingProvider with the auditing parameter.
+```ruby
+  client = SoarHttpClient.new(url: "http://localhost", auditing: auditing)
+```
+
+#### Basic Auth
+```ruby
+  client = SoarHttpClient.new(url: "http://localhost", basic_auth: { user: 'user', password: 'secret' })
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Running specs in docker
+```
+docker-compose build --force-rm --no-cache
+docker-compose run -u $UID:$UID --rm soar-http-client /bin/bash -c 'bundle exec rspec'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hetznerZA/soar_http_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soar_http_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,7 @@
+version: '2.0'
+services:
+  soar-http-client:
+    build: .
+    image: soar-http-client
+    volumes:
+      - .:/usr/local/src/

data/lib/soar_http_client.rb

@@ -0,0 +1,82 @@
+require "soar_http_client/version"
+require 'faraday'
+
+class SoarHttpClient
+  attr_reader :url, :connection, :retries, :auditing, :persistent_connection, :min_sleep_seconds, :max_sleep_seconds
+
+  def initialize(url:, retries: 2, auditing: nil, persistent_connection: false, timeout: 5, basic_auth: nil, min_sleep_seconds: 0.5, max_sleep_seconds: 1)
+    @semaphore = Mutex.new
+    @semaphore.synchronize {
+      @url = url
+      @retries = retries
+      @auditing = auditing
+      @persistent_connection = persistent_connection
+      @min_sleep_seconds = min_sleep_seconds
+      @max_sleep_seconds = max_sleep_seconds
+
+      @connection = Faraday.new(:url => @url) do |faraday|
+        faraday.options[:open_timeout] = timeout
+        faraday.options[:timeout] = timeout
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter if persistent_connection == false
+        faraday.adapter :net_http_persistent if persistent_connection == true
+        faraday.basic_auth 'user', 'pass' if basic_auth && (basic_auth[:user] && basic_auth[:password])
+      end
+    }
+  end
+
+
+  def get(path:, params: nil, body: nil, token: nil, headers: nil, flow_identifier: nil)
+    do_request(verb: 'get', path: path, params: params, body: body, token: token, headers: headers, flow_identifier: flow_identifier)
+  end
+
+  def post(path:, params: nil, body: nil, token: nil, headers: nil, flow_identifier: nil)
+    do_request(verb: 'post', path: path, params: params, body: body, token: token, headers: headers, flow_identifier: flow_identifier)
+  end
+
+  def put(path:, params: nil, body: nil, token: nil, headers: nil, flow_identifier: nil)
+    do_request(verb: 'put', path: path, params: params, body: body, token: token, headers: headers, flow_identifier: flow_identifier)
+  end
+
+  def patch(path:, params: nil, body: nil, token: nil, headers: nil, flow_identifier: nil)
+    do_request(verb: 'patch', path: path, params: params, body: body, token: token, headers: headers, flow_identifier: flow_identifier)
+  end
+
+  def delete(path:, params: nil, body: nil, token: nil, headers: nil, flow_identifier: nil)
+    do_request(verb: 'delete', path: path, params: params, body: body, token: token, headers: headers, flow_identifier: flow_identifier)
+  end
+
+  private
+  def do_request(verb: ,path:, params: nil, body: nil, token: nil, headers: nil, flow_identifier: nil)
+    @semaphore.synchronize {
+      begin
+        tries ||= 0
+
+        result = @connection.send(verb) do |req|
+          req.url path
+          req.params = params if params
+          req.body = body if body
+          req.headers['Authorization'] = token if token
+          req.headers = headers if headers
+        end
+      rescue => ex
+        tries += 1
+        back_off(tries)
+        retry if(tries < retries)
+        @auditing.audit_exception(exception: ex, flow_id: flow_identifier, message: "Max allowed retries reached, while doing HTTP #{verb.upcase} #{@url + path}") if @auditing != nil
+        raise ex
+      else
+        @auditing.warn("Retried #{tries} times, while doing HTTP #{verb.upcase} #{@url + path}", flow_identifier) if tries > 0 && @auditing != nil
+        return result
+      end
+    }
+  end
+
+  def back_off(attempt)
+    sleep_seconds = [@min_sleep_seconds * (2 ** (attempt - 1)), @max_sleep_seconds].min
+    sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
+    sleep_seconds = [@min_sleep_seconds, sleep_seconds].max
+
+    sleep sleep_seconds
+  end
+end

data/lib/soar_http_client/version.rb

@@ -0,0 +1,3 @@
+class SoarHttpClient
+  VERSION = "0.1.0"
+end

data/soar_http_client.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_http_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_http_client"
+  spec.version       = SoarHttpClient::VERSION
+  spec.authors       = ["Tiaan van Deventer"]
+  spec.email         = ["tiaanvandeventer@gmail.com"]
+
+  spec.summary       = %q{Rest client for services at Hetzner}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.11.0'
+  #Faraday not compatible with net-http-persistent v3.0.0
+  spec.add_dependency 'net-http-persistent', '~> 2.9.4'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3.2"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-rcov"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: soar_http_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tiaan van Deventer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  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: ''
+email:
+- tiaanvandeventer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/soar_http_client.rb
+- lib/soar_http_client/version.rb
+- soar_http_client.gemspec
+homepage: ''
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Rest client for services at Hetzner
+test_files: []