whatsapp_sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dabd5d87a1a3988caaafc2a090c9b85bcea77cc764132a169227a5ca1c4b409
-  data.tar.gz: 1ac41750e5e737fbf9a606e013015d796b68c328e3950241cad051c8eef6d674
+  metadata.gz: 4c511dc642ddf1e541454117ebb5e08df060b166b47e7905bfd9e8e989e394e1
+  data.tar.gz: 49f4b2fd988d44d6cdac186a47b3553fb78203ceffb1675c80c6bd176f59d68f
 SHA512:
-  metadata.gz: 183f8600f1e74a46b4a38f290c806f479a0e52a20ec7c6d836b2fe3ac8038e4c91620e83d8780810907a2395555169aa8911fd5385299adcd3830a3492bea9a7
-  data.tar.gz: ce2cb90d04e06dc62d0294bcd395b3cf6cdffb2e60c24a8671539825de486299b11647eab9cf875007f290b8a35af350aadb7a985cad4bad2bcc415d85955cd3
+  metadata.gz: dbcebfa04a24c570cbd28dae1410de7c5d2f95280f4f06129beb7aecdda13cc4d0b218a6c3815b5ecfefbe97c8ddc19c423ce55fb1ac3e4a6cfe535b42a6a4e1
+  data.tar.gz: 8e84e6f855f6383e1a0b56edeb804f72c8519b521bbf1d174c40ac659e8b244c23268cf87ad7df7ef77cbb753420e64b4910914ea80e9cd80bee1675ec38f4cf

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '20 22 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.gitignore

@@ -21,3 +21,4 @@ REMOVE.rb
 .ruby-gemset
 
 .rvmrc
+.DS_Store

data/.rubocop.yml

@@ -4,6 +4,13 @@ require:
 
 AllCops:
   NewCops: enable
+  Exclude:
+    - 'example.rb'
+    - 'tmp/*'
+    - 'vendor/**/*'
+
+Lint/ToJSON:
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: false
@@ -29,9 +36,16 @@ Metrics/ClassLength:
 Metrics/AbcSize:
   Enabled: false
 
+Lint/MissingSuper:
+  Enabled: false
+
 # Wait until https://github.com/rubocop/rubocop/issues/8761 is fixed
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
 Minitest/MultipleAssertions:
   Enabled: false
+
+Style/AccessorGrouping: # disabled so that we can use sorbet signatures for each attr
+  Enabled: false 
+

data/CHANGELOG.md

@@ -1,11 +1,18 @@
 # Unreleased
+- Make the gem stricly typed using Sorbet [#34](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/34), [#35](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/35), [#37](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/37)
+- Object IDs are Strings in development [#37](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/37)
+
+# v 0.3.2
+- Include Zeitwerk
+
+# v 0.3.1
+- Update Meta API to v14
 
 # v 0.3.0
 - Allow Apps to have a singleton global authentication client.
 
 # v 0.2.0
 - Added Media API
-- Update Facebook API to v14
 - Added error and sucess responses
 - Added faraday-multiplart as part of the library
  

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 source "https://rubygems.org"
 
@@ -8,6 +9,8 @@ gem("faraday")
 gem("faraday-multipart")
 gem("oj")
 gem("rake", ">= 12.3.3")
+gem('sorbet-runtime')
+gem("zeitwerk", ">= 2.6.0")
 
 group(:test) do
   gem('mocha')
@@ -19,6 +22,9 @@ end
 group(:development) do
   gem('pry')
   gem('pry-nav')
+  gem('sorbet')
+  gem('spoom')
+  gem('tapioca', require: false)
 end
 
 gemspec

data/Gemfile.lock

@@ -1,16 +1,20 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.2.0)
+    whatsapp_sdk (0.3.2)
       faraday (~> 2.3.0)
       faraday-multipart (~> 1.0.4)
       oj (~> 3.13.13)
+      sorbet
+      sorbet-runtime
+      zeitwerk (~> 2.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     coderay (1.1.3)
+    diff-lcs (1.5.0)
     faraday (2.3.0)
       faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
@@ -21,6 +25,7 @@ GEM
     minitest (5.16.1)
     mocha (1.14.0)
     multipart-post (2.2.3)
+    netrc (0.11.0)
     oj (3.13.14)
     parallel (1.22.1)
     parser (3.1.2.0)
@@ -32,6 +37,11 @@ GEM
       pry (>= 0.9.10, < 0.15)
     rainbow (3.1.1)
     rake (13.0.6)
+    rbi (0.0.15)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rubocop (1.30.1)
@@ -52,7 +62,39 @@ GEM
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    sorbet (0.5.10346)
+      sorbet-static (= 0.5.10346)
+    sorbet-runtime (0.5.10346)
+    sorbet-static (0.5.10346-universal-darwin-21)
+    sorbet-static-and-runtime (0.5.10346)
+      sorbet (= 0.5.10346)
+      sorbet-runtime (= 0.5.10346)
+    spoom (1.1.12)
+      sorbet (>= 0.5.9204)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.9.4)
+      bundler (>= 1.17.3)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      pry (>= 0.12.2)
+      rbi (~> 0.0.0, >= 0.0.14)
+      sorbet-static-and-runtime (>= 0.5.9204)
+      spoom (~> 1.1.0, >= 1.1.11)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
     unicode-display_width (2.2.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.7.0)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   x86_64-darwin-21
@@ -70,7 +112,12 @@ DEPENDENCIES
   rubocop
   rubocop-minitest
   rubocop-performance
+  sorbet
+  sorbet-runtime
+  spoom
+  tapioca
   whatsapp_sdk!
+  zeitwerk (>= 2.6.0)
 
 BUNDLED WITH
    2.3.9

data/README.md

@@ -4,7 +4,7 @@
 <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, locations or just ask for the phone numbers through this library in a few steps!
+Send stickers, messages, audio, videos, and locations or just ask for the phone numbers through this library in a few steps!
 
 
 https://user-images.githubusercontent.com/11672878/173238826-6fc0a6f8-d0ee-4eae-8947-7dfd3b8b3446.mov
@@ -28,9 +28,9 @@ Or install it yourself as:
 
 ## Quick Start
 
-There are three primary resources, `Messages`, `Media` and `PhoneNumbers`. The first one allows clients to send any kind of message (text, audio, location, video, image, etc.), and the latter will enable clients to query the phone numbers associated.
+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.
 
-To use `Messages`, `Media` or `PhoneNumbers` you need to initialize the `Client` that contain 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
   
@@ -39,7 +39,7 @@ WhatsappSdk.configure do |config|
   config.access_token = ACCESS_TOKEN
 end
 ```
-OR creating an instance and pass it to the Messages or PhoneNumbers instance like this:
+OR 2) creating 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
@@ -59,15 +59,82 @@ medias_api = WhatsappSdk::Api::Medias.new
 
 Note: Remember to initialize the client first!
 
+## Set up a Meta app
+
+<details><summary>1) Create a Meta Business app </summary>
+<img width="1063" alt="Screen Shot 2022-09-05 at 11 03 47 AM" src="https://user-images.githubusercontent.com/11672878/188477795-4745a71a-a4b5-41e2-bef1-e41d3060e02b.png">
+</details>
+
+<details><summary>2) Add Whatsapp to your Application</summary>
+<img width="1087" alt="Screen Shot 2022-09-05 at 11 05 43 AM" src="https://user-images.githubusercontent.com/11672878/188478100-98b3bf0a-fec7-4ea1-a492-aeb90a6b06bd.png">
+</details>
+
+<details><summary>3) Add a phone number to your account</summary>
+<img width="972" alt="Screen Shot 2022-09-05 at 11 09 22 AM" src="https://user-images.githubusercontent.com/11672878/188478741-8a6105e8-2776-4493-bba9-05a62082a5aa.png">
+</details>
+
+Try sending a message to your phone in the UI.
+
+<details><summary>4) Copy the ACCESS_TOKEN, the SENDER_ID, the BUSINESS_ID and the RECEIPIENT_NUMBER</summary>
+<img width="1010" alt="Screen Shot 2022-09-05 at 11 13 24 AM" src="https://user-images.githubusercontent.com/11672878/188480634-369f8de1-b851-4735-86de-f49e96f78d8c.png">
+</details>
+
+</details>
+
+<details><summary>5) Use the GEM to interact with Whatsapp</summary>
+
+Example: 
+1) Install the gem by running `gem install whatsapp_sdk` in the gem.
+2) Open the irb terminal by running `irb` 
+3) `require "whatsapp_sdk"` 
+4) Set up the `ACCESS_TOKEN`, the `SENDER_ID`, the `BUSINESS_ID` and the `RECEIPIENT_NUMBER` in variables.
+
+```ruby
+ACCESS_TOKEN = "EAAZAvvr0DZBs0BABRLF8zohP5Epc6pyNu"
+BUSINESS_ID = 1213141516171819
+SENDER_ID = 1234567891011
+RECIPIENT_NUMBER = 12398765432
+```
+
+5) Configure the Client by running 
+
+```ruby
+WhatsappSdk.configure do |config|
+  config.access_token = ACCESS_TOKEN
+end
+```
+
+6) Try the Medias or Messages API
+
+Medias API
+```ruby
+phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
+registered_number = phone_numbers_api.registered_number(SENDER_ID)
+```
+
+Messages API
+```ruby
+messages_api = WhatsappSdk::Api::Messages.new
+message_sent = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
+                                      message: "Hey there! it's Whatsapp Ruby SDK")
+```
+
+Check the [example.rb file](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/blob/main/example.rb) for more examples.
+
+</details>
+
+
+
+
 ### Phone numbers API
 Get the list of phone numbers registered
 ```ruby
-phone_numbers_api.registered_numbers("123456") # accepts a business_id
+phone_numbers_api.registered_numbers(123456) # accepts a business_id
 ```
 
 Get the a phone number by id
 ```ruby
-phone_numbers_api.registered_numbers("123456") # accepts a phone_number_id
+phone_numbers_api.registered_numbers(123456) # accepts a phone_number_id
 ```
 
 ### Media API
@@ -97,7 +164,7 @@ medias_api.delete(media_id: MEDIA_ID)
 **Send a text message**
 
 ```ruby
-messages_api.send_text(sender_id: 1234, recipient_number: "112345678", message: "hola")
+messages_api.send_text(sender_id: 1234, recipient_number: 112345678, message: "hola")
 ```
 
 **Read a message**
@@ -112,7 +179,7 @@ Note: To get the `message_id` you can set up [Webhooks](https://developers.faceb
 
 ```ruby
 messages_api.send_location(
-  sender_id: 123123, recipient_number: "56789",
+  sender_id: 123123, recipient_number: 56789,
   longitude: 45.4215, latitude: 75.6972, name: "nacho", address: "141 cooper street"
 )
 ```
@@ -122,12 +189,12 @@ It could use a link or an image_id.
 ```ruby
 # with a link
 messages_api.send_image(
-  sender_id: 123123, recipient_number: "56789", link: "image_link", caption: "Ignacio Chiazzo Profile"
+  sender_id: 123123, recipient_number: 56789, link: "image_link", caption: "Ignacio Chiazzo Profile"
 )
 
 # with an image id
 messages_api.send_image(
-  sender_id: 123123, recipient_number: "56789", image_id: "1234", caption: "Ignacio Chiazzo Profile"
+  sender_id: 123123, recipient_number: 56789, image_id: "1234", caption: "Ignacio Chiazzo Profile"
 )
 ```
 
@@ -135,10 +202,10 @@ messages_api.send_image(
 It could use a link or an audio_id.
 ```ruby
 # with a link
-messages_api.send_audio(sender_id: 123123, recipient_number: "56789", link: "audio_link")
+messages_api.send_audio(sender_id: 123123, recipient_number: 56789, link: "audio_link")
 
 # with an audio id
-messages_api.send_audio(sender_id: 123123, recipient_number: "56789", audio_id: "1234")
+messages_api.send_audio(sender_id: 123123, recipient_number: 56789, audio_id: "1234")
 ```
 
 **Send a document message**
@@ -146,12 +213,12 @@ It could use a link or a document_id.
 ```ruby
 # with a link
 messages_api.send_document(
-  sender_id: 123123, recipient_number: "56789", link: "document_link", caption: "Ignacio Chiazzo"
+  sender_id: 123123, recipient_number: 56789, link: "document_link", caption: "Ignacio Chiazzo"
 )
 
 # with a document id
 messages_api.send_document(
-  sender_id: 123123, recipient_number: "56789", document_id: "1234", caption: "Ignacio Chiazzo"
+  sender_id: 123123, recipient_number: 56789, document_id: "1234", caption: "Ignacio Chiazzo"
 )
 ```
 
@@ -159,10 +226,10 @@ messages_api.send_document(
 It could use a link or a sticker_id.
 ```ruby
 # with a link
-messages_api.send_sticker(sender_id: 123123, recipient_number: "56789", link: "link")
+messages_api.send_sticker(sender_id: 123123, recipient_number: 56789, link: "link")
 
 # with a sticker_id
-messages_api.send_sticker(sender_id: 123123, recipient_number: "56789", sticker_id: "1234")
+messages_api.send_sticker(sender_id: 123123, recipient_number: 56789, sticker_id: "1234")
 ```
 
 **Send contacts message**
@@ -170,12 +237,12 @@ To send a contact, you need to create a Contact instance object that contain obj
 
 ```ruby
 contacts = [create_contact(params)]
-messages_api.send_contacts(sender_id: 123123, recipient_number: "56789", contacts: contacts)
+messages_api.send_contacts(sender_id: 123123, recipient_number: 56789, contacts: contacts)
 ```
 
 Alernative, you could pass a plain json like this:
 ```ruby
-messages_api.send_contacts(sender_id: 123123, recipient_number: "56789", contacts_json: {...})
+messages_api.send_contacts(sender_id: 123123, recipient_number: 56789, contacts_json: {...})
 ```
 
 **Send a template message**
@@ -190,46 +257,48 @@ currency = WhatsappSdk::Resource::Currency.new(code: "USD", amount: 1000, fallba
 date_time = WhatsappSdk::Resource::DateTime.new(fallback_value: "2020-01-01T00:00:00Z")
 image = WhatsappSdk::Resource::Media.new(type: "image", link: "http(s)://URL")
 
-parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: "image", image: image)
-parameter_text = WhatsappSdk::Resource::ParameterObject.new(type: "text", text: "TEXT_STRING")
-parameter_currency = WhatsappSdk::Resource::ParameterObject.new(type: "currency", currency: currency)
-parameter_date_time = WhatsappSdk::Resource::ParameterObject.new(type: "date_time", date_time: date_time)
+parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Image, image: image)
+# You can also use a plain string as type e.g. 
+# parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: "image", image: image)
+parameter_text = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Text, text: "TEXT_STRING")
+parameter_currency = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Currency, currency: currency)
+parameter_date_time = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::DateTime, date_time: date_time)
 
 header_component = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::HEADER,
+  type: WhatsappSdk::Resource::Component::Type::Header,
   parameters: [parameter_image]
 )
 
 body_component = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::BODY,
+  type: WhatsappSdk::Resource::Component::Type::Body,
   parameters: [parameter_text, parameter_currency, parameter_date_time]
 )
 
 button_component1 = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::BUTTON,
+  type: WhatsappSdk::Resource::Component::Type::Button,
   index: 0,
-  sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+  sub_type: WhatsappSdk::Resource::Component::Subtype::QuickReply,
   parameters: [
-    WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "PAYLOAD")
+    WhatsappSdk::Resource::ButtonParameter.new(type: WhatsappSdk::Resource::ButtonParameter::Type::Payload, payload: "PAYLOAD")
   ]
 )
 
 button_component2 = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::BUTTON,
+  type: WhatsappSdk::Resource::Component::Type::Button,
   index: 1,
-  sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+  sub_type: WhatsappSdk::Resource::Component::Subtype::QuickReply,
   parameters: [
-    WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "PAYLOAD")
+    WhatsappSdk::Resource::ButtonParameter.new(type: WhatsappSdk::Resource::ButtonParameter::Type::Payload, payload: "PAYLOAD")
   ]
 )
-@messages_api.send_template(sender_id: 12_345, recipient_number: "12345678", name: "hello_world", language: "en_US", components_json: [component_1])
+@messages_api.send_template(sender_id: 12_345, recipient_number: 12345678, name: "hello_world", language: "en_US", components_json: [component_1])
 ```
 
 </details>
 
 Alernative, you could pass a plain json like this:
 ```ruby
-@messages_api.send_template(sender_id: 12_345, recipient_number: "12345678", name: "hello_world", language: "en_US", components_json: [{...}])
+@messages_api.send_template(sender_id: 12_345, recipient_number: 12345678, name: "hello_world", language: "en_US", components_json: [{...}])
 ```
 
 ## Example
@@ -244,7 +313,7 @@ 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, make sure 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)
+- If the API response is `success` but the message is not delivered, make sure 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)
 
 ## Development
 
@@ -256,6 +325,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk) This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+### Run all the tests
+- **Unit tests:** Run `rake test`
+- **Sorbet Typecheck:** run `srb tc`
+- **Linters:** `bundle exec rubocop`
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "bundler/gem_tasks"
 require "rake/testtask"

data/bin/tapioca

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# typed: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")