whatsapp_sdk 0.0.2 → 0.3.0

data/lib/whatsapp_sdk/api/responses/error_response.rb

@@ -1,32 +1,23 @@
 # frozen_string_literal: true
 
+require_relative "data_response"
+
 module WhatsappSdk
   module Api
     module Responses
-      class ErrorResponse
-        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
+      class ErrorResponse < DataResponse
+        attr_accessor :error, :status
 
-        def initialize(code:, subcode:, message:, type:, data:, fbtrace_id:)
-          @code = code
-          @subcode = subcode
-          @message = message
-          @type = type
-          @data = data
-          @fbtrace_id = fbtrace_id
+        def initialize(response:)
+          @error = response["error"]
+          @status = response["status"]
+          super(response)
         end
 
         def self.build_from_response(response:)
-          error_response = response["error"]
-          return unless error_response
+          return unless response["error"]
 
-          new(
-            code: error_response["code"],
-            subcode: error_response["error_subcode"],
-            message: error_response["message"],
-            type: error_response["type"],
-            data: error_response["data"],
-            fbtrace_id: error_response["fbtrace_id"]
-          )
+          new(response: response)
         end
       end
     end

data/lib/whatsapp_sdk/api/responses/media_data_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MediaDataResponse < DataResponse
+        attr_accessor :id, :url, :mime_type, :sha256, :file_size, :messaging_product
+
+        def initialize(response)
+          @id = response["id"]
+          @messaging_product = response["messaging_product"]
+          @url = response["url"]
+          @mime_type = response["mime_type"]
+          @sha256 = response["sha256"]
+          @file_size = response["file_size"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return unless response["id"]
+
+          new(response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/message_error_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "error_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MessageErrorResponse < ErrorResponse
+        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
+
+        def initialize(response:)
+          @code = response["code"]
+          @subcode = response["error_subcode"]
+          @message = response["message"]
+          @type = response["type"]
+          @data = response["data"]
+          @fbtrace_id = response["fbtrace_id"]
+          super(response: response)
+        end
+
+        def self.build_from_response(response:)
+          error_response = response["error"]
+          return unless error_response
+
+          new(response: error_response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/read_message_data_response.rb

@@ -8,11 +8,11 @@ require_relative "../../resource/contact_response"
 module WhatsappSdk
   module Api
     module Responses
-      class MessageDataResponse < DataResponse
-        attr_reader :sucess
+      class ReadMessageDataResponse < DataResponse
+        attr_reader :success
 
         def initialize(response:)
-          @sucess = response["sucess"]
+          @success = response["success"]
           super(response)
         end
 

data/lib/whatsapp_sdk/api/responses/success_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class SuccessResponse < DataResponse
+        def initialize(response:)
+          @success = response["success"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return unless response["success"]
+
+          new(response: response)
+        end
+
+        def success?
+          @success
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  # This module allows client instantiating the client as a singleton like the following example:
+  # WhatsappSdk.configure do |config|
+  #   config.access_token = ACCESS_TOKEN
+  # end
+  #
+  # The gem have access to the client through WhatsappSdk.configuration.client
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :access_token
+
+    def initialize(access_token = nil)
+      @access_token = access_token
+    end
+
+    def client
+      return unless access_token
+
+      WhatsappSdk::Api::Client.new(access_token)
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/button_parameter.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class ButtonParameter
+      class InvalidType < StandardError
+        attr_accessor :message
+
+        def initialize(type)
+          @message = "invalid type #{type}. type should be text or payload"
+          super
+        end
+      end
+
+      # Returns the button parameter type.
+      #
+      # @returns type [String] Valid options are payload and text.
+      attr_accessor :type
+
+      module Type
+        TEXT = "text"
+        PAYLOAD = "payload"
+
+        VALID_TYPES = [PAYLOAD, TEXT].freeze
+      end
+
+      # Required for quick_reply buttons.
+      # Returns the button payload. Developer-defined payload that is returned when the button is clicked
+      # in addition to the display text on the button.
+      #
+      # @returns payload [String]
+      attr_accessor :payload
+
+      # Required for URL buttons.
+      # Developer-provided suffix that is appended to the predefined prefix URL in the template.
+      #
+      # @returns text [String]
+      attr_accessor :text
+
+      def initialize(type:, payload: nil, text: nil)
+        @type = type
+        @payload = payload
+        @text = text
+        validate
+      end
+
+      def to_json(*_args)
+        json = {
+          type: type
+        }
+        json[:payload] = payload if payload
+        json[:text] = text if text
+        json
+      end
+
+      private
+
+      def validate
+        return if Type::VALID_TYPES.include?(type)
+
+        raise InvalidType, type
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/component.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Component
+      class InvalidField < StandardError
+        attr_reader :field, :message
+
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      module Type
+        HEADER = 'header'
+        BODY = 'body'
+        BUTTON = 'button'
+      end
+
+      module Subtype
+        QUICK_REPLY = "quick_reply"
+        URL = "url"
+      end
+
+      # Returns the Component type.
+      #
+      # @returns type [String]. Supported Options are header, body and button.
+      attr_accessor :type
+
+      # Returns the parameters of the component. For button type, it's required.
+      #
+      # @returns parameter [Array<ButtonParameter, ParameterObject>] .
+      attr_accessor :parameters
+
+      # Returns the Type of button to create. Required when type=button. Not used for the other types.
+      # Supported Options
+      # quick_reply: Refers to a previously created quick reply button
+      # that allows for the customer to return a predefined message.
+      # url: Refers to a previously created button that allows the customer to visit the URL generated by
+      # appending the text parameter to the predefined prefix URL in the template.
+      #
+      # @returns subtype [String]. Valid options are quick_reply and url.
+      attr_accessor :sub_type
+
+      # Required when type=button. Not used for the other types.
+      # Position index of the button. You can have up to 3 buttons using index values of 0 to 2.
+      #
+      # @returns index [Integer].
+      attr_accessor :index
+
+      def add_parameter(parameter)
+        @parameters << parameter
+      end
+
+      def initialize(type:, parameters: [], sub_type: nil, index: nil)
+        @parameters = parameters
+        @type = type
+        @sub_type = sub_type
+        @index = index.nil? && type == Type::BUTTON ? 0 : index
+        validate_fields
+      end
+
+      def to_json(*_args)
+        json = {
+          type: type,
+          parameters: parameters.map(&:to_json)
+        }
+        json[:sub_type] = sub_type if sub_type
+        json[:index] = index if index
+        json
+      end
+
+      private
+
+      def validate_fields
+        return if type == Type::BUTTON
+        raise InvalidField.new(:sub_type, 'sub_type is not required when type is not button') if sub_type
+
+        raise InvalidField.new(:index, 'index is not required when type is not button') if index
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/currency.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Currency
+      # Returns default text if localization fails.
+      #
+      # @returns fallback_value [String].
+      attr_accessor :fallback_value
+
+      # Currency code as defined in ISO 4217.
+      #
+      # @returns code [String].
+      attr_accessor :code
+
+      # Amount multiplied by 1000.
+      #
+      # @returns code [Float].
+      attr_accessor :amount
+
+      def initialize(fallback_value:, code:, amount:)
+        @fallback_value = fallback_value
+        @code = code
+        @amount = amount
+      end
+
+      def to_json(*_args)
+        {
+          fallback_value: fallback_value,
+          code: code,
+          amount_1000: amount
+        }
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/date_time.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class DateTime
+      # Returns default text if localization fails.
+      #
+      # @returns fallback_value [String].
+      attr_accessor :fallback_value
+
+      def initialize(fallback_value:)
+        @fallback_value = fallback_value
+      end
+
+      def to_json(*_args)
+        {
+          fallback_value: fallback_value
+        }
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/media.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Media
+      class InvalidMedia < StandardError
+        attr_reader :field, :message
+
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      # Returns media id.
+      #
+      # @returns id [String].
+      attr_accessor :id
+
+      module Type
+        AUDIO = 'audio'
+        DOCUMENT = 'document'
+        IMAGE = 'image'
+        VIDEO = 'video'
+        STICKER = 'sticker'
+
+        VALID_TYPES = [AUDIO, DOCUMENT, IMAGE, VIDEO, STICKER].freeze
+      end
+
+      # @returns type [String]. Valid options ar audio, document, image, video and sticker.
+      attr_accessor :type
+
+      # The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.
+      # Do not use this field when the message type is set to text.
+      #
+      # @returns link [String].
+      attr_accessor :link
+
+      # Describes the specified document or image media.
+      #
+      # @returns caption [String].
+      attr_accessor :caption
+
+      # Describes the filename for the specific document. Use only with document media.
+      #
+      # @returns filename [String].
+      attr_accessor :filename
+
+      def initialize(type:, id: nil, link: nil, caption: nil, filename: nil)
+        @type = type
+        @id = id
+        @link = link
+        @caption = caption
+        @filename = filename
+        validate_media
+      end
+
+      def to_json(*_args)
+        json = {}
+        json[:id] = id unless id.nil?
+        json[:link] = link unless link.nil?
+        json[:caption] = caption unless caption.nil?
+        json[:filename] = filename unless filename.nil?
+        json
+      end
+
+      private
+
+      def validate_media
+        unless Type::VALID_TYPES.include?(type)
+          raise InvalidMedia.new(:type, "invalid type. type should be audio, document, image, video or sticker")
+        end
+        if filename && (type != Type::DOCUMENT)
+          raise InvalidMedia.new(:filename, "filename can only be used with document")
+        end
+
+        if caption && !(type == Type::DOCUMENT || type == Type::IMAGE)
+          raise InvalidMedia.new(:caption, "caption can only be used with document or image")
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/parameter_object.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class ParameterObject
+      class InvalidType < StandardError
+        attr_accessor :message
+
+        def initialize(type)
+          @message = "invalid type #{type}. type should be text, currency, date_time, image, document or video"
+          super
+        end
+      end
+
+      class MissingValue < StandardError
+        attr_reader :field, :message
+
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      # Returns the parameter type.
+      #
+      # @returns type [String] Valid options are text, currency, date_time, image, document, video.
+      attr_accessor :type
+
+      module Type
+        TEXT = "text"
+        CURRENCY = "currency"
+        DATE_TIME = "date_time"
+        IMAGE = "image"
+        DOCUMENT = "document"
+        VIDEO = "video"
+
+        VALID_TYPES = [TEXT, CURRENCY, DATE_TIME, IMAGE, DOCUMENT, VIDEO].freeze
+      end
+
+      # Returns Text string if the parameter object type is text.
+      # For the header component, the character limit is 60 characters.
+      # For the body component, the character limit is 1024 characters.
+      #
+      # @returns text [String]
+      attr_accessor :text
+
+      # Returns Currency if the parameter object type is currency.
+      #
+      # @returns currency [Currency]
+      attr_accessor :currency
+
+      # Returns date_time if the parameter object type is date_time.
+      #
+      # @returns date_time [DateTime]
+      attr_accessor :date_time
+
+      # Returns image if the parameter object type is image.
+      #
+      # @returns image [Media]
+      attr_accessor :image
+
+      # Returns document if the parameter object type is document.
+      #
+      # @returns document [Media]
+      attr_accessor :document
+
+      # Returns video if the parameter object type is video.
+      #
+      # @returns video [Media]
+      attr_accessor :video
+
+      def initialize(type:, text: nil, currency: nil, date_time: nil, image: nil, document: nil, video: nil)
+        @type = type
+        @text = text
+        @currency = currency
+        @date_time = date_time
+        @image = image
+        @document = document
+        @video = video
+        validate
+      end
+
+      def to_json(*_args)
+        json = { type: type }
+        json[type.to_sym] = case type
+                            when "text"
+                              text
+                            when "currency"
+                              currency.to_json
+                            when "date_time"
+                              date_time.to_json
+                            when "image"
+                              image.to_json
+                            when "document"
+                              document.to_json
+                            when "video"
+                              video.to_json
+                            else
+                              raise "Invalid type: #{type}"
+                            end
+
+        json
+      end
+
+      private
+
+      def validate
+        validate_attributes
+        validate_type
+      end
+
+      def validate_type
+        return if Type::VALID_TYPES.include?(type)
+
+        raise InvalidType, type
+      end
+
+      def validate_attributes
+        [
+          [:text, text],
+          [:currency, currency],
+          [:date_time, date_time],
+          [:image, image],
+          [:document, document],
+          [:video, video]
+        ].each do |type_sym, value|
+          next unless type == type_sym
+          raise MissingValue.new(type, "#{type} is required when the type is #{type}") if value.nil?
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk.rb

@@ -1,24 +1,38 @@
 # frozen_string_literal: true
 
+# Configuration
+require_relative "whatsapp_sdk/configuration"
+
 # APIs
 require_relative "whatsapp_sdk/api/phone_numbers"
 require_relative "whatsapp_sdk/api/messages"
+require_relative "whatsapp_sdk/api/medias"
 require_relative "whatsapp_sdk/api/client"
 
 # APIs responses
 require_relative "whatsapp_sdk/api/responses/message_data_response"
 require_relative "whatsapp_sdk/api/responses/phone_number_data_response"
 require_relative "whatsapp_sdk/api/responses/phone_numbers_data_response"
-require_relative "whatsapp_sdk/api/responses/error_response"
+require_relative "whatsapp_sdk/api/responses/message_error_response"
 require_relative "whatsapp_sdk/api/responses/data_response"
+require_relative "whatsapp_sdk/api/responses/read_message_data_response"
+require_relative "whatsapp_sdk/api/responses/media_data_response"
+require_relative "whatsapp_sdk/api/responses/success_response"
+require_relative "whatsapp_sdk/api/responses/error_response"
 
 # Resources
 require_relative "whatsapp_sdk/resource/address"
+require_relative "whatsapp_sdk/resource/button_parameter"
+require_relative "whatsapp_sdk/resource/component"
 require_relative "whatsapp_sdk/resource/contact_response"
 require_relative "whatsapp_sdk/resource/contact"
+require_relative "whatsapp_sdk/resource/currency"
+require_relative "whatsapp_sdk/resource/date_time"
 require_relative "whatsapp_sdk/resource/email"
+require_relative "whatsapp_sdk/resource/media"
 require_relative "whatsapp_sdk/resource/message"
 require_relative "whatsapp_sdk/resource/name"
 require_relative "whatsapp_sdk/resource/org"
+require_relative "whatsapp_sdk/resource/parameter_object"
 require_relative "whatsapp_sdk/resource/phone_number"
 require_relative "whatsapp_sdk/resource/url"