whatsapp_sdk 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6eccb61d3c648fa1c8a2a7e56512c1887b1aad9eb99f2569927f810b1754f8
-  data.tar.gz: 5cada724227ef568c36ec56a2a206752e170946e8890acefe504b24f821e9ab6
+  metadata.gz: fa0d6e4b9794168087c75aab57f48d377184850652b7cf7b9ffee57879a38c82
+  data.tar.gz: 25fc304e0f05d91b00897dc8c30b27040da480b78de38f3ec277119c610cdc7c
 SHA512:
-  metadata.gz: d9b534bc13fb8fad31fc31245417cf508537c4edd851b1d9cc6e546f50fbede19dd8bccbbe636194f49c1a40bbe721307b2dd8c1f0c4ea21cdc8ec643423d2db
-  data.tar.gz: 5f99f8a13ce068bd9667a719c7cdebcc87de874fb8b0cc7b06f6b0e1c857d888241ea6188ac6c9c9155a4184059effaade3c6255969a59b4a72cfa17d3c7abfc
+  metadata.gz: 2105c7f9a2a777dce4e486c3e8a1eef8e65b0888e06bd4f01d11822532e7162a5183c07606e96af4aa8ffdfd0c14a10a52b23cffd4a51f869aa9e8435ce0a210
+  data.tar.gz: 655c3432bf4088c9a408b297761e18a996beffda0ff72fc3516fb6988bbd024f0239b0b89cbf351ee30972375f6c1f5f181c4b45eeae9c973592e93766f78ae6

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-# Unreleased 
+# Unreleased
+
+# v 0.10.0
+- Implement Templates API @emersonu, @ignacio-chiazzo [#90](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/90)
+- Using compatible Gem versions instead of fixed dependency versions @nbluis [#108](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/108)
+- [Breaking Change] Rename `error` module with `errors`. @ignacio-chiazzo [#101](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/101)
+
+If you are calling an error using `WhatsappSdk::Resource::Error`, you should update it to `WhatsappSdk::Resource::Errors`, e.g. `WhatsappSdk::Resource::Errors::MissingArgumentError`
+
+# 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)

data/Gemfile

@@ -5,12 +5,6 @@ source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem("faraday")
-gem("faraday-multipart")
-gem("rake", ">= 12.3.3")
-gem('sorbet-runtime')
-gem("zeitwerk", ">= 2.6.0")
-
 group(:test) do
   gem('mocha')
   gem('rubocop', require: false)

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.9.1)
-      faraday (~> 2.3.0)
-      faraday-multipart (~> 1.0.4)
-      sorbet-runtime (~> 0.5.1)
-      zeitwerk (~> 2.6.0)
+    whatsapp_sdk (0.10.0)
+      faraday (~> 2)
+      faraday-multipart (~> 1)
+      sorbet-runtime (~> 0.5)
+      zeitwerk (~> 2)
 
 GEM
   remote: https://rubygems.org/
@@ -13,21 +13,23 @@ GEM
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.2.0)
     coderay (1.1.3)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.7.12)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (2.1.0)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
     method_source (1.0.0)
     minitest (5.16.1)
     mocha (1.14.0)
-    multipart-post (2.2.3)
+    multipart-post (2.3.0)
     netrc (0.11.0)
     parallel (1.22.1)
     parser (3.1.2.0)
@@ -39,7 +41,7 @@ GEM
       pry (>= 0.9.10, < 0.15)
     public_suffix (5.0.0)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (12.3.3)
     rbi (0.0.15)
       ast
       parser (>= 2.6.4.0)
@@ -70,6 +72,7 @@ GEM
     sorbet (0.5.10346)
       sorbet-static (= 0.5.10346)
     sorbet-runtime (0.5.10346)
+    sorbet-static (0.5.10346-universal-darwin-19)
     sorbet-static (0.5.10346-universal-darwin-21)
     sorbet-static (0.5.10346-x86_64-linux)
     sorbet-static-and-runtime (0.5.10346)
@@ -104,33 +107,30 @@ GEM
     yard-sorbet (0.7.0)
       sorbet-runtime (>= 0.5)
       yard (>= 0.9)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-darwin-19
   x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.3)
-  faraday
-  faraday-multipart
   minitest (~> 5.0)
   mocha
   pry
   pry-nav
-  rake (>= 12.3.3)
+  rake (~> 12.3)
   rubocop
   rubocop-minitest
   rubocop-performance
   rubocop-sorbet
   sorbet
-  sorbet-runtime
   spoom
   tapioca
   webmock
   whatsapp_sdk!
-  zeitwerk (>= 2.6.0)
 
 BUNDLED WITH
    2.3.22

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
 
@@ -123,12 +124,31 @@ messages_api = WhatsappSdk::Api::Messages.new
 phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
 medias_api = WhatsappSdk::Api::Medias.new
 business_profile_api = WhatsappSdk::Api::BusinessProfile.new
+templates_api = WhatsappSdk::Api::Templates.new
 ```
 
 Note: Remember to initialize the client first!
 
 ## APIs
 
+### Templates
+<details>
+
+```ruby
+# Get list of templates
+templates_api.templates(business_id: BUSINESS_ID)
+
+# Create a template
+new_template = templates_api.create(
+  business_id: BUSINESS_ID, name: "seasonal_promotion", language: "en_US", category: "MARKETING",
+  components_json: components_json, allow_category_change: true
+) 
+
+# Delete a template
+templates_api.delete(business_id: BUSINESS_ID, name: "my_name") # delete by name
+```
+</details>
+
 ### Business Profile API
 <details>
 
@@ -480,17 +500,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 +526,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

@@ -48,10 +48,76 @@ def print_message_sent(message_response)
 end
 ##################################################
 
+
 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
+templates_api = WhatsappSdk::Api::Templates.new
+
+############################## Templates API ##############################
+
+## Get list of templates
+templates_api.templates(business_id: BUSINESS_ID)
+
+## Get message templates namespace
+templates_api.get_message_template_namespace(business_id: BUSINESS_ID)
+
+# Create a template
+components_json = [
+  {
+    "type": "BODY",
+    "text": "Thank you for your order, {{1}}! Your confirmation number is {{2}}. If you have any questions, please use the buttons below to contact support. Thank you for being a customer!",
+    "example": {
+      "body_text": [
+        [
+          "Ignacio","860198-230332"
+        ]
+      ]
+    }
+  },
+  {
+    "type": "BUTTONS",
+    "buttons": [
+      {
+        "type": "PHONE_NUMBER",
+        "text": "Call",
+        "phone_number": "59898400766"
+      },
+      {
+        "type": "URL",
+        "text": "Contact Support",
+        "url": "https://www.luckyshrub.com/support"
+      }
+    ]
+  }
+]
+
+new_template = templates_api.create(
+  business_id: BUSINESS_ID, name: "seasonal_promotion", language: "ka", category: "MARKETING",
+  components_json: components_json, allow_category_change: true
+)
+
+# Update a template
+components_json = [
+  {
+    "type" => "header",
+    "parameters" => [
+      {
+        "type" => "image",
+        "image" => {
+          "link" => "https://www.google.com/imgres?imgurl=https%3A%2F%2Fqph.cf2.quoracdn.net%2Fmain-qimg-6d977408fdd90a09a1fee7ba9e2f777c-lq&imgrefurl=https%3A%2F%2Fwww.quora.com%2FHow-can-I-find-my-WhatsApp-ID&tbnid=lDAx1vzXwqCakM&vet=12ahUKEwjKupLviJX4AhVrrHIEHQpGD9MQMygAegUIARC9AQ..i&docid=s-DNQVCrZmhJYM&w=602&h=339&q=example%20whatsapp%20image%20id&ved=2ahUKEwjKupLviJX4AhVrrHIEHQpGD9MQMygAegUIARC9AQ"
+        }
+      }
+    ]
+  }
+]
+templates_api.update(template_id: "1624560287967996", category: "UTILITY")
+
+## Delete a template
+templates_api.delete(business_id: BUSINESS_ID, name: "seasonal_promotion") # delete by name
+# templates_api.delete(business_id: BUSINESS_ID, name: "name2", hsm_id: "243213188351928") # delete by name and id
+
 ############################## 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" } )
@@ -107,7 +173,7 @@ message_id = message_sent.data.messages.first.id
 messages_api.send_reaction(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, message_id: message_id, emoji: "\u{1f550}")
 messages_api.send_reaction(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, message_id: message_id, emoji: "⛄️")
 
-######### Reply to a message 
+######### Reply to a message
 message_to_reply_id = message_sent.data.messages.first.id
 reply = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, message: "I'm a reply", message_id: message_to_reply_id)
 print_message_sent(reply)

data/lib/whatsapp_sdk/api/business_profile.rb

@@ -12,17 +12,17 @@ module WhatsappSdk
       # Get the details of business profile.
       #
       # @param phone_number_id [Integer] Phone Number Id.
-      # @return [WhatsappSdk::Api::Response] Response object.
-      sig { params(phone_number_id: Integer).returns(WhatsappSdk::Api::Response) }
+      # @return [Api::Response] Response object.
+      sig { params(phone_number_id: Integer).returns(Api::Response) }
       def details(phone_number_id)
         response = send_request(
           http_method: "get",
           endpoint: "#{phone_number_id}/whatsapp_business_profile?fields=#{DEFAULT_FIELDS}"
         )
 
-        WhatsappSdk::Api::Response.new(
+        Api::Response.new(
           response: response,
-          data_class_type: WhatsappSdk::Api::Responses::BusinessProfileDataResponse
+          data_class_type: Api::Responses::BusinessProfileDataResponse
         )
       end
 
@@ -30,11 +30,11 @@ module WhatsappSdk
       #
       # @param phone_number_id [Integer] Phone Number Id.
       # @param params [Hash] Params to update.
-      # @return [WhatsappSdk::Api::Response] Response object.
+      # @return [Api::Response] Response object.
       sig do
         params(
           phone_number_id: Integer, params: T::Hash[T.untyped, T.untyped]
-        ).returns(WhatsappSdk::Api::Response)
+        ).returns(Api::Response)
       end
       def update(phone_number_id:, params:)
         # this is a required field
@@ -46,9 +46,9 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(
+        Api::Response.new(
           response: response,
-          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse
+          data_class_type: Api::Responses::SuccessResponse
         )
       end
     end

data/lib/whatsapp_sdk/api/medias.rb

@@ -46,17 +46,17 @@ module WhatsappSdk
       # Get Media by ID.
       #
       # @param media_id [String] Media Id.
-      # @return [WhatsappSdk::Api::Response] Response object.
-      sig { params(media_id: String).returns(WhatsappSdk::Api::Response) }
+      # @return [Api::Response] Response object.
+      sig { params(media_id: String).returns(Api::Response) }
       def media(media_id:)
         response = send_request(
           http_method: "get",
           endpoint: "/#{media_id}"
         )
 
-        WhatsappSdk::Api::Response.new(
+        Api::Response.new(
           response: response,
-          data_class_type: WhatsappSdk::Api::Responses::MediaDataResponse
+          data_class_type: Api::Responses::MediaDataResponse
         )
       end
 
@@ -66,8 +66,8 @@ module WhatsappSdk
       # @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, media_type: String).returns(WhatsappSdk::Api::Response) }
+      # @return [Api::Response] Response object.
+      sig { params(url: String, file_path: String, media_type: String).returns(Api::Response) }
       def download(url:, file_path:, media_type:)
         raise InvalidMediaTypeError.new(media_type: media_type) unless valid_media_type?(media_type)
 
@@ -80,10 +80,10 @@ module WhatsappSdk
                      { "error" => true, "status" => response.code }
                    end
 
-        WhatsappSdk::Api::Response.new(
+        Api::Response.new(
           response: response,
-          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse,
-          error_class_type: WhatsappSdk::Api::Responses::ErrorResponse
+          data_class_type: Api::Responses::SuccessResponse,
+          error_class_type: Api::Responses::ErrorResponse
         )
       end
 
@@ -93,8 +93,8 @@ 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 [WhatsappSdk::Api::Response] Response object.
-      sig { params(sender_id: Integer, file_path: String, type: String).returns(WhatsappSdk::Api::Response) }
+      # @return [Api::Response] Response object.
+      sig { params(sender_id: Integer, file_path: String, type: String).returns(Api::Response) }
       def upload(sender_id:, file_path:, type:)
         raise FileNotFoundError.new(file_path: file_path) unless File.file?(file_path)
 
@@ -106,26 +106,26 @@ module WhatsappSdk
 
         response = send_request(http_method: "post", endpoint: "#{sender_id}/media", params: params)
 
-        WhatsappSdk::Api::Response.new(
+        Api::Response.new(
           response: response,
-          data_class_type: WhatsappSdk::Api::Responses::MediaDataResponse
+          data_class_type: Api::Responses::MediaDataResponse
         )
       end
 
       # Delete a Media by ID.
       #
       # @param media_id [String] Media Id.
-      # @return [WhatsappSdk::Api::Response] Response object.
-      sig { params(media_id: String).returns(WhatsappSdk::Api::Response) }
+      # @return [Api::Response] Response object.
+      sig { params(media_id: String).returns(Api::Response) }
       def delete(media_id:)
         response = send_request(
           http_method: "delete",
           endpoint: "/#{media_id}"
         )
 
-        WhatsappSdk::Api::Response.new(
+        Api::Response.new(
           response: response,
-          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse
+          data_class_type: Api::Responses::SuccessResponse
         )
       end
 
@@ -140,7 +140,7 @@ module WhatsappSdk
       end
 
       def valid_media_type?(media_type)
-        WhatsappSdk::Resource::MediaTypes::SUPPORTED_MEDIA_TYPES.include?(media_type)
+        Resource::MediaTypes::SUPPORTED_MEDIA_TYPES.include?(media_type)
       end
     end
   end