koine-rest_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da36fc4df6eb2531f9c94cb98cfc95e56a0943464a517b73ad1d5845a1944cc0
+  data.tar.gz: ad8f8705d5da75a29caddb8ffae8477fc1e308771b6c559cb113206b9e707fba
+SHA512:
+  metadata.gz: 5137beef343e4fb1d7b038fe7b6f38dcd996acf4203e4bf6796f6492af2d0dc04c727533c7e9033e1f2a2fca990a8e00054ece027306139da27e1b57d1306756
+  data.tar.gz: 795b538464313e54b848a7fa7a405d053b4158069df31e6148e2e7633248fda106abb95deeeed152103fad3c4cab5deeaefe7482c7fe6825dd2f94c79f14d787

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.reek.yml

@@ -0,0 +1,6 @@
+detectors:
+  UtilityFunction:
+    public_methods_only: true
+
+exclude_paths:
+  - spec

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,44 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - '*.gemspec'
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: 'exception'
+
+RSpec/ExampleLength:
+  Max: 10
+  Exclude:
+    - spec/upsell/rest_client/rspec_mock_client_spec.rb
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Exclude:
+    - spec/upsell/rest_client/async_builder_spec.rb
+
+# AllCops:
+#   Exclude:

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Changelog
+----------------
+
+## v1.0.1
+
+Parse requests outside the threads. The fetching of the requests still happens inside threads for async requests
+
+
+## v1.0.0
+
+Add the ability of setting headers to the requests

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 marcelo.jacobus@gmail.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/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koine-rest_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marcelo Jacobus
+
+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,139 @@
+# Koine::RestClient
+
+Another http client with async
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'koine-rest_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koine-rest_client
+
+## Usage
+
+```ruby
+# default configuration for every request
+request = Koine::RestClient::Request.new(
+  base_url: 'http://some.endpoint.com/rest',
+  query_params: { auth_token: 'the-auth-token' },
+  headers: { 'X-Client' => 'The Collest Client' }
+)
+client = Koine::RestClient::Client.new(base_request: request)
+json_response = client.get('foo/bar')
+
+json_response = client.post(
+  'foo/bar',
+  campaign_data,
+  query_params: { auth_token: 'other_rid' } # other auth_token
+)
+
+# or throw on non 200
+
+json_response = client.post(
+  'foo/bar',
+  campaign_data,
+  query_params: { auth_token: nil } # remove auth_token param
+)
+```
+
+If you care for the response details:
+
+```ruby
+
+json_response = client.get('foo/bar') do |response|
+  if response.code == 1
+    raise 'what, really?'
+  end
+end
+```
+
+### Async calls
+
+```ruby
+data = client.async do |builder|
+  builder.get('foo', rid: 'bar') do |response|
+  builder.get('bar') do |response|
+    Rails.logger.log(response)
+  end
+
+  builder.post('baz', { payload: :value })
+
+  # optional. Raise error if ommited
+  builder.on_error do |exception|
+    # ignore
+  end
+end
+
+data[0] # foo response
+data[1] # bar response
+data[2] # baz response
+```
+
+### Mocking in rspec
+
+```ruby
+require 'koine/rest_client/rspec_mock_client'
+
+let(:mock_client) { Koine::RestClient::RspecMockClient.new(spec) }
+
+client.mock do |mocker|
+  mocker.get('foo').will_return(body: { foo: :bar })
+  mocker.put('bar', baz: :foo).will_return(body: { baz: :bar })
+  mocker.delete('error').will_return(code: 400, body: { message: :oops })
+end
+
+# or with custom response use the block
+
+client.mock do |mocker|
+  mocker.get('foo').will_return(body: 'parsed-body') do |response|
+    double(code: 200, parsed_response: "the #{response.parsed_response}")
+  end
+end
+```
+
+### Mocking a server
+
+Start the server
+
+```bash
+./bin/mock_server
+```
+
+```ruby
+request = Koine::RestClient::Request.new(
+  base_url: 'http://localhost:4321/something',
+  query_params: { rid: 'internal' },
+  headers: { 'X-Foo-Bar' => 'foo-bar' }
+)
+client = Koine::RestClient::Client.new(base_request: request)
+
+client.get('foo') # check the response
+```
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mjacobus/koine-rest_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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Koine::RestClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mjacobus/koine-rest_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'koine/rest_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(__FILE__)

data/bin/mock_server

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rack'
+require 'json'
+
+app = proc do |env|
+  request = Rack::Request.new(env)
+  headers = {}
+  request.each_header do |name, value|
+    unless name.match('rack.')
+      headers[name] = value
+    end
+  end
+  response = {
+    path: request.path,
+    method: request.request_method,
+    params: request.params,
+    request_headers: headers
+  }
+  code = request.params['response_code'] || 200
+  [code, { 'Content-Type' => 'application/json' }, [response.to_json]]
+end
+
+Rack::Handler.default.run app, Port: 4321

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/koine-rest_client.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koine/rest_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'koine-rest_client'
+  spec.version       = Koine::RestClient::VERSION
+  spec.authors       = ['Marcelo Jacobus']
+  spec.email         = ['marcelo.jacobus@gmail.com']
+
+  spec.summary       = 'Another http client'
+  spec.description   = 'Another http client - with support to async calls'
+  spec.homepage      = 'https://github.com/mjacobus/koine-rest_client'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'addressable', '>= 2.3'
+  spec.add_dependency 'httparty', '>= 0.17.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'object_comparator'
+  spec.add_development_dependency 'awesome_print'
+end