product-aggregator-rb 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74ecfc44e9bf066f2e362dc2131836256121120e
+  data.tar.gz: efab64ef15b9651d6c66a403a7d82a6f39b9f1cb
+SHA512:
+  metadata.gz: 7f310e31437f4cc95f3d36cdc42217a1a3f15752d1a2d9cb907cb3381933d9aac6682a89e79aaf87d6ec946d240657757538343e3c1987a4fa83a75a449fc9e0
+  data.tar.gz: d39a7d07c3ab903a8d464bff03b8ee164456171b085c77e0980fec989995127ebc3b9730ae8ce3832a6985874764d4ec6f7879f293c807643dea1070de220495

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.rbc
+/.bundle/
+.ruby-version
+.ruby-gemset
+.rvmrc
+/coverage/

data/.rubocop.yml

@@ -0,0 +1,57 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - Rakefile
+    - Gemfile
+    - bin/*
+    - '*.gemspec'
+    - spec/**/*.rb
+    - vendor/**/*
+
+Lint/HandleExceptions:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Naming/FileName:
+  Enabled: false

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    product-aggregator-rb (0.0.2)
+      faraday
+      faraday_middleware-circuit_breaker
+      json
+      net-http-persistent
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    codecov (0.1.14)
+      json
+      simplecov
+      url
+    connection_pool (2.2.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dotenv (2.7.4)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware-circuit_breaker (0.3.0)
+      faraday (~> 0.9)
+      stoplight (~> 2.1)
+    hashdiff (1.0.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    multipart-post (2.1.1)
+    net-http-persistent (3.1.0)
+      connection_pool (~> 2.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    public_suffix (3.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.73.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    stoplight (2.1.3)
+    unicode-display_width (1.6.0)
+    url (0.3.2)
+    webmock (3.6.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.2)
+  codecov
+  dotenv (>= 2.4.0)
+  product-aggregator-rb!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  rubocop
+  simplecov (>= 0.16.1)
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,60 @@
+# Product Aggregator Ruby CLient
+
+## Description
+
+A ruby gem to access Bukalapak's product detail
+
+## Owner
+
+[CORE](https://bukalapak.atlassian.net/wiki/spaces/SS/overview)
+
+## Contact and On-Call Information
+
+[CORE](https://bukalapak.atlassian.net/wiki/spaces/SS/overview)
+
+
+### Prerequisite
+
+- Ruby 2.3.0 or later
+
+### Development
+
+- Install gem
+
+  ```sh
+  gem install product-aggregator-rb
+  ```
+
+  or Using Gemfile
+  ```sh
+  gem 'product-aggregator-rb'
+  ```
+
+- Initate new configuration
+
+	```sh
+	require 'product-aggregator-rb'
+
+	ProductAggregator.configure do |t|
+	  t.host = 'http://localhost:1234'
+	  t.user = 'user'
+	  t.password = 'password'
+	end
+	```
+
+- Call the function
+
+	Get product by id and database origin ('readonly' or 'master'):
+
+	```sh
+	ProductAggregator::Connection.get_product(123, 'readonly')
+	```
+
+## On-Call Runbooks
+
+refer to [Core Team Wiki](https://bukalapak.atlassian.net/wiki/spaces/SS/overview)
+or contact core@bukalapak.com
+
+## FAQ
+
+-

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['-c.rubocop.yml']
+end
+
+task :default => :spec
+task lint: :rubocop

data/lib/product-aggregator-rb.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'product-aggregator/version'
+require 'product-aggregator/configuration'
+require 'product-aggregator/connection'
+
+# ProductAggregator is a ruby gem client for product aggregator
+module ProductAggregator
+  class << self
+    attr_accessor :configuration
+  end
+
+  module_function
+
+  def configuration
+    @configuration ||= ProductAggregator::Configuration.new
+  end
+
+  def configure
+    yield(configuration) if block_given?
+
+    configuration.max_retry ||= 5
+    configuration.expiration_time ||= 300
+    configuration.circuit_breaker_timeout ||= 300
+    configuration.circuit_breaker_threshold ||= 10
+  end
+end

data/lib/product-aggregator/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ProductAggregator
+  # ProductAggregator::Configuration yields the configuration of product-aggregator-rb.
+  class Configuration
+    attr_accessor :max_retry
+    attr_accessor :expiration_time
+    attr_accessor :logger
+    attr_accessor :host
+    attr_accessor :user
+    attr_accessor :password
+    attr_accessor :circuit_breaker_timeout
+    attr_accessor :circuit_breaker_threshold
+  end
+end

data/lib/product-aggregator/connection.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware/circuit_breaker'
+require 'json'
+require 'net/http/persistent'
+
+module ProductAggregator
+  # ProductAggregator::Connection provides an instance to connect to product aggregator service.
+  class Connection
+    class << self
+      RETRIABLE_METHODS      = %i[get post].freeze
+      RETRIABLE_EXCEPTIONS   = [Faraday::ConnectionFailed, Faraday::TimeoutError, ::Net::ReadTimeout, 'Timeout::Error'].freeze
+      GET_PRODUCT            = '/_internal/products/'
+
+      def get_product(product_id, origin = 'readonly')
+        endpoint = "#{GET_PRODUCT}#{product_id}?origin=#{origin}"
+
+        begin
+          response = connection.get endpoint do |req|
+            req.options.timeout = 0.2
+            req.options.open_timeout = 1
+          end
+
+          result = ::JSON.parse(response.body)
+          return result['data'] if response.status == 200
+
+          msg = result['errors'][0]['message'] if result['errors'] && result['errors'][0]
+          e = case response.status
+              when 401
+                ProductAggregator::UnauthorizedError.new(msg)
+              when 404
+                ProductAggregator::NotFoundError.new(msg)
+              when 500
+                ProductAggregator::InternalServerError.new(msg)
+              else
+                ProductAggregator::Error.new(msg)
+              end
+          raise e
+        rescue Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::Error => e
+          ProductAggregator.configuration.logger&.error(message: "GET #{endpoint} TIMEOUT: #{e.message}")
+          raise e
+        end
+      end
+
+      private
+
+      def connection
+        @connection ||= Faraday.new(url: ProductAggregator.configuration.host) do |f|
+          f.use :circuit_breaker,
+                timeout: ProductAggregator.configuration.circuit_breaker_timeout,
+                threshold: ProductAggregator.configuration.circuit_breaker_threshold,
+                fallback: ->(_, exception){ raise exception if exception; Faraday::Response.new(status: 503, response_headers: {}) }
+
+          f.use Faraday::Request::BasicAuthentication,
+                ProductAggregator.configuration.user, ProductAggregator.configuration.password
+          f.request :retry, max: ProductAggregator.configuration.max_retry.to_i, interval: 0.1, backoff_factor: 2, methods: RETRIABLE_METHODS, exceptions: RETRIABLE_EXCEPTIONS
+          f.adapter :net_http_persistent
+        end
+      end
+    end
+  end
+end

data/lib/product-aggregator/logger_abstract.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ProductAggregator
+  # ProductAggregator::LoggerAbstract describes the interface class for logger.
+  class LoggerAbstract
+    # the redis you provide must implement these methods
+
+    def error(_message:)
+      raise NotImplementedError, "You must implement #{method_name}"
+    end
+
+    private
+
+    def method_name
+      caller_locations(1, 1)[0].label
+    end
+  end
+end

data/lib/product-aggregator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ProductAggregator
+  VERSION = '0.0.3'
+end

data/product-aggregator-rb.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# encoding: UTF-8
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'product-aggregator/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'product-aggregator-rb'
+  s.version     = ProductAggregator::VERSION
+  s.authors     = ['bukalapak']
+  s.email       = ['product@bukalapak.com']
+  s.homepage    = 'https://gitlab.cloud.bukalapak.io/bukalapak/product-aggregator-rb'
+  s.summary     = 'Product Aggregator ruby client'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'faraday_middleware-circuit_breaker'
+  s.add_runtime_dependency 'net-http-persistent'
+  s.add_runtime_dependency 'json'
+
+  s.add_development_dependency 'bundler', '~> 2.0.2'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'simplecov', '>= 0.16.1'
+  s.add_development_dependency 'dotenv', '>= 2.4.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'rspec_junit_formatter'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'codecov'
+
+  s.required_ruby_version = '>= 2.3.0'
+end

data/spec/initializer.rb

@@ -0,0 +1,9 @@
+require 'product-aggregator-rb'
+require 'product-aggregator/error'
+require 'dotenv'
+
+Dotenv.load
+
+ProductAggregator.configure do |t|
+  t.host = 'http://localhost:8027'
+end

data/spec/product_aggregator/connection_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe ProductAggregator::Connection, :type => :model do
+
+  subject { described_class }
+
+  before do
+    allow(ProductAggregator.configuration).to receive(:max_retry).and_return(1)
+  end
+
+  it { is_expected.to respond_to(:get_product) }
+
+  describe '#get_product' do
+    let(:data) { { id: 123, name: 'Product kecantikan' } }
+    let(:data_other) { { id: 456, name: 'Product kesehatan' } }
+    let(:response) { { data: data }.to_json }
+    let(:response_other) { { data: data_other }.to_json }
+    let(:not_found) { {errors: [{ message: 'Product tidak ditemukann' }] }.to_json }
+    let(:server_error) { {errors: [{ message: 'Ada kesalahan pada sistem' }] }.to_json }
+    let(:unauthorized) { {errors: [{ message: 'Unauthorized' }] }.to_json }
+    let(:other_error) { {errors: [{ message: 'Kesalahan lainnya' }] }.to_json }
+
+    # context 'success response' do
+    #   before do
+    #     stub_request(:get, 'http://localhost:8027/_internal/products/1?origin=readonly').to_return({ status: 200, body: response })
+    #     stub_request(:get, 'http://localhost:8027/_internal/products/2?origin=master').to_return({ status: 200, body: response_other })
+    #   end
+
+    #   it do
+    #     expect(subject.get_product(1)).to eq({ 'id' => 123, 'name' => 'Product kecantikan' })
+    #     expect(subject.get_product(2, 'master')).to eq({ 'id' => 456, 'name' => 'Product kesehatan' })
+    #   end
+    # end
+
+    context '404 response' do
+      before { stub_request(:get, 'http://localhost:8027/_internal/products/1?origin=readonly').to_return({ status: 404, body: not_found }) }
+
+      it { expect(subject.get_product(1)).to raise_error(ProductAggregator::NotFoundError) }
+    end
+
+    context 'timeout' do
+      before { stub_request(:get, 'http://localhost:8027/_internal/products/1?origin=readonly').to_timeout }
+
+      it { expect{subject.get_product(1)}.to raise_error }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'codecov'
+
+SimpleCov.formatter =
+  if ENV['CI']
+    SimpleCov::Formatter::Codecov
+  else
+    SimpleCov::Formatter::HTMLFormatter
+  end
+
+require 'webmock/rspec'
+require 'initializer'

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: product-aggregator-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- bukalapak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware-circuit_breaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: rubocop
+  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: codecov
+  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:
+- product@bukalapak.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/product-aggregator-rb.rb
+- lib/product-aggregator/configuration.rb
+- lib/product-aggregator/connection.rb
+- lib/product-aggregator/logger_abstract.rb
+- lib/product-aggregator/version.rb
+- product-aggregator-rb.gemspec
+- spec/initializer.rb
+- spec/product_aggregator/connection_spec.rb
+- spec/spec_helper.rb
+homepage: https://gitlab.cloud.bukalapak.io/bukalapak/product-aggregator-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Product Aggregator ruby client
+test_files:
+- spec/initializer.rb
+- spec/product_aggregator/connection_spec.rb
+- spec/spec_helper.rb