mybustracker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e485184e0c61f0acea90948b5a905cfac6985f00
-  data.tar.gz: '06593b9b4fa21e9d7d2f1f5c49b71aa413f6168f'
+  metadata.gz: 54a03b29fb608175ede8ece1d2edd85a90fdf3df
+  data.tar.gz: b9fee2a737759b20a6c0b830db3f0e5e40329f08
 SHA512:
-  metadata.gz: 3d4f85c5063bc643bd1c27c8f7b0f8a1af0fcd8a3fe2699ae334a6b9cb2ca67af17505d3a95600b6205066a73924cc6eae13242d3ebdf9358c487fd8ef9c783b
-  data.tar.gz: 2092051f1aa751d9b945e70512ae248e81a1787ad7b5f400be5c207987558e0848c2616d5653e957f773e53119886851b1037009a6024917ee7feb1e5b66fef7
+  metadata.gz: 416ab8ca11c80f68f38d38ac40a8b8a03d6149988d4737612ff892405db1df1220d4fc7000f86e4c7892d7bb5ec8b0189cfa2f588f003507cc52873aaed7397b
+  data.tar.gz: df8b09df88105badb3f94c01593b0b9a058997ffc819181ada379935ef8791b422fcbf2dab481bdc3630739dca2395b39500378b64e4b5dfdcf4f0f779dd5c13

data/lib/mybustracker.rb

@@ -4,11 +4,194 @@
 
 require 'savon'
 require 'digest'
+require 'subunit'
+require 'geocoder'
+require 'geodesic'
+
 
 class MyBusTrackerException < Exception
+  
+  class Service < Exception
+  end
+
 end
 
+
 class MyBusTracker
+  
+  class Service
+    
+    attr_reader :ref, :operator, :number, :name, :bus_stops
+    
+    def initialize(client, appkey, service, all_dests, 
+                   all_bus_stops, number='')
+      
+      if number.empty? then
+        raise MyBusTrackerException::Service, 'provide a bus service number'
+      end
+      
+      @client, @appkey = client, appkey
+      
+      # find out the reference number from the service hash object      
+
+      #e.g. => {:ref=>"7", :operator_id=>"LB", :mnemo=>"4", :name=>"The Jewel
+      #-- Hillend", :type=>nil, :dests=>{:list=>["458752", ...]}
+      
+      @number, @name, @ref, relative_dests, operator  = \
+          %i(mnemo name ref dests operator).map {|field| service[field]}
+      
+      @all_bus_stops = all_bus_stops
+
+      
+    end
+    
+    # accepts a bus service number and returns the relative bus times
+    #
+    def query(times: 'next hour', from: nil, to: nil)
+      
+      #from ||=
+      
+      start_bus_stop1, start_bus_stop2 = find_bus_stop(from)
+      end_bus_stop1, end_bus_stop2 = find_bus_stop(to)
+      
+      # get the bus times
+      
+      @bus_stops, journey_times = get_stop_journeys(start_bus_stop1)
+
+      # select the bus stop end
+      
+      end_stop = journey_times.find do |x| 
+        x[:stop_id] == end_bus_stop1[:stop_id] or x[:stop_id] == end_bus_stop2[:stop_id]
+      end
+            
+      if end_stop then
+        start_bus_stop = start_bus_stop1
+      else
+        start_bus_stop = start_bus_stop2
+        @bus_stops, journey_times = get_stop_journeys(start_bus_stop2) unless end_stop
+        return unless @bus_stops
+        # select the bus stop end
+
+        end_stop = journey_times.find do |x|
+          (x[:stop_id] == end_bus_stop1[:stop_id]) or (x[:stop_id] == end_bus_stop2[:stop_id])
+        end
+        
+      end
+
+      tstart = Time.strptime(journey_times[0][:time],"%H:%M")
+      tend = Time.strptime(end_stop[:time],"%H:%M")
+      travel_time = '~' + Subunit.new(units={minutes:60, hours:60}, \
+                                 seconds: tend - tstart).to_s(omit: [:seconds])
+      
+      {
+        from: {bus_stop: start_bus_stop[:name], bus_stop_id: start_bus_stop[:stop_id]},
+        to: {bus_stop: end_stop[:stop_name], bus_stop_id: end_stop[:stop_id]},
+        start: journey_times[0][:time], 
+        end: end_stop[:time],
+        travel_time: travel_time
+      }
+      
+    end
+    
+    private    
+    
+    def find_bus_stop(address)
+      
+      results = Geocoder.search(address.sub(/,? *edinburgh$/i,'') \
+                                + ", Edinburgh")
+      
+      p1    = Geodesic::Position.new(*results[0].coordinates)
+
+      a = @all_bus_stops.sort_by do |h|
+        
+        x, y = %i(x y).map {|fields| h[fields].to_f.round(4)}
+
+        p2 = Geodesic::Position.new(x, y)
+        d = Geodesic::dist_haversine(p1.lat, p1.lon, p2.lat, p2.lon).round(4)
+      end
+      a.take 2
+            
+    end
+    
+    def get_stop_journeys(start_bus_stop)
+      
+      response = @client.call(:get_bus_times, message: { key: @appkey, time_requests: {list: [{stop_id: start_bus_stop[:stop_id] }]} })
+      
+      bus_times = response.body[:bus_times_response][:bus_times][:list].find do |bus_time|
+        bus_time[:ref_service] == @ref
+      end
+      
+      #e.g.r.keys  => [:operator_id, :stop_id, :stop_name, :ref_service, :mnemo_service, :name_service, 
+      # :time_datas, :global_disruption, :service_disruption, :bus_stop_disruption, :service_diversion]
+      
+      return unless bus_times
+      
+      # get the 1st journey id
+      list = bus_times[:time_datas][:list]
+      journey_id = list.is_a?(Array) ? list[0][:journey_id] : list[:journey_id]
+      
+      response = @client.call(:get_journey_times, message: { key: @appkey, journey_id: journey_id,  stop_id: start_bus_stop[:stop_id]  })
+      journey = response.body[:journey_times_response][:journey_times][:list]
+#=> [:journey_id, :bus_id, :operator_id, :ref_service, :mnemo_service, :name_service, :ref_dest, :name_dest, :terminus, :journey_time_datas, :global_disruption, :service_disruption, :service_diversion] 
+
+      journey_times = journey[:journey_time_datas][:list]
+      # get the bus stops
+      [journey_times.inject({}) {|r,x| r.merge(x[:stop_name] => {id: x[:stop_id]}) }, journey_times]
+    end
+    
+    # method no longer used
+    #
+    def fetch_bus_stops2()
+      # find the outbound destination
+      dest = relative_dests[:list].find do |ref|
+        all_dests.find {|x| x[:ref] == ref and x[:direction] == 'R' }
+      end      
+      
+      # go through each bus stop to find the dests
+
+      raw_bus_stops = all_bus_stops.select do |bus_stop|
+        bus_stop[:dests][:list].include? dest
+      end
+
+      c = ->(coord){ coord.to_f.round(4)}      
+      
+      response = client.call(:get_service_points, message: \
+                             { key: appkey, ref: ref  })
+      all_service_points = response.body[:service_points_response]\
+          [:service_points][:list]      
+      
+      # select only the 1st chain
+      #service_points = all_service_points#.group_by {|x| x[:chainage]}.first[-1]
+      #puts 'service_points: ' + service_points.inspect
+      
+      unsorted_bus_stops = []
+      raw_bus_stops.each do |bus_stop|
+
+        x, y = %i(x y).map {|field| bus_stop[field]}.map(&c)
+
+        r = all_service_points.select do |point|
+          [point[:x], point[:y]].map(&c) == [x, y]
+        end
+
+        r.each do |x|
+          unsorted_bus_stops << [bus_stop[:name], bus_stop[:stop_id], x, x[:order].to_i ]
+        end
+
+      end
+
+      
+      #@bus_stops = unsorted_bus_stops.compact.sort_by(&:last)
+#=begin      
+      # find the correct chainage by the most records
+      h = unsorted_bus_stops.group_by {|x| x[2][:chainage]}
+      a = h.map {|k,v| v.count {|x| x[2][:chainage] == k}}      
+      
+      @bus_stops = h.to_a[a.index(a.max)].last\
+          .sort_by(&:last).inject({}){|r, x| r.merge(x[0] => {id: x[1]}) }
+#=end            
+    end
+    
+  end
 
 
   def initialize(api_key: '')
@@ -16,7 +199,7 @@ class MyBusTracker
 
     raise MyBusTrackerException, 'api_key missing' if api_key.empty?
 
-    @client = Savon.client(wsdl: 'http://ws.mybustracker.co.uk/?wsdl')
+    @client = client = Savon.client(wsdl: 'http://ws.mybustracker.co.uk/?wsdl')
 
     #@client.operations
 
@@ -24,23 +207,37 @@ class MyBusTracker
     #    :get_bus_stops, :get_bus_times, :get_journey_times, :get_disruptions, 
     #    :get_diversions, :get_diversion_points]  
 
-    @appkey = Digest::MD5.hexdigest( api_key + Time.now.strftime("%Y%m%d%H"))
+    @appkey = appkey = Digest::MD5.hexdigest( api_key + 
+                                              Time.now.strftime("%Y%m%d%H"))
+    
+    response = client.call(:get_services, message: { key: appkey  })
+    @all_services= response.body[:services_response][:services][:list]
+    
+    response = client.call(:get_dests, message: { key: appkey  })
+    @all_dests = response.body[:dests_response][:dests][:list]
+    
+    response = client.call(:get_bus_stops, message: { key: appkey  })
+    @all_bus_stops = response.body[:bus_stops_response][:bus_stops][:list]
 
 
   end
 
+  # returns the number and name of all bus services
+  #
   def services()
 
-    # call the get_services operation
-    response = @client.call(:get_services, message: { key: @appkey  })
-    r = response.body
-
-    a = r[:services_response][:services][:list].map do |x| 
-      [x[:mnemo], x[:name]]
-    end
-
-    a.to_h
+    @all_services.map {|x| [x[:mnemo], x[:name]] }.to_h
 
   end
+  
+  # accepts a bus service number and returns the relative bus times
+  #
+  def service(number='')
+    
+    service = @all_services.find {|x| x[:mnemo] == number }        
+    Service.new @client, @appkey, service, @all_dests, @all_bus_stops, number
+    
+  end
+    
+  
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mybustracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Robertson
@@ -53,6 +53,66 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.11.2
+- !ruby/object:Gem::Dependency
+  name: subunit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: geodesic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: 
 email: james@jamesrobertson.eu
 executables: []
@@ -83,6 +143,6 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: "*Currently under development*. An unoficial gem to query the mybustracker.co.uk
+summary: "*Currently under development*. An unofficial gem to query the mybustracker.co.uk
   web service for bus times etc. #edinburgh"
 test_files: []