snap_business 1.0.1

data/lib/snap_business/models/validated_fields_validated_fields.rb

@@ -0,0 +1,262 @@
+=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 'date'
+require 'time'
+
+module SnapBusinessSDK
+  class ValidatedFieldsValidatedFields
+    attr_accessor :pixel_id
+
+    attr_accessor :snap_app_id
+
+    attr_accessor :currency
+
+    attr_accessor :price
+
+    attr_accessor :event_conversion_type
+
+    attr_accessor :event_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pixel_id' => :'pixel_id',
+        :'snap_app_id' => :'snap_app_id',
+        :'currency' => :'currency',
+        :'price' => :'price',
+        :'event_conversion_type' => :'event_conversion_type',
+        :'event_type' => :'event_type'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'pixel_id' => :'String',
+        :'snap_app_id' => :'String',
+        :'currency' => :'String',
+        :'price' => :'String',
+        :'event_conversion_type' => :'String',
+        :'event_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapBusinessSDK::ValidatedFieldsValidatedFields` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapBusinessSDK::ValidatedFieldsValidatedFields`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'pixel_id')
+        self.pixel_id = attributes[:'pixel_id']
+      end
+
+      if attributes.key?(:'snap_app_id')
+        self.snap_app_id = attributes[:'snap_app_id']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
+      if attributes.key?(:'event_conversion_type')
+        self.event_conversion_type = attributes[:'event_conversion_type']
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          pixel_id == o.pixel_id &&
+          snap_app_id == o.snap_app_id &&
+          currency == o.currency &&
+          price == o.price &&
+          event_conversion_type == o.event_conversion_type &&
+          event_type == o.event_type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [pixel_id, snap_app_id, currency, price, event_conversion_type, event_type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapBusinessSDK.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/snap_business/util/capi_hash.rb

@@ -0,0 +1,61 @@
+require 'digest'
+require 'soundex'
+
+module SnapBusinessSDK
+  class CapiHash
+    class << self
+      PHONE_NUM_PATTERN = /^((\+|00)(\d+)[\-\s])?0?(.+)/
+      PHONE_NUM_REPLACE_PATTERN = /[^\d.]/
+
+      def norm_and_hash_str(str)
+        if blank? str
+          nil
+        else
+          Digest::SHA256.hexdigest str.strip.downcase
+        end
+      end
+
+      def norm_and_soundex_str(str)
+        if blank? str
+          nil
+        else
+          Soundex.new(str.strip.downcase).soundex.upcase
+        end
+      end
+
+      def norm_and_hash_phone_num(phone_num)
+        normalized_phone_num = normalize_phone_num phone_num
+        if normalized_phone_num.nil?
+          nil
+        else
+          Digest::SHA256.hexdigest normalized_phone_num
+        end
+      end
+
+      def normalize_phone_num(phone_num)
+        if blank? phone_num
+          return nil
+        end
+
+        phone_num.match(PHONE_NUM_PATTERN) do |m|
+          country_code = (m[3] || "").gsub PHONE_NUM_REPLACE_PATTERN, ""
+          num = (m[4] || "").gsub PHONE_NUM_REPLACE_PATTERN, ""
+
+          if blank? country_code
+            country_code = "1"
+          end
+
+          if blank? num
+            nil
+          else
+            country_code + num
+          end
+        end
+      end
+
+      def blank?(str)
+        str.respond_to?(:empty?) ? str.empty? : str.nil?
+      end
+    end
+  end
+end

data/lib/snap_business/util/constants.rb

@@ -0,0 +1,16 @@
+module SnapBusinessSDK
+  module Constants
+    API_VERSION = 'v2'
+    PROD_DOMAIN = 'tr.snapchat.com'
+    STAGING_DOMAIN = 'tr-shadow.snapchat.com'
+    USER_AGENT = 'BusinessSDK/' + VERSION.to_s + '/Ruby'
+    USER_AGENT_WITH_PAD = USER_AGENT + ' (LaunchPAD)'
+    INTEGRATION_SDK = 'business-sdk'
+    TEST_MODE_HEADER = 'X-CAPI-Test-Mode'
+    CAPI_PATH_HEADER = 'X-CAPI-Path'
+    METRICS_HEADER = 'X-CAPI-BusinessSDK'
+    METRICS_HEADER_VALUE = 'Ruby/' + VERSION.to_s
+    CAPI_PATH = '/' + API_VERSION + '/conversion'
+    CAPI_PATH_TEST = CAPI_PATH + '/validate'
+  end
+end

data/lib/snap_business/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module SnapBusinessSDK
+  VERSION = '1.0.1'
+end

data/lib/snap_business.rb

@@ -0,0 +1,52 @@
+=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
+
+# Common files
+require 'snap_business/api_client'
+require 'snap_business/api_error'
+require 'snap_business/version'
+require 'snap_business/configuration'
+
+# Models
+require 'snap_business/models/capi_event'
+require 'snap_business/models/response'
+require 'snap_business/models/response_error_records'
+require 'snap_business/models/response_logs'
+require 'snap_business/models/response_logs_log'
+require 'snap_business/models/response_stats'
+require 'snap_business/models/response_stats_data'
+require 'snap_business/models/response_stats_test'
+require 'snap_business/models/test_response'
+require 'snap_business/models/validated_fields'
+require 'snap_business/models/validated_fields_items'
+
+# APIs
+require 'snap_business/api/default_api'
+require 'snap_business/api/conversion_api'
+
+module SnapBusinessSDK
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SnapBusinessSDK.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/conversion_api_spec.rb

@@ -0,0 +1,203 @@
+require_relative '../../lib/snap_business/api/conversion_api'
+require_relative '../../lib/snap_business/util/constants'
+
+describe 'conversion_api' do
+  describe 'initialize' do
+    it 'initializes with all optional fields provided' do
+      is_debugging = false
+      launchpad_url = 'some.domain.com'
+      logger = Logger.new(STDOUT)
+      capi = SnapBusinessSDK::ConversionApi.new 'token',
+        launchpad_url: launchpad_url,
+        logger: logger,
+        is_debugging: is_debugging
+
+      expect(capi.use_launchpad).to be true
+      expect(capi.config.host).to eq launchpad_url
+      expect(capi.client.default_headers['User-Agent']).to eq SnapBusinessSDK::Constants::USER_AGENT_WITH_PAD
+      expect(capi.logger).to eq logger
+      expect(capi.is_debugging).to eq is_debugging
+    end
+  end
+
+  describe 'launchpad_url' do
+    it 'sets the provided launchpad url' do
+      launchpad_url = 'some.domain.com'
+      capi = SnapBusinessSDK::ConversionApi.new 'token', launchpad_url: launchpad_url
+
+      expect(capi.use_launchpad).to be true
+      expect(capi.config.host).to eq launchpad_url
+      expect(capi.client.default_headers['User-Agent']).to eq SnapBusinessSDK::Constants::USER_AGENT_WITH_PAD
+    end
+
+    it 'uses the default endpoint when not set' do
+      capi = SnapBusinessSDK::ConversionApi.new 'token'
+
+      expect(capi.use_launchpad).to be false
+      expect(capi.config.host).to eq SnapBusinessSDK::Constants::PROD_DOMAIN
+      expect(capi.client.default_headers['User-Agent']).to eq SnapBusinessSDK::Constants::USER_AGENT
+    end
+  end
+
+  describe 'is_debugging' do
+    it 'sets debugging to false by default' do
+      capi = SnapBusinessSDK::ConversionApi.new 'token'
+
+      expect(capi.is_debugging).to be false
+    end
+
+    it 'sets debugging to true' do
+      debugging = true
+      capi = SnapBusinessSDK::ConversionApi.new 'token', is_debugging: debugging
+
+      expect(capi.is_debugging).to be true
+    end
+  end
+
+  describe 'send_events' do
+    it 'sends events asynchronously' do
+      capi = SnapBusinessSDK::ConversionApi.new 'token'
+      capi_event = SnapBusinessSDK::CapiEvent.new(
+        pixel_id: 'pixel-id',
+        event_conversion_type: 'WEB',
+        event_type: 'PURCHASE',
+        timestamp: 1656022510346,
+      )
+      capi_event.email = 'usr1@gmail.com'
+      capi_event.ip_address = '202.117.0.20'
+      capi_event.phone_number = '123-456-7890'
+      capi_events = [capi_event]
+
+      header = {}
+      request = { body: capi_events, header_params: header }
+      response = SnapBusinessSDK::Response.new status: '200'
+      expect(capi.default_api).to receive(:send_data).with(request).and_return(response)
+
+      promise = capi.send_events capi_events
+      promise.execute.wait
+      expect(promise.value).to eq response
+    end
+  end
+
+  describe 'send_events_sync' do
+    it 'sends events synchronously' do
+      capi = SnapBusinessSDK::ConversionApi.new 'token'
+      capi_event = SnapBusinessSDK::CapiEvent.new(
+        pixel_id: 'pixel-id',
+        event_conversion_type: 'WEB',
+        event_type: 'PURCHASE',
+        timestamp: 1656022510346,
+      )
+      capi_event.email = 'usr1@gmail.com'
+      capi_event.ip_address = '202.117.0.20'
+      capi_event.phone_number = '123-456-7890'
+      capi_events = [capi_event]
+
+      header = {}
+      request = { body: capi_events, header_params: header }
+      response = SnapBusinessSDK::Response.new status: '200'
+      expect(capi.default_api).to receive(:send_data).with(request).and_return(response)
+
+      actual_response = capi.send_events_sync capi_events
+      expect(actual_response).to eq response
+    end
+
+    it 'sends events synchronously to launchpad' do
+      launchpad_url = 'some.domain.com'
+      capi = SnapBusinessSDK::ConversionApi.new 'token', launchpad_url: launchpad_url
+      capi_event = SnapBusinessSDK::CapiEvent.new(
+        pixel_id: 'pixel-id',
+        event_conversion_type: 'WEB',
+        event_type: 'PURCHASE',
+        timestamp: 1656022510346,
+      )
+      capi_event.email = 'usr1@gmail.com'
+      capi_event.ip_address = '202.117.0.20'
+      capi_event.phone_number = '123-456-7890'
+      capi_events = [capi_event]
+
+      header = { SnapBusinessSDK::Constants::CAPI_PATH_HEADER => SnapBusinessSDK::Constants::CAPI_PATH }
+      request = { body: capi_events, header_params: header }
+      response = SnapBusinessSDK::Response.new status: '200'
+      expect(capi.default_api).to receive(:send_data).with(request).and_return(response)
+
+      actual_response = capi.send_events_sync capi_events
+      expect(actual_response).to eq response
+    end
+  end
+
+  describe 'send_test_events' do
+    it 'sends test events synchronously' do
+      capi = SnapBusinessSDK::ConversionApi.new 'token'
+      capi_event = SnapBusinessSDK::CapiEvent.new(
+        pixel_id: 'pixel-id',
+        event_conversion_type: 'WEB',
+        event_type: 'PURCHASE',
+        timestamp: 1656022510346,
+      )
+      capi_event.email = 'usr1@gmail.com'
+      capi_event.ip_address = '202.117.0.20'
+      capi_event.phone_number = '123-456-7890'
+      capi_events = [capi_event]
+
+      header = {}
+      request = { body: capi_events, header_params: header }
+      response = SnapBusinessSDK::TestResponse.new status: '200'
+      expect(capi.default_api).to receive(:send_test_data).with(request).and_return(response)
+
+      actual_response = capi.send_test_events capi_events
+      expect(actual_response).to eq response
+    end
+
+    it 'sends test events synchronously to launchpad' do
+      launchpad_url = 'some.domain.com'
+      capi = SnapBusinessSDK::ConversionApi.new 'token', launchpad_url: launchpad_url
+      capi_event = SnapBusinessSDK::CapiEvent.new(
+        pixel_id: 'pixel-id',
+        event_conversion_type: 'WEB',
+        event_type: 'PURCHASE',
+        timestamp: 1656022510346,
+      )
+      capi_event.email = 'usr1@gmail.com'
+      capi_event.ip_address = '202.117.0.20'
+      capi_event.phone_number = '123-456-7890'
+      capi_events = [capi_event]
+
+      header = { SnapBusinessSDK::Constants::CAPI_PATH_HEADER => SnapBusinessSDK::Constants::CAPI_PATH_TEST }
+      request = { body: capi_events, header_params: header }
+      response = SnapBusinessSDK::TestResponse.new status: '200'
+      expect(capi.default_api).to receive(:send_test_data).with(request).and_return(response)
+
+      actual_response = capi.send_test_events capi_events
+      expect(actual_response).to eq response
+    end
+  end
+
+  describe 'get_test_event_logs' do
+    it 'gets test event logs' do
+      asset_id = 'test-asset-id'
+      capi = SnapBusinessSDK::ConversionApi.new 'token'
+      header = {}
+      request = { header_params: header }
+      response = SnapBusinessSDK::ResponseLogs.new status: '200'
+      expect(capi.default_api).to receive(:conversion_validate_logs).with(asset_id, request).and_return(response)
+
+      actual_response = capi.get_test_event_logs asset_id
+      expect(actual_response).to eq response
+    end
+  end
+
+  describe 'get_test_event_stats' do
+    it 'gets test event stats' do
+      asset_id = 'test-asset-id'
+      capi = SnapBusinessSDK::ConversionApi.new 'token'
+      header = {}
+      request = { header_params: header }
+      response = SnapBusinessSDK::ResponseStats.new status: '200'
+      expect(capi.default_api).to receive(:conversion_validate_stats).with(asset_id, request).and_return(response)
+
+      actual_response = capi.get_test_event_stats asset_id
+      expect(actual_response).to eq response
+    end
+  end
+end

data/spec/api/default_api_spec.rb

@@ -0,0 +1,45 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SnapBusinessSDK::DefaultApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DefaultApi' do
+  before do
+    # run before each test
+    @api_instance = SnapBusinessSDK::DefaultApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DefaultApi' do
+    it 'should create an instance of DefaultApi' do
+      expect(@api_instance).to be_instance_of(SnapBusinessSDK::DefaultApi)
+    end
+  end
+
+  # unit tests for send_data
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<CapiEvent>] :body Snap Conversions API
+  # @return [Response]
+  describe 'send_data test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end