autility 0.0.2 → 0.0.3

data/Readme.md

@@ -5,7 +5,11 @@ A scraper that automatically downloads PDF invoices from utility vendors. That's
 It will focus mainly on spanish vendors, but pull requests will be accepted
 to support as many vendors as possible.
 
-For now it supports downloading invoices from Endesa and Vodafone Spain.
+For now it supports downloading invoices from:
+
+* Endesa
+* Vodafone (Spain)
+* Movistar (Spain)
 
 ## Install
 

data/bin/autility

@@ -47,3 +47,23 @@ command :vodafone do |c|
   end
 end
 
+command :movistar do |c|
+  c.syntax = 'autility movistar [options]'
+  c.summary = 'Downloads invoices from Movistar.'
+  c.description = 'Downloads invoices from Movistar.'
+  c.example 'Download the invoice for the current month of user "foo" with password "bar"', 'utilities movistar --user foo --password bar'
+  c.option '--user USER', String, 'The username for Movistar Online'
+  c.option '--password PASSWORD', String, 'The password for Movistar Online'
+  c.option '--month MONTH_NUMBER', Integer, 'The month (e.g. 5, 9, 12...). By default it\'s the current month'
+  c.option '--output-folder FOLDER_NAME', String, 'The output folder to store the PDF in. Defaults to ~/utilities'
+  c.action do |args, options|
+    options.default :month => Time.now.month
+    options.default :output_folder => File.expand_path("~/utilities")
+
+    raise "Both --user and --password are required options." unless options.user && options.password
+
+    result = Autility::MovistarSpain.scrape(options.user, options.password, options.month, options.output_folder)
+    puts "Path: #{result}"
+  end
+end
+

data/lib/autility.rb

@@ -5,6 +5,7 @@ require_relative 'autility/cookie'
 
 require_relative 'autility/endesa'
 require_relative 'autility/vodafone_spain'
+require_relative 'autility/movistar_spain'
 
 module Autility
 end

data/lib/autility/movistar_spain.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+require 'capybara'
+require 'capybara/dsl'
+require 'show_me_the_cookies'
+require 'fileutils'
+
+Capybara.register_driver :selenium do |app|
+  Capybara::Selenium::Driver.new(app, :browser => :firefox)
+end
+
+module Autility
+  # Public: A scraper for all the utility invoices in MovistarSpain.
+  #
+  # Examples
+  #
+  #   # Download the invoice from September this year and store it in /tmp.
+  #   MovistarSpain.scrape("user", "password", 9, "/tmp") # Download all invoices from September this year
+  #
+  class MovistarSpain
+    include Capybara::DSL
+    include ShowMeTheCookies
+
+    # Public: Instantiates a new scraper and fires it to download the utility
+    # invoices from MovistarSpain.
+    #
+    # Returns nothing.
+    def self.scrape(*args)
+      new(*args).scrape
+    end
+
+    def initialize(user, password, month, folder)
+      @user     = user
+      @password = password
+      @month    = month
+      @folder   = folder
+      @year     = Time.now.year
+    end
+
+    # Public: Scrapes the vodafone website and gets the invoice for the current
+    # month, saving it to @folder.
+    #
+    # Returns the String path of the saved document.
+    def scrape
+      setup_capybara
+      log_in
+
+      FileUtils.mkdir_p(@folder)
+      filename = "#{@folder}/movistar_#{month}_#{@year}.pdf"
+      document.save(filename)
+      filename
+    end
+
+    private
+
+    # Internal: Logs in to the MovistarSpain website.
+    #
+    # Returns nothing.
+    def log_in
+      visit "/on/pub/ServNav?servicio=home&home=personal&v_segmento=EMPR"
+      fill_in "usuario", :with => @user
+      fill_in "contrasenia", :with => @password
+      first("#enviar").click
+    end
+
+    # Internal: Gets the latest invoice and returns it as a Document (not
+    # fetched yet).
+    #
+    # Returns the Document to be fetched.
+    def document
+      @document ||= begin
+        invoice = nil
+
+        cookie = Cookie.new("wacsessionid", get_me_the_cookie("wacsessionid")[:value])
+
+        visit "https://www.movistar.es/id/priv/seg00/jsp/UFE/es/IDAA00SCUFE_1_facturas_STB.jsp?SOLDUP="
+
+        combo = all(".combos_numerados_facturacion1")[1]
+        select = combo.find(".combos_numeros")
+        id = select[:id]
+        options = select.all('option')
+
+        found = options.detect do |date|
+          date.text =~ /#{month}-#{@year}/
+        end
+
+        url = "https://www.movistar.es"
+
+        if found
+          select(found.text, from: id)
+          find("#aceptar").click
+
+          within_window(page.driver.browser.window_handles.last) do
+            within_frame(find('frame')[:id]) do
+              within_frame(find('iframe')[:id]) do
+                url += find('#descargar a')[:href].gsub("javascript:CargarGuardar('","").gsub("')","")
+              end
+            end
+          end
+        else
+          raise "MovistarSpain invoice for month #{month} is not available yet."
+        end
+
+        Document.new(url, :get, cookie)
+      end
+    end
+
+    # Internal: Returns the String current month padded with zeros to the left.
+    def month
+      @month.to_s.rjust(2, '0')
+    end
+
+    # Internal: Sets the configuration for capybara to work with the MovistarSpain
+    # website.
+    #
+    # Returns nothing.
+    def setup_capybara
+      Capybara.run_server = false
+      Capybara.current_driver = :selenium
+      Capybara.app_host       = 'https://www.movistar.es'
+    end
+  end
+end

data/lib/autility/version.rb

@@ -1,3 +1,3 @@
 module Autility
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/autility/movistar_spain_test.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require_relative '../test_helper'
+
+module Autility
+  describe MovistarSpain do
+    subject { MovistarSpain.new("foo", "bar", 11, "/tmp/utilities") }
+
+    describe ".scrape" do
+      it 'delegates to an instance' do
+        MovistarSpain.stubs(:new).with("foo", "bar", 11, "/tmp/utilities").returns subject
+        subject.expects(:scrape)
+
+        MovistarSpain.scrape("foo", "bar", 11, "/tmp/utilities")
+      end
+    end
+
+    describe '#scrape' do
+      it 'gets the document in' do
+        subject.expects(:setup_capybara)
+        subject.expects(:log_in)
+        document = Document.new(url = stub, cookie = stub, {})
+        subject.expects(:document).returns(document)
+        document.expects(:save)
+
+        month = 11
+        year  = Time.now.year
+
+        subject.scrape.must_equal "/tmp/utilities/movistar_#{month}_#{year}.pdf"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autility
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000 Z
+date: 2011-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70224418242640 !ruby/object:Gem::Requirement
+  requirement: &70096387494420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70224418242640
+  version_requirements: *70096387494420
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
-  requirement: &70224418241960 !ruby/object:Gem::Requirement
+  requirement: &70096387493420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70224418241960
+  version_requirements: *70096387493420
 - !ruby/object:Gem::Dependency
   name: show_me_the_cookies
-  requirement: &70224418241080 !ruby/object:Gem::Requirement
+  requirement: &70096387492300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70224418241080
+  version_requirements: *70096387492300
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &70224418239960 !ruby/object:Gem::Requirement
+  requirement: &70096387489320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70224418239960
+  version_requirements: *70096387489320
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70224418239360 !ruby/object:Gem::Requirement
+  requirement: &70096387488100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70224418239360
+  version_requirements: *70096387488100
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70224418238820 !ruby/object:Gem::Requirement
+  requirement: &70096387487580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70224418238820
+  version_requirements: *70096387487580
 description: Downloads utility invoices from common spanish firms such as Endesa or
   Vodafone.
 email:
@@ -99,12 +99,14 @@ files:
 - lib/autility/data.rb
 - lib/autility/document.rb
 - lib/autility/endesa.rb
+- lib/autility/movistar_spain.rb
 - lib/autility/version.rb
 - lib/autility/vodafone_spain.rb
 - test/autility/command_test.rb
 - test/autility/cookie_test.rb
 - test/autility/document_test.rb
 - test/autility/endesa_test.rb
+- test/autility/movistar_spain_test.rb
 - test/autility/vodafone_spain_test.rb
 - test/test_helper.rb
 homepage: http://github.com/codegram/autility
@@ -136,5 +138,6 @@ test_files:
 - test/autility/cookie_test.rb
 - test/autility/document_test.rb
 - test/autility/endesa_test.rb
+- test/autility/movistar_spain_test.rb
 - test/autility/vodafone_spain_test.rb
 - test/test_helper.rb