ruby-irail 0.1.0

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/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    ruby-irail (0.1.0)
+      httparty
+      nokogiri
+      virtus
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    backports (2.6.1)
+    diff-lcs (1.1.3)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    nokogiri (1.5.5)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    virtus (0.5.1)
+      backports (~> 2.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  ruby-irail!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marc Lainez
+
+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,49 @@
+# Ruby::Irail
+
+IRail makes Belgian railway schedule easily available for anyone.
+
+There are already several wrappers available in different languages. This is a Ruby wrapper for their API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-irail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-irail
+
+## Usage
+
+```ruby
+# get a list of all belgian train stations
+
+require "ruby-irail"
+irail = IRail::API.new
+irail.stations
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Running the tests
+
+All tests are in the specs folder. To run them simply run the following from the root folder of your fork:
+
+```ruby
+rspec specs
+```
+
+### Contributors
+
+Marc Lainez (@mlainez)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ruby-irail/api.rb

@@ -0,0 +1,25 @@
+API_URL      = "http://api.irail.be"
+STATIONS_URI = "stations/"
+
+module IRail
+  class API
+    def stations
+      @stations ||= get_stations
+    end
+
+    def get_stations
+      station_list_url = build_station_list_url
+      xml_station_list = get_station_list(station_list_url)
+      IRail::DocumentParser.parse_stations(xml_station_list)
+    end
+
+    def get_station_list(station_list_url)
+      IRail::Request.get(station_list_url)
+    end
+
+    private
+    def build_station_list_url
+      [API_URL, STATIONS_URI].join('/')
+    end
+  end
+end

data/lib/ruby-irail/http/request.rb

@@ -0,0 +1,8 @@
+module IRail
+  module Request
+    def self.get(url)
+      request = HTTParty.get(url)
+      request.response.body
+    end
+  end
+end

data/lib/ruby-irail/models/station.rb

@@ -0,0 +1,13 @@
+require "virtus"
+
+module IRail
+  class Station
+    include Virtus
+
+    attribute :id, String
+    attribute :latitude, Float
+    attribute :longitude, Float
+    attribute :standard_name, String
+    attribute :name, String
+  end
+end

data/lib/ruby-irail/parser/document_parser.rb

@@ -0,0 +1,14 @@
+module IRail
+  class DocumentParser
+    STATION_XPATH = "//station"
+
+    def self.parse_stations(xml_string)
+      xml_payload  = Nokogiri::XML(xml_string)
+      xml_stations = xml_payload.xpath(STATION_XPATH)
+      xml_stations.inject([]) do |stations, xml_station|
+        attributes = StationParser.parse(xml_station)
+        stations << Station.new(attributes)
+      end
+    end
+  end
+end

data/lib/ruby-irail/parser/station_parser.rb

@@ -0,0 +1,33 @@
+module IRail
+  class StationParser
+    def self.parse(xml_payload)
+      id            = parse_station_id(xml_payload)
+      latitude      = parse_station_latitude(xml_payload)
+      longitude     = parse_station_longitude(xml_payload)
+      standard_name = parse_station_standard_name(xml_payload)
+      name          = parse_station_name(xml_payload)
+      {:id => id, :latitude => latitude, :longitude => longitude,
+       :standard_name => standard_name, :name => name}
+    end
+
+    def self.parse_station_id(xml_payload)
+      xml_payload.attr('id')
+    end
+
+    def self.parse_station_latitude(xml_payload)
+      xml_payload.attr('locationX')
+    end
+
+    def self.parse_station_longitude(xml_payload)
+      xml_payload.attr('locationY')
+    end
+
+    def self.parse_station_standard_name(xml_payload)
+      xml_payload.attr('standardname')
+    end
+
+    def self.parse_station_name(xml_payload)
+      xml_payload.content
+    end
+  end
+end

data/lib/ruby-irail.rb

@@ -0,0 +1,11 @@
+require "httparty"
+require "nokogiri"
+
+require File.join(File.dirname(__FILE__), 'ruby-irail', 'api')
+require File.join(File.dirname(__FILE__), 'ruby-irail', 'http', 'request')
+require File.join(File.dirname(__FILE__), 'ruby-irail', 'models', 'station')
+require File.join(File.dirname(__FILE__), 'ruby-irail', 'parser', 'document_parser')
+require File.join(File.dirname(__FILE__), 'ruby-irail', 'parser', 'station_parser')
+
+module IRail
+end

data/lib/version.rb

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

data/ruby-irail.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marc Lainez"]
+  gem.email         = ["ml@theotherguys.be"]
+  gem.description   = %q{IRail makes Belgian railway schedule easily available for anyone. This is a Ruby wrapper for their API.}
+  gem.summary       = %q{Ruby Irail is a wrapper around IRail API.}
+  gem.homepage      = "https://github.com/mlainez/ruby-irail"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = "ruby-irail"
+  gem.require_paths = ["lib"]
+  gem.version       = IRail::VERSION
+  gem.add_development_dependency "rspec"
+  gem.add_dependency "httparty"
+  gem.add_dependency "virtus"
+  gem.add_dependency "nokogiri"
+end

data/spec/http/request_spec.rb

@@ -0,0 +1,33 @@
+require_relative "../../lib/ruby-irail/http/request.rb"
+
+describe IRail::Request do
+  class HTTParty
+  end
+
+  describe :'self.get' do
+    let(:url)      { mock("Url") }
+    let(:request)  { mock("Request") }
+    let(:response) { mock("Response") }
+    let(:body)     { mock("Body") }
+
+    before :each do
+      HTTParty.stub(:get => request)
+      request.stub(:response => response)
+      response.stub(:body => body)
+    end
+
+    it "calls the get method of HTTParty with the url as param" do
+      HTTParty.should_receive(:get).with(url)
+      IRail::Request.get(url)
+    end
+
+    it "gets the body from the response" do
+      response.should_receive(:body)
+      IRail::Request.get(url)
+    end
+
+    it "returns the response body" do
+      IRail::Request.get(url).should eql body
+    end
+  end
+end

data/spec/irail_spec.rb

@@ -0,0 +1,74 @@
+require_relative "../lib/ruby-irail/api.rb"
+
+describe IRail::API do
+  let(:irail) { IRail::API.new }
+
+  describe :stations do
+    let(:stations)         { mock("Stations") }
+    let(:fetched_stations) { mock("Fetched stations") }
+
+    before :each do
+      irail.stub(:get_stations => fetched_stations)
+    end
+
+    it "returns the stations when they were already fetched" do
+      irail.instance_variable_set(:@stations, stations)
+      irail.stations.should eql stations
+    end
+
+    context "when stations have not been fetched yet" do
+      it "fetches them" do
+        irail.should_receive(:get_stations)
+        irail.stations
+      end
+
+      it "returns them" do
+        irail.stations.should eql fetched_stations
+      end
+    end
+  end
+
+  describe :get_stations do
+    let(:station_list_url) { mock("Url") }
+    let(:xml_station_list) { mock("Xml station list") }
+    let(:stations)         { mock("Stations") }
+
+    before :each do
+      irail.stub(:build_station_list_url => station_list_url)
+      irail.stub(:get_station_list => xml_station_list)
+      IRail::DocumentParser.stub(:parse_stations => stations)
+    end
+
+    it "builds the station list url" do
+      irail.should_receive(:build_station_list_url)
+      irail.get_stations
+    end
+
+    it "gets the xml station list" do
+      irail.should_receive(:get_station_list).with(station_list_url)
+      irail.get_stations
+    end
+
+    it "returns the parsed stations" do
+      irail.get_stations.should eql stations
+    end
+  end
+
+  describe :get_station_list do
+    let(:url)      { mock("Url") }
+    let(:response) { mock("Response") }
+
+    before :each do
+      IRail::Request.stub(:get => response)
+    end
+
+    it "calls the station list url through a get request" do
+      IRail::Request.should_receive(:get).with(url)
+      irail.get_station_list(url)
+    end
+
+    it "returns the response" do
+      irail.get_station_list(url).should eql response
+    end
+  end
+end

data/spec/models/station_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../../lib/ruby-irail/models/station.rb'
+
+describe IRail::Station do
+  let(:station) { IRail::Station.new }
+
+  it "has an id" do
+    station.should respond_to(:id)
+  end
+
+  it "has an latitude" do
+    station.should respond_to(:latitude)
+  end
+
+  it "has an longitude" do
+    station.should respond_to(:longitude)
+  end
+
+  it "has a standard name" do
+    station.should respond_to(:standard_name)
+  end
+
+  it "has a name" do
+    station.should respond_to(:name)
+  end
+end

data/spec/parser/document_parser_spec.rb

@@ -0,0 +1,55 @@
+require_relative "../../lib/ruby-irail/parser/document_parser.rb"
+
+describe IRail::DocumentParser do
+  module Nokogiri
+    module XML
+    end
+  end
+
+  class StationParser
+  end
+
+  class Station
+  end
+
+  describe :'self.parse_stations' do
+    let(:xml_string)  { mock("Xml string") }
+    let(:xml_payload) { mock("Xml payload") }
+    let(:stations)    { [ mock("Station"), mock("Station"), mock("Station") ] }
+    let(:attributes)  { {} }
+
+    before :each do
+      Nokogiri.stub(:XML => xml_payload)
+      xml_payload.stub(:xpath => stations)
+      IRail::StationParser.stub(:parse => attributes)
+    end
+
+    it "gets the xml payload from the string passed as parameter" do
+      Nokogiri.should_receive(:XML).with(xml_string)
+      IRail::DocumentParser.parse_stations(xml_string)
+    end
+
+    it "extracts the stations from the xml payload" do
+      xml_payload.should_receive(:xpath).with(IRail::DocumentParser::STATION_XPATH)
+      IRail::DocumentParser.parse_stations(xml_string)
+    end
+
+    it "parses the attributes of all stations" do
+      stations.each do |xml_station|
+        IRail::StationParser.should_receive(:parse).with(xml_station)
+      end
+      IRail::DocumentParser.parse_stations(xml_string)
+    end
+
+    it "creates a new station for all parsed station attributes" do
+      stations.each do |station|
+        IRail::Station.should_receive(:new).with(attributes)
+      end
+      IRail::DocumentParser.parse_stations(xml_string)
+    end
+
+    it "returns as many stations as in the xml payload" do
+      IRail::DocumentParser.parse_stations(xml_string).size.should eql stations.size
+    end
+  end
+end

data/spec/parser/station_parser_spec.rb

@@ -0,0 +1,50 @@
+require_relative "../../lib/ruby-irail/parser/station_parser.rb"
+
+describe IRail::StationParser do
+  describe :'self.parse' do
+    let(:xml_payload)   { mock("Xml Payload") }
+    let(:id)            { mock("Station Id") }
+    let(:latitude)      { mock("Latitude") }
+    let(:longitude)     { mock("Longitude") }
+    let(:standard_name) { mock("Standard Name") }
+    let(:name)          { mock("Name") }
+
+    before :each do
+      IRail::StationParser.stub(parse_station_id: id)
+      IRail::StationParser.stub(parse_station_latitude: latitude)
+      IRail::StationParser.stub(parse_station_longitude: longitude)
+      IRail::StationParser.stub(parse_station_standard_name: standard_name)
+      IRail::StationParser.stub(parse_station_name: name)
+    end
+
+    it "parses the id" do
+      IRail::StationParser.should_receive(:parse_station_id).with(xml_payload)
+      IRail::StationParser.parse(xml_payload)
+    end
+
+    it "parses the latitude" do
+      IRail::StationParser.should_receive(:parse_station_latitude).with(xml_payload)
+      IRail::StationParser.parse(xml_payload)
+    end
+
+    it "parses the longitude" do
+      IRail::StationParser.should_receive(:parse_station_longitude).with(xml_payload)
+      IRail::StationParser.parse(xml_payload)
+    end
+
+    it "parses the standard name" do
+      IRail::StationParser.should_receive(:parse_station_standard_name).with(xml_payload)
+      IRail::StationParser.parse(xml_payload)
+    end
+
+    it "parses the name" do
+      IRail::StationParser.should_receive(:parse_station_name).with(xml_payload)
+      IRail::StationParser.parse(xml_payload)
+    end
+
+    it "returns a hash containing the parsed attributes" do
+      expected = { id: id, latitude: latitude, longitude: longitude, standard_name: standard_name, name: name}
+      IRail::StationParser.parse(xml_payload).should eql expected
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ruby-irail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marc Lainez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70309396504580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70309396504580
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70309396504160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70309396504160
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: &70309396503740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70309396503740
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70309396503320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70309396503320
+description: IRail makes Belgian railway schedule easily available for anyone. This
+  is a Ruby wrapper for their API.
+email:
+- ml@theotherguys.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/ruby-irail.rb
+- lib/ruby-irail/api.rb
+- lib/ruby-irail/http/request.rb
+- lib/ruby-irail/models/station.rb
+- lib/ruby-irail/parser/document_parser.rb
+- lib/ruby-irail/parser/station_parser.rb
+- lib/version.rb
+- ruby-irail.gemspec
+- spec/http/request_spec.rb
+- spec/irail_spec.rb
+- spec/models/station_spec.rb
+- spec/parser/document_parser_spec.rb
+- spec/parser/station_parser_spec.rb
+homepage: https://github.com/mlainez/ruby-irail
+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: Ruby Irail is a wrapper around IRail API.
+test_files:
+- spec/http/request_spec.rb
+- spec/irail_spec.rb
+- spec/models/station_spec.rb
+- spec/parser/document_parser_spec.rb
+- spec/parser/station_parser_spec.rb