squeegee 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@squeegee --create

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: rspec

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in squeegee.gemspec
+gemspec
+
+gem 'guard-rspec'
+gem "cane", "~> 1.1.0"

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', :notification => false,:version => 2, :cli => "--colour", :run_all => {:cli => '--profile'} do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kyle Welsby
+
+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,47 @@
+# Squeegee [![CI Build Status](https://secure.travis-ci.org/BritRuby/Squeegee.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/BritRuby/Squeegee.png?travis)][gemnasium]
+
+[travis]:http://travis-ci.org/BritRuby/Squeegee
+[gemnasium]:https://gemnasium.com/BritRuby/Squeegee
+
+Squeegee is a collection of login strategies to gather bill dates and amounts
+from customer accounts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'squeegee'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install squeegee
+
+## Usage
+
+Get the next bill statement for British Gas
+
+    user_credentials = {
+      :username => "JoeBlogs",
+      :password => "superduper",
+      :customer_number => "8500xxxxxxx"
+    }
+
+    s = Squeegee::BritishGas.new(user_credentials)
+
+    s.accounts.first #=> { :due_at => "2012-03-23",
+                           :amount => 10000,
+                         }
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/squeegee/base.rb

@@ -0,0 +1,24 @@
+module Squeegee
+  class Base
+    attr_writer :keys, :agent, :amount, :paid, :due_at
+    def params(args)
+      missing_keys = []
+      return unless defined? @keys
+      @keys.each do |key|
+        missing_keys << key unless args.has_key?(key.to_sym)
+      end
+      if missing_keys.any?
+        raise Error::InvalidParams,
+          "missing parameters #{missing_keys.map {|key| "`#{key}` "}.join}"
+      end
+    end
+
+    def get(url)
+      @agent ||= Mechanize.new
+      @agent.log = Logger.new 'squeegee.log'
+      @agent.user_agent = "Mozilla/5.0 (Squeegee)"
+      @agent.default_encoding = "utf8"
+      @agent.get(url)
+    end
+  end
+end

data/lib/squeegee/british_gas.rb

@@ -0,0 +1,88 @@
+module Squeegee
+
+  # BritishGas - Energy Supplier
+  # * can have more than one account.
+  #
+  class BritishGas < Base
+    HOST = "https://www.britishgas.co.uk"
+    LOGIN_URL = "#{HOST}/Your_Account/Account_Details/"
+    ACCOUNTS_URL = "#{HOST}/Account_History/Transactions_Account_List/"
+    ACCOUNT_URL = "#{HOST}/Your_Account/Account_Transaction/"
+
+    # British Gas Account information Extration
+    # Example:
+    #     BritishGas::Account("8500", Mecanize.new)
+    #
+    class Account < BritishGas
+      attr_accessor :paid, :due_at, :amount
+
+      def initialize(id, agent)
+        @agent = agent
+        url = "#{Squeegee::BritishGas::ACCOUNT_URL}?accountnumber=#{id}"
+        page = get(url)
+        table = page.search("div#divHistoryTable table tbody")
+        rows = table.search("tr").map do |row|
+          tds = row.search("td")
+          _row = {
+            date: Date.parse(
+              tds.first.inner_text.match(/\d{2}\s\w{3}\s\d{4}/)[0]
+            ),
+            type: tds[1].inner_text.match(/[A-Za-z]{2,}\s?[A-Za-z]?{2,}/)[0],
+            debit: tds[2].inner_text.to_f,
+            credit: tds[3].inner_text.to_f,
+            balance: tds[4].inner_text.to_f
+          }
+          _row
+        end
+        @paid = !!(rows[0][:balance] = 0)
+        rows.each do |row|
+          if row[:debit] > 0
+            @amount = row[:debit].to_s.gsub(/\.|,/,'').to_i
+            @due_at = row[:date]
+            break
+          end
+        end
+      end
+    end
+
+    attr_accessor :accounts
+
+    FIELD = {
+      email: "userName",
+      password: "password"
+    }
+
+    def initialize(args = {})
+      @keys = %w(email password)
+
+      params(args)
+      @email = args.delete(:email)
+      @password = args.delete(:password)
+
+      authenticate!
+      get_statements
+    end
+
+    private
+
+    def authenticate!
+      page = get(LOGIN_URL)
+      form = page.form_with(action: '/Online_User/Account_Summary/')
+
+      form[FIELD[:email]] = @email
+      form[FIELD[:password]] = @password
+
+      page = @agent.submit(form, form.buttons.first)
+      #raise Error::Unauthorized, "Account details could be wrong" if page.at('.error')
+    end
+
+    def get_statements
+      page = get(ACCOUNTS_URL)
+      account_ids = page.search("table#tableSelectAccount td > strong").collect {|row| row.content.to_i}
+      @accounts = account_ids.map do |account_id|
+        Account.new(account_id, @agent)
+      end
+    end
+
+  end
+end

data/lib/squeegee/bskyb.rb

@@ -0,0 +1,61 @@
+module Squeegee
+
+  # British Sky Broadcasting (BSkyB) - Premium Television
+  #
+  class BSkyB < Base
+    LOGIN_URL = "https://skyid.sky.com/signin/accountmanagement"
+    ACCOUNT_URL = "https://myaccount.sky.com/?action=viewbills"
+
+    FIELD = {
+      username: 'username',
+      password: 'password'
+    }
+
+    attr_accessor :due_at, :amount, :paid
+
+    def initialize(args = {})
+      @keys = %w(username password)
+
+      params(args)
+      @username = args.delete(:username)
+      @password = args.delete(:password)
+
+      authenticate!
+      get_statement
+    end
+
+    private
+
+    def authenticate!
+      page = get(LOGIN_URL)
+      form = page.form_with(name: 'signinform')
+
+      form[FIELD[:username]] = @username
+      form[FIELD[:password]] = @password
+
+      @agent.submit(form, form.buttons.first)
+    end
+
+    def get_statement
+      page = get(ACCOUNT_URL)
+      amount = page.search(
+        "#outstanding_balance_total span.money-left"
+      ).inner_text.gsub(/\.|,/,'').match(/\d{1,}/)
+
+      @amount = amount[0].to_i if amount
+
+      due_at = page.search(
+        "#outstanding_balance_box_label h5 span"
+      ).inner_text.match(/(\d{2})\/(\d{2})\/(\d{2})/)
+
+      @due_at = Date.parse("20#{due_at[3]}-#{due_at[2]}-#{due_at[1]}")if due_at
+
+      @paid = page.search(
+        "#payments .bill .desc"
+      ).inner_text.downcase.include?("received")
+
+    rescue NoMethodError => e
+      raise Error::PageMissingContent, "Can't find something on the page"
+    end
+  end
+end

data/lib/squeegee/error.rb

@@ -0,0 +1,10 @@
+module Squeegee
+  module Error
+    # Invalid Parameters - raised when ever a parameter is listed as missing
+    class InvalidParams < ArgumentError;end
+    # Page Missing Content - raised when the page expectations have changed
+    class PageMissingContent < NoMethodError;end
+    # Unauthenticated - raised when authentication fails.
+    class Unauthenticated < NoMethodError;end
+  end
+end

data/lib/squeegee/orange_uk.rb

@@ -0,0 +1,55 @@
+module Squeegee
+
+  # OrangeUK - Mobile network
+  #
+  class OrangeUK < Base
+    LOGIN_URL = "https://web.orange.co.uk/r/login/"
+    BILLS_URL = "https://www.youraccount.orange.co.uk/sss/jfn?mfunc=63&jfnRC=1"
+    LOGIN_POST_URL = "https://web.orange.co.uk/id/signin.php?rm=StandardSubmit"
+
+    FIELD = {
+      username: 'LOGIN',
+      password: 'PASSWORD'
+    }
+
+    attr_accessor :paid, :amount, :due_at
+
+    def initialize(args = {})
+      @keys = %w(username password)
+
+      params(args)
+      @username = args.delete(:username)
+      @password = args.delete(:password)
+
+      authenticate!
+      get_statement
+    end
+
+    private
+
+    def authenticate!
+      page = get(LOGIN_URL)
+      form = page.form_with(action: '/id/signin.php?rm=StandardSubmit')
+
+      form[FIELD[:username]] = @username
+      form[FIELD[:password]] = @password
+      page = @agent.submit(form, form.buttons.first)
+
+      if page.uri == LOGIN_POST_URL && !page.search('.error').nil?
+        raise Squeegee::Error::Unauthenticated
+      end
+    end
+
+    def get_statement
+      page = get(BILLS_URL)
+
+      last_bill = page.search("#eBillMainContent .eBillStandardTable").first
+
+      balance = page.search("#paymBalanceIncVAT").inner_text.gsub(/\.|,/,'').match(/\d{1,}/)
+
+      @due_at = Date.parse(last_bill.search("td")[0].inner_text)
+      @amount = last_bill.search('td')[2].inner_text.gsub(/\.|,/,'').match(/\d{1,}/)[0].to_i
+      #@paid = balance || balance[0].to_i >= 0
+    end
+  end
+end

data/lib/squeegee/version.rb

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

data/lib/squeegee.rb

@@ -0,0 +1,9 @@
+require 'mechanize'
+require 'logger'
+require 'squeegee/version'
+require 'squeegee/error'
+require 'squeegee/base'
+
+require 'squeegee/british_gas'
+require 'squeegee/bskyb'
+require 'squeegee/orange_uk'

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+unless ENV['travis']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec"
+  end
+end
+
+require 'rspec'
+require 'webmock'
+require 'squeegee'
+
+CONFIGS = YAML::load(File.open('spec/support/configs.yml'))
+
+RSpec.configure do |config|
+  config.order = :rand
+  config.color_enabled = true
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+  end
+end

data/spec/squeegee/base_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Squeegee::Base do
+  describe "#params" do
+    it "should raise InvalidParams if any parameters are missing" do
+      expect{
+        subject.keys = ['test']
+        subject.params({})
+      }.to raise_error(Squeegee::Error::InvalidParams, "missing parameters `test` ")
+    end
+
+    it "should raise error if no arguments given" do
+      expect{
+        subject.params
+      }.to raise_error(ArgumentError, "wrong number of arguments (0 for 1)")
+    end
+
+    it "should return nil if keys are not defined" do
+      subject.params({}).should be_nil
+    end
+  end
+
+  describe "#get" do
+    let(:mechanize) {mock('mechanize')}
+    let(:logger) {mock('logger')}
+    it "should assign agent with a new instance of Mechanize" do
+      Mechanize.should_receive(:new).and_return(mechanize)
+
+      mechanize.should_receive(:user_agent=).with("Mozilla/5.0 (Squeegee)")
+      mechanize.should_receive(:default_encoding=).with("utf8")
+      Logger.should_receive(:new).with('squeegee.log').and_return(logger)
+      mechanize.should_receive(:log=).with(logger)
+      mechanize.should_receive(:get).with("http://google.com")
+
+      subject.get("http://google.com")
+    end
+  end
+end

data/spec/squeegee/british_gas_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe Squeegee::BritishGas do
+  let(:mechanize) {mock('mechanize') }
+  let(:node) {mock('node')}
+  let(:form) {mock('form')}
+  let(:button) {mock('button')}
+
+  subject {Squeegee::BritishGas}
+
+  context "classes" do
+    before do
+      Mechanize.any_instance.stub(get: mechanize)
+    end
+    subject {Squeegee::BritishGas::Account.new(1, mechanize.as_null_object)}
+    it "should get single account" do
+      pending
+      Mechanize.any_instance.should_receive(:get).at_least(:once).with(
+        "https://www.britishgas.co.uk/Your_Account/Account_Transaction/?accountnumber=1"
+      ).and_return(mechanize.as_null_object)
+
+      subject
+    end
+    it "should build array of data" do
+      mechanize.should_receive(:search).with(
+        "div#divHistoryTable table tbody"
+      ).and_return(node)
+
+      node.should_receive(:search).with("tr").and_return([node])
+      node.should_receive(:search).with("td").and_return(
+        [
+          stub(inner_text: "12 Feb 2012"),
+          stub(inner_text: "Payment Received"),
+          stub(inner_text: ""),
+          stub(inner_text: "30.50"),
+          stub(inner_text: "0.00")
+        ]
+      )
+
+      subject.paid.should be_true
+    end
+  end
+
+  context "Parameters" do
+    before do
+      subject.any_instance.stub(:authenticate!)
+      subject.any_instance.stub(:get_statements)
+    end
+    it "raises InvalidParams when email is missing" do
+      expect{
+        subject.new
+      }.to raise_error(Squeegee::Error::InvalidParams, 
+                       "missing parameters `email` `password` ")
+    end
+
+    it "raises InvalidParams when password is missing" do
+      expect{
+        subject.new(email: "test@test.com")
+      }.to raise_error(Squeegee::Error::InvalidParams, 
+                       "missing parameters `password` ")
+    end
+
+    it "accepts email" do
+      expect{
+        subject.new(email: "test@test.com", password: "superduper")
+      }.to_not raise_error
+    end
+  end
+  context "calls" do
+    before do
+      subject.any_instance.stub(:params)
+      subject.any_instance.stub(:authenticate!)
+      subject.any_instance.stub(:get_statements)
+    end
+
+    it "calls authenticate!" do
+      subject.any_instance.should_receive(:authenticate!)
+      subject.new
+    end
+
+    it "calls get_accounts" do
+      subject.any_instance.should_receive(:get_statements)
+      subject.new
+    end
+
+    it "calls params with arguments" do
+      args = {:a => 'b'}
+      subject.any_instance.should_receive(:params).with(args)
+      subject.new(args)
+    end
+  end
+
+  context "Authentication" do
+    before do
+      subject.any_instance.stub(:params)
+      #subject.any_instance.stub(get: mechanize.as_null_object)
+      #Mechanize.any_instance.stub(get: mechanize.as_null_object)
+      Mechanize.should_receive(:new).and_return(mechanize.as_null_object)
+      mechanize.stub(form_with: form.as_null_object)
+    end
+    it "navigates to login URL" do
+      mechanize.should_receive(:get).with(
+        "https://www.britishgas.co.uk/Your_Account/Account_Details/"
+      ).and_return(mechanize)
+
+      subject.new({})
+    end
+
+    it "finds by form action" do
+      mechanize.should_receive(:form_with).with(
+        action: '/Online_User/Account_Summary/'
+      ).and_return(form.as_null_object)
+
+      subject.new
+    end
+
+    it "fills in form inputs" do
+      form.should_receive(:[]=).with('userName', 'test@test.com')
+      form.should_receive(:[]=).with('password', 'superduper')
+
+      subject.new(email: "test@test.com", password: "superduper")
+    end
+
+    it "submits with first button" do
+      form.should_receive(:buttons).and_return([button])
+      mechanize.should_receive(:submit).with(form, button)
+
+      subject.new(email: "test")
+    end
+  end
+
+  context "get_accounts" do
+    before do
+      subject.any_instance.stub(:params)
+      Mechanize.any_instance.stub(get: mechanize)
+      subject.any_instance.stub(:authenticate!)
+      mechanize.stub(search: [stub(content: "  1  ")])
+      subject::Account.stub(:new, mechanize)
+    end
+
+    it "navigates to account list URL" do
+      Mechanize.any_instance.should_receive(:get).with(
+        "https://www.britishgas.co.uk/Account_History/Transactions_Account_List/"
+      ).and_return(mechanize)
+      subject.new
+    end
+
+    it "initialises a new account" do
+      pending
+      #mechanize.stub(search: [stub(content: "  1  ")])
+      #subject::Account.should_receive(:new).with(1, Mechanize.new())
+      #subject.new
+    end
+  end
+end