ovchipkaart 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09ccdb1d5717c059077262bbf71be5c193b0224c
+  data.tar.gz: 952b7c38c40a842f689bc4ebcf82c357681e15f1
+SHA512:
+  metadata.gz: a9039725bc5bda89975e6bf04990265d17e22481e800661a6d0e2e981283ad052a77036f066eca264f287190165df9510c83576347df1563aecf597d79956da8
+  data.tar.gz: 10b222ac46cee284ae09c48b7510a246185d70072c3ec56e7bad50fafa8ddbfd74d83c8c837c59f7ca8fab643654ff0d55474572bc60387a6d5b5dc1a8bcd894

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+bundler_args: --without development
+script: 'bundle exec rspec --tag ~web_driver:true'
+env:
+  - TRAVIS_CI=true
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'capybara'
+gem 'selenium-webdriver'
+gem 'chromedriver-helper', github: 'mars/chromedriver-helper', ref: '3be3d'
+
+gem 'coveralls', require: false
+
+group :development, :test do
+  gem 'pry', require: false
+  gem 'rspec'
+end
+
+group :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan van der Pas
+
+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,107 @@
+# OV Chipkaart
+
+[![Coverage Status](https://coveralls.io/repos/JanDintel/ovchipkaart/badge.png)](https://coveralls.io/r/JanDintel/ovchipkaart)
+[![Build Status](https://travis-ci.org/JanDintel/ovchipkaart.png?branch=master)](https://travis-ci.org/JanDintel/ovchipkaart)
+
+An OV Chipkaart gem, which scrapes the OV Chipkaart website and provides an easy to use API.
+
+The OV Chipkaart is the Dutch national transportation card for public transport. The use and transactions are regulated by the TLS.
+
+
+## Installation
+
+The OV Chipkaart gem makes use of the [chromedriver](https://code.google.com/p/chromedriver/) in combination with [capybara](https://github.com/jnicklas/capybara) and [selenium](https://github.com/SeleniumHQ/selenium) under the hood.
+
+For users with homebrew:
+
+    $ brew install chromedriver
+
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'ovchipkaart'
+```
+
+You might need to update the chromedriver after you ran `bundle install`:
+
+    $ chromedriver-update
+    
+*Chromedriver update with thanks to [flavorjones/chromedriver-helper](https://github.com/flavorjones/chromedriver-helper) and [mars/chromedriver-helper](https://github.com/flavorjones/chromedriver-helper/pull/9).*
+
+## Configuration
+
+You need to provide your credentials from the OV Chipkaart website. You can use a hash or a YAML file:
+
+```ruby
+Ovchipkaart.configure({ username: 'foo', password: 'bar'})
+    
+Ovchipkaart.configure_with(path_to_yaml_file)
+Ovchipkaart.configure_with('config/credentials.yml')
+```
+
+*Don't forget to put this in your .gitignore*
+
+## Usage
+
+Because the TLS doesn't provide an API for the OV Chipkaart, it scrapes the website and downloads the transactions to the filesystem for parsing. Therefore some methods might feel slow.
+
+**Balance and timestamp**
+
+```ruby
+ov_chipkaart = Ovchipkaart::Api.new
+ov_chipkaart.balance         #=> € 45,30
+ov_chipkaart.last_updated    #=> (12-10-2013 20:57)
+```
+
+**Journeys and transactions**
+
+Every journey or transaction is a hash with ten keys: `datum`, `checkin`, `vertrek`, `checkuit`, `bestemming`, `bedrag`, `transactie`, `klasse`, `product` and `opmerkingen`.
+
+Based on the `transactie` key everything is sorted in six categories:
+
+```ruby
+ov_chipkaart = Ovchipkaart::Api.new
+```
+
+1. `ov_chipkaart.journeys` contains all the finish journeys.
+2. `ov_chipkaart.checkins` contains all the checkins, when the journey starts.
+3. `ov_chipkaart.forgotten_checkouts` contains all the journeys that started, but didn't end, because there was no `checkuit`. These can be used to claim your money back.
+4. `ov_chipkaart.additions` contains all the additions to the balance of the OV Chipkaart.
+5. `ov_chipkaart.products` contains all the additions of products to the OV Chipkaart, such as subscriptions and discounts.
+6. `ov_chipkaart.unclassified` contains everything that couldn't be specified.
+
+## Troubleshooting
+
+**Credentials**
+
+The OV Chipkaart gem needs your credentials to login on the OV Chipkaart website.
+
+If you have trouble configuring your credentials check the YAML for syntax errors and make sure that you only specify an `username` and `password`. Otherwise it will raise an error.
+
+**Chromedriver**
+
+Make sure you have installed the latest `chromedriver`. You can use homebrew to easily install the `chromedriver`. You might try running the `chromedriver-update` command, which downloads the helper for the `chromedriver` that is used by `selenium` with `capybara`.
+
+The OV Chipkaart gem current uses `chromedriver` version `2.8.241036`.
+
+**OV Chipkaart results**
+
+Since this gem relies on scraping the OV Chipkaart website, it might break during an update of the website. If you experience this issue either help out with a Pull request or send me a message.
+
+## Contributing
+
+**TODO/IDEAS:**
+
+1. Clean up the downloaded files if they are too old
+2. Add configuration option for the webdriver. (Firefox and PhantonJS)
+3. Add configuration option for the download path
+4. Encrypt the credentials and decrypt them in runtime with an OTP.
+
+**Pull requests:**
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/ovchipkaart.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'ovchipkaart/setup'
+require 'ovchipkaart/version'
+require 'ovchipkaart/scraper'
+require 'ovchipkaart/parser'
+require 'ovchipkaart/api'
+
+module Ovchipkaart
+  class OvchipkaartError < StandardError; end
+  class ConfigurationError < OvchipkaartError; end
+
+  # Configuration
+  MANDATORY_CONFIGURATION = { username: nil, password: nil }
+  CONFIGURATIONS_KEYS = MANDATORY_CONFIGURATION.merge!({})
+
+  # Global config hash
+  @config = {}
+  def self.config
+    @config
+  end
+
+  # Configuration with a hash
+  def self.configure(options = {})
+    MANDATORY_CONFIGURATION.each_key do |mandatory_option|
+      unless options.keys.map(&:to_sym).include?(mandatory_option)
+        raise ConfigurationError, 'Username and password are mandatory configuration options'
+      end
+    end
+
+    options.keys.map(&:to_sym).each do |given_configuration_key|
+      unless CONFIGURATIONS_KEYS.keys.include? given_configuration_key
+        raise ConfigurationError, 'Unknown configuration given'
+      end
+    end
+
+    options.each { |key, value| @config[key.to_sym] = value }
+  end
+
+  # Configuration with a YAML file
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      raise ConfigurationError, 'YAML configuration file not found'
+    rescue Psych::SyntaxError
+      raise ConfigurationError, 'YAML configuration file contains invalid syntax'
+    end
+
+    configure(config)
+  end
+end

data/lib/ovchipkaart/api.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+module Ovchipkaart
+  class Api
+    attr_reader :parser
+
+    def initialize
+      @parser = parse_transactions
+    end
+
+    def balance
+      balance_and_date[:balance]
+    end
+
+    def last_updated
+      balance_and_date[:date]
+    end
+
+    def journeys
+      parser.journeys
+    end
+
+    def checkins
+      parser.check_ins
+    end
+
+    def forgotten_checkouts
+      parser.forgotten_check_outs
+    end
+
+    def additions
+      parser.additions
+    end
+
+    def products
+      parser.products
+    end
+
+    def unclassified
+      parser.others
+    end
+
+    private
+
+    def balance_and_date
+      regex = scraper.balance.match(/(€.*)(\(.*\))/)
+      {balance: regex[1].strip, date: regex[2]}
+    end
+
+    def scraper
+      @scraper ||= Scraper.scrape
+    end
+
+    def parse_transactions
+      parser = Parser.new
+      parser.sort_csv_file
+      @parser ||= parser
+    end
+  end
+end

data/lib/ovchipkaart/parser.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+require 'csv'
+
+module Ovchipkaart
+  class Parser
+    attr_reader :journeys, :check_ins, :additions, :others, :products, :forgotten_check_outs
+
+    def initialize
+      @journeys   = []
+      @check_ins  = []
+      @additions  = []
+      @others     = []
+      @products   = []
+      @forgotten_check_outs = []
+    end
+
+    def self.process_transactions
+      new.sort_csv_file
+    end
+
+    def sort_csv_file
+      transactions_enum = transactions.each
+      begin
+        transaction = transactions_enum.next
+        case transaction[:transactie]
+        when "Reis"
+          journeys << transaction
+        when "Check-in"
+          if transactions_enum.peek[:transactie] == "Check-in"
+            forgotten_check_outs << transaction
+          else
+            check_ins << transaction
+          end
+        when "Saldo opgeladen"
+          additions << transaction
+        when "Product op kaart gezet"
+          products << transaction
+        else
+          others << transaction
+        end
+      rescue StopIteration
+        break
+      end while true
+    end
+
+    def parse_csv_file
+      CSV.new(csv_file, headers: true, header_converters: :symbol, col_sep: ';')
+    end
+
+    def csv_file
+      File.read last_downloaded_file
+    end
+
+    def last_downloaded_file
+      Dir['tmp/downloads/*'].sort_by{ |f| File.basename(f) }.first
+    end
+
+    private
+
+    def transactions
+      @transactions ||= parse_csv_file.to_a.map { |row| row.to_hash }
+    end
+  end
+end

data/lib/ovchipkaart/scraper.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+module Ovchipkaart
+  class Scraper
+    include Capybara::DSL
+
+    attr_reader :balance
+
+    def self.scrape
+      scraper = new
+      scraper.visit_ovchipkaart
+      scraper.login_user
+      scraper.visit_transaction_overview
+      scraper.select_transaction_period
+      scraper.checkbox_all_transactions
+      scraper.download_transaction_history
+      scraper.find_balance
+      scraper
+    end
+
+    def visit_ovchipkaart
+      visit('https://www.ov-chipkaart.nl/login/')
+      accept_cookies if need_to_accept_cookies?
+      self
+    end
+
+    def login_user
+      fill_in 'gebruikersnaam', with: Ovchipkaart.config[:username]
+      fill_in 'wachtwoord',     with: Ovchipkaart.config[:password]
+      click_button 'Inloggen'
+      self
+    end
+
+    def visit_transaction_overview
+      click_link 'Transactieoverzicht'
+      self
+    end
+
+    def select_transaction_period
+      select('2013', from: 'periodes')
+      click_button 'Transacties tonen'
+      self
+    end
+
+    def checkbox_all_transactions
+      check('transactiePanel:container:transacties.declareerAlles')
+      self
+    end
+
+    def download_transaction_history
+      click_link 'Opslaan als CSV'
+      self
+    end
+
+    def find_balance
+      @balance = all('span', text: /[€,\d]/)[5].text
+    end
+
+    private
+
+    def need_to_accept_cookies?
+      !find_link('Ik accepteer deze cookies').nil? rescue Capybara::ElementNotFound
+    end
+
+    def accept_cookies
+      click_on('Ik accepteer deze cookies') rescue Capybara::ElementNotFound
+    end
+  end
+end

data/lib/ovchipkaart/setup.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Ovchipkaart
+  module Setup
+    # YAML Configuration
+    require 'yaml'
+
+    # Capybara
+    require 'capybara'
+    require 'capybara/dsl'
+    require 'selenium/webdriver'
+
+    Capybara.register_driver :selenium_chrome do |app|
+      preferences = {"download" => {"default_directory" => Dir.getwd + '/tmp/downloads', "directory_upgrade" => true, "extensions_to_open" => ""}}
+      capabilities = Selenium::WebDriver::Remote::Capabilities.chrome
+      capabilities['chromeOptions'] = {'prefs' => preferences}
+      Capybara::Selenium::Driver.new(app, :detach => false, :browser => :chrome, :desired_capabilities => capabilities)
+    end
+
+    Capybara.default_driver = :selenium_chrome
+    Capybara.run_server = false
+  end
+end

data/lib/ovchipkaart/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Ovchipkaart
+  VERSION = '0.0.1'
+end

data/ovchipkaart.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ovchipkaart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ovchipkaart'
+  spec.version       = Ovchipkaart::VERSION
+  spec.authors       = ['Jan van der Pas']
+  spec.email         = ['janvanderpas@gmail.com']
+  spec.description   = "An unofficial OV Chipkaart gem, which scrapes the OV Chipkaart website (ov-chipkaart.nl) and provides an easy to use Ruby API."
+  spec.summary       = 'Unofficial Ruby OV Chipkaart API gem'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.requirements         << 'chromedriver, v2.8'
+  spec.post_install_message = "Make sure that the chromedriver is installed before using the ovchipkaart gem."
+
+  spec.add_runtime_dependency 'nokogiri',           '~> 1.6.0'
+  spec.add_runtime_dependency 'capybara',           '~> 2.2.0'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 2.38.0'
+
+  spec.add_development_dependency 'bundler',        '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/spec/factories/api_factory.rb

@@ -0,0 +1,33 @@
+module Factory
+
+  def self.journeys
+    [{:datum=>"13-12-2013", :checkin=>"", :vertrek=>"Grote Markt", :checkuit=>"19:57", :bestemming=>"Muurbloemweg", :bedrag=>"1,76", :transactie=>"Reis", :klasse=>"", :product=>"", :opmerkingen=>""},
+    {:datum=>"13-12-2013", :checkin=>"", :vertrek=>"Leiden Centraal", :checkuit=>"09:20", :bestemming=>"Haag HS (Den)", :bedrag=>"1,90", :transactie=>"Reis", :klasse=>"2", :product=>"Altijd Voordeel (maandabonnement)", :opmerkingen=>""},
+    {:datum=>"12-12-2013", :checkin=>"", :vertrek=>"Haag HS (Den)", :checkuit=>"18:30", :bestemming=>"Leiden Centraal", :bedrag=>"2,60", :transactie=>"Reis", :klasse=>"2", :product=>"Altijd Voordeel (maandabonnement)", :opmerkingen=>""},
+    {:datum=>"12-12-2013", :checkin=>"", :vertrek=>"Leiden Centraal", :checkuit=>"09:21", :bestemming=>"Haag HS (Den)", :bedrag=>"1,90", :transactie=>"Reis", :klasse=>"2", :product=>"Altijd Voordeel (maandabonnement)", :opmerkingen=>""}]
+  end
+
+  def self.checkins
+    [{:datum=>"13-12-2013", :checkin=>"19:38", :vertrek=>"Grote Markt", :checkuit=>"", :bestemming=>"", :bedrag=>"-4,00", :transactie=>"Check-in", :klasse=>"", :product=>"", :opmerkingen=>""},
+    {:datum=>"13-12-2013", :checkin=>"08:57", :vertrek=>"Leiden Centraal", :checkuit=>"", :bestemming=>"", :bedrag=>"-10,00", :transactie=>"Check-in", :klasse=>"", :product=>"", :opmerkingen=>""},
+    {:datum=>"12-12-2013", :checkin=>"18:10", :vertrek=>"Haag HS (Den)", :checkuit=>"", :bestemming=>"", :bedrag=>"-10,00", :transactie=>"Check-in", :klasse=>"", :product=>"", :opmerkingen=>""},
+    {:datum=>"12-12-2013", :checkin=>"08:55", :vertrek=>"Leiden Centraal", :checkuit=>"", :bestemming=>"", :bedrag=>"-10,00", :transactie=>"Check-in", :klasse=>"", :product=>"", :opmerkingen=>""},
+    {:datum=>"11-12-2013", :checkin=>"8:10", :vertrek=>"Leiden Centraal", :checkuit=>"", :bestemming=>"", :bedrag=>"-10,00", :transactie=>"Check-in", :klasse=>"", :product=>"", :opmerkingen=>""}]
+  end
+
+  def self.forgotten_checkouts
+    [{:datum=>"11-12-2013", :checkin=>"8:15", :vertrek=>"Den Haag Laan van NOI", :checkuit=>"", :bestemming=>"", :bedrag=>"-10,00", :transactie=>"Check-in", :klasse=>"", :product=>"", :opmerkingen=>""}]
+  end
+
+  def self.additions
+    [{:datum=>"12-12-2013", :checkin=>"08:52", :vertrek=>"", :checkuit=>"", :bestemming=>"", :bedrag=>"50,00", :transactie=>"Saldo opgeladen", :klasse=>"", :product=>"", :opmerkingen=>""}]
+  end
+
+  def self.products
+    [{:datum=>"10-12-2013", :checkin=>"8:00", :vertrek=>"", :checkuit=>"", :bestemming=>"", :bedrag=>"", :transactie=>"Product op kaart gezet", :klasse=>"2", :product=>"Altijd Voordeel (maandabonnement)", :opmerkingen=>""}]
+  end
+
+  def self.unclassified
+    [{:datum=>"9-12-2013", :checkin=>"7:00", :vertrek=>"", :checkuit=>"", :bestemming=>"", :bedrag=>"", :transactie=>"Foo", :klasse=>"", :product=>"", :opmerkingen=>""}]
+  end
+end

data/spec/factories/csv_factory.rb

@@ -0,0 +1,6 @@
+module Factory
+
+  def self.csv_file
+    File.read 'spec/fixtures/test_transaction_1.csv'
+  end
+end

data/spec/fixtures/invalid_configuration.yml

@@ -0,0 +1,2 @@
+foo
+  bar: baz

data/spec/fixtures/test_transaction_1.csv

@@ -0,0 +1,14 @@
+"Datum";"Check-in";"Vertrek";"Check-uit";"Bestemming";"Bedrag";"Transactie";"Klasse";"Product";"Opmerkingen"
+"13-12-2013";"";"Grote Markt";"19:57";"Muurbloemweg";"1,76";"Reis";"";"";""
+"13-12-2013";"19:38";"Grote Markt";"";"";"-4,00";"Check-in";"";"";""
+"13-12-2013";"";"Leiden Centraal";"09:20";"Haag HS (Den)";"1,90";"Reis";"2";"Altijd Voordeel (maandabonnement)";""
+"13-12-2013";"08:57";"Leiden Centraal";"";"";"-10,00";"Check-in";"";"";""
+"12-12-2013";"";"Haag HS (Den)";"18:30";"Leiden Centraal";"2,60";"Reis";"2";"Altijd Voordeel (maandabonnement)";""
+"12-12-2013";"18:10";"Haag HS (Den)";"";"";"-10,00";"Check-in";"";"";""
+"12-12-2013";"";"Leiden Centraal";"09:21";"Haag HS (Den)";"1,90";"Reis";"2";"Altijd Voordeel (maandabonnement)";""
+"12-12-2013";"08:55";"Leiden Centraal";"";"";"-10,00";"Check-in";"";"";""
+"12-12-2013";"08:52";"";"";"";"50,00";"Saldo opgeladen";"";"";""
+"11-12-2013";"8:15";"Den Haag Laan van NOI";"";"";"-10,00";"Check-in";"";"";""
+"11-12-2013";"8:10";"Leiden Centraal";"";"";"-10,00";"Check-in";"";"";""
+"10-12-2013";"8:00";"";"";"";"";"Product op kaart gezet";"2";"Altijd Voordeel (maandabonnement)";""
+"9-12-2013";"7:00";"";"";"";"";"Foo";"";"";""

data/spec/lib/ovchipkaart/api_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Ovchipkaart::Api do
+  let(:csv_file)            { Factory.csv_file }
+  let(:journeys)            { Factory.journeys }
+  let(:checkins)            { Factory.checkins }
+  let(:forgotten_checkouts) { Factory.forgotten_checkouts }
+  let(:additions)           { Factory.additions }
+  let(:products)            { Factory.products }
+  let(:unclassified)        { Factory.unclassified }
+
+  describe 'public API' do
+    before { Ovchipkaart::Parser.any_instance.stub(:csv_file).and_return csv_file }
+
+    specify { expect(subject.journeys).to             eql journeys }
+    specify { expect(subject.checkins).to             eql checkins }
+    specify { expect(subject.forgotten_checkouts).to  eql forgotten_checkouts }
+    specify { expect(subject.additions).to            eql additions }
+    specify { expect(subject.products).to             eql products }
+    specify { expect(subject.unclassified).to         eql unclassified }
+
+    context 'with web_driver', :web_driver do
+      before { Ovchipkaart::Scraper.any_instance.stub(:balance).and_return "€ 30,51 (19-12-2013 20:57)" }
+
+      specify { expect(subject.balance).to              eql '€ 30,51' }
+      specify { expect(subject.last_updated).to         eql '(19-12-2013 20:57)' }
+    end
+  end
+end

data/spec/lib/ovchipkaart/parser_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Ovchipkaart::Parser do
+  let(:csv_file)      { Factory.csv_file }
+  let(:csv_file_stub) { described_class.any_instance.stub(:csv_file).and_return csv_file }
+
+  describe '.process_transactions' do
+    it 'sorts the transactions' do
+      expect_any_instance_of(described_class).to receive :sort_csv_file
+      described_class.process_transactions
+    end
+  end
+
+  describe '#sort_csv_file' do
+    before  { csv_file_stub }
+    before  { subject.sort_csv_file }
+
+    specify { expect(subject.journeys.count).to       eql 4 }
+    specify { expect(subject.check_ins.count).to      eql 5 }
+    specify { expect(subject.additions.count).to      eql 1 }
+    specify { expect(subject.products.count).to       eql 1 }
+    specify { expect(subject.others.count).to         eql 1 }
+    specify {
+      expect(subject.forgotten_check_outs.count).to   eql 1 }
+  end
+
+  describe '#parse_csv_file' do
+    before  { csv_file_stub }
+
+    it 'parses the csv file' do
+      expect(CSV).to receive(:new).with(csv_file, { headers: true, header_converters: :symbol, col_sep: ";" })
+      subject.parse_csv_file
+    end
+  end
+
+  describe 'downloaded csv file' do
+    let(:tmp_dir)     { "#{Dir.getwd}/tmp/downloads"}
+    let(:file_1_path) { "#{tmp_dir}/transacties_-0001.csv" }
+    let(:file_2_path) { "#{tmp_dir}/transacties_-0002.csv" }
+
+    before do
+      FileUtils.mkdir_p tmp_dir
+      File.open(file_1_path, 'w+') { |file| file.write csv_file }
+      File.new file_2_path, 'w+'
+    end
+
+    after do
+      FileUtils.rm file_1_path
+      FileUtils.rm file_2_path
+    end
+
+    context '#csv_file' do
+      specify { expect(subject.csv_file).to eql csv_file }
+    end
+
+    context '#last_downloaded_file' do
+      it 'sorts the file on their basename and returns first one' do
+        expect(subject.last_downloaded_file).to eql 'tmp/downloads/transacties_-0001.csv'
+      end
+    end
+  end
+end

data/spec/lib/ovchipkaart/scraper_spec.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'capybara/rspec'
+
+# Methods in the Ovchipkaart::Scraper class are,
+# dependent on the order of calling them.
+RSpec.configure { |config| config.order = 'default' }
+
+describe Ovchipkaart::Scraper, :web_driver do
+
+  describe '.scrape' do
+    it 'scrapes the ovchipkaart website' do
+      expect_any_instance_of(described_class).to receive(:visit_ovchipkaart)
+      expect_any_instance_of(described_class).to receive(:login_user)
+      expect_any_instance_of(described_class).to receive(:visit_transaction_overview)
+      expect_any_instance_of(described_class).to receive(:select_transaction_period)
+      expect_any_instance_of(described_class).to receive(:checkbox_all_transactions)
+      expect_any_instance_of(described_class).to receive(:download_transaction_history)
+      expect_any_instance_of(described_class).to receive(:find_balance)
+      described_class.scrape
+    end
+  end
+
+  describe '#visit_ovchipkaart' do
+    it 'lands on the login page of ovchipkaart' do
+      expect(subject.visit_ovchipkaart).to have_content 'Inloggen op Mijn OV-chipkaart'
+    end
+  end
+
+  describe '#login_user' do
+    it 'fills out the user credentials and logs in' do
+      expect(subject.login_user).to have_content 'Transactieoverzicht'
+    end
+  end
+
+  describe '#visit_transaction_overview' do
+    it 'visits the transaction overview page' do
+      expect(subject.visit_transaction_overview).to have_content 'Mijn transactieoverzicht'
+    end
+  end
+
+  describe '#select_transaction_period' do
+    it 'changes the time period of the transaction history' do
+      expect(subject.select_transaction_period).to have_select('periodes', selected: '2013')
+    end
+  end
+
+  describe '#checkbox_all_transactions' do
+    it 'checks on all transactions' do
+      expect(subject.checkbox_all_transactions).to have_checked_field('transactiePanel:container:transacties.declareerAlles', checked: true)
+    end
+  end
+
+  describe '#download_transaction_history' do
+    let(:download_path) { Dir.getwd + '/tmp/downloads/*' }
+
+    it 'downloads the transaction history' do
+      # Give time to process download before calling downloads count again
+      expect{ subject.download_transaction_history; sleep 3 }.to change{ Dir[download_path].length }.by(1)
+    end
+  end
+
+  describe '#find_balance' do
+    before { subject.find_balance }
+
+    it 'scrapes the balance of the transaction overview page' do
+      expect(subject.balance).to match /(€+\s+\d*,+\d*)+\s*(\(\d*-\d*-\d*\s\d*:\d*\))/
+    end
+  end
+end

data/spec/lib/ovchipkaart_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Ovchipkaart do
+
+  describe 'configuration' do
+    context 'valid configuration' do
+      specify { expect{ subject.configure({ username: 'foo', password: 'bar' }) }.not_to raise_error }
+
+      it 'sets the configuration' do
+        subject.configure({ username: 'foo', password: 'bar' })
+        expect(subject.config[:username]).to eql 'foo'
+        expect(subject.config[:password]).to eql 'bar'
+      end
+    end
+
+    context 'mandatory configuration' do
+      specify { expect(subject.const_get :MANDATORY_CONFIGURATION).to eql({:username=>nil, :password=>nil}) }
+
+      it 'raises an Ovchipkaart::ConfigurationError without the mandatory configuration' do
+        expect{ subject.configure({ foo: 'bar' }) }.to raise_error Ovchipkaart::ConfigurationError, 'Username and password are mandatory configuration options'
+      end
+    end
+
+    context 'configuration keys' do
+      it 'raises an Ovchipkaart::ConfigurationError with invalid configuration keys' do
+        expect{ subject.configure({ username: 'foo', password: 'bar', baz: 'foobar' }) }.to raise_error Ovchipkaart::ConfigurationError, 'Unknown configuration given'
+      end
+    end
+
+    context 'YAML configuration' do
+      it 'raises an Ovchipkaart::ConfigurationError without a YAML file' do
+        expect{ subject.configure_with('') }.to raise_error Ovchipkaart::ConfigurationError, 'YAML configuration file not found'
+      end
+
+      it 'raises an Ovchipkaart::ConfigurationError with an invalid YAML file' do
+        expect{ subject.configure_with('spec/fixtures/invalid_configuration.yml') }.to raise_error Ovchipkaart::ConfigurationError, 'YAML configuration file contains invalid syntax'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+if ENV['TRAVIS_CI'].nil?
+  SimpleCov.start
+else
+  SimpleCov.start do
+    add_filter 'lib/ovchipkaart/scraper.rb'
+    add_filter 'spec/lib/ovchipkaart/scraper_spec.rb'
+  end
+end
+
+require 'ovchipkaart'
+
+# Add support files
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |file| require file }
+
+# Add factories
+Dir[File.join(File.dirname(__FILE__), "factories/**/*.rb")].each { |file| require file }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.order = 'random'
+end

data/spec/support/ovchipkaart_configuration_support.rb

@@ -0,0 +1 @@
+Ovchipkaart.configure_with('spec/support/credentials.yml') if ENV['TRAVIS_CI'].nil?

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: ovchipkaart
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan van der Pas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.38.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.38.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An unofficial OV Chipkaart gem, which scrapes the OV Chipkaart website
+  (ov-chipkaart.nl) and provides an easy to use Ruby API.
+email:
+- janvanderpas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ovchipkaart.rb
+- lib/ovchipkaart/api.rb
+- lib/ovchipkaart/parser.rb
+- lib/ovchipkaart/scraper.rb
+- lib/ovchipkaart/setup.rb
+- lib/ovchipkaart/version.rb
+- ovchipkaart.gemspec
+- spec/factories/api_factory.rb
+- spec/factories/csv_factory.rb
+- spec/fixtures/invalid_configuration.yml
+- spec/fixtures/test_transaction_1.csv
+- spec/lib/ovchipkaart/api_spec.rb
+- spec/lib/ovchipkaart/parser_spec.rb
+- spec/lib/ovchipkaart/scraper_spec.rb
+- spec/lib/ovchipkaart_spec.rb
+- spec/spec_helper.rb
+- spec/support/ovchipkaart_configuration_support.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: Make sure that the chromedriver is installed before using the
+  ovchipkaart gem.
+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:
+- chromedriver, v2.8
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby OV Chipkaart API gem
+test_files:
+- spec/factories/api_factory.rb
+- spec/factories/csv_factory.rb
+- spec/fixtures/invalid_configuration.yml
+- spec/fixtures/test_transaction_1.csv
+- spec/lib/ovchipkaart/api_spec.rb
+- spec/lib/ovchipkaart/parser_spec.rb
+- spec/lib/ovchipkaart/scraper_spec.rb
+- spec/lib/ovchipkaart_spec.rb
+- spec/spec_helper.rb
+- spec/support/ovchipkaart_configuration_support.rb