arbolito 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6578546e1c600d31c863bb8595417a54c6f49e9
+  data.tar.gz: 50f297829ff304dbe48516d5d4a6871aa4a04f7b
+SHA512:
+  metadata.gz: a5bd4af63f45e6b0856c3aaddda4cc2bbf173dab8eef549adfdef49f6c8afea2643fabe548525af5cb756cac85f7dd0ef121b1c35d5aa13d5f72058f5ed7180e
+  data.tar.gz: 67288a8b6a28bfb7393a265f572e9a3941539398f33c8afa86a514c4df400d84a9783f39422bb131ecaa2598283bb0c47ab2436049dbf795d00f2825e03df8e0

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,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.4

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, ethnicity, 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 arbolito.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 jvillarejo
+
+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,84 @@
+# Arbolito
+
+Arbolito is a minimalist Ruby API for currency conversions, it has no dependencies except the Ruby Standard Library.
+
+It's like your Florida street best companion!
+
+![Florida Street](http://i.imgur.com/qupBCJN.jpg)
+
+## Features
+  * Doesn't encapsulates the currencies in any object model, it just use `BigDecimal` class and `Hash`
+  * You can add manually price rates 
+  * If the rate isn't found it fetches the rate using Yahoo Finance API as exchange
+  * You implement your own exchange and configure it
+  * It stores in memory the rates fetched with a configurable expiration time
+  * You can implement your own store and configure it
+
+## Motivation
+There were two reason why I've developed this gem. 
+
+First the argetine economy makes difficult to keep the prices updated with official exchanges rates like Yahoo Finance, so we had to manage our own prices rates. But also I wanted to know the rates of other currencies through Yahoo Finance. This gem lets you do both. 
+
+The second reason is that other gems implements their own money or currency model, and I didn't want to update all my models to manage those objects. That's why I tried to be agnostic on how you implement your currencies. 
+
+The API just receives a Big Decimal and a hash describing the conversion
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arbolito'
+```
+And then execute:
+
+    $ bundle
+Or install it yourself as:
+
+    $ gem install arbolito
+## Usage
+
+``` ruby 
+require 'arbolito'
+
+# We can add multiple rates
+
+Arbolito.add_currency_rate(BigDecimal.new(9), 'USD' => 'ARS')
+Arbolito.add_currency_rate(BigDecimal.new(15), 'USD Blue' => 'ARS')
+Arbolito.add_currency_rate(BigDecimal.new(12), 'USD Tarjeta' => 'ARS')
+Arbolito.add_currency_rate(BigDecimal.new(6.5), 'USD Moreno' => 'ARS')
+
+# It gives the stored rate
+Arbolito.current_rate('USD' => 'ARS')
+# => #<BigDecimal:7f061f0787e0,'0.15E2',9(27)>
+
+# It stored rate backwards
+Arbolito.current_rate('ARS' => 'USD')
+# => #<BigDecimal:7f061f076af8,'0.6666666666 6666667E-1',18(36)>
+
+# It can make the conversion for you
+Arbolito.convert(BigDecimal.new(100), 'USD' => 'ARS')
+# => #<BigDecimal:7f061f1bd010,'0.15E4',9(27)>
+
+Arbolito.convert(BigDecimal.new(100), 'USD Tarjeta' => 'ARS')
+=> #<BigDecimal:7f061f39c818,'0.12E4',9(27)>
+
+# Now we ask for the Uruguayan pesos to USD rate
+Arbolito.current_rate('UYU' => 'USD')
+#<BigDecimal:7f061f142ba8,'0.34E-1',9(18)>
+
+# Now we ask to convert USD to Chilean Pesos
+Arbolito.convert(BigDecimal.new(100), 'USD' => 'CLP')
+=> #<BigDecimal:7f061f35e680,'0.689695E5',18(36)>
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jvillarjeo/arbolito. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/arbolito.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arbolito/version'
+
+Gem::Specification.new do |s|
+  s.name          = "arbolito"
+  s.version       = Arbolito::VERSION
+  s.authors       = ["jvillarejo"]
+  s.email         = ["contact@jonvillage.com"]
+
+  s.summary       = "A currency conversion api for the minimalist developer"
+  s.description   = s.summary
+  s.homepage      = "https://github.com/jvillarejo/arbolito.git"
+  s.license       = "MIT"
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+end

data/bin/console

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

@@ -0,0 +1,68 @@
+require 'bigdecimal'
+require 'time'
+require 'arbolito/currency/quote'
+require 'arbolito/currency/rate'
+require 'arbolito/currency/non_expirable_rate'
+require 'arbolito/store/memory'
+require 'arbolito/exchange/yahoo_finance'
+require "arbolito/version"
+
+module Arbolito
+
+  class << self
+    def add_currency_rate(currency_price, from_to_currencies)
+      rate = Currency::NonExpirableRate.new(currency_price, from_to_currencies) 
+      add_to_store(rate)
+    end
+
+    def current_rate(from_to_currencies) 
+      fetch(Currency::Quote.new(from_to_currencies)).price
+    end
+
+    def convert(money, from_to_currencies)
+      quote = Currency::Quote.new(from_to_currencies)
+
+      rate = fetch(quote)
+
+      rate.convert(money)
+    end
+
+    def exchange=(exchange)
+      @@exchange = exchange
+    end
+
+    def expiration_time=(seconds)
+      @@expiration_time = seconds
+    end
+
+    private
+    def add_to_store(rate)
+      store.add(rate)
+      store.add(rate.backwards)
+    end
+
+    def fetch(quote)
+      rate = store.fetch(quote)
+
+      if(!rate || rate.expired?(expiration_time))
+        rate = exchange.find_current_rate(quote)
+
+        store.add(rate)
+      end
+
+      rate
+    end
+
+    def store
+      @@store ||= Store::Memory
+    end
+
+    def exchange
+      @@exchange ||= Exchange::YahooFinance
+    end
+
+    def expiration_time
+      @@expiration_time ||= 60
+    end
+  end
+end

data/lib/arbolito/currency/non_expirable_rate.rb

@@ -0,0 +1,9 @@
+module Arbolito
+  module Currency
+    class NonExpirableRate < Rate
+      def expired?(expiration_time)
+        false
+      end
+    end
+  end
+end

data/lib/arbolito/currency/quote.rb

@@ -0,0 +1,28 @@
+module Arbolito
+  module Currency
+    class Quote
+      attr_reader :from, :to
+      
+      def initialize(hash) 
+        raise ArgumentError.new('You must specify 1 quote rate') if hash.size != 1
+
+        @from = hash.keys.first.to_sym
+        @to = hash.values.first.to_sym
+      end
+
+      def to_hash
+        { @from => @to }
+      end
+
+      def backwards 
+        Quote.new( @to => @from )
+      end
+
+      def ==(other_currency_quote)
+        raise TypeError unless other_currency_quote.is_a?(Quote)
+
+        @from == other_currency_quote.from && @to == other_currency_quote.to
+      end
+    end
+  end
+end

data/lib/arbolito/currency/rate.rb

@@ -0,0 +1,31 @@
+module Arbolito
+  module Currency
+    class Rate
+      attr_reader :quote, :price, :rated_at
+
+      def initialize(price, from_to_hash, rated_at = Time.now)
+        @quote = Quote.new(from_to_hash)
+        @price = BigDecimal.new(price)
+        @rated_at = rated_at
+      end
+
+      def convert(money)
+        @price * BigDecimal.new(money)
+      end
+
+      def backwards
+        self.class.new(BigDecimal.new(1) / @price, @quote.backwards.to_hash)
+      end
+
+      def expired?(expiration_time)
+        (Time.now - rated_at) > expiration_time
+      end
+
+      def ==(other_currency_rate)
+        raise TypeError unless other_currency_rate.is_a?(CurrencyRate)
+
+        @quote == other_currency_rate.quote && @price == @other.price
+      end
+    end
+  end
+end

data/lib/arbolito/exchange/yahoo_finance.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+
+module Arbolito
+  module Exchange
+    class YahooFinance
+      class << self
+        def find_current_rate(quote)
+          data = response(build_uri(quote))
+
+          values = {
+            quote: quote,
+            price: data[1],
+          }
+
+          build_rate(values)
+        end
+
+        private
+        def response(uri)
+          response = Net::HTTP.get(uri)
+          data = response.gsub(/"|\\n/,'').split(',')
+        end
+
+        def build_uri(quote)
+          param = "#{quote.from.upcase}#{quote.to.upcase}"
+          URI("http://download.finance.yahoo.com/d/quotes.csv?s=#{param}=X&f=nl1d1t1")
+        end
+
+        def build_rate(values)
+          Currency::Rate.new(
+            values[:price],
+            values[:quote].to_hash
+          )
+        end
+      end
+    end
+  end
+end

data/lib/arbolito/store/memory.rb

@@ -0,0 +1,37 @@
+module Arbolito
+  module Store
+    class Memory
+      class << self
+        def mutex
+          @@mutex ||= Mutex.new
+        end
+
+        def add(rate)
+          synchronize do 
+            hash[rate.quote.to_hash] = rate
+          end
+        end
+
+        def fetch(quote)
+          synchronize do 
+            hash[quote.to_hash]
+          end
+        end
+
+        def clear
+          synchronize do 
+            @@hash = {}
+          end
+        end
+
+        def synchronize(&block)
+          mutex.synchronize(&block)
+        end
+
+        def hash
+          @@hash ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/arbolito/version.rb

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

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: arbolito
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jvillarejo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !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'
+description: A currency conversion api for the minimalist developer
+email:
+- contact@jonvillage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arbolito.gemspec
+- bin/console
+- bin/setup
+- lib/arbolito.rb
+- lib/arbolito/currency/non_expirable_rate.rb
+- lib/arbolito/currency/quote.rb
+- lib/arbolito/currency/rate.rb
+- lib/arbolito/exchange/yahoo_finance.rb
+- lib/arbolito/store/memory.rb
+- lib/arbolito/version.rb
+homepage: https://github.com/jvillarejo/arbolito.git
+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.8
+signing_key: 
+specification_version: 4
+summary: A currency conversion api for the minimalist developer
+test_files: []