ratis 2.5.2.5 → 2.5.2.6

data/README.md

@@ -19,19 +19,19 @@ Currently Supports Ruby `1.8.7` and `1.9.3`
 
 Gem installation
 -------------------
-  1. Ensure that an SSH identity with permission for the *authoritylabs* organisation on github is available to Bundler.
+  1. Ensure that an SSH identity with permission for the *authoritylabs* organization on github is available to Bundler.
   1. Include the gem in your Gemfile thus:
 
-        gem 'ratis', :git => 'git@github.com:authoritylabs/ratis.git'
+        gem 'ratis', '[VERSION]'
 
-  1. Add the following (Valley Metro specific) configuration block.
+  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://soap.valleymetro.org/cgi-bin-soap-web-new/soap.cgi'
-          config.namespace = 'PX_WEB'
+          config.endpoint = 'http://(YOUR ENDPOINT URL)'
+          config.namespace = '(YOUR NAMESPACE)'
           config.proxy = 'http://localhost:8080'
           config.timeout = 5
         end
@@ -39,43 +39,59 @@ Gem installation
      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
+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.
 
-### Classes
-All the classes are prefixed with `Atis`, such as:
+  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.
 
-    AtisError, AtisItinerary, AtisLandmark, AtisModel, AtisNextBus, AtisRoute,...
+Gem usage
+-------------------
 
-All `Atis` classes, with the exception of `AtisModel` and `AtisError` represent data structures returned by SOAP actions.
+### Classes
+All the classes should be named to match the ATIS method:
 
-If you know the SOAP action you want to use, and wish to see if it is implemented in Ratis, you can open a console and ask `AtisModel` to tell you `who_implements_soap_action`:
+    Itinerary, Landmark, ScheduleNearby, ...
 
-    > AtisModel.who_implements_soap_action 'Getlandmarks'
-    => [AtisLandmark]
+Notable exceptions:
 
+    Routes contains Allroutes method with the thinking that this might be extened for other routes methods, but is probably not necessary and should be renamed
+    
 ### Queries
 By convention most provide either an `all` or `where` class method (following [Active Record's hash conditions syntax](http://guides.rubyonrails.org/active_record_querying.html#hash-conditions)), which will return an array of objects which wrap the response, e.g:
 
-    >> all_landmarks = AtisLandmark.where :type => :all
+    >> all_landmarks = Landmark.where :type => :all
     >> all_landmarks.count
     => 1510
     >> all_landmarks.first
-    => #<AtisLandmark:0x10d263190 @locality="N", @type="AIRPT", @location="4800 E. FALCON DR.", @verbose="FALCON FIELD AIRPORT">
+    => #<Landmark:0x10d263190 @locality="N", @type="AIRPT", @location="4800 E. FALCON DR.", @verbose="FALCON FIELD AIRPORT">
 
 ### Errors
 The `where` methods will try to sanity check your conditions before making a call to the SOAP server:
 
-    >> AtisLandmark.where({})
+    >> Landmark.where({})
     ArgumentError: You must provide a type
 
-    >> AtisLandmark.where :type => :all, :foo => 1
+    >> Landmark.where :type => :all, :foo => 1
     ArgumentError: Conditions not used by this class: [:foo]
 
-When something goes wrong with the SOAP transaction an `AtisError` will be raised:
+When something goes wrong with the SOAP transaction an `Error` will be raised:
 
-    >> AtisNextBus.where :stop_id => 123456
-    #<AtisError: #10222--Unknown stop>
+    >> NextBus.where :stop_id => 123456
+    #<Error: #10222--Unknown stop>
 
 
 Development 
@@ -87,20 +103,23 @@ Development
 
 ### Usage
 
- 1. For development Ratis is hard coded to use a local proxy server on port 8080:
-
-        ssh -i ~/.ssh/authoritylabs.pem -L 8080:localhost:3128 ubuntu@codingsanctum.com
-
  1. Run the test suite with `rake`
  1. Test it out with `irb -I lib/ -r rubygems -r ratis`
+ 2. After irb is open with above step, paste in your application's connection config settings. Example:
+
+  Ratis.configure do |config|
+    config.endpoint = 'http://(YOUR ENDPOINT URL)'
+    config.namespace = '(YOUR NAMESPACE)'
+    config.timeout = 5
+  end
 
 ### Extending
 
-The `AtisLandmark` class is a simple one to look at for reference, and will be referred to below:
+The `Landmark` class is a simple one to look at for reference, and will be referred to below:
 
 #### Testing
 
-You can see the spec for it in `spec/ratis/atis_landmark_spec.rb`, it uses helper methods defined in `spec/spec_helper.rb`:
+You can see the spec for it in `spec/ratis/landmark_spec.rb`, it uses helper methods defined in `spec/spec_helper.rb`:
 
   1. `stub_atis_request` tells `Webmock` to stub a `POST` to the ATIS SOAP server, any request which hasn't been explicitly allowed will trigger an exception.
 
@@ -125,16 +144,12 @@ You can see the spec for it in `spec/ratis/atis_landmark_spec.rb`, it uses helpe
 
 #### Implementing
 
-To ease interaction with the ATIS SOAP server the `AtisModel` module is available. Any class which makes requests to the server should:
-
-    require 'ratis/atis_model'
-    extend AtisModel
-
 You get the following:
 
-  1. `atis_request` should be used to make request to the ATIS SOAP server. It ensures the request is built in a way which the ATIS SOAP server expects, provides a version check against responses and returns a `Savon::Response`:
 
-        atis_request 'Getlandmarks', {'Type' => type}
+  1. `Request` should be used to make request to the ATIS SOAP server. It ensures the request is built in a way which the ATIS SOAP server expects, provides a version check against responses and returns a `Savon::Response`:
+
+        Request.get 'Getlandmarks', {'Type' => type}
 
   The method and parameter names should be given as described by the ATIS SOAP Interface reference, with the first character uppercase and all others lowercase.
 

data/lib/ratis/request.rb

@@ -7,6 +7,7 @@ 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?
+      
       self.class.client do
         wsdl.endpoint     = Ratis.config.endpoint
         wsdl.namespace    = Ratis.config.namespace
@@ -31,6 +32,8 @@ module Ratis
         raise Errno::ECONNREFUSED.new 'Refused request to ATIS SOAP server'
       rescue Savon::SOAP::Fault => e
         raise Errors::SoapError.new e
+      rescue Timeout::Error => e
+        raise "TIMEOUT!"
       end
     end
 

data/lib/ratis/timetable.rb

@@ -4,6 +4,7 @@ module Ratis
 
     attr_accessor :route_short_name, :direction, :service_type, :operator, :effective, :timepoints, :trips
 
+    #Ratis::Timetable.where( :route_short_name => "460", :direction => "E", :service_type => 'W')
     def self.where(conditions)
       short_name   = conditions.delete :route_short_name
       direction    = conditions.delete :direction
@@ -12,7 +13,7 @@ module Ratis
 
       raise ArgumentError.new('You must provide a route_short_name') unless short_name
       raise ArgumentError.new('You must provide a direction') unless direction
-      raise ArgumentError.new('You must provide either date or service_type') unless date ^ service_type
+      raise ArgumentError.new('You must provide either date or service_type') if date.blank? && service_type.blank?
       Ratis.all_conditions_used? conditions
 
       request_params = { 'Route' => short_name, 'Direction' => direction }
@@ -29,14 +30,18 @@ module Ratis
       timetable.operator         = headway[:operator]
       timetable.effective        = headway[:effective]
 
-      stop = headway[:timepoints][:stop]
-      timetable.timepoints = [ Timetable::Stop.new(stop[:atisstopid], stop[:stopid], stop[:description], stop[:area]) ]
+      timepoints_array = []
+      headway[:timepoints][:stop].each_with_index{|tp, i| timepoints_array.push(Timetable::Stop.new(i, tp[:stopid], tp[:description], tp[:area]) )} rescue []
+      timetable.timepoints       = timepoints_array
 
-      trip = headway[:times][:trip]
-      timetable.trips = [ Timetable::Trip.new(trip[:time], trip[:comment]) ]
+      trips_array = []
+      headway[:times][:trip].each_with_index{|t,i| trips_array.push(Timetable::Trip.new(i, t[:time], t[:comment]))} rescue []
+      timetable.trips            =  trips_array
 
       timetable
     end
+    
+    
 
   end
 

data/lib/ratis/timetable/stop.rb

@@ -1,6 +1,7 @@
+
 module Ratis
 
-  class Timetable::Stop < Struct.new(:atis_stop_id, :stop_id, :description, :area)
+  class Timetable::Stop < Struct.new(:ratis_stop_id, :atis_stop_id, :stop_id, :description, :area)
   end
 
 end

data/lib/ratis/timetable/trip.rb

@@ -1,6 +1,6 @@
 module Ratis
 
-  class Timetable::Trip < Struct.new(:times, :comment)
+  class Timetable::Trip < Struct.new(:ratis_stop_id, :times, :comment)
   end
 
 end

data/lib/ratis/version.rb

@@ -4,7 +4,8 @@ module Ratis
 
   def version
     @version ||= begin
-      string = '2.5.2.5'
+
+      string = '2.5.2.6'
 
       def string.parts
         split('.').map { |p| p.to_i }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: ratis
 version: !ruby/object:Gem::Version 
-  hash: 69
+  hash: 67
   prerelease: 
   segments: 
   - 2
   - 5
   - 2
-  - 5
-  version: 2.5.2.5
+  - 6
+  version: 2.5.2.6
 platform: ruby
 authors: 
 - AuthorityLabs
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-16 00:00:00 Z
+date: 2013-02-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: savon