kvvliveapi 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3aafbe5a2805b5304dd284a3b2660fb71d6c3b9d
+  data.tar.gz: 8a2f42baf316bb138a48870bad767c730d2b14f3
+SHA512:
+  metadata.gz: 207aadb37d57d87fd2bc93d0aaf6968132e1e2526d8cc5fa0b109d66ed8a7d51d924dd54978d5daab415249eb206f3c21c12839e04ec0297f1848c3d21087106
+  data.tar.gz: 26fa63cdfeeae3862d5eca95babba29c2e25c14d3c554c33a24c4e228810b5fe3922b03b720d0bd3a950b1e5f2ad942b03c0ffaf0120daa1e22796ff1f9022df

data/.gitignore

@@ -0,0 +1,3 @@
+doc/
+Gemfile.lock
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/kvvliveapi.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kvvliveapi/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'kvvliveapi'
+  s.version       = KVVLiveAPI::VERSION
+  s.date          = '2018-02-05'
+  s.summary       = "Inofficial ruby bindings for the KVV (Karlsruher Verkehrsverbund) live API."
+  s.description   = "Allows to retrieve live information about train and bus depatures as well as information about stops."
+  s.authors       = ["Julian Schuh"]
+  s.email         = 'rubygems.dev@jlzmail.de'
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.require_paths = ['lib']
+  s.homepage      = 'https://github.com/julianschuh/kvvliveapi'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency 'faraday', '~> 0.14.0'
+  s.add_runtime_dependency 'activesupport', '~> 5.1'
+end

data/lib/kvvliveapi.rb

@@ -0,0 +1,83 @@
+require 'faraday'
+require 'json'
+require 'uri'
+require 'cgi'
+
+require 'active_support/all'
+
+require 'kvvliveapi/version'
+require 'kvvliveapi/constants'
+require 'kvvliveapi/stop'
+require 'kvvliveapi/depature'
+
+# Main module for accessing the KVV live API.
+# All API functions can be called directly on the class object.
+module KVVLiveAPI
+  class << self
+
+    # Retrieves a list of stops whose names match a given string
+    #
+    # * +name+ - name or fragment of the name of the Stop that is searched
+    def stops_by_name(name)
+      stops('stops/byname/' + CGI.escape(name))
+    end
+
+    # Retrieves a list of stops close to a given set of coordinates
+    #
+    # * +lat+ - latitude
+    # * +long+ - longitude
+    def stops_by_coordinates(lat, lon)
+      stops('stops/bylatlon/' + ('%.6f' % lat) + '/' + ('%.6f' % lon))
+    end
+
+    # Retrieves a single stop object by its ID
+    #
+    # * +stop_id+ - ID of the Stop to retrieve
+    def stops_by_id(stop_id)
+      [Stop.from_json(query('stops/bystop/' + CGI.escape(stop_id)))]
+    end
+
+    # Retrieves a list of upcoming depatures for a specified Stop ID
+    #
+    # * +stop_id+ - ID of the Stop for which upcoming depatures should
+    # be retrieved
+    def depatures_by_stop(stop_id)
+      departures('departures/bystop/' + stop_id)
+    end
+
+    # Retrieves a list of upcoming depatures for a specified rouute
+    # at a specified Stop ID
+    #
+    # * +route+ - Route for which upcoming depatures should be retrieved
+    # * +stop_id+ - ID of the Stop for which upcoming depatures should
+    #   be retrieved
+    def depatures_by_route(route, stop_id)
+      departures('departures/byroute/' + CGI.escape(route) + '/' + CGI.escape(stop_id))
+    end
+
+    private
+
+    def stops(api_path)
+      query(api_path)['stops'].map do |stop|
+        Stop.from_json(stop)
+      end
+    end
+
+    def departures(api_path)
+      query(api_path)['departures'].map do |stop|
+        Departure.from_json(stop)
+      end
+    end
+
+    def query(path, params = {})
+      params.merge!({ key: API_KEY })
+
+      uri = URI.parse(API_BASE + path).tap do |u|
+        u.query = URI.encode_www_form(params)
+      end
+
+      response = Faraday.get(uri)
+      JSON.parse!(response.body)
+    end
+  end
+end

data/lib/kvvliveapi/constants.rb

@@ -0,0 +1,7 @@
+module KVVLiveAPI
+	# Publicly available key needed to access the API
+	API_KEY = '377d840e54b59adbe53608ba1aad70e8'.freeze
+
+	# Base URL for all API calls
+	API_BASE = 'https://live.kvv.de/webapp/'.freeze
+end

data/lib/kvvliveapi/depature.rb

@@ -0,0 +1,84 @@
+module KVVLiveAPI
+  # Instances of this class represent the depature
+  # of a vehicle of a specific route with a
+  # specified destination at a specified time.
+  #
+  # It contins additional information about the
+  # depature and vehicle.
+  class Departure
+    class << self
+      def from_json(json)
+        new(json['route'],
+            json['destination'],
+            json['direction'],
+            json['time'],
+            json['lowfloor'],
+            json['realtime'],
+            json['traction'],
+            json['stopPosition'])
+      end
+    end
+
+    # The route for which the depature is valid, e.g. 2 or S7
+    attr_reader :route
+
+    # Final destination of the vehicle
+    attr_reader :destination
+
+    # Number representing the direction
+    attr_reader :direction
+
+    # Indicates the accessibility of the used vehicle
+    attr_reader :lowfloor
+
+    # Indicates if the depature is a realtime estimation
+    attr_reader :realtime
+
+    # Specified if single or double traction is used
+    attr_reader :traction
+
+    # Depature time
+    attr_reader :time
+
+    # Number representing the "sub-stop", as in some cases
+    # a single stops might have different sub-stops for
+    # different kinds if vehicles
+    attr_reader :stop_position
+
+    def initialize(route, destination, direction, time, lowfloor, realtime, traction, stop_position)
+      @route = route
+      @destination = destination
+      @direction = direction
+      @lowfloor = lowfloor
+      @realtime = realtime
+      @traction = traction
+      @time = convert_timestr(time)
+      @stop_position = stop_position
+    end
+
+    def to_s
+      @route + ' (-> ' + @destination + ') @ ' + @time.getlocal.strftime('%H:%M') + ', Stop ' + @stop_position.to_s
+    end
+
+    private
+
+    def convert_timestr(time)
+      timestr = time.to_s
+      now = Time.now.getlocal
+
+      return now.getutc if timestr == 'sofort' || timestr == '0'
+
+      if (mtch = /^([1-9]) min$/.match(timestr))
+        return now.advance(minutes: mtch[1].to_i).getutc
+      end
+
+      if (mtch = /^([0-2]?[0-9]):([0-5][0-9])$/.match(timestr))
+        resulting_time = now.change(hour: mtch[1].to_i, min: mtch[2].to_i)
+        resulting_time += 1.day if resulting_time < now
+        return resulting_time.getutc
+      end
+
+      nil
+    end
+  end
+end

data/lib/kvvliveapi/stop.rb

@@ -0,0 +1,34 @@
+module KVVLiveAPI
+  # Instances of this class represent a stop operated
+  # by the KVV
+  class Stop
+    class << self
+      def from_json(json)
+        new(json['name'], json['id'], json['lat'], json['lon'])
+      end
+    end
+
+    # Name of the stop
+    attr_reader :name
+
+    # ID used to reference the stop
+    attr_reader :stop_id
+
+    # latitute of the location of the stop
+    attr_reader :lat
+
+    # longitude of the location of the stop
+    attr_reader :lon
+
+    def initialize(name, stop_id, lat, lon)
+      @name = name
+      @stop_id = stop_id
+      @lat = lat
+      @lon = lon
+    end
+
+    def to_s
+      @name + '(' + @stop_id.to_s + ')'
+    end
+  end
+end

data/lib/kvvliveapi/version.rb

@@ -0,0 +1,4 @@
+module KVVLiveAPI
+  # Currently installed version of the Gem
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: kvvliveapi
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Julian Schuh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Allows to retrieve live information about train and bus depatures as
+  well as information about stops.
+email: rubygems.dev@jlzmail.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- kvvliveapi.gemspec
+- lib/kvvliveapi.rb
+- lib/kvvliveapi/constants.rb
+- lib/kvvliveapi/depature.rb
+- lib/kvvliveapi/stop.rb
+- lib/kvvliveapi/version.rb
+homepage: https://github.com/julianschuh/kvvliveapi
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Inofficial ruby bindings for the KVV (Karlsruher Verkehrsverbund) live API.
+test_files: []