Bloombox/Swift

/**
* Copyright 2019, Momentum Ideas, Co. All rights reserved.
* Source and object computer code contained herein is the private intellectual
* property of Momentum Ideas Co., a Delaware Corporation. Use of this
* code in source form requires permission in writing before use or the
* assembly, distribution, or publishing of derivative works, for commercial
* purposes or any other purpose, from a duly authorized officer of Momentum
* Ideas Co.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/

import SwiftGRPC
import OpenCannabis


/// Client variant, or build permutation, of this library.
internal let __BLOOMBOX_VARIANT__ = "full"

/// Version of this library.
internal let __BLOOMBOX_VERSION__ = "0.5.0"


/// Main Bloombox API client class. Provides access to service-specific clients, and initializes basic settings or
/// context required for communication with servers. At the time of this writing, the API client for Swift supports the
/// following remote service:
///
/// - Devices API: Manage devices, activate devices.
/// - Shop API: Submit orders, enroll members, check zipcodes.
/// - Menu API: Download showcase-oriented product catalog data.
/// - POS API: Integration API for point-of-sale operations.
/// - Platform API: Account and system information services.
/// - Telemetry API: Event and device telemetry services.
public final class Bloombox {
  /// Specifies settings for an instance of Bloombox.
  public class Settings: EventContextData {
    /// Default API key to use. Identifies the app or project invoking the API.
    public var apiKey: APIKey?

    /// Default partner code to use.
    public var partner: PartnerCode?

    /// Default partner location code to use.
    public var location: LocationCode?

    /// Default device UUID to use, if known.
    public var deviceUUID: DeviceUUID?

    /// Default collection to send events to.
    public var collection: EventCollection?

    /// Active order ID, if any.
    public var order: OrderID?

    /// Active user ID, if any.
    public var user: UserID?

    /// Menu section to specify, if any.
    public var section: MenuSection?

    /// Commercial item related to this event, if any.
    public var item: ItemID?

    /// Session or group ID, if applicable, and set.
    public var group: GroupID?

    /// Specifies the iOS application sending events.
    public var bundleId: String?

    /// Pre-made gRPC channel to use for service transmissions.
    public var channel: Channel?

    /// Produce a default set of settings.
    public static func defaultSettings() -> Settings {
      return Settings()
    }

    /// Initialize a new settings object. The settings object governs defaults for the Bloombox client. Most properties
    /// exposed via the settings object can be overridden per-call.
    ///
    /// - Parameter apiKey: API key to use when invoking API calls.
    /// - Parameter partner: Partner account code to use.
    /// - Parameter location: Partner location account code to invoke under.
    /// - Parameter deviceUUID: Globally-unique device ID.
    /// - Parameter collection: Event collection.
    /// - Parameter order: Order ID to send with events.
    /// - Parameter user: User ID to send with events.
    /// - Parameter section: Section ID to send with events.
    /// - Parameter item: Item ID to send with events.
    /// - Parameter group: Group ID to send with events.
    /// - Parameter bundleId: Bundle ID to include with events.
    /// - Parameter channel: Pre-made gRPC channel to use for service transport.
    public init(apiKey: APIKey? = nil,
                partner: PartnerCode? = nil,
                location: LocationCode? = nil,
                deviceUUID: DeviceUUID? = nil,
                collection: EventCollection? = nil,
                order: OrderID? = nil,
                user: UserID? = nil,
                section: MenuSection? = nil,
                item: ItemID? = nil,
                group: GroupID? = nil,
                bundleId: String? = nil,
                channel: Channel? = nil) {
      self.apiKey = apiKey
      self.partner = partner
      self.location = location
      self.deviceUUID = deviceUUID
      self.collection = collection
      self.order = order
      self.user = user
      self.section = section
      self.item = item
      self.group = group
      self.bundleId = bundleId
      self.channel = channel
    }
  }

  // -- Internals -- //
  private var _services: Services

  /// Main initializer. Defaults settings to sensible values, if none are provided. Explicit settings can be prepared
  /// ahead of time and handed in - see `Bloombox.Settings`.
  ///
  /// - Parameter settings: Settings to use for the desired client object.
  public init(settings: Settings = Settings.defaultSettings()) {
    self._services = Services(settings: settings)
    self._services.prepare()
  }

  // -- Public Interface -- //

  /// Update settings on this client object. Settings are expected to express the "current working state" behind the API
  /// client library, including any relevant API key, partner code and location code. API client modules (i.e. each
  /// service) are not designed to be kept around, so that settings may be effectively switched out when values change.
  ///
  /// - Parameter settings: Updated settings object.
  func updateSettings(_ settings: Settings) {
    self._services = Services(settings: settings)
    self._services.prepare()
  }

  /// Fetch active settings for this client.
  public var settings: Settings {
    return _services.settings
  }

  /// Public access to the mounted services.
  public var services: Services {
    return _services
  }

  /// Public access to the Auth service client.
  public var auth: AuthClient {
    return _services.auth
  }

  /// Public access to the Devices service client.
  public var devices: DevicesClient {
    return _services.devices
  }

  /// Public access to the Shop service client.
  public var shop: ShopClient {
    return _services.shop
  }

  /// Public access to the Menu service client.
  public var menu: MenuClient {
    return _services.menu
  }

  /// Public access to the Platform service client.
  public var platform: PlatformClient {
    return _services.platform
  }

  /// Public access to the Telemetry service client.
  public var telemetry: TelemetryClient {
    return _services.telemetry
  }

}