dw-currency-converter 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4d4a4ab4d553ef7f457dcc80f3e9cf8dbc7f20e
+  data.tar.gz: 8bee05eb9e939928cf76e3ffaac787a8247b249a
+SHA512:
+  metadata.gz: ccc71c1f3fee718d04f8bb27f4c52ee21326530fccc80418db7766aab933383b65793dcc1646c321eac88f70ad333f3e49dadaf8ecc4a669aafa33d3f742d181
+  data.tar.gz: b716045ab0c69fc4f1696797522e77482c2b3b18c4ae1a5d1cebd257bd6ce9f32f628d06e726771cac8195a49c5a35efdff98c156472f25e8849246bb1b1d86c

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.semver

@@ -0,0 +1,5 @@
+---
+:major: 0
+:minor: 0
+:patch: 0
+:special: ''

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "semver", "~> 1.0.1"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "juwelier", "~> 2.1.0"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.1.3)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.14.5)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2 (~> 1.0)
+    hashie (3.4.6)
+    highline (1.7.8)
+    json (1.8.3)
+    juwelier (2.1.3)
+      builder
+      bundler (>= 1.13)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    jwt (1.5.6)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.0.1)
+    rake (11.3.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    semver (1.0.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    yard (0.9.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  juwelier (~> 2.1.0)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  semver (~> 1.0.1)
+  simplecov
+  yard (~> 0.7)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Fred Mitchell
+
+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.org

@@ -0,0 +1,96 @@
+* Ruby/Fullstack Task
+  This is a simple gem to do currency conversion. It was inspired
+  by a challenge from a particular firm, but might be useful
+  to you otherwise.
+
+** Documentation
+   Please see the tests in [[./spec/money_spec.rb][RSpec Money Test]] as an example of usage.
+
+** Canidate Challenge
+*** Canidate Note
+    I added simplified exception handling for attempted
+    conversions that are not covered. 
+
+*** Requirements and Expectations
+    Hello dear candidate,
+
+as part of the interview process to join the DaWanda Engineering Team,
+we would ask you to complete a short homework task. We hope you will
+enjoy it :)
+
+We estimate the time needed to complete this task to be in the range of
+a few hours. During evaluation, we focus mostly on:
+
+-  Structure of the code
+-  Proper testing
+-  Consistency of the code style
+-  Correctness of the solution
+-  Simplicity vs. over-engineering
+
+Here is your task:
+
+Write a Ruby gem to perform currency conversion and arithmetics with
+different currencies (we know there are already gems for that, but for
+the sake of the exercise implement your own ;) ). The expected features
+and the usage of the gem should be something like this:
+
+#+BEGIN_EXAMPLE
+    # Configure the currency rates with respect to a base currency (here EUR):
+
+    Money.conversion_rates('EUR', {
+      'USD'     => 1.11,
+      'Bitcoin' => 0.0047
+    })
+
+    # Instantiate money objects:
+
+    fifty_eur = Money.new(50, 'EUR')
+
+    # Get amount and currency:
+
+    fifty_eur.amount   # => 50
+    fifty_eur.currency # => "EUR"
+    fifty_eur.inspect  # => "50.00 E0UR"
+
+    # 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 = 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 == Money.new(20, 'USD') # => true
+    twenty_dollars == Money.new(30, 'USD') # => false
+
+    fifty_eur_in_usd = fifty_eur.convert_to('USD')
+    fifty_eur_in_usd == fifty_eur          # => true
+
+    twenty_dollars > Money.new(5, 'USD')   # => true
+    twenty_dollars < fifty_eur             # => true
+#+END_EXAMPLE
+
+For the purpose of this exercise, when implementing equality, you can
+consider two monetary amounts as equal if they agree up to the cents.
+
+You might want to namespace your gem not to conflict with existing gems
+with the same name.
+
+Keep it simple, no need to support other features rather than these. The
+clearer your code the better. But please write tests or documentation
+whenever it makes sense. Think as if other people will have to use your
+gem or contribute to it.
+
+Please note that the actual numbers here are based on the conversion
+rate at the time we wrote the task. With different rates you will get
+different numbers.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'semver'
+
+def s_version
+  SemVer.find.format "%M.%m.%p%s"
+end
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "dw-currency-converter"
+  gem.homepage = "http://github.com/flajann2/dw-currency-converter"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple Conversion between currencies using a base currency.}
+  gem.description = %Q{Convert between any two specified currencies.
+ This is not ready for prime-time usage yet, but
+ can be used for now in non-production code.}
+  gem.email = "fred.mitchell@gmx.de"
+  gem.authors = ["Fred Mitchell"]
+  gem.version = s_version
+  gem.required_ruby_version = '>= 2.3.1'
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/dw-currency-converter.gemspec

@@ -0,0 +1,71 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: dw-currency-converter 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "dw-currency-converter".freeze
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Fred Mitchell".freeze]
+  s.date = "2016-11-09"
+  s.description = "Convert between any two specified currencies.\n This is not ready for prime-time usage yet, but\n can be used for now in non-production code.".freeze
+  s.email = "fred.mitchell@gmx.de".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.org"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".semver",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.org",
+    "Rakefile",
+    "dw-currency-converter.gemspec",
+    "lib/dw-currency-converter.rb",
+    "spec/money_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/flajann2/dw-currency-converter".freeze
+  s.licenses = ["MIT".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.1".freeze)
+  s.rubygems_version = "2.6.7".freeze
+  s.summary = "Simple Conversion between currencies using a base currency.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<semver>.freeze, ["~> 1.0.1"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 2.8.0"])
+      s.add_development_dependency(%q<yard>.freeze, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<semver>.freeze, ["~> 1.0.1"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 2.8.0"])
+      s.add_dependency(%q<yard>.freeze, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<semver>.freeze, ["~> 1.0.1"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 2.8.0"])
+    s.add_dependency(%q<yard>.freeze, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+  end
+end
+

data/lib/dw-currency-converter.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+module DwCurrencyConv
+  class Money
+    attr :amount, :currency
+
+    def self.conversion_rates base, rate_list
+      @@base_currency = base.to_s
+      @@rate_list = rate_list.to_h
+      @@rate_list[base] = 1.0 # to simplify conversion logic
+    end
+    
+    def initialize amount, currency
+      @amount = amount.to_f
+      @currency = currency.to_s
+    end
+
+    def convert_to(currency)
+      begin
+        if currency == @@base_currency # converting to base currency
+          Money.new(self.amount * 1.0 / @@rate_list[self.currency], currency)
+          
+        elsif self.currency == @@base_currency # converting from the base currency
+          Money.new(self.amount * @@rate_list[currency] / 1.0, currency)
+          
+        else # converting between currencies -- first conver to base, then from base to target
+          convert_to(@@base_currency).convert_to(currency)
+        end
+      rescue => e
+        raise "Problem with converting #{self.currency} to #{currency}: #{e}"
+      end
+    end
+    
+    # Add these two objects and yield a third.
+    def +(other_money)
+      Money.new(amount +
+                other_money.convert_to(currency).amount,
+                self.currency)
+    end
+    
+    def -(other_money)
+      Money.new(self.amount -
+                other_money.convert_to(self.currency).amount,
+                self.currency)
+    end
+    
+    def *(x)
+      Money.new(self.amount * x, self.currency)
+    end
+    
+    def /(x)
+      Money.new(self.amount / x, self.currency)
+    end
+    
+    def >(other_money)
+      self.amount > other_money.convert_to(self.currency).amount
+    end
+    
+    def <(other_money)
+      self.amount < other_money.convert_to(self.currency).amount
+    end
+
+    def ==(other_money)
+      amount.round(2) == other_money.convert_to(currency).amount.round(2)
+    end
+
+    def inspect
+      "%.2f #{currency}" % [amount.round(2)]
+    end
+  end  
+end

data/spec/money_spec.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require_relative 'spec_helper'
+
+include DwCurrencyConv
+
+describe Money do
+  before(:all) do
+    Money.conversion_rates 'EUR', {
+                             'USD'     => 1.11,
+                             'Bitcoin' => 0.0047,
+                             'PHP'     => 53.768438,
+                             'PLN'     => 4.34457705
+                           }
+    @a = Money.new 20, 'EUR'
+    @b = Money.new 40, 'USD'
+    @fifty_eur = Money.new 50, 'EUR'
+    @twenty_dollars = Money.new 20, 'USD'
+  end
+  
+  it "can add two currencies" do
+    a_plus_b = @a + @b
+    expect(a_plus_b.inspect).to eq("56.04 EUR")
+  end
+
+  it "can convert between non-base currencies" do
+    from = Money.new 2000, 'PHP'
+    to = from.convert_to 'USD'
+    expect(to.amount.round(2)).to eq(41.29)
+  end
+
+  it "get amount and currency" do
+    expect(@fifty_eur.amount).to eq(50)
+    expect(@fifty_eur.currency).to eq('EUR')
+    expect(@fifty_eur.inspect).to eq('50.00 EUR')
+  end
+
+  it "convert to a different currency" do
+    expect(@fifty_eur.convert_to('USD').inspect).to eq('55.50 USD')
+  end
+
+  it "does arithemetics" do
+    expect((@fifty_eur + @twenty_dollars).inspect).to eq('68.02 EUR')
+    expect((@fifty_eur - @twenty_dollars).inspect).to eq('31.98 EUR')
+    expect((@fifty_eur / 2).inspect).to               eq('25.00 EUR')
+    expect((@twenty_dollars * 3).inspect).to          eq('60.00 USD')    
+  end
+
+  it "does comparasions" do
+    expect(@twenty_dollars == Money.new(20, 'USD')).to be_truthy
+    expect(@twenty_dollars == Money.new(30, 'USD')).to be_falsey
+
+    fifty_eur_in_usd = @fifty_eur.convert_to('USD')
+    
+    expect(fifty_eur_in_usd == @fifty_eur).to          be_truthy
+    expect(@twenty_dollars > Money.new(5, 'USD')).to   be_truthy
+    expect(@twenty_dollars < @fifty_eur).to             be_truthy
+  end
+
+  it "throws an exception if currency is not recognized" do
+    expect {
+      @twenty_dollars.convert_to('XXX')
+    }.to raise_error /Problem with converting EUR to XXX/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+require 'dw-currency-converter'
+require 'pp'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+  
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: dw-currency-converter
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Fred Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: |-
+  Convert between any two specified currencies.
+   This is not ready for prime-time usage yet, but
+   can be used for now in non-production code.
+email: fred.mitchell@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.org
+files:
+- ".document"
+- ".rspec"
+- ".semver"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.org
+- Rakefile
+- dw-currency-converter.gemspec
+- lib/dw-currency-converter.rb
+- spec/money_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/flajann2/dw-currency-converter
+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.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: Simple Conversion between currencies using a base currency.
+test_files: []