workarea-listrak 5.0.1

data/app/services/workarea/listrak/email_api.rb

@@ -0,0 +1,71 @@
+module Workarea
+  module Listrak
+    class EmailApi
+      def initialize(client_id:, client_secret:, open_timeout: nil, read_timeout: nil)
+        @client_id = client_id
+        @client_secret = client_secret
+        @open_timeout = open_timeout
+        @read_timeout = read_timeout
+      end
+
+      def request(http_request)
+        token = Listrak::Oauth.token(client_id: client_id, client_secret: client_secret)
+
+        http_request.add_field 'Authorization', "Bearer #{token}"
+        http_request.add_field 'Content-Type', 'application/json'
+        http_request['Accept'] = 'application/json'
+
+        response = http.start do |conn|
+          conn.request http_request
+        end
+
+        case response
+        when ::Net::HTTPSuccess
+          response
+        else
+          raise Listrak::HttpError, response
+        end
+      end
+
+      def events
+        Events.new self
+      end
+
+      def contacts
+        Contacts.new self
+      end
+
+      def lists
+        Lists.new self
+      end
+
+      def messages
+        Messages.new self
+      end
+
+      def transactional_messages
+        TransactionalMessages.new self
+      end
+
+      private
+
+        attr_reader :client_id, :client_secret, :open_timeout, :read_timeout
+
+        def http
+          Net::HTTP.new(uri.host, uri.port).tap do |conn|
+            conn.use_ssl = true
+            conn.read_timeout = read_timeout if read_timeout
+            conn.open_timeout = open_timeout if open_timeout
+          end
+        end
+
+        def base_url
+          "https://api.listrak.com/email/"
+        end
+
+        def uri
+          URI base_url
+        end
+    end
+  end
+end

data/app/services/workarea/listrak/models/address.rb

@@ -0,0 +1,83 @@
+module Workarea
+  module Listrak
+    module Models
+      class Address
+        attr_reader :workarea_address
+
+        def initialize(workarea_address)
+          @workarea_address = workarea_address
+        end
+
+        def as_json
+          {
+            address1: address1,
+            address2: address2,
+            address3: address3,
+            city: city,
+            country: country,
+            state: state
+          }.compact
+        end
+
+        # Home address line 1
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def address1
+          workarea_address.street.to_s[0...100]
+        end
+
+        # Home address line 2
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def address2
+          workarea_address.street_2.to_s[0..100]
+        end
+
+        # Home address line 3
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def address3
+        end
+
+        # Home address city
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def city
+          workarea_address.city.to_s[0...100]
+        end
+
+        # Home address country
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def country
+          workarea_address.country.name[0...100]
+        end
+
+        # Home address state
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def state
+          workarea_address.region.to_s[0...100]
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/contact.rb

@@ -0,0 +1,67 @@
+module Workarea
+  module Listrak
+    class Models::Contact
+      attr_reader :hash
+
+      def initialize(hash)
+        @hash = hash
+      end
+
+      # Email address of the contact.
+      #
+      # @return [String]
+      #
+      def email_address
+        hash['emailAddress']
+      end
+
+      # Listrak email key of the contact.
+      #
+      # @return [String]
+      #
+      def email_key
+        hash['emailKey']
+      end
+
+      # Subscription state of the contact. Allowed values are Subscribed and Unsubscribed.
+      #
+      # @return [String]
+      #
+      def subscription_state
+        hash['subscriptionState']
+      end
+
+      # Subscribe date of the contact.
+      #
+      # @return [DateTime]
+      #
+      def subscribe_date
+        DateTime.strptime(hash["subscribeDate"], '%FT%T')
+      end
+
+      # Subscribe method of the contact.
+      #
+      # @return [String]
+      #
+      def subscribe_method
+        hash['subscribeMethod']
+      end
+
+      # Unsubscribe date of the contact.
+      #
+      # @return [DateTime]
+      #
+      def unsubscribe_date
+        DateTime.strptime(hash["unsubscribeDate"], '%FT%T')
+      end
+
+      # Unsubscribe method of the contact.
+      #
+      # @return [String]
+      #
+      def unsubscribe_method
+        hash['unsubscribeMethod']
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/contact_form.rb

@@ -0,0 +1,24 @@
+module Workarea
+  module Listrak
+    module Models
+      class ContactForm
+        SUBSCRIBED_STATES = ['Subscribed', 'Unsubscribed']
+        attr_reader :email, :subscription_state, :options
+
+        def initialize(email:, subscription_state: nil, **options)
+          @email = email
+          @subscription_state = subscription_state.presence_in SUBSCRIBED_STATES
+          @options = options
+        end
+
+        def to_json
+          {
+            emailAddress: email,
+            subscriptionState: subscription_state,
+            segmentationFieldValues: nil
+          }.to_json
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/customer_form.rb

@@ -0,0 +1,209 @@
+module Workarea
+  module Listrak
+    module Models
+      class CustomerForm
+        GENDERS = ['M', 'F', 'Male', 'Female']
+
+        # @param [Workarea::User] user to create a customer
+        #
+        def initialize(user)
+          @user = user
+        end
+
+        def as_json(_options)
+          {
+            address: address,
+            birthday: birthday,
+            customerNumber: customer_number,
+            email: email,
+            firstName: first_name,
+            gender: gender,
+            homePhone: home_phone,
+            lastName: last_name,
+            meta1: meta1,
+            meta2: meta2,
+            meta3: meta3,
+            meta4: meta4,
+            meta5: meta5,
+            mobilePhone: mobile_phone,
+            preferredStoreNumber: preferred_store_number,
+            registered: registered,
+            workPhone: work_phone,
+            zipCode: zip_code
+          }.compact
+        end
+
+        private
+
+          attr_reader :user
+
+          # Address of customer
+          #
+          # @return [Workarea::Listrak::Models::Address]
+          #
+          def address
+            return unless user.default_billing_address.present?
+
+            Listrak::Models::Address.new(user.default_billing_address)
+          end
+
+          # Customer birthdate
+          #
+          # @return [String] birthday DateTime in %FT%TZ
+          #
+          def birthday
+          end
+
+          # Internal customer number
+          #
+          # limited to 20 characters
+          #
+          # @return [String]
+          #
+          def customer_number
+            user.id.to_s[0...20]
+          end
+
+          # Email address of customer. This property is required for accounts
+          # that are not CRM enabled.
+          #
+          # limited to 100 characters
+          #
+          # @return [String]
+          #
+          def email
+            user.email.to_s[0...100]
+          end
+
+          # First name
+          #
+          # limited to 50 characters
+          #
+          # @return [String]
+          #
+          def first_name
+            user.first_name
+          end
+
+          # Gender of customer
+          #
+          # limited to 50 characters
+          #
+          # @return [String]
+          #
+          def gender
+          end
+
+          # Landline phone number
+          #
+          # limted to 50 characters
+          #
+          # @return [String]
+          #
+          def home_phone
+            user.default_billing_address&.phone_number
+          end
+
+          # Last name
+          #
+          # limited to 50 characters
+          #
+          # @return [String]
+          #
+          def last_name
+            user.last_name
+          end
+
+          # Additional meta imformation
+          #
+          # limted to 250 characters
+          #
+          # @return [String]
+          #
+          def meta1
+          end
+
+          # Additional meta imformation
+          #
+          # limted to 250 characters
+          #
+          # @return [String]
+          #
+          def meta2
+          end
+
+          # Additional meta imformation
+          #
+          # limted to 250 characters
+          #
+          # @return [String]
+          #
+          def meta3
+          end
+
+          # Additional meta imformation
+          #
+          # limted to 250 characters
+          #
+          # @return [String]
+          #
+          def meta4
+          end
+
+          # Additional meta imformation
+          #
+          # limted to 250 characters
+          #
+          # @return [String]
+          #
+          def meta5
+          end
+
+          # Mobile phone number
+          #
+          # limited to 50 characters
+          #
+          # @return [String]
+          def mobile_phone
+            user.default_billing_address&.phone_number
+          end
+
+          # Preferred brick and mortar store location
+          #
+          # limited to 100 characters
+          #
+          # @return [String]
+          #
+          def preferred_store_number
+          end
+
+          # Indicates the customer registration state
+          #
+          # @return [Boolean]
+          #
+          def registered
+            true
+          end
+
+          # Work phone number
+          #
+          # limited to 50 characters
+          #
+          # @return [String]
+          #
+          def work_phone
+          end
+
+          # Customer ZIP Code
+          #
+          # limited to 50 characters
+          #
+          # @return [String]
+          #
+          def zip_code
+            user.default_billing_address&.postal_code
+          end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/event.rb

@@ -0,0 +1,45 @@
+module Workarea
+  module Listrak
+    module Models
+      class Event
+        attr_reader :hash
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        # Identifier used to locate the event.
+        #
+        # @return [Integer]
+        #
+        def id
+          hash["eventId"]
+        end
+
+        # Name given to the event.
+        #
+        # @return [String]
+        #
+        def name
+          hash["eventName"]
+        end
+
+        # Identifier of the event group associated with the event.
+        #
+        # @return [Integer]
+        #
+        def group_id
+          hash["eventGroupId"]
+        end
+
+        # Status of the event. Allowed values are Active and Blocked.
+        #
+        # @return [String]
+        #
+        def status
+          hash["status"]
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/event_form.rb

@@ -0,0 +1,25 @@
+module Workarea
+  module Listrak
+    module Models
+      class EventForm
+        STATUSES = ['Active', 'Blocked']
+        attr_reader :name, :status, :group_ip, :options
+
+        def initialize(name:, status: nil, group_ip: nil, **options)
+          @name = name
+          @status = status.presence_in(STATUSES) || STATUSES.first
+          @group_ip = group_ip
+          @options = options
+        end
+
+        def to_json
+          {
+            eventName: name,
+            eventGroupId: group_ip,
+            status: status
+          }.compact.to_json
+        end
+      end
+    end
+  end
+end