snap_business 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e44e1b1969ef6262afe8131d70bc0a09eba90569ce3bafdd6816304242781704
+  data.tar.gz: cbed17683de06c931200188a3c9a62a8044993017e0cbe5da858922aa4e0ea32
+SHA512:
+  metadata.gz: e38542907ffdccab41f2412a3bd5e7888b02832e0c41b98d2b5abcb76c6f1dc798e37e7d81014586f53ac570285cb138dca917fea14e677abc72a14cca738f93
+  data.tar.gz: c0be57a7ab1f309b3ff578cf72c5c557f1a543218a676c00ddb01bbe5793960742b9d6037dee80d68e9906b079d0a78d05eda5214d1c7cdec043ed53ee440471

data/lib/snap_business/api/conversion_api.rb

@@ -0,0 +1,244 @@
+require 'concurrent'
+require_relative '../util/constants'
+
+module SnapBusinessSDK
+  class ConversionApi
+    attr_reader :use_launchpad
+    attr_accessor :config
+    attr_accessor :client
+    attr_accessor :default_api
+
+    # Creates a CAPI object to send conversion events with
+    #
+    # @param [String] long_lived_token token for authentication
+    # @option opts [String] :launchpad_url endpoint for launchpand
+    # @option opts [Boolean] :test_mode send events to test endpoints or not
+    # @option opts [Boolean] :is_debugging enable debugging logs
+    # @option opts [Logger] :logger custom logger
+    def initialize(long_lived_token, opts = {})
+      @is_debugging = false
+      @use_launchpad = false
+
+      @config = Configuration.new 
+      config.access_token = long_lived_token
+      @client = ApiClient.new config
+      client.user_agent = SnapBusinessSDK::Constants::USER_AGENT
+      client.default_headers[SnapBusinessSDK::Constants::METRICS_HEADER] = SnapBusinessSDK::Constants::METRICS_HEADER_VALUE
+      client.default_headers['accept-encoding'] = ''
+
+      if opts.key?(:'is_debugging')
+        self.is_debugging = opts[:'is_debugging']
+      end
+
+      if opts.key?(:'launchpad_url')
+        set_launchpad_url opts[:'launchpad_url']
+      end
+
+      if opts.key?(:'logger')
+        self.logger = opts[:'logger']
+      end
+
+      # override host for certain endpoints
+      @config.server_operation_index = {
+        "DefaultApi.send_data": nil,
+        "DefaultApi.send_test_data": nil,
+        "DefaultApi.conversion_validate_logs": nil,
+        "DefaultApi.conversion_validate_stats": nil,
+      }
+
+      @default_api = DefaultApi.new client
+    end
+
+    # @return [Boolean]
+    def is_debugging
+      config.debugging
+    end
+
+    # @return [Logger]
+    def logger
+      config.logger
+    end
+
+    # Send a single conversion event to CAPI asynchronously
+    #
+    # @param [CapiEvent] capi_event
+    # @return [Concurrent::Promise]
+    def send_event(capi_event)
+      send_events [capi_event]
+    end
+
+    # Send multiple conversion event to CAPI asynchronously
+    #
+    # @param [Array<CapiEvent>] capi_events
+    # @return [Concurrent::Promise]
+    def send_events(capi_events)
+      Concurrent::Promise.execute do
+        send_events_sync(capi_events)
+      end
+    end
+
+    # Send a single conversion event to CAPI synchronously
+    #
+    # @param [CapiEvent] capi_event
+    # @return [Response]
+    def send_event_sync(capi_event)
+      send_events_sync [capi_event]
+    end
+
+    # Send multiple conversion event to CAPI synchronously
+    #
+    # @param [Array<CapiEvent>] capi_events
+    # @return [Response]
+    def send_events_sync(capi_events)
+      headers = {}
+      if use_launchpad
+        headers[SnapBusinessSDK::Constants::CAPI_PATH_HEADER] = SnapBusinessSDK::Constants::CAPI_PATH
+      end
+
+      capi_events.each do |event|
+        if is_debugging
+          logger.info "[Snap Business SDK] Sending event: #{event.to_s}"
+        end
+        event.integration = SnapBusinessSDK::Constants::INTEGRATION_SDK
+      end
+
+      begin
+        @default_api.send_data body: capi_events, header_params: headers
+      rescue SnapBusinessSDK::ApiError => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Failed to send event: #{error.to_s}"
+        end
+        SnapBusinessSDK::Response.new status: error.code.to_s, reason: error.response_body
+      rescue => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Exception occured: #{error.to_s}"
+        end
+        SnapBusinessSDK::Response.new status: 'FAILED', reason: error.to_s
+      end
+    end
+
+    # Send a single conversion event to CAPI synchronously
+    #
+    # @param [CapiEvent] capi_event
+    # @return [TestResponse]
+    def send_test_event(capi_event)
+      send_test_events [capi_event]
+    end
+
+    # Send multiple test conversion event to CAPI synchronously
+    #
+    # @param [Array<CapiEvent>] capi_events
+    # @return [TestResponse]
+    def send_test_events(capi_events)
+      headers = {}
+      if use_launchpad
+        headers[SnapBusinessSDK::Constants::CAPI_PATH_HEADER] = SnapBusinessSDK::Constants::CAPI_PATH_TEST
+      end
+
+      capi_events.each do |event|
+        if is_debugging
+          logger.info "[Snap Business SDK] Sending test event: #{event.to_s}"
+        end
+        event.integration = SnapBusinessSDK::Constants::INTEGRATION_SDK
+      end
+
+      begin
+        @default_api.send_test_data body: capi_events, header_params: headers
+      rescue SnapBusinessSDK::ApiError => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Failed to send test event: #{error.to_s}"
+        end
+        SnapBusinessSDK::TestResponse.new status: error.code.to_s, reason: error.response_body
+      rescue => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Exception occured: #{error.to_s}"
+        end
+        SnapBusinessSDK::TestResponse.new status: 'FAILED', reason: error.to_s
+      end
+    end
+
+    # Get test event logs
+    #
+    # @param [String] asset_id
+    # @return [ResponseLogs]
+    def get_test_event_logs(asset_id)
+      headers = {}
+
+      begin
+        @default_api.conversion_validate_logs asset_id, header_params: headers
+      rescue SnapBusinessSDK::ApiError => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Failed to get test event logs: #{error.to_s}"
+        end
+        SnapBusinessSDK::ResponseLogs.new status: error.code.to_s, reason: error.response_body
+      rescue => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Exception occured: #{error.to_s}"
+        end
+        SnapBusinessSDK::ResponseLogs.new status: 'FAILED', reason: error.to_s
+      end
+    end
+
+    # Get test event stats
+    #
+    # @param [String] asset_id
+    # @return [ResponseStats]
+    def get_test_event_stats(asset_id)
+      headers = {}
+
+      begin
+        @default_api.conversion_validate_stats asset_id, header_params: headers
+      rescue SnapBusinessSDK::ApiError => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Failed to get test event stats: #{error.to_s}"
+        end
+        SnapBusinessSDK::ResponseStats.new status: error.code.to_s, reason: error.response_body
+      rescue => error
+        if is_debugging
+          logger.error "[Snap Business SDK] Exception occured: #{error.to_s}"
+        end
+        SnapBusinessSDK::ResponseStats.new status: 'FAILED', reason: error.to_s
+      end
+    end
+
+    private
+
+      # Set the launchpad url to use if instead of the public Snapchat endpoint
+      #
+      # @param [String] launchpad_url
+      def set_launchpad_url(launchpad_url)
+        @use_launchpad = !(launchpad_url.nil? || launchpad_url.strip.empty?)
+
+        if use_launchpad
+          client.user_agent = SnapBusinessSDK::Constants::USER_AGENT_WITH_PAD
+          config.host = launchpad_url.strip
+
+          if is_debugging
+            logger.info "[Snap Business SDK] Launchpad host is set to #{@config.host}"
+          end
+        else
+          client.user_agent = SnapBusinessSDK::Constants::USER_AGENT
+        end
+      end
+
+      # Enables/disables logging
+      #
+      # @param [Boolean] is_enabled
+      def is_debugging=(is_enabled)
+        config.debugging = is_enabled
+        if is_debugging
+          config.logger.info "[Snap Business SDK] Debug mode is set to #{is_enabled}"
+        end
+      end
+
+      # Set the logger used
+      #
+      # @param [Logger] logger
+      def logger=(logger)
+        config.logger = logger
+        if is_debugging
+          logger.info '[Snap Business SDK] Logger set'
+        end
+      end
+  end
+end

data/lib/snap_business/api/default_api.rb

@@ -0,0 +1,266 @@
+=begin
+#Snap Conversions API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1
+
+=end
+
+require 'cgi'
+
+module SnapBusinessSDK
+  class DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns a list of test events in last 24 hours
+    # @param asset_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ResponseLogs]
+    def conversion_validate_logs(asset_id, opts = {})
+      data, _status_code, _headers = conversion_validate_logs_with_http_info(asset_id, opts)
+      data
+    end
+
+    # Returns a list of test events in last 24 hours
+    # @param asset_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ResponseLogs, Integer, Hash)>] ResponseLogs data, response status code and response headers
+    def conversion_validate_logs_with_http_info(asset_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.conversion_validate_logs ...'
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling DefaultApi.conversion_validate_logs"
+      end
+      # resource path
+      local_var_path = '/v2/conversion/validate/logs'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'asset_id'] = asset_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseLogs'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.conversion_validate_logs",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#conversion_validate_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the stats on test and non-test events in the past hour
+    # @param asset_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ResponseStats]
+    def conversion_validate_stats(asset_id, opts = {})
+      data, _status_code, _headers = conversion_validate_stats_with_http_info(asset_id, opts)
+      data
+    end
+
+    # Returns the stats on test and non-test events in the past hour
+    # @param asset_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ResponseStats, Integer, Hash)>] ResponseStats data, response status code and response headers
+    def conversion_validate_stats_with_http_info(asset_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.conversion_validate_stats ...'
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling DefaultApi.conversion_validate_stats"
+      end
+      # resource path
+      local_var_path = '/v2/conversion/validate/stats'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'asset_id'] = asset_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseStats'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.conversion_validate_stats",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#conversion_validate_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<CapiEvent>] :body Snap Conversions API
+    # @return [Response]
+    def send_data(opts = {})
+      data, _status_code, _headers = send_data_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<CapiEvent>] :body Snap Conversions API
+    # @return [Array<(Response, Integer, Hash)>] Response data, response status code and response headers
+    def send_data_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.send_data ...'
+      end
+      # resource path
+      local_var_path = '/v2/conversion'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.send_data",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#send_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<CapiEvent>] :body Snap Conversions API
+    # @return [TestResponse]
+    def send_test_data(opts = {})
+      data, _status_code, _headers = send_test_data_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<CapiEvent>] :body Snap Conversions API
+    # @return [Array<(TestResponse, Integer, Hash)>] TestResponse data, response status code and response headers
+    def send_test_data_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.send_test_data ...'
+      end
+      # resource path
+      local_var_path = '/v2/conversion/validate'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TestResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.send_test_data",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#send_test_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end