cloud-waba-ruby-client 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add418afadc7db2c4e164bc742a67bb82b5b372d7bf84f956fbc8d7c2d948930
-  data.tar.gz: c210daa37769103a78c3f290d75e5af35cc92104b1f2b1b6f21918d24a2e8cac
+  metadata.gz: 776fe9551683b144357021a087daf8be4600e8bed893552017ded5d0ddbf9306
+  data.tar.gz: 9f6118a9123f470b303a255ba782a7db3349abfcc649c4d391f04c4e4aeef473
 SHA512:
-  metadata.gz: f1c12beadeedf7f0fa3b8268b9b8d548ebb362c11e1626b88a4b7de3ef28f55a131c89dbb2d1c3f894e68c8485177fa7b490927ddb82cc87ba5475b4b17465d2
-  data.tar.gz: 43de35076e075ceb5eb08307b975f78326d6a7ab97bc89bf8ce07498319be284ec777548e6ec6023b36178f8166c463c91639ba7c71dc7e474d8e0b60fb3c268
+  metadata.gz: 849442cf4206504c78a3552d75eb87c27c3a9e0b68ac67e28ff4644706cc3d3048d9a634aadbc7dc4abf2fa0566848165e800ce27275adb70ab359f706ecd395
+  data.tar.gz: da26c3bc79ef14949ae2aba44816685a9e10a02bbb49f52892dc72ee9608a117131ccffdf55ce0076dc4f9eae1637a3319c22e3664e68101258650626f2b6d84

data/README.md

@@ -7,7 +7,7 @@ Ruby wrapper for [Cloud WhatsApp Business API](https://developers.facebook.com/d
 Add following line to your Gemfile:
 
 ```ruby
-gem 'cloud-waba-ruby-client', '~> 0.0.2'
+gem 'cloud-waba-ruby-client', '~> 0.0.5'
 ```
 
 then run
@@ -134,6 +134,14 @@ phone_1 = ::CloudWaba::Models::Messages::ContactPhone.new(type: ::CloudWaba::Mod
 contacts = [::CloudWaba::Models::Messages::Contact.new(name: name, phones: [phone_1])]
 client.messages.send_contact(contacts: contacts,recipient: "+201XXXXXXXXX")
 ```
+
+### Sending reaction on a message
+```ruby
+require "cloud_waba/client"
+
+client = CloudWaba::Client.new
+ client.messages.send_reaction(recipient: "+201XXXXXXXXX", emoji: "💙", reply_message_id: "wamid.HBgMMjAxMjAxMzIyMzMxFQIAEZgSQTU5QkExMUUyQlRCNTU1NTVEAA==")
+```
 <!-- ### Sending template with header, body, footer and buttons
 
 ### Sending template with header, body, footer and buttons (variables)

data/cloud-waba-ruby-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "cloud-waba-ruby-client"
-  s.version     = "0.0.3"
+  s.version     = "0.0.5"
   s.summary     = "Cloud Waba Client for Ruby."
   s.description = "A simple API wrapper for Cloud Whatsapp Business API"
   s.authors     = ["Ahmed Bassell"]

data/lib/api/messages/service.rb

@@ -1,7 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
-# require 'pry'
+require 'pry'
 
 module API
   module Messages
@@ -37,7 +37,8 @@ module API
 
         payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
 
-        response = http_client.post(body: payload, headers: {})
+        response = with_error_handling { http_client.post(body: payload, headers: {}) }
+
         parsed_response = JSON.parse(response.body.to_s)
         ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
       end
@@ -58,7 +59,7 @@ module API
         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: {})
+        response = with_error_handling { http_client.post(body: payload, headers: {}) }
         parsed_response = JSON.parse(response.body.to_s)
         ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
       end
@@ -79,7 +80,7 @@ module API
         payload["audio"] = { link: link }
         payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
 
-        response = http_client.post(body: payload, headers: {})
+        response = with_error_handling { http_client.post(body: payload, headers: {}) }
         parsed_response = JSON.parse(response.body.to_s)
         ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
       end
@@ -100,7 +101,7 @@ module API
         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: {})
+        response = with_error_handling { http_client.post(body: payload, headers: {}) }
         parsed_response = JSON.parse(response.body.to_s)
         ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
       end
@@ -121,7 +122,7 @@ module API
         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: {})
+        response = with_error_handling { http_client.post(body: payload, headers: {}) }
         parsed_response = JSON.parse(response.body.to_s)
         ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
       end
@@ -147,7 +148,7 @@ module API
         }
         payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
 
-        response = http_client.post(body: payload, headers: {})
+        response = with_error_handling { http_client.post(body: payload, headers: {}) }
         parsed_response = JSON.parse(response.body.to_s)
         ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
       end
@@ -168,11 +169,49 @@ module API
         payload["contacts"] = contacts.map(&:serialize)
         payload["context"] = { "message_id": reply_message_id } unless reply_message_id.nil?
 
-        response = http_client.post(body: payload, headers: {})
+        response = with_error_handling { http_client.post(body: payload, headers: {}) }
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Messages::Response.parse(hash: parsed_response)
+      end
+
+      # curl -X  POST \
+      #   'https://graph.facebook.com/v18.0/FROM_PHONE_NUMBER_ID/messages' \
+      #   -H 'Authorization: Bearer ACCESS_TOKEN' \
+      #   -H 'Content-Type: application/json' \
+      #   -d '{
+      #     "messaging_product": "whatsapp",
+      #     "recipient_type": "individual",
+      #     "to": "PHONE_NUMBER",
+      #     "type": "reaction",
+      #     "reaction": {
+      #       "message_id": "wamid.HBgLM...",
+      #       "emoji": "\uD83D\uDE00"
+      #     }
+      #   }'
+      sig do
+        params(recipient: ::String, emoji: ::String, reply_message_id: ::String).returns(::CloudWaba::Models::Messages::Response)
+      end
+      def send_reaction(recipient:, emoji:, reply_message_id: nil)
+        reaction_type = "reaction"
+
+        payload = {
+          "messaging_product": MESSAGING_PRODUCT,
+          "recipient_type": RECIPIENT_TYPE,
+          "to": recipient,
+          "type": reaction_type,
+        }
+
+        payload["reaction"] = {
+          "message_id": reply_message_id,
+          "emoji": emoji
+        }
+
+        response = with_error_handling { 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,
@@ -198,11 +237,21 @@ module API
           }
         }
 
-        response = http_client.post(body: payload, headers: {})
+        response = with_error_handling { 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(media_id: ::String).returns(::CloudWaba::Models::Media::Response)
+      end
+      def fetch_media_url(media_id:)
+        url = "#{@config.base_url}/#{@config.api_version}/#{media_id}"
+        response = with_error_handling { http_client.get(url) }
+        parsed_response = JSON.parse(response.body.to_s)
+        ::CloudWaba::Models::Media::Response.parse(hash: parsed_response)
+      end
+
       private
 
       def http_client
@@ -212,6 +261,25 @@ module API
       def messages_endpoint
         "#{@config.base_url}/#{@config.api_version}/#{@config.phone_number_id}/messages"
       end
+
+      def with_error_handling
+        return unless block_given?
+
+        response = yield
+        parsed_response = JSON.parse(response.body.to_s)
+        error_message = parsed_response.dig("error", "message")
+
+        case response.code
+        when 400
+          raise ::CloudWaba::Errors::BadRequest, error_message
+        when 401
+          raise ::CloudWaba::Errors::Unauthorized, error_message
+        else
+          # Success
+        end
+
+        response
+      end
     end
   end
 end

data/lib/api/templates/service.rb

@@ -21,7 +21,7 @@ module API
       end
       def list(limit: 20)
         fields = "id,name,category,language,status"
-        response = templates_client.get(params: { fields: fields, limit: limit })
+        response = with_error_handling { 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)}
@@ -47,7 +47,7 @@ module API
           "components": components.map(&:serialize)
         }
 
-        response = templates_client.post(body: payload)
+        response = with_error_handling { templates_client.post(body: payload) }
         ::CloudWaba::Models::Templates::Response.parse(response: response)
       end
 
@@ -64,7 +64,7 @@ module API
           "category": category.serialize,
           "components": components.map(&:serialize)
         }
-        response = client.post(body: payload)
+        response = with_error_handling { client.post(body: payload) }
         parsed_response = JSON.parse(response.body.to_s)
 
         parsed_response["success"] || false
@@ -80,7 +80,7 @@ module API
         params = { name: name }
         params[:hsm_id] = template_id unless template_id.nil?
 
-        response = templates_client.delete(params: params)
+        response = with_error_handling { templates_client.delete(params: params) }
         parsed_response = JSON.parse(response.body.to_s)
         
         parsed_response["success"] || false
@@ -103,6 +103,25 @@ module API
       def template_endpoint(template_id:)
         "#{@config.base_url}/#{@config.api_version}/#{template_id}"
       end
+
+      def with_error_handling
+        return unless block_given?
+
+        response = yield
+        parsed_response = JSON.parse(response.body.to_s)
+        error_message = parsed_response.dig("error", "message")
+
+        case response.code
+        when 400
+          raise ::CloudWaba::Errors::BadRequest, error_message
+        when 401
+          raise ::CloudWaba::Errors::Unauthorized, error_message
+        else
+          # Success
+        end
+
+        response
+      end
     end
   end
 end

data/lib/cloud_waba/client.rb

@@ -10,6 +10,7 @@ require_relative "models/enums/templates/component_type"
 require_relative "models/enums/templates/button_type"
 require_relative "models/enums/templates/format"
 require_relative "models/enums/contact_phone_type"
+
 # Models
 require_relative "models/config"
 require_relative "models/contact"
@@ -17,6 +18,7 @@ require_relative "models/messages/response"
 require_relative "models/messages/contact_name"
 require_relative "models/messages/contact_phone"
 require_relative "models/messages/contact"
+require_relative "models/media/response"
 
 require_relative "models/templates/example"
 require_relative "models/templates/component"
@@ -35,6 +37,12 @@ require_relative "models/templates/buttons_component"
 require_relative "models/templates/message_template"
 require_relative "models/templates/response"
 require_relative "models/templates/list"
+
+# Errors
+require_relative "errors/unauthorized"
+require_relative "errors/bad_request"
+require_relative "errors/missing_parameter"
+
 # Helpers
 require_relative "utils"
 require_relative "http_client"

data/lib/cloud_waba/errors/bad_request.rb

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+module CloudWaba
+  module Errors
+    class BadRequest < ::StandardError
+    end
+  end
+end

data/lib/cloud_waba/errors/missing_parameter.rb

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+module CloudWaba
+  module Errors
+    class MissingParameter < ::StandardError
+    end
+  end
+end

data/lib/cloud_waba/errors/unauthorized.rb

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+module CloudWaba
+  module Errors
+    class Unauthorized < ::StandardError
+    end
+  end
+end

data/lib/cloud_waba/models/media/response.rb

@@ -0,0 +1,48 @@
+# typed: true
+# frozen_string_literal: true
+
+# require 'pry'
+
+module CloudWaba
+  module Models
+    module Media
+      class Response < T::Struct
+        extend ::T::Sig
+        extend ::T::Helpers
+        ##
+        # {
+        #   "messaging_product": "whatsapp",
+        #   "url": "<URL>",
+        #   "mime_type": "<MIME_TYPE>",
+        #   "sha256": "<HASH>",
+        #   "file_size": "<FILE_SIZE>",
+        #   "id": "<MEDIA_ID>"
+        # }
+        prop :messaging_product, ::CloudWaba::Models::Enums::MessagingProduct
+        prop :url, ::String
+        prop :mime_type, ::String
+        prop :sha256, ::String
+        prop :file_size, ::Integer
+        prop :id, ::String
+
+        sig { params(hash: ::T::Hash[::T.untyped, ::T.untyped]).returns(::CloudWaba::Models::Media::Response) }
+        def self.parse(hash:)
+          id = hash["id"]
+          url = hash["url"]
+          mime_type = hash["mime_type"]
+          sha256 = hash["sha256"]
+          file_size = hash["file_size"]
+
+          self.new(
+            messaging_product: ::CloudWaba::Models::Enums::MessagingProduct::WhatsApp,
+            url: url,
+            mime_type: mime_type,
+            sha256: sha256,
+            file_size: file_size,
+            id: id,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/cloud_waba/utils.rb

@@ -18,7 +18,6 @@ module CloudWaba
     end
     def self.import_config(app_id:, app_secret:, phone_number_id:, business_account_id:, access_token:, api_version:)
       Dotenv.load
-      validate_config!
 
       base_url = ENV.fetch("WA_BASE_URL", "https://graph.facebook.com")
       app_id = app_id || ENV.fetch("M4D_APP_ID", "")
@@ -28,6 +27,14 @@ module CloudWaba
       access_token = access_token || ENV.fetch("CLOUD_API_ACCESS_TOKEN", "")
       api_version = api_version || ENV.fetch("CLOUD_API_VERSION", "v16.0")
 
+      validate_config!(
+        app_id: app_id,
+        app_secret: app_secret,
+        phone_number_id: phone_number_id,
+        business_account_id: business_account_id,
+        access_token: access_token
+      )
+
       ::CloudWaba::Models::Config.new(
         base_url: base_url,
         app_id: app_id,
@@ -41,9 +48,28 @@ module CloudWaba
 
     private
 
-    sig { void }
-    def self.validate_config!
-      # TODO: Validate configuration
+    sig { params(
+      app_id: ::T.nilable(::String),
+      app_secret: ::T.nilable(::String),
+      phone_number_id: ::T.nilable(::String),
+      business_account_id: ::T.nilable(::String),
+      access_token: ::T.nilable(::String)).void }
+    def self.validate_config!(app_id:, app_secret:, phone_number_id:, business_account_id:, access_token:)
+      error_message = nil
+
+      if app_id.nil? || app_id.empty?
+        error_message = "app_id parameter is missing"
+      elsif app_secret.nil? || app_secret.empty?
+        error_message = "app_secret parameter is missing"
+      elsif phone_number_id.nil? || phone_number_id.empty?
+        error_message = "phone_number_id parameter is missing"
+      elsif business_account_id.nil? || business_account_id.empty?
+        error_message = "business_account_id parameter is missing"
+      elsif access_token.nil? || access_token.empty?
+        error_message = "access_token parameter is missing"
+      end
+
+      raise ::CloudWaba::Errors::MissingParameter, error_message unless error_message.nil?
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud-waba-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Ahmed Bassell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-05 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -112,6 +112,9 @@ files:
 - lib/api/messages/service.rb
 - lib/api/templates/service.rb
 - lib/cloud_waba/client.rb
+- lib/cloud_waba/errors/bad_request.rb
+- lib/cloud_waba/errors/missing_parameter.rb
+- lib/cloud_waba/errors/unauthorized.rb
 - lib/cloud_waba/http_client.rb
 - lib/cloud_waba/models/config.rb
 - lib/cloud_waba/models/contact.rb
@@ -121,6 +124,7 @@ files:
 - lib/cloud_waba/models/enums/templates/category.rb
 - lib/cloud_waba/models/enums/templates/component_type.rb
 - lib/cloud_waba/models/enums/templates/format.rb
+- lib/cloud_waba/models/media/response.rb
 - lib/cloud_waba/models/messages/contact.rb
 - lib/cloud_waba/models/messages/contact_name.rb
 - lib/cloud_waba/models/messages/contact_phone.rb