dolarblue 0.3.0 → 0.4.0

data/lib/dolarblue/inflector.rb

@@ -0,0 +1,23 @@
+class Dolarblue
+  module Inflector
+    extend self
+
+    # Removes the module part from the expression in the string.
+    #
+    # @param path [String] the module expression stringified
+    #
+    # @example
+    #   demodulize('ActiveRecord::CoreExtensions::String::Inflections') # => "Inflections"
+    #   demodulize('Inflections')                                       # => "Inflections"
+    #
+    # @return [String] with the module part removed and the stringified class name only
+    def demodulize(path)
+      path = path.to_s
+      if i = path.rindex('::')
+        path[(i+2)..-1]
+      else
+        path
+      end
+    end
+  end
+end

data/lib/dolarblue/instance_methods.rb

@@ -1,94 +1,102 @@
+require 'dolarblue/configuration'
+require 'dolarblue/blue'
+require 'dolarblue/official'
+require 'dolarblue/card'
+
+require 'nokogiri' # gem 'nokogiri'
+require 'open-uri' # stdlib
+
 class Dolarblue
-  module InstanceMethods
-
-    # Create a new Dolarblue instance to work later on
-    #
-    # @param [Configuration] config the configuration instance
-    #
-    # @return [Dolarblue] new instance
-    def initialize(config = Configuration.instance)
-      fail ArgumentError, "Expected a Dolarblue::Configuration instance as argument" unless config.is_a?(Configuration)
-      @card_fee = config.card_fee
-      @blue = Dolarblue::Exchange.new('Blue', config.blue_screen_name, config.blue_regexp, config.buy_sell_blue_factor)
-      @official = Dolarblue::Exchange.new('Official', config.official_screen_name, config.official_regexp, config.buy_sell_official_factor)
-      self
-    end
 
-    # Returns current object state, whether valid or not
-    #
-    # @return [true, false] boolean state
-    def valid?
-      @blue.valid? && @official.valid?
-    end
+  # Create a new Dolarblue instance to work later on
+  #
+  # @param config [Configuration] the configuration instance
+  #
+  # @return [Dolarblue] new instance
+  def initialize(config = Configuration.instance)
+    @config   = config.defaults
+    @blue     = Blue.new
+    @official = Official.new
+    @card     = Card.new
+    @output   = nil
+    self
+  end
 
-    # Connect to the source and retrieve dollar exchange values
-    #
-    # @return [self]
-    def update!
-      print "Obtaining latest AR$ vs US$ exchange values..."
-      @blue.update!
-      @official.update!
-      print "Done.\n\n"
-      self
-    end
+  # Connect to the source and retrieve dollar exchange values
+  #
+  # @return (see #initialize)
+  def update!
+    @output = ''
+    base_url = @config.base_url
+    fail ArgumentError, "Need base_url configuration to know where to web-scrape from. Current value: #{base_url}" if base_url.empty?
 
-    # Returns the gap between the real (blue) dollar value versus the official
-    #
-    # @return [Float] percentile value between 0..1
-    def gap_official
-      fail "Need blue and official values to be setup before calculating the gap" unless @blue.sell_value && @blue.sell_value > 0 && @official.sell_value && @official.sell_value > 0
-      (@blue.sell_value / @official.sell_value - 1)
-    end
+    log "Obtaining latest AR$ vs US$ exchange values..."
+    html_file = open(base_url)
 
-    # Returns the gap percentile between the real (blue) dollar value versus the official
-    #
-    # @return [Float] percentile value between 0..100
-    def gap_official_percent
-      (gap_official * 100).round(0)
-    end
+    log "Parsing values..."
+    parse_values Nokogiri::HTML(html_file)
 
-    def card_fee_sell_value
-      (@official.sell_value * @card_fee).round(2)
-    end
+    log "\nDone: #{Time.now.localtime}\n"
+    self
+  end
 
-    # Returns the gap between the real (blue) dollar value versus the dollar "tarjeta" vale
-    #
-    # @return [Float] percentile value between 0..1
-    def gap_card
-      fail "Need blue and official values to be setup before calculating the gap" unless @blue.sell_value && @blue.sell_value > 0 && @official.sell_value && @official.sell_value > 0
-      (@blue.sell_value / card_fee_sell_value - 1)
-    end
+  # Returns the gap percentile (e.g. 60) between the real (blue) dollar value versus the official
+  #
+  # @return [Float] percentile value between 0..100
+  def gap_official_percent
+    gap_official = @blue.sell / @official.sell - 1
+    (gap_official * 100).round(0)
+  end
 
-    # Returns the gap percentile between the real (blue) dollar value versus the official
-    #
-    # @return [Float] percentile value between 0..100
-    def gap_card_percent
-      (gap_card * 100).round(0)
-    end
+  # Returns the gap percentile between the real (blue) dollar value versus the official
+  #
+  # @return (see #gap_official_percent)
+  def gap_card_percent
+    gap_card = @blue.sell / @card.sell - 1
+    (gap_card * 100).round(0)
+  end
 
-    # Return a string suitable for user output about dollar "tarjeta" values
-    #
-    # @return [String] output exchange values 1 line string
-    def card_output_values
-      %Q{- Dolar "Tarjeta":  n/a / #{'%.2f' % card_fee_sell_value}  (Updated #{@official.updated_ago})}
-    end
+  # Output string to be used by the binary `dolarblue`
+  #
+  # @return [String] the output with dollar exchange information
+  def output
+    <<-OUTPUT
+#{@output}
+#{@official.output}
+#{@card.output}
+#{@blue.output}
+
+- Gap card.......blue: #{gap_card_percent}%
+- Gap official...blue: #{gap_official_percent}%
 
-    # Output string to be used by the binary `dolarblue`
-    #
-    # @return [String] the output with dollar exchange information
-    def output
-      <<-OUTPUT
-#{@official.output_values}
-#{card_output_values}
-#{@blue.output_values}
-- Gap "tarjeta"..: #{gap_card_percent}%
-- Gap (official).: #{gap_official_percent}%
-
-Information sources:
-#{@official.output_link}
-#{@blue.output_link}
-      OUTPUT
+Information source:
+#{@config.base_url}
+    OUTPUT
+  end
+
+  private
+
+  # Parse dollar related values using the XPath configured
+  #
+  # @param doc [Nokogiri::HTML] the html document to extract values from
+  #
+  # @return [true, false] boolean If parsed successfully or not
+  def parse_values(doc)
+    [@blue, @official, @card].each do |type|
+      type.extract_values(doc)
     end
+  end
 
+  # Poor man's logger to keep user updated with http get activity
+  #   while allowing to buffer the string while in RSpec test mode
+  #
+  # @param msg [String] the message to print or buffer
+  def log(msg)
+    if defined?(RSpec)
+      @output << msg
+    else
+      print msg
+    end
   end
+
 end

data/lib/dolarblue/official.rb

@@ -0,0 +1,7 @@
+require 'dolarblue/xchange'
+
+class Dolarblue
+  # Class used to hold sell/buy values functionality for dollar "Official"
+  class Official < XChange
+  end
+end

data/lib/dolarblue/version.rb

@@ -1,3 +1,3 @@
 class Dolarblue
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/dolarblue/xchange.rb

@@ -0,0 +1,86 @@
+require 'dolarblue/configuration'
+require 'dolarblue/inflector'
+
+class Dolarblue
+
+  # Base class for Blue, Official and Card used to hold sell/buy values functionality
+  #
+  # @abstract
+  class XChange
+    attr_reader :buy, :sell
+
+    # Create a new Blue / Official / Card instance to work later on
+    #
+    # @param config [Configuration] the configuration instance
+    #
+    # @return [self] new instance
+    def initialize(config = Configuration.instance)
+      @config = config.defaults
+      self
+    end
+
+    # Return the demodulized class name
+    #
+    # @return [String] demodulized class name string
+    def cname
+      Inflector.demodulize(self.class.name)
+    end
+
+    # Return downcased demodulized class name
+    #
+    # @return [String] downcased demodulized class name string
+    def name
+      cname.downcase
+    end
+
+    # Performs buy and sell values extraction from a Nokogiri::HTML Document
+    #
+    # @param [Nokogiri::HTML] doc the html document to extract values from
+    def extract_values(doc)
+      @buy  = extract_val(doc, 'buy')
+      @sell = extract_val(doc, 'sell')
+    end
+
+    # Return a formatted string suitable for user output with current buy value
+    #
+    # @return [String] formatted output buy exchange value
+    def buy_output
+      '%.2f' % buy
+    end
+
+    # Return a formatted string suitable for user output with current sell value
+    #
+    # @return [String] formatted output sell exchange value
+    def sell_output
+      '%.2f' % sell
+    end
+
+    # Return a formatted string suitable for user output with current buy and sell values
+    #
+    # @return [String] formatted output with buy and sell exchange values
+    def output
+      t = cname.ljust(10, '.')
+      b = buy_output.rjust(5)
+      s = sell_output.rjust(5)
+      %Q{- Dollar #{t}..: #{b} / #{s}}
+    end
+
+    protected
+
+    # Extract individual buy/sell values from a Nokogiri::HTML Document
+    #
+    # @param doc [Nokogiri::HTML] the html document to extract values from
+    # @param type [String] the dollar type, can be 'blue', 'official', 'card'
+    #
+    # @raise [RuntimeError] if unable to proper buy/sell value for current dollar type
+    #
+    # @private
+    def extract_val(doc, type)
+      xpath = @config[name][type].xpath
+      value = doc.xpath(xpath).text.gsub(',', '.')
+      fail RuntimeError, "Failed to capture #{name} #{type} value" if value.empty?
+      value.to_f.round(2)
+    end
+  end
+
+end

data/spec/blue_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Dolarblue::Blue do
+  #TODO
+end

data/spec/dolarblue_spec.rb

@@ -1,92 +1,22 @@
 require 'spec_helper'
 
-describe Dolarblue do
-  let(:blue_tweet) do
-    Twitter::Tweet.new({
-      id: '309326405148233731',
-      text: 'Dolar Paralelo: $7,82',
-      created_at: DateTime.parse('2013-03-06T12:35:36-03:00'),
-      screen_name: 'DolarBlue'
-    })
-  end
-  let(:official_tweet) do
-    Twitter::Tweet.new({
-      id: '309289043722637312',
-      text: '#Cotizacion cierre promedio parcial 06-03-13: #Dolar: 5.06 // #Euro: 6.71 // #Real: 2.74.',
-      created_at: DateTime.parse('2013-03-06T10:07:08-03:00'),
-      screen_name: 'cotizacionhoyar'
-    })
-  end
-
-  before do
-    Twitter::Client.stub_chain(:new, :last_tweet).with('DolarBlue').and_return(blue_tweet)
-    Twitter::Client.stub_chain(:new, :last_tweet).with('cotizacionhoyar').and_return(official_tweet)
-  end
-
-  describe '#new' do
-    it 'fails if argument is not a Configuration class' do
-      expect { described_class.new(nil) }.to raise_error(ArgumentError)
-    end
-
-    it 'start as invalid right after creation' do
-      subject.should_not be_valid
-    end
-
-    it 'fails if you try to use it before is valid' do
-      expect { subject.gap }.to raise_error
-      expect { subject.gap_percent }.to raise_error
-      expect { subject.output }.to raise_error
-    end
-  end
-
-  context 'updated' do
-    before do
-      subject.update!
-    end
-
-    describe '#update!' do
-      it 'becomes valid after calling update!' do
-        subject.should be_valid
-      end
-    end
-
-    describe '#output' do
-      it 'has an output with real values' do
-        subject.output.should match(/Blue/)
-        subject.output.should match(/Tarjeta/)
-      end
-    end
-
-    describe 'gap values' do
-      it 'has a valid gap card value' do
-        subject.gap_card.should be >= 0
-      end
-
-      it 'has a valid gap card % value' do
-        subject.gap_card_percent.should be >= 0
-      end
-
-      it 'has a valid gap official value' do
-        subject.gap_official.should be >= 0
-      end
-
-      it 'has a valid gap official % value' do
-        subject.gap_official_percent.should be >= 0
-      end
+vcr_options = { allow_playback_repeats: true }
+
+describe Dolarblue, vcr: vcr_options do
+  context 'Class Methods' do
+    subject { Dolarblue }
+
+    it 'should return all the dollar exchange Blue/Official/Card values and percentiles suitable for user printing' do
+      # expect(subject.get_output).to match(/Dollar Blue.*\d+\.\d+.*^Information source/)
+      expect(subject.get_output).to match(/Obtaining/)
+      expect(subject.get_output).to match(/Done/)
+      values = %q{\d+\.\d+\s+\/\s+\d+\.\d+}
+      expect(subject.get_output).to match(/Official.*#{values}/)
+      expect(subject.get_output).to match(/Card.*n\/a\s+\/\s+\d+\.\d+/)
+      expect(subject.get_output).to match(/Blue.*#{values}/)
+      expect(subject.get_output).to match(/Gap card/)
+      expect(subject.get_output).to match(/Gap official/)
+      expect(subject.get_output).to match(/Information source/)
     end
   end
-
-  describe 'constants' do
-    it 'should have a version number' do
-      Dolarblue::VERSION.should_not be_nil
-    end
-  end
-
-  describe 'ClassMethods' do
-    it 'has an get_output() class method to retrieve latest values' do
-      Dolarblue.get_output.should match(/Blue/)
-      Dolarblue.get_output.should match(/Tarjeta/)
-    end
-  end
-
 end

data/spec/spec_helper.rb

@@ -1,22 +1,32 @@
-require 'simplecov'
-require 'coveralls'
+unless %w(jruby rbx).include? RUBY_ENGINE
+  require 'simplecov'
+  require 'coveralls'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.start
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start
+end
 
-# Internal
 require 'dolarblue'
 
+require 'vcr' # gem 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
 # Require this file using `require "spec_helper"` within each of your specs
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies.
-  config.order = 'random'
+  config.order = 'random' # Run specs in random order to surface order dependencies.
+  config.expect_with :rspec do |c|
+    c.syntax = :expect  # disable `should` syntax  http://goo.gl/BGxqP
+  end
 end