ruby-whatsapp 0.3.0

data/lib/ruby/whatsapp/messages/interactive/body.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class Body < Base
+        module Defaults
+          MAX_TEXT_LENGTH = 1024
+        end
+
+        # @!attribute [rw] text
+        #   @return [String]
+        attr_accessor :text
+
+        validates :text, presence: true, length: { maximum: Defaults::MAX_TEXT_LENGTH }
+        # @param text [String] The footer text.
+        def initialize(text)
+          @text = text
+
+          validate!
+        end
+
+        class << self
+          # @return [Hash] Serialized representation of the Header.
+          def serialize(text)
+            new(text).serialize
+          end
+        end
+
+        # @return [Hash] Serialized representation of the Header.
+        def serialize
+          {
+            text:,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/footer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class Footer < Base
+        module Defaults
+          MAX_TEXT_LENGTH = 60
+        end
+
+        # @!attribute [rw] text
+        #   @return [String]
+        attr_accessor :text
+
+        validates :text, presence: true, length: { maximum: Defaults::MAX_TEXT_LENGTH }
+
+        # @param text [String] The footer text.
+        def initialize(text)
+          @text = text
+
+          validate!
+        end
+
+        class << self
+          # @return [Hash] Serialized representation of the Header.
+          def serialize(text:)
+            new(text).serialize
+          end
+        end
+
+        # @return [Hash] Serialized representation of the Header.
+        def serialize
+          {
+            text:,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/header.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class Header < Base
+        class HeaderError < Whatsapp::Error; end
+
+        module Types
+          IMAGE = "image"
+          VIDEO = "video"
+          DOCUMENT = "document"
+          TEXT = "text"
+        end
+
+        # @!attribute [rw] type
+        #   @return [String]
+        attr_accessor :type
+
+        validates :type, presence: true, inclusion: { in: Types.constants.map { |c| Types.const_get(c) } }
+        validate :validate_text_length
+
+        # @param type [String] The type of the header (e.g., "text", "image", "video", "document").
+        # @param kwargs [Hash] Additional keyword arguments for the header content.
+        def initialize(type:, **kwargs)
+          @type = type
+          @kwargs = kwargs
+
+          validate!
+        end
+
+        class << self
+          # @return [Hash] Serialized representation of the Header.
+          def serialize(type:, **)
+            new(type:, **).serialize
+          end
+        end
+
+        # @return [Hash] Serialized representation of the Header.
+        def serialize
+          case type
+          when Types::TEXT then serialize_text
+          when Types::IMAGE then serialize_image
+          when Types::DOCUMENT then serialize_document
+          when Types::VIDEO then serialize_video
+          else
+            raise HeaderError, "Unsupported header type: #{type.inspect}"
+          end
+        end
+
+      private
+
+        # @return [Hash] Serialized representation of text header.
+        def serialize_text
+          raise HeaderError, "Text content is required for text header" unless @kwargs[:text]
+
+          {
+            type: Types::TEXT,
+            text: @kwargs[:text],
+          }
+        end
+
+        # @return [Hash] Serialized representation of media header.
+        def serialize_image
+          handle_media(Types::IMAGE)
+        end
+
+        # @return [Hash] Serialized representation of media header.
+        def serialize_document
+          handle_media(Types::DOCUMENT)
+        end
+
+        # @return [Hash] Serialized representation of media header.
+        def serialize_video
+          handle_media(Types::VIDEO)
+        end
+
+        # @return [Hash] Serialized representation of media header.
+        #  @raise [HeaderError] if required link is missing.
+        def handle_media(type)
+          raise HeaderError, "#{type.capitalize} link is required for #{type} header" unless @kwargs[:link]
+
+          {
+            type:,
+            type.to_sym => {
+              link: @kwargs[:link],
+            },
+          }
+        end
+
+        # Validates that text headers don't exceed 60 characters
+        def validate_text_length
+          return unless type == Types::TEXT && @kwargs[:text]
+
+          return unless @kwargs[:text].length > 60
+
+          errors.add(:text, "must be 60 characters or less")
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/list_buttons/section/row.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class ListButtons
+        class Section
+          class Row
+            include ActiveModel::Validations
+
+            module Defaults
+              MAX_ID_LENGTH = 200
+              MAX_TITLE_LENGTH = 24
+              MAX_DESCRIPTION_LENGTH = 72
+            end
+
+            # @!attribute [rw] id
+            #   @return [String]
+            attr_accessor :id
+
+            # @!attribute [rw] title
+            #   @return [String]
+            attr_accessor :title
+
+            # @!attribute [rw] description
+            #   @return [String, nil]
+            attr_accessor :description
+
+            validates :id, presence: true, length: { maximum: Defaults::MAX_ID_LENGTH }
+            validates :title, presence: true, length: { maximum: Defaults::MAX_TITLE_LENGTH }
+            validates :description, length: { maximum: Defaults::MAX_DESCRIPTION_LENGTH }, allow_nil: true
+
+            # @param id [String] The unique identifier for the row.
+            # @param title [String] The title of the row.
+            # @param description [String, nil] The description of the row.
+            #  @raise [ActiveModel::ValidationError] if validation fails.
+            def initialize(id:, title:, description: nil)
+              @id = id
+              @title = title
+              @description = description
+
+              validate!
+            end
+
+            class << self
+              # @return [Hash] Serialized representation of the Row.
+              #  @raise [ActiveModel::ValidationError] if validation fails.
+              def serialize(**row)
+                new(**row).serialize
+              end
+            end
+
+            # @return [Hash] Serialized representation of the Row.
+            def serialize
+              {
+                id:,
+                title:,
+                description:,
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/list_buttons/section.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class ListButtons
+        class Section
+          include ActiveModel::Validations
+
+          module Defaults
+            MAX_TITLE_LENGTH = 24
+            MIN_ROWS_LENGTH = 1
+            MAX_ROWS_LENGTH = 10
+          end
+
+          # @!attribute [rw] title
+          #   @return [String]
+          attr_accessor :title
+
+          # @!attribute [rw] rows
+          #   @return [Array<Hash>]
+          attr_accessor :rows
+
+          validates :title, presence: true, length: { maximum: Defaults::MAX_TITLE_LENGTH }
+          validates :rows, presence: true, length: { minimum: Defaults::MIN_ROWS_LENGTH, maximum: Defaults::MAX_ROWS_LENGTH }
+
+          # @param title [String] The title of the section.
+          # @param rows [Array<Hash>] The rows in the section.
+          #  @raise [ActiveModel::ValidationError] if validation fails.
+          def initialize(title:, rows:)
+            @title = title
+            @rows = rows
+
+            validate!
+          end
+
+          class << self
+            # @return [Hash] Serialized representation of the Section.
+            #  @raise [ActiveModel::ValidationError] if validation fails.
+            def serialize(**section)
+              new(**section).serialize
+            end
+          end
+
+          # @return [Hash] Serialized representation of the Section.
+          def serialize
+            {
+              title:,
+              rows: serialized_rows,
+            }
+          end
+
+        private
+
+          # @return [Array<Hash>] Serialized rows.
+          #  @raise [ActiveModel::ValidationError] if validation fails.
+          def serialized_rows
+            rows.map { |row| Row.serialize(**row) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/list_buttons.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      # Interactive list messages allow you to present WhatsApp users with a list of options to choose from
+      # Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/messages/interactive-list-messages
+      class ListButtons < Base
+        module Defaults
+          MAX_BUTTON_LENGTH = 20
+          MIN_SECTIONS_COUNT = 1
+          MAX_SECTIONS_COUNT = 10
+        end
+
+        # @!attribute [rw] button
+        #   @return [String]
+        attr_accessor :button
+
+        # @!attribute [rw] sections
+        #   @return [Array<Hash>]
+        attr_accessor :sections
+
+        validates :button, presence: true, length: { maximum: Defaults::MAX_BUTTON_LENGTH }
+        validates :sections, presence: true, length: { minimum: Defaults::MIN_SECTIONS_COUNT,
+                                                       maximum: Defaults::MAX_SECTIONS_COUNT, }
+
+        # @param button [String] The text for the list button.
+        # @param sections [Array<Hash>] The sections of the list button.
+        #  @raise [ActiveModel::ValidationError] if validation fails.
+        def initialize(button:, sections:)
+          @button = button
+          @sections = sections
+
+          validate!
+        end
+
+        class << self
+          # @return [Hash] Serialized representation of the ListButtons.
+          #  @raise [ActiveModel::ValidationError] if validation fails.
+          def serialize(**list_buttons)
+            new(**list_buttons).serialize
+          end
+        end
+
+        # @return [Hash] Serialized representation of the ListButtons.
+        def serialize
+          {
+            button:,
+            sections: serialized_sections,
+          }
+        end
+
+      private
+
+        # @return [Array<Hash>] Serialized sections.
+        #   @raise [ActiveModel::ValidationError] if validation fails.
+        def serialized_sections
+          sections.map { |section| Section.serialize(**section) }
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/media_carousel/card/button/quick_reply.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class MediaCarousel
+        class Card
+          class Button
+            class QuickReply
+              include ActiveModel::Validations
+
+              # @!attribute [rw] id
+              #   @return [String]
+              attr_accessor :id
+
+              # @!attribute [rw] title
+              #   @return [String]
+              attr_accessor :title
+
+              validates :id, presence: true, length: { maximum: 20 }
+              validates :title, presence: true, length: { maximum: 20 }
+
+              # @param id [String] The ID of the quick reply button.
+              # @param title [String] The title of the quick reply button.
+              def initialize(id:, title:)
+                @id = id
+                @title = title
+              end
+
+              class << self
+                # @return [Hash] Serialized representation of the QuickReply.
+                def serialize(id:, title:)
+                  new(id:, title:).serialize
+                end
+              end
+
+              # @return [Hash] Serialized representation of the QuickReply.
+              def serialize
+                {
+                  id:,
+                  title:,
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/media_carousel/card/button.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class MediaCarousel
+        class Card
+          class Button
+            module Defaults
+              BUTTON_TYPE = "quick_reply"
+            end
+
+            # @!attribute [rw] quick_reply
+            #   @return [Hash]
+            attr_accessor :quick_reply
+
+            # @param quick_reply [Hash] The quick reply content of the button.
+            def initialize(quick_reply:)
+              @quick_reply = quick_reply
+            end
+
+            class << self
+              # @return [Hash] Serialized representation of the Button.
+              def serialize(quick_reply:)
+                new(quick_reply:).serialize
+              end
+            end
+
+            # @return [Hash] Serialized representation of the Button.
+            def serialize
+              {
+                type: Defaults::BUTTON_TYPE,
+                quick_reply: serialized_quick_reply,
+              }
+            end
+
+          private
+
+            def serialized_quick_reply
+              QuickReply.serialize(**quick_reply)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/media_carousel/card.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class MediaCarousel
+        class Card
+          include ActiveModel::Validations
+
+          module Defaults
+            TYPE = "cta_url"
+          end
+
+          # @!attribute [rw] card_index
+          #   @return [Integer]
+          attr_accessor :card_index
+
+          # @!attribute [rw] header
+          #   @return [Hash]
+          attr_accessor :header
+
+          # @!attribute [rw] body
+          #   @return [String]
+          attr_accessor :body
+
+          # @!attribute [rw] action
+          #   @return [Hash]
+          attr_accessor :action
+
+          # @!attribute [rw] buttons
+          #   @return [Array<Hash>]
+          attr_accessor :buttons
+
+          validates :card_index, presence: true
+
+          # @param card_index [Integer] The index of the card.
+          # @param header [Hash] The header content of the card.
+          # @param body [String] The body content of the card.
+          # @param action [Hash] The action content of the card.
+          def initialize(card_index:, header:, body:, action:, buttons:)
+            @card_index = card_index
+            @header = header
+            @body = body
+            @action = action
+            @buttons = buttons
+
+            validate!
+          end
+
+          class << self
+            # @return [Hash] Serialized representation of the Card.
+            def serialize(card_index:, header:, body:, action:, buttons:)
+              new(card_index:, header:, body:, action:, buttons:).serialize
+            end
+          end
+
+          # @return [Hash] Serialized representation of the Card.
+          def serialize
+            {
+              card_index:,
+              type: Defaults::TYPE,
+              header: Whatsapp::Messages::Interactive::Header.serialize(**header),
+              body: Whatsapp::Messages::Interactive::Body.serialize(body),
+              action: Whatsapp::Messages::Interactive::UrlButton.serialize(**action),
+              buttons: serialized_buttons,
+            }
+          end
+
+        private
+
+          def serialized_buttons
+            buttons.map { |button| Button.serialize(**button) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/media_carousel.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class MediaCarousel < Base
+        module Defaults
+          MIN_CARDS_LENGTH = 2
+          MAX_CARDS_LENGTH = 10
+        end
+
+        # @!attribute [rw] cards
+        #   @return [Array<Hash>]
+        attr_accessor :cards
+
+        validates :cards, presence: true, length: { minimum: Defaults::MIN_CARDS_LENGTH,
+                                                    maximum: Defaults::MAX_CARDS_LENGTH, }
+
+        # @param cards [Array<Hash>] The media cards.
+        def initialize(cards:)
+          @cards = cards
+
+          validate!
+        end
+
+        class << self
+          # @return [Hash] Serialized representation of the MediaCarousel.
+          def serialize(cards:)
+            new(cards:).serialize
+          end
+        end
+
+        # @return [Hash] Serialized representation of the MediaCarousel.
+        def serialize
+          {
+            cards: serialized_cards,
+          }
+        end
+
+      private
+
+        # @return [Array<Hash>] Serialized cards.
+        #  @raise [ActiveModel::ValidationError] if validation fails.
+        def serialized_cards
+          cards.map.with_index { |card, index| Card.serialize(card_index: index, **card) }
+        end
+      end
+    end
+  end
+end

data/lib/ruby/whatsapp/messages/interactive/product_carousel/card.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class Messages
+    class Interactive
+      class ProductCarousel
+        class Card
+          module Defaults
+            TYPE = "product"
+          end
+
+          # @!attribute [rw] card_index
+          #   @return [Integer]
+          attr_accessor :card_index
+
+          # @!attribute [rw] catalog_id
+          #   @return [String]
+          attr_accessor :catalog_id
+
+          # @!attribute [rw] product_retailer_id
+          #   @return [String]
+          attr_accessor :product_retailer_id
+
+          # @param card_index [Integer] The index of the card in the carousel.
+          # @param catalog_id [String] The catalog ID associated with the product.
+          # @param product_retailer_id [String] The retailer ID of the product.
+          def initialize(card_index:, catalog_id:, product_retailer_id:)
+            @card_index = card_index
+            @catalog_id = catalog_id
+            @product_retailer_id = product_retailer_id
+          end
+
+          class << self
+            # @return [Hash] Serialized representation of the Card.
+            def serialize(card_index:, catalog_id:, product_retailer_id:)
+              new(card_index:, catalog_id:, product_retailer_id:).serialize
+            end
+          end
+
+          # @return [Hash] Serialized representation of the Card.
+          def serialize
+            {
+              type: Defaults::TYPE,
+              card_index:,
+              action: {
+                catalog_id:,
+                product_retailer_id:,
+              },
+            }
+          end
+        end
+      end
+    end
+  end
+end