minato_ruby_api_client 0.2.1

data/minato_ruby_api_client.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+# Minato Ruby Api Client
+
+The Minato ruby HTTP Client
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "minato_ruby_api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "minato_ruby_api_client"
+  s.version     = MinatoRubyApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ferreri"]
+  s.email       = ["support@ferreri.co"]
+  s.homepage    = "http://ferreri.co"
+  s.summary     = "A Minato ruby HTTP Client"
+  s.description = "Minato HTTP Client"
+  s.license     = "unlicense"
+  s.required_ruby_version = ">= 3.0"
+
+  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'minato_error_handler', '~> 0.1.9-1'
+  s.add_runtime_dependency 'minato-trace', '~> 0.1.6-8'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,309 @@
+require 'spec_helper'
+
+describe MinatoRubyApiClient::ApiClient do
+  
+  [:config, :default_headers].each do |method|
+    it { should respond_to method }
+  end
+
+  let(:url) { 'https://example.com/v1' }
+
+  let(:api_client) do
+    uri = URI.parse(url)
+    described_class.default.tap do |api_client|
+      api_client.config.host = uri.host
+    end
+  end
+
+  describe '.default' do
+    it 'memoizes the instance of MinatoRubyApiClient::ApiClient in subsequent calls' do
+      expect(described_class).to receive(:new).once.and_call_original
+      2.times { described_class.default }
+    end
+
+    it 'returns a instance of MinatoRubyApiClient::ApiClient' do
+      expect(described_class.default).to be_a MinatoRubyApiClient::ApiClient
+    end
+  end
+
+  describe '#build_request_body' do
+    let(:form_params) { { foo: 'bar', bar: 'foobar' } }
+    let(:body) { { foo: 'bar', bar: 'foobar' } }
+
+    before do
+      @data = api_client.build_request_body(header_params, form_params, body)
+    end
+
+    context 'when content type is form-url-encoded' do
+      let(:header_params) { { 'Content-Type' => 'application/x-www-form-urlencoded' } }
+
+      it 'returns data in url encoded format' do
+        expect(@data).to eq('foo=bar&bar=foobar')
+      end
+    end
+
+    context 'when content type is multipar/form-data' do
+      let(:header_params) { { 'Content-Type' => 'multipart/form-data' } }
+
+      it 'returns data in hash format' do
+        expect(@data).to eq(form_params)
+      end
+    end
+
+    context 'when body is a string' do
+      let(:header_params) { { 'Content-Type' => 'text/plain' } }
+      let(:body) { 'body is a string' }
+
+      it 'returns data in string format' do
+        expect(@data).to eq(body)
+      end
+    end
+
+    context 'when body is a hash' do
+      let(:header_params) { { 'Content-Type' => 'application/json' } }
+
+      it 'returns data in json format' do
+        expect(@data).to eq(body.to_json)
+      end
+    end
+
+    context 'when no body and form content types is passed' do
+      let(:header_params) { { 'Content-Type' => 'application/json' } }
+      let(:body) { nil }
+
+      it 'returns a null data' do
+        expect(@data).to be_nil
+      end
+    end
+  end
+
+  describe '#json_mime?' do
+    context 'when content type is json' do
+      it 'returns true' do
+        expect(api_client.json_mime?('application/json')).to be true
+      end
+    end
+
+    context 'when content type is not json' do
+      it 'returns false' do
+        expect(api_client.json_mime?('application/xml')).to be false
+      end
+    end
+  end
+
+  describe '#call_api' do
+    let(:opts) { { body: { name: 'Foo Bar' }, auth_names: 'apikey', return_type: 'Object' } }
+    let(:http_response) do
+      { status: 200, headers: { 'Context-type': 'application/json' },
+        body: { message: 'success' }.to_json }
+    end
+
+    before do
+      stub_request(:post, /test/)
+        .to_return(http_response)
+      allow(api_client.config).to receive(:logger).and_return(Logger.new(STDOUT))
+      api_client.config.logger.level = Logger::WARN
+    end
+
+    context 'when request is successful' do
+      it 'returns data, status and headers' do
+        data, status_code, headers = api_client.call_api(:post, '/test', opts)
+        expect(data).to eq({ message: 'success' })
+        expect(status_code).to eq(200)
+      end
+
+      it 'returns nil when return_type is not defined' do
+        opts[:return_type] = nil
+        data, status_code, headers = api_client.call_api(:post, '/test', opts)
+        expect(data).to be_nil
+      end
+    end
+
+    context 'when request failed' do
+      let(:http_response) do
+        { status: [400, 'Bad Request'], headers: { 'Context-type': 'application/json' },
+          body: { message: 'Dados inválidos' }.to_json }
+      end
+
+      it 'raise an error MinatoRubyApiClient::ApiError' do
+        expect { api_client.call_api(:post, '/test', opts) }.to raise_error(
+          an_instance_of(MinatoRubyApiClient::ApiError)
+            .and having_attributes(message: 'An error occurred while communicating with the API.',
+                                   caused_by: 'Bad Request', status_code: 400))
+      end
+    end
+
+    context 'when request timeout' do
+      before { stub_request(:get, /test/).to_raise(Faraday::TimeoutError) }
+
+      it 'raise an error caused by timeout' do
+        expect { api_client.call_api(:get, '/test', opts) }.to raise_error { |error|
+          expect(error).to be_a(MinatoRubyApiClient::ApiError)
+          expect(error.caused_by).to be_a(Faraday::TimeoutError)
+        }
+      end
+    end
+  end
+
+  describe 'trace' do
+    let(:config) { MinatoRubyApiClient::Configuration.new }
+    let(:api_client) { described_class.new(config) }
+
+    context 'when trace is enabled and Rails is defined' do
+      it 'add distributed trace middleware to middleware stack' do
+        allow(Object).to receive(:const_defined?).with(:Rails).and_return(true)
+        allow(Rails.env).to receive(:production?).and_return(true)
+        allow(Minato::Trace).to receive(:enabled?).and_return(true)
+        expect(api_client.config.instance_variable_get('@middlewares')).to include([Minato::Trace::Middleware::DistributedTraceContext])
+      end
+    end
+
+    context 'when trace is disabled' do
+      it 'should not add ditributed trace middleware' do
+        allow(Object).to receive(:const_defined?).with(:Rails).and_return(true)
+        allow(Rails.env).to receive(:production?).and_return(true)
+        allow(Minato::Trace).to receive(:enabled?).and_return(false)
+        expect(api_client.config.instance_variable_get('@middlewares')).to eq []
+      end
+    end
+
+    context 'when Rails is not defined' do
+      it 'should not add ditributed trace middleware' do
+        allow(Object).to receive(:const_defined?).with(:Rails).and_return(false)
+        allow(Minato::Trace).to receive(:enabled?).and_return(true)
+        expect(api_client.config.instance_variable_get('@middlewares')).to eq []
+      end
+    end
+
+    context 'when Rails is defined but is not in productio mode' do
+      it 'should not add ditributed trace middleware' do
+        allow(Object).to receive(:const_defined?).with(:Rails).and_return(true)
+        allow(Rails.env).to receive(:production?).and_return(false)
+        allow(Minato::Trace).to receive(:enabled?).and_return(true)
+        expect(api_client.config.instance_variable_get('@middlewares')).to eq []
+      end
+    end
+  end
+
+  describe '#convert_to_type' do
+    context 'when data is nil' do
+      it 'returns nil' do
+        expect(api_client.convert_to_type(nil, 'String')).to be_nil
+      end
+    end
+
+    context 'when return type is String' do
+      it 'returns string' do
+        expect(api_client.convert_to_type(1, 'String')).to be_a(String)
+      end
+    end
+
+    context 'when return type is Integer' do
+      it 'returns integer' do
+        expect(api_client.convert_to_type('1', 'Integer')).to be_a(Integer)
+      end
+    end
+
+    context 'when return type is Float' do
+      it 'returns float' do
+        expect(api_client.convert_to_type('1', 'Float')).to be_a(Float)
+      end
+    end
+
+    context 'when return type is Boolean' do
+      it 'returns boolean' do
+        expect(api_client.convert_to_type(true, 'Boolean')).to be_truthy
+      end
+    end
+
+    context 'when return type is Time' do
+      it 'returns time' do
+        expect(api_client.convert_to_type('12:00:00', 'Time')).to be_a(Time)
+      end
+    end
+
+    context 'when return type is Date' do
+      it 'returns time' do
+        expect(api_client.convert_to_type('2020-12-25 12:00:00', 'Date')).to be_a(Date)
+      end
+    end
+
+    context 'when return type is Object' do
+      it 'returns data' do
+        data = { id: 1 }
+        expect(api_client.convert_to_type(data, 'Object')).to equal(data)
+      end
+    end
+
+    context 'when return type is Array<String>' do
+      it 'returns array list of type specified' do
+        data = [1, 2, 3]
+        expect(api_client.convert_to_type(data, 'Array<String>')).to eq(['1', '2', '3'])
+      end
+    end
+
+    context 'when return type is Hash<String, Integer>' do
+      it 'returns hash with key:value of types specifieds' do
+        data = { id: '22', qtd: '12' }
+        expect(api_client.convert_to_type(data, 'Hash<String, Integer>')).to eq({ 'id': 22, 'qtd': 12 })
+      end
+    end
+
+    context 'when return type is a custom type as a class' do
+      it 'returns a object from the class' do
+        klass = double('Pet', name: 'Bob')
+        allow(MinatoRubyApiClient).to receive(:const_get).with('Pet').and_return(klass)
+        allow(klass).to receive(:build_from_hash).and_return(true)
+
+        expect(api_client.convert_to_type({ name: 'Bob' }, 'Pet')).to be_truthy
+      end
+    end
+  end
+
+  describe '#update_params_for_auth!' do
+    let(:header_params) { {} }
+    let(:query_params) { {} }
+    let(:config) { MinatoRubyApiClient::Configuration.new }
+    let(:api_client) { described_class.new(config) }
+
+    context 'when auth method is bearer auth' do
+      it 'add bearer auth in header' do
+        api_client.config.access_token = 'access_token'
+        api_client.update_params_for_auth!(header_params, query_params, ['bearer_auth'])
+        expect(header_params).to eq({ 'Authorization' => 'Bearer access_token' })
+      end
+    end
+
+    context 'when auth method is basic auth' do
+      it 'add basic auth in header' do
+        api_client.config.username = 'user'
+        api_client.config.password = 'pass'
+        basic_auth = Base64.encode64("user:pass").chomp.delete("\n")
+
+        api_client.update_params_for_auth!(header_params, query_params, ['basic_auth'])
+        expect(header_params).to eq({ 'Authorization' => "Basic #{basic_auth}" })
+      end
+    end
+
+    context 'when auth method is apikey' do
+      context 'when api_key prefix is not defined' do
+        it 'add apikey auth in header without prefix' do
+          api_client.config.api_key['api_key'] = 'key'
+
+          api_client.update_params_for_auth!(header_params, query_params, ['apikey'])
+          expect(header_params).to eq({ 'api_key' => 'key' })
+        end
+      end
+
+      context 'when api_key prefix is defined' do
+        it 'add apikey auth in header with prefix' do
+          api_client.config.api_key['api_key'] = 'key'
+          api_client.config.api_key_prefix['api_key'] = 'prefix'
+
+          api_client.update_params_for_auth!(header_params, query_params, ['apikey'])
+          expect(header_params).to eq({ 'api_key' => 'prefix key' })
+        end
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+
+describe MinatoRubyApiClient::Configuration do
+  let(:url) { 'https://example.com/v1' }
+
+  before :each do
+    require 'uri'
+    uri = URI.parse(url)
+    MinatoRubyApiClient.configure do |c|
+      c.host = uri.host
+      c.base_path = uri.path
+      c.api_key['api_key'] = 'test_key'
+    end
+
+    @config = described_class.default
+  end
+
+  describe '#scheme' do
+    it 'should have the default value https' do
+      expect(@config.scheme).to eq('https')
+    end
+
+    it 'should remove :// from scheme' do
+      @config.scheme = 'https://'
+      expect(@config.scheme).to eq('https')
+    end
+  end
+
+  describe '#host' do
+    it 'should do not have the scheme value' do
+      expect(@config.host).not_to match(/https/)
+    end
+  end
+
+  describe '#base_path' do
+    it 'should add leading slashes if missing' do
+      @config.base_path = 'v1'
+      expect(@config.base_path).to eq('/v1')
+    end
+
+    it 'should be empty if is /' do
+      @config.base_path = '/'
+      expect(@config.base_path).to eq('')
+    end
+  end
+
+  describe '#user_agent' do
+  it 'should have user agent' do
+    @config.user_agent = 'Minato'
+    expect(@config.user_agent).to eq('Minato')
+  end
+end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      expect(@config.base_url).to eq(url)
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        @config.base_path = base_path
+        expect(@config.base_url).to eq("https://example.com")
+      end
+    end
+  end
+
+  describe '#timeout' do
+    it 'should have the default value' do
+      expect(@config.timeout).to eq(60)
+    end
+  end
+
+  describe '#debugging' do
+    it 'should have the default value falsy' do
+      expect(@config.debugging).to be_falsy
+    end
+
+    context 'when MINATO_RUBY_API_CLIENT_DEBUG is true' do
+      it 'should be truthy' do
+        allow(ENV).to receive(:[]).with('MINATO_RUBY_API_CLIENT_DEBUG').and_return('true')
+        expect(@config.debugging).to be_truthy
+      end
+    end
+
+    context 'when debug is active' do
+      it 'should be truthy' do
+        config = described_class.new
+        config.debugging = true
+        expect(config.debugging).to be_truthy
+      end
+    end
+  end
+
+  describe '#auth_settings' do
+    it 'should have default auth types' do
+      expect(@config.auth_settings.keys).to eq(%w[bearer_auth basic_auth apikey])
+    end
+  end
+
+  describe '#basic_auth_token' do
+    let(:username) { 'test' }
+    let(:password) { 'test' }
+    let(:token) { ["#{username}:#{password}"].pack('m').delete("\r\n") }
+    it 'should return basic auth string' do
+      @config.username = username
+      @config.password = password
+      expect(@config.basic_auth_token).to eq("Basic #{token}")
+    end
+  end
+
+  describe '#logger' do
+    let(:logger) { Logger.new(STDOUT) }
+
+    context 'when Rails is defined' do
+      it 'should return Rails.logger' do
+        allow(Object).to receive(:const_defined?).with(:Rails).and_return(true)
+        allow(Rails).to receive(:logger).and_return(logger)
+        config = described_class.new
+        expect(config.logger).to eq(Rails.logger)
+      end
+    end
+
+    context 'when Rails is not defined' do
+      it 'should return Logger instance' do
+        allow(Object).to receive(:const_defined?).with(:Rails).and_return(nil)
+        config = described_class.new
+        expect(config.logger).to be_instance_of(Logger)
+      end
+    end
+  end
+
+  describe '#api_key_with_prefix' do
+    context 'when api_key_prefix is not defined' do
+      it 'return the key without prefix' do
+        expect(@config.api_key_with_prefix('api_key')).to eq('test_key')
+      end
+    end
+
+    context 'when api_key_prefix is defined' do
+      it 'return the key with prefix' do
+        @config.api_key_prefix['api_key'] = 'Prefix'
+        expect(@config.api_key_with_prefix('api_key')).to eq('Prefix test_key')
+      end
+    end
+  end
+
+  describe '#configure' do
+    context 'when block is given' do
+      it 'should yield the configuration object' do
+        expect { |b| @config.configure(&b) }.to yield_with_args
+      end
+    end
+
+    context 'when block is not given' do
+      it 'should return nil' do
+        expect(@config.configure).to be_nil
+      end
+    end   
+  end
+
+  describe '#use' do
+    it 'add middleware to the middlewares list' do
+      @config.use(:test)
+      expect(@config.instance_variable_get('@middlewares')).to include([:test])
+    end
+  end
+
+  describe '#request' do
+    it 'add middleware to the request middlewares list' do
+      @config.request(:test)
+      expect(@config.instance_variable_get('@request_middlewares')).to include([:test])
+    end
+  end
+
+  describe '#response' do
+    it 'add middleware to the response middlewares list' do
+      @config.response(:test)
+      expect(@config.instance_variable_get('@response_middlewares')).to include([:test])
+    end
+  end
+
+  describe '#configure_middleware' do
+    let(:conn) { double('conn') }
+    let(:config) { described_class.new }
+
+    before do
+      config.use(:use)
+      config.request(:request)
+      config.response(:response)
+
+      allow(conn).to receive(:use)
+      allow(conn).to receive(:request)
+      allow(conn).to receive(:response)
+
+      config.configure_middleware(conn)
+    end
+
+    it 'add middlewares to connection middleware stack' do
+      expect(conn).to have_received(:use).once.with(:use)
+      expect(conn).to have_received(:request).once.with(:request)
+      expect(conn).to have_received(:response).once.with(:response)
+    end
+  end
+end

data/spec/minato_ruby_api_client_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe MinatoRubyApiClient do
+  describe '.configure' do
+    context 'when no block is given' do
+      it 'returns the default configuration' do
+        expect(MinatoRubyApiClient.configure).to eq MinatoRubyApiClient::Configuration.default
+      end
+    end
+
+    context 'when a block is given' do
+      it 'yields the configuration' do
+        expect { |b| MinatoRubyApiClient.configure(&b) }.to yield_control
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# load the gem
+require 'minato_ruby_api_client'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end