tannenbaum 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2NlN2EyZTY0MDk0MTU4Nzk1NWFmYjllMDJhZWRkYjMwZjgwOWNjMQ==
+  data.tar.gz: !binary |-
+    YzE1ZTQyOTk0YjU1ZTAwZjg3MTAyOGI4MmNkZGZlY2ZjNGE4MjhjNw==
+SHA512:
+  metadata.gz: !binary |-
+    MjVhYjk5MTNmNWVmODZiNWM1MDcxYzg0YTcxZDM4OTkxN2FhNDk2MmJjZWVm
+    YjFjOWRjMDgxMjcwMGE0YWI5MjgwMzIyZGRhNWZkZmE2NWQxZWNmOGI0NDFm
+    YjUwMzg1MmE4YWNhYmNlMTBlZTRkMjRmYjJmZDVlZjVhYjljY2I=
+  data.tar.gz: !binary |-
+    MzAzZTU4ZjFkMWY2NjY3NDFmZWVhMjUyODllNWQ2NjQ4ZmFlMDg0NDI4Nzkx
+    OTkzOGM3MWNkZmI0Y2E4ODg4ZWNmYjgzOTEzNDdiNjE3OTM4Y2NmZDVkNDRl
+    NjEzNWQzMTM3YWE3MWQxZjVlOTFkZDc5Mzc1NjkzMmJmNDE4MzE=

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+tannenbaum

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p484

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Horacio Bertorello
+
+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,40 @@
+[![Build Status](https://secure.travis-ci.org/svankie/tannenbaum.png)](http://travis-ci.org/svankie/tannenbaum)
+
+# Tannenbaum
+
+Tannenbaum is an experimental tool for querying currency informal exchange rates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tannenbaum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tannenbaum
+
+## Usage
+
+    [1] pry(main)> require 'tannenbaum'
+    => true
+    [2] pry(main)> quoting = Tannenbaum::Quote.new
+    => #<Tannenbaum::Quote:0x92993bc @provider=Tannenbaum::Providers::USD>
+    [3] pry(main)> rates = quoting.ask
+    => #<struct Tannenbaum::ExchangeRate
+          sell=10.77,
+          buy=10.72,
+          timestamp= #<DateTime: 2014-01-13T18:50:02+00:00 ((2456671j,67802s,0n),+0s,2299161j)>,
+          provider="elDolarBlue">
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tannenbaum.rb

@@ -0,0 +1,7 @@
+require "tannenbaum/exceptions"
+require "tannenbaum/providers"
+require "tannenbaum/quote"
+require "tannenbaum/scraper"
+require "tannenbaum/version"
+
+module Tannenbaum; end

data/lib/tannenbaum/exceptions.rb

@@ -0,0 +1,5 @@
+module Tannenbaum
+  module Exceptions
+    class InvalidCurrencyException < Exception; end
+  end
+end

data/lib/tannenbaum/providers.rb

@@ -0,0 +1,16 @@
+module Tannenbaum
+  module Providers
+    # Our exchange rate data providers are defined here as separate classes.
+    class USD
+      # The name of the [Provider].
+      def self.provider
+        "elDolarBlue"
+      end
+      
+      # The URL of the [Provider].
+      def self.url
+        "http://www.eldolarblue.net/getDolarBlue.php?as=xml"
+      end
+    end
+  end
+end

data/lib/tannenbaum/quote.rb

@@ -0,0 +1,39 @@
+module Tannenbaum
+  class Quote
+    # The [Quote] class defines our medium for getting informal exchange rate information
+    # for a given currency on a given [Provider].
+    def initialize(currency = :USD)
+      raise Tannenbaum::Exceptions::InvalidCurrencyException unless Tannenbaum::Providers.constants.include?(currency)
+      @provider = get_provider(currency)
+    end
+
+    # Retrieves the latest exchange rate prices according to our [Provider].
+    #
+    # @param ensure_fresh [Boolean] Ensures that we get the latest rates.
+    # @return [ExchangeRate] Struct with a sell and buy prices and the query timestamp.
+    def ask(ensure_fresh = false)
+      if ensure_fresh
+        @exchange_rates = fetch_current_exchange_rates
+      else
+        @exchange_rates ||= fetch_current_exchange_rates
+      end
+    end
+
+    private
+
+    def get_provider(currency)
+      Tannenbaum::Providers.const_get(currency)
+    end
+
+    def fetch_current_exchange_rates
+      raw_exchange_data = Tannenbaum::Scraper.new(@provider).process
+      Tannenbaum::ExchangeRate.new(raw_exchange_data)
+    end
+  end
+
+  class ExchangeRate < Struct.new(:sell, :buy, :timestamp, :provider)
+    def initialize(hash)
+      super(*hash.values_at(:sell, :buy, :timestamp, :provider))
+    end
+  end
+end

data/lib/tannenbaum/scraper.rb

@@ -0,0 +1,52 @@
+require "nokogiri"
+require "open-uri"
+
+module Tannenbaum
+  class Scraper
+    # A [Scraper] that fetches and parses the exchange rate data from our -for now- only [Provider]. 
+    def initialize(supplier)
+      @url = supplier.url
+      @provider = supplier.provider
+    end
+
+    # Processes the XML response of our [Provider]
+    # and return it as a [Hash].
+    #
+    # @return [Hash] with fresh exchange rate data.
+    def process
+      xml_response = open(@url) rescue Hash.new
+      quote = Nokogiri::XML(xml_response)
+      parse_exchange_rates(quote)
+    end
+
+    private
+
+    def parse_exchange_rates(quote)
+      result = [:sell, :buy].inject({}) do |rates, key|
+        rate = extract_node_value(quote, key)
+        rates[key] = sanitize_rate!(rate)
+        rates
+      end
+      # XXX: yeah, it's hardcoded. mayhaps every ::Provider 
+      # should have its own ::Scraper. i've to implement it.
+      timestamp = extract_node_value(quote, :datetime)
+      result[:timestamp] = parse_timestamp!(timestamp)
+
+      result[:provider] = @provider
+
+      result
+    end
+
+    def extract_node_value(node, key)
+      node.xpath("//#{key.to_s}").text
+    end
+
+    def sanitize_rate!(value, precision = 2)
+      value.to_f.round(precision)
+    end
+
+    def parse_timestamp!(timestamp)
+      DateTime.parse(timestamp) rescue DateTime.now
+    end
+  end 
+end

data/lib/tannenbaum/version.rb

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

data/spec/tannenbaum_spec.rb

@@ -0,0 +1,20 @@
+require "tannenbaum"
+
+describe Tannenbaum do
+  describe Tannenbaum::Quote do
+    it "shows the current exchange rates and timestamp for a given currency" do
+      quotation = Tannenbaum::Quote.new(:USD)
+      
+      exchange_rates = quotation.ask
+
+      exchange_rates.sell.should be_a(Float)
+      exchange_rates.buy.should be_a(Float)
+      
+      exchange_rates.timestamp.should be_a(DateTime)
+    end
+
+    it "fails when trying to quote a non-existant currency" do
+      expect { Tannenbaum::Quote.new(:ANT) }.to raise_exception(Tannenbaum::Exceptions::InvalidCurrencyException)
+    end
+  end
+end

data/tannenbaum.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tannenbaum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tannenbaum"
+  spec.version       = Tannenbaum::VERSION
+  spec.authors       = ["Horacio Bertorello"]
+  spec.email         = ["svankie@gmail.com"]
+  spec.description   = %q{Tannenbaum is a tool for querying currency informal exchange rates.}
+  spec.summary       = %q{Tannenbaum is a tool for querying currency informal exchange rates.}
+  spec.homepage      = "https://www.github.com/svankie/tannenbaum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: tannenbaum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Horacio Bertorello
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard-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'
+- !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'
+description: Tannenbaum is a tool for querying currency informal exchange rates.
+email:
+- svankie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tannenbaum.rb
+- lib/tannenbaum/exceptions.rb
+- lib/tannenbaum/providers.rb
+- lib/tannenbaum/quote.rb
+- lib/tannenbaum/scraper.rb
+- lib/tannenbaum/version.rb
+- spec/tannenbaum_spec.rb
+- tannenbaum.gemspec
+homepage: https://www.github.com/svankie/tannenbaum
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Tannenbaum is a tool for querying currency informal exchange rates.
+test_files:
+- spec/tannenbaum_spec.rb