blabla_client 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jeanbaptistevilain
+
+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,29 @@
+# BlablaClient
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blabla_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blabla_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.pattern = '**/*_test.rb'
+end

data/blabla_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blabla_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blabla_client"
+  spec.version       = BlablaClient::VERSION
+  spec.authors       = ["jeanbaptistevilain"]
+  spec.email         = ["jbvilain@gmail.com"]
+  spec.description   = "A simple client for the BlaBlaCar API (valid credentials required)"
+  spec.summary       = "A simple client for the BlaBlaCar API (valid credentials required)"
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "shoulda"
+  spec.add_runtime_dependency "oauth2"
+  spec.add_runtime_dependency "json"
+end

data/lib/blabla_client/attribute_helper.rb

@@ -0,0 +1,11 @@
+module AttributeHelper
+  def attributes=(hash)
+    hash.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end
+  end
+
+  def attributes
+    Hash[instance_variables.map { |name| [name.to_s[1..-1], instance_variable_get(name)] }]
+  end
+end

data/lib/blabla_client/trip.rb

@@ -0,0 +1,81 @@
+require 'json'
+require 'blabla_client/attribute_helper'
+
+class Trip
+
+  include AttributeHelper
+
+  WHITELISTED_ATTRS = [:departure_date, :departure_place, :arrival_place, :price, :seats_left, :duration, :distance, :car, :links]
+
+  attr_reader *WHITELISTED_ATTRS
+
+  def initialize(hash)
+    self.attributes = hash.keep_if {|k,v| WHITELISTED_ATTRS.include?(k)}
+  end
+
+  def self.parse_response(json_response)
+    response = {}
+    response_hash = JSON.parse json_response, :symbolize_names => true
+    unless response_hash[:trips].nil?
+      response[:trips] = response_hash[:trips].collect {|t| Trip.new(t)}
+    end
+    unless response_hash[:pager].nil?
+      response[:page] = response_hash[:pager][:page]
+      response[:pages] = response_hash[:pager][:pages]
+      response[:count] = response_hash[:pager][:total]
+    end
+    response
+  end
+
+  def get_url
+    links[:_front]
+  end
+
+  def get_price
+    {:value => price[:value], :currency => price[:symbol], :color => price[:price_color].downcase}
+  end
+
+  def get_departure_date
+    departure_fields = departure_date.split(' ')
+    date_fields = departure_fields[0].split('/')
+    time_fields = departure_fields[1].split(':')
+    Time.new(date_fields[2].to_i, date_fields[1].to_i, date_fields[0].to_i, time_fields[0].to_i, time_fields[1].to_i, time_fields[2].to_i)
+  end
+
+  def get_departure_place
+    full_address = departure_place[:address]
+    full_address += ", #{departure_place[:city_name]}" unless departure_place[:address].include?(departure_place[:city_name])
+    full_address
+  end
+
+  def get_arrival_place
+    full_address = arrival_place[:address]
+    full_address += ", #{arrival_place[:city_name]}" unless arrival_place[:address].include?(arrival_place[:city_name])
+    full_address
+  end
+
+  def get_duration
+    duration_hash = {}
+    unless duration.nil? || duration.empty?
+      if duration[:unity] == 's'
+        duration_hash[:hours] = (duration[:value].to_f/3600).floor
+        duration_hash[:minutes] = ((duration[:value] - duration_hash[:hours]*3600).to_f/60).floor
+      end
+    end
+    duration_hash
+  end
+
+  def get_distance
+    distance[:value] unless distance.nil?
+  end
+
+  def get_car
+    car_hash = {}
+    unless car.nil? || car.empty?
+      car_hash[:model] = car[:make]
+      car_hash[:model] += " #{car[:model]}" unless car[:model].nil?
+      car_hash[:comfort] = car[:comfort_nb_star]
+    end
+    car_hash
+  end
+end

data/lib/blabla_client/version.rb

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

data/lib/blabla_client.rb

@@ -0,0 +1,79 @@
+require 'oauth2'
+require 'blabla_client/version'
+require 'blabla_client/trip'
+
+module BlablaClient
+
+  # Note : token expiration is ignored for now (current token expires on 15/03/2015)
+  CURRENT_TOKEN = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0MjY0MjY5NTUsImNsaWVudCI6ImE3NzM3ODdhNmI2YjM0NzlhMjk5NTg0MDUwMmUwNDZkNGE0NDNjYmE2MDFjMDk2Y2U1NGI4OTcyYjRkZTdjNzkiLCJzY29wZSI6IiIsInVzZXIiOm51bGx9.dOZF0wbZtW6_Vfa5dU6_X831yGCJlsSZE7gkdp2lldg'
+
+  # token "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0MjY0MjY5NTUsImNsaWVudCI6ImE3NzM3ODdhNmI2YjM0NzlhMjk5NTg0MDUwMmUwNDZkNGE0NDNjYmE2MDFjMDk2Y2U1NGI4OTcyYjRkZTdjNzkiLCJzY29wZSI6IiIsInVzZXIiOm51bGx9.dOZF0wbZtW6_Vfa5dU6_X831yGCJlsSZE7gkdp2lldg"
+  # expires_at : 1426426958
+  # expires_in : 2419200
+
+  # Configuration defaults (as of API v3)
+  @config = {
+      :auth_site => 'http://www.blablacar.fr',
+      :token_path => '/oauth/v2/access_token',
+      :client_id => '',
+      :client_secret => '',
+      :api_url => 'http://api.blablacar.fr/api/v2/trips'
+  }
+
+  @valid_config_keys = @config.keys
+  @logger = Logger.new(STDOUT)
+
+  # Configure through hash
+  def self.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.available_trips(departure, arrival, date_range_start, date_range_end, page = 1)
+    trips = []
+    range_start = normalize_date(date_range_start)
+    range_end = normalize_date(date_range_end)
+    begin
+      response = get_response(departure, arrival, range_start, range_end, page)
+      trips = Trip.parse_response(response.body)
+      @logger.info("Retrieved #{trips[:trips].length} trips for page #{page} of request #{departure}-#{arrival} from #{range_start} to #{range_end}")
+    rescue OAuth2::Error => e
+      @logger.error("An error occurred while calling the API on #{@config[:api_url]}")
+      @logger.error("Response : #{e.response}")
+      @logger.error("Code : #{e.code}")
+      @logger.error("Description : #{e.description}")
+    end
+    trips
+  end
+
+  def self.normalize_date(date)
+    if date.is_a?(Date) || date.is_a?(DateTime) || date.is_a?(Time)
+      date_as_object = date
+    else
+      date_as_object = Date.parse(date)
+    end
+    date_as_object.strftime('%d-%m-%Y')
+  end
+
+  private
+
+  def self.get_response(departure, arrival, date_range_start, date_range_end, page)
+    client = OAuth2::Client.new(@config[:client_id], @config[:client_secret], :site => @config[:auth_site], :token_url => @config[:token_path])
+    # token = client.client_credentials.get_token
+    token = OAuth2::AccessToken.new(client, CURRENT_TOKEN, :mode => :query)
+    token.get(@config[:api_url],
+              :params => {
+                             :_format => 'json',
+                             :fn => departure,
+                             :tn => arrival,
+                             :db => date_range_start,
+                             :de => date_range_end,
+                             :seats => '1',
+                             :page => page
+                         }
+    )
+  end
+end

data/test/blabla_client/trip_test.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+require 'rubygems'
+gem 'shoulda'
+require 'test/unit'
+require 'shoulda'
+require 'blabla_client/trip'
+
+class TripTest < Test::Unit::TestCase
+
+  RESPONSE_BODY =
+      '{"links":{"_self":"http://api.blablacar.fr/api/v2/trips"},"pager":{"page":1,"pages":68,"total":674,"limit":10},' +
+      '"trips":[' +
+      '{"links":{"_self":"http://api.blablacar.fr/api/v2/trips/95946679-lyon-grenoble","_front":"http://www.covoiturage.fr/trajet-lyon-grenoble-95946679","_threads":"http://api.blablacar.fr/api/v2/trips/95946679-lyon-grenoble/threads"},"frequency":"UNIQUE","departure_date":"15/02/2015 15:15:00","departure_place":{"city_name":"Lyon","address":"Lyon","latitude":45.764043,"longitude":4.835659},"arrival_place":{"city_name":"Grenoble","address":"Grenoble","latitude":45.188529,"longitude":5.724524},"price":{"value":7,"currency":"EUR","symbol":"\u20ac","string_value":"7\u00a0\u20ac","price_color":"GREEN"},"seats_left":0,"seats":2,"duration":{"value":3600,"unity":"s"},"distance":{"value":111,"unity":"km"},"permanent_id":"95946679-lyon-grenoble","car":{"model":"SCENIC III","make":"RENAULT","comfort":"Confort","comfort_nb_star":3},"viaggio_rosa":false,"freeway":true,"answer_delay":3,"booking_mode":"manual","booking_type":"online"},' +
+      '{"links":{"_self":"http://api.blablacar.fr/api/v2/trips/98529037-lyon-grenoble","_front":"http://www.covoiturage.fr/trajet-lyon-grenoble-98529037","_threads":"http://api.blablacar.fr/api/v2/trips/98529037-lyon-grenoble/threads"},"frequency":"UNIQUE","departure_date":"15/02/2015 15:20:00","departure_place":{"city_name":"Lyon","address":"Lyon","latitude":45.7640299,"longitude":4.8350211},"arrival_place":{"city_name":"Grenoble","address":"Grenoble","latitude":45.188529,"longitude":5.724524},"price":{"value":7,"currency":"EUR","symbol":"\u20ac","string_value":"7\u00a0\u20ac","price_color":"GREEN"},"seats_left":1,"seats":3,"duration":{"value":4800,"unity":"s"},"distance":{"value":111,"unity":"km"},"permanent_id":"98529037-lyon-grenoble","car":{"model":"PASSAT","make":"VOLKSWAGEN","comfort":"Confort","comfort_nb_star":3},"viaggio_rosa":false,"freeway":true,"answer_delay":1,"booking_mode":"manual","booking_type":"online"},' +
+      '{"links":{"_self":"http://api.blablacar.fr/api/v2/trips/97965469-lyon-grenoble","_front":"http://www.covoiturage.fr/trajet-lyon-grenoble-97965469","_threads":"http://api.blablacar.fr/api/v2/trips/97965469-lyon-grenoble/threads"},"frequency":"UNIQUE","departure_date":"15/02/2015 15:30:00","departure_place":{"city_name":"Lyon","address":"Place Jean Jaur\u00e8s, Lyon","latitude":45.7390393,"longitude":4.8395687},"arrival_place":{"city_name":"Grenoble","address":"Grenoble","latitude":45.188529,"longitude":5.724524},"price":{"value":5,"currency":"EUR","symbol":"\u20ac","string_value":"5\u00a0\u20ac","price_color":"GREEN"},"seats_left":2,"seats":4,"duration":{"value":6000,"unity":"s"},"distance":{"value":105,"unity":"km"},"permanent_id":"97965469-lyon-grenoble","car":{"model":"206","make":"PEUGEOT","comfort":"Normal","comfort_nb_star":2},"viaggio_rosa":false,"freeway":true,"answer_delay":6,"booking_mode":"manual","booking_type":"online"}' +
+      ']}'
+
+  should 'populate trips objects with the parsed json response' do
+    trips = Trip.parse_response(RESPONSE_BODY)[:trips]
+
+    assert_equal 3, trips.length
+    assert_equal ['15/02/2015 15:15:00', '15/02/2015 15:20:00', '15/02/2015 15:30:00'], trips.collect {|t| t.departure_date}
+    assert_equal [{:value => 7, :currency => '€', :color => 'green'}, {:value => 7, :currency => '€', :color => 'green'},
+                  {:value => 5, :currency => '€', :color => 'green'}], trips.collect {|t| t.get_price}
+    assert_equal ['Lyon', 'Lyon', 'Place Jean Jaurès, Lyon'], trips.collect {|t| t.get_departure_place}
+    assert_equal ['Grenoble', 'Grenoble', 'Grenoble'], trips.collect {|t| t.get_arrival_place}
+    assert_equal [0, 1, 2], trips.collect {|t| t.seats_left}
+    assert_equal [{:hours => 1, :minutes => 0}, {:hours => 1, :minutes => 20}, {:hours => 1, :minutes => 40}], trips.collect {|t| t.get_duration}
+    assert_equal [111, 111, 105], trips.collect {|t| t.get_distance}
+  end
+
+  should 'return departure date as a time object' do
+    assert_equal Time.new(2015, 2, 15, 15, 15, 0), Trip.new({:departure_date => '15/02/2015 15:15:00'}).get_departure_date
+  end
+
+  should 'return the trip url' do
+    assert_equal 'http://www.covoiturage.fr/trajet-lyon-grenoble-95946679', Trip.new({:links => {:_front => 'http://www.covoiturage.fr/trajet-lyon-grenoble-95946679'}}).get_url
+  end
+
+  should 'return paging fields included in the response' do
+    response = Trip.parse_response(RESPONSE_BODY)
+
+    assert_equal 1, response[:page]
+    assert_equal 68, response[:pages]
+    assert_equal 674, response[:count]
+  end
+
+  should 'return a trip duration hash' do
+    assert_equal({:hours => 1, :minutes => 0}, Trip.new({:duration => {:value => 3600, :unity => 's'}}).get_duration)
+    assert_equal({:hours => 2, :minutes => 0}, Trip.new({:duration => {:value => 7200, :unity => 's'}}).get_duration)
+    assert_equal({:hours => 1, :minutes => 30}, Trip.new({:duration => {:value => 5400, :unity => 's'}}).get_duration)
+    assert_equal({:hours => 0, :minutes => 40}, Trip.new({:duration => {:value => 2400, :unity => 's'}}).get_duration)
+    assert_equal({:hours => 0, :minutes => 45}, Trip.new({:duration => {:value => 2710, :unity => 's'}}).get_duration)
+    assert_equal({:hours => 1, :minutes => 0}, Trip.new({:duration => {:value => 3620, :unity => 's'}}).get_duration)
+  end
+
+  should 'return a data hash with the car information' do
+    assert_equal({:model => 'RENAULT SCENIC III', :comfort => 3},
+                 Trip.new({:car => {:model => 'SCENIC III', :make => 'RENAULT', :comfort => 'Confort', :comfort_nb_star => 3}}).get_car)
+  end
+end
+

data/test/blabla_client_test.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+gem 'shoulda'
+require 'test/unit'
+require 'shoulda'
+require 'blabla_client'
+
+class BlablaClientTest < Test::Unit::TestCase
+
+  # should 'test a real call to the trips API' do
+  #   response = BlablaClient.available_trips('lyon', 'grenoble', Date.today, Date.today)
+  #   assert_not_nil response
+  #   assert_not_empty response[:trips]
+  #   assert_equal 1, response[:page]
+  # end
+
+  should 'normalize input dates' do
+    assert_equal '17-10-2015', BlablaClient.normalize_date('2015-10-17')
+    assert_equal '17-10-2015', BlablaClient.normalize_date('17-10-2015')
+    assert_equal '17-10-2015', BlablaClient.normalize_date('20151017')
+    assert_equal '17-10-2015', BlablaClient.normalize_date(Date.new(2015, 10, 17))
+    assert_equal '17-10-2015', BlablaClient.normalize_date(DateTime.new(2015, 10, 17))
+    assert_equal '17-10-2015', BlablaClient.normalize_date(Time.new(2015, 10, 17))
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: blabla_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- jeanbaptistevilain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple client for the BlaBlaCar API (valid credentials required)
+email:
+- jbvilain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blabla_client.gemspec
+- lib/blabla_client.rb
+- lib/blabla_client/attribute_helper.rb
+- lib/blabla_client/trip.rb
+- lib/blabla_client/version.rb
+- test/blabla_client/trip_test.rb
+- test/blabla_client_test.rb
+homepage: ''
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: A simple client for the BlaBlaCar API (valid credentials required)
+test_files:
+- test/blabla_client/trip_test.rb
+- test/blabla_client_test.rb