station_master 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e312a2799b864999ba67bb915b2c92a1163881e6
+  data.tar.gz: 6b6694a902539bfaf90fd7177afffb74525fb36a
+SHA512:
+  metadata.gz: eb5fd618b872e81ee0469ee5694ceec8b31477318315c7ec169262eeb24ebe57fb893dd08b61a612c08b0821816369908696b501cf955d85944414852e14e33f
+  data.tar.gz: 5807a83d567bddfeee73eb5d24ebf5abcdb0024e8c58a7f18a8f62c23354cc0231d9b1bfacbc40df486f84f8fd492ee8097a614c9d9dc11e949eef8e41dee2f1

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,3 @@
+--color
+--format documentation
+--order random

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/Gemfile

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

data/README.md

@@ -0,0 +1,87 @@
+# StationMaster
+
+This gem provide an interface to an api from www.viaggiatreno.it public site.
+This project exploits the api that the site uses to build up the front-end side,
+to retrieve real-time information on italian rail system and to provide an more
+convinient interface to that information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'station_master'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install station_master
+
+## Usage
+
+    require 'station_master'
+
+To get a list of all stations available:
+
+
+    StationMaster::Ask::Station.all
+
+
+It returns the list of all stations with geo-coordinates information (may
+require minutes!).
+
+To find a specific station based on city name:
+
+    StationMaster::Ask::Station.find_by_city('Torino')
+
+It returns a list of possible stations that match the parameter string.
+
+## Changelog
+
+### 0.0.3
+
+- Retrieve station codes by providing city name.
+
+### 0.0.2
+
+- Setup test environment.
+- Mocking api in test environment.
+
+### 0.0.1
+
+- Retrieve the list of all stations.
+- gem bundlerized.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/station_master/fork )
+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
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Stefano Ordine
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/station_master/ask/station.rb

@@ -0,0 +1,72 @@
+module StationMaster
+  module Ask
+    class Station
+      class << self
+        def all
+          stations_array = []
+          index = 0
+          begin
+            response = MultiJson::load(remote_call(:stations, page: index), symbolize_keys: true).inject([]) do |array, station|
+              station_code = station[:codiceStazione]
+              latitude = station[:lat]
+              longitude = station[:lon]
+              region_id = find_region_id_by_code(station[:codiceStazione])
+              station_details = find_details(station_code, region_id)
+              location = (station_details[:localita][:nomeLungo] || '').split.map(&:capitalize).join(' ') if station_details
+
+              array << {
+                station_code: station_code,
+                latitude: latitude,
+                longitude: longitude,
+                region_id: region_id,
+                location: location
+              }
+            end
+            stations_array += response
+            index += 1
+          end while response.any?
+
+          stations_array
+        end
+
+        def find_by_city(city)
+          remote_call(:search, { city: city }).split(/\n/).map(&:strip).inject({}) { |hash, entry| hash.merge!({ entry.split('|').first.to_sym => entry.split('|').last }) }
+        end
+
+        def find_region_id_by_code(station_code)
+          remote_call(:region_id, station_code: station_code)
+        end
+
+        def find_details(station_code, region_id)
+          MultiJson::load(remote_call(:station_details, station_code: station_code, region_id: region_id), symbolize_keys: true)
+        end
+
+        private
+          def remote_call(resource, options = {})
+            request_url = case resource
+              when :stations then
+                STATION_MASTER_BASE_URL + "elencoStazioni/#{options[:page] || 0}"
+              when :region_id then
+                STATION_MASTER_BASE_URL + "regione/#{options[:station_code] || 0}"
+              when :station_details
+                STATION_MASTER_BASE_URL + "dettaglioStazione/#{options[:station_code] || 0}/#{options[:region_id] || 0}"
+              when :search
+                STATION_MASTER_BASE_URL + "autocompletaStazione/#{options[:city] || ''}"
+              else
+                ''
+            end
+
+            remote_call!(request_url)
+          end
+
+          def remote_call!(request_url)
+            url = URI.parse(request_url)
+            http = Net::HTTP.new(url.host, url.port)
+            http.read_timeout = 2
+
+            http.get(url).body
+          end
+      end
+    end
+  end
+end

data/lib/station_master/ask.rb

@@ -0,0 +1,4 @@
+module StationMaster
+  module Ask
+  end
+end

data/lib/station_master/version.rb

@@ -0,0 +1,3 @@
+module StationMaster
+  VERSION = "0.0.3"
+end

data/lib/station_master.rb

@@ -0,0 +1,12 @@
+require 'active_support/core_ext'
+require 'multi_json'
+require 'net/http'
+
+require 'station_master/version'
+require 'station_master/ask'
+require 'station_master/ask/station'
+
+
+module StationMaster
+  STATION_MASTER_BASE_URL = 'http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'station_master'
+
+require 'pry'
+require 'webmock/rspec'
+include WebMock::API
+require 'benchmark'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:get, 'http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/elencoStazioni/0').
+      to_return(status: 200, body: <<-JSON.squish, headers: {})
+        [{"codReg":15,"tipoStazione":3,"dettZoomStaz":[],"pstaz":[],"mappaCitta":{"urlImagePinpoint":"","urlImageBaloon":""},"codiceStazione":"S11212","codStazione":"S11212","lat":40.787682,"lon":15.758093,"latMappaCitta":0.0,"lonMappaCitta":0.0,"localita":{"nomeLungo":"CASTEL LAGOPESOLE","nomeBreve":"Castel Lagopes.","label":"","id":"S11212"},"esterno":false,"offsetX":0,"offsetY":0,"nomeCitta":"A"},{"codReg":15,"tipoStazione":3,"dettZoomStaz":[],"pstaz":[],"mappaCitta":{"urlImagePinpoint":"","urlImageBaloon":""},"codiceStazione":"S11214","codStazione":"S11214","lat":40.714667,"lon":15.785619,"latMappaCitta":0.0,"lonMappaCitta":0.0,"localita":{"nomeLungo":"AVIGLIANO LUCANIA","nomeBreve":"Avigliano Luc.","label":"","id":"S11214"},"esterno":false,"offsetX":0,"offsetY":0,"nomeCitta":"A"}]
+      JSON
+
+    stub_request(:get, 'http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/elencoStazioni/1').
+      to_return(status: 200, body: <<-JSON.squish, headers: {})
+        [{"codReg":15,"tipoStazione":3,"dettZoomStaz":[],"pstaz":[],"mappaCitta":{"urlImagePinpoint":"","urlImageBaloon":""},"codiceStazione":"S11219","codStazione":"S11219","lat":41.062304,"lon":15.595094,"latMappaCitta":0.0,"lonMappaCitta":0.0,"localita":{"nomeLungo":"LEONESSA","nomeBreve":"Leonessa","label":"","id":"S11219"},"esterno":false,"offsetX":0,"offsetY":0,"nomeCitta":"A"}]
+      JSON
+
+    stub_request(:get, 'http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/elencoStazioni/2').
+      to_return(status: 200, body: '[]', headers: {})
+
+    ['S11212', 'S11214', 'S11219'].each do |station_id|
+      region_id = 15
+
+      stub_request(:get, "http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/regione/#{station_id}").
+        to_return(status: 200, body: "#{region_id}", headers: {})
+
+      body = case station_id
+        when 'S11212' then '{"codReg":15,"tipoStazione":3,"dettZoomStaz":[],"pstaz":[],"mappaCitta":{"urlImagePinpoint":"","urlImageBaloon":""},"codiceStazione":"S11212","codStazione":"S11212","lat":40.787682,"lon":15.758093,"latMappaCitta":0.0,"lonMappaCitta":0.0,"localita":{"nomeLungo":"CASTEL LAGOPESOLE","nomeBreve":"Castel Lagopes.","label":"","id":"S11212"},"esterno":false,"offsetX":0,"offsetY":0,"nomeCitta":"A"}'
+        when 'S11214' then '{"codReg":15,"tipoStazione":3,"dettZoomStaz":[],"pstaz":[],"mappaCitta":{"urlImagePinpoint":"","urlImageBaloon":""},"codiceStazione":"S11214","codStazione":"S11214","lat":40.714667,"lon":15.785619,"latMappaCitta":0.0,"lonMappaCitta":0.0,"localita":{"nomeLungo":"AVIGLIANO LUCANIA","nomeBreve":"Avigliano Luc.","label":"","id":"S11214"},"esterno":false,"offsetX":0,"offsetY":0,"nomeCitta":"A"}'
+        when 'S11219' then '{"codReg":15,"tipoStazione":3,"dettZoomStaz":[],"pstaz":[],"mappaCitta":{"urlImagePinpoint":"","urlImageBaloon":""},"codiceStazione":"S11219","codStazione":"S11219","lat":41.062304,"lon":15.595094,"latMappaCitta":0.0,"lonMappaCitta":0.0,"localita":{"nomeLungo":"LEONESSA","nomeBreve":"Leonessa","label":"","id":"S11219"},"esterno":false,"offsetX":0,"offsetY":0,"nomeCitta":"A"}'
+      end
+
+      stub_request(:get, "http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/dettaglioStazione/#{station_id}/#{region_id}").
+        to_return(status: 200, body: body, headers: {})
+    end
+
+    stub_request(:get, "http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/Tor").
+      to_return(status: 200, body: <<-JSON, headers: {})
+        TORINO P.NUOVA|S00219
+        TOR SAPIENZA|S08501
+        TOR VERGATA|S08655
+        TORA PRESENZANO|S09202
+        TORANO LATTARICO|S11906
+        TORCHIARA|S11706
+        TORINO DORA|S00224
+        TORINO LINGOTTO|S00452
+        TORINO PORTA SUSA|S00035
+        TORINO REBAUDENGO FOSSATA|S00060
+        TORINO S. PAOLO|S00223
+        TORINO STURA|S00228
+        TORRALBA|S12865
+        TORRAZZA P.|S00234
+        TORRE ANNUNZIATA CENTRALE|S09806
+        TORRE ANNUNZIATA CITTA'|S09805
+        TORRE DEI PASSERI|S07706
+        TORRE DEL GRECO|S09803
+        TORRE DEL LAGO PUCCINI|S06015
+        TORRE DE` PICENARDI|S01918
+        TORRE IN PIETRA-PALIDORO|S08019
+        TORRE MELISSA|S11821
+        TORRE ORSAIA|S11717
+        TORRE PELLICE|S00524
+        TORRE S.GIORGIO|S00545
+        TORREBERETTI|S00039
+        TORREMEZZO DI FALCONARA|S11971
+        TORRENIERI|S06817
+        TORRICELLA|S07011
+        TORRICOLA|S08600
+        TORRILE S. POLO|S01853
+        TORRITA DI SIENA|S06854
+        TORTONA|S01810
+        TORTORETO LIDO|S07801
+        TORVISCOSA|S03206
+      JSON
+  end
+end

data/spec/station_master_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe StationMaster::Ask::Station do
+  let(:station) { StationMaster::Ask::Station }
+
+  context "#all" do
+    let(:all_stations) { StationMaster::Ask::Station.all }
+
+    it "returns all stations" do
+      expect(station).to respond_to(:all)
+      expect(all_stations).to be_a(Array)
+      expect(all_stations).not_to be_empty
+      expect(all_stations.count).to eq(3)
+      expect(all_stations).to eq([
+        {
+          station_code: "S11212",
+          latitude: 40.787682,
+          longitude: 15.758093,
+          region_id: "15",
+          location: "Castel Lagopesole"
+        },
+        {
+          station_code: "S11214",
+          latitude: 40.714667,
+          longitude: 15.785619,
+          region_id: "15",
+          location: "Avigliano Lucania"
+        },
+        {
+          station_code: "S11219",
+          latitude: 41.062304,
+          longitude: 15.595094,
+          region_id: "15",
+          location: "Leonessa"
+        }])
+    end
+  end
+
+  context "#find_by_city" do
+    let(:found_stations) { StationMaster::Ask::Station.find_by_city('Tor') }
+
+    it "returns stations that match with city name" do
+      expect(station).to respond_to(:find_by_city)
+      expect(found_stations).to be_a(Hash)
+      expect(found_stations).not_to be_empty
+      expect(found_stations.values.count).to eq(35)
+      expect(found_stations).to eq(
+        {
+          :"TORINO P.NUOVA" => "S00219",
+          :"TOR SAPIENZA" => "S08501",
+          :"TOR VERGATA" => "S08655",
+          :"TORA PRESENZANO" => "S09202",
+          :"TORANO LATTARICO" => "S11906",
+          :"TORCHIARA" => "S11706",
+          :"TORINO DORA" => "S00224",
+          :"TORINO LINGOTTO" => "S00452",
+          :"TORINO PORTA SUSA" => "S00035",
+          :"TORINO REBAUDENGO FOSSATA" => "S00060",
+          :"TORINO S. PAOLO" => "S00223",
+          :"TORINO STURA" => "S00228",
+          :"TORRALBA" => "S12865",
+          :"TORRAZZA P." => "S00234",
+          :"TORRE ANNUNZIATA CENTRALE" => "S09806",
+          :"TORRE ANNUNZIATA CITTA'" => "S09805",
+          :"TORRE DEI PASSERI" => "S07706",
+          :"TORRE DEL GRECO" => "S09803",
+          :"TORRE DEL LAGO PUCCINI" => "S06015",
+          :"TORRE DE` PICENARDI" => "S01918",
+          :"TORRE IN PIETRA-PALIDORO" => "S08019",
+          :"TORRE MELISSA" => "S11821",
+          :"TORRE ORSAIA" => "S11717",
+          :"TORRE PELLICE" => "S00524",
+          :"TORRE S.GIORGIO" => "S00545",
+          :"TORREBERETTI" => "S00039",
+          :"TORREMEZZO DI FALCONARA" => "S11971",
+          :"TORRENIERI" => "S06817",
+          :"TORRICELLA" => "S07011",
+          :"TORRICOLA" => "S08600",
+          :"TORRILE S. POLO" => "S01853",
+          :"TORRITA DI SIENA" => "S06854",
+          :"TORTONA" => "S01810",
+          :"TORTORETO LIDO" => "S07801",
+          :"TORVISCOSA" => "S03206"
+        }
+      )
+    end
+  end
+end

data/station_master.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'station_master'
+
+Gem::Specification.new do |spec|
+  spec.name          = "station_master"
+  spec.version       = StationMaster::VERSION
+  spec.authors       = ["Stefano Ordine"]
+  spec.email         = ["stefano.ordine@gmail.com"]
+  spec.summary       = "This gem provide an interface to an api from www.viaggiatreno.it public site."
+  spec.description   = "This gem provide an interface to an api from www.viaggiatreno.it public site. This project exploits the api that the site uses to build up the front-end side, to retrieve real-time information on italian rail system and to provide an more convinient interface to that information."
+  spec.homepage      = "https://github.com/StefanoOrdine/station_master"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "multi_json", "~> 1.10"
+  spec.add_dependency "activesupport", "~> 4.1"
+
+  spec.add_development_dependency "bundler", "~> 0"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-nav", "~> 0.2"
+  spec.add_development_dependency "webmock", "~> 1.19"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: station_master
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Stefano Ordine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+description: This gem provide an interface to an api from www.viaggiatreno.it public
+  site. This project exploits the api that the site uses to build up the front-end
+  side, to retrieve real-time information on italian rail system and to provide an
+  more convinient interface to that information.
+email:
+- stefano.ordine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- lib/station_master.rb
+- lib/station_master/ask.rb
+- lib/station_master/ask/station.rb
+- lib/station_master/version.rb
+- spec/spec_helper.rb
+- spec/station_master_spec.rb
+- station_master.gemspec
+homepage: https://github.com/StefanoOrdine/station_master
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This gem provide an interface to an api from www.viaggiatreno.it public site.
+test_files:
+- spec/spec_helper.rb
+- spec/station_master_spec.rb