mbanker 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+guard 'ego' do
+  watch('Guardfile')
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+  watch('Gemfile') { "spec" }
+  watch(/^.+\.gemspec/) { "spec" }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2011 Michal Taszycki
+
+ 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.markdown

@@ -0,0 +1,77 @@
+mBanker
+=======
+
+Missing API for online mBank services.
+
+Client for nonexistent mBank API. 
+
+Installation
+------------
+
+gem install mbanker
+
+Usage
+-----
+
+``` ruby
+
+require 'mbanker'
+
+# opening session
+session = Mbanker.create_session USERNAME, PASSWORD
+
+# printing accounts info
+session.accounts.each do |account|
+  puts "#{account.label} - #{account.name}"
+  puts "  number: #{account.number}"
+  puts "  balance: #{account.balance}"
+  puts "  available money: #{account.balance}"
+  
+  # fetch and print account details
+  account.fetch_details
+  puts "  details:"
+  puts "    iban number: #{account.iban_number}"
+  puts "    bic number: #{account.bic_number}"
+  puts "    owner: #{account.owner}"
+  puts "    account type: #{account.account_type}"
+  puts "    client role: #{account.client_role}"
+  puts "    plenipotentiary: #{account.plenipotentiary}"
+end
+
+# changing name of the account
+session.accounts.first.change_name "MONEY JAR"
+
+```
+
+Development and testing
+-------------
+    
+    git clone git://github.com/mehowte/mbanker.git
+    cd mbanker
+    bundle
+    bundle exec rspec spec
+
+License
+-------
+
+Copyright © 2011 Michal Taszycki
+
+ 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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/mbanker.rb

@@ -0,0 +1,14 @@
+module Mbanker
+  autoload :Account, 'mbanker/account'
+  autoload :AccountsList, 'mbanker/accounts_list'
+  autoload :Authenticator, 'mbanker/authenticator'
+  autoload :Crawler, 'mbanker/crawler'
+  autoload :PersistentCrawler, 'mbanker/persistent_crawler'
+  autoload :Session, 'mbanker/session'
+
+  def self.create_session username, password
+    crawler = Crawler.new
+    authenticator = Authenticator.new crawler, username, password
+    Session.new crawler, authenticator
+  end
+end

data/lib/mbanker/account.rb

@@ -0,0 +1,71 @@
+module Mbanker
+  class Account
+    attr_reader :index, :name, :label, :number, :iban_number, :bic_number, :account_type
+    attr_reader :owner, :plenipotentiary, :client_role, :balance, :available_money
+
+    def initialize index, crawler, attributes
+      @index, @crawler = index, crawler
+      if attributes.key? :full_name_and_number
+        extract_label_name_and_number attributes[:full_name_and_number]
+      end
+      [:balance, :available_money].each do |attribute_name|
+        if attributes.key? attribute_name
+          instance_variable_set(:"@#{attribute_name}", attributes[attribute_name])
+        end
+      end
+    end
+
+    def change_name new_name
+      visit_account_details
+      @crawler.click change_name_button
+      
+      @crawler.get_form.tbVarPartAccName = new_name
+      @crawler.click confirm_button
+    end
+
+    def fetch_details
+      visit_account_details 
+      extract_label_and_name @crawler.extract_text('fieldset:nth-child(2) .content')
+      @number = @crawler.extract_text('fieldset:nth-child(3) .content')
+      @iban_number = @crawler.extract_text('fieldset:nth-child(4) .content')
+      @bic_number = @crawler.extract_text('fieldset:nth-child(5) .content')
+      @account_type = @crawler.extract_text('fieldset:nth-child(6) .content')
+      @owner = @crawler.extract_text('fieldset:nth-child(7) li')
+      @plenipotentiary = @crawler.extract_text('fieldset:nth-child(8) li')
+      @client_role = @crawler.extract_text('fieldset:nth-child(9) .content')
+      @balance = @crawler.extract_text('fieldset:nth-child(10) .amount')
+      @available_money = @crawler.extract_text('fieldset:nth-child(11) .amount')
+    end
+
+
+    private
+
+    def extract_label_name_and_number full_name_and_number
+      label_and_name, @number = full_name_and_number.gsub(/\A(.+) ((\d\s?){26})\Z/,'\1,\2').split(',').map(&:strip)
+      extract_label_and_name label_and_name
+    end
+
+    def extract_label_and_name label_and_name
+      @label, @name = label_and_name.split(' - ').map(&:strip)
+      @name ||= ''
+    end
+
+    def visit_account_details
+      @crawler.visit :accounts_list
+      @crawler.click account_link
+    end
+
+    def change_name_button
+      @crawler.search('.button:nth-child(2)').first
+    end
+
+    def confirm_button
+      @crawler.search('#Confirm').first
+    end
+
+    def account_link
+      @crawler.search('p.Account a')[@index]
+    end
+  end
+end
+

data/lib/mbanker/accounts_list.rb

@@ -0,0 +1,29 @@
+module Mbanker
+  class AccountsList
+    attr_reader :accounts
+
+    def initialize crawler
+      @crawler = crawler
+      fetch_accounts
+    end
+
+    private
+    def fetch_accounts
+      @accounts = []
+      @crawler.visit :accounts_list
+      full_names_and_numbers = @crawler.extract_texts('.Account a')
+      balances = @crawler.extract_texts('.Amount a')
+      availables = @crawler.extract_texts('.Amount span')
+      accounts_count = full_names_and_numbers.count
+      accounts_count.times do |index|
+        attributes = {
+          full_name_and_number: full_names_and_numbers[index],
+          balance: balances[index],
+          available_money: availables[index]
+        }
+        @accounts << Mbanker::Account.new(index, @crawler, attributes)
+      end
+    end
+    
+  end
+end

data/lib/mbanker/authenticator.rb

@@ -0,0 +1,34 @@
+module Mbanker
+  class Authenticator
+    attr_accessor :crawler
+
+    def initialize crawler, login, password
+      @crawler, @login, @password = crawler, login, password
+    end
+
+    def authenticated?
+      crawler.visit :accounts_list
+      session_error_absent?
+    end
+
+    def authenticate!
+      crawler.visit :login
+      login_form = crawler.get_form
+      login_form.customer = @login
+      login_form.password = @password
+      login_form.submit
+      unless session_error_absent?
+        raise "Could not authenticate"
+      end
+    end
+
+    def unauthenticate!
+      crawler.visit :logout
+    end
+
+    def session_error_absent?
+      not crawler.can_find?('.error.noSession')
+    end
+
+  end
+end

data/lib/mbanker/crawler.rb

@@ -0,0 +1,78 @@
+require 'mechanize'
+module Mbanker
+  class Crawler
+
+    BASE_URI = 'https://www.mbank.com.pl/'
+    PATHS = {
+      :login => 'logon.aspx',
+      :logout => 'logout.aspx',
+      :accounts_list => 'accounts_list.aspx',
+      :account_details => 'account_details.aspx',
+      :account_name_change => 'contract_change_name.aspx',
+      :operation_history => 'account_oper_list.aspx'
+    }
+
+    def initialize 
+      @agent = Mechanize.new
+    end
+  
+    def visit path_name
+      @agent.get(BASE_URI + PATHS[path_name])
+    end
+
+    def click link_or_button
+      action = extract_action link_or_button
+      parameters = extract_post_parameters link_or_button
+      submit_navigation_form action, parameters
+    end
+
+    def extract_action link
+      onclick_value = link.attribute('onclick').value
+      onclick_value.gsub(/\A.*\('/, '').gsub(/'.*\Z/,'')
+    end
+
+    def extract_post_parameters link
+      onclick_value = link.attribute('onclick').value
+      onclick_value.gsub(/'/,'').split(',')[3]
+    end
+
+    def submit_navigation_form action, parameters
+      navigation_form = @agent.page.form
+      navigation_form.action = action
+      navigation_form.__PARAMETERS = parameters
+      navigation_form.method = 'POST'
+      navigation_form.submit
+    end
+
+
+
+
+    def search selector
+      @agent.page.search(selector)
+    end
+
+    def find_first selector
+      @agent.page.at selector
+    end
+
+    def extract_text selector
+      element = find_first(selector)
+      element ? element.text.strip : ''
+    end
+
+    def extract_texts selector
+      search(selector).map(&:text).map(&:strip)
+    end
+
+    def can_find? selector
+      not search(selector).empty?
+    end
+
+
+    def get_form
+      @agent.page.form
+    end
+
+    
+  end
+end

data/lib/mbanker/persistent_crawler.rb

@@ -0,0 +1,51 @@
+module Mbanker
+  class PersistentCrawler
+
+    def initialize crawler, authenticater
+      @crawler, @authenticator = crawler, authenticater
+      if @authenticator.authenticated?
+        @authenticator.authenticate!
+      end
+    end
+  
+    def visit path_name
+      @crawler.visit path_name
+      unless @authenticator.session_error_absent?
+        @authenticator.authenticate!
+        @crawler.visit path_name
+      end
+    end
+
+    def click link_or_button
+      @crawler.click link_or_button
+      unless @authenticator.session_error_absent?
+        @authenticator.authenticate!
+        @crawler.visit link_or_button
+      end
+    end
+
+    def search selector
+      @crawler.search selector
+    end
+
+    def can_find? selector
+      @crawler.can_find? selector
+    end
+
+    def find_first selector
+      @crawler.find_first selector
+    end
+
+    def extract_text selector
+      @crawler.extract_text selector
+    end
+
+    def extract_texts selector
+      @crawler.extract_texts selector
+    end
+
+    def get_form
+      @crawler.get_form
+    end
+  end
+end

data/lib/mbanker/session.rb

@@ -0,0 +1,16 @@
+module Mbanker
+  class Session
+    attr_accessor :crawler, :persistent_crawler
+    
+    def initialize crawler, authorizer 
+      @crawler, @authorizer = crawler, authorizer 
+      @persistent_crawler = Mbanker::PersistentCrawler.new @crawler, @authorizer
+    end
+
+    def accounts
+      @accounts_list ||= Mbanker::AccountsList.new @persistent_crawler
+      @accounts_list.accounts
+    end
+
+  end
+end

data/lib/mbanker/version.rb

@@ -0,0 +1,3 @@
+module Mbanker
+  VERSION = "0.1.0"
+end

data/mbanker.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mbanker/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mbanker"
+  s.version     = Mbanker::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michał Taszycki"]
+  s.email       = ["mtaszycki@gmail.com"]
+  s.homepage    = "https://github.com/mehowte/mbanker"
+  s.summary     = %q{Missing API for online mBank services}
+  s.description = %q{Provides access to online mBank services.}
+
+  s.rubyforge_project = "mbanker"
+
+  s.add_dependency "mechanize"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "growl"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/lib/mbanker/authenticator.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Mbanker
+  describe Authenticator do
+    let(:password) { double("password") }
+    let(:login) { double("login") }
+    let(:crawler) { double("crawler") }
+    let(:search_result) { double("search_result") }
+    let(:login_form) { double("login_form") }
+
+    subject { Authenticator.new crawler, login, password }
+
+    describe "#session_error_absent?" do
+      it "searches for appropriate element on current page" do
+        crawler.should_receive(:can_find?).with('.error.noSession') do
+          search_result.as_null_object
+        end
+        subject.session_error_absent?
+      end
+
+      it "recognizes when error element is found" do
+        crawler.stub(:can_find?) { true }
+        subject.session_error_absent?.should == false
+        crawler.stub(:can_find?) { false }
+        subject.session_error_absent?.should == true
+      end
+    end
+
+    describe "#authenticate!" do
+      it "visits login page" do
+        crawler.as_null_object.should_receive(:visit).with(:login)
+        subject.authenticate!
+      end
+      it "submits credentials" do
+        crawler.as_null_object.should_receive(:get_form) { login_form }
+        login_form.should_receive(:customer).with(:login)
+        login_form.should_receive(:password).with(:password)
+        login_form.should_receive(:submit)
+        subject.authenticate!
+      end
+    end
+
+
+    describe "#unauthenticate!" do
+      it "visits logout page" do
+        crawler.should_receive(:visit).with(:logout)
+        subject.unauthenticate!
+      end
+    end
+  end
+end
+

data/spec/lib/mbanker/session_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Mbanker
+  describe Session do
+    let(:accounts_list) { double("accounts_list").as_null_object }
+    let(:accounts) { double("accounts").as_null_object }
+    let(:crawler) { double("crawler").as_null_object }
+    let(:authorizer) { double("authorizer").as_null_object }
+    let(:persistent_crawler) { double("persistent_crawler").as_null_object }
+
+    subject { Session.new crawler, authorizer }
+
+    before do
+      Mbanker::PersistentCrawler.stub(:new) { persistent_crawler }
+      Mbanker::AccountsList.stub(:new) { accounts_list }
+    end
+
+    describe "#accounts" do
+      it "returns new accounts list" do
+        Mbanker::AccountsList.should_receive(:new) { accounts_list }
+        accounts_list.stub(:accounts) { accounts }
+        subject.accounts.should == accounts
+      end
+
+      it "initializes accounts list with persistent crawler" do
+        Mbanker::AccountsList.should_receive(:new).with(persistent_crawler)
+        subject.accounts
+      end
+
+      it "memoizes accounts list" do
+        Mbanker::AccountsList.should_receive(:new).once
+        subject.accounts
+        subject.accounts
+      end
+    end
+  end
+end

data/spec/lib/mbanker_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Mbanker do
+
+  describe "#create_session" do
+
+    let(:username) { "a username" }
+    let(:password) { "a password" }
+
+    let(:crawler) { double("crawler") }
+    let(:authenticator) { double("authenticator") }
+    let(:session) { double("session") }
+
+    before do
+      Mbanker::Crawler.stub(:new) { crawler }
+      Mbanker::Authenticator.stub(:new) { authenticator }
+      Mbanker::Session.stub(:new) { session }
+    end
+
+    it "creates new crawler" do
+      Mbanker::Crawler.should_receive(:new)
+      Mbanker::create_session username, password
+    end
+
+    it "creates new authenticator with crawler and credentials" do
+      Mbanker::Authenticator.should_receive(:new).with(crawler, username, password)
+      Mbanker::create_session username, password
+    end
+
+    it "returns new session constructed with crawler and credentials" do
+      Mbanker::Session.should_receive(:new).with(crawler, authenticator) { session }
+
+      Mbanker::create_session(username, password).should == session
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/mbanker'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: mbanker
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Micha\xC5\x82 Taszycki"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Provides access to online mBank services.
+email: 
+- mtaszycki@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/mbanker.rb
+- lib/mbanker/account.rb
+- lib/mbanker/accounts_list.rb
+- lib/mbanker/authenticator.rb
+- lib/mbanker/crawler.rb
+- lib/mbanker/persistent_crawler.rb
+- lib/mbanker/session.rb
+- lib/mbanker/version.rb
+- mbanker.gemspec
+- spec/lib/mbanker/authenticator.rb
+- spec/lib/mbanker/session_spec.rb
+- spec/lib/mbanker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mehowte/mbanker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: mbanker
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Missing API for online mBank services
+test_files: 
+- spec/lib/mbanker/authenticator.rb
+- spec/lib/mbanker/session_spec.rb
+- spec/lib/mbanker_spec.rb
+- spec/spec_helper.rb