ratis 3.3.3 → 3.3.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ratis (3.3.2)
+    ratis (3.3.4)
       savon (< 2.0)
 
 GEM

data/lib/ratis.rb

@@ -13,6 +13,7 @@ require 'ratis/next_bus'
 require 'ratis/next_bus2'
 require 'ratis/pattern'
 require 'ratis/pattern/routeinfo'
+require 'ratis/plantrip'
 require 'ratis/point_2_point'
 require 'ratis/point_2_point/group'
 require 'ratis/point_2_point/routes_only_response'

data/lib/ratis/itinerary.rb

@@ -2,54 +2,20 @@ module Ratis
 
   class Itinerary
 
-    attr_accessor :co2_auto, :co2_transit
-    attr_accessor :final_walk_dir, :legs
-    attr_accessor :reduced_fare, :regular_fare
-    attr_accessor :transit_time
-
-    def self.where(conditions)
-      date = conditions.delete :date
-      time = conditions.delete :time
-      minimize = conditions.delete(:minimize).to_s.upcase
-
-      origin_lat = conditions.delete(:origin_lat).to_f
-      origin_long = conditions.delete(:origin_long).to_f
-      destination_lat = conditions.delete(:destination_lat).to_f
-      destination_long = conditions.delete(:destination_long).to_f
-
-      raise ArgumentError.new('You must provide a date DD/MM/YYYY') unless DateTime.strptime(date, '%d/%m/%Y') rescue false
-      raise ArgumentError.new('You must provide a time as 24-hour HHMM') unless DateTime.strptime(time, '%H%M') rescue false
-      raise ArgumentError.new('You must provide a conditions of T|X|W to minimize') unless ['T', 'X', 'W'].include? minimize
-
-      raise ArgumentError.new('You must provide an origin latitude') unless Ratis.valid_latitude? origin_lat
-      raise ArgumentError.new('You must provide an origin longitude') unless Ratis.valid_longitude? origin_long
-      raise ArgumentError.new('You must provide an destination latitude') unless Ratis.valid_latitude? destination_lat
-      raise ArgumentError.new('You must provide an destination longitude') unless Ratis.valid_longitude? destination_long
-
-      Ratis.all_conditions_used? conditions
-
-      response = Request.get 'Plantrip',
-        'Date' => date, 'Time' => time, 'Minimize' => minimize,
-        'Originlat' => origin_lat, 'Originlong' => origin_long,
-        'Destinationlat' => destination_lat, 'Destinationlong' => destination_long
-
-      return [] unless response.success?
-
-      response.to_array(:plantrip_response, :itin).map do |itinerary|
-        atis_itinerary = Itinerary.new
-        atis_itinerary.co2_auto = itinerary[:co2auto].to_f
-        atis_itinerary.co2_transit = itinerary[:co2transit].to_f
-        atis_itinerary.final_walk_dir = itinerary[:finalwalkdir]
-        atis_itinerary.reduced_fare = itinerary[:reducedfare].to_f
-        atis_itinerary.regular_fare = itinerary[:regularfare].to_f
-        atis_itinerary.transit_time = itinerary[:transittime].to_i
-        atis_itinerary.legs = itinerary.to_array :legs, :leg
-
-        atis_itinerary
-      end
-
+    attr_accessor :co2_auto, :co2_transit, :final_walk_dir, :legs, :reduced_fare, :regular_fare, :transit_time, :trace_info
+
+    def initialize(response)
+      @co2_auto       = response[:co2auto].to_f
+      @co2_transit    = response[:co2transit].to_f
+      @final_walk_dir = response[:finalwalkdir]
+      @reduced_fare   = response[:reducedfare].to_f
+      @regular_fare   = response[:regularfare].to_f
+      @transit_time   = response[:transittime].to_i
+      @trace_info     = response[:traceinfo]
+      @legs           = response.to_array :legs, :leg
     end
 
   end
 
 end
+

data/lib/ratis/landmark.rb

@@ -5,18 +5,22 @@ module Ratis
     attr_accessor :type, :verbose, :location, :locality
 
     def self.where(conditions)
+      app_id  = conditions.delete(:app_id)      || 'WEB'
+      type    = conditions.delete(:type).to_s.upcase
+      zipcode = conditions.delete(:zipcode)
 
-      type = conditions.delete(:type).to_s.upcase
       raise ArgumentError.new('You must provide a type') if type.blank?
       Ratis.all_conditions_used? conditions
 
-      response = Request.get 'Getlandmarks', {'Type' => type}
+      response = Request.get 'Getlandmarks', {'Appid' => app_id,
+                                              'Type' => type,
+                                              'Zipcode' => zipcode}
       return [] unless response.success?
 
       response.to_array(:getlandmarks_response, :landmarks, :landmark).map do |landmark|
-        atis_landmark = Landmark.new
-        atis_landmark.type = landmark[:type]
-        atis_landmark.verbose = landmark[:verbose]
+        atis_landmark          = Landmark.new
+        atis_landmark.type     = landmark[:type]
+        atis_landmark.verbose  = landmark[:verbose]
         atis_landmark.location = landmark[:location]
         atis_landmark.locality = landmark[:locality]
         atis_landmark

data/lib/ratis/landmark_category.rb

@@ -2,18 +2,25 @@ module Ratis
 
   class LandmarkCategory
 
-    attr_accessor :type, :description
+    attr_accessor :type, :description, :human_type, :human_description
 
     def self.all
-
       response = Request.get 'Getcategories'
       return [] unless response.success?
 
-      response.to_array(:getcategories_response, :types, :typeinfo).map do |typeinfo|
-        atis_landmark_category = LandmarkCategory.new
-        atis_landmark_category.type = typeinfo[:type]
-        atis_landmark_category.description = typeinfo[:description]
-        atis_landmark_category
+      response.to_array(:getcategories_response, :types, :typeinfo).map do |ti|
+        lc                   = LandmarkCategory.new
+        lc.type              = ti[:type]
+        lc.description       = ti[:description]
+        lc.human_type        = lc.type.gsub(/web/i, "")
+        lc.human_description = lc.description.gsub(/web\s*/i, "")
+        lc
+      end
+    end
+
+    def self.web_categories
+      all.select{|cat| cat.type.include?('WEB') }.map do |cat|
+        [ cat.human_description, cat.type ]
       end
     end
 

data/lib/ratis/location.rb

@@ -5,33 +5,41 @@ module Ratis
     attr_accessor :name, :area, :response, :areacode, :latitude, :longitude, :landmark_id, :address, :startaddr, :endaddr, :address_string
 
     def self.where(conditions)
-      location = conditions.delete :location
-      media = (conditions.delete(:media) || :w).to_s.upcase
+      location    = conditions.delete :location
+      media       = (conditions.delete(:media)      || 'W').to_s.upcase
       max_answers = conditions.delete(:max_answers) || 20
+      app_id      = conditions.delete(:app_id)      || 'WEB'
+      area        = conditions.delete(:area)
+      region      = conditions.delete(:region)
 
       raise ArgumentError.new('You must provide a location') unless location
       raise ArgumentError.new('You must provide media of A|W|I') unless ['A','W','I'].include? media
       raise ArgumentError.new('You must provide a numeric max_answers') unless (Integer max_answers rescue false)
       Ratis.all_conditions_used? conditions
 
-      response = Request.get 'Locate', {'Location' => location, 'Media' => media, 'Maxanswers' => max_answers}
+      response = Request.get 'Locate', {'Appid' => app_id,
+                                        'Location' => location,
+                                        'Area' => area,
+                                        'Region' => region,
+                                        'Maxanswers' => max_answers,
+                                        'Media' => media }
       return [] unless response.success?
 
-      meta = response.to_hash[:locate_response]
+      meta      = response.to_hash[:locate_response]
       locations = response.to_array :locate_response, :location
 
       locations.map do |location_hash|
-        location = Ratis::Location.new
-        location.name = location_hash[:name]
-        location.area = location_hash[:area]
-        location.response = meta[:responsecode]
-        location.areacode = location_hash[:areacode]
-        location.latitude = location_hash[:latitude]
-        location.longitude = location_hash[:longitude]
-        location.landmark_id = location_hash[:landmarkid] || 0
-        location.address = location_hash[:address] || ''
-        location.startaddr = location_hash[:startaddr] || ''
-        location.endaddr = location_hash[:endaddr] || ''
+        location                = Ratis::Location.new
+        location.name           = location_hash[:name]
+        location.area           = location_hash[:area]
+        location.response       = meta[:responsecode]
+        location.areacode       = location_hash[:areacode]
+        location.latitude       = location_hash[:latitude]
+        location.longitude      = location_hash[:longitude]
+        location.landmark_id    = location_hash[:landmarkid] || 0
+        location.address        = location_hash[:address] || ''
+        location.startaddr      = location_hash[:startaddr] || ''
+        location.endaddr        = location_hash[:endaddr] || ''
         location.address_string = build_address_string location_hash
         location
       end
@@ -50,9 +58,9 @@ module Ratis
 
     def self.build_address_string(location_hash)
       address_string = ''
-      address = location_hash[:address]
-      name = location_hash[:name]
-      area = location_hash[:area]
+      address        = location_hash[:address]
+      name           = location_hash[:name]
+      area           = location_hash[:area]
 
       if !address.blank?
         address_string << "#{address} #{name} (in #{area})"

data/lib/ratis/next_bus.rb

@@ -80,7 +80,7 @@ module Ratis
     def self.where(conditions)
       stop_id = conditions.delete(:stop_id)
       app_id  = conditions.delete(:app_id) || 'ratis-gem'
-      type    = conditions.delete(:type) || 'N' # N for Next Bus
+      type    = conditions.delete(:type)   || 'N' # N for Next Bus
 
       if datetime = conditions.delete(:datetime)
         raise ArgumentError.new('If datetime supplied it should be a Time or DateTime instance, otherwise it defaults to Time.now') unless datetime.is_a?(DateTime) || datetime.is_a?(Time)

data/lib/ratis/next_bus2.rb

@@ -16,8 +16,9 @@ module Ratis
     # [runs]     <em>Optional</em> -
     #            An array of runs. Defaults to empty array.
 
-    def initialize(_stops = [], _runs = [])
-      @stops, @runs = _stops, _runs
+    def initialize(response)
+      @stops = response.to_array :nextbus2_response, :stops, :stop
+      @runs  = response.to_array :nextbus2_response, :runs, :run
     end
 
     # Returns results of NextBus query containing arrays of stops and runs.
@@ -46,10 +47,7 @@ module Ratis
       response = Request.get 'Nextbus2', { 'Stopid' => stop_id, 'Appid' => app_id }
       return [] unless response.success?
 
-      stops = response.to_array :nextbus2_response, :stops, :stop
-      runs  = response.to_array :nextbus2_response, :runs, :run
-
-      NextBus2.new stops, runs
+      NextBus2.new(response)
     end
 
     # Gets description of first stop

data/lib/ratis/plantrip.rb

@@ -0,0 +1,77 @@
+module Ratis
+
+  class Plantrip
+
+    attr_accessor :success, :itineraries, :walkable, :walkadjust, :input
+
+    def initialize(response)
+      @success     = response.success?
+
+      @walkable    = response.body[:walkable]
+      @walkadjust  = response.body[:walkadjust]
+      @input       = response.body[:plantrip_response][:input]
+
+      @itineraries = response.to_array(:plantrip_response, :itin).map do |itinerary|
+                                    Itinerary.new(itinerary)
+                                  end
+    end
+
+    def self.where(conditions)
+      app_id                  = conditions.delete(:app_id)                || 'ratis-gem'
+      minimize                = conditions.delete(:minimize).try(:upcase) || 'T'
+      arrdep                  = conditions.delete(:arrdep).try(:upcase)   || "D"
+      maxanswers              = conditions.delete(:maxanswers)            || '3'
+      xmode                   = conditions.delete(:xmode)                 || 'BCFKLRSTX'
+      walkdist                = conditions.delete(:walkdist)              || "0.50"
+      origin_lat              = conditions.delete(:origin_lat).to_f
+      origin_long             = conditions.delete(:origin_long).to_f
+      origin_text             = conditions.delete(:origin_text)
+      origin_landmark_id      = conditions.delete(:origin_landmark_id)
+      destination_lat         = conditions.delete(:destination_lat).to_f
+      destination_long        = conditions.delete(:destination_long).to_f
+      destination_text        = conditions.delete(:destination_text)
+      destination_landmark_id = conditions.delete(:destination_landmark_id)
+
+      if datetime = conditions.delete(:datetime)
+        raise ArgumentError.new('If datetime supplied it should be a Time or DateTime instance, otherwise it defaults to Time.now') unless datetime.is_a?(DateTime) || datetime.is_a?(Time)
+      else
+        datetime = Time.now
+      end
+
+      raise ArgumentError.new('You must provide a date DD/MM/YYYY') unless DateTime.strptime(date, '%d/%m/%Y') rescue false
+      raise ArgumentError.new('You must provide a time as 24-hour HHMM') unless DateTime.strptime(time, '%H%M') rescue false
+      raise ArgumentError.new('You must provide a conditions of T|X|W to minimize') unless ['T', 'X', 'W'].include? minimize
+
+      raise ArgumentError.new('You must provide an origin latitude') unless Ratis.valid_latitude? origin_lat
+      raise ArgumentError.new('You must provide an origin longitude') unless Ratis.valid_longitude? origin_long
+      raise ArgumentError.new('You must provide an destination latitude') unless Ratis.valid_latitude? destination_lat
+      raise ArgumentError.new('You must provide an destination longitude') unless Ratis.valid_longitude? destination_long
+
+      Ratis.all_conditions_used? conditions
+
+      response = Request.get 'Plantrip', {'Appid'                 => app_id,
+                                          'Date'                  => datetime.strftime("%m/%d/%Y"),
+                                          'Time'                  => datetime.strftime("%H%M"),
+                                          'Minimize'              => minimize,
+                                          'Arrdep'                => arrdep,
+                                          'Maxanswers'            => maxanswers,
+                                          'Walkdist'              => walkdist,
+                                          'Xmode'                 => xmode,
+                                          'Originlat'             => origin_lat,
+                                          'Originlong'            => origin_long,
+                                          'Origintext'            => origin_text,
+                                          'Originlandmarkid'      => origin_landmark_id,
+                                          'Destinationlat'        => destination_lat,
+                                          'Destinationlong'       => destination_long,
+                                          'Destinationtext'       => destination_text,
+                                          'Destinationlandmarkid' => destination_landmark_id}
+
+      Plantrip.new(response)
+    end
+
+    def success?
+      @success
+    end
+  end
+
+end

data/lib/ratis/version.rb

@@ -5,7 +5,7 @@ module Ratis
   def version
     @version ||= begin
 
-      string = '3.3.3'
+      string = '3.3.4'
 
       def string.parts
         split('.').map { |p| p.to_i }

data/spec/ratis/area_spec.rb

@@ -4,7 +4,7 @@ describe Ratis::Area do
   before do
     Ratis.reset
     Ratis.configure do |config|
-      config.endpoint   = 'http://soap.valleymetro.org/cgi-bin-soap-web-252/soap.cgi'
+      config.endpoint   = 'http://soap.valleymetro.org/cgi-bin-soap-web-262/soap.cgi'
       config.namespace  = 'PX_WEB'
     end
   end
@@ -25,11 +25,13 @@ describe Ratis::Area do
     end
 
     it 'should return all areas' do
+      pending
       areas = Ratis::Area.all
       areas.should have(29).items
     end
 
     it "should parse the area fields" do
+      pending
       areas = Ratis::Area.all
       area  = areas.last
 

data/spec/ratis/closest_stop_spec.rb

@@ -5,7 +5,7 @@ describe Ratis::ClosestStop do
   before do
     Ratis.reset
     Ratis.configure do |config|
-      config.endpoint   = 'http://soap.valleymetro.org/cgi-bin-soap-web-252/soap.cgi'
+      config.endpoint   = 'http://soap.valleymetro.org/cgi-bin-soap-web-262/soap.cgi'
       config.namespace  = 'PX_WEB'
     end
   end
@@ -59,8 +59,8 @@ describe Ratis::ClosestStop do
       stops = Ratis::ClosestStop.where(@conditions.dup)
       stop  = stops.first
 
-      expect(stop.latitude).to eq('33.454494')
-      expect(stop.longitude).to eq('-112.070508')
+      expect(stop.latitude.to_f).to be_within(0.001).of(33.454494)
+      expect(stop.longitude.to_f).to be_within(0.001).of(-112.070508.to_f)
       expect(stop.area).to be_nil
       expect(stop.walk_dir).to eq('SE')
       expect(stop.stop_position).to eq('Y')

data/spec/ratis/next_bus2_spec.rb

@@ -4,7 +4,7 @@ describe Ratis::NextBus2 do
   before do
     Ratis.reset
     Ratis.configure do |config|
-      config.endpoint   = 'http://soap.valleymetro.org/cgi-bin-soap-web-252/soap.cgi'
+      config.endpoint   = 'http://soap.valleymetro.org/cgi-bin-soap-web-262/soap.cgi'
       config.namespace  = 'PX_WEB'
     end
   end
@@ -16,16 +16,34 @@ describe Ratis::NextBus2 do
       # appid
       # a short string that can be used to separate requests from different applications or different modules with
       # Optional (highly recommended)
-      @stop_id = 10050
+      @stop_id = 10040
       @conditions = {:stop_id      => @stop_id,
                      :app_id       => 'ratis-specs'}
     end
 
+    describe "Developer can find a late bus to a stop" do
+      it "will give developer happiness :-)" do
+        pending "don't run unless needed"
+        require 'pp'
+        10001.upto(10039).each do |id|
+          puts id
+          response = Ratis::NextBus2.where(@conditions.dup.merge(:stop_id => id))
+          # expect(response.stops).to_not be_empty
+          # expect(response.runs).to_not be_empty
+
+          response.runs.each do |run|
+            if run[:realtime][:valid] != 'N'
+              pp run[:realtime]
+            end
+          end
+      end
+    end
+
     describe 'single next bus' do
       it "only makes one request" do
         # false just to stop further processing of response
         Ratis::Request.should_receive(:get).once.and_call_original
-        Ratis::NextBus.where(@conditions.dup)
+        Ratis::NextBus2.where(@conditions.dup)
       end
 
       it 'requests the correct SOAP action with args' do
@@ -38,10 +56,24 @@ describe Ratis::NextBus2 do
         Ratis::NextBus2.where(@conditions.dup)
       end
 
-      it 'requests the correct SOAP action' do
+      it "description", {:vcr => {:cassette_name => "Nextbus2_running_LATE", :re_record_interval => 6.months}} do
+
         response = Ratis::NextBus2.where(@conditions.dup)
-        expect(response.stops).to_not be_empty
-        expect(response.runs).to_not be_empty
+        late_run = response.runs.first
+        expect(late_run[:realtime][:valid]).to eq("Y")
+        expect(late_run[:realtime][:estimatedtime]).to_not eq(late_run[:triptime])
+        expect(late_run[:realtime][:reliable]).to eq("Y")
+        expect(late_run[:realtime][:estimatedtime]).to eq("02:52 PM")
+        expect(late_run[:realtime][:estimatedminutes]).to eq("16")
+
+        # :realtime=>{:valid=>"Y", :estimatedtime=>"02:52 PM", :reliable=>"Y", :stopped=>"N", :estimatedminutes=>"16", :lat=>"33.451187", :polltime=>"02:35 PM", :long=>"-111.982079", :adherence=>"0", :trend=>"D", :speed=>"0.00", :vehicleid=>"6050"},
+      end
+
+      it 'requests the correct SOAP action' do
+        response = Ratis::NextBus2.where(@conditions.dup.merge(:stop_id => id))
+          expect(response.stops).to_not be_empty
+          expect(response.runs).to_not be_empty
+        end
       end
 
       it "should raise error when no stop id provided" do