foreign_currency_exchange 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f712145f1831ac7938c72551ea7573f15cc58098
+  data.tar.gz: 981ba95ba055ce1523bdf4bda7a5fa4c48f75950
+SHA512:
+  metadata.gz: 5d3b01d2b81041af0db49cb6f65ab90e20d990e9776b4b365c562f8aa2e0bbcd2ce9de09fd89c1fed3fd55ae259896f80cb3de5619e21419f285e6631895eedb
+  data.tar.gz: 9ac7c85f292e5335929dd2046a655efe7da2915cb1f64dfc9ed480bf8d1bac5e1c8c26e6f7463743dc7ffd0e5d838a67974bddd0617d660974ad8f91476d55b2

data/.gitignore

@@ -0,0 +1,3 @@
+# Created by .ignore support plugin (hsz.mobi)
+.idea
+.ruby-*

data/.rubocop.yml

@@ -0,0 +1,19 @@
+# See full list of defaults here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# To see all cops used see here: https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+LineLength:
+  Max: 120
+
+Style/OpMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foreign_currency_exchange.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', require: false
+end
+
+group :development do
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    foreign_currency_exchange (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.3)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  foreign_currency_exchange!
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -0,0 +1,56 @@
+### Installation
+
+```bash
+gem install foreign_currency_exchange
+```
+
+### Usage
+
+```ruby
+require 'foreign_currency_exchange'
+
+# Configure the currency rates with respect to a base currency (here EUR):
+
+ForeignCurrencyExchange::Money.conversion_rates(
+  'EUR',
+  'USD'     => 1.11,
+  'Bitcoin' => 0.0047
+)
+
+# Instantiate money objects:
+
+fifty_eur = ForeignCurrencyExchange::Money.new(50, 'EUR')
+
+# Get amount and currency:
+
+fifty_eur.amount   # => 50
+fifty_eur.currency # => "EUR"
+fifty_eur.inspect  # => "50.00 EUR"
+
+# Convert to a different currency (should return a Money
+# instance, not a String):
+
+fifty_eur.convert_to('USD') # => 55.50 USD
+
+# Perform operations in different currencies:
+
+twenty_dollars = ForeignCurrencyExchange::Money.new(20, 'USD')
+
+# Arithmetics:
+
+fifty_eur + twenty_dollars # => 68.02 EUR
+fifty_eur - twenty_dollars # => 31.98 EUR
+fifty_eur / 2              # => 25 EUR
+twenty_dollars * 3         # => 60 USD
+
+# Comparisons (also in different currencies):
+
+twenty_dollars == ForeignCurrencyExchange::Money.new(20, 'USD') # => true
+twenty_dollars == ForeignCurrencyExchange::Money.new(30, 'USD') # => false
+
+fifty_eur_in_usd = fifty_eur.convert_to('USD')
+fifty_eur_in_usd == fifty_eur                                   # => true
+
+twenty_dollars > ForeignCurrencyExchange::Money.new(5, 'USD')   # => true
+twenty_dollars < fifty_eur                                      # => true
+```

data/foreign_currency_exchange.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path('../lib/foreign_currency_exchange/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'foreign_currency_exchange'
+  gem.version     = ForeignCurrencyExchange::VERSION
+  gem.date        = '2017-04-24'
+  gem.summary     = 'Foreign currency exchange'
+  gem.description = 'Ruby gem to perform currency conversion and arithmetic with different currencies'
+  gem.authors     = ['Konstantin Lynda']
+  gem.email       = 'knlynda@gmail.com'
+  gem.files       = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+  gem.homepage    = 'http://rubygems.org/gems/foreign_currency_exchange'
+  gem.license     = 'MIT'
+end

data/lib/foreign_currency_exchange.rb

@@ -0,0 +1,7 @@
+require 'forwardable'
+
+# This is main namespace for the library
+module ForeignCurrencyExchange
+end
+
+require 'foreign_currency_exchange/money'

data/lib/foreign_currency_exchange/money.rb

@@ -0,0 +1,94 @@
+require 'foreign_currency_exchange/money/exceptions'
+require 'foreign_currency_exchange/money/configuration'
+
+module ForeignCurrencyExchange
+  # This class represents a money object.
+  class Money
+    AMOUNT_FORMAT = '%.2f'.freeze
+    ROUND_LEVEL = 2
+
+    extend Configuration
+    extend Forwardable
+    include Comparable
+
+    attr_reader :amount, :currency
+    def_delegators :'self.class', :base_currency, :rates, :new, :check_configuration
+
+    def initialize(amount, currency)
+      check_configuration # Configuration should be valid.
+      check_currency(currency) # Currency should be configured before.
+      @amount = amount.is_a?(Integer) ? amount : amount.to_f.round(ROUND_LEVEL)
+      @currency = currency
+    end
+
+    # Returns current object amount if currency equals to base_currency
+    #   or converted current object amount to base_currency otherwise.
+    def base_amount
+      return amount if currency == base_currency
+      (amount / rates[currency].to_f).round(ROUND_LEVEL)
+    end
+
+    def <=>(other)
+      base_amount <=> other.base_amount
+    end
+
+    def +(other)
+      new_amount = amount + other.convert_to(currency).amount
+      new(new_amount, currency)
+    end
+
+    def -(other)
+      new_amount = amount - other.convert_to(currency).amount
+      new(new_amount, currency)
+    end
+
+    # Returns new money object with multiplied current object amount,
+    #   parameter multiplier should be kind of Numeric object.
+    def *(multiplier)
+      new(amount * multiplier, currency)
+    end
+
+    # Returns new money object with divided current object amount,
+    #   parameter divider should be kind of Numeric object.
+    def /(divider)
+      raise ZeroDivisionError if divider.zero?
+      new(amount / divider.to_f, currency)
+    end
+
+    def to_s
+      "#{formatted_amount} #{currency}"
+    end
+
+    def inspect
+      to_s
+    end
+
+    # Returns new money object converted to given currency,
+    #   raises UnknownCurrencyError in case when given currency is unknown.
+    def convert_to(other_currency)
+      new_amount = calculate_amount(other_currency)
+      new(new_amount, other_currency)
+    end
+
+    private
+
+    def formatted_amount
+      amount.is_a?(Integer) ? amount.to_s : format(AMOUNT_FORMAT, amount)
+    end
+
+    # Returns amount based on given currency,
+    #   raises UnknownCurrencyError in case when given other_currency is unknown.
+    def calculate_amount(other_currency)
+      check_currency(other_currency)
+      return amount if other_currency == currency
+      return base_amount if other_currency == base_currency
+      base_amount * rates[other_currency]
+    end
+
+    # Checks that currency is known otherwise raises UnknownCurrencyError.
+    def check_currency(currency)
+      return if base_currency == currency || rates.keys.include?(currency)
+      raise UnknownCurrencyError
+    end
+  end
+end

data/lib/foreign_currency_exchange/money/configuration.rb

@@ -0,0 +1,49 @@
+module ForeignCurrencyExchange
+  class Money
+    # This module contains configuration methods for Money class
+    module Configuration
+      BASE_CURRENCY_RATE = 1.0
+
+      attr_reader :base_currency, :rates
+
+      def conversion_rates(base_currency, rates)
+        @rates = rates
+        @base_currency = base_currency
+        check_configuration
+      rescue => exception
+        nullify_configuration
+        raise exception
+      end
+
+      def check_configuration
+        check_rates
+        check_base_currency_rate
+      end
+
+      private
+
+      def nullify_configuration
+        @rates = nil
+        @base_currency = nil
+      end
+
+      def check_rates
+        raise InvalidRatesError unless valid_rates?
+      end
+
+      def check_base_currency_rate
+        raise InvalidBaseCurrencyRateError unless valid_base_currency_rate?
+      end
+
+      def valid_rates?
+        rates.is_a?(Hash) && !rates.empty? &&
+          rates.values.all? { |v| v.is_a?(Numeric) && v.positive? }
+      end
+
+      def valid_base_currency_rate?
+        !rates.key?(base_currency) ||
+          rates[base_currency] == BASE_CURRENCY_RATE
+      end
+    end
+  end
+end

data/lib/foreign_currency_exchange/money/exceptions.rb

@@ -0,0 +1,7 @@
+module ForeignCurrencyExchange
+  class Money
+    UnknownCurrencyError = Class.new(StandardError)
+    InvalidRatesError = Class.new(StandardError)
+    InvalidBaseCurrencyRateError = Class.new(StandardError)
+  end
+end

data/lib/foreign_currency_exchange/version.rb

@@ -0,0 +1,3 @@
+module ForeignCurrencyExchange
+  VERSION = '0.1.1'.freeze
+end

data/spec/lib/money_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+RSpec.describe ForeignCurrencyExchange::Money do
+  before do
+    described_class.conversion_rates(
+      'EUR',
+      'USD'     => 1.11,
+      'Bitcoin' => 0.0047
+    )
+  end
+
+  describe '.new' do
+    subject { described_class.new(amount, currency) }
+
+    context 'when known currency' do
+      let(:currency) { 'USD' }
+      let(:amount) { 50 }
+
+      it { is_expected.to be_an_instance_of described_class }
+      it { expect(subject.currency).to eql currency }
+      it { expect(subject.amount).to eql amount }
+    end
+
+    context 'when currency is base currency' do
+      let(:currency) { 'EUR' }
+      let(:amount) { 100 }
+
+      it { is_expected.to be_an_instance_of described_class }
+      it { expect(subject.currency).to eql currency }
+      it { expect(subject.amount).to eql amount }
+    end
+
+    context 'when unknown currency' do
+      let(:currency) { 'UAH' }
+      let(:amount) { 30 }
+
+      it 'raises UnknownCurrencyError' do
+        expect { subject }.to raise_error described_class::UnknownCurrencyError
+      end
+    end
+  end
+
+  describe '#base_amount' do
+    subject { money_object.base_amount }
+    let(:money_object) { described_class.new(10, currency) }
+
+    context 'when object currency is base currency' do
+      let(:currency) { 'EUR' }
+      it { is_expected.to eql 10 }
+    end
+
+    context 'when object currency is known currency' do
+      let(:currency) { 'USD' }
+      it { is_expected.to eql 9.01 }
+    end
+
+    context 'when object currency is known currency' do
+      let(:currency) { 'Bitcoin' }
+      it { is_expected.to eql 2127.66 }
+    end
+  end
+
+  describe '#<=>' do
+    subject { money_object <=> other_money_object }
+
+    context 'when same amount and currency' do
+      let(:money_object) { described_class.new(5.01, 'EUR') }
+      let(:other_money_object) { described_class.new(5.01, 'EUR') }
+
+      it { is_expected.to be_zero }
+    end
+
+    context 'when amount greater then other amount (0.001)' do
+      let(:money_object) { described_class.new(5.012, 'EUR') }
+      let(:other_money_object) { described_class.new(5.011, 'EUR') }
+
+      it { is_expected.to be_zero }
+    end
+
+    context 'when amount greater then other amount (0.01)' do
+      let(:money_object) { described_class.new(5.02, 'EUR') }
+      let(:other_money_object) { described_class.new(5.01, 'EUR') }
+
+      it { is_expected.to eql 1 }
+    end
+
+    context 'when amount less then other amount (0.01)' do
+      let(:money_object) { described_class.new(5.01, 'EUR') }
+      let(:other_money_object) { described_class.new(5.02, 'EUR') }
+
+      it { is_expected.to eql(-1) }
+    end
+  end
+
+  describe '#+' do
+    subject { money_object + other_money_object }
+
+    let(:money_object) { described_class.new(5, 'EUR') }
+    let(:other_money_object) { described_class.new(10, 'EUR') }
+
+    it { expect(subject.amount).to eql 15 }
+    it { expect(subject.currency).to eql 'EUR' }
+
+    context 'when different currencies' do
+      let(:money_object) { described_class.new(5, 'USD') }
+      let(:other_money_object) { described_class.new(10, 'EUR') }
+
+      it { expect(subject.amount).to eql 16.1 }
+      it { expect(subject.currency).to eql 'USD' }
+    end
+  end
+
+  describe '#-' do
+    subject { money_object - other_money_object }
+
+    let(:money_object) { described_class.new(10, 'EUR') }
+    let(:other_money_object) { described_class.new(5, 'EUR') }
+
+    it { expect(subject.amount).to eql 5 }
+    it { expect(subject.currency).to eql 'EUR' }
+
+    context 'when different currencies' do
+      let(:money_object) { described_class.new(10, 'USD') }
+      let(:other_money_object) { described_class.new(5, 'EUR') }
+
+      it { expect(subject.amount).to eql 4.45 }
+      it { expect(subject.currency).to eql 'USD' }
+    end
+  end
+
+  describe '#*' do
+    subject { described_class.new(10, 'EUR') * 10.00001 }
+
+    it { expect(subject.amount).to eql 100.0 }
+    it { expect(subject.currency).to eql 'EUR' }
+  end
+
+  describe '#/' do
+    subject { described_class.new(10, 'EUR') / 10.00001 }
+
+    it { expect(subject.amount).to eql 1.0 }
+    it { expect(subject.currency).to eql 'EUR' }
+
+    context 'when divider is zero' do
+      subject { described_class.new(10, 'EUR') / 0 }
+
+      it 'raises ZeroDivisionError' do
+        expect { subject }.to raise_error ZeroDivisionError
+      end
+    end
+  end
+
+  describe '#to_s' do
+    context 'when amount is Fixnum' do
+      subject { described_class.new(10, 'EUR').to_s }
+      it { is_expected.to eql '10 EUR' }
+    end
+
+    context 'when amount is Bignum' do
+      subject { described_class.new(999_999_999_999_999_999_999, 'EUR').to_s }
+      it { is_expected.to eql '999999999999999999999 EUR' }
+    end
+
+    context 'when amount is Float' do
+      subject { described_class.new(5.5555, 'EUR').to_s }
+      it { is_expected.to eql '5.56 EUR' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'foreign_currency_exchange'
+
+RSpec.configure(&:disable_monkey_patching!)

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: foreign_currency_exchange
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Konstantin Lynda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-24 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem to perform currency conversion and arithmetic with different
+  currencies
+email: knlynda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- foreign_currency_exchange.gemspec
+- lib/foreign_currency_exchange.rb
+- lib/foreign_currency_exchange/money.rb
+- lib/foreign_currency_exchange/money/configuration.rb
+- lib/foreign_currency_exchange/money/exceptions.rb
+- lib/foreign_currency_exchange/version.rb
+- spec/lib/money/configuration_spec.rb
+- spec/lib/money_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/foreign_currency_exchange
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Foreign currency exchange
+test_files:
+- spec/lib/money/configuration_spec.rb
+- spec/lib/money_spec.rb
+- spec/spec_helper.rb