whatsapp_sdk 0.0.2 → 0.3.0

data/example.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+# 1) Copy this code into a file and save it `example.rb`
+# 2) Replace the `ACCESS_TOKEN` constant with a valid `access_token`.
+# 3) Run the file with the command `ruby example.rb`
+
+require 'bundler/inline'
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "whatsapp_sdk"
+  gem "pry"
+  gem "pry-nav"
+end
+
+require 'whatsapp_sdk'
+require "pry"
+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>"
+
+################# Initialize Client #################
+WhatsappSdk.configure do |config|
+  config.access_token = ACCESS_TOKEN
+end
+
+################# HELPERS ########################
+def print_message_sent(message_response)
+  if message_response.ok?
+    puts "Message sent to: #{message_response.data.contacts.first.input}"
+  else
+    puts "Error: #{message_response.error&.to_s}"
+  end
+end
+##################################################
+
+medias_api = WhatsappSdk::Api::Medias.new
+messages_api = WhatsappSdk::Api::Messages.new
+phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
+
+############################## Phone Numbers API ##############################
+phone_numbers_api.registered_number(SENDER_ID)
+phone_numbers_api.registered_numbers(BUSINESS_ID)
+############################## Media API ##############################
+
+# upload a media
+uploaded_media = medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/whatsapp.png", type: "image/png")
+puts "Uploaded media id: #{uploaded_media.data&.id}"
+
+# get a media
+media = medias_api.media(media_id: uploaded_media.data&.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')
+puts "Downloaded: #{download_image.data.success?}"
+
+# delete a media
+deleted_media = medias_api.delete(media_id: media&.id)
+puts "Deleted: #{deleted_media.data.success?}"
+
+############################## Messages API ##############################
+
+######### SEND A TEXT MESSAGE
+message_sent = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
+                                      message: "Hey there! it's Whatsapp Ruby SDK")
+print_message_sent(message_sent)
+
+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"
+)
+print_message_sent(location_sent)
+
+######### READ A MESSAGE
+# messages_api.read_message(sender_id: SENDER_ID, message_id: msg_id)
+
+######### SEND AN IMAGE
+# Send an image with a link
+image_sent = messages_api.send_image(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: media.url, caption: "Ignacio Chiazzo Profile"
+)
+print_message_sent(image_sent)
+
+# Send an image with an id
+messages_api.send_image(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, image_id: media.id, caption: "Ignacio Chiazzo Profile"
+)
+
+######### SEND AUDIOS
+## with a link
+messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: "audio_link")
+
+## with an audio id
+messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, audio_id: "1234")
+
+######### SEND DOCUMENTS
+## with a link
+messages_api.send_document(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: "document_link", caption: "Ignacio Chiazzo"
+)
+
+## with a document id
+messages_api.send_document(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, document_id: "1234", caption: "Ignacio Chiazzo"
+)
+
+######### SEND STICKERS
+## with a link
+messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: "link")
+
+## with a sticker_id
+messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, sticker_id: "1234")
+
+######### SEND A TEMPLATE
+# Note: The template must have been created previously.
+
+# Send a template with no component
+response_with_object = messages_api.send_template(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
+                                                  name: "hello_world", language: "en_US", components: [])
+puts response_with_object
+
+# Send a template with components.Remember to create the template first.
+header_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::HEADER
+)
+
+image = WhatsappSdk::Resource::Media.new(type: "image", link: "http(s)://URL", caption: "caption")
+document = WhatsappSdk::Resource::Media.new(type: "document", link: "http(s)://URL", filename: "txt.rb")
+video = WhatsappSdk::Resource::Media.new(type: "video", id: 123)
+
+parameter_image = WhatsappSdk::Resource::ParameterObject.new(
+  type: "image",
+  image: image
+)
+
+parameter_document = WhatsappSdk::Resource::ParameterObject.new(
+  type: "document",
+  document: document
+)
+
+parameter_video = WhatsappSdk::Resource::ParameterObject.new(
+  type: "video",
+  video: video
+)
+
+parameter_text = WhatsappSdk::Resource::ParameterObject.new(
+  type: "text",
+  text: "I am a text"
+)
+
+header_component.add_parameter(parameter_text)
+header_component.add_parameter(parameter_image)
+header_component.add_parameter(parameter_video)
+header_component.add_parameter(parameter_document)
+header_component.to_json
+
+body_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BODY
+)
+body_component.add_parameter(parameter_text)
+body_component.add_parameter(parameter_image)
+body_component.add_parameter(parameter_video)
+body_component.add_parameter(parameter_document)
+body_component.to_json
+
+# button_component_1 = WhatsappSdk::Resource::Component.new(
+#   type: WhatsappSdk::Resource::Component::Type::BUTTON,
+#   index: 0,
+#   sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+#   parameters: [WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "payload")]
+# )
+
+# button_component_2 = WhatsappSdk::Resource::Component.new(
+#   type: WhatsappSdk::Resource::Component::Type::BUTTON,
+#   index: 1,
+#   sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+#   parameters: [WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "payload")]
+# )
+
+# Send a template with component_json
+response_with_json = messages_api.send_template(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, name: "hello_world", language: "en_US",
+  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"
+          }
+        }
+      ]
+    }
+  ]
+)
+puts response_with_json

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhatsappSdk
-  VERSION = "0.0.2"
+  VERSION = "0.3.0"
 end

data/lib/whatsapp_sdk/api/client.rb

@@ -6,25 +6,45 @@ require "oj"
 module WhatsappSdk
   module Api
     class Client
-      API_VERSION = "v13.0"
+      API_VERSION = "v14.0"
       API_CLIENT = "https://graph.facebook.com/#{API_VERSION}/"
 
       def initialize(access_token)
         @access_token = access_token
       end
 
-      def client
-        @client ||= ::Faraday.new(API_CLIENT) do |client|
+      def send_request(endpoint: "", full_url: nil, http_method: "post", params: {})
+        url = full_url || API_CLIENT
+
+        response = faraday(url).public_send(http_method, endpoint, params)
+        Oj.load(response.body)
+      end
+
+      def download_file(url, path_to_file_name = nil)
+        uri = URI.parse(url)
+        request = Net::HTTP::Get.new(uri)
+        request["Authorization"] = "Bearer #{@access_token}"
+        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
+
+        response
+      end
+
+      private
+
+      def faraday(url)
+        ::Faraday.new(url) do |client|
+          client.request :multipart
           client.request :url_encoded
           client.adapter ::Faraday.default_adapter
           client.headers['Authorization'] = "Bearer #{@access_token}" unless @access_token.nil?
         end
       end
-
-      def send_request(endpoint:, http_method: "post", params: {})
-        response = client.public_send(http_method, endpoint, params)
-        Oj.load(response.body)
-      end
     end
   end
 end

data/lib/whatsapp_sdk/api/medias.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "faraday"
+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'
+
+module WhatsappSdk
+  module Api
+    class Medias < Request
+      class FileNotFoundError < StandardError
+        attr_reader :file_path
+
+        def initialize(file_path)
+          @file_path = file_path
+          super("Couldn't find file_path: #{file_path}")
+        end
+      end
+
+      # Get Media by ID.
+      #
+      # @param media_id [Integer] Media Id.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def media(media_id:)
+        response = send_request(
+          http_method: "get",
+          endpoint: "/#{media_id}"
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MediaDataResponse
+        )
+      end
+
+      # Download Media by URL.
+      #
+      # @param media_id [Integer] Media Id.
+      # @param file_path [String] The file_path to download the media e.g. "tmp/downloaded_image.png".
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def download(url:, file_path:)
+        response = download_file(url, file_path)
+
+        response = if response.code.to_i == 200
+                     { "success" => true }
+                   else
+                     { "error" => true, "status" => response.code }
+                   end
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse,
+          error_class_type: WhatsappSdk::Api::Responses::ErrorResponse
+        )
+      end
+
+      # Upload a media.
+      # @param sender_id [Integer] Sender' phone number.
+      # @param file_path [String] Path to the file stored in your local directory. For example: "tmp/whatsapp.png".
+      # @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.
+      def upload(sender_id:, file_path:, type:)
+        raise FileNotFoundError, file_path unless File.file?(file_path)
+
+        params = {
+          messaging_product: "whatsapp",
+          file: Faraday::FilePart.new(file_path, type),
+          type: type
+        }
+
+        response = send_request(http_method: "post", endpoint: "#{sender_id}/media", params: params)
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MediaDataResponse
+        )
+      end
+
+      # Delete a Media by ID.
+      #
+      # @param media_id [Integer] Media Id.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def delete(media_id:)
+        response = send_request(
+          http_method: "delete",
+          endpoint: "/#{media_id}"
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse
+        )
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/messages.rb

@@ -25,9 +25,9 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "text",
-          "text": { body: message }
+          text: { body: message }
         }
 
         response = send_request(
@@ -35,7 +35,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send location.
@@ -51,13 +54,13 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "location",
-          "location": {
-            "longitude": longitude,
-            "latitude": latitude,
-            "name": name,
-            "address": address
+          location: {
+            longitude: longitude,
+            latitude: latitude,
+            name: name,
+            address: address
           }
         }
 
@@ -66,7 +69,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send an image.
@@ -83,7 +89,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "image"
         }
         params[:image] = if link
@@ -97,7 +103,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send an audio.
@@ -113,7 +122,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "audio"
         }
         params[:audio] = link ? { link: link } : { id: audio_id }
@@ -123,7 +132,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send a video.
@@ -140,7 +152,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "video"
         }
         params[:video] = if link
@@ -154,7 +166,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send a document.
@@ -171,7 +186,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "document"
         }
         params[:document] = if link
@@ -185,7 +200,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send a document.
@@ -200,7 +218,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "sticker"
         }
         params[:sticker] = link ? { link: link } : { id: sticker_id }
@@ -210,7 +228,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send contacts.
@@ -225,7 +246,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "contacts"
         }
         params[:contacts] = contacts ? contacts.map(&:to_h) : contacts_json
@@ -235,7 +256,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       def send_interactive_button
@@ -267,7 +291,50 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::ReadMessageDataResponse
+        )
+      end
+
+      # Send template
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param name [String] the template's name.
+      # @param language [String] template language.
+      # @param components [Component] Component.
+      # @param components_json [Json] The component as a Json. If you pass components_json, you can't pass components.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def send_template(sender_id:, recipient_number:, name:, language:, components: nil, components_json: nil)
+        raise MissingArgumentError, "components or components_json is required" if !components && !components_json
+
+        params = {
+          messaging_product: "whatsapp",
+          recipient_type: "individual",
+          to: recipient_number,
+          type: "template",
+          template: {
+            name: name
+          }
+        }
+
+        params[:template][:language] = { code: language } if language
+        params[:template][:components] = if components.nil?
+                                           components_json
+                                         else
+                                           components.map(&:to_json)
+                                         end
+
+        response = send_request(
+          endpoint: endpoint(sender_id),
+          params: params
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       private

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -16,8 +16,10 @@ module WhatsappSdk
           endpoint: "#{business_id}/phone_numbers"
         )
 
-        WhatsappSdk::Api::Response.new(response: response,
-                                       class_type: WhatsappSdk::Api::Responses::PhoneNumbersDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumbersDataResponse
+        )
       end
 
       # Get the registered number id.
@@ -30,8 +32,10 @@ module WhatsappSdk
           endpoint: phone_number_id.to_s
         )
 
-        WhatsappSdk::Api::Response.new(response: response,
-                                       class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse
+        )
       end
     end
   end

data/lib/whatsapp_sdk/api/request.rb

@@ -6,12 +6,18 @@ module WhatsappSdk
       API_VERSION = "v13.0"
       API_CLIENT = "https://graph.facebook.com/#{API_VERSION}/"
 
-      def initialize(client)
+      def initialize(client = WhatsappSdk.configuration.client)
         @client = client
       end
 
-      def send_request(endpoint:, http_method: "post", params: {})
-        @client.send_request(http_method: http_method, endpoint: endpoint, params: params)
+      def download_file(url, path_to_file_name = nil)
+        @client.download_file(url, path_to_file_name)
+      end
+
+      def send_request(endpoint: nil, full_url: nil, http_method: "post", params: {})
+        @client.send_request(
+          http_method: http_method, full_url: full_url, endpoint: endpoint, params: params
+        )
       end
     end
   end

data/lib/whatsapp_sdk/api/response.rb

@@ -3,31 +3,25 @@
 require_relative "responses/message_data_response"
 require_relative "responses/phone_number_data_response"
 require_relative "responses/phone_numbers_data_response"
-require_relative "responses/error_response"
+require_relative "responses/read_message_data_response"
+require_relative "responses/message_error_response"
 
 module WhatsappSdk
   module Api
     class Response
       attr_accessor :error, :data
 
-      CLASS_TYPE = {
-        message_data_response: Responses::MessageDataResponse,
-        phone_number_data_response: Responses::PhoneNumberDataResponse,
-        phone_numbers_data_response: Responses::PhoneNumbersDataResponse,
-        read_message_data_response: ReadMessageDataResponse
-      }.freeze
-
-      def initialize(response:, class_type:)
-        @data = class_type.build_from_response(response: response)
-        @error = Responses::ErrorResponse.build_from_response(response: response)
+      def initialize(response:, data_class_type:, error_class_type: Responses::MessageErrorResponse)
+        @data = data_class_type.build_from_response(response: response)
+        @error = error_class_type.build_from_response(response: response)
       end
 
-      # Whether or not the response is successful.
+      # @return [Boolean] Whether or not the response is successful.
       def ok?
         @error.nil?
       end
 
-      # Whether or not the response has an error.
+      # @return [Boolean] Whether or not the response has an error.
       def error?
         !!@error
       end