cycle_hire 1.0.0

data/README.md

@@ -0,0 +1,72 @@
+# Cycle Hire
+
+Cycle Hire is a Ruby API for the Barclays Cycle Hire scheme in London. It primarily works by scraping the TfL website.
+
+It provides access to the following data:
+
+* User journey history
+* Docking station status
+
+## Requirements
+
+Ruby 1.9 and Bundler. (It'll probably work on Ruby 1.8 but is untested)
+
+Bundler installs:
+
+* Nokogiri
+* HTTParty
+
+## Installation
+
+    gem install cycle-hire
+
+Or, add this to your Gemfile:
+
+    gem 'cycle-hire'
+
+## Usage (binaries)
+
+### Fetch journey history
+
+    ./bin/cycle_hire_history <email> <password>
+
+Where the access credentials are your login to the cycle hire section of the TfL website. Outputs the data in YAML format.
+
+### Fetch docking station status
+
+    ./bin/cycle_hire_status <station>
+
+Where station is a regex of stations you want to match. Outputs the data in YAML format.
+
+## Usage (in your code)
+
+### Fetch journey history
+
+      session = CycleHire.authenticate email, password
+      # raises CycleHire::Session::AuthenticationError if
+      # the email or password and incorrect
+
+      journeys = session.journeys
+      # array of the users journeys
+
+### Fetch docking station status
+
+      stations = CycleHire.stations
+      # array of stations, see CycleHire::Station
+      # for more details
+
+## Todo
+
+* Tests
+* Access to more user account data (e.g. balance, membership expiry)
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Send me a pull request. Bonus points for topic branches.
+* Add tests for what you are building, and make sure you don't break any existing tests.
+
+## License
+
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/InteractiveResource" property="dct:title" rel="dct:type">cycle-hire</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/lucaspiller/cycle-hire" property="cc:attributionName" rel="cc:attributionURL">Luca Spiller</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/lucaspiller/cycle-hire" rel="dct:source">github.com</a>.<br />Permissions beyond the scope of this license may be available at <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/lucaspiller/cycle-hire" rel="cc:morePermissions">https://github.com/lucaspiller/cycle-hire</a>.

data/bin/cycle_hire_history

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+
+require 'cycle_hire'
+
+unless ARGV.size == 2
+  abort "Usage: #{$0} username password"
+end
+
+begin
+  session = CycleHire.authenticate ARGV[0], ARGV[1]
+  session.journeys.each do |journey|
+    puts journey.to_h.to_yaml
+  end
+rescue CycleHire::Session::AuthenticationError
+  abort "Invalid username and password"
+end

data/bin/cycle_hire_status

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+
+require 'cycle_hire'
+require 'yaml'
+
+unless ARGV.size == 1
+  abort "Usage: #{$0} station_regex"
+end
+
+stations = CycleHire.stations
+stations.each do |station|
+  if station.name =~ /#{ARGV[0]}/i
+    puts station.to_h.to_yaml
+  end
+end

data/lib/cycle_hire/journey.rb

@@ -0,0 +1,26 @@
+class CycleHire::Journey
+  attr_reader :start_time, :start_station, :end_time, :end_station, :cost
+
+  def initialize(start_time, start_station, end_time, end_station, cost)
+    @start_time = start_time
+    @start_station = start_station
+    @end_time = end_time
+    @end_station = end_station
+    @cost = cost
+  end
+
+  def duration
+    ((@end_time - @start_time) / 60).to_i
+  end
+
+  def to_h
+    {
+      :start_time => @start_time,
+      :start_station => @start_station.to_s,
+      :end_time => @end_time,
+      :end_station => @end_station.to_s,
+      :cost => @cost,
+      :duration => duration
+    }
+  end
+end

data/lib/cycle_hire/journey_parser.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'nokogiri'
+
+class CycleHire::JourneyParser
+  def initialize(data)
+    @data = data
+  end
+
+  def parse
+    rows = rows_from_data(@data)
+    rows.collect do |row|
+      columns = column_data_for_row(row)
+
+      # ignore the header and other column types
+      if columns[4] == 'Hire'
+        start_time = parse_time(columns[0])
+        end_time = parse_time(columns[1])
+        cost = parse_cost(columns[5])
+        CycleHire::Journey.new(start_time, columns[2], end_time, columns[3], cost)
+      else
+        nil
+      end
+    end.compact
+  end
+
+  protected
+
+  def rows_from_data(data)
+    doc = Nokogiri::HTML(data)
+    rows = doc.xpath("//table[@summary='My Account - Activity log']/tbody/tr")
+  end
+
+  def column_data_for_row(row)
+    row.xpath('td').collect do |column|
+      column.inner_text.strip
+    end
+  end
+
+  # the data in the tables is seperated by a br, which the inner_text
+  # method strips, as such dates come in as "11 Oct 201109:15"
+  def parse_time(string)
+    if string =~ /(.*)([0-9]{2}:[0-9]{2})/
+      Time.parse($1 + " " + $2 + " London")
+    end
+  end
+
+  def parse_cost(string)
+    if string =~ /£([0-9]+\.[0-9]{2})/
+      $1.to_f
+    end
+  end
+end

data/lib/cycle_hire/session.rb

@@ -0,0 +1,64 @@
+require 'httparty'
+require 'nokogiri'
+
+class CycleHire::Session
+  include HTTParty
+
+  base_uri 'https://web.barclayscyclehire.tfl.gov.uk/'
+
+  def initialize(email, password)
+    @email = email
+    @password = password
+  end
+
+  def authenticate!
+    # initial request to get csrf
+    csrf_response = make_request(:get, '/')
+    doc = Nokogiri::HTML(csrf_response.body)
+    csrf = doc.xpath("//input[@id='login__csrf_token']").first.attribute('value').value
+
+    # authentication request
+    options = {
+      :query => {
+        'login[Email]' => @email,
+        'login[Password]' => @password,
+        'login[_csrf_token]' => csrf
+      },
+      :headers => {
+        'Content-Type' => 'application/x-www-form-urlencoded',
+      }
+    }
+    authentication_response = make_request(:post, '/', options)
+    raise AuthenticationError unless authentication_response.body =~ /Account Summary/
+    self
+  end
+
+  def journeys
+    response = make_request(:get, '/account/activity')
+    parser = CycleHire::JourneyParser.new(response.body)
+    parser.parse
+  end
+
+  class AuthenticationError < Exception
+  end
+
+  protected
+
+  def make_request(method, path, options = {})
+    options[:headers] ||= {}
+    options[:headers]['Cookie'] = @cookies if @cookies
+    response = self.class.send(method, path, options)
+    set_cookies_from_response(response)
+    response
+  end
+
+  def set_cookies_from_response(httparty_response)
+    # TODO there must be a better way to do this
+    headers = httparty_response.response.to_hash
+    if headers['set-cookie']
+      @cookies = headers['set-cookie'].map do |cookie|
+        cookie.split(';').first
+      end.join('; ')
+    end
+  end
+end

data/lib/cycle_hire/station.rb

@@ -0,0 +1,45 @@
+class CycleHire::Station
+  attr_reader :name, :area, :id, :latitude, :longitude, :bikes, :empty_docks, :installed, :locked, :temporary, :timestamp
+
+  def initialize(name)
+    parse_name!(name)
+  end
+
+  def initialize(name, id, latitude, longitude, bikes, empty_docks, installed, locked, temporary, timestamp)
+    parse_name!(name)
+    @id = id
+    @latitude = latitude
+    @longitude = longitude
+
+    @bikes = bikes
+    @empty_docks = empty_docks
+
+    @installed = installed
+    @locked = locked
+    @temporary = temporary
+    @timestamp = timestamp
+  end
+
+  def to_h
+    {
+      :id => @id,
+      :name => @name,
+      :area => @area,
+      :latitude => @latitude,
+      :longitude => @longitude,
+      :bikes => @bikes,
+      :empty_docks => @empty_docks,
+      :installed => @installed,
+      :locked => @locked,
+      :temporary => @temporary,
+      :timestamp => @timestamp
+    }
+  end
+
+  protected
+
+  def parse_name!(name)
+    @name = (name.split(',').first || '').strip
+    @area = (name.split(',').last || '').strip
+  end
+end

data/lib/cycle_hire/station_parser.rb

@@ -0,0 +1,48 @@
+require 'open-uri'
+
+class CycleHire::StationParser
+  STATION_REGEX = /\{id:"(\d+)".+?name:"(.+?)".+?lat:"(.+?)".+?long:"(.+?)".+?nbBikes:"(\d+)".+?nbEmptyDocks:"(\d+)".+?installed:"(.+?)".+?locked:"(.+?)".+?temporary:"(.+?)"\}/
+  TIME_REGEX = /var hour='(\d\d:\d\d)'/
+  ENDPOINT = "https://web.barclayscyclehire.tfl.gov.uk/maps"
+
+  def self.get_stations
+    data = open(ENDPOINT).read
+    parser = self.new data
+    parser.parse
+  end
+
+  def initialize(data)
+    @data = data
+  end
+
+  def parse
+    @data.scan(STATION_REGEX).map do |station|
+      parse_station(station)
+    end
+  end
+
+  def timestamp
+    @timestamp ||= Time.parse(TIME_REGEX.match(@data).to_s)
+  end
+
+  protected
+
+  def parse_station(st)
+    installed = (st[6] == 'true')
+    locked = (st[7] == 'true')
+    temporary = (st[8] == 'true')
+
+    CycleHire::Station.new(
+      st[1],
+      st[0],
+      st[2].to_f,
+      st[3].to_f,
+      st[4].to_i,
+      st[5].to_i,
+      installed,
+      locked,
+      temporary,
+      timestamp
+    )
+  end
+end

data/lib/cycle_hire.rb

@@ -0,0 +1,20 @@
+module CycleHire
+  ROOT = File.expand_path(File.dirname(__FILE__))
+  VERSION = '1.0.0'
+
+  autoload :Session, "#{ROOT}/cycle_hire/session"
+  autoload :JourneyParser, "#{ROOT}/cycle_hire/journey_parser"
+  autoload :Journey, "#{ROOT}/cycle_hire/journey"
+  autoload :StationParser, "#{ROOT}/cycle_hire/station_parser"
+  autoload :Station, "#{ROOT}/cycle_hire/station"
+
+  # raises CycleHire::Session::AuthenticationError
+  def self.authenticate(email, password)
+    session = Session.new email, password
+    session.authenticate!
+  end
+
+  def self.stations
+    StationParser.get_stations
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: cycle_hire
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Luca Spiller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70304140311480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70304140311480
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70304140310540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70304140310540
+description: cycle_hire gem
+email: luca@stackednotion.com
+executables:
+- cycle_hire_history
+- cycle_hire_status
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/cycle_hire/journey.rb
+- lib/cycle_hire/journey_parser.rb
+- lib/cycle_hire/session.rb
+- lib/cycle_hire/station.rb
+- lib/cycle_hire/station_parser.rb
+- lib/cycle_hire.rb
+- bin/cycle_hire_history
+- bin/cycle_hire_status
+homepage: http://github.com/lucaspiller/cycle-hire
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Ruby API for the Barclays Cycle Hire scheme in London
+test_files: []