ifin24-client 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Łukasz Bandzarewicz
+
+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

@@ -0,0 +1,54 @@
+Sample session:
+
+ruby-1.9.1-p378$ ./ifin24-client.rb
+a) Dodaj wydatek
+b) Lista transakcji
+c) Koniec
+?  a
+Nazwa: Obiad
+Data: |2010-08-08|
+1. eKONTO / 50 PLN
+2. Gotówka / 100 PLN
+3. Konto oszczędnościowe / 3 000 PLN
+4. PKO Bank Polski / 2 000,00 PLN
+Wybierz rachunek: 2
+1. Dom
+2. Bieżące wydatki
+3. Multimedia
+4. Transport
+5. Odzież i dodatki
+6. Dla innych
+7. Sport
+8. Edukacja
+9. Zdrowie/Ubezpieczenia
+10. Rozrywka/ Wypoczynek
+11. Zainteresowania
+12. Zobowiązania finansowe
+13. Inwestycje
+14. Transfer środków
+Wybierz kategorię: 2
+1. Żywność
+2. Stołówka/ posiłki poza domem
+3. Kosmetyki i Chemia
+4. Fryzjer/ kosmetyczka
+5. Alkohol
+6. Papierosy
+Wybierz podkategorię: 2
+Kwota: 15
+Tagi:
+Opis:
+================
+Nazwa: Obiad
+Data: 2010-08-08
+Rachunek: Gotówka / 100 PLN
+Kwota: 15
+Kategoria: Bieżące wydatki / Stołówka/ posiłki poza domem
+Tagi:
+Opis:
+================
+Dane poprawne? y
+Wysyłanie danych...
+a) Dodaj wydatek
+b) Lista transakcji
+c) Koniec
+?  c

data/README.rdoc

@@ -0,0 +1,17 @@
+= ifin24-client.1
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Łukasz Bandzarewicz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ifin24-client"
+    gem.summary = %Q{Console for iFIN24}
+    gem.description = %Q{Console for iFIN24}
+    gem.email = "lucassus@gmail.com"
+    gem.homepage = "http://github.com/lucassus/ifin24-client"
+    gem.authors = ["Łukasz Bandzarewicz"]
+    
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+
+    gem.add_dependency "mechanize"
+    gem.add_dependency "highline"
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ifin24-client.1 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/ifin24

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+
+require 'yaml'
+require 'mechanize'
+require 'highline/import'
+
+require 'ifin24'
+
+def main
+  config = Ifin24::Configuration.instance
+  client = Ifin24::Client.new(config[:login], config[:password])
+  console = Ifin24::Console.new(client)
+  console.main_menu
+end
+
+main

data/config.yml.example

@@ -0,0 +1,3 @@
+:login: ifin24_console
+:password: ifin24_console
+

data/lib/ifin24/client.rb

@@ -0,0 +1,131 @@
+class Ifin24::Client
+
+  LOGIN_FORM_URL = 'https://www.ifin24.pl/logowanie'
+  ENTRY_FORM_URL = 'https://www.ifin24.pl/zarzadzanie-finansami/transakcje/dodaj-wydatek'
+  LIST_URL = 'https://www.ifin24.pl/zarzadzanie-finansami/transakcje/lista'
+  LIST_PAGE_PARAM = '?pageNumber='
+
+  def initialize(login, password)
+    @agent = Mechanize.new
+    login(login, password)
+  end
+
+  def categories
+    @categories ||= fetch_categories
+  end
+
+  def accounts
+    fetch_accounts
+  end
+
+  def send_entry(entry)
+    page = @agent.get(ENTRY_FORM_URL)
+    form = page.forms.first
+
+    form['entry.title'] = entry.title.to_s
+    form['entry.date'] = entry.date.to_s
+    form['selectedBankAccount'] = entry.account.id.to_s
+    form['entry.entryCategory.id'] = entry.sub_category.id.to_s
+    form['entry.amount'] = entry.amount.to_s
+    form['value'] = entry.tags.to_s
+    form['entry.note'] = entry.note.to_s
+
+    form.submit
+  end
+
+  def fetch_entries(curr_page = 1)
+    page = @agent.get(LIST_URL + LIST_PAGE_PARAM + curr_page.to_s)
+    total_pages = extract_entries_total_pages(page)
+    entry_row_elements = page.search('table tbody tr')
+
+    entries = []
+
+    entry_row_elements.each do |entry_row_element|
+      entry_elements = entry_row_element.search('td')
+      next if entry_elements.size != 5
+
+      entry = Ifin24::Models::Entry.new
+
+      title_column = entry_elements[2]
+      entry.title = title_column.children[0].text.strip
+      entry.note = title_column.search('span').text.strip
+
+      date_column = entry_elements[1]
+      entry.date = date_column.text.strip
+
+      category_column = entry_elements[3]
+      sub_category = Ifin24::Models::Category.new(:name => category_column.children[0].text.strip)
+      entry.sub_category = sub_category
+        
+      entry.tags = category_column.search('span').text.strip
+      amount_column = entry_elements[4]
+      entry.amount = amount_column.text.strip
+
+      entries << entry
+    end
+
+    return entries, total_pages
+  end
+
+  private
+
+  def login(login, password)
+    page = @agent.get(LOGIN_FORM_URL)
+    form = page.forms.first
+
+    form['login'] = login
+    form['password'] = password
+
+    form.submit
+  end
+
+  def fetch_categories
+    page = @agent.get(ENTRY_FORM_URL)
+    categories_element = page.search('ul.expenseCombo>li')
+
+    categories = []
+    categories_element[1..-1].each do |category_elem|
+      category_without_children = category_elem.children[1].nil?
+      next if category_without_children
+
+      category_name = category_elem.children[0].text.strip
+      category = Ifin24::Models::Category.new(:name => category_name)
+      children_element = category_elem.children[1].children.search('li')
+
+      children_element.each do |child_elem|
+        child_id = child_elem.attributes['rel'].value
+        child_name = child_elem.text.strip
+
+        child = Ifin24::Models::Category.new(:id => child_id, :name => child_name)
+        category.children << child
+      end
+
+      categories << category
+    end
+
+    return categories
+  end
+
+  def fetch_accounts
+    page = @agent.get(ENTRY_FORM_URL)
+    accounts_element = page.search('ul#bankAccountCombo>li')
+
+    accounts = []
+    accounts_element.each do |account_elem|
+      id = account_elem.attributes['rel'].value
+      next if id == '0' # skip the prompt
+      name = account_elem.text.strip
+
+      accounts << Ifin24::Models::Account.new(:id => id, :name => name)
+    end
+
+    return accounts
+  end
+
+  # TODO implement
+  def extract_entries_total_pages(page)
+#    page.search('div.pager a')
+    3
+  end
+
+end

data/lib/ifin24/commands/add_expense.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+class Ifin24::Commands::AddExpense < Ifin24::Commands::Base
+
+  def execute
+    entry = get_entry
+
+    catch :all_ok do
+      loop do
+        choose do |menu|
+          menu.index = :letter
+          menu.index_suffix = ") "
+
+          menu.choice("Nazwa: #{entry.title}") { get_title(entry) }
+          menu.choice("Data: #{entry.date}") { get_date(entry) }
+          menu.choice("Konto: #{entry.account.name}") { get_account(entry) }
+          menu.choice("Kategoria: #{entry.category_full_name}") { get_category(entry) }
+          menu.choice("Kwota: #{entry.amount}") { get_amount(entry) }
+          menu.choice("Tagi: #{entry.tags}") { get_tags(entry) }
+          menu.choice("Opis: #{entry.note}") { get_note(entry) }
+
+          menu.choice("Powrót do głównego menu") do
+            throw :all_ok
+          end
+
+          menu.choice("Wyślij") do
+            puts "Wysyłanie danych..."
+            @client.send_entry(entry)
+            throw :all_ok
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def get_entry
+    entry = Ifin24::Models::Entry.new
+
+    get_title(entry)
+    get_date(entry)
+    get_account(entry)
+    get_category(entry)
+    get_amount(entry)
+    get_tags(entry)
+    get_note(entry)
+
+    return entry
+  end
+
+  def get_title(entry)
+    entry.title = ask('Nazwa: ')
+  end
+
+  def get_date(entry)
+    curr_date = Date.today
+    entry.date = ask('Data: ') do |q|
+      q.default = curr_date
+    end
+  end
+
+  def get_account(entry)
+    choose do |menu|
+      menu.prompt = 'Wybierz rachunek: '
+
+      @client.accounts.each do |account|
+        menu.choice(account.name) do
+          entry.account = account
+        end
+      end
+    end
+  end
+
+  def get_category(entry)
+    choose do |menu|
+      menu.prompt = 'Wybierz kategorię: '
+
+      @client.categories.each do |category|
+        menu.choice(category.name) do
+          entry.category = category
+        end
+      end
+    end
+
+    choose do |menu|
+      menu.prompt = 'Wybierz podkategorię: '
+
+      entry.category.children.each do |child|
+        menu.choice(child.name) do
+          entry.sub_category = child
+        end
+      end
+    end
+  end
+
+  def get_amount(entry)
+    entry.amount = eval ask('Kwota: ')
+  end
+
+  def get_tags(entry)
+    entry.tags = ask('Tagi: ')
+  end
+
+  def get_note(entry)
+    entry.note = ask('Opis: ')
+  end
+
+end

data/lib/ifin24/commands/base.rb

@@ -0,0 +1,8 @@
+class Ifin24::Commands::Base
+  include Ifin24::Helpers::Printer
+
+  def initialize(client)
+    @client = client
+  end
+
+end

data/lib/ifin24/commands/list_accounts.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+class Ifin24::Commands::ListAccounts < Ifin24::Commands::Base
+
+  def execute
+    print_list(@client.accounts, :name)
+  end
+
+end

data/lib/ifin24/commands/list_entries.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+class Ifin24::Commands::ListEntries < Ifin24::Commands::Base
+
+  def execute
+    current_page = 1
+    list, pages = @client.fetch_entries(current_page)
+    print_entries(list)
+
+    catch :exit do
+      loop do
+        choose do |menu|
+          menu.index = :letter
+          menu.index_suffix = ") "
+
+          menu.choice("Poprzednia strona") do
+            current_page -= 1 if current_page > 1
+
+            list, pages = @client.fetch_entries(current_page)
+            print_entries(list)
+          end
+
+          menu.choice("Następna strona") do
+            current_page += 1 if current_page < pages
+
+            list, pages = @client.fetch_entries(current_page)
+            print_entries(list)
+          end
+
+          menu.choice("Powrót do głównego menu") { throw :exit }
+        end
+      end
+    end
+  end
+
+  private
+
+  def print_entries(list)
+    print_list(list, :date, :title, :sub_category, :tags, :amount)
+  end
+
+end

data/lib/ifin24/commands.rb

@@ -0,0 +1,8 @@
+module Ifin24::Commands
+
+  autoload :Base, 'ifin24/commands/base'
+  autoload :AddExpense, 'ifin24/commands/add_expense'
+  autoload :ListAccounts, 'ifin24/commands/list_accounts'
+  autoload :ListEntries, 'ifin24/commands/list_entries'
+
+end

data/lib/ifin24/configuration.rb

@@ -0,0 +1,20 @@
+require 'singleton'
+
+class Ifin24::Configuration
+  include Singleton
+
+  attr_reader :config
+
+  def initialize
+    @config = {}
+    
+    config_file_name = File.join(ENV['HOME'], '.ifin24-client', 'config.yml')
+    if File.exist?(config_file_name)
+      @config = YAML.load_file(config_file_name) rescue {}
+    end
+  end
+
+  def [](index)
+    @config[index]
+  end
+end

data/lib/ifin24/console.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+class Ifin24::Console
+
+  def initialize(client)
+    @client = client
+  end
+
+  def main_menu
+    catch :exit do
+      loop do
+        choose do |menu|
+          menu.index = :letter
+          menu.index_suffix = ") "
+
+          menu.choice("Dodaj wydatek") { add_expense }
+          menu.choice("Lista kont") { list_accounts }
+          menu.choice("Lista ostatnich transakcji") { list_entries }
+
+          menu.choice("Koniec") { throw :exit }
+        end
+      end
+    end
+  end
+
+  def add_expense
+    execute_command(Ifin24::Commands::AddExpense)
+  end
+
+  def list_accounts
+    execute_command(Ifin24::Commands::ListAccounts)
+  end
+
+  def list_entries
+    execute_command(Ifin24::Commands::ListEntries)
+  end
+
+  private
+
+  def execute_command(command)
+    command.new(@client).execute
+  end
+
+end

data/lib/ifin24/helpers/printer.rb

@@ -0,0 +1,32 @@
+module Ifin24::Helpers
+  module Printer
+
+    def print_list(items, *fields)
+      # find max length for each field; start with the field names themselves
+      fields = items.first.class.column_names unless fields.any?
+      max_len = Hash[*fields.map { |f| [f, f.to_s.length] }.flatten]
+      items.each do |item|
+        fields.each do |field|
+          len = item.send(field).to_s.length
+          max_len[field] = len if len > max_len[field]
+        end
+      end
+
+      border = '+-' + fields.map { |f| '-' * max_len[f] }.join('-+-') + '-+'
+      title_row = '| ' + fields.map { |f| sprintf("%-#{max_len[f]}s", f.to_s) }.join(' | ') + ' |'
+
+      puts border
+      puts title_row
+      puts border
+
+      items.each do |item|
+        row = '| ' + fields.map { |f| sprintf("%-#{max_len[f]}s", item.send(f)) }.join(' | ') + ' |'
+        puts row
+      end
+
+      puts border
+      puts "#{items.length} rows in set\n"
+    end
+
+  end
+end

data/lib/ifin24/helpers.rb

@@ -0,0 +1,5 @@
+module Ifin24::Helpers
+
+  autoload :Printer, 'ifin24/helpers/printer'
+
+end

data/lib/ifin24/models/account.rb

@@ -0,0 +1,6 @@
+class Ifin24::Models::Account < Ifin24::Models::Base
+
+  attr_accessor :id
+  attr_accessor :name
+
+end

data/lib/ifin24/models/base.rb

@@ -0,0 +1,11 @@
+class Ifin24::Models::Base
+
+  def initialize(attributes = {})
+
+    attributes.each do |key, value|
+      send(:"#{key}=", value)
+    end
+    
+  end
+  
+end

data/lib/ifin24/models/category.rb

@@ -0,0 +1,15 @@
+class Ifin24::Models::Category < Ifin24::Models::Base
+
+  attr_accessor :id, :name
+  attr_accessor :children
+
+  def initialize(attributes = {})
+    super(attributes)
+    @children = []
+  end
+
+  def to_s
+    @name
+  end
+
+end

data/lib/ifin24/models/entry.rb

@@ -0,0 +1,14 @@
+class Ifin24::Models::Entry < Ifin24::Models::Base
+
+  # TODO Add validations
+  attr_accessor :title, :date, :amount, :tags, :note
+  attr_accessor :account
+    
+  attr_accessor :category
+  attr_accessor :sub_category
+
+  def category_full_name
+    "#{category.name} | #{sub_category.name}"
+  end
+
+end

data/lib/ifin24/models.rb

@@ -0,0 +1,8 @@
+module Ifin24::Models
+
+  autoload :Base, 'ifin24/models/base'
+  autoload :Account, 'ifin24/models/account'
+  autoload :Category, 'ifin24/models/category'
+  autoload :Entry, 'ifin24/models/entry'
+
+end

data/lib/ifin24.rb

@@ -0,0 +1,11 @@
+module Ifin24
+
+  autoload :Client, 'ifin24/client'
+  autoload :Commands, 'ifin24/commands'
+  autoload :Configuration, 'ifin24/configuration'
+  autoload :Console, 'ifin24/console'
+  autoload :Helpers, 'ifin24/helpers'
+  autoload :Models, 'ifin24/models'
+
+end
+

data/spec/ifin24-client_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Ifin24Client" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ifin24'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: ifin24-client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "\xC5\x81ukasz Bandzarewicz"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-28 00:00:00 +02:00
+default_executable: ifin24
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Console for iFIN24
+email: lucassus@gmail.com
+executables: 
+- ifin24
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/ifin24
+- config.yml.example
+- lib/ifin24.rb
+- lib/ifin24/client.rb
+- lib/ifin24/commands.rb
+- lib/ifin24/commands/add_expense.rb
+- lib/ifin24/commands/base.rb
+- lib/ifin24/commands/list_accounts.rb
+- lib/ifin24/commands/list_entries.rb
+- lib/ifin24/configuration.rb
+- lib/ifin24/console.rb
+- lib/ifin24/helpers.rb
+- lib/ifin24/helpers/printer.rb
+- lib/ifin24/models.rb
+- lib/ifin24/models/account.rb
+- lib/ifin24/models/base.rb
+- lib/ifin24/models/category.rb
+- lib/ifin24/models/entry.rb
+- spec/ifin24-client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/lucassus/ifin24-client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Console for iFIN24
+test_files: 
+- spec/ifin24-client_spec.rb
+- spec/spec_helper.rb