iterable-api-client 0.1.0 → 0.2.0

data/lib/iterable/events.rb

@@ -0,0 +1,59 @@
+module Iterable
+  ##
+  #
+  # Interact with /events API endpoints
+  #
+  # @example Creating events endpoint object
+  #   # With default config
+  #   campaigns = Iterable::Events.new
+  #   campaigns.all
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   campaigns = Iterable::Events.new(config)
+  class Events < ApiResource
+    ##
+    #
+    # Get all events for a user by email
+    #
+    # @param email [String] Email of user to find events for
+    # @param limit [Integer] Limit of events to return, max 200 default 30
+    #
+    # @return [Iterable::Response] A response object
+    def for_email(email, limit = 30)
+      Iterable.request(conf, "/events/#{email}", limit: limit).get
+    end
+
+    ##
+    #
+    # Track an event
+    #
+    # @param name [String] Required name of event
+    # @param email [String] Email of user to track event for
+    # @param attrs [Hash] Event values and fields to include
+    #
+    # @return [Iterable::Response] A response object
+    def track(name, email = nil, attrs = {})
+      attrs[:eventName] = name
+      attrs[:email] = email
+      Iterable.request(conf, '/events/track').post(attrs)
+    end
+
+    ##
+    #
+    # Track an event
+    #
+    # @param campaign_id [String] Campaign ID of the push event to track
+    # @param message_id [String] Message ID of the push event to track
+    # @param email [String] Email of user to track push event for
+    # @param attrs [Hash] Event values and fields to include
+    #
+    # @return [Iterable::Response] A response object
+    def track_push_open(campaign_id, message_id, email, attrs = {})
+      attrs[:campaignId] = campaign_id
+      attrs[:messageId] = message_id
+      attrs[:email] = email
+      Iterable.request(conf, '/events/trackPushOpen').post(attrs)
+    end
+  end
+end

data/lib/iterable/experiments.rb

@@ -0,0 +1,50 @@
+module Iterable
+  ##
+  #
+  # Interact with /experiments API endpoints
+  #
+  # @example Creating experiments endpoint object
+  #   # With default config
+  #   templates = Iterable::Experiments.new [1, 2, 3]
+  #   templates.get
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   templates = Iterable::Experiments.new([1, 2, 3], config)
+  class Experiments < ApiResource
+    attr_reader :experiment_ids
+    ##
+    #
+    # Initialize Experiments with an array of experiment ids
+    #
+    # @param experiment_ids [Array[Integer]] Array of experiment_id Integers
+    # @param conf [Iterable::Config] A config to optionally pass for requests
+    #
+    # @return [Iterable::Experiments]
+    def initialize(experiment_ids = [], conf = nil)
+      @experiment_ids = experiment_ids
+      super conf
+    end
+
+    ##
+    #
+    # Get metrics for experiments
+    #
+    # @params campaign_ids [Array] Array of campaignIds to optionally query for
+    # @param start_time [Date|Time] Start of metrics to query for
+    # @param end_time [Date|Time] End of metrics to query for
+    #
+    # @return [Iterable::Response] A response object
+    def metrics(campaign_ids = [], start_time = nil, end_time = nil)
+      params = {
+        experimentId: @experiment_ids,
+        campaignId: campaign_ids
+      }
+      if start_time
+        params[:startTime] = start_time.to_date.strftime(Iterable::DATE_FORMAT)
+        params[:endTime] = end_time.to_date.strftime(Iterable::DATE_FORMAT)
+      end
+      Iterable.request(conf, '/experiments/metrics', params).get
+    end
+  end
+end

data/lib/iterable/export.rb

@@ -0,0 +1,124 @@
+module Iterable
+  ##
+  #
+  # Interact with /export API endpoints
+  #
+  # @example Creating an export endpoint object
+  #   # With default config
+  #   export = Iterable::Export.new
+  #   export = Iterable::Export.new Iterable::Export::EMAIL_SEND_TYPE
+  #   export.all
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   export = Iterable::Export.new(Iterable::Export::EMAIL_SEND_TYPE, nil, nil, nil, config)
+  class Export < ApiResource
+    DATE_FORMAT = '%Y-%m-%d %H:%M:%S'.freeze
+    DATA_TYPES = [
+      EMAIL_SEND_TYPE = 'emailSend'.freeze,
+      EMAIL_OPEN_TYPE = 'emailOpen'.freeze,
+      EMAIL_CLICK_TYPE = 'emailClick'.freeze,
+      EMAIL_UNSUBSCRIBE_TYPE = 'emailUnSubscribe'.freeze,
+      EMAIL_SUBSCRIBE_TYPE = 'emailSubscribe'.freeze,
+      EMAIL_BOUNCE_TYPE = 'emailBounce'.freeze,
+      EMAIL_COMPLAINT_TYPE = 'emailComplaint'.freeze,
+      PUSH_SEND_TYPE = 'pushSend'.freeze,
+      PUSH_BOUNCE_TYPE = 'pushBounce'.freeze,
+      PUSH_OPEN_TYPE = 'pushOpen'.freeze,
+      SMS_SEND_TYPE = 'smsSend'.freeze,
+      SMS_BOUNCE_TYPE = 'smsBounce'.freeze,
+      SMS_RECEIVED_TYPE = 'smsReceived'.freeze,
+      IN_APP_OPEN_TYPE = 'inAppOpen'.freeze,
+      IN_APP_CLICK_TYPE = 'inAppClick'.freeze,
+      WEB_PUSH_SEND_TYPE = 'webPushSend'.freeze,
+      HOSTED_UNSUBSCRIBE_CLICK_TYPE = 'hostedUnsubscribeClick'.freeze,
+      PURCHASE_TYPE = 'purchase'.freeze,
+      CUSTOM_EVENT_TYPE = 'customEvent'.freeze,
+      USER_TYPE = 'user'.freeze
+    ].freeze
+
+    RANGES = [
+      TODAY = 'Today'.freeze,
+      YESTERDAY = 'Yesterday'.freeze,
+      BEFORE_TODAY = 'BeforeToday'.freeze,
+      ALL = 'All'.freeze
+    ].freeze
+
+    attr_reader :data_type, :only_fields, :omit_fields, :campaign_id
+
+    ##
+    #
+    # Initialize an [Iterable::Export] object to export data from Iterable
+    #
+    # @param data_type [String] The type of data to export, one of [Iterable::Export::DATA_TYPES]
+    # @param only_fields [Array[String]] Array of fields to only export
+    # @param omit_fields [Array[String]] Array of fields to omit
+    # @param data_fields [Hash] Additional device data fields
+    # @param conf [Iterable::Config] A config to optionally pass for requests
+    #
+    # @return [Iterable::Export]
+    def initialize(data_type, only_fields = [], omit_fields = [], campaign_id = nil, conf = nil)
+      @data_type = data_type
+      @only_fields = only_fields
+      @omit_fields = omit_fields
+      @campaign_id = campaign_id
+      super conf
+    end
+
+    ##
+    # The format of the exporter to be implemented by a subclass
+    #
+    # @example Formats are currently csv or json
+    #
+    # @return [Exception] Raises an exception
+    def format
+      raise '#format must be implemented in child class'
+    end
+
+    ##
+    #
+    # Export data between a start and end time
+    #
+    # @param start_time [Time] The start time of the data to export
+    # @param end_time [Time] The end time of the data to export
+    #
+    # @return [Iterable::Response] A response object
+    def export(start_time, end_time)
+      params = {
+        startDateTime: start_time.strftime(Iterable::Export::DATE_FORMAT),
+        endDateTime: end_time.strftime(Iterable::Export::DATE_FORMAT)
+      }
+      Iterable.request(conf, base_path, request_params(params)).get
+    end
+
+    ##
+    #
+    # Export data given a valid range constant [Iterable::Export::RANGES]
+    #
+    # @param range [Iterable::Export::RANGES] A valid range to export data for
+    #
+    # @return [Iterable::Response] A response object
+    def export_range(range = Iterable::Export::TODAY)
+      params = { range: range }
+      Iterable.request(conf, base_path, request_params(params)).get
+    end
+
+    protected
+
+    def base_path
+      "/export/data.#{format}"
+    end
+
+    def request_params(params = {})
+      default_params.merge params
+    end
+
+    def default_params
+      params = { dataTypeName: @data_type }
+      params[:onlyFields] = @only_fields if @only_fields && @only_fields.length.positive?
+      params[:omitFields] = @omit_fields.join(',') if @omit_fields && @omit_fields.length.positive?
+      params[:campaignId] = @campaign_id if @campaign_id
+      params
+    end
+  end
+end

data/lib/iterable/json_exporter.rb

@@ -0,0 +1,23 @@
+module Iterable
+  ##
+  #
+  # Subclass of [Iterable::Export] for JSON exporting of data
+  #
+  # @example Creating a JSON Exporter
+  #   # With default config
+  #   exporter = Iterable::JsonExporter.new Iterable::Export::EMAIL_SEND_TYPE
+  #   exporter.export
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   exporter = Iterable::JsonExporter.new(Iterable::Export::EMAIL_SEND_TYPE, nil, nil, nil, config)
+  class JsonExporter < Export
+    ##
+    # Format to use for exporting
+    #
+    # @return [String] Format of export
+    def format
+      'json'
+    end
+  end
+end

data/lib/iterable/lists.rb

@@ -0,0 +1,89 @@
+module Iterable
+  ##
+  #
+  # Interact with /lists API endpoints
+  #
+  # @example Creating list endpoint object
+  #   # With default config
+  #   lists = Iterable::Lists.new
+  #   lists.all
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   lists = Iterable::Lists.new(config)
+  class Lists < ApiResource
+    ##
+    #
+    # Get all lists
+    #
+    # @return [Iterable::Response] A response object
+    def all
+      Iterable.request(conf, '/lists').get
+    end
+
+    ##
+    #
+    # Create a new list with a name
+    #
+    # @param name [String] The name of the list to create
+    #
+    # @return [Iterable::Response] A response object
+    def create(name)
+      Iterable.request(conf, '/lists').post(name: name)
+    end
+
+    ##
+    #
+    # Delete an existing list given a list id
+    #
+    # @param name [String|Integer] The id of the list to delete
+    #
+    # @return [Iterable::Response] A response object
+    def delete(list_id)
+      Iterable.request(conf, "/lists/#{list_id}").delete
+    end
+
+    ##
+    #
+    # Get users for a list
+    #
+    # @param list_id [String|Integer] The id of the list
+    #
+    # @return [Iterable::Response] A response object
+    def users(list_id)
+      Iterable.request(conf, '/lists/getUsers', listId: list_id).get
+    end
+
+    ##
+    #
+    # Subscribe users to a list
+    #
+    # @param list_id [String|Integer] The id of the list
+    # @param subscribes [Array[Hash]] An array of hashes of user emails and data fields
+    #
+    # @return [Iterable::Response] A response object
+    def subscribe(list_id, subscribers = [])
+      attrs = {
+        listId: list_id,
+        subscribers: subscribers
+      }
+      Iterable.request(conf, '/lists/subscribe').post(attrs)
+    end
+
+    ##
+    #
+    # Subscribe users to a list
+    #
+    # @param list_id [String|Integer] The id of the list
+    # @param subscribes [Array[Hash]] An array of hashes with an email
+    #
+    # @return [Iterable::Response] A response object
+    def unsubscribe(list_id, subscribers = [])
+      attrs = {
+        listId: list_id,
+        subscribers: subscribers
+      }
+      Iterable.request(conf, '/lists/unsubscribe').post(attrs)
+    end
+  end
+end

data/lib/iterable/message_types.rb

@@ -0,0 +1,31 @@
+module Iterable
+  ##
+  #
+  # Interact with /messageTypes API endpoints
+  #
+  # @example Creating message_types endpoint object
+  #   # With default config
+  #   message_types = Iterable::MessageTypes.new
+  #   message_types.all
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   message_types = Iterable::MessageTypes.new(config)
+  class MessageTypes < ApiResource
+    # Message mediums
+    MEDIUMS = [
+      EMAIL_MEDIUM  = 'Email'.freeze,
+      PUSH_MEDIUM   = 'Push'.freeze,
+      IN_APP_MEDIUM = 'InApp'.freeze,
+      SMS_MEDIUM    = 'SMS'.freeze
+    ].freeze
+    ##
+    #
+    # Get all message_types
+    #
+    # @return [Iterable::Response] A response object
+    def all
+      Iterable.request(conf, '/messageTypes').get
+    end
+  end
+end

data/lib/iterable/metadata.rb

@@ -0,0 +1,24 @@
+module Iterable
+  ##
+  #
+  # Interact with /metadata API endpoints
+  #
+  # @example Creating metadata endpoint object
+  #   # With default config
+  #   templates = Iterable::Metadata.new
+  #   templates.get
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   templates = Iterable::Metadata.new(config)
+  class Metadata < ApiResource
+    ##
+    #
+    # Get metadata
+    #
+    # @return [Iterable::Response] A response object
+    def get
+      Iterable.request(conf, '/metadata').get
+    end
+  end
+end

data/lib/iterable/metadata_table.rb

@@ -0,0 +1,93 @@
+module Iterable
+  ##
+  #
+  # Interact with /metadata/{table} API endpoints
+  #
+  # @example Creating metadata table endpoint object
+  #   # With default config
+  #   templates = Iterable::MetadataTable.new "table-name"
+  #   templates.get
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   templates = Iterable::MetadataTable.new("table-name", config)
+  class MetadataTable < ApiResource
+    attr_reader :name
+    ##
+    #
+    # Initialize a MetadataTable with a table name
+    #
+    # @param name [String] The name of the table to interact with
+    # @param conf [Iterable::Config] A config to optionally pass for requests
+    #
+    # @return [Iterable::MetadataTable]
+    def initialize(name, conf = nil)
+      @name = name
+      super conf
+    end
+
+    ##
+    #
+    # Get metadata table keys
+    #
+    # @params next_marker [String] next result set id if more hits exist
+    #
+    # @return [Iterable::Response] A response object
+    def list_keys(next_marker = nil)
+      params = {}
+      params['nextMarker'] = next_marker if next_marker
+      Iterable.request(conf, base_path, params).get
+    end
+
+    ##
+    #
+    # Delete metadata table
+    #
+    # @return [Iterable::Response] A response object
+    def delete
+      Iterable.request(conf, base_path).delete
+    end
+
+    ##
+    #
+    # Add metadata for table
+    #
+    # @param key [String] Key of metadata to add
+    # @param value [Hash] Value of metadata key as a hash of key/value data
+    #
+    # @return [Iterable::Response] A response object
+    def add(key, value = {})
+      Iterable.request(conf, base_path(key)).put(value: value)
+    end
+
+    ##
+    #
+    # Get metadata key for table
+    #
+    # @param key [String] Key of metadata to get
+    #
+    # @return [Iterable::Response] A response object
+    def get(key)
+      Iterable.request(conf, base_path(key)).get
+    end
+
+    ##
+    #
+    # Remove metadata key for table
+    #
+    # @param key [String] Key of metadata to delete
+    #
+    # @return [Iterable::Response] A response object
+    def remove(key)
+      Iterable.request(conf, base_path(key)).delete
+    end
+
+    private
+
+    def base_path(key = nil)
+      path = "/metadata/#{@name}"
+      path += "/#{key}" if key
+      path
+    end
+  end
+end