Skip to content

Commit

Permalink
Swifty APIs (Pt 2) (#177)
Browse files Browse the repository at this point in the history 
* Reduce complexity of RideParameters

* Make API public
  • Loading branch information
@edjiang
edjiang authored Sep 13, 2017
1 parent ffddf05 commit 17d9edc
Show file tree
Hide file tree
Showing 17 changed files with 190 additions and 567 deletions.
356 changes: 37 additions & 319 deletions source/UberRides/Model/RideParameters.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,20 @@

import MapKit

/// Object to represent the parameters needed to request a ride. Should be built using a RideParametersBuilder
/// Object to represent the parameters needed to request a ride.
@objc(UBSDKRideParameters) public class RideParameters : NSObject {

/// True if the pickup location should use the device's current location, false if a location has been set
public let useCurrentLocationForPickup: Bool

/// ProductID to use for the ride
public let productID: String?
public var productID: String?

/// The pickup location to use for the ride
public let pickupLocation: CLLocation?

/// The nickname of the pickup location of the ride
public let pickupNickname: String?
public var pickupNickname: String?

/// The address of the pickup location of the ride
public let pickupAddress: String?
public var pickupAddress: String?

/// This is the name of an Uber saved place. Only “home” or “work” is acceptable.
public let pickupPlaceID: String?
Expand All @@ -49,20 +46,47 @@ import MapKit
public let dropoffLocation: CLLocation?

/// The nickname of the dropoff location for the ride
public let dropoffNickname: String?
public var dropoffNickname: String?

/// The adress of the dropoff location of the ride
public let dropoffAddress: String?
public var dropoffAddress: String?

/// This is the name of an Uber saved place. Only “home” or “work” is acceptable.
public let dropoffPlaceID: String?

/// The unique identifier of the payment method selected by a user.
public let paymentMethod: String?
public var paymentMethod: String?

/// The unique identifier of the surge session for a user.
public let surgeConfirmationID: String?

public var surgeConfirmationID: String?

/// The source to use for attributing the ride
public var source: String?

convenience public override init() {
self.init(pickupLocation: nil, dropoffLocation: nil, pickupPlaceID: nil, dropoffPlaceID: nil)
}

convenience public init(pickupLocation: CLLocation?, dropoffLocation: CLLocation?) {
self.init(pickupLocation: pickupLocation, dropoffLocation: dropoffLocation, pickupPlaceID: nil, dropoffPlaceID: nil)
}

convenience public init(pickupPlaceID: String?, dropoffPlaceID: String?) {
self.init(pickupLocation: nil, dropoffLocation: nil, pickupPlaceID: pickupPlaceID, dropoffPlaceID: dropoffPlaceID)
}

private init(pickupLocation: CLLocation?,
dropoffLocation: CLLocation?,
pickupPlaceID: String?,
dropoffPlaceID: String?) {
self.pickupLocation = pickupLocation
self.dropoffLocation = dropoffLocation
self.pickupPlaceID = pickupPlaceID
self.dropoffPlaceID = dropoffPlaceID

super.init()
}

var userAgent: String {
var userAgentString: String = ""
if let versionNumber: String = Bundle(for: type(of: self)).object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String {
Expand All @@ -73,310 +97,4 @@ import MapKit
}
return userAgentString
}

var source: String?

fileprivate init(dropoffAddress: String?,
dropoffLocation: CLLocation?,
dropoffNickname: String?,
dropoffPlaceID: String?,
paymentMethod: String?,
pickupAddress: String?,
pickupLocation: CLLocation?,
pickupNickname: String?,
pickupPlaceID: String?,
productID: String?,
source: String?,
surgeConfirmationID: String?,
useCurrentLocationForPickup: Bool) {

self.useCurrentLocationForPickup = useCurrentLocationForPickup
self.productID = productID
self.pickupLocation = pickupLocation
self.pickupNickname = pickupNickname
self.pickupAddress = pickupAddress
self.pickupPlaceID = pickupPlaceID
self.dropoffLocation = dropoffLocation
self.dropoffNickname = dropoffNickname
self.dropoffAddress = dropoffAddress
self.dropoffPlaceID = dropoffPlaceID
self.paymentMethod = paymentMethod
self.surgeConfirmationID = surgeConfirmationID
self.source = source
}

}

/// Builder for a RideParameters object.
@objc(UBSDKRideParametersBuilder) open class RideParametersBuilder : NSObject {

private var useCurrentLocationForPickup: Bool
private var productID: String?
private var pickupLocation: CLLocation?
private var pickupNickname: String?
private var pickupAddress: String?
private var pickupPlaceID: String?
private var dropoffLocation: CLLocation?
private var dropoffNickname: String?
private var dropoffAddress: String?
private var dropoffPlaceID: String?
private var paymentMethod: String?
private var surgeConfirmationID: String?
private var source: String?

@objc public convenience override init() {
self.init(rideParameters: nil)
}

@objc public init(rideParameters: RideParameters?) {
if let rideParameters = rideParameters {
useCurrentLocationForPickup = rideParameters.useCurrentLocationForPickup
productID = rideParameters.productID
pickupLocation = rideParameters.pickupLocation
pickupNickname = rideParameters.pickupNickname
pickupAddress = rideParameters.pickupAddress
pickupPlaceID = rideParameters.pickupPlaceID
dropoffLocation = rideParameters.dropoffLocation
dropoffNickname = rideParameters.dropoffNickname
dropoffAddress = rideParameters.dropoffAddress
dropoffPlaceID = rideParameters.dropoffPlaceID
paymentMethod = rideParameters.paymentMethod
surgeConfirmationID = rideParameters.surgeConfirmationID

source = rideParameters.source
} else {
useCurrentLocationForPickup = true
}
}

/**
Set the product ID for the ride parameters.

- parameter productID: The unique ID of the product being requested.

- returns: RideParametersBuilder to continue chaining.
*/
open func setProductID(_ productID: String) -> RideParametersBuilder {
self.productID = productID

return self
}

/**
Sets the builder to use your current location for pickup. Will clear any set
pickupLocation, pickupNickname, and pickupAddress.
*/
open func setPickupToCurrentLocation() -> RideParametersBuilder {
useCurrentLocationForPickup = true
pickupLocation = nil
pickupNickname = nil
pickupAddress = nil

return self
}

/**
Sets the builder to use the given place ID as the pickup location. This will remove any existing pickup location.
Please note that place IDs are not supported for RequestDeeplink.

- parameter placeID: the place ID of the pickup location - either "home" or "work".

- returns: RideParametersBuilder to continue chaining.
*/
open func setPickupPlaceID(_ placeID: String) -> RideParametersBuilder {
useCurrentLocationForPickup = false
pickupPlaceID = placeID
pickupLocation = nil
pickupNickname = nil
pickupAddress = nil

return self
}

/**
Set pickup location information for the ride parameters.

- parameter location: CLLocation of pickup.
- parameter nickname: Optional nickname of pickup location.
- parameter address: Optional address of pickup location.

- returns: RideParametersBuilder to continue chaining.
*/
open func setPickupLocation(_ location: CLLocation, nickname: String?, address: String?) -> RideParametersBuilder {
useCurrentLocationForPickup = false
pickupLocation = location
pickupNickname = nickname
pickupAddress = address

return self
}

/**
Set pickup location information for the ride parameters.

- parameter location: CLLocation of pickup.
- parameter address: Optional address of pickup location.

- returns: RideParametersBuilder to continue chaining.
*/
open func setPickupLocation(_ location: CLLocation, address: String?) -> RideParametersBuilder {
return self.setPickupLocation(location, nickname: nil, address: address)
}

/**
Set pickup location information for the ride parameters.

- parameter location: CLLocation of pickup.
- parameter nickname: Optional nickname of pickup location.

- returns: RideParametersBuilder to continue chaining.
*/
open func setPickupLocation(_ location: CLLocation, nickname: String?) -> RideParametersBuilder {
return self.setPickupLocation(location, nickname: nickname, address: nil)
}

/**
Set pickup location information for the ride parameters.

- parameter location: CLLocation of pickup.

- returns: RideParametersBuilder to continue chaining.
*/
open func setPickupLocation(_ location: CLLocation) -> RideParametersBuilder {
return self.setPickupLocation(location, nickname: nil, address: nil)
}

/**
Set dropoff location information for the ride parameters.

- parameter location: CLLocation of dropoff.
- parameter nickname: Optional nickname of dropoff location.
- parameter address: Optional address of dropoff location.

- returns: RideParametersBuilder to continue chaining.
*/
open func setDropoffLocation(_ location: CLLocation, nickname: String?, address: String?) -> RideParametersBuilder {
dropoffLocation = location
dropoffNickname = nickname
dropoffAddress = address

return self
}

/**
Set dropoff location information for the ride parameters.

- parameter location: CLLocation of dropoff.
- parameter address: Optional address of dropoff location.

- returns: RideParametersBuilder to continue chaining.
*/
open func setDropoffLocation(_ location: CLLocation, address: String?) -> RideParametersBuilder {
return self.setDropoffLocation(location, nickname: nil, address: address)
}

/**
Set dropoff location information for the ride parameters.

- parameter location: CLLocation of dropoff.
- parameter nickname: Optional nickname of dropoff location.

- returns: RideParametersBuilder to continue chaining.
*/
open func setDropoffLocation(_ location: CLLocation, nickname: String?) -> RideParametersBuilder {
return self.setDropoffLocation(location, nickname: nickname, address: nil)
}

/**
Set dropoff location information for the ride parameters.

- parameter location: CLLocation of dropoff.

- returns: RideParametersBuilder to continue chaining.
*/
open func setDropoffLocation(_ location: CLLocation) -> RideParametersBuilder {
return self.setDropoffLocation(location, nickname: nil, address: nil)
}

/**
Sets the builder to use the given place ID as the dropoff location. This will remove any existing dropoff location.
Please note that place IDs are not supported for RequestDeeplink and the Ride Request Widget.

- parameter placeID: the place ID of the dropoff location - either "home" or "work".

- returns: RideParametersBuilder to continue chaining.
*/
open func setDropoffPlaceID(_ placeID: String) -> RideParametersBuilder {
dropoffPlaceID = placeID
dropoffLocation = nil
dropoffNickname = nil
dropoffAddress = nil

return self
}

/**
Sets the builder to use the given payment method for the user.
If set, the trip will be requested using this payment method.
If not set, the trip will be requested using the user’s last used payment method.
Please note that payment methods are not supported for RequestDeeplink and the Ride Request Widget.

- parameter method: unique identifier of payment method.

- returns: RideParametersBuilder to continue chaining.
*/
open func setPaymentMethod(_ method: String) -> RideParametersBuilder {
paymentMethod = method

return self
}

/**
Sets the builder to use the surge confirmation ID for making ride requests that have surge.
Please note surge confirmation is not supported for RequestDeeplink and the Ride Request Widget.

- parameter surgeConfirmation: the unique identifier of the surge session for a user.

- returns: RideParametersBuilder to continue chaining.
*/
open func setSurgeConfirmationID(_ surgeConfirmation: String) -> RideParametersBuilder {
surgeConfirmationID = surgeConfirmation

return self
}

/**
Set the source to use for attributing the ride

- parameter source: The source string to use

- returns: RideParametersBuilder to continue chaining.
*/
func setSource(_ source: String?) -> RideParametersBuilder {
self.source = source

return self
}

/**
Build the ride parameter object.

- returns: An initialized RideParameters object
*/
open func build() -> RideParameters {
return RideParameters(dropoffAddress: dropoffAddress,
dropoffLocation: dropoffLocation,
dropoffNickname: dropoffNickname,
dropoffPlaceID: dropoffPlaceID,
paymentMethod: paymentMethod,
pickupAddress: pickupAddress,
pickupLocation: pickupLocation,
pickupNickname: pickupNickname,
pickupPlaceID: pickupPlaceID,
productID: productID,
source: source,
surgeConfirmationID: surgeConfirmationID,
useCurrentLocationForPickup: useCurrentLocationForPickup)
}

}
Loading

0 comments on commit 17d9edc

Please sign in to comment.