uruguayan_exchange_rates 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb93362ca62e2dfe9ac27897819487d1d89ea939
+  data.tar.gz: da06a9b4763d3a5fc1f18ac992c346ba677ac15b
+SHA512:
+  metadata.gz: b62337d1cb332ddb558f8b59475fd131f40e8d59b6d850662fa8da2bea60a1ec3dc535ff1aaefa655f62dbd4781cd275f7ed52dd5c2af140379268b874de6e10
+  data.tar.gz: 72431aa54a422986cd544ed96d769c83888f088494ba1a27cccc7de69846809c324bbfb61b424d43343019bf13d36f6e2c1127396ad2552b716808410a3fb8a2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - jruby
+  - 2.1.5
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - jpbalarini@email.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Juan Pablo Balarini
+
+MIT License
+
+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,57 @@
+# Uruguayan Exchange Rates
+
+[![Code Climate](https://codeclimate.com/github/jpbalarini/uruguayan_exchange_rates/badges/gpa.svg)](https://codeclimate.com/github/jpbalarini/uruguayan_exchange_rates)
+[![Build Status](https://travis-ci.org/jpbalarini/uruguayan_exchange_rates.svg?branch=master)](https://travis-ci.org/jpbalarini/uruguayan_exchange_rates)
+
+With this gem you can get the official Uruguayan exchange rates (buy and sell) for multiple currencies. Data is taken from Banco República.
+This gem was designed for a project where I needed to update the price of some elements daily, using the official Uruguayan exchange rates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uruguayan_exchange_rates'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uruguayan_exchange_rates
+
+## Usage
+
+Usage is simple, just call the exchange_rates method with a valid key:
+  
+    UruguayanExchangeRates.exchange_rates(:UYU_USD)
+
+It should return an array with two elements, buy and sell values respectively:
+  
+    [25.95, 26.75]
+
+Supported keys are:
+  
+    {
+      :UYU_USD => 'Dólar',
+      :UYU_EUR => 'Euro',
+      :UYU_ARS => 'Peso Argentino',
+      :UYU_BRL => 'Real',
+      :USD_GPD => 'Dólares USA por Libra esterlina',
+      :CHF_USD => 'Francos suizos por Dólar',
+      :JPY_USD => 'Yens por Dólar',
+      :USD_EUR => 'Dólares USA por Euro',
+      :ARS_USD => 'Pesos Argentinos por Dólar',
+      :BRL_USD => 'Reales por Dólar',
+      :PYG_USD => 'Guaraníes por Dólar',
+      :UYU_UI => 'Unidad Indexada',
+      :USD_ONZATROY => 'Onza Troy de Oro'
+    }
+
+## Contributing
+
+1. Fork it ( https://github.com/jpbalarini/uruguayan_exchange_rates/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,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = '--format documentation'
+end
+
+task default: :spec

data/lib/uruguayan_exchange_rates.rb

@@ -0,0 +1,29 @@
+require 'uruguayan_exchange_rates/version'
+require 'uruguayan_exchange_rates/constants'
+require 'uruguayan_exchange_rates/error'
+require 'uruguayan_exchange_rates/util'
+
+# TODO: remove nokogiri and add a regular expression
+# TODO: compare in lowercase
+
+module UruguayanExchangeRates
+  SERVICE_HOST = 'http://www.bancorepublica.com.uy'
+  SERVICE_PATH = '/web/guest/institucional/cotizaciones'
+
+  def self.exchange_rates(currency)
+    currency_raw = Constants[currency]
+    raise InvalidCurrency, 'Invalid currency' if currency_raw.nil?
+
+    util = Util.new(currency_raw: currency_raw)
+    # Make request
+    data = util.request_data
+
+    # Find currency in page
+    currency_data = util.find_currency(data)
+
+    raise CurrencyNotFound, 'Currency not found' if currency_data.nil?
+
+    # Get values
+    util.extract_values(currency_data)
+  end
+end

data/lib/uruguayan_exchange_rates/constants.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require_relative 'enumeration'
+
+module UruguayanExchangeRates
+  class Constants < Enumeration
+    self.add_item(:UYU_USD, 'Dólar')
+    self.add_item(:UYU_EUR, 'Euro')
+    self.add_item(:UYU_ARS, 'Peso Argentino')
+    self.add_item(:UYU_BRL, 'Real')
+    self.add_item(:USD_GPD, 'Dólares USA por Libra esterlina')
+    self.add_item(:CHF_USD, 'Francos suizos por Dólar')
+    self.add_item(:JPY_USD, 'Yens por Dólar')
+    self.add_item(:USD_EUR, 'Dólares USA por Euro')
+    self.add_item(:ARS_USD, 'Pesos Argentinos por Dólar')
+    self.add_item(:BRL_USD, 'Reales por Dólar')
+    self.add_item(:PYG_USD, 'Guaraníes por Dólar')
+    self.add_item(:UYU_UI, 'Unidad Indexada')
+    self.add_item(:USD_ONZATROY, 'Onza Troy de Oro')
+  end
+end

data/lib/uruguayan_exchange_rates/enumeration.rb

@@ -0,0 +1,28 @@
+module UruguayanExchangeRates
+  class Enumeration
+    def Enumeration.add_item(key, value)
+      @hash ||= {}
+      @hash[key] = value
+    end
+
+    def Enumeration.const_missing(key)
+      @hash[key]
+    end   
+
+    def Enumeration.each
+      @hash.each { |key, value| yield(key, value) }
+    end
+
+    def Enumeration.values
+      @hash.values || []
+    end
+
+    def Enumeration.keys
+      @hash.keys || []
+    end
+
+    def Enumeration.[](key)
+      @hash[key]
+    end
+  end
+end

data/lib/uruguayan_exchange_rates/error.rb

@@ -0,0 +1,10 @@
+module UruguayanExchangeRates
+  # Custom error class for rescuing from all UruguayanExchangeRates errors
+  class Error < StandardError; end
+
+  # Raised when invalid currency is passed
+  class InvalidCurrency < Error; end
+
+  # Raised when currency is not found on the page
+  class CurrencyNotFound < Error; end
+end

data/lib/uruguayan_exchange_rates/util.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+require 'nokogiri'
+
+module UruguayanExchangeRates
+  class Util
+    attr_accessor :currency_raw
+
+    def initialize(options = {})
+      unless block_given?
+        options.each do |key, value|
+          send(:"#{key}=", value)
+        end
+      else
+        yield(self)
+      end
+    end
+
+    def request_data
+      uri = URI.parse(SERVICE_HOST + SERVICE_PATH)
+      result = Net::HTTP.get(uri)
+      data = Nokogiri::HTML(result)
+    end
+
+    def find_currency(data)
+      values = data.css('#exchangeRatesLarge').at('tr:contains("' + currency_raw + '")')
+    end
+
+    def extract_values(currency_data)
+      # Remove unnecessary spaces
+      values = currency_data.text.strip
+      # Remove name
+      values.gsub!(currency_raw, '')
+      # Remove spaces
+      values.gsub!(/(?:\n\r?|\r\n?)/, ' ').strip!
+      buy, sell = values.split(/\s+/).map{ |v| v.to_f }
+    end
+  end
+end

data/lib/uruguayan_exchange_rates/version.rb

@@ -0,0 +1,3 @@
+module UruguayanExchangeRates
+  VERSION = "0.0.1"
+end

data/spec/exchange_rates_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'uruguayan_exchange_rates'
+
+describe UruguayanExchangeRates do
+  context 'with valid params' do
+    it 'should return 2 parameters' do
+      UruguayanExchangeRates::Constants.keys.each do |key|
+        expect(UruguayanExchangeRates::exchange_rates(key)[0]).to be > 0.0
+        expect(UruguayanExchangeRates::exchange_rates(key)[1]).to be > 0.0
+        expect(UruguayanExchangeRates::exchange_rates(key).count).to eq(2)
+      end
+    end
+  end
+
+  context 'with invalid params' do
+    it 'should return InvalidCurrency' do
+      expect{ 
+        UruguayanExchangeRates::exchange_rates('foo')
+      }.to raise_error(UruguayanExchangeRates::InvalidCurrency)
+      expect{ 
+        UruguayanExchangeRates::exchange_rates(2)
+      }.to raise_error(UruguayanExchangeRates::InvalidCurrency)
+      expect{ 
+        UruguayanExchangeRates::exchange_rates(:FOO_BAR)
+      }.to raise_error(UruguayanExchangeRates::InvalidCurrency)
+    end
+
+    it 'should return CurrencyNotFound' do
+      # Add test element to Constants
+      UruguayanExchangeRates::Constants.add_item(:FOO_BAR, 'Foo_bar')
+      expect{
+        UruguayanExchangeRates::exchange_rates(:FOO_BAR)
+      }.to raise_error(UruguayanExchangeRates::CurrencyNotFound)
+    end
+  end
+
+  context 'with bad URI' do
+    it 'should return an error' do
+      # Change host
+      stub_const('UruguayanExchangeRates::SERVICE_HOST', 'SOME_BAD_HOST')
+      # Get some currency
+      currency = UruguayanExchangeRates::Constants.keys.first
+      expect{
+        UruguayanExchangeRates::exchange_rates(currency)
+      }.to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/uruguayan_exchange_rates.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uruguayan_exchange_rates/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uruguayan_exchange_rates'
+  spec.version       = UruguayanExchangeRates::VERSION
+  spec.authors       = ['Juan Pablo Balarini']
+  spec.email         = ['jpbalarini@gmail.com']
+  spec.summary       = %q{Uruguayan exchange rates.}
+  spec.description   = %q{Uruguayan exchange rates. Data is taken from the Banco Republica.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'nokogiri'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: uruguayan_exchange_rates
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Juan Pablo Balarini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: Uruguayan exchange rates. Data is taken from the Banco Republica.
+email:
+- jpbalarini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uruguayan_exchange_rates.rb
+- lib/uruguayan_exchange_rates/constants.rb
+- lib/uruguayan_exchange_rates/enumeration.rb
+- lib/uruguayan_exchange_rates/error.rb
+- lib/uruguayan_exchange_rates/util.rb
+- lib/uruguayan_exchange_rates/version.rb
+- spec/exchange_rates_spec.rb
+- spec/spec_helper.rb
+- uruguayan_exchange_rates.gemspec
+homepage: ''
+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.4
+signing_key: 
+specification_version: 4
+summary: Uruguayan exchange rates.
+test_files:
+- spec/exchange_rates_spec.rb
+- spec/spec_helper.rb