sfba_transit_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a91205825ff83f8ee86dc627a40aa701baebb01c
+  data.tar.gz: 1cfe169dd87692a8c4a3ce72f83e0cf45aedb929
+SHA512:
+  metadata.gz: 297a294c2863f724ee4c21bc3663c57fcda7862d52b11a59f3ce507b4b4bccf471c62a581867e3df3e13efeaf3291c3fbe586d37509da12d3a690501f15039a6
+  data.tar.gz: e2957283da7b6633349ba7bb02209773b81227e8e06902b70f355a15f1ce8a2b601d8c88a46301c8a5e46c492a375b565845d2985e73afe3a6603102097ace4e

data/lib/sfba_transit_api/agency.rb

@@ -0,0 +1,30 @@
+module SFBATransitAPI
+  class Agency
+    attr_accessor :name, :has_direction, :mode, :routes
+
+    def to_s
+      "#<SFBATransitAPI::Agency:#{object_id} @name=\"#{name}\", @has_direction=#{has_direction}, @mode=\"#{mode}\", routes.count=#{routes.count}>"
+    end
+
+    def has_direction=(has_direction)
+      if has_direction.is_a? String
+        @has_direction = has_direction.downcase == "true" ? true : false
+      else
+        @has_direction = has_direction ? true : false
+      end
+    end
+
+    def self.parse(node)
+      node.xpath("//Agency").map do |agency_node|
+        agency = new
+
+        agency.name = agency_node["Name"]
+        agency.has_direction = agency_node["HasDirection"]
+        agency.mode = agency_node["Mode"]
+        agency.routes = Route.parse(agency_node, agency)
+
+        agency
+      end
+    end
+  end
+end

data/lib/sfba_transit_api/client.rb

@@ -0,0 +1,77 @@
+module SFBATransitAPI
+  class Client
+
+    attr_accessor :connection
+
+    # Initialize the client
+    #
+    # @param token [String] obtained from http://www.511.org/developer-resources_api-security-token_rtt.asp
+    # @return [String] the object converted into the expected format.
+    def initialize(token, options={})
+      self.connection = Connection.new(token, options)
+    end
+
+    def get_agencies
+      response = get(:get_agencies)
+
+      Agency.parse(response)
+    end
+
+    def get_routes_for_agency(agency_name)
+      response = get(:get_routes_for_agency, {agency_name: agency_name})
+
+      Agency.parse(response).map { |agency| agency.routes }.flatten
+    end
+
+    def get_routes_for_agencies(agency_names)
+      response = get(:get_routes_for_agencies, {agency_names: agency_names.join("|")})
+
+      Agency.parse(response).map { |agency| agency.routes }.flatten
+    end
+
+    def get_stops_for_route(route_info)
+      route_idf = makeRouteIDF(route_info)
+
+      response = get(:get_stops_for_route, {route_idf: route_idf})
+
+      Agency.parse(response).map do |agency|
+        agency.routes.map do |route|
+          route.stops
+        end.flatten
+      end.flatten
+    end
+
+    def get_stops_for_routes(route_infos)
+      route_idf = route_infos.map { |route_info| makeRouteIDF(route_info) }.join("|")
+
+      response = get(:get_stops_for_routes, {route_idf: route_idf})
+
+      Agency.parse(response).map do |agency|
+        agency.routes.map do |route|
+          route.stops
+        end.flatten
+      end.flatten
+    end
+
+    def get_next_departures_by_stop_code(stopcode)
+      response = get(:get_next_departures_by_stop_code, stopcode: stopcode)
+
+      Agency.parse(response).map do |agency|
+        agency.routes.map do |route|
+          route.stops
+        end.flatten
+      end.flatten.first
+    end
+
+    def makeRouteIDF(route_info)
+      route_idf = "#{route_info[:agency_name]}~#{route_info[:route_code]}"
+      route_idf += "~Inbound" if route_info[:route_direction] == :inbound
+      route_idf += "~Outbound" if route_info[:route_direction] == :outbound
+      route_idf
+    end
+
+    def get(method, options={})
+      self.connection.get(method, options)
+    end
+  end
+end

data/lib/sfba_transit_api/connection.rb

@@ -0,0 +1,52 @@
+require 'faraday'
+require 'active_support/core_ext/string'
+require 'nokogiri'
+
+module SFBATransitAPI
+  class Connection
+
+    attr_accessor :token, :path_prefix
+
+    def initialize(token, options={})
+      self.token = token
+      self.path_prefix = options.fetch(:path_prefix, PATH_PREFIX)
+
+      @connection = Faraday.new(:url => options.fetch(:api_endpoint, API_ENDPOINT))
+    end
+
+    def get(method, options={})
+      path = "#{path_prefix}/#{method.to_s.camelize}.aspx"
+      params = options_to_params(options)
+      params["token"] = token
+
+      response = request(path, params)
+
+      if response.status != 200
+        raise ResponseException, "Server responded with #{response.status}"
+      end
+
+      xml_doc = Nokogiri::XML(response.body)
+
+      error_node = xml_doc.at_xpath("/transitServiceError")
+
+      if error_node
+        raise ResponseException, error_node.text
+      end
+
+      xml_doc
+    end
+
+    def request(path, params)
+      @connection.get path, params
+    end
+
+    def options_to_params(options)
+      options.inject({}) do |memo, pair|
+        key = pair[0].to_s.camelize(:lower).sub(/idf/i, "IDF")
+        value = pair[1]
+        memo[key] = value
+        memo
+      end
+    end
+  end
+end

data/lib/sfba_transit_api/route.rb

@@ -0,0 +1,39 @@
+module SFBATransitAPI
+  class Route
+    attr_accessor :name, :code, :inbound_name, :outbound_name, :stops, :agency
+
+    def has_direction
+      not (inbound_name.nil? and outbound_name.nil?)
+    end
+
+    def to_s
+      "#<SFBATransitAPI::Route:#{object_id} @name=\"#{name}\", @code=\"#{code}\", @inbound_name=\"#{inbound_name}\", @outbound_name=\"#{outbound_name}\", @agency=<SFBATransitAPI::Agency:#{agency.object_id}>, stops.count=#{stops.count}>"
+    end
+
+    def self.parse(agency_node, agency)
+      agency_node.xpath(".//Route").map do |route_node|
+        route = new
+
+
+        route.agency = agency
+        route.name = route_node["Name"]
+        route.code = route_node["Code"]
+
+        direction_nodes = route_node.xpath(".//RouteDirection")
+        if direction_nodes.count > 0
+          direction_nodes.each do |direction_node|
+            if direction_node["Code"] == "Inbound"
+              route.inbound_name = direction_node["Name"]
+            elsif direction_node["Code"] == "Outbound"
+              route.outbound_name = direction_node["Name"]
+            end
+          end
+        end
+
+        route.stops = Stop.parse(route_node, route)
+
+        route
+      end
+    end
+  end
+end

data/lib/sfba_transit_api/stop.rb

@@ -0,0 +1,47 @@
+module SFBATransitAPI
+  class Stop
+    attr_accessor :name, :code, :direction, :direction_name, :departure_times, :route
+
+    def to_s
+      "#<SFBATransitAPI::Stop:#{object_id} @name=\"#{name}\", @code=\"#{code}\", @direction=\"#{direction}\", @direction_name=\"#{direction_name}\", @route=<SFBATransitAPI::Route:#{route.object_id}>, departure_times=#{departure_times}>"
+    end
+
+    def self.parse_departure_times(stop_node)
+      stop_node.xpath(".//DepartureTime").map do |departure_time_node|
+        departure_time_node.text ? departure_time_node.text.to_i : nil
+      end
+    end
+
+    def self.parse(route_node, route)
+      if route.has_direction
+        route_node.xpath(".//RouteDirection").map do |direction_node|
+
+          if direction_node["Code"] == "Inbound"
+            direction = :inbound
+          elsif direction_node["Code"] == "Outbound"
+            direction = :outbound
+          end
+
+          parse_stop(direction_node, route, direction, direction_node["Name"])
+        end.flatten
+      else
+        parse_stop(route_node, route)
+      end
+    end
+
+    def self.parse_stop(node, route, direction=nil, direction_name=nil)
+      node.xpath(".//Stop").map do |stop_node|
+        stop = new
+
+        stop.route = route
+        stop.name = stop_node["name"]
+        stop.code = stop_node["StopCode"]
+        stop.departure_times = parse_departure_times(stop_node)
+        stop.direction = direction
+        stop.direction_name = direction_name
+
+        stop
+      end
+    end
+  end
+end

data/lib/sfba_transit_api.rb

@@ -0,0 +1,18 @@
+require_relative "./sfba_transit_api/stop"
+require_relative "./sfba_transit_api/route"
+require_relative "./sfba_transit_api/agency"
+require_relative "./sfba_transit_api/connection"
+require_relative "./sfba_transit_api/client"
+
+module SFBATransitAPI
+
+  API_ENDPOINT = "http://services.my511.org"
+  PATH_PREFIX = "/Transit2.0"
+
+  class ResponseException < Exception
+  end
+
+  def self.client(token, options={})
+    Client.new(token, options)
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: sfba_transit_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: faraday
+  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: activesupport
+  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: rspec
+  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: guard
+  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: guard-rspec
+  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: dotenv
+  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'
+description: A Simple Way to Query the 511 RTT API
+email: gniquil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sfba_transit_api.rb
+- lib/sfba_transit_api/agency.rb
+- lib/sfba_transit_api/client.rb
+- lib/sfba_transit_api/connection.rb
+- lib/sfba_transit_api/route.rb
+- lib/sfba_transit_api/stop.rb
+homepage: https://github.com/gniquil/sfba_transit_api
+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.4.5
+signing_key: 
+specification_version: 4
+summary: San Francisco Bay Area 511 Real-time Transit Data Services API
+test_files: []