xchange 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac10f4a1aa03608b79a6cd56de97a17c8fd36e5b
+  data.tar.gz: 2bf8acb13169eab8784163548f9b3c5908073139
+SHA512:
+  metadata.gz: 13a22b98e9e494e462d340227706e822c61d7895bb56872a650d168dbd6575e1f6e0466fff21d9385d15e2f55913b1c26302a11d7cfac3f193ae1e680cbcb3f3
+  data.tar.gz: d1e8b0784a0da122e689bb1ed59b7ae126f49e5863f45ba3f49b4572952eefeca143b23a6dc96d6f960d43be0974dcdae9e9dc76565a9a9ced623f5dbbe7e080

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xchange.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 acaporrini
+
+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,78 @@
+# Xchange
+
+A Library for dealing with currency conversion and operations between different currencies.
+
+## Installation
+
+    $ gem install xchange
+
+## Usage
+
+Require Xchange
+
+```ruby
+require 'xchange'
+```
+
+Configure the currency rates with respect to a base currency
+
+```ruby
+Xchange.conversion_rates('EUR', {'USD' => 1.11, 'Bitcoin' => 0.0047})
+```
+Instantiate Xchange objects
+```ruby
+  fifty_eur = Xchange.new(50, 'EUR')
+```
+Get amount and currency
+```ruby
+  fifty_eur.amount   # => 50
+
+  fifty_eur.currency # => "EUR"
+
+  fifty_eur.inspect  # => "50.00 EUR"
+```
+Convert to a different currency
+```ruby
+  fifty_eur.convert_to('USD') # => 55.50 USD
+```
+Perform operations in different currencies
+```ruby
+  twenty_dollars = Xchange.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 == Xchange.new(20, 'USD') # => true
+
+  twenty_dollars == Xchange.new(30, 'USD') # => false
+
+  fifty_eur_in_usd = fifty_eur.convert_to('USD')
+
+  fifty_eur_in_usd == fifty_eur          # => true
+
+  twenty_dollars > Xchange.new(5, 'USD')   # => true
+
+  twenty_dollars < fifty_eur             # => true
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/acaporrini/xchange/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xchange.rb

@@ -0,0 +1,210 @@
+require 'bigdecimal'
+
+=begin rdoc
+
+An instance of Xchange represents an amount of a specific currency.
+
+
+=Usage
+
+====Install
+  gem install Xchange
+====Require Xchange
+
+  require 'xchange'
+
+==== Configure the currency rates with respect to a base currency
+
+  Xchange.conversion_rates('EUR', {'USD' => 1.11, 'Bitcoin' => 0.0047})
+
+====Instantiate Xchange objects
+
+  fifty_eur = Xchange.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
+
+  fifty_eur.convert_to('USD') # => 55.50 USD
+
+====Perform operations in different currencies
+
+  twenty_dollars = Xchange.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 == Xchange.new(20, 'USD') # => true
+
+  twenty_dollars == Xchange.new(30, 'USD') # => false
+
+  fifty_eur_in_usd = fifty_eur.convert_to('USD')
+
+  fifty_eur_in_usd == fifty_eur          # => true
+
+  twenty_dollars > Xchange.new(5, 'USD')   # => true
+
+  twenty_dollars < fifty_eur             # => true
+
+
+=end
+
+
+class Xchange
+
+  # Include the Comparable Mixins to implement the comparison methods
+  include Comparable
+
+  # Accessor method
+  attr_reader :currency, :amount_bigdecimal
+
+  #Creates a new Xchange object of value given by amount parameter,  with the currency given by the currency parameter
+  #
+  # @example
+  #   Xchange.new(100, "USD") #=> "100.00 USD"
+  #   Xchange.new(100, "EUR") #=> "100.00 EUR"
+  def initialize (amount, currency)
+
+    #Amount is stored in BigDecimal for better precision in currency operations
+    @amount_bigdecimal = BigDecimal.new(amount,0)
+
+    @currency = currency
+
+  end
+
+  #Class method that configure the currency rates with respect to a base currency
+  #
+  # @example
+  #   Xchange.conversion_rates('EUR',{'USD' => 1.11, 'bitcoin' => 0.00047})
+  def self.conversion_rates(base_currency, rates)
+
+    @@base_currency = base_currency
+
+    @@rates = rates
+
+  end
+
+  #Convenience method for amount, it returns the value in float rounded by two decimals.
+  def amount
+
+    @amount_bigdecimal.to_f.round(2)
+
+  end
+
+  #Convenience method that overrides the output of inspect
+  def inspect
+
+    "#{'%.02f' % (@amount_bigdecimal)} #{@currency}"
+
+  end
+
+  #Converts an instance to another currency
+  #
+  # @example
+  # Xchange.new(50, 'EUR').convert_to('USD') #=> "55.50 USD"
+  def convert_to(new_currency)
+
+    # if the instance is already in the requested currency
+    if @currency == new_currency
+
+      #returns itself without conversions
+      return self
+
+    # if  the current currency is different from the base currency used for conversions
+    # and also the new currency is different from the base one
+    elsif @currency != @@base_currency && new_currency != @@base_currency
+
+      # amount is divided by the rate of the current currency in order to convert it to the base currency
+      # then is multiplied by the rate of the new currency
+      amount = (@amount_bigdecimal/(BigDecimal(@@rates[@currency],0))) * (BigDecimal(@@rates[new_currency],0))
+
+    # current currency is different from the base currency but new currency equals the base currency
+    elsif @currency != @@base_currency && new_currency == @@base_currency
+
+      # amount is divided by the rate of the current currency in order to convert it to the base currency
+      amount = (@amount_bigdecimal  / @@rates[@currency])
+
+    # current currency must be equal to the base currency and be different from the new currency
+    else
+
+      # amount is multiplied for the rate of the new currency
+      amount = @amount_bigdecimal * (BigDecimal.new(@@rates[new_currency],0))
+
+    end
+
+    # A new istance is returned with the new currency and the calculated amount
+    Xchange.new(amount,new_currency)
+
+  end
+
+  # <=> implementation allows the comparison between two Xchange instances through the Comparable mixin
+  def <=>(another_currency)
+
+    #converts the given instance in the actual currency and compares the amounts
+    @amount_bigdecimal <=> another_currency.convert_to(@currency).amount_bigdecimal
+
+  end
+
+  # Performs an addition between the current instance and another one and
+  # returns the result as a new Xchange instance
+  def +(another_currency)
+
+    #converts the given instance in the actual currency and sums the amounts
+    amount = @amount_bigdecimal + another_currency.convert_to(@currency).amount
+
+    #returns the result as a new instance
+    Xchange.new(amount,@currency)
+
+  end
+
+  # Performs a subtraction between the current instance and another one and
+  # returns the result as a new Xchange instance
+  def -(another_currency)
+
+    #converts the given instance in the actual currency and substracts the amounts
+    amount= @amount_bigdecimal - another_currency.convert_to(@currency).amount
+
+    #returns the result as a new instance
+    Xchange.new(amount,@currency)
+
+  end
+
+  # Multiplies the amount by a given number
+  def *(number)
+
+    #performs the multiplication in BigDecimal
+    amount= @amount_bigdecimal * BigDecimal(number,0)
+
+    #returns the result as a new instance
+    Xchange.new(amount,@currency)
+
+  end
+
+  # Divides the amount by a given number
+  def /(number)
+
+    #performs the division in BigDecimal
+    amount= @amount_bigdecimal / BigDecimal(number,0)
+
+    #returns the result as a new instance
+    Xchange.new(amount,@currency)
+
+  end
+
+
+end

data/lib/xchange/version.rb

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

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/xchange.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xchange/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xchange"
+  spec.version       = Xchange::VERSION
+  spec.authors       = ["acaporrini"]
+  spec.email         = ["a.caporrini@gmail.com"]
+  spec.summary       = "A Library for dealing with currency conversion and operations between different currencies."
+  spec.homepage      = "http://rubygems.org/gems/xchange"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: xchange
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- acaporrini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- a.caporrini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xchange.rb
+- lib/xchange/version.rb
+- tasks/rspec.rake
+- xchange.gemspec
+homepage: http://rubygems.org/gems/xchange
+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.4.7
+signing_key: 
+specification_version: 4
+summary: A Library for dealing with currency conversion and operations between different
+  currencies.
+test_files: []