kvv-liveapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa8d1e2ba1e608f32e6eddc0a3bc47dc489ac8f1818a6071e5f217fdd5d37ab8
+  data.tar.gz: 61e669c130154bcb1aee0c7d96cb573b3c80261eba0a520627079b63794cd4ac
+SHA512:
+  metadata.gz: 77169131ecf884d796b78953a760e60923ee49a4cc659fa303bdb691a0504fc780801c4899428564144bf8f8179f01f7035812eb2f278889674eea1cba561dbf
+  data.tar.gz: 15ce5b5371fc02412e9703756c04e67f437efb53173052bac8c18270bc8b11002a82ed3ab7d08d0255cb793520c42060ebfb5a01717437bfd307fa85c0823282

data/.gitignore

@@ -0,0 +1,25 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,35 @@
+source "https://rubygems.org"
+
+gemspec
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+group :test do
+  # gem 'minitest', '5.10.3'
+ #  # gem 'minitest-rails'
+ #  gem 'minitest-spec-context'
+ #  gem 'minitest-matchers'
+ #  gem 'minitest-reporters'
+ #  gem 'webmock'
+ #  gem 'vcr'
+ #  gem "minitest-vcr"
+ #  gem 'simplecov'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Christian Buggle <christian@buggle.net>
+
+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,55 @@
+# KVV::Liveapi
+
+KVV::Liveapi is a simple ruby gem to query stop data and timetables / departures as provided by the KVV Live Service (Karlsruhe Transport Agency).
+
+The KVV services is unofficial and undocumented so I can make no claims of any kind for this adapter to work as intended now or at any time in the future.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kvv-liveapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kvv-liveapi
+
+## Usage
+
+The KVV::Liveapi provides these 5 methods to query KVV data.
+
+* KVV::Liveapi.departures_bystop_name( name )
+
+* KVV::Liveapi.departures_bystop( stop_id )
+
+* KVV::Liveapi.departures_by_route( route: nil, stop_id: nil )
+
+* KVV::Liveapi.stops_by_name name
+
+* KVV::Liveapi.stops_by_latlon( lat: nil, lon: nil )
+
+The method names are derived closely from the corresponding liveapi.kvv.de api endpoints to assert consistency.
+
+
+TODO: Explain details where not obvious
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/buggle/kvv-liveapi.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_helper"
+require "rake/testtask"
+
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kvv/liveapi"
+
+# 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(__FILE__)

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/kvv-liveapi.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kvv/liveapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kvv-liveapi"
+  spec.version       = KVV::Liveapi::VERSION
+  spec.authors       = ["Christian Buggle"]
+  spec.email         = ["christian@buggle.net"]
+
+  spec.homepage      = "https://github.com//kvv-liveapi"
+  spec.summary       = "KVV Live API (Karlsruhe Transport Agency)"
+  spec.description   = "A simple adapter to query the KVV API (Karlsruher Verkehrsverbund - Karlsruhe Transport Agency) for live timetable data and stop information"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", '~> 1.16'
+  spec.add_development_dependency "rake", '~> 12.3'
+
+  spec.add_development_dependency "minitest", '~> 5.11'
+  spec.add_development_dependency "minitest-vcr", '~> 1.4'
+  spec.add_development_dependency "minitest-reporters", "~> 1.1"
+  spec.add_development_dependency 'webmock', '~> 3.3'
+  spec.add_development_dependency "simplecov", '~> 0.15'
+end
+

data/lib/kvv/liveapi.rb

@@ -0,0 +1,72 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module KVV
+  class Liveapi
+    API_KEY = '?key=377d840e54b59adbe53608ba1aad70e8'
+    API_BASE = 'https://live.kvv.de/webapp/'
+
+    URL_PATH_STOPS_BY_NAME = 'stops/byname/'
+    URL_PATH_DEPARTURES_BY_STOP = 'departures/bystop/'
+    URL_PATH_DEPARTURES_BY_LATLON = 'stops/bylatlon/'
+    URL_PATH_DEPARTURES_BY_ROUTE = 'departures/byroute/'
+
+    def self.departures_bystop_name name
+      self.departures_bystop guess_stop_id_by_name(name)
+    end
+
+    def self.departures_bystop stop_id
+      return {} unless stop_id
+      fetch_api_path [URL_PATH_DEPARTURES_BY_STOP, stop_id]
+    end
+
+    def self.departures_by_route route: nil, stop_id: nil
+      return {} unless route && stop_id
+      fetch_api_path [URL_PATH_DEPARTURES_BY_ROUTE, route, "/", stop_id]
+    end
+
+    def self.stops_by_name name
+      return [] if name.to_s.empty?
+      response = fetch_api_path [URL_PATH_STOPS_BY_NAME, name]
+      response["stops"] || {}
+    end
+
+    def self.stops_by_latlon lat: nil, lon: nil
+      return [] unless lat && lon
+      response = fetch_api_path [URL_PATH_DEPARTURES_BY_LATLON, lat, "/", lon]
+      response["stops"] || {}
+    end
+
+    private
+
+    def self.fetch_api_path *path
+      fetch [API_BASE, path, API_KEY].join
+    end
+
+    def self.fetch url
+      uri = URI( url )
+      request = Net::HTTP::Get.new(uri)
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      case response.code
+      when "200"
+        JSON.parse(response.body)
+      else
+        {}
+      end
+    end
+
+    def self.guess_stop_id_by_name name
+      first_stop = stops_by_name(name).first
+      first_stop["id"] unless first_stop.nil?
+    end
+  end
+end

data/lib/kvv/liveapi/version.rb

@@ -0,0 +1,5 @@
+module KVV
+  class Liveapi
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: kvv-liveapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Buggle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: A simple adapter to query the KVV API (Karlsruher Verkehrsverbund - Karlsruhe
+  Transport Agency) for live timetable data and stop information
+email:
+- christian@buggle.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kvv-liveapi.gemspec
+- lib/kvv/liveapi.rb
+- lib/kvv/liveapi/version.rb
+homepage: https://github.com//kvv-liveapi
+licenses: []
+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.7.3
+signing_key: 
+specification_version: 4
+summary: KVV Live API (Karlsruhe Transport Agency)
+test_files: []