iterable-api-client 0.1.0 → 0.2.0

data/lib/iterable/push_templates.rb

@@ -0,0 +1,54 @@
+module Iterable
+  ##
+  #
+  # Interact with /templates/push API endpoints
+  #
+  # @example Creating push templates endpoint object
+  #   # With default config
+  #   templates = Iterable::PushTemplates.new
+  #   templates.get
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   templates = Iterable::PushTemplates.new(config)
+  class PushTemplates < ApiResource
+    ##
+    #
+    # Get a push template
+    #
+    # @param template_id [String|Integer] A push template ID
+    # @param params [Hash] Additional params to use such as locale
+    #
+    # @return [Iterable::Response] A response object
+    def get(template_id, params = {})
+      params['templateId'] = template_id
+      Iterable.request(conf, '/templates/push/get', params).get
+    end
+
+    ##
+    #
+    # Update a push template
+    #
+    # @param template_id [String|Integer] A push template ID
+    # @param attrs [Hash] Update attributes
+    #
+    # @return [Iterable::Response] A response object
+    def update(template_id, attrs = {})
+      attrs['templateId'] = template_id
+      Iterable.request(conf, '/templates/push/update').post(attrs)
+    end
+
+    ##
+    #
+    # Upsert a push template by client template ID
+    #
+    # @param client_template_id [String] A client template id to use or create
+    # @param attrs [Hash] Update attributes
+    #
+    # @return [Iterable::Response] A response object
+    def upsert(client_template_id, attrs = {})
+      attrs['clientTemplateId'] = client_template_id
+      Iterable.request(conf, '/templates/push/upsert').post(attrs)
+    end
+  end
+end

data/lib/iterable/request.rb

@@ -0,0 +1,100 @@
+require 'openssl'
+require 'uri'
+
+module Iterable
+  # @!visibility private
+  class Request
+    DEFAULT_OPTIONS = {
+      use_ssl: true,
+      verify_ssl: true,
+      verify_mode: OpenSSL::SSL::VERIFY_PEER
+    }.freeze
+
+    DEFAULT_HEADERS = {
+      'accept' => 'application/json',
+      'content-type' => 'application/json'
+    }.freeze
+
+    def initialize(config, path, params = {})
+      @config = config
+      @uri = build_uri(path, params)
+      @net = net_http
+      setup_http(@net)
+    end
+
+    def get(headers = {})
+      execute :get, {}, headers
+    end
+
+    def post(body = {}, headers = {})
+      execute :post, body, headers
+    end
+
+    def put(body = {}, headers = {})
+      execute :put, body, headers
+    end
+
+    def delete(headers = {})
+      execute :delete, {}, headers
+    end
+
+    private
+
+    def execute(verb, body = {}, headers = {})
+      http = connection(verb, body, headers)
+      setup_http(http)
+      transmit http
+    end
+
+    def connection(verb, body = {}, headers = {})
+      conn_headers = DEFAULT_HEADERS.merge(headers)
+      req = Net::HTTP.const_get(verb.to_s.capitalize, false).new(@uri, conn_headers)
+      req.body = JSON.dump(body)
+      req
+    end
+
+    def setup_http(http)
+      DEFAULT_OPTIONS.dup.each do |option, value|
+        setter = "#{option.to_sym}="
+        http.send(setter, value) if http.respond_to?(setter)
+      end
+    end
+
+    def build_uri(path, params = {})
+      uri = @config.uri
+      uri.path += path
+      params['api_key'] = @config.token
+      uri.query = URI.encode_www_form(params)
+      uri
+    end
+
+    def net_http
+      Net::HTTP.new(@uri.hostname, @uri.port, nil, nil, nil, nil)
+    end
+
+    def transmit(req)
+      response = nil
+      @net.start do |http|
+        response = http.request(req, nil, &:read_body)
+      end
+      handle_response response
+    end
+
+    def handle_response(response)
+      redirected = response.is_a?(Net::HTTPRedirection) || response.code == '303'
+      if redirected && response['location']
+        Response.new Net::HTTP.get_response(uri_for_redirect(response))
+      else
+        Response.new response
+      end
+    end
+
+    def uri_for_redirect(response)
+      uri = @config.uri
+      redirect_uri = URI(response['location'])
+      uri.path = redirect_uri.path
+      uri.query = redirect_uri.query
+      uri
+    end
+  end
+end

data/lib/iterable/response.rb

@@ -0,0 +1,46 @@
+require 'forwardable'
+
+module Iterable
+  ##
+  #
+  # Response class is used to get access to raw HTTP request info
+  class Response
+    extend Forwardable
+
+    def_delegators :@resp, :code, :message, :uri
+
+    attr_reader :body
+
+    # @!visibility private
+    def initialize(resp) # @private
+      @resp = resp
+      @body = parsed_body
+    end
+
+    ##
+    #
+    # Convenience method to determine if request was successfull or not
+    # @return [Boolean]
+    def success?
+      case @resp.code.to_i
+      when (200..299) then true
+      else
+        false
+      end
+    end
+
+    private
+
+    ##
+    # Attempts to parse the response as JSON. Will rescue and return original
+    # if unable to parse.
+    #
+    # @return [Hash,Array,String] A parsed JSON object or the original response body
+    def parsed_body
+      response_body = @resp.body
+      MultiJson.load response_body
+    rescue MultiJson::ParseError
+      response_body
+    end
+  end
+end

data/lib/iterable/templates.rb

@@ -0,0 +1,37 @@
+module Iterable
+  ##
+  #
+  # Interact with /templates API endpoints
+  #
+  # @example Creating templates endpoint object
+  #   # With default config
+  #   templates = Iterable::Templates.new
+  #   templates.all
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   templates = Iterable::Templates.new(config)
+  class Templates < ApiResource
+    # Template types
+    TYPES = [
+      BASE_TYPE      = 'Base'.freeze,
+      BLAST_TYPE     = 'Blast'.freeze,
+      TRIGGERED_TYPE = 'Triggered'.freeze,
+      WORKFLOW_TYPE  = 'Workflow'.freeze
+    ].freeze
+
+    ##
+    #
+    # Get all templates
+    #
+    # @return [Iterable::Response] A response object
+    def all(params = {})
+      Iterable.request(conf, '/templates', params).get
+    end
+
+    def for_client_template_id(client_template_id)
+      params = { clientTemplateId: client_template_id }
+      Iterable.request(conf, '/templates/getByClientTemplateId', params).get
+    end
+  end
+end

data/lib/iterable/users.rb

@@ -0,0 +1,190 @@
+module Iterable
+  ##
+  #
+  # Interact with /users API endpoints
+  #
+  # @example Creating users endpoint object
+  #   # With default config
+  #   templates = Iterable::Users.new
+  #   templates.get
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   templates = Iterable::Users.new(config)
+  class Users < ApiResource
+    ##
+    #
+    # Update user data or adds a user if missing. Data is merged - missing
+    # fields are not deleted
+    #
+    # @param email [String] User email to update or create
+    # @param attrs [Hash] Additional data to update or add
+    #
+    # @return [Iterable::Response] A response object
+    def update(email, attrs = {})
+      attrs['email'] = email
+      Iterable.request(conf, '/users/update').post(attrs)
+    end
+
+    ##
+    #
+    # Bulk update user data or adds it if does not exist. Data is merged and
+    # missing fields are not deleted
+    #
+    # @param users [Array[Hash]] Array of hashes of user details
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note User fields can be email [String], dataFields [Hash], or userId [String]
+    def bulk_update(users = [])
+      Iterable.request(conf, '/users/bulkUpdate').post(users: users)
+    end
+
+    ##
+    #
+    # Update user subscriptions. Overwrites existing data if the field is
+    # provided and not null
+    #
+    # @param email [String] User email to update
+    # @param attrs [Hash] Additional data to update
+    #
+    # @return [Iterable::Response] A response object
+    def update_subscriptions(email, attrs = {})
+      attrs['email'] = email
+      Iterable.request(conf, '/users/updateSubscriptions').post(attrs)
+    end
+
+    ##
+    #
+    # Update user subscriptions in bulk. Overwrites existing data if the field is
+    # provided and not null
+    #
+    # @param subscriptions [Array[Hash]] An array of subscription update attributes
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note Refer to [Iterable::Users#update_subscriptions] for what subscription
+    # information is needed such as email
+    def bulk_update_subscriptions(subscriptions = [])
+      attrs = { updateSubscriptionsRequests: subscriptions }
+      Iterable.request(conf, '/users/bulkUpdateSubscriptions').post(attrs)
+    end
+
+    ##
+    #
+    # Get a user by their email
+    #
+    # @param email [String] The email of the user to get
+    #
+    # @return [Iterable::Response] A response object
+    def for_email(email)
+      Iterable.request(conf, "/users/#{email}").get
+    end
+
+    ##
+    #
+    # Update a user email
+    #
+    # @param email [String] The email of the user to get
+    #
+    # @return [Iterable::Response] A response object
+    def update_email(email, new_email)
+      attrs = { currentEmail: email, newEmail: new_email }
+      Iterable.request(conf, '/users/updateEmail').post(attrs)
+    end
+
+    ##
+    #
+    # Delete a user by their email
+    #
+    # @param email [String] The email of the user to delete
+    #
+    # @return [Iterable::Response] A response object
+    def delete(email)
+      Iterable.request(conf, "/users/#{email}").delete
+    end
+
+    ##
+    #
+    # Delete a user by their userId
+    #
+    # @param user_id [String] The userId of the user to delete
+    #
+    # @return [Iterable::Response] A response object
+    def delete_by_id(user_id)
+      Iterable.request(conf, "/users/byUserId/#{user_id}").delete
+    end
+
+    ##
+    #
+    # Get a user by their userId
+    #
+    # @param user_id [String] The user ID of the user to get
+    #
+    # @return [Iterable::Response] A response object
+    def for_id(user_id)
+      Iterable.request(conf, "/users/byUserId/#{user_id}").get
+    end
+
+    ##
+    #
+    # Get the user fields with mappings from field to type
+    #
+    # @return [Iterable::Response] A response object
+    def fields
+      Iterable.request(conf, '/users/getFields').get
+    end
+
+    ##
+    #
+    # Register a browser token for a user
+    #
+    # @param email [String] An email of a user
+    # @param token [String] The browser token to register
+    # @param attrs [Hash] Additional attrs like userId to pass along
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note An email or userId is required
+    def register_browser_token(email, token, attrs = {})
+      attrs[:email] = email
+      attrs[:browserToken] = token
+      Iterable.request(conf, '/users/registerBrowserToken').post(attrs)
+    end
+
+    ##
+    #
+    # Disable a device
+    #
+    # @param token [String] A device token to disable
+    # @param email [String] Optional user email device belongs to to disable
+    # @param user_id [String] Optional user_id device belongs to to disable
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note An email or userId is required
+    def disable_device(token, email = nil, user_id = nil)
+      attrs = { token: token }
+      attrs[:email] = email if email
+      attrs[:userId] = user_id if user_id
+      Iterable.request(conf, '/users/disableDevice').post(attrs)
+    end
+
+    ##
+    #
+    # Get sent messages for a user
+    #
+    # @param email [String] An email for a user to retreive messages for
+    # @param start_time [Time] An optional start time for range of messages
+    # @param end_time [Time] An optional end time for range of messages
+    # @param params [Hash] Additional params to use to filter messages further
+    #
+    # @return [Iterable::Response] A response object
+    def sent_messages(email, start_time = nil, end_time = nil, params = {})
+      params[:email] = email
+      params[:startTime] = start_time.to_s if start_time
+      params[:endTime] = end_time.to_s if end_time
+      Iterable.request(conf, '/users/getSentMessages', params).get
+    end
+  end
+end

data/lib/iterable/workflows.rb

@@ -0,0 +1,30 @@
+module Iterable
+  ##
+  #
+  # Interact with /workflows API endpoints
+  #
+  # @example Creating workflows endpoint object
+  #   # With default config
+  #   templates = Iterable::Workflows.new
+  #   templates.get
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   templates = Iterable::Workflows.new(config)
+  class Workflows < ApiResource
+    ##
+    #
+    # Trigger a workflow for an email or a list.
+    #
+    # @param workflow_id [Integer] workflow_id to trigger
+    # @param attrs [Hash] Additional data fields
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note An email or listId is required to trigger a workflow
+    def trigger(workflow_id, attrs = {})
+      attrs['workflowId'] = workflow_id
+      Iterable.request(conf, '/workflows/triggerWorkflow').post(attrs)
+    end
+  end
+end