whatsapp_sdk 0.13.0 → 1.0.0

data/lib/whatsapp_sdk/api/medias.rb

@@ -4,9 +4,6 @@ require "faraday"
 require "faraday/multipart"
 
 require_relative "request"
-require_relative "response"
-require_relative 'responses/media_data_response'
-require_relative 'responses/success_response'
 require_relative '../resource/media_types'
 
 module WhatsappSdk
@@ -37,17 +34,19 @@ module WhatsappSdk
       # Get Media by ID.
       #
       # @param media_id [String] Media Id.
-      # @return [Api::Response] Response object.
-      def media(media_id:)
+      # @return [Resource::Media] Media object.
+      def get(media_id:)
         response = send_request(
           http_method: "get",
           endpoint: "/#{media_id}"
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MediaDataResponse
-        )
+        Resource::Media.from_hash(response)
+      end
+
+      def media(media_id:)
+        warn "[DEPRECATION] `media` is deprecated. Please use `get` instead."
+        get(media_id: media_id)
       end
 
       # Download Media by URL.
@@ -57,7 +56,7 @@ module WhatsappSdk
       # @param media_type [String] The media type e.g. "audio/mp4". See possible types in the official
       #  documentation https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types,
       #  but note that the API may allow more depending on the client.
-      # @return [Api::Response] Response object.
+      # @return [Boolean] Whether the media was downloaded successfully.
       def download(url:, file_path:, media_type:)
         # Allow download of unsupported media types, since Cloud API may decide to let it through.
         #   https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/discussions/127
@@ -66,17 +65,16 @@ module WhatsappSdk
         content_type_header = map_media_type_to_content_type_header(media_type)
 
         response = download_file(url: url, file_path: file_path, content_type_header: content_type_header)
-        response = if response.code.to_i == 200
-                     { "success" => true }
-                   else
-                     { "error" => true, "status" => response.code }
-                   end
-
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::SuccessResponse,
-          error_class_type: Api::Responses::ErrorResponse
-        )
+
+        return true if response.code.to_i == 200
+
+        begin
+          body = JSON.parse(response.body)
+        rescue JSON::ParserError
+          body = { "message" => response.body }
+        end
+
+        raise Api::Responses::HttpResponseError.new(http_status: response.code, body: body)
       end
 
       # Upload a media.
@@ -85,7 +83,7 @@ module WhatsappSdk
       # @param type [String] Media type e.g. text/plain, video/3gp, image/jpeg, image/png. For more information,
       # see the official documentation https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types.
       #
-      # @return [Api::Response] Response object.
+      # @return [Api::Responses::IdResponse] IdResponse object.
       def upload(sender_id:, file_path:, type:, headers: {})
         raise FileNotFoundError.new(file_path: file_path) unless File.file?(file_path)
 
@@ -103,26 +101,20 @@ module WhatsappSdk
           multipart: true
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MediaDataResponse
-        )
+        Api::Responses::IdResponse.new(response["id"])
       end
 
       # Delete a Media by ID.
       #
       # @param media_id [String] Media Id.
-      # @return [Api::Response] Response object.
+      # @return [Boolean] Whether the media was deleted successfully.
       def delete(media_id:)
         response = send_request(
           http_method: "delete",
           endpoint: "/#{media_id}"
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::SuccessResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
       end
 
       private

data/lib/whatsapp_sdk/api/messages.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "request"
-require_relative "response"
 
 module WhatsappSdk
   module Api
@@ -14,7 +13,7 @@ module WhatsappSdk
       # @param recipient_number [Integer] Recipient' Phone number.
       # @param message [String] Text to send.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_text(sender_id:, recipient_number:, message:, message_id: nil)
         params = {
           messaging_product: "whatsapp",
@@ -31,10 +30,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send location.
@@ -46,7 +42,7 @@ module WhatsappSdk
       # @param name [String] Location name.
       # @param address [String] Location address.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_location(
         sender_id:, recipient_number:, longitude:, latitude:, name:, address:, message_id: nil
       )
@@ -70,10 +66,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send an image.
@@ -84,7 +77,7 @@ module WhatsappSdk
       # @param link [String] Image link.
       # @param caption [String] Image caption.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_image(
         sender_id:, recipient_number:, image_id: nil, link: nil, caption: "", message_id: nil
       )
@@ -109,10 +102,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send an audio.
@@ -122,7 +112,7 @@ module WhatsappSdk
       # @param audio_id [String] Audio ID.
       # @param link [String] Audio link.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_audio(sender_id:, recipient_number:, audio_id: nil, link: nil, message_id: nil)
         raise Resource::Errors::MissingArgumentError, "audio_id or link is required" if !audio_id && !link
 
@@ -142,10 +132,7 @@ module WhatsappSdk
           multipart: true
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send a video.
@@ -156,7 +143,7 @@ module WhatsappSdk
       # @param link [String] Image link.
       # @param caption [String] Image caption.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_video(
         sender_id:, recipient_number:, video_id: nil, link: nil, caption: "", message_id: nil
       )
@@ -181,10 +168,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send a document.
@@ -195,7 +179,7 @@ module WhatsappSdk
       # @param link [String] Image link.
       # @param caption [String] Image caption.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_document(
         sender_id:, recipient_number:, document_id: nil, link: nil, caption: "", message_id: nil, filename: nil
       )
@@ -224,10 +208,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send a document.
@@ -237,7 +218,7 @@ module WhatsappSdk
       # @param sticker_id [String] The sticker ID.
       # @param link [String] Image link.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_sticker(sender_id:, recipient_number:, sticker_id: nil, link: nil, message_id: nil)
         raise Resource::Errors::MissingArgumentError, "sticker or link is required" if !sticker_id && !link
 
@@ -256,10 +237,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send contacts.
@@ -270,7 +248,7 @@ module WhatsappSdk
       # @param contacts [Array<Contact>] Contacts.
       # @param contacts_json [Json] Contacts.
       # @param message_id [String] The id of the message to reply to.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_contacts(
         sender_id:, recipient_number:, contacts: nil, contacts_json: {}, message_id: nil
       )
@@ -289,10 +267,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # def send_interactive_button
@@ -309,7 +284,7 @@ module WhatsappSdk
       # @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 [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_interactive_message(
         sender_id:, recipient_number:, interactive: nil, interactive_json: nil, message_id: nil
       )
@@ -338,10 +313,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       alias send_interactive_reply_buttons send_interactive_message
@@ -351,7 +323,7 @@ module WhatsappSdk
       #
       # @param sender_id [Integer] Sender' phone number.
       # @param message_id [Integer] Message ID.
-      # @return [Api::Response] Response object.
+      # @return [Boolean] Whether the message was marked as read.
       def read_message(sender_id:, message_id:)
         params = {
           messaging_product: "whatsapp",
@@ -365,10 +337,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::ReadMessageDataResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
       end
 
       # Send template
@@ -379,7 +348,7 @@ module WhatsappSdk
       # @param language [String] template language.
       # @param components [Component] Component.
       # @param components_json [Json] The component as a Json. If you pass components_json, you can't pass components.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_template(
         sender_id:, recipient_number:, name:, language:, components: nil, components_json: nil
       )
@@ -411,10 +380,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       # Send reaction
@@ -423,7 +389,7 @@ module WhatsappSdk
       # @param recipient_number [Integer] Recipient' Phone number.
       # @param message_id [String] the id of the message to reaction.
       # @param emoji [String] unicode of the emoji to send.
-      # @return [Api::Response] Response object.
+      # @return [MessageDataResponse] Response object.
       def send_reaction(sender_id:, recipient_number:, message_id:, emoji:)
         params = {
           messaging_product: "whatsapp",
@@ -442,10 +408,7 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::MessageDataResponse
-        )
+        Api::Responses::MessageDataResponse.build_from_response(response: response)
       end
 
       private

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "request"
-require_relative "response"
 
 module WhatsappSdk
   module Api
@@ -16,39 +15,37 @@ module WhatsappSdk
       #
       # @param business_id [Integer] Business Id.
       # @return [Api::Response] Response object.
-      def registered_numbers(business_id)
+      def list(business_id)
         response = send_request(
           http_method: "get",
           endpoint: "#{business_id}/phone_numbers?fields=#{DEFAULT_FIELDS}"
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumbersDataResponse
+        Api::Responses::PaginationRecords.new(
+          records: parse_phone_numbers(response['data']),
+          before: response['paging']['cursors']['before'],
+          after: response['paging']['cursors']['after']
         )
       end
 
-      # Get the registered number id.
+      # Get the registered number.
       #
       # @param phone_number_id [Integer] The registered number we want to retrieve.
-      # @return [Api::Response] Response object.
-      def registered_number(phone_number_id)
+      # @return [Resource::PhoneNumber] A PhoneNumber object.
+      def get(phone_number_id)
         response = send_request(
           http_method: "get",
           endpoint: "#{phone_number_id}?fields=#{DEFAULT_FIELDS}"
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumberDataResponse
-        )
+        Resource::PhoneNumber.from_hash(response)
       end
 
       # Register a phone number.
       #
       # @param phone_number_id [Integer] The registered number we want to retrieve.
       # @param pin [Integer] Pin of 6 digits.
-      # @return [Api::Response] Response object.
+      # @return [Boolean] Whether the registration was successful.
       def register_number(phone_number_id, pin)
         response = send_request(
           http_method: "post",
@@ -56,16 +53,13 @@ module WhatsappSdk
           params: { messaging_product: 'whatsapp', pin: pin }
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumberDataResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
       end
 
       # Deregister a phone number.
       #
       # @param phone_number_id [Integer] The registered number we want to retrieve.
-      # @return [Api::Response] Response object.
+      # @return [Boolean] Whether the deregistration was successful.
       def deregister_number(phone_number_id)
         response = send_request(
           http_method: "post",
@@ -73,10 +67,26 @@ module WhatsappSdk
           params: {}
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumberDataResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
+      end
+
+      # deprecated methods
+      def registered_numbers(business_id)
+        warn "[DEPRECATION] `registered_numbers` is deprecated. Please use `list` instead."
+        list(business_id)
+      end
+
+      def registered_number(phone_number_id)
+        warn "[DEPRECATION] `registered_number` is deprecated. Please use `get` instead."
+        get(phone_number_id)
+      end
+
+      private
+
+      def parse_phone_numbers(phone_numbers_data)
+        phone_numbers_data.map do |phone_number|
+          Resource::PhoneNumber.from_hash(phone_number)
+        end
       end
     end
   end

data/lib/whatsapp_sdk/api/request.rb

@@ -1,6 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
+require_relative "../../whatsapp_sdk"
+
 module WhatsappSdk
   module Api
     class Request

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

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "error_response"
-
 module WhatsappSdk
   module Api
     module Responses
-      class GenericErrorResponse < ErrorResponse
+      class GenericErrorResponse
         attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
 
         def initialize(response:)
@@ -15,8 +13,10 @@ module WhatsappSdk
           @type = response["type"]
           @data = response["data"]
           @fbtrace_id = response["fbtrace_id"]
+        end
 
-          super(response: response)
+        def self.response_error?(response:)
+          response["error"]
         end
 
         def self.build_from_response(response:)

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class HttpResponseError < StandardError
+        attr_reader :http_status, :body, :error_info
+
+        def initialize(http_status:, body:)
+          super
+          @http_status = http_status
+          @body = body
+          @error_info = GenericErrorResponse.build_from_response(response: body)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/{message_error_response.rb → id_response.rb}

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "generic_error_response"
-
 module WhatsappSdk
   module Api
     module Responses
-      class MessageErrorResponse < GenericErrorResponse
+      class IdResponse
+        attr_accessor :id
+
+        def initialize(id)
+          @id = id
+        end
       end
     end
   end

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

@@ -1,37 +1,34 @@
 # frozen_string_literal: true
 
-require_relative "../request"
-require_relative "data_response"
 require_relative "../../resource/message"
 require_relative "../../resource/contact_response"
 
 module WhatsappSdk
   module Api
     module Responses
-      class MessageDataResponse < DataResponse
-        attr_reader :contacts, :messages
+      class MessageDataResponse
+        attr_accessor :contacts, :messages
 
-        def initialize(response:)
-          @contacts = response["contacts"]&.map { |contact_json| parse_contact(contact_json) }
-          @messages = response["messages"]&.map { |contact_json| parse_message(contact_json) }
+        class << self
+          def build_from_response(response:)
+            return unless response["messages"]
 
-          super(response)
-        end
-
-        def self.build_from_response(response:)
-          return unless response["messages"]
+            data_response = new
+            data_response.contacts = response["contacts"]&.map { |contact_json| parse_contact(contact_json) }
+            data_response.messages = response["messages"]&.map { |contact_json| parse_message(contact_json) }
 
-          new(response: response)
-        end
+            data_response
+          end
 
-        private
+          private
 
-        def parse_message(message_json)
-          Resource::Message.new(id: message_json["id"])
-        end
+          def parse_message(message_json)
+            Resource::Message.new(id: message_json["id"])
+          end
 
-        def parse_contact(contact_json)
-          Resource::ContactResponse.new(input: contact_json["input"], wa_id: contact_json["wa_id"])
+          def parse_contact(contact_json)
+            Resource::ContactResponse.new(input: contact_json["input"], wa_id: contact_json["wa_id"])
+          end
         end
       end
     end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class PaginationRecords
+        attr_reader :records, :before, :after
+
+        def initialize(records:, before:, after:)
+          @records = records
+          @before = before
+          @after = after
+        end
+      end
+    end
+  end
+end

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

@@ -1,24 +1,11 @@
 # 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
+      class SuccessResponse
+        def self.success_response?(response:)
+          response["success"] == true
         end
       end
     end