whatsapp_sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f270a981b63f318f63b07d8d7812e27a925ce5b96e8b46cec457b11647d531e2
-  data.tar.gz: ca9c1316ae6e4df8c01e809bee3693512cafba6840aff6b1ff6d471acc75b63c
+  metadata.gz: 789c30c096735aa557c643a11a810990c8bc2c207360bee7d0b0e9710f2de60c
+  data.tar.gz: 66bf61944f214767a8feae139e62d544be51c10e32895b33ca5239b3b1582009
 SHA512:
-  metadata.gz: 9dd7789b53c1c5b570698a4b03da3726acc899330aa2b123625ef833c410e1d21abe1ed35415abbcd79626b5698b80e64d71dfc98212a4cb4325ddbc555b729a
-  data.tar.gz: adb2fd6df0007660d4e88edc455cc3bf540407820212b4b7b6c7a7d5303da654430e8b29a7bc805e350bdb334e87d72a6d13c0b15c7408ecd094f4450b915a9f
+  metadata.gz: cc2eef92ce66f87374e1f2fb0f5cfb01f9bbf5814ae80d625403660fd1fc9d834680fb72a06941c8d66f0fb30e9dabe5561231c4547cc2fd1daf651300b93193
+  data.tar.gz: fe548e9bfee0913a4eca4b1675342c565d35821e5d7b384908eebc0073b03616d7bc762ca8afefd1284dd6bd6ddffe88904b339e6448622b7675f09e68ed62e9

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Unreleased
+
+# v 0.0.2
+- Implement read message.
+- Implement Yard doc.
+

data/README.md

@@ -8,7 +8,7 @@ Send stickers, messages, audio, videos, locations or just ask for the phone numb
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby-whatsapp-sdk'
+gem 'whatsapp_sdk'
 ```
 
 And then execute:
@@ -17,7 +17,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install ruby-whatsapp-sdk
+    $ gem install whatsapp_sdk
 
 ## Quick Start
 
@@ -143,7 +143,7 @@ gemfile(true) do
 
   git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-  gem "whatsapp_sdk", path: "/Users/ignaciochiazzo/src/whatsapp_sdk"
+  gem "whatsapp_sdk"
   gem "pry"
   gem "pry-nav"
 end
@@ -210,6 +210,11 @@ binding.pry
 ```
 </details>
 
+## Whatsapp Cloud API
+
+- See the [official documentation](https://developers.facebook.com/docs/whatsapp/cloud-api) for the Whatsapp Cloud API.
+- For pricing, refer to the [official documentation](https://developers.facebook.com/docs/whatsapp/pricing/). As of today, Whatsapp offers have 1000 conversations free per month.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.

data/lib/version.rb

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

data/lib/whatsapp_sdk/api/messages.rb

@@ -15,6 +15,12 @@ module WhatsappSdk
         end
       end
 
+      # Send a text message.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param message [String] Text to send.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_text(sender_id:, recipient_number:, message:)
         params = {
           messaging_product: "whatsapp",
@@ -32,6 +38,15 @@ module WhatsappSdk
         WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
       end
 
+      # Send location.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param longitude [Float] Location longitude.
+      # @param latitude [Float] Location latitude.
+      # @param name [String] Location name.
+      # @param address [String] Location address.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_location(sender_id:, recipient_number:, longitude:, latitude:, name:, address:)
         params = {
           messaging_product: "whatsapp",
@@ -54,6 +69,14 @@ module WhatsappSdk
         WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
       end
 
+      # Send an image.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param image_id [Integer] Image ID.
+      # @param link [String] Image link.
+      # @param caption [String] Image caption.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_image(sender_id:, recipient_number:, image_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "image_id or link is required" if !image_id && !link
 
@@ -77,6 +100,13 @@ module WhatsappSdk
         WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
       end
 
+      # Send an audio.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param audio_id [Integer] Audio ID.
+      # @param link [String] Audio link.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_audio(sender_id:, recipient_number:, audio_id: nil, link: nil)
         raise MissingArgumentError, "audio_id or link is required" if !audio_id && !link
 
@@ -96,6 +126,14 @@ module WhatsappSdk
         WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
       end
 
+      # Send a video.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param video_id [Integer] Video ID.
+      # @param link [String] Image link.
+      # @param caption [String] Image caption.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_video(sender_id:, recipient_number:, video_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "video_id or link is required" if !video_id && !link
 
@@ -119,6 +157,14 @@ module WhatsappSdk
         WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
       end
 
+      # Send a document.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param document_id [Integer] document ID.
+      # @param link [String] Image link.
+      # @param caption [String] Image caption.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_document(sender_id:, recipient_number:, document_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "document or link is required" if !document_id && !link
 
@@ -142,6 +188,12 @@ module WhatsappSdk
         WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
       end
 
+      # Send a document.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param link [String] Image link.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_sticker(sender_id:, recipient_number:, sticker_id: nil, link: nil)
         raise MissingArgumentError, "sticker or link is required" if !sticker_id && !link
 
@@ -161,6 +213,14 @@ module WhatsappSdk
         WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
       end
 
+      # Send contacts.
+      # You can either send contacts objects or contacts as JSON.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param contacts [Array<Contact>] Contacts.
+      # @param contacts_json [Json] Contacts.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_contacts(sender_id:, recipient_number:, contacts: nil, contacts_json: {})
         params = {
           messaging_product: "whatsapp",
@@ -190,6 +250,26 @@ module WhatsappSdk
         # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
       end
 
+      # Mark a message as read.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param message_id [Integer] Message ID.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def read_message(sender_id:, message_id:)
+        params = {
+          messaging_product: "whatsapp",
+          status: "read",
+          message_id: message_id
+        }
+
+        response = send_request(
+          endpoint: endpoint(sender_id),
+          params: params
+        )
+
+        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+      end
+
       private
 
       def endpoint(sender_id)

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -6,6 +6,10 @@ require_relative "response"
 module WhatsappSdk
   module Api
     class PhoneNumbers < Request
+      # Get list of registered numbers.
+      #
+      # @param business_id [Integer] Business Id.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def registered_numbers(business_id)
         response = send_request(
           http_method: "get",
@@ -16,6 +20,10 @@ module WhatsappSdk
                                        class_type: WhatsappSdk::Api::Responses::PhoneNumbersDataResponse)
       end
 
+      # Get the registered number id.
+      #
+      # @param phone_number_id [Integer] The registered number we want to retrieve.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def registered_number(phone_number_id)
         response = send_request(
           http_method: "get",

data/lib/whatsapp_sdk/api/response.rb

@@ -13,7 +13,8 @@ module WhatsappSdk
       CLASS_TYPE = {
         message_data_response: Responses::MessageDataResponse,
         phone_number_data_response: Responses::PhoneNumberDataResponse,
-        phone_numbers_data_response: Responses::PhoneNumbersDataResponse
+        phone_numbers_data_response: Responses::PhoneNumbersDataResponse,
+        read_message_data_response: ReadMessageDataResponse
       }.freeze
 
       def initialize(response:, class_type:)
@@ -21,10 +22,12 @@ module WhatsappSdk
         @error = Responses::ErrorResponse.build_from_response(response: response)
       end
 
+      # Whether or not the response is successful.
       def ok?
         @error.nil?
       end
 
+      # Whether or not the response has an error.
       def error?
         !!@error
       end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../request"
+require_relative "data_response"
+require_relative "../../resource/message"
+require_relative "../../resource/contact_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MessageDataResponse < DataResponse
+        attr_reader :sucess
+
+        def initialize(response:)
+          @sucess = response["sucess"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return if response["error"]
+
+          new(response: response)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-29 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - lib/whatsapp_sdk/api/responses/message_data_response.rb
 - lib/whatsapp_sdk/api/responses/phone_number_data_response.rb
 - lib/whatsapp_sdk/api/responses/phone_numbers_data_response.rb
+- lib/whatsapp_sdk/api/responses/read_message_data_response.rb
 - lib/whatsapp_sdk/error.rb
 - lib/whatsapp_sdk/resource/address.rb
 - lib/whatsapp_sdk/resource/contact.rb