cloud-waba-ruby-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b05346a3973d5ce70286253be967af2a3957a89596f25413875dd49aeac108c
+  data.tar.gz: d18f9be6b156d2a653847285261547471de8c6669d9e8b6099a5ccd165f59bb7
+SHA512:
+  metadata.gz: 493698b05d953833438948afb46209c02dec9eef058954708c4dc24fb7f2b0c6abd742582c8da349915ed011cc501f9cf1cf15f936180c3cab2a99e47c25230b
+  data.tar.gz: 9667f440fb7309e02f2bbd7f5a92e408f2a59dd8a8de29f62fb386a4456499b7c7a6233d51ea52b89ea37bb50b5cd40c425dafbf106f6aa2cc6d0a24ffc36fd7

data/.env.example

@@ -0,0 +1,9 @@
+WA_BASE_URL=
+M4D_APP_ID=
+M4D_APP_SECRET=
+WA_PHONE_NUMBER_ID=
+WA_BUSINESS_ACCOUNT_ID=
+CLOUD_API_ACCESS_TOKEN=
+CLOUD_API_VERSION=v16.0
+WEBHOOK_ENDPOINT=
+WEBHOOK_VERIFICATION_TOKEN=

data/.gitignore

@@ -0,0 +1,2 @@
+.env
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    cloud-waba-ruby-client (0.0.0)
+      dotenv (~> 2.8.0)
+      http (~> 4.0.0)
+      sorbet-runtime (~> 0.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    byebug (9.1.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.8.1)
+    hashdiff (1.0.1)
+    http (4.0.5)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http_parser.rb (0.6.0)
+    public_suffix (4.0.7)
+    rexml (3.2.6)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sorbet (0.5.10461)
+      sorbet-static (= 0.5.10461)
+    sorbet-runtime (0.5.10461)
+    sorbet-static (0.5.10461-universal-darwin-14)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    webmock (3.17.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 9.0, >= 9.0.5)
+  cloud-waba-ruby-client!
+  rspec (~> 3.4.0)
+  sorbet
+  sorbet-runtime
+  webmock (~> 3.17.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,176 @@
+# cloud-waba-ruby-client
+
+Ruby wrapper for [Cloud WhatsApp Business API](https://developers.facebook.com/docs/whatsapp/cloud-api).
+
+## Installation
+
+Add following line to your Gemfile:
+
+```ruby
+gem 'cloud-waba-ruby-client', '~> 0.0.0'
+```
+
+then run
+
+```shell
+bundle
+```
+
+or install it yourself as:
+
+```shell
+gem install cloud-waba-ruby-client
+```
+
+## Setup
+1. Make sure you have
+  - Meta business app
+  - WhatsApp Business account
+  - A phone number added to your WhatsApp business account
+  - Meta developer app
+2. Add following environment variables to your `.env` file:
+  ```shell
+  WA_BASE_URL=https://graph.facebook.com
+  CLOUD_API_VERSION=v16.0
+  M4D_APP_ID=
+  M4D_APP_SECRET=
+  WA_PHONE_NUMBER_ID=
+  WA_BUSINESS_ACCOUNT_ID=
+  CLOUD_API_ACCESS_TOKEN=
+  ```
+Fill credentials for your meta developer app, business account and phone number ids.
+
+## Usage
+### Sending template message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.messages.send_template(recipient: "+201XXXXXXXXX", template_name: "hello_world", template_lang: "en_US", components: [])
+```
+
+### Sending text message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.messages.send_text(body: "Hello World!", recipient: "+201XXXXXXXXX")
+```
+
+### Sending image message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.messages.send_image(caption: "Nice caption for image!", link: "https://picsum.photos/200/300",recipient: "+201XXXXXXXXX")
+```
+
+### Sending audio message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.messages.send_audio(link: "https://samplelib.com/lib/preview/mp3/sample-3s.mp3",recipient: "+201XXXXXXXXX")
+```
+
+### Sending video message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.messages.send_video(caption: "Nice caption for video!", link: "https://samplelib.com/lib/preview/mp4/sample-5s.mp4",recipient: "+201XXXXXXXXX")
+```
+
+### Sending document message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.messages.send_document(caption: "Nice caption for doc!", link: "https://download.samplelib.com/xls/sample-empty.xls",recipient: "+201XXXXXXXXX")
+```
+
+### Sending location message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.messages.send_location(longitude: 30.0849643, latitude: 31.2913638, name: "Cairo University", address: "1 شارع الجامعة, Giza Governorate 12613", recipient: "+201XXXXXXXXX")
+```
+
+### Sending contact message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+name = ::CloudWaba::Models::Messages::ContactName.new(formatted_name: "Ahmed Ali", first_name: "Ashley")
+phone_1 = ::CloudWaba::Models::Messages::ContactPhone.new(type: ::CloudWaba::Models::Enums::ContactPhoneType::Cell, phone: "+201XXXXXXXXX")
+contacts = [::CloudWaba::Models::Messages::Contact.new(name: name, phones: [phone_1])]
+client.messages.send_contact(contacts: contacts,recipient: "+201XXXXXXXXX")
+```
+<!-- ### Sending template with header, body, footer and buttons
+
+### Sending template with header, body, footer and buttons (variables)
+ -->
+
+
+
+
+### Listing templates
+```ruby
+require "cloud_waba/client"
+client = CloudWaba::Client.new
+client.templates.list(limit: 5)
+```
+### Creating a template
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+client.templates.create(name: "welcome", category: ::CloudWaba::Models::Enums::Templates::Category::Utility, language: "en", components: [::CloudWaba::Models::Templates::BodyComponent.new(text: "Welcome to our store!, how can we help?")])
+```
+
+### Creating a template with header, body and footer components with variables
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+category = ::CloudWaba::Models::Enums::Templates::Category::Marketing
+language = "en"
+
+header_text = "Hi {{1}}!"
+header_example = ::CloudWaba::Models::Templates::Example.new(values: ["ahmed"])
+header_component = ::CloudWaba::Models::Templates::HeaderTextComponent.new(text: header_text, example: header_example)
+
+body_text = "We offer {{1}} discount!"
+body_example = ::CloudWaba::Models::Templates::Example.new(values: ["20%"])
+body_component = ::CloudWaba::Models::Templates::BodyComponent.new(text: body_text, example: body_example)
+
+footer_text = "Petitux Team"
+footer_component = ::CloudWaba::Models::Templates::FooterComponent.new(text: footer_text)
+
+client.templates.create(name: "discount", category: category, language: language, components: [header_component, body_component, footer_component])
+```
+
+### Update Template
+```ruby
+client = CloudWaba::Client.new
+
+category = ::CloudWaba::Models::Enums::Templates::Category::Utility
+body_text = "Your order no. {{1}} has been placed!"
+body_example = ::CloudWaba::Models::Templates::Example.new(values: ["500"])
+body_component = ::CloudWaba::Models::Templates::BodyComponent.new(text: body_text, example: body_example)
+
+client.templates.update(template_id: "1027873614915405", category: category, components: [body_component])
+```
+
+### Delete Template
+```ruby
+client = CloudWaba::Client.new
+client.templates.delete(name: "discount")
+```
+
+<!-- ### Creating a template with header, body, footer and buttons
+
+### Sending template with header, body, footer and buttons
+
+### Sending template with header, body, footer and buttons (variables) -->

data/bin/console

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "dotenv/load"
+require "cloud_waba/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+
+def reload!(print = true)
+  puts 'Reloading ...' if print
+  # Main project directory.
+  root_dir = File.expand_path('..', __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w{lib}
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
+IRB.start(__FILE__)

data/cloud-waba-ruby-client.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name        = "cloud-waba-ruby-client"
+  s.version     = "0.0.1"
+  s.summary     = "Cloud Waba Client for Ruby."
+  s.description = "A simple API wrapper for Cloud Whatsapp Business API"
+  s.authors     = ["Ahmed Bassell"]
+  s.email       = "ahmedbassell@gmail.com"
+  # s.platform    = Gem::Platform::RUBY
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    =
+    "https://rubygems.org/gems/cloud_waba"
+  s.license       = "MIT"
+  
+  # Runtime dependencies
+  s.add_dependency 'dotenv', '~>2.8.0' # env variable
+  s.add_dependency 'http', '~> 4.0.0'
+
+  # Development dependencies
+  s.add_development_dependency "rspec", '~>3.4.0' # testing
+  s.add_development_dependency 'webmock', '~>3.17.0'
+  s.add_development_dependency 'byebug', '~> 9.0', '>= 9.0.5'
+  s.add_development_dependency 'sorbet', '~> 0.5.1'
+  s.add_runtime_dependency 'sorbet-runtime', '~>0.5.1'
+end

data/lib/api/messages/service.rb

@@ -0,0 +1,217 @@
+# typed: true
+# frozen_string_literal: true
+
+# require 'pry'
+
+module API
+  module Messages
+    class Service
+      extend ::T::Sig
+      extend ::T::Helpers
+
+      MESSAGING_PRODUCT = ::T.let("whatsapp", ::String)
+      RECIPIENT_TYPE = ::T.let("individual", ::String)
+
+      def initialize(config:)
+        @config = config
+      end
+
+
+      sig do
+        params(recipient: ::String, body: ::String, reply_message_id: ::T.nilable(::String)).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_text(recipient:, body:, reply_message_id: nil)
+        text_type = "text"
+        enable_preview = false
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": text_type,
+          "text": {
+            "preview_url": enable_preview,
+            "body": body
+          }
+        }
+
+        payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      sig do
+        params(recipient: ::String, caption: ::T.nilable(::String), link: ::String, reply_message_id: ::T.nilable(::String)).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_image(recipient:, caption:, link:, reply_message_id: nil)
+        image_type = "image"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": image_type,
+        }
+
+        payload["image"] = { link: link, caption: caption }
+        payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      sig do
+        params(recipient: ::String, link: ::String, reply_message_id: ::T.nilable(::String)).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_audio(recipient:, link:, reply_message_id: nil)
+        audio_type = "audio"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": audio_type,
+        }
+
+        payload["audio"] = { link: link }
+        payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      sig do
+        params(recipient: ::String, caption: ::T.nilable(::String), link: ::String, reply_message_id: ::T.nilable(::String)).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_video(recipient:, caption:, link:, reply_message_id: nil)
+        video_type = "video"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": video_type,
+        }
+
+        payload["video"] = { link: link, caption: caption }
+        payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      sig do
+        params(recipient: ::String, caption: ::T.nilable(::String), link: ::String, reply_message_id: ::T.nilable(::String)).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_document(recipient:, caption:, link:, reply_message_id: nil)
+        document_type = "document"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": document_type,
+        }
+
+        payload["document"] = { link: link, caption: caption }
+        payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      sig do
+        params(recipient: ::String, longitude: ::Float, latitude: ::Float, name: ::String, address: ::String, reply_message_id: ::T.nilable(::String)).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_location(recipient:, longitude:, latitude:, name:, address:, reply_message_id: nil)
+        location_type = "location"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": location_type,
+        }
+
+        payload["location"] = {
+          "longitude": longitude,
+          "latitude": latitude,
+          "name": name,
+          "address": address
+        }
+        payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      sig do
+        params(recipient: ::String, contacts: ::T::Array[::CloudWaba::Models::Messages::Contact], reply_message_id: ::T.nilable(::String)).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_contact(recipient:, contacts:, reply_message_id: nil)
+        contacts_type = "contacts"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": contacts_type,
+        }
+
+        payload["contacts"] = contacts.map(&:serialize)
+        payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      sig do
+        params(
+          recipient: ::String,
+          template_name: ::String,
+          template_lang: ::String,
+          components: ::T::Array[::CloudWaba::Models::Templates::Component]
+        ).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_template(recipient:, template_name:, template_lang:, components:)
+        template_type = "template"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": template_type,
+          "template": {
+            "name": template_name,
+            "language": {
+              "code": template_lang
+            },
+            "components": []
+          }
+        }
+
+        response = http_client.post(body: payload, headers: {})
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      private
+
+      def http_client
+        ::CloudWaba::HttpClient.new(base_url: messages_endpoint, auth_token: @config.access_token)
+      end
+
+      def messages_endpoint
+        "#{@config.base_url}/#{@config.api_version}/#{@config.phone_number_id}/messages"
+      end
+    end
+  end
+end

data/lib/api/templates/service.rb

@@ -0,0 +1,108 @@
+# typed: true
+# frozen_string_literal: true
+
+# require 'pry'
+
+module API
+  module Templates
+    class Service
+      extend ::T::Sig
+      extend ::T::Helpers
+
+      MESSAGE_TEMPLATES_PATH = T.let("message_templates", ::String)
+
+      def initialize(config:)
+        @config = config
+      end
+
+
+      sig do
+        params(limit: T.nilable(::Integer)).returns(::CloudWaba::Models::Templates::List)
+      end
+      def list(limit: 20)
+        fields = "id,name,category,language,status"
+        response = templates_client.get(params: { fields: fields, limit: limit })
+
+        parsed_response = JSON.parse(response.body.to_s)
+        templates = parsed_response["data"].map{|hash| ::CloudWaba::Models::Templates::Response.parse(template_hash: hash)}
+        ::CloudWaba::Models::Templates::List.new(templates: templates, paging: parsed_response["paging"])
+      end
+
+      sig do
+        params(
+          name: ::String,
+          category: ::CloudWaba::Models::Enums::Templates::Category,
+          language: ::String,
+          components: ::T::Array[::CloudWaba::Models::Templates::Component]
+        ).returns(::CloudWaba::Models::Templates::Response)
+      end
+      def create(name:, category:, language:, components:)
+        allow_category_change = true
+
+        payload = {
+          "name": name,
+          "category": category.serialize,
+          "allow_category_change": allow_category_change,
+          "language": language,
+          "components": components.map(&:serialize)
+        }
+
+        response = templates_client.post(body: payload)
+        ::CloudWaba::Models::Templates::Response.parse(response: response)
+      end
+
+      sig do
+        params(
+          template_id: ::String,
+          category: ::CloudWaba::Models::Enums::Templates::Category,
+          components: ::T::Array[::CloudWaba::Models::Templates::Component]
+        ).returns(::T::Boolean)
+      end
+      def update(template_id:, category:, components:)
+        template_client = template_endpoint(template_id: template_id)
+        payload = {
+          "category": category.serialize,
+          "components": components.map(&:serialize)
+        }
+        response = client.post(body: payload)
+        parsed_response = JSON.parse(response.body.to_s)
+
+        parsed_response["success"] || false
+      end
+
+      sig do
+        params(
+          name: ::String,
+          template_id: ::T.nilable(::String)
+        ).returns(::T::Boolean)
+      end
+      def delete(name:, template_id: nil)
+        params = { name: name }
+        params[:hsm_id] = template_id unless template_id.nil?
+
+        response = templates_client.delete(params: params)
+        parsed_response = JSON.parse(response.body.to_s)
+        
+        parsed_response["success"] || false
+      end
+
+      private
+
+      def templates_client
+        ::CloudWaba::HttpClient.new(base_url: templates_endpoint, auth_token: @config.access_token)
+      end
+
+      def template_endpoint(template_id:)
+        ::CloudWaba::HttpClient.new(base_url: template_endpoint(template_id: template_id), auth_token: @config.access_token)
+      end
+
+      def templates_endpoint
+        "#{@config.base_url}/#{@config.api_version}/#{@config.business_account_id}/#{MESSAGE_TEMPLATES_PATH}"
+      end
+
+      def template_endpoint(template_id:)
+        "#{@config.base_url}/#{@config.api_version}/#{template_id}"
+      end
+    end
+  end
+end