whatsapp_sdk 0.0.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 789c30c096735aa557c643a11a810990c8bc2c207360bee7d0b0e9710f2de60c
-  data.tar.gz: 66bf61944f214767a8feae139e62d544be51c10e32895b33ca5239b3b1582009
+  metadata.gz: 3dabd5d87a1a3988caaafc2a090c9b85bcea77cc764132a169227a5ca1c4b409
+  data.tar.gz: 1ac41750e5e737fbf9a606e013015d796b68c328e3950241cad051c8eef6d674
 SHA512:
-  metadata.gz: cc2eef92ce66f87374e1f2fb0f5cfb01f9bbf5814ae80d625403660fd1fc9d834680fb72a06941c8d66f0fb30e9dabe5561231c4547cc2fd1daf651300b93193
-  data.tar.gz: fe548e9bfee0913a4eca4b1675342c565d35821e5d7b384908eebc0073b03616d7bc762ca8afefd1284dd6bd6ddffe88904b339e6448622b7675f09e68ed62e9
+  metadata.gz: 183f8600f1e74a46b4a38f290c806f479a0e52a20ec7c6d836b2fe3ac8038e4c91620e83d8780810907a2395555169aa8911fd5385299adcd3830a3492bea9a7
+  data.tar.gz: ce2cb90d04e06dc62d0294bcd395b3cf6cdffb2e60c24a8671539825de486299b11647eab9cf875007f290b8a35af350aadb7a985cad4bad2bcc415d85955cd3

data/.rubocop.yml

@@ -1,3 +1,10 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+
 Style/StringLiterals:
   Enabled: false
 
@@ -11,7 +18,10 @@ Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 40
+
+Naming/VariableNumber:
+  Enabled: false
 
 Metrics/ClassLength:
   Enabled: false
@@ -21,4 +31,7 @@ Metrics/AbcSize:
 
 # Wait until https://github.com/rubocop/rubocop/issues/8761 is fixed
 Gemspec/RequiredRubyVersion:
-  Enabled: false
+  Enabled: false
+
+Minitest/MultipleAssertions:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Unreleased
 
+# 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
+ 
+# v 0.1.0
+- Added Message Template API.
+- Added Currency and Datetime resources.
+- Added Media resource.
+- Added Component and ParameterObject resource.
+- Fixed bug in recipient_number in Messages API.
+
 # v 0.0.2
 - Implement read message.
 - Implement Yard doc.
-

data/Gemfile

@@ -4,18 +4,21 @@ source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in whatsapp_sdk.gemspec
 gem("faraday")
+gem("faraday-multipart")
 gem("oj")
+gem("rake", ">= 12.3.3")
 
 group(:test) do
   gem('mocha')
+  gem('rubocop', require: false)
+  gem('rubocop-minitest', require: false)
+  gem('rubocop-performance', require: false)
 end
 
 group(:development) do
   gem('pry')
   gem('pry-nav')
-  gem('rubocop', require: false)
 end
 
 gemspec

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.0.1)
+    whatsapp_sdk (0.2.0)
       faraday (~> 2.3.0)
+      faraday-multipart (~> 1.0.4)
       oj (~> 3.13.13)
 
 GEM
@@ -13,11 +14,14 @@ GEM
     faraday (2.3.0)
       faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (2.0.3)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.1)
     mocha (1.14.0)
-    oj (3.13.13)
+    multipart-post (2.2.3)
+    oj (3.13.14)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -27,10 +31,10 @@ GEM
     pry-nav (1.0.0)
       pry (>= 0.9.10, < 0.15)
     rainbow (3.1.1)
-    rake (10.5.0)
+    rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.30.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -41,9 +45,14 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
+    rubocop-minitest (0.20.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   x86_64-darwin-21
@@ -51,13 +60,16 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.3)
   faraday
+  faraday-multipart
   minitest (~> 5.0)
   mocha
   oj
   pry
   pry-nav
-  rake (~> 10.0)
+  rake (>= 12.3.3)
   rubocop
+  rubocop-minitest
+  rubocop-performance
   whatsapp_sdk!
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,15 @@
 # Ruby Whatsapp SDK
+[![Gem Version](https://badge.fury.io/rb/whatsapp_sdk.svg)](https://badge.fury.io/rb/whatsapp_sdk)
+[![CircleCI](https://circleci.com/gh/circleci/circleci-docs.svg?style=svg)](https://circleci.com/gh/ignacio-chiazzo/ruby_whatsapp_sdk)
+<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!
 
+
+https://user-images.githubusercontent.com/11672878/173238826-6fc0a6f8-d0ee-4eae-8947-7dfd3b8b3446.mov
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,12 +28,22 @@ Or install it yourself as:
 
 ## Quick Start
 
-There are two primary resources, `Messages` 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`. 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.
+
+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` or `PhoneNumbers` you need to create a `Client` instance by passing the `access_token` like this:
+1) Using an initializer
+  
+```ruby
+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:
 
 ```ruby
 client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access token
+messages_api = WhatsappSdk::Api::Messages.new(client)
 ```
 
 Each API operation returns a `WhatsappSdk::Api::Response` that contains `data` and `error` and a couple of helpful functions such as `ok?` and `error?`. There are three types of response `WhatsappSdk::Api::MessageDataResponse`, `WhatsappSdk::Api::PhoneNumberDataResponse` and `WhatsappSdk::Api::PhoneNumbersDataResponse`. Each of them contains different attributes.
@@ -35,11 +52,13 @@ Each API operation returns a `WhatsappSdk::Api::Response` that contains `data` a
 First, create the client and then create an instance `WhatsappSdk::Api::Messages` that requires a client as a param like this:
 
 ```ruby
-client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access_token
-messages_api = WhatsappSdk::Api::Messages.new(client)
-phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new(client)
+messages_api = WhatsappSdk::Api::Messages.new
+phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
+medias_api = WhatsappSdk::Api::Medias.new
 ```
 
+Note: Remember to initialize the client first!
+
 ### Phone numbers API
 Get the list of phone numbers registered
 ```ruby
@@ -51,6 +70,28 @@ Get the a phone number by id
 phone_numbers_api.registered_numbers("123456") # accepts a phone_number_id
 ```
 
+### Media API
+
+Upload a media
+```ruby
+medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/whatsapp.png", type: "image/png")
+```
+
+Get a media
+```ruby
+media = medias_api.media(media_id: MEDIA_ID)
+```
+
+Download media
+```ruby
+medias_api.download(url: MEDIA_URL, file_path: 'tmp/downloaded_whatsapp.png')
+```
+
+Delete a media
+```ruby
+medias_api.delete(media_id: MEDIA_ID)
+```
+
 ### Messages API
 
 **Send a text message**
@@ -59,11 +100,19 @@ phone_numbers_api.registered_numbers("123456") # accepts a phone_number_id
 messages_api.send_text(sender_id: 1234, recipient_number: "112345678", message: "hola")
 ```
 
+**Read a message**
+```ruby
+messages_api.read_message(sender_id: 1234, message_id: "wamid.HBgLMTM0M12345678910=")
+```
+
+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 location message**
 
 ```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"
 )
 ```
@@ -71,12 +120,12 @@ messages_api.send_location(
 **Send an image message**
 It could use a link or an image_id.
 ```ruby
-# with a link 
+# with a link
 messages_api.send_image(
   sender_id: 123123, recipient_number: "56789", link: "image_link", caption: "Ignacio Chiazzo Profile"
 )
 
-# with an image id 
+# with an image id
 messages_api.send_image(
   sender_id: 123123, recipient_number: "56789", image_id: "1234", caption: "Ignacio Chiazzo Profile"
 )
@@ -85,22 +134,22 @@ messages_api.send_image(
 **Send an audio message**
 It could use a link or an audio_id.
 ```ruby
-# with a link 
+# with a link
 messages_api.send_audio(sender_id: 123123, recipient_number: "56789", link: "audio_link")
 
-# with an audio id 
+# with an audio id
 messages_api.send_audio(sender_id: 123123, recipient_number: "56789", audio_id: "1234")
 ```
 
 **Send a document message**
 It could use a link or a document_id.
 ```ruby
-# with a link 
+# with a link
 messages_api.send_document(
   sender_id: 123123, recipient_number: "56789", link: "document_link", caption: "Ignacio Chiazzo"
 )
 
-# with a document id 
+# with a document id
 messages_api.send_document(
   sender_id: 123123, recipient_number: "56789", document_id: "1234", caption: "Ignacio Chiazzo"
 )
@@ -109,7 +158,7 @@ messages_api.send_document(
 **Send a sticker message**
 It could use a link or a sticker_id.
 ```ruby
-# with a link 
+# with a link
 messages_api.send_sticker(sender_id: 123123, recipient_number: "56789", link: "link")
 
 # with a sticker_id
@@ -117,104 +166,86 @@ messages_api.send_sticker(sender_id: 123123, recipient_number: "56789", sticker_
 ```
 
 **Send contacts message**
-To send a contact, you need to create a Contact instance object that contain objects embedded like 
-`addresses`, `birthday`, `emails`, `name`, `org`. See this [guide](/test/contact_helper.rb) to learn how to create contacts objects.
+To send a contact, you need to create a Contact instance object that contain objects embedded like `addresses`, `birthday`, `emails`, `name`, `org`. See this [guide](/test/contact_helper.rb) to learn how to create contacts objects.
 
 ```ruby
 contacts = [create_contact(params)]
 messages_api.send_contacts(sender_id: 123123, recipient_number: "56789", contacts: contacts)
 ```
 
-## Example
-
-<details><summary>Example in a single file. </summary>
-    
-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`
-
+Alernative, you could pass a plain json like this:
 ```ruby
-# frozen_string_literal: true
-
-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
+messages_api.send_contacts(sender_id: 123123, recipient_number: "56789", contacts_json: {...})
+```
 
-require 'whatsapp_sdk'
-require "pry"
-require "pry-nav"
+**Send a template message**
+WhatsApp message templates are specific message formats that businesses use to send out notifications or customer care messages to people that have opted in to notifications. Messages can include appointment reminders, shipping information, issue resolution or payment updates.
 
-ACCESS_TOKEN = "12345" # replace this with a valid access_token
-SENDER_ID = 107878721936019
-RECEIPIENT_NUMBER = "1234"
+**Before sending a message template, you need to create one.** visit the [Official API Documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates)
 
-client = WhatsappSdk::Api::Client.new(ACCESS_TOKEN) # replace this with a valid access_token
-messages_api = WhatsappSdk::Api::Messages.new(client)
-phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new(client)
+<details> <summary>Component's example</summary>
 
-phone_numbers_api.registered_number("107878721936019")
-phone_numbers_api.registered_numbers("114503234599312") 
-
-messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, message: "hola")
-messages_api.send_location(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, 
-  longitude: 45.4215, latitude: 75.6972, name: "nacho", address: "141 cooper street"
+```ruby
+currency = WhatsappSdk::Resource::Currency.new(code: "USD", amount: 1000, fallback_value: "1000")
+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)
+
+header_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::HEADER,
+  parameters: [parameter_image]
 )
 
-# Send images
-
-## with a link 
-messages_api.send_image(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "image_link", caption: "Ignacio Chiazzo Profile"
+body_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BODY,
+  parameters: [parameter_text, parameter_currency, parameter_date_time]
 )
 
-## with an image id 
-messages_api.send_image(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, image_id: "1234", caption: "Ignacio Chiazzo Profile"
+button_component1 = 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")
+  ]
 )
 
-# Send audios
-## with a link 
-messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "audio_link")
-
-## with an audio id 
-messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, audio_id: "1234")
-
-# Send documents
-## with a link 
-messages_api.send_document(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "document_link", caption: "Ignacio Chiazzo"
+button_component2 = 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")
+  ]
 )
+@messages_api.send_template(sender_id: 12_345, recipient_number: "12345678", name: "hello_world", language: "en_US", components_json: [component_1])
+```
 
-## with a document id 
-messages_api.send_document(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, document_id: "1234", caption: "Ignacio Chiazzo"
-)
+</details>
 
-# send stickers
-## with a link 
-messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "link")
+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: [{...}])
+```
 
-## with a sticker_id
-messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, sticker_id: "1234")
-binding.pry
+## Example
+
+Visit [the example file](/example.rb) with examples to call the API in a single file.
 
-```
-</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.
 
+## 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)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
@@ -223,7 +254,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/ignacio-chiazzo/whatsapp_sdk](https://github.com/ignacio-chiazzo/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.
+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.
 
 ## License