opendata-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10b8aa1b9cba390f86ec972ce6c02667c5bf90c6
+  data.tar.gz: 757f9601ea75c14add7387494ecb594d5546072d
+SHA512:
+  metadata.gz: 20305e4c5809641911c815f6b4a786a01c4ef185ce3358dc8617cf22632c17dee9c0ac360dc5341720a07d86e54646a0cab7c2ea0352f4aa39fed768238d6b27
+  data.tar.gz: 5bcedb4a342de52a1332ea2a9be5b879bca876306541e65bc90042c723b86e1da62b9cae6e8486e66537cb68e04a85b0aa7c5222c10038f8408d77a68f11076f

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+%��z��Ҫ*��NYX�V�J({���vI�‹�dQ*�N�{��CB��a݇`e� cn!�7_��r�(�|4�6����(�À~�x󈶲�I<�i�����C��/Ym ��#�-�������l_�.P!$~|���
+�(��}�P,MzF�>��

data/lib/opendata-api.rb

@@ -0,0 +1,80 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+require 'openssl'
+
+require_relative './opendata-api/config'
+require_relative './opendata-api/request'
+
+module OpenDataAPI
+  def self.init(api_key)
+    raise "OpenData API Key required" if api_key.empty?
+
+    uri_base = URI.parse(OpenDataAPI::Constants::BASE_URL)
+    http_base = Net::HTTP.new(uri_base.host, uri_base.port)
+
+    # Store API Key as class variable
+    OpenDataAPIRequest.set_api_key(api_key)
+
+    # Store URI and HTTP base as class variables
+    OpenDataAPIRequest.set_uri_base(uri_base)
+    OpenDataAPIRequest.set_http_base(http_base)
+  end
+
+  def self.run(args)
+    api_requests = []
+    args.each do |arg|
+      case arg[:api_name]
+      when 'traffic_volume_counts'
+        # Request for Traffic Volume Counts API
+        uri_traffic_volume_counts_api = URI.parse(
+          OpenDataAPI::Constants::TrafficVolumeCountsAPI::BASE_URL + 
+          OpenDataAPI::Constants::TrafficVolumeCountsAPI::API_ENDPOINT + 
+          OpenDataAPI::Constants::TrafficVolumeCountsAPI.query_string_params(arg[:format], arg[:table], arg[:limit])
+        )
+        request_for_traffic_volume_counts_api = {
+          api_name: arg[:api_name],
+          api_instance: OpenDataAPIRequest.new(OpenDataAPIRequest.http_base, uri_traffic_volume_counts_api, OpenDataAPIRequest.api_key)
+        }
+        api_requests << request_for_traffic_volume_counts_api
+      when 'trip_planner'
+        # Request for Trip Planner API
+        uri_trip_planner_api = URI.parse(
+          OpenDataAPI::Constants::TripPlannerAPI::BASE_URL + 
+          OpenDataAPI::Constants::TripPlannerAPI::API_ENDPOINT + 
+          OpenDataAPI::Constants::TripPlannerAPI.query_string_params(arg[:format], arg[:coord_lat], arg[:coord_long], arg[:coord_radius])
+        )
+        request_for_trip_planner_api = {
+          api_name: arg[:api_name],
+          api_instance: OpenDataAPIRequest.new(OpenDataAPIRequest.http_base, uri_trip_planner_api, OpenDataAPIRequest.api_key)
+        }
+        api_requests << request_for_trip_planner_api
+      else
+        raise ArgumentError.new("Invalid API Name")
+      end
+    end
+
+    begin
+      # Start HTTP(S) Session to re-use across multiple requests
+      Net::HTTP.start(OpenDataAPIRequest.uri_base.hostname, OpenDataAPIRequest.uri_base.port,
+        :use_ssl => OpenDataAPIRequest.uri_base.scheme == 'https') do |http_session|
+        puts http_session.use_ssl? ? "OpenData API HTTPS Session" : "OpenData API HTTP Session"
+
+        http_session.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http_session.read_timeout = OpenDataAPI::Constants::READ_TIMEOUT
+
+        response = {}
+        # Request #1 to each API (i.e. Traffic Volume Counts API, Trip Planner API, etc)
+        api_requests.each do |request|
+          _res = request[:api_instance].fetch(http_session, request[:api_instance].request, OpenDataAPI::Constants::REQUEST_LIMIT)
+          # puts JSON.pretty_generate(JSON.parse(_res.body))
+          response[request[:api_name].to_sym] = _res.body
+        end
+        response
+      end
+    rescue Exception => e
+      raise "Exception opening TCP connection: #{e}"
+    end
+  end
+end

data/lib/opendata-api/config.rb

@@ -0,0 +1,29 @@
+module OpenDataAPI
+  module Constants
+    # Transport for NSW (TfNSW) Open Data API
+    BASE_URL = 'https://api.transport.nsw.gov.au'
+    READ_TIMEOUT = 500
+    REQUEST_LIMIT = 3
+
+    # Traffic Volume Counts API
+    module TrafficVolumeCountsAPI
+      BASE_URL = 'https://api.transport.nsw.gov.au/v1'
+      API_ENDPOINT = '/roads/spatial'
+      PARAM_FORMAT = 'geojson'
+      def self.query_string_params(format, table, limit)
+        "?format=#{format}&q=select%20*%20from%20#{table}%20limit%20#{limit}%20"
+      end
+    end
+
+    # Trip Planner API
+    module TripPlannerAPI
+      BASE_URL = 'https://api.np.transport.nsw.gov.au/v1'
+      API_ENDPOINT = '/tp/coord'
+      PARAM_FORMAT = 'rapidJSON'
+      def self.query_string_params(format, coord_lat = '-33.8688', coord_long = '151.2093', coord_radius = '1000')
+        "?outputFormat=#{format}&coord=#{coord_long}%3A#{coord_lat}%3AEPSG%3A4326&inclFilter=1&" +
+        "type_1=GIS_POINT&radius_1=#{coord_radius}&PoisOnMapMacro=true&version=10.2.1.42"
+      end  
+    end
+  end
+end

data/lib/opendata-api/request.rb

@@ -0,0 +1,83 @@
+class OpenDataAPIRequest
+  attr_reader :request, :api_key
+
+  @@api_key = ''
+  @@uri_base = ''
+  @@http_base = ''
+
+  def initialize(http, uri, api_key)
+    @http = http
+    @uri = uri
+    @api_key = api_key
+    @request = self.generate_request_for_api(uri, api_key)
+  end
+
+  def self.api_key()
+    @@api_key
+  end
+
+  def self.set_api_key(api_key)
+    @@api_key = api_key
+  end
+
+  def self.uri_base()
+    @@uri_base
+  end
+
+  def self.set_uri_base(uri_base)
+    @@uri_base = uri_base
+  end
+
+  def self.http_base()
+    @@http_base
+  end
+
+  def self.set_http_base(http_base)
+    @@http_base = http_base
+  end
+
+  def generate_request_for_api(uri, api_key)
+    # puts "Generating Request for URI: #{uri.to_s}\nURI Host/Port: #{uri.host}, #{uri.port}"
+    request = Net::HTTP::Get.new(uri)
+
+    request.initialize_http_header({
+      "Accept" => "application/json",
+      "Content-Type" => "application/json",
+      "Authorization" => "apikey #{api_key}",
+      "User-Agent" => "ruby/net::http"
+    })
+    # puts "Generated Request with Headers: #{request.to_hash.inspect}"
+    request
+  end
+
+  # Fetch specific request
+  def fetch(http_session, request, limit = 10)
+    raise "Too many HTTP redirects" if limit == 0
+    response = http_session.request(request) # Net::HTTPResponse object
+    
+    case response
+    when Net::HTTPSuccess then
+      if response['content-type'] =~ /json/i
+        # puts """Response:\n\t
+        # Code: #{response.code}\n\t
+        # Message: #{response.message}\n\t
+        # Class: #{response.class.name}\n\t
+        # Headers: \n #{JSON.pretty_generate(response.to_hash)}
+        # Body: \n #{JSON.pretty_generate(JSON.parse(response.body))}
+        # """ 
+        # puts "Response code #{response.code} for request to: #{request.uri}"
+        response
+      else
+        raise Exception.new("Only JSON response supported")
+      end
+    when Net::HTTPRedirection then
+      location = response['location']
+      # puts Net::HTTP.get(URI.parse(location))
+      warn "Redirected to #{location}"
+      request = Net::HTTP::Get.new(location)
+      self.fetch(http_session, request, limit - 1)
+    else
+      raise Exception.new("Unsupported HTTP Response #{response.inspect}")
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: opendata-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Schoen
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDdDCCAlygAwIBAgIBATANBgkqhkiG9w0BAQUFADBAMRIwEAYDVQQDDAlsdGZz
+  Y2hvZW4xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTAeFw0xNzEyMjIwNTUxMTVaFw0xODEyMjIwNTUxMTVaMEAxEjAQBgNVBAMMCWx0
+  ZnNjaG9lbjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvvj7phLRWC1L2w4j
+  ZVkfFvZXKo/07aDPvch+oHiHfTwaCnxVrSLAKJmx2TjVrJlVkJfIA9hOhHksWvzJ
+  jihVNhscy1O/6zTP62peu0BVg7PFEGtXqljMSSEKuJOfq33vCp0dVXBZ6mOYebCE
+  0qv5XRNi4pFHLcdccOu3Kt5KKlXPt9QaeLIEvbe6PSLCoP3iuchgVsX0uV/av8U/
+  l983GW73fdiHaSaIAlzOgBlNEEYKk39DE/5JkT7fIQV++KGVcQegQG5xbbwKzXNL
+  cs+FDku1z6iTx5s+dPe5P3vC58YW+JUc+cRLotQDvVwL4SQi/UT4Bpmm20Aa8n6N
+  AAI1KwIDAQABo3kwdzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
+  Na7MnwCNDJXxjxzj4YnsfFJh9mYwHgYDVR0RBBcwFYETbHRmc2Nob2VuQGdtYWls
+  LmNvbTAeBgNVHRIEFzAVgRNsdGZzY2hvZW5AZ21haWwuY29tMA0GCSqGSIb3DQEB
+  BQUAA4IBAQBfQvJI8uICi7Q0aEecxTI69lYW9HWWpkfkcohriNoC2t0DipKUB6vl
+  U12RzmfUctLPDOymMechUgu22FneFFSP0zN1ajehbWDUPNTw/KKW8eL9rsQtbs/4
+  hvd0fQGfAfRBGs2S6OJ78bD/R9elp1nTz0C/hmuKc88DNnVOIizBb/40mjH8FgSO
+  U6WBxl3dGZ/mzbvLKjVpRoG0P1CdhDXkHScpBbAvfLwm2W1wsB2EQckKKIfMWflp
+  ewIPdCDEuyq9+uvAyBA8yqLcFO22IV+tO5sVQlK176dm/YMu/4XahSgWWabxb3M5
+  i1pV9bobg0pMrHjsh9BCO8rI+hKrNudb
+  -----END CERTIFICATE-----
+date: 2017-12-22 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper for Transport for New South Wales (TfNSW) Open Data APIs
+email: ltfschoen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/opendata-api.rb
+- lib/opendata-api/config.rb
+- lib/opendata-api/request.rb
+homepage: https://github.com/ltfschoen/opendata-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: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: OpenData API
+test_files: []