ratis 3.4.3 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38bc48975296b0233d4edc70fa1cf91f209c18da
-  data.tar.gz: 1338c06d87b19f9df12c221aad2af9de5e10f6be
+  metadata.gz: 282d28c9d2eeafb0d0751b298c7b95f66883674c
+  data.tar.gz: ac3a46211cb5f393f6d9b218d141726cd4d94643
 SHA512:
-  metadata.gz: fea762beb8e8eb943cf17ea526fb75455bd90e8fa474c2d556571d504e0daa36f2524f207cf41b113f8529fe48fba0a316074526de40efa283129d9467bae556
-  data.tar.gz: bf018a86ed61ebe423a747aa15b5bf8854533d819eeafe46a9c98655ef3c3129866c6472b155615e010716098e1ddb2a0ba9bcc086e04e370aeb021b7c47a8b3
+  metadata.gz: 44d8bf2bb1f431e448fc6b4d91c4c461de8571ede8ed6306332b922a00a951acd459a0f2300ac0a32a1c723f6de4cf3b54a654c01c96e3524f4b513ed7c7805e
+  data.tar.gz: 357ff7d97e92bf572f3cba14433d4221801de2b1f055d1aa570d7b5c5aed1793933726c973c2c734af9259145924794eb8730539eb21c22fcc02f540607b74bb

data/.ruby-gemset

@@ -0,0 +1 @@
+ratis

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p451

data/CHANGELOG

@@ -1,57 +1,58 @@
-3.1
-- The NextBus class was really using the Nextbus2 api call all along.  This was pretty confusing, so 2 seperate classes now exist; one for NextBus and NextBus2.  This means any code using NextBus prior to 3.1 will break since it was really calling the Nextbus2 api and we've updated it so the class of matching name is calling the matching api method.
-- Dev dependencies of chronic and rspec-instafail were also added to aid testing
+3.5.0
+- Updated all tests to work against ATIS 2.7.1
+- Added Ratis.config required option: Appid. Appid is now sent with all ATIS requests.
 
-3.1.1
-- spec updates, and general tidy
+3.4.2
+- added support for ATIS ver 2.7.1's Fleetlocation api
 
-3.1.2
-- NextBus#stop added
-- Contains info about the stop (:side, :stopid, :heading, :lat, :area, :servicetype, :route, :operator)
+3.4.1
+- regeneration of gem to fix missing files
 
-3.1.3
-- Turns out that in the NextBus calls the <service> tag can come back as either a single node or list of nodes.  In one case savon turns this into an array, in the other case it's just a single entity.  Rewrote NextBus.where to handle these two cases, this also means NextBus would never really represent a single service.  Created a NextBus.services method that returns all these entities in a similar manner.  Update test specs
+3.4 (3/11/14)
+- added location type ahead support
+- added test spec for location type ahead support
 
-3.1.4
-- Bug Fix: NextBus trips returned can be an array or a single hash
+3.3.7
+- all tests now use VCR
+- fixes for failing tests
+- changed itinerary_spec to plantrip_spec
+- created new empty itinerary_spec as stub
+- changed walk_spec to walkstop_spec
 
-3.1.5
-- Bug Fix: NextBus where was incorrectly sending Time in 12 hour format when ATIS needs it in 24 hour format.
+3.3.5
+- Refactored Ratis::Location to be usable in Trip Planner
 
-3.1.6
-- Added field 'sign' to Ratis::Timetable::Trip, this is the headsign for a bus running a given trip
+3.2.1
+- Timetable::Trip now contains the trip's headsign
 
-3.1.7
-- Removed to_hash, instead use better named to_hash_for_xml for use with NextRide SMS service end-point
+3.2.0
+- When querying Nextbus for a Light Rail stop, in most cases you will actually get back 2 stops for a single NextRide ID.  One for each side of the stop platform.  Made changes to handle this case.  Both stops services are flattened into the #services attribute.
 
 3.1.8
 - Within to_hash_from_xml, pull route and sign attributes from the service instead of the realtime info (they always seem to be blank)
 
-3.2.0
-- When querying Nextbus for a Light Rail stop, in most cases you will actually get back 2 stops for a single NextRide ID.  One for each side of the stop platform.  Made changes to handle this case.  Both stops services are flattened into the #services attribute.
+3.1.7
+- Removed to_hash, instead use better named to_hash_for_xml for use with NextRide SMS service end-point
 
-3.2.1
-- Timetable::Trip now contains the trip's headsign
+3.1.6
+- Added field 'sign' to Ratis::Timetable::Trip, this is the headsign for a bus running a given trip
 
-3.3.5
-- Refactored Ratis::Location to be usable in Trip Planner
+3.1.5
+- Bug Fix: NextBus where was incorrectly sending Time in 12 hour format when ATIS needs it in 24 hour format.
 
-3.3.7
-- all tests now use VCR
-- fixes for failing tests
-- changed itinerary_spec to plantrip_spec
-- created new empty itinerary_spec as stub
-- changed walk_spec to walkstop_spec
+3.1.4
+- Bug Fix: NextBus trips returned can be an array or a single hash
 
-3.4 (3/11/14)
-- added location type ahead support
-- added test spec for location type ahead support
+3.1.3
+- Turns out that in the NextBus calls the <service> tag can come back as either a single node or list of nodes.  In one case savon turns this into an array, in the other case it's just a single entity.  Rewrote NextBus.where to handle these two cases, this also means NextBus would never really represent a single service.  Created a NextBus.services method that returns all these entities in a similar manner.  Update test specs
 
-3.4.1
-- regeneration of gem to fix missing files
+3.1.2
+- NextBus#stop added
+- Contains info about the stop (:side, :stopid, :heading, :lat, :area, :servicetype, :route, :operator)
 
-3.4.2
-- added support for ATIS ver 2.7.1's Fleetlocation api
+3.1.1
+- spec updates, and general tidy
 
-3.4.3
-- removed to_hash method on nextbus2.  is called from to_json calls in Routes app and throwing exceptions
+3.1
+- The NextBus class was really using the Nextbus2 api call all along.  This was pretty confusing, so 2 seperate classes now exist; one for NextBus and NextBus2.  This means any code using NextBus prior to 3.1 will break since it was really calling the Nextbus2 api and we've updated it so the class of matching name is calling the matching api method.
+- Dev dependencies of chronic and rspec-instafail were also added to aid testing

data/README.md

@@ -31,6 +31,7 @@ Gem installation
 
         require 'ratis/config'
         Ratis.configure do |config|
+          config.appid = '(YOUR APP ID)'
           config.endpoint = 'http://(YOUR ENDPOINT URL)'
           config.namespace = '(YOUR NAMESPACE)'
           config.proxy = 'http://localhost:8080'
@@ -44,21 +45,6 @@ NOTE ABOUT VERSIONS
 -------------------
 The versioning strategy for Ratis gem is the major, minor, and build components are set to match the ATIS version you are running. At the time of this edit, ATIS version 2.5.2 is matched with Ratis gem version 2.5.2.x. The last component is the patch version of the gem. This is the number that increases as we add feature from a particular ATIS version.
 
-  1. Add the following configuration block.
-
-     This must happen before Ratis is `require`d (before `Rails::Initializer.run` in a Rails app).
-
-        require 'ratis/config'
-        Ratis.configure do |config|
-          config.endpoint = 'http://(YOUR ENDPOINT URL)'
-          config.namespace = '(YOUR NAMESPACE)'
-          config.proxy = 'http://localhost:8080'
-          config.timeout = 5
-        end
-
-     If Ratis is `require`d prior to this config being set you will get a `RuntimeError` informing you so.
-     If the provided `endpoint` is invalid an `ArgumentError: Invalid URL: bad URI` will be thrown, but only when a request is made.
-
 Gem usage
 -------------------
 

data/lib/ratis/area.rb

@@ -5,7 +5,7 @@ module Ratis
     attr_accessor :area, :description
 
     def self.all
-      response = Request.get('Getareas')
+      response = Request.get 'Getareas'
 
       return [] unless response.success?
 

data/lib/ratis/config.rb

@@ -2,12 +2,10 @@ module Ratis
 
   class Config
 
-    attr_accessor :endpoint, :namespace, :proxy, :timeout, :log, :log_level
+    attr_accessor :appid, :endpoint, :log, :log_level, :namespace, :proxy, :timeout
 
     def valid?
-      return false if endpoint.nil? or namespace.nil?
-      return false if endpoint.empty? or namespace.empty?
-      true
+      !(endpoint.nil? || endpoint.empty? || namespace.nil? || namespace.empty? || appid.nil? || appid.empty?)
     end
 
   private

data/lib/ratis/fleet_location.rb

@@ -24,19 +24,14 @@ module Ratis
 
   class FleetLocation
 
-    def self.current(conditions)
-      app_id  = conditions.delete(:app_id) || 'WEB'
-
-      response = Request.get 'Fleetlocation', {'Appid' => app_id}
+    def self.current
+      response = Request.get 'Fleetlocation'
 
       return [] unless response.success?
 
       response.to_array(:fleetlocation_response, :vehicles, :vehicle).map do |vehicle|
         Vehicle.new(vehicle)
       end
-
     end
-
   end
-
 end

data/lib/ratis/landmark.rb

@@ -12,16 +12,13 @@ module Ratis
     end
 
     def self.where(conditions)
-      app_id  = conditions.delete(:app_id) || 'WEB'
       type    = conditions.delete(:type).to_s.upcase
       zipcode = conditions.delete(:zipcode)
 
       raise ArgumentError.new('You must provide a type') if type.blank?
       Ratis.all_conditions_used? conditions
 
-      response = Request.get 'Getlandmarks', {'Appid'   => app_id,
-                                              'Type'    => type,
-                                              'Zipcode' => zipcode}
+      response = Request.get 'Getlandmarks', { 'Type' => type, 'Zipcode' => zipcode }
 
       return [] unless response.success?
 

data/lib/ratis/location.rb

@@ -28,7 +28,6 @@ module Ratis
       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)
 
@@ -38,8 +37,7 @@ module Ratis
 
       Ratis.all_conditions_used? conditions
 
-      response = Request.get 'Locate', {'Appid'      => app_id,
-                                        'Location'   => location,
+      response = Request.get 'Locate', {'Location'   => location,
                                         'Area'       => area,
                                         'Region'     => region,
                                         'Maxanswers' => max_answers,

data/lib/ratis/location_type_ahead.rb

@@ -4,14 +4,11 @@ module Ratis
 
     def self.where(conditions={})
       search_text = conditions.delete(:search)
-      app_id      = conditions.delete(:app_id) || 'WEB'
-
       raise ArgumentError.new('You must provide some search text') unless search_text
 
       Ratis.all_conditions_used? conditions
 
-      response = Request.get 'Locationtypeahead', {'Appid' => app_id,
-                                                   'Search' => search_text.downcase}
+      response = Request.get 'Locationtypeahead', { 'Search' => search_text.downcase }
 
       return "" unless response.success?
 

data/lib/ratis/next_bus.rb

@@ -79,7 +79,6 @@ 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
 
       if datetime = conditions.delete(:datetime)
@@ -93,7 +92,6 @@ module Ratis
       Ratis.all_conditions_used?(conditions)
 
       response = Request.get 'Nextbus', {'Stopid' => stop_id,
-                                         'Appid' => app_id,
                                          'Date' => datetime.strftime("%m/%d/%Y"),
                                          'Time' => datetime.strftime("%H%M"),
                                          'Type' => type }

data/lib/ratis/next_bus2.rb

@@ -39,12 +39,10 @@ module Ratis
 
     def self.where(conditions)
       stop_id = conditions.delete :stop_id
-      app_id  = conditions.delete(:app_id) || 'ratis-gem'
-
       raise ArgumentError.new('You must provide a stop ID') unless stop_id
       Ratis.all_conditions_used? conditions
 
-      response = Request.get 'Nextbus2', { 'Stopid' => stop_id, 'Appid' => app_id }
+      response = Request.get 'Nextbus2', { 'Stopid' => stop_id }
       return [] unless response.success?
 
       NextBus2.new(response)

data/lib/ratis/plantrip.rb

@@ -17,7 +17,6 @@ module Ratis
     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'
@@ -49,8 +48,7 @@ module Ratis
 
       Ratis.all_conditions_used? conditions
 
-      response = Request.get 'Plantrip', {'Appid'                 => app_id,
-                                          'Date'                  => datetime.strftime("%m/%d/%Y"),
+      response = Request.get 'Plantrip', {'Date'                  => datetime.strftime("%m/%d/%Y"),
                                           'Time'                  => datetime.strftime("%H%M"),
                                           'Minimize'              => minimize,
                                           'Arrdep'                => arrdep,

data/lib/ratis/request.rb

@@ -6,8 +6,8 @@ module Ratis
 
     def initialize(config = nil)
       config = Ratis.config if config.nil?
-      raise Errors::ConfigError('It appears that Ratis.configure has not been called') unless config.valid?
-      
+      raise Errors::ConfigError('It appears that Ratis.configure has not been called or properly setup') unless config.valid?
+
       self.class.client do
         wsdl.endpoint     = Ratis.config.endpoint
         wsdl.namespace    = Ratis.config.namespace
@@ -22,6 +22,9 @@ module Ratis
       begin
         raise Errors::ConfigError, 'It appears that Ratis.configure has not been called or properly setup' unless Ratis.config.valid?
 
+        # Merge in the Appid as set in the configuration.
+        params.merge!({ 'Appid' => Ratis.config.appid })
+
         # ClassMethods from Savon::Model
         # Necessary since calling Ratis.configure doesn't allow changing of values set during Savon initialization
         # Savon memoizes the client config

data/lib/ratis/schedule_nearby.rb

@@ -13,7 +13,6 @@ module Ratis
       walk_distance = conditions.delete(:walk_distance)
       landmark_id   = conditions.delete(:landmark_id)
       stop_id       = conditions.delete(:stop_id) || ''
-      app_id        = conditions.delete(:app_id) || 'ratis-gem'
 
       raise ArgumentError.new('You must provide latitude') unless latitude
       raise ArgumentError.new('You must provide longitude') unless longitude
@@ -33,8 +32,7 @@ module Ratis
                              'Window'       => window,
                              'Walkdist'     => walk_distance,
                              'Landmarkid'   => landmark_id,
-                             'Stopid'       => stop_id,
-                             'Appid'        => app_id
+                             'Stopid'       => stop_id
                             }
 
       return [] unless response.success?

data/lib/ratis/timetable.rb

@@ -34,7 +34,7 @@ module Ratis
       timepoints_array = []
 
       headway[:timepoints][:stop].each_with_index do |tp, i|
-        timepoints_array << Timetable::Stop.new(i, tp[:atisstopid], tp[:stopid], tp[:description], tp[:area])
+        timepoints_array << Timetable::Stop.new(i, tp[:atisstopid], tp[:stopid], CGI.unescapeHTML(tp[:description]), tp[:area])
       end rescue []
 
       timetable.timepoints = timepoints_array
@@ -49,9 +49,5 @@ module Ratis
 
       timetable
     end
-
-
-
   end
-
 end

data/lib/ratis/version.rb

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

data/lib/ratis/walkstop.rb

@@ -26,7 +26,6 @@ module Ratis
       start_long = conditions.delete :start_long
       end_lat    = conditions.delete :end_lat
       end_long   = conditions.delete :end_long
-      app_id     = conditions.delete(:app_id) || 'ratis-gem'
 
       raise ArgumentError.new('You must provide a start_lat') unless start_lat
       raise ArgumentError.new('You must provide a start_long') unless start_long
@@ -39,8 +38,7 @@ module Ratis
                              'Startlat'  => start_lat,
                              'Startlong' => start_long,
                              'Endlat'    => end_lat,
-                             'Endlong'   => end_long,
-                             'Appid'     => app_id
+                             'Endlong'   => end_long
 
       Walkstop.new(response)
     end

data/ratis.gemspec

@@ -7,26 +7,26 @@ Gem::Specification.new do |s|
   s.version          = Ratis.version
   s.platform         = Gem::Platform::RUBY
   s.summary          = 'A Ruby wrapper around the ATIS SOAP Interface'
-  s.authors          = ['Velocity labs']
+  s.authors          = ['Velocity Labs']
   s.email            = 'irish@velocitylabs.io'
   s.files            = `git ls-files`.split($/)
   s.require_paths    = ['lib']
   s.rdoc_options     = ['--charset=UTF-8 --main=README.md']
   s.extra_rdoc_files = ['README.md']
 
-  s.add_dependency 'savon', '<2.0'
+  s.add_dependency 'savon', '< 2.0'
 
-  s.add_development_dependency 'activesupport', '< 4.0'
-  s.add_development_dependency 'bundler',       '~> 1.5'
-  s.add_development_dependency 'chronic',       '~> 0.10'
-  s.add_development_dependency 'hashdiff',      '~> 0.1'
-  s.add_development_dependency 'rake',          '~> 10.1'
-  s.add_development_dependency 'redcarpet',     '~> 2.1'
-  s.add_development_dependency 'rspec',         '~> 2.14'
-  s.add_development_dependency 'rspec-instafail','~> 0.2'
-  s.add_development_dependency 'byebug',        '~> 2.7'
-  s.add_development_dependency 'nokogiri',      '~> 1.6'
-  s.add_development_dependency 'simplecov',     '~> 0.8'
-  s.add_development_dependency 'vcr',           '~> 2.8'
-  s.add_development_dependency 'webmock',       '~> 1.17'
+  s.add_development_dependency 'activesupport',   '< 4.0'
+  s.add_development_dependency 'bundler',         '~> 1.5'
+  s.add_development_dependency 'chronic',         '~> 0.10'
+  s.add_development_dependency 'hashdiff',        '~> 0.1'
+  s.add_development_dependency 'rake',            '~> 10.1'
+  s.add_development_dependency 'redcarpet',       '~> 2.1'
+  s.add_development_dependency 'rspec',           '~> 2.14'
+  s.add_development_dependency 'rspec-instafail', '~> 0.2'
+  s.add_development_dependency 'byebug',          '~> 2.7'
+  s.add_development_dependency 'nokogiri',        '~> 1.6'
+  s.add_development_dependency 'simplecov',       '~> 0.8'
+  s.add_development_dependency 'vcr',             '~> 2.8'
+  s.add_development_dependency 'webmock',         '~> 1.17'
 end

data/spec/ratis/area_spec.rb

@@ -1,14 +1,6 @@
 require 'spec_helper'
 
 describe Ratis::Area do
-  before do
-    Ratis.reset
-    Ratis.configure do |config|
-      config.endpoint   = 'http://soap.valleymetro.org/cgi-bin-soap-web-262/soap.cgi'
-      config.namespace  = 'PX_WEB'
-    end
-  end
-
   describe '#all', vcr: {} do
     it 'only makes one request' do
       # false just to stop further processing of response
@@ -39,5 +31,4 @@ describe Ratis::Area do
       expect(area.description).to eq('Youngtown')
     end
   end
-
-end
+end