konvert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99e29e8e28ca257057af2d543483a9ac42941a32
+  data.tar.gz: a372b06dfed1b8991012e5663153e4818e829942
+SHA512:
+  metadata.gz: ada89fbe2a5226f98dd4910f994ac347c023d1d1748c88aa1b8408d6cbc364cbae6381c3a6915f90f54a784f7e82d7c7f9db4905e70f04851a53c75317434fb2
+  data.tar.gz: 21e21f0b67dfff5e6a0d566d1bee29a7f4c7fd12056115d843d7be1e6e6b544bd59d2cb41aa5df16f0e517df0bf17b1df0e5e4b6dec0847d269617ea45bb7805

data/.gitignore

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

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nauman Tahir
+
+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,55 @@
+# Konvert
+
+Konvert is a Ruby command line gem that lets you convert between different currencies and perform arithmetic operations on them from the command line. Just set the currency rates and have fun..  
+
+## Installation
+
+ install it as:
+
+    $ gem install konvert
+
+## Usage
+
+1- After installing the gem, enter irb console and require konvert:
+
+    irb(main): require 'konvert'
+
+2- Configure the currency rates with respect to a base currency (here EUR):
+
+    irb(main): Money.conversion_rates('EUR', {
+        'USD'     => 1.11,
+        'Bitcoin' => 0.0047
+      })
+
+3- You can perform the operations now. Examples:
+   1) Create a Money object  
+    
+    irb(main): five_euro = Konvert::Money.new(5,'EUR)
+   2) Convert to different currency
+    
+    irb(main): five_euro.convert_to('USD') 
+   3) Add two Money objects. They can be of same or different currencies
+   
+    irb(main): fifty_eur + twenty_dollars                # => 68.02 EUR
+    irb(main): fifty_eur - twenty_dollars                  # => 31.98 EUR
+
+ 
+   4) Divide or multiply a Money object with an integer
+    
+    irb(main): fifty_eur / 2                         # => 25 EUR
+    irb(main): twenty_dollars * 3             # => 60 USD
+   
+  
+   5) Perform Comparisons (same currencies or in different currencies):  
+    
+    irb(main): twenty_dollars == Money.new(20, 'USD')          # => true
+    irb(main): twenty_dollars == Money.new(30, 'USD')          # => false
+    irb(main): twenty_dollars > Money.new(5, 'USD')               # => true
+    irb(main): twenty_dollars < fifty_eur                                    # => true
+    
+ 
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'konvert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "konvert"
+  spec.version       = Konvert::VERSION
+  spec.authors       = ["Nauman Tahir"]
+  spec.email         = ["nomibzu@gmail.com"]
+
+  spec.summary       = %q{Currency converter gem}
+  spec.description   = %q{Konvert is a Ruby command line gem that lets you convert between different currencies and perform arithmetic operations on them from the command line. Just set the currency rates and have fun..}
+  spec.homepage      = "https://github.com/Nauman-nxvt/konvert"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

data/lib/konvert/version.rb

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

data/lib/konvert.rb

@@ -0,0 +1,6 @@
+require "konvert/version"
+
+module Konvert
+  require_relative 'money'
+  require_relative 'operations'
+end

data/lib/money.rb

@@ -0,0 +1,67 @@
+module Konvert
+  require 'pry'
+  require_relative '../lib/operations'
+  class Money
+    include Konvert::Operations
+
+    attr_accessor :amount
+    attr_accessor :currency
+
+    def self.conversion_rates(base,currency_hash)
+      @@base_currency = base
+      @@currency_hash = currency_hash
+    end
+
+    def self.base_currency
+      @@base_currency
+    end
+
+    def self.currency_hash
+      @@currency_hash
+    end
+
+    def initialize(amount, currency)
+      @amount = amount
+      @currency = currency
+    end
+
+    def inspect
+      p sprintf('%.2f', amount) + ' ' + currency
+    end
+
+    def convert_to_base_amount
+      return unless (conversion_rates_set? && currency_defined?)
+      self.currency == Money.base_currency ? self.amount : self.amount /  Money.currency_hash[self.currency]
+    end
+
+    def convert_to(to_currency)
+      return unless (conversion_rates_set? && currency_defined?)
+      if to_currency == Money.base_currency
+        amount =  self.convert_to_base_amount
+      else
+        amount_in_base = self.convert_to_base_amount
+        amount = amount_in_base * Money.currency_hash[to_currency]
+      end
+      Money.new(amount, to_currency)
+    end
+
+    def conversion_rates_set?
+      if (defined?(@@base_currency)).nil? || (defined?(@@currency_hash)).nil?
+        p "Conversion rates not set: Please set conversion rates first."
+        exit(false)
+        #abort 'Conversion rates not set: Please set conversion rates first.'
+      else
+        true
+      end
+    end
+    def currency_defined?
+      unless (@@currency_hash.key?(self.currency) || self.currency == @@base_currency)
+        p "Invalid currency: Rates for #{self.currency} not defined in currency hash"
+        exit(false)
+        #abort "Invalid currency: Rates for #{self.currency} not defined in currency hash"
+      else
+        true
+      end
+    end
+  end
+end

data/lib/operations.rb

@@ -0,0 +1,50 @@
+module Konvert
+  module Operations
+
+    def perform_sum(operand1,operand2,operation)
+      amount1 = operand1.convert_to_base_amount
+      amount2 = operand2.convert_to_base_amount
+      sum_in_base_currency = send(operation, amount1, amount2)
+      result = Money.new(sum_in_base_currency, Money.base_currency)
+      operand1.currency == Money.base_currency ? result : result.convert_to(operand1.currency)
+    end
+
+    def add(val1,val2)
+      val1 + val2
+    end
+
+    def subtract(val1,val2)
+      val1 - val2
+    end
+
+    def +(operand)
+      perform_sum(self,operand,'add')
+    end
+
+    def -(operand)
+      perform_sum(self,operand,'subtract')
+    end
+
+    def *(operand)
+      Money.new(self.amount * operand, self.currency)
+    end
+
+    def /(operand)
+      Money.new(self.amount / operand, self.currency)
+    end
+
+    # Comparisons
+
+    def ==(operand)
+      return self.convert_to_base_amount == operand.convert_to_base_amount
+    end
+
+    def >(operand)
+      return self.convert_to_base_amount > operand.convert_to_base_amount
+    end
+
+    def <(operand)
+      return self.convert_to_base_amount < operand.convert_to_base_amount
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: konvert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nauman Tahir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: pry
+  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'
+- !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: Konvert is a Ruby command line gem that lets you convert between different
+  currencies and perform arithmetic operations on them from the command line. Just
+  set the currency rates and have fun..
+email:
+- nomibzu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/vcs.xml"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- konvert.gemspec
+- lib/konvert.rb
+- lib/konvert/version.rb
+- lib/money.rb
+- lib/operations.rb
+homepage: https://github.com/Nauman-nxvt/konvert
+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: Currency converter gem
+test_files: []