whatsapp_sdk 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d70f3c946148d4935fa447fae876defaea2a086f944ff94b3838c306c925752
-  data.tar.gz: afd71dd8d1fc23fd4000ed7263f868724db24a120c247c8e5a1ac1dc41a86d56
+  metadata.gz: 50d31bd48fd780c01049dfb4057424ce55cc6bc5092a5b250900482044bd8622
+  data.tar.gz: 0a76d504966100b86add6394bd69af61863575c05d3c67db74eab934a199fb5a
 SHA512:
-  metadata.gz: aed5dd70fb476006f5d0d68089549eb646fddb761b1521e16b65ded7b4d1150354618d0bb6fd63f45478236af5369bdb4c9fe9ac512ab6bd957c1dc6d667b7a4
-  data.tar.gz: de335d17ff40f47625a99636923b0053718ebca4d21c0dc24066a87570bb30385ec7f2dd3d8aa0c69c4c2afa0c6068bd7fb5b17f80a17df69de5ac77553ae906
+  metadata.gz: 66dc2b2cad95e2b230203613be97fef11ea32bcaaba1f9a157a9e7d1336060690462a1e4b4202b31d9b4494158ea55a29b88e2b26b45ec16e67817054b653bc5
+  data.tar.gz: e9a7602a3f6f74a1ee043b21b4beee11160db4286eb28b4addbe5867c9b088bc796e612f62f8b1cd48200677b018f7b6c51c6bd99d456d9f3d2277d5479b55f6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v 0.6.2
+Add Business Profiles API [#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.6.2)
       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)
@@ -98,6 +109,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.3)
@@ -116,6 +128,7 @@ DEPENDENCIES
   sorbet-runtime
   spoom
   tapioca
+  webmock
   whatsapp_sdk!
   zeitwerk (>= 2.6.0)
 

data/README.md

@@ -7,8 +7,11 @@ 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!
 
 
+## 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
 

data/example.rb

@@ -11,7 +11,7 @@ gemfile(true) do
 
   git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-  gem "whatsapp_sdk"
+  gem "whatsapp_sdk", path: "."
   gem "pry"
   gem "pry-nav"
 end
@@ -22,11 +22,11 @@ require "pry-nav"
 
 ################# UPDATE CONSTANTS #################
 
-ACCESS_TOKEN = "<TODO replace>"
-SENDER_ID = "<TODO replace>"
-RECIPIENT_NUMBER = "<TODO replace>"
-BUSINESS_ID = "<TODO replace>"
-IMAGE_LINK = "<TODO replace>"
+ACCESS_TOKEN = "EAAZAvvr0DZBs0BAFe8yjwJujpg5JZBX5DvzQ5Mv1oUBxuOefZAmi1TuRTkYmd9AqNqyTt2TtGict94yDWMmxb4fVQ3gZANjIb0IXXptezSad0xTHIZBpCNqZB8SBeBGL0eajPEjP1tZBwY3oyuOMwRU1ZAQuKMFkIV7Sw01AA3nX32plODm7LObsLp04C3aL7Pb1UF6OYKS0vPcqtFl21E9sf" # replace this with a valid access_token # TODO replace
+SENDER_ID = 111591145018464
+RECIPIENT_NUMBER = 13_437_772_910
+BUSINESS_ID = 102261539298487
+IMAGE_LINK = "https://ignaciochiazzo.com/static/4c403819b9750c8ad8b20a75308f2a8a/876d5/profile-pic.avif"
 
 ################# Initialize Client #################
 WhatsappSdk.configure do |config|
@@ -46,6 +46,9 @@ end
 medias_api = WhatsappSdk::Api::Medias.new
 messages_api = WhatsappSdk::Api::Messages.new
 phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
+business_profile = WhatsappSdk::Api::BusinessProfile.new
+
+binding.pry
 
 ############################## Phone Numbers API ##############################
 registered_number = phone_numbers_api.registered_number(SENDER_ID)

data/lib/whatsapp_sdk/api/business_profile.rb

@@ -0,0 +1,30 @@
+# 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'.freeze
+
+      # 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
+    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,8 @@ module WhatsappSdk
 
         response = send_request(
           endpoint: endpoint(sender_id),
-          params: params
+          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,48 @@
+# frozen_string_literal: true
+# typed: strict
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class BusinessProfileDataResponse < DataResponse
+        sig { returns(String) }
+        attr_accessor :about
+
+        sig { returns(String) }
+        attr_accessor :address
+
+        sig { returns(String) }
+        attr_accessor :description
+
+        sig { returns(String) }
+        attr_accessor :email
+
+        sig { returns(String) }
+        attr_accessor :messaging_product
+
+        sig { returns(String) }
+        attr_accessor :profile_picture_url
+
+        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))
+          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.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-02 00:00:00.000000000 Z
+date: 2022-10-23 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