whatsapp_sdk 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d70f3c946148d4935fa447fae876defaea2a086f944ff94b3838c306c925752
-  data.tar.gz: afd71dd8d1fc23fd4000ed7263f868724db24a120c247c8e5a1ac1dc41a86d56
+  metadata.gz: d7cfa077303348e47c90cfcbda06cd977a1ccbd60680cc3dcbdfe609109b4570
+  data.tar.gz: 9a9d46ee397b70538e41f6489f5b0a72fc44054e154164d3fa383cccba5acdfa
 SHA512:
-  metadata.gz: aed5dd70fb476006f5d0d68089549eb646fddb761b1521e16b65ded7b4d1150354618d0bb6fd63f45478236af5369bdb4c9fe9ac512ab6bd957c1dc6d667b7a4
-  data.tar.gz: de335d17ff40f47625a99636923b0053718ebca4d21c0dc24066a87570bb30385ec7f2dd3d8aa0c69c4c2afa0c6068bd7fb5b17f80a17df69de5ac77553ae906
+  metadata.gz: b08d94c4c773906cac506abb473f46281bfa233a9d56b5d6eaf294dfd53afca2c0cf4f70fb7f4019f6d1581697c43b54ff6556c1c50bfd95854cda54cf682952
+  data.tar.gz: 19ab26c648687e6ef2f7872ce0fa85b259b0fe2a91d6a41e2686d0b6cfe6bd6bf2e1727dd3daa84abd36de8b1d6dc19d1abaaaab7b5046f7af6ad06c80357f85

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# unreleased 
+
+# v 0.7.0
+Add message reaction @sanchezpaco [#58](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/58)
+Add Business update API @sahilbansal17 [#56](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/56)
+Fix Sorbet bug BusinessAPI [#60](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/60)
+
+# v 0.6.2
+Add Business Profiles API @sahilbansal17 [#53](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/53)
+
 # v 0.6.1
 Add raw_response to response [#47](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/46)
 

data/Gemfile

@@ -17,6 +17,7 @@ group(:test) do
   gem('rubocop', require: false)
   gem('rubocop-minitest', require: false)
   gem('rubocop-performance', require: false)
+  gem('webmock')
 end
 
 group(:development) do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.6.1)
+    whatsapp_sdk (0.7.0)
       faraday (>= 2.3.0)
       faraday-multipart (~> 1.0.4)
       oj (~> 3.13.13)
@@ -12,8 +12,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     coderay (1.1.3)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
     faraday (2.5.2)
       faraday-net_http (>= 2.0, < 3.1)
@@ -21,6 +25,7 @@ GEM
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
     faraday-net_http (3.0.0)
+    hashdiff (1.0.1)
     method_source (1.0.0)
     minitest (5.16.1)
     mocha (1.14.0)
@@ -35,6 +40,7 @@ GEM
       method_source (~> 1.0)
     pry-nav (1.0.0)
       pry (>= 0.9.10, < 0.15)
+    public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
     rbi (0.0.15)
@@ -66,6 +72,7 @@ GEM
       sorbet-static (= 0.5.10346)
     sorbet-runtime (0.5.10346)
     sorbet-static (0.5.10346-universal-darwin-21)
+    sorbet-static (0.5.10346-x86_64-linux)
     sorbet-static-and-runtime (0.5.10346)
       sorbet (= 0.5.10346)
       sorbet-runtime (= 0.5.10346)
@@ -88,6 +95,10 @@ GEM
     unparser (0.6.5)
       diff-lcs (~> 1.3)
       parser (>= 3.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
@@ -97,7 +108,9 @@ GEM
     zeitwerk (2.6.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.3)
@@ -116,6 +129,7 @@ DEPENDENCIES
   sorbet-runtime
   spoom
   tapioca
+  webmock
   whatsapp_sdk!
   zeitwerk (>= 2.6.0)
 

data/README.md

@@ -4,11 +4,14 @@
 <a href="https://codeclimate.com/github/ignacio-chiazzo/ruby_whatsapp_sdk/maintainability"><img src="https://api.codeclimate.com/v1/badges/169cce95450272e4ad7d/maintainability" /></a>
 
 The SDK provides a set of operations and classes to use the Whatsapp API.
-Send stickers, messages, audio, videos, and locations or just ask for the phone numbers through this library in a few steps!
+Send stickers, messages, audio, videos, locations, react to messages or just ask for the phone numbers through this library in a few steps!
 
 
+## Demo
+
 https://user-images.githubusercontent.com/11672878/173238826-6fc0a6f8-d0ee-4eae-8947-7dfd3b8b3446.mov
 
+**Check the [Ruby on Rails Whatsapp example repository](https://github.com/ignacio-chiazzo/ruby_on_rails_whatsapp_example)** that uses this library to send messages.
 
 ## Installation
 
@@ -119,12 +122,27 @@ First, create the client and then create an instance `WhatsappSdk::Api::Messages
 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
 ```
 
 Note: Remember to initialize the client first!
 
 ## APIs
 
+### Business Profile API
+<details>
+
+Get the details of your business
+```ruby
+business_profile = business_profile_api.details(123456)
+```
+
+Update the details of your business
+```ruby
+business_profile_api.update(phone_number_id: SENDER_ID, params: { about: "A very cool business" } )
+```
+</details>
+
 ### Phone numbers API
 
 <details>
@@ -181,6 +199,14 @@ messages_api.read_message(sender_id: 1234, message_id: "wamid.HBgLMTM0M123456789
 
 Note: To get the `message_id` you can set up [Webhooks](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components) that will listen and fire an event when a message is received.
 
+**Send a reaction to message**
+To send a reaction to a message, you need to obtain the mssage id and look for the emoji's unicode you want to use.
+
+```ruby
+messages_api.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "\u{1f550}")
+
+messages_api.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "⛄️")
+```
 
 **Send a location message**
 

data/example.rb

@@ -28,6 +28,11 @@ 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"
+  exit
+end
+
 ################# Initialize Client #################
 WhatsappSdk.configure do |config|
   config.access_token = ACCESS_TOKEN
@@ -46,10 +51,16 @@ 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
+
+############################## 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" } )
 
 ############################## Phone Numbers API ##############################
 registered_number = phone_numbers_api.registered_number(SENDER_ID)
 registered_numbers = phone_numbers_api.registered_numbers(BUSINESS_ID)
+
 ############################## Media API ##############################
 
 # upload a media
@@ -76,6 +87,12 @@ message_sent = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RE
                                       message: "Hey there! it's Whatsapp Ruby SDK")
 print_message_sent(message_sent)
 
+######### React to a message
+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: "⛄️")
+
+######### Send location
 location_sent = messages_api.send_location(
   sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
   longitude: -75.6898604, latitude: 45.4192206, name: "Ignacio", address: "My house"

data/lib/whatsapp_sdk/api/business_profile.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+# typed: strict
+
+require_relative "request"
+require_relative "response"
+
+module WhatsappSdk
+  module Api
+    class BusinessProfile < Request
+      DEFAULT_FIELDS = 'about,address,description,email,profile_picture_url,websites,vertical'
+
+      # 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) }
+      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(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::BusinessProfileDataResponse
+        )
+      end
+
+      # Update the details of business profile.
+      #
+      # @param phone_number_id [Integer] Phone Number Id.
+      # @param params [Hash] Params to update.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          phone_number_id: Integer, params: T::Hash[T.untyped, T.untyped]
+        ).returns(WhatsappSdk::Api::Response)
+      end
+      def update(phone_number_id:, params:)
+        # this is a required field
+        params[:messaging_product] = 'whatsapp'
+
+        response = send_request(
+          http_method: "post",
+          endpoint: "#{phone_number_id}/whatsapp_business_profile",
+          params: params
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse
+        )
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/client.rb

@@ -2,6 +2,7 @@
 # typed: strict
 
 require "faraday"
+require "faraday/multipart"
 require "oj"
 
 module WhatsappSdk
@@ -19,13 +20,20 @@ module WhatsappSdk
 
       sig do
         params(
-          endpoint: String, full_url: T.nilable(String), http_method: String, params: T::Hash[T.untyped, T.untyped]
-        ).returns(T::Hash[T.untyped, T.untyped])
+          endpoint: String,
+          full_url: T.nilable(String),
+          http_method: String,
+          params: T::Hash[T.untyped, T.untyped],
+          headers: T::Hash[T.untyped, T.untyped]
+        ).returns(T.nilable(T::Hash[T.untyped, T.untyped]))
       end
-      def send_request(endpoint: "", full_url: nil, http_method: "post", params: {})
+      def send_request(endpoint: "", full_url: nil, http_method: "post", params: {}, headers: {})
         url = full_url || API_CLIENT
 
-        response = T.unsafe(faraday(url)).public_send(http_method, endpoint, params)
+        faraday_request = T.unsafe(faraday(url))
+
+        response = faraday_request.public_send(http_method, endpoint, request_params(params, headers), headers)
+
         Oj.load(response.body)
       end
 
@@ -47,6 +55,18 @@ module WhatsappSdk
 
       private
 
+      sig do
+        params(
+          params: T::Hash[T.untyped, T.untyped],
+          headers: T::Hash[T.untyped, T.untyped]
+        ).returns(T.any(T::Hash[T.untyped, T.untyped], String))
+      end
+      def request_params(params, headers)
+        return params.to_json if params.is_a?(Hash) && headers['Content-Type'] == 'application/json'
+
+        params
+      end
+
       sig { params(url: String).returns(Faraday::Connection) }
       def faraday(url)
         ::Faraday.new(url) do |client|

data/lib/whatsapp_sdk/api/messages.rb

@@ -9,6 +9,8 @@ module WhatsappSdk
     class Messages < Request
       extend T::Sig
 
+      DEFAULT_HEADERS = T.let({ 'Content-Type' => 'application/json' }, Hash)
+
       class MissingArgumentError < StandardError
         extend T::Sig
 
@@ -40,7 +42,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -80,7 +83,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -120,7 +124,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -154,7 +159,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -194,7 +200,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -234,7 +241,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -268,7 +276,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -302,7 +311,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -338,7 +348,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(
@@ -385,7 +396,44 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          params: params,
+          headers: DEFAULT_HEADERS
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
+      end
+
+      # Send reaction
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @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 [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer, message_id: String, emoji: T.any(String, Integer)
+        ).returns(WhatsappSdk::Api::Response)
+      end
+      def send_reaction(sender_id:, recipient_number:, message_id:, emoji:)
+        params = {
+          messaging_product: "whatsapp",
+          recipient_type: "individual",
+          to: recipient_number,
+          type: "reaction",
+          reaction: {
+            message_id: message_id,
+            emoji: emoji
+          }
+        }
+
+        response = send_request(
+          endpoint: endpoint(sender_id),
+          params: params,
+          headers: DEFAULT_HEADERS
         )
 
         WhatsappSdk::Api::Response.new(

data/lib/whatsapp_sdk/api/request.rb

@@ -14,9 +14,9 @@ module WhatsappSdk
         @client.download_file(url, path_to_file_name)
       end
 
-      def send_request(endpoint: nil, full_url: nil, http_method: "post", params: {})
+      def send_request(endpoint: nil, full_url: nil, http_method: "post", params: {}, headers: {})
         @client.send_request(
-          http_method: http_method, full_url: full_url, endpoint: endpoint, params: params
+          http_method: http_method, full_url: full_url, endpoint: endpoint, params: params, headers: headers
         )
       end
     end

data/lib/whatsapp_sdk/api/response.rb

@@ -6,6 +6,7 @@ require_relative "responses/phone_number_data_response"
 require_relative "responses/phone_numbers_data_response"
 require_relative "responses/read_message_data_response"
 require_relative "responses/message_error_response"
+require_relative "responses/business_profile_data_response"
 
 module WhatsappSdk
   module Api

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+# typed: strict
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class BusinessProfileDataResponse < DataResponse
+        sig { returns(T.nilable(String)) }
+        attr_accessor :about
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :address
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :email
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :messaging_product
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :profile_picture_url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :vertical
+
+        sig { returns(T::Array[String]) }
+        attr_accessor :websites
+
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
+        def initialize(response)
+          @about = T.let(response["data"][0]["about"], T.nilable(String))
+          @address = T.let(response["data"][0]["address"], T.nilable(String))
+          @description = T.let(response["data"][0]["description"], T.nilable(String))
+          @email = T.let(response["data"][0]["email"], T.nilable(String))
+          @messaging_product = T.let(response["data"][0]["messaging_product"], T.nilable(String))
+          @profile_picture_url = T.let(response["data"][0]["profile_picture_url"], T.nilable(String))
+          @vertical = T.let(response["data"][0]["vertical"], T.nilable(String))
+          @websites = T.let(response["data"][0]["websites"], T.nilable(T::Array[String]))
+          super(response)
+        end
+
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(BusinessProfileDataResponse)) }
+        def self.build_from_response(response:)
+          return nil if response['error']
+
+          new(response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/version.rb

@@ -2,5 +2,5 @@
 # typed: strict
 
 module WhatsappSdk
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-02 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,12 +166,14 @@ files:
 - bin/tapioca
 - example.rb
 - lib/whatsapp_sdk.rb
+- lib/whatsapp_sdk/api/business_profile.rb
 - lib/whatsapp_sdk/api/client.rb
 - lib/whatsapp_sdk/api/medias.rb
 - lib/whatsapp_sdk/api/messages.rb
 - lib/whatsapp_sdk/api/phone_numbers.rb
 - lib/whatsapp_sdk/api/request.rb
 - lib/whatsapp_sdk/api/response.rb
+- lib/whatsapp_sdk/api/responses/business_profile_data_response.rb
 - lib/whatsapp_sdk/api/responses/data_response.rb
 - lib/whatsapp_sdk/api/responses/error_response.rb
 - lib/whatsapp_sdk/api/responses/media_data_response.rb