whatsapp_sdk 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb8ebc1170878767c0800ab380f6cca2cd853fe59ec7496921781ef85fde8fb
-  data.tar.gz: 67e312ba37cc9c8e612af0a5d0840c1b7933eb3dfcebb9641faee41194387d21
+  metadata.gz: acff9c2aa69b398017bced8fbbf81d3d82eb4088f91b2dda24e3638da6c2240a
+  data.tar.gz: '0269bed60b15e5c8f1f1e4057f7683f5fe2ea8d931549390037f040530f125ad'
 SHA512:
-  metadata.gz: 856af75ac80060b7f0c6e282fc64d396a102dc31c6cbd8bf09c15bcee55b265ee4e0e5ffbff7e3bab055659233cd4d2db087a6303598128d881ae935b5d45685
-  data.tar.gz: d709a2b39b758cb294a1cc682320bfa4be3a634d137561e01b79f66c3df042312a31e07925d774ab42e84b51e7597a1b20bb6ef1965503a84085cfb1827aca58
+  metadata.gz: 70225a9c4b03a4c80e5c300d04eb61b8db45e0933a3aaef35fee71562c021adf80e33e3917b5439946b1d5690820ed4348e108f95692a8e614b221a7010761a1
+  data.tar.gz: b0ce380977fc51bf9f79f5fdd40c75ae533239ee78e40a15081b9f9bc19c827b94399373d979b82ad940fd9ac0a3d1ad4b3493ce27ae6f021e4df04d7c834d66

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Unreleased 
 
+# v 0.9.2
+- Add Support to image/webp sticker media. @renatovico [#94](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/issues/94)
+
+# v 0.9.1
+- Invalidate unsupported and invalid media types @ignacio-chiazzo [#89](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/89)
+
 # 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)

data/Gemfile.lock

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

data/README.md

@@ -31,25 +31,26 @@ Or install it yourself as:
 
 ## Quick Start
 
-There are three primary resources, `Messages`, `Media` and `PhoneNumbers`. `Messages` allows users to send any kind of message (text, audio, location, video, image, etc.). `Media` allows users to manage media, and `Phone Numbers` enable clients to query the associated phone numbers.
+There are three primary resources, `Messages`, `Media` and `PhoneNumbers`. `Messages` allows users to send any message (text, audio, location, video, image, etc.). `Media` allows users to manage media, and `Phone Numbers` enable clients to query the associated phone numbers.
 
-To use `Messages`, `Media` or `PhoneNumbers`, you need to initialize the `Client` that contains auth information. There are two ways to do it
+To use `Messages`, `Media` or `PhoneNumbers`, you need to initialize the `Client` that contains auth information. There are two ways to do it.
 
-1) Using an initializer
+1) Use an initializer
   
 ```ruby
+# config/initializers/whatsapp_sdk.rb
 WhatsappSdk.configure do |config|
   config.access_token = ACCESS_TOKEN
 end
 ```
-OR 2) creating a `Client` instance and pass it to the `Messages`, `Medias` or `PhoneNumbers` instance like this:
+OR 2) Create a `Client` instance and pass it to the `Messages`, `Medias` or `PhoneNumbers` instance like this:
 
 ```ruby
 client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access token
 messages_api = WhatsappSdk::Api::Messages.new(client)
 ```
 
-Each API operation returns a `WhatsappSdk::Api::Response` that contains `data` and `error` and a couple of helpful functions such as `ok?` and `error?`. There are three types of response `WhatsappSdk::Api::MessageDataResponse`, `WhatsappSdk::Api::PhoneNumberDataResponse` and `WhatsappSdk::Api::PhoneNumbersDataResponse`. Each of them contains different attributes.
+Each API operation returns a `WhatsappSdk::Api::Response` that contains `data` and `error` and a couple of helpful functions such as `ok?` and `error?`. There are three types of responses `WhatsappSdk::Api::MessageDataResponse`, `WhatsappSdk::Api::PhoneNumberDataResponse` and `WhatsappSdk::Api::PhoneNumbersDataResponse`. Each of them contains different attributes.
 
 ## Set up a Meta app
 
@@ -480,17 +481,17 @@ Visit [the example file](/example.rb) with examples to call the API in a single
 
 ## Troubleshooting
 
-- If the API response is `success`,  but the message is not delivered, ensure the device you're sending the message to is using a supported Whatsapp version. [Check documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/troubleshooting#message-not-delivered). Try also replying a message to the number your registered on your Whatsapp.
+- If the API response is `success`,  but the message is not delivered, ensure the device you're sending the message to is using a supported Whatsapp version. [Check documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/troubleshooting#message-not-delivered). Try also replying a message to the number you are registered on your Whatsapp.
 - Ensure your Meta App uses an API version greater than or equal to `v.14`.
-- Ensure that the Panel in the Facebook dashboard doesn't display any error.
+- Ensure that the Panel in the Facebook dashboard doesn't display any errors.
 
-Note: Sometimes the messages are delayed, see [Meta documentation](https://developers.facebook.com/docs/whatsapp/on-premises/guides/send-message-performance#delays). 
+Note: Sometimes the messages are delayed; see [Meta documentation](https://developers.facebook.com/docs/whatsapp/on-premises/guides/send-message-performance#delays). 
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Run ' bundle exec rake install ' to install this gem onto your local machine. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ### Run all the tests
 - **Unit tests:** Run `rake test`
@@ -506,6 +507,9 @@ Bug reports and pull requests are welcome on GitHub at [https://github.com/ignac
 
 If you want a feature to be implemented in the gem, please, open an issue and we will take a look as soon as we can. 
 
+
+Do you want to contribute and are unsure where to start? Ping me on Twitter, and I will help you!
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/example.rb

@@ -22,12 +22,11 @@ require "pry-nav"
 
 ################# UPDATE CONSTANTS #################
 
-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"
+ACCESS_TOKEN = "<TODO replace>"
+SENDER_ID = "<TODO replace>"
+RECIPIENT_NUMBER = "<TODO replace>"
+BUSINESS_ID = "<TODO replace>"
+IMAGE_LINK = "<TODO replace>"
 
 if ACCESS_TOKEN == "<TODO replace>"
   puts "\n\n**** Please update the ACCESS_TOKEN constant in this file. ****\n\n"
@@ -53,24 +52,6 @@ medias_api = WhatsappSdk::Api::Medias.new
 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" } )

data/lib/whatsapp_sdk/api/client.rb

@@ -36,14 +36,14 @@ module WhatsappSdk
       end
 
       sig do
-        params(url: String, content_header: String, file_path: T.nilable(String))
+        params(url: String, content_type_header: String, file_path: T.nilable(String))
           .returns(Net::HTTPResponse)
       end
-      def download_file(url:, content_header:, file_path: nil)
+      def download_file(url:, content_type_header:, file_path: nil)
         uri = URI.parse(url)
         request = Net::HTTP::Get.new(uri)
         request["Authorization"] = "Bearer #{@access_token}"
-        request.content_type = content_header
+        request.content_type = content_type_header
         req_options = { use_ssl: uri.scheme == "https" }
 
         response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|

data/lib/whatsapp_sdk/api/medias.rb

@@ -6,8 +6,9 @@ require "faraday/multipart"
 
 require_relative "request"
 require_relative "response"
-require_relative '../../../lib/whatsapp_sdk/api/responses/media_data_response'
-require_relative '../../../lib/whatsapp_sdk/api/responses/success_response'
+require_relative 'responses/media_data_response'
+require_relative 'responses/success_response'
+require_relative '../resource/media_types'
 
 module WhatsappSdk
   module Api
@@ -19,9 +20,11 @@ module WhatsappSdk
         attr_reader :file_path
 
         sig { params(file_path: String).void }
-        def initialize(file_path)
+        def initialize(file_path:)
           @file_path = file_path
-          super("Couldn't find file_path: #{file_path}")
+
+          message = "Couldn't find file_path: #{file_path}"
+          super(message)
         end
       end
 
@@ -32,10 +35,10 @@ module WhatsappSdk
         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."
+        def initialize(media_type:)
+          @media_type = media_type
+          message =  "Invalid Media Type #{media_type}. See the supported types in the official documentation " \
+                     "https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types."
           super(message)
         end
       end
@@ -66,11 +69,11 @@ module WhatsappSdk
       # @return [WhatsappSdk::Api::Response] Response object.
       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)
+        raise InvalidMediaTypeError.new(media_type: media_type) unless valid_media_type?(media_type)
 
-        content_header = media_type
+        content_type_header = map_media_type_to_content_type_header(media_type)
 
-        response = download_file(url: url, file_path: file_path, content_header: content_header)
+        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
@@ -93,7 +96,7 @@ module WhatsappSdk
       # @return [WhatsappSdk::Api::Response] Response object.
       sig { params(sender_id: Integer, file_path: String, type: String).returns(WhatsappSdk::Api::Response) }
       def upload(sender_id:, file_path:, type:)
-        raise FileNotFoundError, file_path unless File.file?(file_path)
+        raise FileNotFoundError.new(file_path: file_path) unless File.file?(file_path)
 
         params = {
           messaging_product: "whatsapp",
@@ -128,10 +131,16 @@ module WhatsappSdk
 
       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
+      def map_media_type_to_content_type_header(media_type)
+        # Media type maps 1:1 to the content-type header.
+        # The list of supported types are in MediaTypes::SUPPORTED_TYPES.
+        # It uses the media type defined by IANA https://www.iana.org/assignments/media-types
+
+        media_type
+      end
+
+      def valid_media_type?(media_type)
+        WhatsappSdk::Resource::MediaTypes::SUPPORTED_MEDIA_TYPES.include?(media_type)
       end
     end
   end

data/lib/whatsapp_sdk/api/request.rb

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

data/lib/whatsapp_sdk/resource/media_types.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class MediaTypes
+      extend T::Sig
+
+      # The media types supported by Whatsapp. The list contains all the types defined in the Whatsapp API
+      # documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types
+      #
+      # The media type is used as a content-type header when downloading the file with MediasApi#download_file.
+      # The content-type header matches with the media type using Internet Assigned Numbers Authority (IANA).
+      # Media type list defined by IANA https://www.iana.org/assignments/media-types/media-types.xhtml
+      #
+
+      AUDIO_TYPES = %w[audio/aac audio/mp4 audio/mpeg audio/amr audio/ogg].freeze
+      DOCUMENT_TYPES = %w[
+        text/plain application/pdf application/vnd.ms-powerpoint application/msword application/vnd.ms-excel
+        application/vnd.openxmlformats-officedocument.wordprocessingml.document
+        application/vnd.openxmlformats-officedocument.presentationml.presentation
+        application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+      ].freeze
+      IMAGE_TYPES = %w[image/jpeg image/png].freeze
+      STICKER_TYPES = %w[image/webp].freeze
+      VIDEO_TYPES = %w[video/mp4 video/3gp].freeze
+
+      SUPPORTED_MEDIA_TYPES = [AUDIO_TYPES + DOCUMENT_TYPES + IMAGE_TYPES + STICKER_TYPES + VIDEO_TYPES].flatten.freeze
+    end
+  end
+end

data/lib/whatsapp_sdk/version.rb

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

data/sorbet/rbi/annotations/mocha.rbi

@@ -18,8 +18,8 @@ module Mocha::ClassMethods
 end
 
 class Mocha::Expectation
-  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(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(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.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -191,6 +191,7 @@ files:
 - lib/whatsapp_sdk/resource/interactive_footer.rb
 - lib/whatsapp_sdk/resource/interactive_header.rb
 - lib/whatsapp_sdk/resource/media.rb
+- lib/whatsapp_sdk/resource/media_types.rb
 - lib/whatsapp_sdk/resource/message.rb
 - lib/whatsapp_sdk/resource/name.rb
 - lib/whatsapp_sdk/resource/org.rb