monefy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f80d9004701e3d2aa7f6b356133cd02b87436710
+  data.tar.gz: 65ff94cf1affd47ec6b13f0adcd8c4d2562683e6
+SHA512:
+  metadata.gz: 0d67271662357e8e954a1c573e7b49aaa5ac4b056552ca904cc1e6f4eb290c5684a28963482246ac5caf78bf313054da37a2378135885cfd78e6b1df2596ef7b
+  data.tar.gz: ca0000483caa721e668103c3855e2c2c47b930d8b03c4b68e0bfb8f7bea9f9c65197821ea255f62bea428936a698c610a55132ae76c81599c993c46a7d874792

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in monefy.gemspec
+gemspec
+
+gem 'coveralls', '>= 0.8.17', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bruno Almeida
+
+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,134 @@
+[![Build Status](https://travis-ci.org/wwwbruno/monefy.svg?branch=master)](https://travis-ci.org/wwwbruno/monefy)
+[![Code Climate](https://codeclimate.com/github/wwwbruno/monefy/badges/gpa.svg)](https://codeclimate.com/github/wwwbruno/monefy)
+[![Coverage Status](https://coveralls.io/repos/github/wwwbruno/monefy/badge.svg?branch=master)](https://coveralls.io/github/wwwbruno/monefy?branch=master)
+[![Inline docs](http://inch-ci.org/github/wwwbruno/monefy.svg?branch=master)](http://inch-ci.org/github/wwwbruno/monefy)
+
+# Monefy
+
+This gem will easily help you to perform currency conversion and arithmetics with different currencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monefy', github: 'wwwbruno/monefy'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+#### Set your conversion rates on your Initialize file
+```ruby
+Monefy.conversion_rates('EUR', {
+  'USD'     => 1.11,
+  'Bitcoin' => 0.0047
+}) # => {"USD"=>1.11, "Bitcoin"=>0.0047, "EUR"=>1}
+```
+
+#### Create a new Monefy instance passing amount and currency as initializer parameters
+```ruby
+fifty_eur = Monefy.new(50, 'EUR')
+# => #<Monefy:0x... @amount=50.0, @currency="EUR">
+```
+
+#### Convert to another currencies
+```ruby
+fifty_eur.convert_to('USD')
+# => #<Monefy:0x... @amount=55.5, @currency="USD">
+fifty_eur.convert_to('Bitcoin')
+# => #<Monefy:0x... @amount=0.24, @currency="Bitcoin">
+```
+
+#### Add and subtract with other Monefy instances with different currencies
+```ruby
+fifty_eur + Monefy.new(20, 'USD')
+# => #<Monefy:0x... @amount=68.02, @currency="EUR">
+fifty_eur - Monefy.new(0.03, 'Bitcoin')
+# => #<Monefy:0x... @amount=43.62, @currency="EUR">
+```
+
+#### Multiply and divide
+```ruby
+fifty_eur / 2
+# => #<Monefy:0x... @amount=25.0, @currency="EUR">
+fifty_eur * 3
+# => #<Monefy:0x... @amount=150.0, @currency="EUR">
+```
+
+#### Compare different currencies:
+```ruby
+fifty_eur > Monefy.new(54.55, 'USD') # => true
+Monefy.new(180, 'USD') < Monefy.new(0.73, 'Bitcoin') # => false
+Monefy.new(54.55, 'USD') == Monefy.new(49.14, 'EUR') # => true
+Monefy.new(35, 'USD') != Monefy.new(49.14, 'EUR') # => true
+```
+
+## Exceptions
+#### Instantiate class without setting conversion rates
+```ruby
+Monefy.new(50, 'USD')
+# => StandardError: No conversion rates set
+
+# Solution
+# Set your conversion rates on your Initialize file
+Monefy.conversion_rates('EUR', {
+  'USD'     => 1.11,
+  'Bitcoin' => 0.0047
+}) # => {"USD"=>1.11, "Bitcoin"=>0.0047, "EUR"=>1}
+```
+
+#### Instantiate class or call convert_to to method with invalid current
+```ruby
+Monefy.new(50, 'INVALID-CURRENCY')
+# => StandardError: "Invalid currency"
+
+Monefy.new(50, 'EUR').convert_to('INVALID-CURRENCY')
+# => StandardError: "Invalid currency"
+```
+
+#### Compare Monefy instance without another Monefy instance
+```ruby
+Monefy.new(50, 'EUR') == 50
+# => StandardError: "Not a Monefy instance"
+
+Monefy.new(50, 'EUR') > "40.0 EUR"
+# => StandardError: "Not a Monefy instance"
+```
+
+#### Adding or subtracting a Monefy instance without another Monefy instance
+```ruby
+Monefy.new(50, 'EUR') + 50
+# => StandardError: "Not a Monefy instance"
+
+Monefy.new(50, 'EUR') - "40.0 EUR"
+# => StandardError: "Not a Monefy instance"
+```
+
+#### Splitting or multiplying a Monefy instance without a Numeric
+```ruby
+Monefy.new(50, 'EUR') / Monefy.new(15, 'EUR')
+# => StandardError: "Not a numeric"
+
+Monefy.new(50, 'EUR') * "40.0 EUR"
+# => StandardError: "Not a numeric"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wwwbruno/monefy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

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

@@ -0,0 +1,97 @@
+require "monefy/converter"
+require "monefy/matchers"
+require "monefy/arithmetic"
+require "monefy/version"
+
+# Monefy instance with two attr_reader
+#
+# @attr_reader amount [Float] is the quantiy of a currency.
+# @attr_reader currency [String] is the string correspondent to the currency.
+class Monefy
+  include Monefy::Converter
+  include Monefy::Matchers
+  include Monefy::Arithmetic
+
+  attr_reader :amount, :currency
+
+  # To create a new instance, pass amout and current as parameters
+  #
+  # @param amount [Integer, Float] quantiy of a currency.
+  # @param currency [String] currency key created on `conversion_rates` method.
+  #
+  # @return [Monefy] all currencies conversion rate.
+  #
+  # @example
+  #   Monefy.new(50, 'EUR') # => #<Monefy:0x... @amount=50.0, @currency="EUR">
+  #
+  # See 'self.conversion_rates' methdo before initializa a new instance
+  def initialize(amount, currency)
+    validate_currencies_rates
+    validate_currency(currency)
+
+    @amount = amount.round(2)
+    @currency = currency
+
+    self
+  end
+
+  # Set default currencies and conversion rates
+  # used to calculate conversions.
+  #
+  # Use this method on your initilizer application
+  # config
+  #
+  # @param main_currency [String] main currency.
+  # @param other_currencies [Hash] currencies relatives to main currency with
+  # key with other currency and value with conversion rate.
+  #
+  # @return [Hash] all currencies conversion rate.
+  #
+  # @example
+  #   Monefy.conversion_rates('EUR', {
+  #     'USD'     => 1.11,
+  #     'Bitcoin' => 0.0047
+  #   }) # => {"USD"=>1.11, "Bitcoin"=>0.0047, "EUR"=>1}
+  def self.conversion_rates(main_currency, other_currencies)
+    @@currencies_rates = other_currencies.merge({ main_currency => 1 })
+  end
+
+  # Return Monefy instance string value
+  #
+  # @return [String] currency and amout string.
+  #
+  # @example
+  #   Monefy.new(50, 'EUR').to_s # => "50.00 EUR"
+  #   "#{Monefy.new(50, 'EUR')}" # => "50.00 EUR"
+  def to_s
+    "#{'%.02f' % amount} #{currency}"
+  end
+
+  private
+
+  def validate_currencies_rates
+    return if @@currencies_rates.present?
+
+    raise StandardError, "No conversion rates set"
+  end
+
+  def validate_currency(currency)
+    return if @@currencies_rates.key? currency
+
+    raise StandardError, "Invalid currency"
+  end
+
+  def validate_monefy_instance(monefy)
+    return if monefy.instance_of? Monefy
+
+    raise StandardError, "Not a Monefy instance"
+  end
+
+  def currencies_rates
+    @@currencies_rates
+  end
+
+  def create_new_instace(new_amount, new_currency)
+    self.class.new(new_amount, new_currency)
+  end
+end

data/lib/monefy/arithmetic.rb

@@ -0,0 +1,90 @@
+class Monefy
+  # Encapsulate all the logic to handle basics arithmetic between two instances.
+  module Arithmetic
+
+    # Sum two Monefy instances
+    #
+    # @param monefy [Monefy] another Monefy instance.
+    #
+    # @return [Monefy] new Monefy instance with added amount.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') + Monefy.new(20, 'USD')
+    #   => #<Monefy:0x... @amount=68.02, @currency="EUR">
+    def + monefy
+      validate_monefy_instance(monefy)
+
+      calculated_amount = amount + converted_money_currency(monefy)
+      create_new_instace(
+        calculated_amount,
+        currency
+      )
+    end
+
+    # Subtract two Monefy instances
+    #
+    # @param monefy [Monefy] another Monefy instance.
+    #
+    # @return [Monefy] new Monefy instance with subtracted amount.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') - Monefy.new(20, 'USD')
+    #   => #<Monefy:0x... @amount=31.98, @currency="EUR">
+    def - monefy
+      validate_monefy_instance(monefy)
+
+      calculated_amount = amount - converted_money_currency(monefy)
+      create_new_instace(
+        calculated_amount,
+        currency
+      )
+    end
+
+    # Split a Monefy instances amount
+    #
+    # @param value [Integer, Float] value to split the Monefy instance amount.
+    #
+    # @return [Monefy] new Monefy instance with splited amount.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') / 2
+    #   => #<Monefy:0x... @amount=25, @currency="EUR">
+    def / value
+      validate_arithmetic_value(value)
+
+      calculated_amount = amount / value
+      create_new_instace(
+        calculated_amount,
+        currency
+      )
+    end
+
+    # Multiply a Monefy instances amount
+    #
+    # @param value [Integer, Float] value to multiply the Monefy instance
+    # amount.
+    #
+    # @return [Monefy] new Monefy instance with multiplied amount.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') * 3
+    #   => #<Monefy:0x... @amount=150, @currency="EUR">
+    def * value
+      validate_arithmetic_value(value)
+
+      calculated_amount = amount * value
+      create_new_instace(
+        calculated_amount,
+        currency
+      )
+    end
+
+    private
+
+    def validate_arithmetic_value(value)
+      return if value.is_a? Numeric
+
+      raise StandardError, "Not a numeric"
+    end
+  end
+end

data/lib/monefy/converter.rb

@@ -0,0 +1,41 @@
+class Monefy
+  # Encapsulate all the logic to convet currencies
+  module Converter
+
+    # Converts a Monefy instance froma a currency to another.
+    #
+    # @param to_currency [String] currency to be converted to.
+    #
+    # @return [Monefy] new Monefy instance converted to another currency.
+    #
+    # @example
+    #   eur = Monefy.new(50, 'EUR')
+    #   eur.convert_to('USD') # => #<Monefy:0x... @amount=55, @currency="USD">
+    def convert_to(to_currency)
+      validate_currency(to_currency)
+
+      calculated_amount = convert_currency(currency, amount, to_currency)
+      create_new_instace(
+        calculated_amount,
+        to_currency
+      )
+    end
+
+    private
+
+    def converted_money_currency(money)
+      convert_currency(
+        money.currency,
+        money.amount,
+        currency
+      ).round(2)
+    end
+
+    def convert_currency(from_currency, from_amount, to_currency)
+      to_currency_rate = currencies_rates[to_currency]
+      from_currency_rate = currencies_rates[from_currency]
+
+      (to_currency_rate * from_amount) / from_currency_rate
+    end
+  end
+end

data/lib/monefy/matchers.rb

@@ -0,0 +1,69 @@
+class Monefy
+  # Encapsulate all the logic to compare differente Monefy instances
+  module Matchers
+
+    # Check if two distinct Monefy instances are equal.
+    #
+    # @param monefy [Monefy] another Monefy instance.
+    #
+    # @return [Boolean] true if both instances are equal and false if they
+    # are different.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') == Monefy.new(40, 'EUR') # => false
+    #   Monefy.new(50, 'EUR') == Monefy.new(55.5, 'USD') # => true
+    def == monefy
+      validate_monefy_instance(monefy)
+
+      amount == converted_money_currency(monefy)
+    end
+
+    # Check if two distinct Monefy instances are different.
+    #
+    # @param monefy [Monefy] another Monefy instance.
+    #
+    # @return [Boolean] true if both instances are different and false if they
+    # are equal.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') != Monefy.new(40, 'EUR') # => true
+    #   Monefy.new(50, 'EUR') != Monefy.new(55.5, 'USD') # => false
+    def != monefy
+      validate_monefy_instance(monefy)
+
+      amount != converted_money_currency(monefy)
+    end
+
+    # Check if one Monefy instance is greater than another.
+    #
+    # @param monefy [Monefy] another Monefy instance.
+    #
+    # @return [Boolean] true if current instace is greater than another and
+    # false if not.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') > Monefy.new(40, 'EUR') # => true
+    #   Monefy.new(50, 'EUR') > Monefy.new(200, 'USD') # => false
+    def > monefy
+      validate_monefy_instance(monefy)
+
+      amount > converted_money_currency(monefy)
+    end
+
+    # Check if one Monefy instance is less than another.
+    #
+    # @param monefy [Monefy] another Monefy instance.
+    #
+    # @return [Boolean] true if current instace is less than another and
+    # false if not.
+    #
+    # @example
+    #   Monefy.new(50, 'EUR') < Monefy.new(40, 'EUR') # => false
+    #   Monefy.new(50, 'EUR') < Monefy.new(200, 'USD') # => true
+    def < monefy
+      validate_monefy_instance(monefy)
+
+      amount < converted_money_currency(monefy)
+    end
+  end
+end

data/lib/monefy/version.rb

@@ -0,0 +1,3 @@
+class Monefy
+  VERSION = "0.1.0"
+end

data/monefy.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "monefy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "monefy"
+  spec.version       = Monefy::VERSION
+  spec.authors       = ["Bruno Almeida"]
+  spec.email         = ["brunom.almd@gmail.com"]
+
+  spec.summary       = "Perform currency conversion and arithmetics with different currencies."
+  spec.description   = "Perform currency conversion and arithmetics with different currencies."
+  spec.homepage      = "https://github.com/wwwbruno/monefy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: monefy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Almeida
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Perform currency conversion and arithmetics with different currencies.
+email:
+- brunom.almd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/monefy.rb
+- lib/monefy/arithmetic.rb
+- lib/monefy/converter.rb
+- lib/monefy/matchers.rb
+- lib/monefy/version.rb
+- monefy.gemspec
+homepage: https://github.com/wwwbruno/monefy
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Perform currency conversion and arithmetics with different currencies.
+test_files: []