ztm_warszawa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5faa3e86cba2f5cf8b58f48a21c8c18565cb7b04
+  data.tar.gz: a55e9d33bca875c913a42e3a9feb26233d9eee81
+SHA512:
+  metadata.gz: c4d861d53500db71471b846691e313e89a1c288aaf84acdae1025ececd94df8252988cea1f8d75f2daa3ce82ff481a83eb068556c603f8271ade6c6649f21d88
+  data.tar.gz: b6beb1fac06737c10415dacd1d8d1c2e4c83e80abebb6a3fd5fc915d89d870797db348fba262b2494cf664226438747e80f96f7d2dd0c9ddc6ec695c6e5203d3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Piotr Górni
+
+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,51 @@
+# ZtmWarszawa
+
+This is a simple gem making querying the UM Warszawa's ZTM API easy. No-one has to reinvent the wheel anymore :)
+
+Using this gem, you can easily:
+
+- find out, which bus lines depart from a given bus stop
+- get the hours of departure of a given bus line from a specified bus stop
+- get the closest bus departures for a given bus stop
+
+It also seems to work with other types of stops that are under ZTM's administration (e.g. railway stations, tram stations...)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ztm_warszawa'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ztm_warszawa
+
+## Dependencies
+
+This gem depends on the `httparty` gem for making HTTP requests and the `addressable` gem for transcribing any Polish characters.
+
+## Usage
+
+First, create the the appropriate object:
+
+`ztm_api = ZtmWarszawa.new(api_key)`
+
+The API key has to be a string. It can be changed later on by calling `ztm_api.api_key = (new api key)`. You can get an API key by registering [here](https://api.um.warszawa.pl/index.php?wcag=true&opc=8.8,2,0,0,).
+
+Now, you can use the following methods:
+
+- `get_stop_id(bus_stop_name)`: Queries the ZTM API to get the bus stop's ID from its name. The ID is required for all the latter operations.
+
+- `get_bus_lines(bus_stop_id, bus_stop_no)`: Returns an array of bus lines (e.g. 527, 141...) that depart from a given bus stop.
+
+- `get_closest_departures(server_response, script_starting_time, bus_line, number_of_departures)`: From the server's response from get_line_departure_hours(), find a given number of closest departures. The result is an array of hashes with "bus_line" and "time" entries.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ztm_warszawa"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ztm_warszawa/version.rb

@@ -0,0 +1,3 @@
+class ZtmWarszawa
+  VERSION = "0.1.0"
+end

data/lib/ztm_warszawa.rb

@@ -0,0 +1,60 @@
+require "ztm_warszawa/version"
+require 'httparty'
+require 'addressable/uri'
+
+class ZtmWarszawa
+
+	attr_writer :api_key
+
+	def initialize(api_key)
+		@api_key = api_key
+	end
+
+	# Queries the ZTM API to get the bus stop's ID from its name.
+	# The ID is required for all the latter operations.
+	def get_stop_id(bus_stop_name)
+		raw_url = "https://api.um.warszawa.pl/api/action/dbtimetable_get?id=b27f4c17-5c50-4a5b-89dd-236b282bc499&name=#{bus_stop_name}&apikey=#{@api_key}"
+		url = Addressable::URI.parse(raw_url)
+		response = HTTParty.get(url.normalize).parsed_response["result"]
+		raise 'Bus stop not found' if response.empty?
+		bus_stop_id = response[0]["values"][0]["value"]
+		return bus_stop_id
+	end
+
+	# Returns an array of bus lines (e.g. 527, 141...) that depart from a given bus stop.
+	def get_bus_lines(bus_stop_id, bus_stop_no)
+		bus_lines = []
+	
+		url = "https://api.um.warszawa.pl/api/action/dbtimetable_get/?id=88cd555f-6f31-43ca-9de4-66c479ad5942&busstopId=#{bus_stop_id}&busstopNr=#{bus_stop_no}&apikey=#{@api_key}"
+		response = HTTParty.get(url).parsed_response["result"]
+		raise 'No vehicles seem to depart from here.' if response.empty?
+
+		response.each do |bus_line_info|
+		bus_lines << bus_line_info["values"][0]["value"]
+		end
+		return bus_lines
+	end
+
+	# Returns the server response with all the hours of departure of a given bus line from a given bus stop (and its number).
+	def get_line_departure_hours(bus_stop_id, bus_stop_no, bus_line)
+		url = "https://api.um.warszawa.pl/api/action/dbtimetable_get?id=e923fa0e-d96c-43f9-ae6e-60518c9f3238&busstopId=#{bus_stop_id}&busstopNr=#{bus_stop_no}&line=#{bus_line}&apikey=#{@api_key}"
+		response = HTTParty.get(url).parsed_response["result"]
+		return response
+	end
+
+	# From the server's response from get_line_departure_hours(), find a given number of closest departures
+	def get_closest_departures(server_response, script_starting_time, bus_line, number_of_departures)
+		bus_data = server_response
+		closest_departures = []
+
+			bus_data.each do |bus|
+				diff = Time.parse(bus["values"][0]["value"]) - script_starting_time
+				if diff > 0
+					closest_departures << {"bus_line" => bus_line, "time" => bus["values"][0]["value"] }
+				end
+			end
+
+		return closest_departures.take(number_of_departures)
+	end
+
+end

data/ztm_warszawa.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ztm_warszawa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ztm_warszawa"
+  spec.version       = ZtmWarszawa::VERSION
+  spec.authors       = ["Piotr Górni"]
+  spec.email         = ["p137@gmx.com"]
+
+  spec.summary       = %q{Ruby bindings for UM Warszawa ZTM's API.}
+  spec.description   = %q{Use this gem to access the api.um.warszawa.pl public data. Only the API key is required.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'addressable'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: ztm_warszawa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Górni
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use this gem to access the api.um.warszawa.pl public data. Only the API
+  key is required.
+email:
+- p137@gmx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ztm_warszawa.rb
+- lib/ztm_warszawa/version.rb
+- ztm_warszawa.gemspec
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for UM Warszawa ZTM's API.
+test_files: []