commissioner-guy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6067d96597146d7a831da0b17b7ddd5b1c2a3f33b41763d5ba093fd42e60021
+  data.tar.gz: 5db9d89fd1598f2d2a281164634c38f4d91b9c7f3fe8ff0f3caf0eaee737a3d0
+SHA512:
+  metadata.gz: 339d2995163a048e22bc76fc7e17128011eba644cb98f9eafbc0a63cf8be0e1eef060782d36615769747117a427e1e67d9a4c94162012b1174abe2170de6bb77
+  data.tar.gz: 5cc1573af34d93762a262534980b26b6141474b403eeaa3b306a32152cb0ab7d765293699398d3d7d93c40fe0a83a33eb9fbf3223c4f146ad4aac89a4926a460

data/.gitignore

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

data/.irbrc

@@ -0,0 +1,4 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commissioner'
+Commissioner.configure {|c| c.exchanger = ->(from, to, amount) { [Money.from_amount(amount.to_f, to), 1] } }

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in exchanger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    commissioner (0.1.0)
+      dry-auto_inject (~> 0.6)
+      dry-configurable
+      money (~> 6.13.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    dry-auto_inject (0.7.0)
+      dry-container (>= 0.3.4)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.10)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    money (6.13.8)
+      i18n (>= 0.6.4, <= 2)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  commissioner!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Valentine Kiselev
+
+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,90 @@
+# Commissioner
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'commissioner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_commissioner
+
+## Usage
+
+### First, configure the gem
+
+```ruby
+Commissioner.configure do |config|
+  # If you exchange money provider the lambda that receives
+  #   from   - string
+  #   to     - string
+  #   amount - Money instance
+  # 'amount' might be in 'from' or 'to' currency
+  # Must return either just exchanged amount or [amount, exchanged_rate]
+  config.exchanger = ->(from, to, amount) { ... }
+
+  # When applying commission the amount might be rounded. This setting
+  # defined the rounding mode. Available modes are:
+  # - :up
+  # - :down
+  # - :half_up
+  # - :half_even
+  # See BigDecimal rounding modes for more
+  config.rouding_mode = :up
+end
+```
+
+### Explicit call
+
+```ruby
+calculation = Commissioner.calculate(
+  charged_amount: 100,
+  charged_currency: 'EUR',
+  received_currency: 'USD',
+  commission: 10, # %
+  exchange_commission: 15 # %
+)
+
+calculation.charged_amount # #<Money fractional:10000 currency:EUR>
+calculation.received_amount # #<Money fractional:7650 currency:USD>
+calculation.fee # #<Money fractional:1000 currency:EUR>
+calculation.exchange_fee # <Money fractional:1350 currency:USD>
+calculation.exchange_rate # 1 (only if config.exchanger returns it)
+```
+
+### As a mixin
+
+```ruby
+class MyCalculator
+  include Commissiner::Mixin
+
+  def call(params)
+    calculate(params)
+  end
+end
+```
+
+## Development
+
+- [x] Custom exchanger
+  - [x] If exchanging is not needed, it is not executed
+- [x] Commission for operation
+- [x] Commission for exchange
+- [x] No matter whether received or charged amount is provided, the calculation result is the same
+- [ ] User-defined order of commissions aplying
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrexox/commissioner.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :build do
+  sh 'gem build commissioner.gemspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exchanger"
+
+# 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/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/commissioner.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commissioner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'commissioner-guy'
+  spec.version       = Commissioner::VERSION
+  spec.authors       = ['Valentine Kiselev']
+  spec.email         = ['mrexox@outlook.com']
+
+  spec.summary       = %q{A simple gem to calculate money based on provided amounts.}
+  spec.description   = %q{A simple gem to calculate money based on provided amounts.}
+  spec.homepage      = 'https://github.com/mrexox/commissioner'
+  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['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/mrexox/commissioner'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.11'
+  spec.add_runtime_dependency 'dry-auto_inject', '~> 0.6'
+  spec.add_runtime_dependency 'money', '~> 6.13.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/commissioner.rb

@@ -0,0 +1,16 @@
+require 'commissioner/version'
+require 'commissioner/calculator'
+require 'commissioner/mixin'
+require 'dry-configurable'
+
+module Commissioner
+  extend Dry::Configurable
+
+  # A lambda that accepts from_currency, to_currency, amount
+  setting :exchanger, reader: true # arity = 3
+  setting :rounding_mode, :half_up # possible values: :up, :down, :half_up, :half_even
+
+  def self.calculate(params)
+    Calculator.new(params, config: self.config).calculate
+  end
+end

data/lib/commissioner/calculator.rb

@@ -0,0 +1,131 @@
+require 'money'
+
+module Commissioner
+  class Calculator
+    AmountUnknown = Class.new(StandardError)
+    CommissionerArityInvalid = Class.new(StandardError)
+
+    HELP_MESSAGE = 'You must provider either charged_amount (with charged_currency) or received_amount (with received_currency). If none or both are non-zero, the service cannot know how to handle this.'.freeze
+    DEFAULT_ORDER = [
+      :reduce_commission,
+      :exchange,
+      :reduce_exchange_commission
+    ].freeze
+
+    private_constant :HELP_MESSAGE
+
+
+    def initialize(params, config:, order: DEFAULT_ORDER)
+      @charged_amount = guess_amount(params[:charged_amount], params[:charged_currency])
+      @received_amount = guess_amount(params[:received_amount], params[:received_currency])
+
+      @exchange_commission = params[:exchange_commission] || 0
+      @commission = params[:commission] || 0
+
+      unless config.exchanger.is_a?(Proc) && config.exchanger.arity == 3
+        raise CommissionerArityInvalid.new("'exchanger' setting must be a lambda with arity of 3")
+      end
+
+      @exchanger = config.exchanger
+      @rounding_mode =
+        case config.rounding_mode
+        when :up
+          BigDecimal::ROUND_UP
+        when :down
+          BigDecimal::ROUND_DOWN
+        when :half_even
+          BigDecimal::ROUND_HALF_EVEN
+        else
+          BigDecimal::ROUND_HALF_UP
+        end
+      @order = order
+    end
+
+    def calculate
+      if !empty?(@received_amount) && empty?(@charged_amount)
+        @charged_amount = calculate_for_received
+      elsif !empty?(@charged_amount) && empty?(@received_amount)
+        @received_amount = calculate_for_charged
+      else
+        raise AmountUnknown.new(HELP_MESSAGE)
+      end
+
+      OpenStruct.new(
+        received_amount: @received_amount,
+        charged_amount: @charged_amount,
+        fee: @fee,
+        exchange_fee: @exchange_fee,
+        exchange_rate: @exchange_rate
+      )
+    end
+
+    private
+
+    attr_reader :exchange_commission, :commission, :exchanger
+
+    def empty?(amount)
+      amount.nil? || amount.zero?
+    end
+
+    def calculate_for_received
+      amount = @received_amount
+
+      amount, @exchange_fee = add_commission(amount, exchange_commission)
+
+      amount, @exchange_rate = exchange(amount) if @charged_amount.currency != @received_amount.currency
+
+      amount, @fee = add_commission(amount, commission)
+
+      amount
+    end
+
+    def calculate_for_charged
+      amount = @charged_amount
+
+      amount, @fee = reduce_commission(amount, commission)
+
+      amount, @exchange_rate = exchange(amount) if @charged_amount.currency != @received_amount.currency
+
+      amount, @exchange_fee = reduce_commission(amount, exchange_commission)
+
+      amount
+    end
+
+    def guess_amount(amount, currency)
+      case amount
+      when Money
+        amount
+      when Numeric
+        Money.from_amount(amount, currency) if currency.is_a?(String)
+      when NilClass
+        Money.new(0, currency) if currency.is_a?(String)
+      end
+    end
+
+    def reduce_commission(amount, commission)
+      return 0 unless commission
+      fee = round(amount.to_f * commission / 100, amount.currency.to_s)
+      amount -= fee
+
+      [amount, fee]
+    end
+
+    def add_commission(amount, commission)
+      return 0 unless commission
+      fee = round(amount.to_f * commission / (100 - commission), amount.currency.to_s)
+      amount += fee
+
+      [amount, fee]
+    end
+
+    def round(decimal, currency)
+      Money.with_rounding_mode(@rounding_mode) do
+        Money.from_amount(decimal, currency)
+      end
+    end
+
+    def exchange(amount)
+      exchanger.call(@charged_amount.currency.to_s, @received_amount.currency.to_s, amount)
+    end
+  end
+end

data/lib/commissioner/mixin.rb

@@ -0,0 +1,16 @@
+module Commissioner
+  module Mixin
+    # TODO: Allow configuring order of operations
+    # Order = ->(*order) { @@order = order }
+
+    # @@order = [
+    #   :commission,
+    #   :exchange,
+    #   :exchange_commission
+    # ]
+
+    def calculate(params)
+      Calculator.new(params, config: Commissioner.config, order: @@order).calculate
+    end
+  end
+end

data/lib/commissioner/version.rb

@@ -0,0 +1,3 @@
+module Commissioner
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: commissioner-guy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Valentine Kiselev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: dry-auto_inject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.13.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.13.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: A simple gem to calculate money based on provided amounts.
+email:
+- mrexox@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".irbrc"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- commissioner.gemspec
+- lib/commissioner.rb
+- lib/commissioner/calculator.rb
+- lib/commissioner/mixin.rb
+- lib/commissioner/version.rb
+homepage: https://github.com/mrexox/commissioner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mrexox/commissioner
+  source_code_uri: https://github.com/mrexox/commissioner
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A simple gem to calculate money based on provided amounts.
+test_files: []