whatsapp_sdk 0.7.3 → 0.9.0

data/lib/whatsapp_sdk/api/client.rb

@@ -3,7 +3,6 @@
 
 require "faraday"
 require "faraday/multipart"
-require "oj"
 
 module WhatsappSdk
   module Api
@@ -31,21 +30,27 @@ module WhatsappSdk
 
         response = faraday_request.public_send(http_method, endpoint, request_params(params, headers), headers)
 
-        Oj.load(response.body)
+        return nil if response.body == ""
+
+        JSON.parse(response.body)
       end
 
-      sig { params(url: String, path_to_file_name: T.nilable(String)).returns(Net::HTTPResponse) }
-      def download_file(url, path_to_file_name = nil)
+      sig do
+        params(url: String, content_header: String, file_path: T.nilable(String))
+          .returns(Net::HTTPResponse)
+      end
+      def download_file(url:, content_header:, file_path: nil)
         uri = URI.parse(url)
         request = Net::HTTP::Get.new(uri)
         request["Authorization"] = "Bearer #{@access_token}"
+        request.content_type = content_header
         req_options = { use_ssl: uri.scheme == "https" }
 
         response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
           http.request(request)
         end
 
-        File.write(path_to_file_name, response.body) if response.code == "200" && path_to_file_name
+        File.write(file_path, response.body, mode: 'wb') if response.code == "200" && file_path
 
         response
       end

data/lib/whatsapp_sdk/api/medias.rb

@@ -25,6 +25,21 @@ module WhatsappSdk
         end
       end
 
+      class InvalidMediaTypeError < StandardError
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :media_type
+
+        sig { params(media_type: String).void }
+        def initialize(_media_type)
+          @file_path = file_path
+          message =  "Invalid Media Type. See the supported types" \
+                     "see the official documentation https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types."
+          super(message)
+        end
+      end
+
       # Get Media by ID.
       #
       # @param media_id [String] Media Id.
@@ -46,11 +61,16 @@ module WhatsappSdk
       #
       # @param url URL.
       # @param file_path [String] The file_path to download the media e.g. "tmp/downloaded_image.png".
+      # @param media_type [String] The media type e.g. "audio/mp4". See the supported types in the official
+      #  documentation https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types.
       # @return [WhatsappSdk::Api::Response] Response object.
-      sig { params(url: String, file_path: String).returns(WhatsappSdk::Api::Response) }
-      def download(url:, file_path:)
-        response = download_file(url, file_path)
+      sig { params(url: String, file_path: String, media_type: String).returns(WhatsappSdk::Api::Response) }
+      def download(url:, file_path:, media_type:)
+        return InvalidMediaTypeError(media_type) if media_type && !valid_content_header?(media_type)
+
+        content_header = media_type
 
+        response = download_file(url: url, file_path: file_path, content_header: content_header)
         response = if response.code.to_i == 200
                      { "success" => true }
                    else
@@ -105,6 +125,14 @@ module WhatsappSdk
           data_class_type: WhatsappSdk::Api::Responses::SuccessResponse
         )
       end
+
+      private
+
+      def valid_content_header?(_media_type)
+        # TODO: Add validations for media types. See available types in the official documentation
+        # https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types.
+        true
+      end
     end
   end
 end

data/lib/whatsapp_sdk/api/messages.rb

@@ -363,13 +363,57 @@ module WhatsappSdk
       #   # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
       # end
 
-      # def send_interactive_reply_buttons
-      #   # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
-      # end
+      # Send interactive reply buttons.
+      # https://developers.facebook.com/docs/whatsapp/guides/interactive-messages#reply-buttons
+      # You can either send interactive object or as JSON.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param interactive [Interactive] Interactive.
+      # @param interactive_json [Json] The interactive object as a Json.
+      #    If you pass interactive_json, you can't pass interactive.
+      # @param message_id [String] The id of the message to reply to.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer,
+          interactive: T.nilable(WhatsappSdk::Resource::Interactive),
+          interactive_json: T.nilable(T::Hash[T.untyped, T.untyped]), message_id: T.nilable(String)
+        ).returns(WhatsappSdk::Api::Response)
+      end
+      def send_interactive_message(
+        sender_id:, recipient_number:, interactive: nil, interactive_json: nil, message_id: nil
+      )
+        raise MissingArgumentError, "interactive or interactive_json is required" if !interactive && !interactive_json
 
-      # def send_interactive_section
-      #   # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
-      # end
+        params = {
+          messaging_product: "whatsapp",
+          to: recipient_number,
+          recipient_type: "individual",
+          type: "interactive"
+        }
+
+        params[:interactive] = if interactive.nil?
+                                 interactive_json
+                               else
+                                 interactive.to_json
+                               end
+        params[:context] = { message_id: message_id } if message_id
+
+        response = send_request(
+          endpoint: endpoint(sender_id),
+          params: params,
+          headers: DEFAULT_HEADERS
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
+      end
+
+      alias send_interactive_reply_buttons send_interactive_message
+      alias send_interactive_list_messages send_interactive_message
 
       # Mark a message as read.
       #

data/lib/whatsapp_sdk/api/request.rb

@@ -10,8 +10,8 @@ module WhatsappSdk
         @client = client
       end
 
-      def download_file(url, path_to_file_name = nil)
-        @client.download_file(url, path_to_file_name)
+      def download_file(url:, content_header:, file_path: nil)
+        @client.download_file(url: url, content_header: content_header, file_path: file_path)
       end
 
       def send_request(endpoint: nil, full_url: nil, http_method: "post", params: {}, headers: {})

data/lib/whatsapp_sdk/resource/error.rb

@@ -0,0 +1,39 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    module Error
+      class MissingValue < WhatsappSdk::Error
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :field
+
+        sig { returns(String) }
+        attr_reader :message
+
+        sig { params(field: String, message: String).void }
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      class InvalidField < MissingValue; end
+
+      class InvalidInteractiveBody < WhatsappSdk::Error; end
+
+      class InvalidInteractiveActionReplyButton < WhatsappSdk::Error; end
+
+      class InvalidInteractiveActionButton < WhatsappSdk::Error; end
+
+      class InvalidInteractiveActionSection < WhatsappSdk::Error; end
+
+      class InvalidInteractiveActionSectionRow < WhatsappSdk::Error; end
+
+      class InvalidInteractiveFooter < WhatsappSdk::Error; end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive.rb

@@ -0,0 +1,89 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Interactive
+      extend T::Sig
+
+      class Type < T::Enum
+        extend T::Sig
+
+        enums do
+          ListMessage = new("list")
+          ReplyButton = new("button")
+          SingleProductMessage = new("product")
+          MultiProductMessage = new("product_list")
+        end
+      end
+
+      # Returns the Interactive type of message you want to send.
+      #
+      # @returns type [Type]. Supported Options are list, button, product and product_list.
+      sig { returns(Type) }
+      attr_accessor :type
+
+      # Returns the interactive header if present. Required for type product_list.
+      #
+      # @returns type [InteractiveHeader] It can be nil.
+      sig { returns(T.nilable(InteractiveHeader)) }
+      attr_accessor :header
+
+      # Returns the interactive body.
+      #
+      # @returns type [InteractiveBody] Valid option is of type text only.
+      sig { returns(InteractiveBody) }
+      attr_accessor :body
+
+      # Returns the interactive footer if present.
+      #
+      # @returns type [InteractiveFooter] Valid option is of type text only. It can be nil.
+      sig { returns(T.nilable(InteractiveFooter)) }
+      attr_accessor :footer
+
+      # Returns the interactive action.
+      #
+      # @returns type [InteractiveBody] Valid condition is buttons of length of 1, 2 or 3 if type is button.
+      sig { returns(InteractiveAction) }
+      attr_accessor :action
+
+      sig do
+        params(
+          type: Type, body: InteractiveBody, action: InteractiveAction,
+          header: T.nilable(InteractiveHeader), footer: T.nilable(InteractiveFooter)
+        ).void
+      end
+      def initialize(type:, body:, action:, header: nil, footer: nil)
+        @type = type
+        @body = body
+        @action = action
+        @header = header
+        @footer = footer
+        validate
+      end
+
+      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      def to_json
+        json = { type: type.serialize }
+        json[:header] = header.to_json if header
+        json[:body] = body.to_json
+        json[:footer] = footer.to_json if footer
+        json[:action] = action.to_json
+
+        json
+      end
+
+      private
+
+      sig { void }
+      def validate
+        validate_action
+      end
+
+      sig { void }
+      def validate_action
+        action.validate
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action.rb

@@ -0,0 +1,141 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveAction
+      extend T::Sig
+
+      class Type < T::Enum
+        extend T::Sig
+
+        enums do
+          ListMessage = new("list_message")
+          ReplyButton = new("reply_button")
+        end
+      end
+
+      # Returns the type of interactive action you want to send.
+      #
+      # @returns type [Type]. Supported Options are list_message and reply_button.
+      sig { returns(Type) }
+      attr_accessor :type
+
+      # Returns the buttons of the Action. For reply_button type, it's required.
+      #
+      # @returns buttons [Array<InteractiveActionReplyButton>] .
+      sig { returns(T::Array[InteractiveActionReplyButton]) }
+      attr_accessor :buttons
+
+      # Returns the button of the Action. For list_message type, it's required.
+      #
+      # @returns button [String] .
+      sig { returns(String) }
+      attr_accessor :button
+
+      # Returns the sections of the Action. For list_message type, it's required.
+      #
+      # @returns sections [Array<InteractiveActionSection>] .
+      sig { returns(T::Array[InteractiveActionSection]) }
+      attr_accessor :sections
+
+      # TODO: attr_accessor :catalog_id
+      # TODO: attr_accessor :product_retailer_id
+
+      sig { params(reply_button: InteractiveActionReplyButton).void }
+      def add_reply_button(reply_button)
+        @buttons << reply_button
+      end
+
+      sig { params(section: InteractiveActionSection).void }
+      def add_section(section)
+        @sections << section
+      end
+
+      REPLY_BUTTONS_MINIMUM = 1
+      REPLY_BUTTONS_MAXIMUM = 3
+      LIST_BUTTON_TITLE_MAXIMUM = 20
+      LIST_SECTIONS_MINIMUM = 1
+      LIST_SECTIONS_MAXIMUM = 10
+
+      sig do
+        params(
+          type: Type, buttons: T::Array[InteractiveActionReplyButton],
+          button: String, sections: T::Array[InteractiveActionSection]
+        ).void
+      end
+      def initialize(type:, buttons: [], button: "", sections: [])
+        @type = type
+        @buttons = buttons
+        @button = button
+        @sections = sections
+      end
+
+      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      def to_json
+        json = {}
+        case type.serialize
+        when "list_message"
+          json = { button: button, sections: sections.map(&:to_json) }
+        when "reply_button"
+          json = { buttons: buttons.map(&:to_json) }
+        end
+
+        json
+      end
+
+      def validate
+        validate_fields
+      end
+
+      private
+
+      def validate_fields
+        case type.serialize
+        when "list_message"
+          validate_list_message
+        when "reply_button"
+          validate_reply_button
+        end
+      end
+
+      def validate_list_message
+        button_length = button.length
+        sections_count = sections.length
+        unless button_length.positive?
+          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionButton,
+                "Invalid button in action. Button label is required."
+        end
+
+        unless button_length <= LIST_BUTTON_TITLE_MAXIMUM
+          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionButton,
+                "Invalid length #{button_length} for button. Maximum length: " \
+                "#{LIST_BUTTON_TITLE_MAXIMUM} characters."
+        end
+
+        unless (LIST_SECTIONS_MINIMUM..LIST_SECTIONS_MAXIMUM).cover?(sections_count)
+          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+                "Invalid length #{sections_count} for sections in action. It should be between " \
+                "#{LIST_SECTIONS_MINIMUM} and #{LIST_SECTIONS_MAXIMUM}."
+        end
+
+        sections.each(&:validate)
+      end
+
+      def validate_reply_button
+        buttons_count = buttons.length
+        unless (REPLY_BUTTONS_MINIMUM..REPLY_BUTTONS_MAXIMUM).cover?(buttons_count)
+          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+                "Invalid length #{buttons_count} for buttons in action. It should be between " \
+                "#{REPLY_BUTTONS_MINIMUM} and #{REPLY_BUTTONS_MAXIMUM}."
+        end
+
+        button_ids = buttons.map(&:id)
+        return if button_ids.length.eql?(button_ids.uniq.length)
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+              "Duplicate ids #{button_ids} for buttons in action. They should be unique."
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action_reply_button.rb

@@ -0,0 +1,88 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveActionReplyButton
+      extend T::Sig
+
+      class Type < T::Enum
+        extend T::Sig
+
+        enums do
+          Reply = new("reply")
+        end
+      end
+
+      # Returns the ActionButton type of message you want to send.
+      #
+      # @returns type [String]. Supported Options are reply only.
+      sig { returns(Type) }
+      attr_accessor :type
+
+      # Returns the ActionButton title you want to send.
+      #
+      # @returns title [String]. The character limit is 20 characters.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Returns the ActionButton unique identifier you want to send.
+      # This ID is returned in the webhook when the button is clicked by the user.
+      #
+      # @returns id [String]. The character limit is 256 characters.
+      sig { returns(String) }
+      attr_accessor :id
+
+      ACTION_BUTTON_TITLE_MAXIMUM = 20
+      ACTION_BUTTON_ID_MAXIMUM = 256
+
+      sig { params(title: String, id: String).void }
+      def initialize(title:, id:)
+        @type = Type::Reply
+        @title = title
+        @id = id
+        validate
+      end
+
+      def to_json
+        json = { type: type.serialize }
+        json[type.serialize.to_sym] = {
+          id: id,
+          title: title
+        }
+
+        json
+      end
+
+      private
+
+      sig { void }
+      def validate
+        validate_title
+        validate_id
+      end
+
+      sig { void }
+      def validate_title
+        title_length = title.length
+        return if title_length <= ACTION_BUTTON_TITLE_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+              "Invalid length #{title_length} for title in button. " \
+              "Maximum length: #{ACTION_BUTTON_TITLE_MAXIMUM} characters."
+      end
+
+      sig { void }
+      def validate_id
+        id_unfrozen = id.dup
+        id_unfrozen.strip!  # You cannot have leading or trailing spaces when setting the ID.
+        id = id_unfrozen.freeze
+        id_length = id.length
+        return if id_length <= ACTION_BUTTON_ID_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+              "Invalid length #{id_length} for id in button. Maximum length: #{ACTION_BUTTON_ID_MAXIMUM} characters."
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action_section.rb

@@ -0,0 +1,72 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveActionSection
+      extend T::Sig
+
+      # Returns the ActionSection title you want to send.
+      #
+      # @returns title [String]. The character limit is 24 characters.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Returns the ActionSection rows you want to send.
+      #
+      # @returns id [T::Array[InteractiveActionSectionRow]]. There must be at least one rows object.
+      sig { returns(T::Array[InteractiveActionSectionRow]) }
+      attr_accessor :rows
+
+      sig { params(row: InteractiveActionSectionRow).void }
+      def add_row(row)
+        @rows << row
+      end
+
+      ACTION_SECTION_TITLE_MAXIMUM = 24
+      ACTION_SECTION_ROWS_MAXIMUM = 10
+
+      sig { params(title: String, rows: T::Array[InteractiveActionSectionRow]).void }
+      def initialize(title:, rows: [])
+        @title = title
+        @rows = rows
+        validate(skip_rows: true)
+      end
+
+      def to_json
+        {
+          title: title,
+          rows: rows.map(&:to_json)
+        }
+      end
+
+      sig { params(skip_rows: T.nilable(T::Boolean)).void }
+      def validate(skip_rows: false)
+        validate_title
+        validate_rows unless skip_rows
+      end
+
+      private
+
+      sig { void }
+      def validate_title
+        title_length = title.length
+        return if title_length <= ACTION_SECTION_TITLE_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+              "Invalid length #{title_length} for title in section. Maximum length: " \
+              "#{ACTION_SECTION_TITLE_MAXIMUM} characters."
+      end
+
+      sig { void }
+      def validate_rows
+        rows_length = rows.length
+        return if rows_length <= ACTION_SECTION_ROWS_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+              "Invalid number of rows #{rows_length} in section. Maximum count: " \
+              "#{ACTION_SECTION_ROWS_MAXIMUM}."
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action_section_row.rb

@@ -0,0 +1,93 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveActionSectionRow
+      extend T::Sig
+
+      # Returns the ActionSection title you want to send.
+      #
+      # @returns title [String]. The character limit is 24 characters.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Returns the ActionSection description you want to send.
+      #
+      # @returns description [String]. The character limit is 72 characters if present.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # Returns the ActionSection unique identifier you want to send.
+      # This ID is returned in the webhook when the section is selected by the user.
+      #
+      # @returns id [String]. The character limit is 256 characters.
+      sig { returns(String) }
+      attr_accessor :id
+
+      ACTION_SECTION_TITLE_MAXIMUM = 24
+      ACTION_SECTION_DESCRIPTION_MAXIMUM = 72
+      ACTION_SECTION_ID_MAXIMUM = 256
+
+      sig { params(title: String, id: String, description: T.nilable(String)).void }
+      def initialize(title:, id:, description: "")
+        @title = title
+        @id = id
+        @description = description
+        validate
+      end
+
+      def to_json
+        json = {
+          id: id,
+          title: title
+        }
+        json[:description] = description if description.length.positive?
+
+        json
+      end
+
+      private
+
+      sig { void }
+      def validate
+        validate_title
+        validate_id
+        validate_description
+      end
+
+      sig { void }
+      def validate_title
+        title_length = title.length
+        return if title_length <= ACTION_SECTION_TITLE_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
+              "Invalid length #{title_length} for title in section row. "\
+              "Maximum length: #{ACTION_SECTION_TITLE_MAXIMUM} characters."
+      end
+
+      sig { void }
+      def validate_id
+        id_unfrozen = id.dup
+        id_unfrozen.strip!  # You cannot have leading or trailing spaces when setting the ID.
+        id = id_unfrozen.freeze
+        id_length = id.length
+        return if id_length <= ACTION_SECTION_ID_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
+              "Invalid length #{id_length} for id in section row. Maximum length: "\
+              "#{ACTION_SECTION_ID_MAXIMUM} characters."
+      end
+
+      sig { void }
+      def validate_description
+        description_length = description.length
+        return if description_length <= ACTION_SECTION_DESCRIPTION_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
+              "Invalid length #{description_length} for description in section " \
+              "row. Maximum length: #{ACTION_SECTION_DESCRIPTION_MAXIMUM} characters."
+      end
+    end
+  end
+end