whatsapp_sdk 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1d072bf1bc9cd834a9917a863177cc0b5b2ddfac0c29b0d4e899ee23cb9c19
-  data.tar.gz: 25dca7a61a5d80d19fcf32fa54e07edcb911901e936c5b315e46488d87c8b900
+  metadata.gz: 5fb8ebc1170878767c0800ab380f6cca2cd853fe59ec7496921781ef85fde8fb
+  data.tar.gz: 67e312ba37cc9c8e612af0a5d0840c1b7933eb3dfcebb9641faee41194387d21
 SHA512:
-  metadata.gz: 5a1204308855d7fb8945a5fda9a3939928b0ec5d6cc6e65fe95abfb303eec2f3dfa4f667f6b9cfc3c264144cdf8290eb80e7aa2ed5e60b213da398d1beded5ef
-  data.tar.gz: 82039c3038209445ad552cca6c23755d8acf2662af4ff6c3fb63464979a42533c92d5768cd376c72252e5b4058932b71a8b9d393471aeb7ba4903a1b62358c12
+  metadata.gz: 856af75ac80060b7f0c6e282fc64d396a102dc31c6cbd8bf09c15bcee55b265ee4e0e5ffbff7e3bab055659233cd4d2db087a6303598128d881ae935b5d45685
+  data.tar.gz: d709a2b39b758cb294a1cc682320bfa4be3a634d137561e01b79f66c3df042312a31e07925d774ab42e84b51e7597a1b20bb6ef1965503a84085cfb1827aca58

data/.gitignore

@@ -7,6 +7,8 @@
 /spec/reports/
 /tmp/
 
+example_copy.rb
+
 DELETE_ME
 REMOVE.rb
 

data/.rubocop.yml

@@ -31,6 +31,9 @@ Metrics/MethodLength:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
 Naming/VariableNumber:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased 
 
+# v 0.9.0
+- Use binary mode to download files @ignacio-chiazzo [#88](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/87)
+- Added support for downloading media by specifying the type @ignacio-chiazzo [#87](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/87)
+
 # v 0.8.0
 - Added Send interactive message @alienware [#82](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/82) 
 - Support JRuby @ignacio-chiazzo [#83](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/83)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.8.0)
+    whatsapp_sdk (0.9.0)
       faraday (~> 2.3.0)
       faraday-multipart (~> 1.0.4)
       sorbet-runtime (~> 0.5.1)

data/README.md

@@ -183,7 +183,7 @@ media = medias_api.media(media_id: MEDIA_ID)
 
 Download media
 ```ruby
-medias_api.download(url: MEDIA_URL, file_path: 'tmp/downloaded_whatsapp.png')
+medias_api.download(url: MEDIA_URL, file_path: 'tmp/downloaded_whatsapp.png', media_type: "image/png")
 ```
 
 Delete a media

data/example.rb

@@ -22,11 +22,12 @@ require "pry-nav"
 
 ################# UPDATE CONSTANTS #################
 
-ACCESS_TOKEN = "EAAZAvvr0DZBs0BAIOsVV2FogD1qQhIyIrK9vfM7mmfdTlhbRqFZAZBnS2ciXPD35wb8d69siULaU5cqX9HonDNnZA9YLAbrCLUys1qt1E3n4d69v9RTZCoA8bkz9TZCV2PWzRR9DvBmwUOltCOrZBN0vGQxULlhsJE1mTeUrXlpVfFZCY5sWXCKxe04uyd7dzyK0hMgvkCR97OXi9AI3qJFYo"
-SENDER_ID = 111591145018464
-RECIPIENT_NUMBER = 13437772910
-BUSINESS_ID = 102261539298487
+ACCESS_TOKEN = "EAAHlmy2rChwBAGELLYnNnJfhKOPuSuaX5cRrfYA65RLY2NlEsMQ4x4tO3fz2imwrhmyx2pvKnC07tm0sWRzFHEko7CtXoZBTSb3lrBrKlx86eDvtdZBm2P2ewEJPbotfMYhTYwLsfMyRdQqgNAmc0wij1hMTHOusZALovPKHsme3RvAo1Ag1wqZA3qrPB2WhZChhKWPOkVQZDZD"
+SENDER_ID = 100219219709628
+RECIPIENT_NUMBER = 15550429560
+BUSINESS_ID = 102_261_539_298_487
 IMAGE_LINK = "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"
+AUDIO_LINK = "https://lookaside.fbsbx.com/whatsapp_business/attachments/?mid=2951440611667284&ext=1681491953&hash=ATsLUNWiMmGDndn5YlpWQFHm5CUXca0gdahSJTCp5XjgTQ"
 
 if ACCESS_TOKEN == "<TODO replace>"
   puts "\n\n**** Please update the ACCESS_TOKEN constant in this file. ****\n\n"
@@ -53,6 +54,23 @@ messages_api = WhatsappSdk::Api::Messages.new
 phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
 business_profile_api = WhatsappSdk::Api::BusinessProfile.new
 
+binding.pry
+# upload an audio
+uploaded_media = medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/downloaded_audio.ogg", type: "audio/ogg")
+media_id = uploaded_media.data&.id
+puts "Uploaded media id: #{media_id}"
+
+# get a media audio
+media = medias_api.media(media_id: media_id).data
+puts "Media info: #{media.raw_data_response}"
+
+# get a media audio
+audio_link = media.url
+download_image = medias_api.download(url: audio_link, file_path: 'tmp/downloaded_audio2.ogg', media_type: "audio/ogg")
+puts "Downloaded: #{download_image.data.success?}"
+
+
+
 ############################## Business API ##############################
 business_profile = business_profile_api.details(SENDER_ID)
 business_profile_api.update(phone_number_id: SENDER_ID, params: { about: "A very cool business" } )
@@ -63,23 +81,39 @@ registered_numbers = phone_numbers_api.registered_numbers(BUSINESS_ID)
 
 ############################## Media API ##############################
 
-# upload a media
+##### Image #####
+# upload a Image
 uploaded_media = medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/whatsapp.png", type: "image/png")
 media_id = uploaded_media.data&.id
 puts "Uploaded media id: #{media_id}"
 
-# get a media
+# get a media Image
 media = medias_api.media(media_id: media_id).data
 puts "Media info: #{media.raw_data_response}"
 
-# download media
-download_image = medias_api.download(url: media&.url, file_path: 'tmp/downloaded_whatsapp.png')
+# download media Image
+download_image = medias_api.download(url: media.url, file_path: 'tmp/downloaded_image.png', media_type: "image/png")
 puts "Downloaded: #{download_image.data.success?}"
 
 # delete a media
 deleted_media = medias_api.delete(media_id: media&.id)
 puts "Deleted: #{deleted_media.data.success?}"
 
+#### Audio ####
+# upload an audio
+uploaded_media = medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/downloaded_audio.ogg", type: "audio/ogg")
+media_id = uploaded_media.data&.id
+puts "Uploaded media id: #{media_id}"
+
+# get a media audio
+media = medias_api.media(media_id: media_id).data
+puts "Media info: #{media.raw_data_response}"
+
+# get a media audio
+audio_link = media.url
+download_image = medias_api.download(url: audio_link, file_path: 'tmp/downloaded_audio2.ogg', media_type: "audio/ogg")
+puts "Downloaded: #{download_image.data.success?}"
+
 ############################## Messages API ##############################
 
 ######### SEND A TEXT MESSAGE

data/lib/whatsapp_sdk/api/client.rb

@@ -35,18 +35,22 @@ module WhatsappSdk
         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

@@ -412,8 +412,8 @@ module WhatsappSdk
         )
       end
 
-      alias :send_interactive_reply_buttons :send_interactive_message
-      alias :send_interactive_list_messages :send_interactive_message
+      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/interactive_action.rb

@@ -61,7 +61,7 @@ module WhatsappSdk
       sig do
         params(
           type: Type, buttons: T::Array[InteractiveActionReplyButton],
-          button: String, sections: T::Array[InteractiveActionSection],
+          button: String, sections: T::Array[InteractiveActionSection]
         ).void
       end
       def initialize(type:, buttons: [], button: "", sections: [])
@@ -93,40 +93,48 @@ module WhatsappSdk
       def validate_fields
         case type.serialize
         when "list_message"
-          button_length = button.length
-          sections_count = sections.length
-          unless button_length > 0
-            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 { |section| section.validate }
+          validate_list_message
         when "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
+          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
 
-          button_ids = buttons.map(&:id)
-          return if button_ids.length.eql?(button_ids.uniq.length)
+        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,
-                "Duplicate ids #{button_ids} for buttons in action. They should be unique."
+                "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

data/lib/whatsapp_sdk/resource/interactive_action_section.rb

@@ -34,12 +34,10 @@ module WhatsappSdk
       end
 
       def to_json
-        json = {
+        {
           title: title,
-          rows: rows.map(&:to_json),
+          rows: rows.map(&:to_json)
         }
-
-        json
       end
 
       sig { params(skip_rows: T.nilable(T::Boolean)).void }
@@ -72,4 +70,3 @@ module WhatsappSdk
     end
   end
 end
-

data/lib/whatsapp_sdk/resource/interactive_action_section_row.rb

@@ -29,7 +29,7 @@ module WhatsappSdk
       ACTION_SECTION_DESCRIPTION_MAXIMUM = 72
       ACTION_SECTION_ID_MAXIMUM = 256
 
-      sig { params(title: String, id: String, description: T::nilable(String)).void }
+      sig { params(title: String, id: String, description: T.nilable(String)).void }
       def initialize(title:, id:, description: "")
         @title = title
         @id = id
@@ -42,7 +42,7 @@ module WhatsappSdk
           id: id,
           title: title
         }
-        json[:description] = description if description.length > 0
+        json[:description] = description if description.length.positive?
 
         json
       end
@@ -61,9 +61,9 @@ module WhatsappSdk
         title_length = title.length
         return if title_length <= ACTION_SECTION_TITLE_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow.new(
-          "Invalid length #{title_length} for title in section row. Maximum length: #{ACTION_SECTION_TITLE_MAXIMUM} characters.",
-        )
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
+              "Invalid length #{title_length} for title in section row. "\
+              "Maximum length: #{ACTION_SECTION_TITLE_MAXIMUM} characters."
       end
 
       sig { void }
@@ -74,9 +74,9 @@ module WhatsappSdk
         id_length = id.length
         return if id_length <= ACTION_SECTION_ID_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow.new(
-          "Invalid length #{id_length} for id in section row. Maximum length: #{ACTION_SECTION_ID_MAXIMUM} characters.",
-        )
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
+              "Invalid length #{id_length} for id in section row. Maximum length: "\
+              "#{ACTION_SECTION_ID_MAXIMUM} characters."
       end
 
       sig { void }
@@ -84,11 +84,10 @@ module WhatsappSdk
         description_length = description.length
         return if description_length <= ACTION_SECTION_DESCRIPTION_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow.new(
-          "Invalid length #{description_length} for description in section row. Maximum length: #{ACTION_SECTION_DESCRIPTION_MAXIMUM} characters.",
-        )
+        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
-

data/lib/whatsapp_sdk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module WhatsappSdk
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/sorbet/rbi/annotations/mocha.rbi

@@ -18,8 +18,8 @@ module Mocha::ClassMethods
 end
 
 class Mocha::Expectation
-  sig { params(expected_parameters: T.untyped, matching_block: T.nilable(T.proc.params(actual_parameters: T.untyped).void)).returns(Mocha::Expectation) }
-  def with(*expected_parameters, &matching_block); end
+  sig { params(expected_parameters_or_matchers: T.untyped, kwargs: T.untyped, matching_block: T.nilable(T.proc.params(actual_parameters: T.untyped).void)).returns(Mocha::Expectation) }
+  def with(*expected_parameters_or_matchers, **kwargs, &matching_block); end
 
   sig { params(values: T.untyped).returns(Mocha::Expectation) }
   def returns(*values); end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler