go_puff-tax_service 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 526b3c2835e7e616fbba411b00233f1eb06f04a7dcd3cdfb34c940f2de4660f8
+  data.tar.gz: aa17969f6074beb34e0d67e06c25b32bae51872f161c6ed1936bebd46e86c15d
+SHA512:
+  metadata.gz: 1f3ac9637457e14a5757fe32fabf1e16bbd1e48a4c6216d6d33b2f808c7e640a85164285825ec9eabd3c45f28ac9928d72ce14fb99b3f2255cae955bfbacf682
+  data.tar.gz: c733352e4b01583e81f2a615454fce27acf282a97f654910fb83adf08bf59bde107ab81ec6a1975506e05950dd44979de2993823ee15892561a3343c4dacb584

data/.bundle/config.example

@@ -0,0 +1,2 @@
+---
+BUNDLE_HTTPS://RUBYGEMS__PKG__GITHUB__COM/GOPUFF/: "GITHUB_USERNAME:PERSONAL_ACCESS_TOKEN"

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+*   @ruslantolstov

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Links
+
+- **Jira:** [PUFF-XXX](https://gopuff.atlassian.net/browse/PUFF-XXX)
+
+## Description
+_Description of changes. If a reviewer should focus their review on specific files or lines of code, list them here._
+
+## Checklist
+
+**Note:** All questions should be answered before this PR is ready to be reviewed.
+
+
+- [ ] Tested my changes locally
+- [ ] Self-reviewed this PR

data/.github/workflows/ci.yml

@@ -0,0 +1,126 @@
+name: CI
+
+on: [push]
+
+env:
+  GITHUB_PACKAGES_TOKEN: ${{ secrets.GP_REPO_PACKAGE_R }}
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: self-hosted-base
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Lint Ruby code with RuboCop
+        run: |
+          gem install bundler
+          bundle config set --global rubygems.pkg.github.com ${GITHUB_PACKAGES_TOKEN}
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop
+
+
+  test:
+    runs-on: self-hosted-base
+    needs: lint
+    strategy:
+      matrix:
+        ruby: [2.7, 3.0, 3.1]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with RSpec
+        run: |
+          gem install bundler
+          bundle config set --global rubygems.pkg.github.com ${GITHUB_PACKAGES_TOKEN}
+          bundle install --jobs 4 --retry 3
+          bundle exec rspec
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-${{ matrix.ruby }}
+          parallel: true
+
+  test-finish:
+    needs: test
+    name: Publish to Coveralls
+    runs-on: self-hosted-base
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+
+  publish:
+    needs: test
+    name: Publish to GitHub Packages
+    if: github.head_ref == 'main' || github.ref_name == 'main'
+    runs-on: self-hosted-base
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Set Credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: Bearer ${GITHUB_TOKEN}\n" > $HOME/.gem/credentials
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Publish to GitHub Packages
+        run: |
+          gem build go_puff-tax_service.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+          echo "release_version=v"`find . -iname "*.gem" | sed -ne "s/[^0-9]*\(\([0-9]\.\)\{0,4\}[0-9]\).*/\1/p"` >> $GITHUB_ENV
+        env:
+          OWNER: ${{ github.repository_owner }}
+
+      - name: Create a Release
+        uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: ${{secrets.GITHUB_TOKEN}}
+          automatic_release_tag: ${{ env.release_version }}
+          prerelease: false
+  publish-beta:
+    needs: test
+    name: Publish Beta to GitHub Packages
+    if: github.ref != 'refs/heads/main'
+    runs-on: self-hosted-base
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Set Credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: Bearer ${GITHUB_TOKEN}\n" > $HOME/.gem/credentials
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Publish to GitHub Packages
+        run: |
+          gem build go_puff-tax_service.gemspec
+          find . -iname "*-*.*.*.*.gem" | grep .
+          if [ $? -eq 1 ]
+          then
+            echo "Version does not contain beta/alpha prefix. Please check version.rb file."
+            exit 1
+          fi
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+          echo "release_version=v"`find . -iname "*.gem" | sed -ne "s/[^0-9]*\(\([0-9]\.\)\{0,4\}[0-9]\).*/\1/p"` >> $GITHUB_ENV
+        env:
+          OWNER: ${{ github.repository_owner }}

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+rspec*.xml

data/.rubocop.yml

@@ -0,0 +1,85 @@
+require:
+  - rubocop-thread_safety
+  - rubocop-rspec
+  - rubocop-performance
+
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6.8
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ScatteredSetup:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+Metrics/AbcSize:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/MessageChain:
+  Exclude:
+    - spec/go_puff/tax_service/tax_spec.rb
+
+RSpec/AnyInstance:
+  Exclude:
+    - spec/go_puff/tax_service/tax_spec.rb
+
+ThreadSafety/ClassAndModuleAttributes:
+  Exclude:
+    - lib/go_puff/tax_service.rb
+
+RSpec/ContextWording:
+  Exclude:
+    - spec/go_puff/tax_service/configuration_spec.rb
+    - spec/support/shared_contexts/get_response.rb
+
+RSpec/InstanceVariable:
+  Exclude:
+    - spec/go_puff/tax_service/tax_spec.rb

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:2.7-slim
+
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends \
+    bash less git \
+    build-essential ruby-dev \
+ && apt-get clean
+
+ENV APP_HOME /app
+
+ENV BUNDLE_GEMFILE=$APP_HOME/Gemfile \
+    BUNDLE_JOBS=8 \
+    BUNDLE_PATH=/gems
+
+RUN mkdir $APP_HOME
+
+WORKDIR $APP_HOME
+
+ADD Gemfile $APP_HOME/Gemfile
+ADD Gemfile.lock $APP_HOME/Gemfile.lock
+
+RUN gem install bundler --no-document

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+source 'https://rubygems.pkg.github.com/gopuff'
+
+# Specify your gem's dependencies in gopuff-gem-rails_tax_service.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    go_puff-tax_service (1.5.0)
+      activesupport
+      go_puff-http-client (~> 0.1)
+      retryable
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://rubygems.pkg.github.com/gopuff/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-net_http_persistent (2.1.0)
+      faraday (~> 2.5)
+      net-http-persistent (~> 4.0)
+    go_puff-http-client (0.5.1)
+      faraday (~> 2.5)
+      faraday-net_http_persistent (~> 2.1)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    net-http-persistent (4.0.2)
+      connection_pool (~> 2.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    regexp_parser (2.5.0)
+    retryable (3.0.5)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    rubocop-thread_safety (0.4.4)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  aarch64-linux
+  ruby
+  x86_64-darwin-18
+
+DEPENDENCIES
+  go_puff-tax_service!
+  pry
+  rspec
+  rubocop (~> 1.25)
+  rubocop-performance
+  rubocop-rspec
+  rubocop-thread_safety (~> 0.4)
+  simplecov (~> 0.21)
+  simplecov-lcov (~> 0.8.0)
+  webmock
+
+BUNDLED WITH
+   2.4.12

data/README.md

@@ -0,0 +1,86 @@
+# GoPuff::TaxService
+[![Coverage Status](https://coveralls.io/repos/github/gopuff/go_puff-tax_service/badge.svg?branch=main&t=ZBIABm)](https://coveralls.io/github/gopuff/go_puff-tax_service?branch=main)
+
+GoPuff Rails library to handle interaction with Tax Service
+
+## Installation
+
+Add the gem to your project's Gemfile:
+
+```ruby
+source 'https://rubygems.pkg.github.com/gopuff' do
+  gem 'go_puff-tax_service'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+gem install go_puff-tax_service --source "https://rubygems.pkg.github.com/gopuff"
+```
+## Configuration example
+```ruby
+# config/initializers/tax_service.rb
+
+GoPuff::TaxService.configure do |config|
+  config.logger = GoPuff::Logger
+
+  config.base_url = ENV['GOPUFF_TAX_SERVICE_BASE_URL']
+
+  config.requests.max_retries = 3
+  config.requests.retry_wait_time = 0.5
+  config.requests.retryable_exceptions = [EOFError, Errno::ECONNRESET]
+
+  config.user_agent_header = 'your header'
+
+  config.authentication.token_provider = -> { Apis::TaxService::Authentication.get_token }
+  config.authentication.on_unauthorized = -> { Apis::TaxService::Authentication.get_token(fresh: true) }
+end
+
+Gopuff::TaxService = GoPuff::TaxService
+```
+
+## Usage
+There are 3 main actions you can use: `Get`, `Commit`, `Cancel`
+
+`Get`. It is used for fee calculation:
+```ruby
+  order = ...
+  purchases = ...
+  fees_kind = 'all' || 'non_alcohol' || 'alcohol' || 'none'
+  GoPuff::TaxService::Actions::Get.new(order, purchases: purchases, fees_kind: 'all').call
+```
+
+`Commit` It is used for confirming fee when order is finished:
+```ruby
+  order = ...
+  GoPuff::TaxService::Actions::Commit.new(order).call
+```
+
+`Cancel` It is used for refund:
+```ruby
+  order = ...
+  GoPuff::TaxService::Actions::Cancel.new(order).call
+```
+
+## Local development with docker
+```bash
+docker-compose run --rm go_puff-tax_service bash
+```
+
+
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Clone the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'go_puff/tax_service'
+
+# 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/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

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/dip.yml

@@ -0,0 +1,23 @@
+version: '2'
+
+environment:
+  RAILS_ENV: development
+
+compose:
+  files:
+    - docker-compose.yml
+
+interaction:
+  bash:
+    service: go_puff-tax_service
+    command: /bin/bash
+    compose_run_options: [no-deps]
+  bundle:
+    service: go_puff-tax_service
+    command: bundle
+  rake:
+    service: go_puff-tax_service
+    command: bundle exec rake
+  rspec:
+    service: go_puff-tax_service
+    command: bundle exec rspec

data/docker-compose.yml

@@ -0,0 +1,13 @@
+
+version: '3.4'
+
+services:
+  go_puff-tax_service:
+    build:
+      context: .
+    volumes:
+      - .:/app
+      - go_puff-tax_service-gems:/gems
+      - ./.bundle/config:/root/.bundle/config
+volumes:
+  go_puff-tax_service-gems:

data/go_puff-tax_service.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'go_puff/tax_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'go_puff-tax_service'
+  spec.version       = GoPuff::TaxService::VERSION
+  spec.authors       = ['Sergey Timofeyev']
+  spec.email         = ['timofeyev@mlsdev.com']
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.summary       = 'Tax Service'
+  spec.description   = 'Tax service integration that was made initially for Avalara'
+
+  # 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 'activesupport'
+  spec.add_dependency 'go_puff-http-client', '~> 0.1'
+  spec.add_dependency 'retryable'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '~> 1.25'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-thread_safety', '~> 0.4'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+  spec.add_development_dependency 'webmock'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/go_puff/tax_service/actions/cancel.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GoPuff
+  module TaxService
+    module Actions
+      class Cancel < GoPuff::TaxService::Tax
+        private
+
+        def body_params
+          @body_params ||= { orderId: order.id_obfuscated.to_s }
+        end
+
+        def endpoint
+          '/api/taxes/refund'
+        end
+      end
+    end
+  end
+end