bos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a431e5d2c758bebe674427c3315193ad5cd37e76
+  data.tar.gz: 530fea7769d8dc1487a185af0ff04da80cda0ac0
+SHA512:
+  metadata.gz: 9c4fe7f4f1629ffe8c4673dc534e611a5c96eafa2207adcda075b987f2fe04f738326a2b63d6f4b1d612b3c7c55fd60060f8d05c64d1e55cef1e572339c8dd40
+  data.tar.gz: 54869da17dc46b89e23347ef1fc041aa38e42f3635eb2b42705312012ea8ca5f69051ce1545898abe8f9b31359abd4276c06d0b6ee73bf7136c3e6868def1ac8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jingkai He
+
+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,52 @@
+# BOS
+
+BOS is a ruby client that scrape your banking details from your bank of scotland web page. You are higly under risk (e.g. online bank account get blocked; Either password or security code leaks) when using it. So please do use it responsibly (The author of the gem under any circumstances will not responsible for any lost).
+
+It seems like Lloyds Bank plc, TSB Bank plc, Bank of Scotland plc and Halifax, as all of them belong to Lloyds Banking Group, are sharing the same banking system. As a result, you might be able to migrate the gem to some other banking systems without too much difficulties. Again, please do use it responsibly!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bos'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bos
+
+## Usage
+
+BOS is a screen scraper that collect you your banking details.
+
+If you use it for the first time, then you need do configuration. The code shown below would store your banking details into ~/.bos file and persit in JSON format.
+
+```ruby
+BOS.confg USER_ID, PASSWORD, SECURITY_CODE
+```
+
+The code snippet below show the basic usage of BOS gem (very easy to understand, isn't it?)
+
+```ruby
+client = BOS.client # Return a bos client.
+
+client.balance
+client.account_number
+client.sort_code
+client.mini_statement
+client.full_statement
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/jaxi/bos/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,16 @@
+require "bundler/gem_tasks"
+
+desc "Run an IRB session with BOS preloaded"
+task :console do
+  exec "irb -I lib -r bos"
+end
+
+require 'rake/testtask'
+
+task :default => :test
+
+task :test do
+  require "bos"
+  $LOAD_PATH.unshift('lib', 'test')
+  Dir.glob('./test/**/*_test.rb') { |f| require f }
+end

data/bos.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bos/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bos"
+  spec.version       = BOS::VERSION
+  spec.authors       = ["Jingkai He"]
+  spec.email         = ["jaxihe@gmail.com"]
+  spec.summary       = %q{Bank of Scotland screen scraper}
+  spec.description   = %q{Bank of Scotland screen scraper}
+  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_dependency "mechanize", "~> 2.7.3"
+  spec.add_dependency "thor", "~> 0.19.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.3"
+end

data/lib/bos.rb

@@ -0,0 +1,54 @@
+require "mechanize"
+require "json"
+
+require "bos/version"
+require "bos/query"
+require "bos/user"
+
+module BOS
+  LOGIN_PAGE = "https://online.bankofscotland.co.uk/personal/logon/login.jsp".freeze
+  class << self
+    def agent
+      @agent ||= begin
+        a = Mechanize.new
+        a.agent.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        a
+      end
+    end
+
+    # Public: Configure the user_id, password and security code
+    #
+    # Return: Nothing
+    def config(options = {})
+      if options[:file]
+        filename = options[:filename] || File.join(Dir.home, ".bos")
+        config_hash = JSON.parse(IO.read(filename), symbolize_names: true)
+        @user_id = config_hash[:user_id]
+        @password = config_hash[:password]
+        @security_code = config_hash[:security_code]
+      else
+        @user_id = options[:user_id]
+        @password = options[:password]
+        @security_code = options[:security_code]
+        File.open(File.join(Dir.home, ".bos"), "w") do |f|
+          f.write options.to_json
+        end
+      end
+    end
+
+    # Public: The client that answer your questions about your banking
+    #
+    # Returns: A BOS::User object
+    def client
+      @client ||= begin
+        config(file: true) if !user_id
+        User.new(user_id, password, security_code)
+      end
+    end
+
+    private
+    attr_reader :user_id, :password, :security_code
+  end
+
+  class LoginError < StandardError; end
+end

data/lib/bos/query.rb

@@ -0,0 +1,107 @@
+module BOS
+  class Query
+    def initialize(session)
+      @session = session
+    end
+
+    def balance
+      @balance ||= session.at("p[class='balance']/span[2]").text
+    end
+
+    def sort_code
+      @sort_code ||= begin
+        txt = session.at("p[class='numbers wider']").text
+        /\d\d-\d\d-\d\d/.match(txt)[0]
+      end
+    end
+
+    def account_number
+      @account_number ||= begin
+        txt = session.at("p[class='numbers wider']").text
+        /\d{8}/.match(txt)[0]
+      end
+    end
+
+    def mini_statement_page
+      @mini_statement_page ||= begin
+        mini_link = session.at("a[id='lstAccLst:0:lstOptions:lkMiniAccountStmt']")
+        mini_link = / {ajaxURI:'([\S]+)'}/.match(mini_link.attributes["class"].value)[1]
+        BOS.agent.get mini_link
+      end
+    end
+
+    def mini_statement
+      @mini_statement ||= begin
+        rows = mini_statement_page.search('//table/tbody/tr')
+        result = []
+        rows.each_with_index do |row, index|
+          date_ele = row.at('td[1]/span/text()')
+          date = date_ele ? Date.parse(date_ele.text) : result[index - 1][:date]
+
+          description = row.at('td[2]/text()').text.strip
+
+          income = row.at('td[3]/text()')
+          income = income ? income.text.strip.to_f : 0
+
+          outcome = row.at('td[4]/text()')
+          outcome = outcome ? outcome.text.strip.to_f : 0
+
+          result << {
+            date: date,
+            description: description,
+            income: income,
+            outcome: outcome
+          }
+        end
+
+        result
+      end
+    end
+
+    def full_statement
+      @full_statement ||= begin
+        rows = full_statement_page.search('//table/tbody/tr')
+        result = []
+        rows.each do |row|
+          date = Date.parse(row.at("th/span/text()"))
+          tds = row.search("td")
+
+          description = tds[0].text.strip
+          type = tds[1].text.strip
+          income = tds[2].text.to_f
+          outcome = tds[3].text.to_f
+          balance = tds[4].text
+
+          result << {
+            date: date,
+            description: description,
+            type: type,
+            income: income,
+            outcome: outcome,
+            balance: balance
+          }
+        end
+
+        result
+      end
+    end
+
+    def full_statement_page
+      @full_statement_page ||= begin
+        full_statement_page_link = mini_statement_page
+          .at("a[id='miniaccountstatements:lkViewFullStatement']")["href"]
+
+        BOS.agent.get(full_statement_page_link)
+      end
+    end
+
+    # TODO: Implement query search
+    def transaction_query(query, start_date, end_date)
+      raise NoMethodError, "transaction_query method will come soon"
+    end
+
+    private
+
+    attr_reader :session
+  end
+end

data/lib/bos/user.rb

@@ -0,0 +1,84 @@
+module BOS
+  class User
+    extend ::Forwardable
+
+    def initialize(user_id, password, security_code)
+      @user_id = user_id
+      @password = password
+      @security_code = security_code
+    end
+
+    delegate [:balance, :sort_code, :account_number,
+      :mini_statement, :full_statement] => :query
+
+    def inspect
+      "#<BOS::User:0x#{(object_id << 1).to_s(16)}>"
+    end
+
+    private
+
+    # Private: Login with the user's id and password
+    #
+    # Returns: Security Page
+    def enter_password
+      return if @security_page
+
+      login_page = BOS.agent.get(LOGIN_PAGE)
+      login_form = login_page.form("frmLogin")
+      login_form["frmLogin:strCustomerLogin_userID"] = user_id
+      login_form["frmLogin:strCustomerLogin_pwd"] = password
+
+      page = BOS.agent.submit(login_form, login_form.buttons.first)
+
+      if page.uri.to_s.include? LOGIN_PAGE
+        raise LoginError, "ID OR PASSWORD IS WRONG"
+      else
+        @security_page = page
+      end
+    end
+
+    # Private: Enter the security code on security information page
+    #
+    # Returns: Acccount Overall Page
+    def enter_security_code
+      return if @overview_page
+      security_code_form = security_page.form("frmentermemorableinformation1")
+
+      number1 = security_page.search("label[for='frmentermemorableinformation1:strEnterMemorableInformation_memInfo1']").text()
+      number1 = security_code[/\d+/.match(number1)[0].to_i - 1]
+
+      number2 = security_page.search("label[for='frmentermemorableinformation1:strEnterMemorableInformation_memInfo2']").text()
+      number2 = security_code[/\d+/.match(number2)[0].to_i - 1]
+
+      number3 = security_page.search("label[for='frmentermemorableinformation1:strEnterMemorableInformation_memInfo3']").text()
+      number3 = security_code[/\d+/.match(number3)[0].to_i - 1]
+
+      security_code_form.field_with(name: "frmentermemorableinformation1:strEnterMemorableInformation_memInfo1")
+        .value = "&nbsp;#{number1}"
+      security_code_form.field_with(name: "frmentermemorableinformation1:strEnterMemorableInformation_memInfo2")
+        .value = "&nbsp;#{number2}"
+      security_code_form.field_with(name: "frmentermemorableinformation1:strEnterMemorableInformation_memInfo3")
+        .value = "&nbsp;#{number3}"
+
+      page = BOS.agent.submit(security_code_form, security_code_form.buttons.first)
+
+      if /account_overview_personal/.match page.uri.to_s
+        @overview_page = page
+      else
+        raise LoginError, "SECURE CODE IS WRONG" unless /account_overview_personal/.match page.uri.to_s
+      end
+    end
+
+    def query
+      @query ||= begin
+        enter_password
+        enter_security_code
+        Query.new overview_page
+      end
+    end
+
+    attr_reader :user_id, :password, :security_code
+
+    attr_reader :security_page, :overview_page
+  end
+end

data/lib/bos/version.rb

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

data/test/bos_test.rb

@@ -0,0 +1,7 @@
+require "minitest/autorun"
+
+describe BOS do
+  it "works" do
+    BOS::VERSION.must_equal "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: bos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jingkai He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+description: Bank of Scotland screen scraper
+email:
+- jaxihe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bos.gemspec
+- lib/bos.rb
+- lib/bos/query.rb
+- lib/bos/user.rb
+- lib/bos/version.rb
+- test/bos_test.rb
+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.5
+signing_key: 
+specification_version: 4
+summary: Bank of Scotland screen scraper
+test_files:
+- test/bos_test.rb