tripit 0.3.2

data/lib/trip_it/classes/trip.rb

@@ -0,0 +1,230 @@
+module TripIt
+  class Trip < Base
+    attr_reader :closeness_matches, :trip_invitees, :trip_crs_remarks, :id, :relative_url, :info
+    date_param :start_date, :end_date
+    string_param :description, :display_name, :image_url, :primary_location
+    boolean_param :is_private
+    exceptions :not_implemented_error
+    
+    def initialize(client, obj_id = nil, include_children = false, source = nil)
+      @client = client
+      # If we get an Object ID, we'll load and populate it. Otherwise assume its a new Trip Object.
+      unless obj_id.nil?
+        @obj_id = obj_id
+        include_children ? populate(source, :include_objects => true) : populate(source)
+      end
+    end
+    
+    def populate(source, params = {})
+      params.merge!( {:id => @obj_id} )
+      info = source || @client.get("/trip", params)
+            
+      @id                         = info['Trip']['id']
+      @primary_location           = info['Trip']['primary_location']
+      @is_private                 = Boolean(info['Trip']['is_private'])
+      @display_name               = info['Trip']['display_name']
+      @description                = info['Trip']['description']
+      @start_date                 = Date.parse(info['Trip']['start_date']) unless info['Trip']['start_date'].nil?
+      @end_date                   = Date.parse(info['Trip']['end_date']) unless info['Trip']['end_date'].nil?
+      @image_url                  = info['Trip']['image_url']
+      @relative_url               = info['Trip']['relative_url']
+      @trip_crs_remarks           = []
+      @trip_invitees              = []
+      @closeness_matches          = []
+      
+      chkAndPopulate(@trip_crs_remarks, TripIt::TripCrsRemark, info['Trip']['TripCrsRemarks']['TripCrsRemark']) unless info['Trip']['TripCrsRemarks'].nil?
+      
+      # Load associated profiles into Profile objects
+      profileInfo                 = info['Profile']
+      profiles                    = []
+      if profileInfo.is_a?(Array)
+        profileInfo.each do |pi|
+          profiles << TripIt::Profile.new(@client, pi)
+        end
+      else
+        profiles << TripIt::Profile.new(@client, profileInfo)
+      end
+      # And now match them into the invitees and closenessmatches array
+      unless info['Trip']['ClosenessMatches'].nil?
+        if info['Trip']['ClosenessMatches']['Match'].is_a?(Array)
+          info['Trip']['ClosenessMatches']['Match'].each do |match|
+            @closeness_matches << profiles.find { |profile| profile.ref == match['@attributes']['profile_ref'] }
+          end
+        else
+          @closeness_matches << profiles.find { |profile| profile.ref == info['Trip']['ClosenessMatches']['Match']['@attributes']['profile_ref'] }
+        end
+      end
+      
+      unless info['Trip']['TripInvitees'].nil?
+        if info['Trip']['TripInvitees']['Invitee'].is_a?(Array)
+          info['Trip']['TripInvitees']['Invitee'].each do |invitee|
+            @trip_invitees << TripIt::Invitee.new(invitee, profiles.find { |profile| profile.ref == invitee['@attributes']['profile_ref'] })
+          end
+        else
+          @trip_invitees << TripIt::Invitee.new(info['Trip']['TripInvitees']['Invitee'], profiles.find { |profile| profile.ref == info['Trip']['TripInvitees']['Invitee']['@attributes']['profile_ref'] })
+        end
+      end
+      
+      # If include_objects is true, we need to fill them up here
+      if params[:include_objects] == true
+        [
+          [info['ActivityObject'], @activities = [], TripIt::ActivityObject],
+          [info['AirObject'], @air = [], TripIt::AirObject],
+          [info['CarObject'], @cars = [], TripIt::CarObject],
+          [info['CruiseObject'], @cruises = [], TripIt::CruiseObject],
+          [info['DirectionsObject'], @directions = [], TripIt::DirectionsObject],
+          [info['LodgingObject'], @lodgings = [], TripIt::LodgingObject],
+          [info['MapObject'], @maps = [], TripIt::MapObject],
+          [info['NoteObject'], @notes = [], TripIt::NoteObject],
+          [info['RailObject'], @rail = [], TripIt::RailObject],
+          [info['RestaurantObject'], @restaurants = [], TripIt::RestaurantObject],
+          [info['TransportObject'], @transports = [], TripIt::TransportObject],
+          [info['WeatherObject'], @weather = [], TripIt::WeatherObject]
+        ].each do |obj|
+          unless obj[0].nil?
+            chkObjAndPopulate(@client, obj[1], obj[2], obj[0])
+          end
+        end
+      end
+    end
+    
+    def activities
+      return @activities unless @activities.nil?
+      actobj = @client.list("/object", {:trip_id => @id, :type => "activity"})["ActivityObject"]
+      @activities = []
+      return @activities if actobj.nil?
+      chkObjAndPopulate(@client, @activities, TripIt::ActivityObject, actobj)
+      return @activities
+    end
+    
+    def air
+      return @air unless @air.nil?
+      airobj = @client.list("/object", {:trip_id => @id, :type => "air"})["AirObject"]
+      @air = []
+      return @air if airobj.nil?
+      chkObjAndPopulate(@client, @air, TripIt::AirObject, airobj)
+      return @air
+    end
+    
+    def cars
+      return @cars unless @cars.nil?
+      carobj = @client.list("/object", {:trip_id => @id, :type => "car"})["CarObject"]
+      @cars = []
+      return @cars if carobj.nil?
+      chkObjAndPopulate(@client, @cars, TripIt::CarObject, carobj)
+      return @cars
+    end
+    
+    def cruises
+      return @cruises unless @cruises.nil?
+      cruiseobj = @client.list("/object", {:trip_id => @id, :type => "cruise"})["CruiseObject"]
+      @cruises = []
+      return @cruises if cruiseobj.nil?
+      chkObjAndPopulate(@client, @cruises, TripIt::CruiseObject, cruiseobj)
+      return @cruises
+    end
+    
+    def directions
+      return @directions unless @directions.nil?
+      directobj = @client.list("/object", {:trip_id => @id, :type => "directions"})["DirectionsObject"]
+      @directions = []
+      return @directions if directobj.nil?
+      chkObjAndPopulate(@client, @directions, TripIt::DirectionsObject, directobj)
+      return @directions
+    end
+    
+    def lodgings
+      return @lodgings unless @lodgings.nil?
+      lodgingobj = @client.list("/object", {:trip_id => @id, :type => "lodging"})["LodgingObject"]
+      @lodgings = []
+      return @lodgings if lodgingobj.nil?
+      chkObjAndPopulate(@client, @lodgings, TripIt::LodgingObject, lodgingobj)
+      return @lodgings
+    end
+    
+    def maps
+      return @maps unless @maps.nil?
+      mapsobj = @client.list("/object", {:trip_id => @id, :type => "map"})["MapObject"]
+      @maps = []
+      return @maps if mapsobj.nil?
+      chkObjAndPopulate(@client, @maps, TripIt::MapObject, mapsobj)
+      return @maps
+    end
+    
+    def notes
+      return @notes unless @notes.nil?
+      noteobj = @client.list("/object", {:trip_id => @id, :type => "note"})["NoteObject"]
+      @notes = []
+      return @notes if noteobj.nil?
+      chkObjAndPopulate(@client, @notes, TripIt::NoteObject, noteobj)
+      return @notes   
+    end
+    
+    def rail
+      return @rail unless @rail.nil?
+      railobj = @client.list("/object", {:trip_id => @id, :type => "rail"})["RailObject"]
+      @rail = []
+      return @rail if railobj.nil?
+      chkObjAndPopulate(@client, @rail, TripIt::RailObject, railobj)
+      return @rail
+    end
+    
+    def restaurants
+      return @restaurants unless @restaurants.nil?
+      restobj = @client.list("/object", {:trip_id => @id, :type => "restaurant"})["RestaurantObject"]
+      @restaurants = []
+      return @rail if restobj.nil?
+      chkObjAndPopulate(@client, @restaurants, TripIt::RestaurantObject, restobj)
+      return @restaurants
+    end
+    
+    def transports
+      return @transports unless @transports.nil?
+      transobj = @client.list("/object", {:trip_id => @id, :type => "transport"})["TransportObject"]
+      @transports = []
+      return @transports if transobj.nil?
+      chkObjAndPopulate(@client, @transports, TripIt::TransportObject, transobj)
+      return @transports
+    end
+    
+    def weather
+      return @weather unless @weather.nil?
+      wxobj = @client.list("/object", {:trip_id => @id, :type => "weather"})["WeatherObject"]
+      @weather = []
+      return @weather if wxobj.nil?
+      chkObjAndPopulate(@client, @weather, TripIt::WeatherObject, wxobj)
+      return @weather      
+    end
+    
+    def sequence
+      ["@start_date", "@end_date", "@description", "@display_name","@image_url", "@is_private", "@primary_location"]
+    end
+    
+    def save
+      [ @activities,
+        @air,
+        @cars,
+        @cruises,
+        @directions,
+        @lodgings,
+        @maps,
+        @notes,
+        @rail,
+        @restaurants,
+        @transports,
+        @weather
+      ].each do |obj|
+          unless obj.nil?
+            if obj.count > 1
+              raise NotImplementedError, "TripIt can only save one complex object at a time."
+            end
+          end
+        end
+        
+        # We only want to allow save for new objects for now.
+        if @obj_id.nil?
+          @client.create(self.xml)
+        end
+    end
+  end
+end

data/lib/trip_it/classes/trip_crs_remark.rb

@@ -0,0 +1,12 @@
+module TripIt
+  class TripCrsRemark < Base
+    attr_reader :record_locator, :notes
+    
+    def initialize(params = {}) 
+      raise ArgumentError, "TripCrsRemark created with empty parameters" if params.empty?
+      
+      @record_locator = params["record_locator"]
+      @notes          = params["notes"]
+    end
+  end
+end

data/lib/trip_it/enums/activity_detail_type.rb

@@ -0,0 +1,8 @@
+module TripIt
+  ACTIVITY_DETAIL_TYPE_CODE = {
+    "C" => "Concert",
+    "H" => "Theatre",
+    "M" => "Meeting",
+    "T" => "Tour"
+  }
+end

data/lib/trip_it/enums/cruise_detail_type.rb

@@ -0,0 +1,5 @@
+module TripIt
+  CRUISE_DETAIL_TYPE_CODE = {
+    "P" => "Port of Call"
+  }
+end

data/lib/trip_it/enums/flight_status_code.rb

@@ -0,0 +1,15 @@
+module TripIt
+  FLIGHT_STATUS_CODE = {
+    100 => "Not Monitorable",
+    200 => "Not Monitored",
+    300 => "Scheduled",
+    301 => "On Time",
+    302 => "In Flight - On Time",
+    303 => "Arrived - On Time",
+    400 => "Cancelled",
+    401 => "Delayed",
+    402 => "In Flight - Late",
+    403 => "Arrived - Late",
+    404 => "Diverted"
+  }
+end

data/lib/trip_it/enums/note_detail_type.rb

@@ -0,0 +1,5 @@
+module TripIt
+  NOTE_DETAIL_TYPE_CODE = {
+    "A" => "Article"
+  }
+end

data/lib/trip_it/enums/transport_detail_type.rb

@@ -0,0 +1,6 @@
+module TripIt
+  TRANSPORT_DETAIL_TYPE_CODE = {
+    "F" => "Ferry",
+    "G" => "Ground Transportation"
+  }
+end

data/lib/trip_it/oauth.rb

@@ -0,0 +1,77 @@
+module TripIt
+  class OAuth < Base
+    attr_reader :consumer, :access_token
+    exceptions :bad_request_exception, :unauthorized_exception, :not_found_exception, :server_error
+    
+    def initialize(ctoken, csecret)
+      @consumer = ::OAuth::Consumer.new(ctoken, csecret, :site => 'https://api.tripit.com')
+    end
+    
+    def set_callback_url(url)
+      @request_token = nil
+      request_token(:oauth_callback => url)
+    end
+    
+    def request_token(options={})
+      @request_token ||= consumer.get_request_token(options)
+    end
+    
+    def authorize_from_request(rtoken, rsecret, verifier)
+      request_token = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
+      access = request_token.get_access_token(:oauth_verifier => verifier)
+      @access_token = ::OAuth::AccessToken.new(consumer, access.token, access.secret)
+    end
+    
+    def authorize_from_access(atoken, asecret)
+      @access_token = ::OAuth::AccessToken.new(consumer, atoken, asecret)
+    end
+    
+    def get(resource, params={})
+      params.merge!(:format => "json")
+      params_string = params.collect{|k, v| "#{k}/#{v}"}.join('/')
+      request = access_token.get("/v1/get#{resource}/#{URI.escape(params_string)}")
+      returnResponse(request)
+    end
+    
+    def list(resource, params={})
+      params.merge!(:format => "json")
+      params_string = params.collect{|k, v| "#{k}/#{v}"}.join('/')
+      request = access_token.get("/v1/list#{resource}/#{URI.escape(params_string)}")
+      returnResponse(request)
+    end
+    
+    # Only takes XML
+    def create(param)
+      request = access_token.post("/v1/create", "xml=<Request>#{URI.escape(param)}</Request>", {'Content-Type' => 'application/x-www-form-urlencoded'})
+      returnResponse(request, "xml")
+    end
+    
+    # Only takes XML
+    def replace(resource, param)
+      request = access_token.post("/v1/replace#{resource}", "xml=<Request>#{URI.escape(param)}</Request>", {'Content-Type' => 'application/x-www-form-urlencoded'})
+      returnResponse(request, "xml")
+    end        
+    
+    def delete(resource, params={})
+      params.merge!(:format => "json")
+      params_string = params.collect{|k, v| "#{k}/#{v}"}.join('/')
+      request = access_token.get("/v1/delete#{resource}/#{URI.escape(params_string)}")
+      returnResponse(request)
+    end
+    
+    def returnResponse(request, format = "")
+      case request
+      when Net::HTTPOK: 
+        if format == "xml"
+          return request.body
+        else
+          return JSON.parse(request.body) 
+        end
+      when Net::HTTPBadRequest: raise BadRequestException, request.body
+      when Net::HTTPUnauthorized: raise UnauthorizedException, request.body
+      when Net::HTTPNotFound: raise NotFoundException, request.body
+      when Net::HTTPInternalServerError: raise ServerError, request.body
+      end
+    end
+  end
+end

data/lib/trip_it/util/param_util.rb

@@ -0,0 +1,235 @@
+require 'date'
+
+module TripIt
+  module ParamUtil
+    def string_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(String)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be a String"
+          end
+        end
+      end
+    end
+  
+    def integer_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Integer)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be an Integer"
+          end
+        end
+      end
+    end
+    
+    def float_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Float)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be a Float"
+          end
+        end
+      end      
+    end
+  
+    def boolean_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(TrueClass) || val.is_a?(FalseClass)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be a Boolean"
+          end
+        end
+      
+        define_method "#{name}?" do
+          !!instance_variable_get("@#{name}")
+        end
+      end
+    end
+    
+    def boolean_read_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}?" do
+          !!instance_variable_get("@#{name}")
+        end
+      end
+    end
+  
+    def array_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Array)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be an Array"
+          end
+        end
+      end
+    end  
+  
+    def datetime_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(DateTime)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be a DateTime"
+          end
+        end
+      end
+    end  
+  
+    def date_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Date)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be a Date"
+          end
+        end
+      end
+    end
+    
+    def time_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Time)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be a Time"
+          end
+        end
+      end      
+    end
+    
+    def airportcode_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.match("[A-Z][A-Z][A-Z]").nil?
+            raise ArgumentError, "#{name} must be a valid airport code"
+          else
+            instance_variable_set("@#{name}",val)
+          end
+        end
+      end      
+    end
+    
+    def address_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Address)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be an Address"
+          end
+        end
+      end      
+    end
+    
+    def traveler_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Traveler)
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be a Traveler"
+          end
+        end
+      end      
+    end
+    
+    def traveler_array_param(*names)
+      names.each do |name|
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+      
+        define_method "#{name}=" do |val|
+          if val.is_a?(Array) && val.all? { |e| Traveler === e }
+            instance_variable_set("@#{name}",val)
+          else
+            raise ArgumentError, "#{name} must be an Array of Travelers"
+          end
+        end
+      end      
+    end
+    
+    def exceptions(*names)
+      names.each do |n|
+        # Clean up the name
+        n = camelize(n.to_s)
+
+        class_eval %{
+          # Define a common Error class if it's
+          # not yet defined
+          unless const_defined?("Error")
+            const_set("Error", Class.new(StandardError) )
+          end
+
+          # Define the exception class
+          class #{n} < Error; end
+        }
+      end
+    end
+    
+    def camelize(word)
+      word.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
+    end
+  end 
+end

data/lib/tripit.rb

@@ -0,0 +1,45 @@
+$: << File.dirname(__FILE__)
+
+require 'rubygems'
+require 'oauth'
+require 'json'
+require 'time'
+
+require 'trip_it/util/param_util'
+
+require 'trip_it/base'
+require 'trip_it/oauth'
+
+require 'trip_it/classes/tp_date_time'
+require 'trip_it/classes/profile'
+require 'trip_it/classes/profile_email_address'
+require 'trip_it/classes/group'
+require 'trip_it/classes/image'
+require 'trip_it/classes/flight_status'
+require 'trip_it/classes/trip'
+require 'trip_it/classes/trip_crs_remark'
+require 'trip_it/classes/invitee'
+require 'trip_it/classes/traveler'
+require 'trip_it/classes/address'
+require 'trip_it/classes/points_program'
+require 'trip_it/classes/points_program_activity'
+require 'trip_it/classes/points_program_expiration'
+require 'trip_it/classes/objects/base_object'
+require 'trip_it/classes/objects/reservation_object'
+require 'trip_it/classes/objects/activity_object'
+require 'trip_it/classes/objects/air_object'
+require 'trip_it/classes/objects/car_object'
+require 'trip_it/classes/objects/cruise_object'
+require 'trip_it/classes/objects/directions_object'
+require 'trip_it/classes/objects/lodging_object'
+require 'trip_it/classes/objects/map_object'
+require 'trip_it/classes/objects/note_object'
+require 'trip_it/classes/objects/rail_object'
+require 'trip_it/classes/objects/restaurant_object'
+require 'trip_it/classes/objects/transport_object'
+require 'trip_it/classes/objects/weather_object'
+
+require 'trip_it/classes/segments/air_segment'
+require 'trip_it/classes/segments/cruise_segment'
+require 'trip_it/classes/segments/rail_segment'
+require 'trip_it/classes/segments/transport_segment'

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tripit'
+
+class Test::Unit::TestCase
+end

data/test/test_tripit.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestTripit < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end