whatsapp-ruby-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 135d887ffef729da0fe2d5683bc829c4a24769886173503061698fb331c37c95
+  data.tar.gz: d6a1421398e7440bc90e4ecfabc960de2d32ba83feccffd7e6495d60e5389a58
+SHA512:
+  metadata.gz: 53c97158cf0ac6838076325a63a8478cd49aeb8962df88282512388dc0bd8c7d4c26deecae21da234b5fc91c54cfd92d4cd13a46d9eab1c44a7dc2fcb972a870
+  data.tar.gz: 7adb978fb903dc7b054eb33504cb85263c0fca41da57ee675f4ebb509c382ee3248b8a2d0f68f7be522318d9e8e14eea190ddb136fc77293b976656a94b3892e

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2022 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,85 @@
+
+# Getting Started with WhatsApp Cloud API
+
+## Introduction
+
+Welcome to the WhatsApp API from Meta.
+
+Individual developers and existing Business Service Providers (BSPs) can now send and receive messages via the WhatsApp API using a cloud-hosted version of the WhatsApp Business API. Compared to the previous solutions, the cloud-based WhatsApp API is simpler to use and is a more cost-effective way for businesses to use WhatsApp. Please keep in mind the following configurations:
+
+| Name | Description |
+| --- | --- |
+| Version | Latest [Graph API version](https://developers.facebook.com/docs/graph-api/). For example: v13.0 |
+| User-Access-Token | Your user access token after signing up at [developers.facebook.com](https://developers.facebook.com). |
+| WABA-ID | Your WhatsApp Business Account (WABA) ID. |
+| Phone-Number-ID | ID for the phone number connected to the WhatsApp Business API. You can get this with a [Get Phone Number ID request](3184f675-d289-46f1-88e5-e2b11549c418). |
+| Business-ID | Your Business' ID. Once you have your Phone-Number-ID, make a [Get Business Profile request](#99fd3743-46cf-46c4-95b5-431c6a4eb0b0) to get your Business' ID. |
+| Recipient-Phone-Number | Phone number that you want to send a WhatsApp message to. |
+| Media-ID | ID for the media to [send a media message](#0a632754-3788-43bf-b785-ac6a73423d5a) or [media template message](#439c926a-8a6c-4972-ab2c-d99297716da9) to your customers. |
+| Media-URL | URL for the media to [download media content](#cbe5ece3-246c-48f3-b338-074187dfef66). |
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install whatsapp-ruby-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'whatsapp-ruby-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the whatsapp-ruby-sdk gem](https://rubygems.org/gems/whatsapp-ruby-sdk/versions/1.0.0).
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `access_token` | `String` | The OAuth 2.0 Access Token to use for API requests. |
+| `version` | `String` | *Default*: `'v13.0'` |
+| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+
+The API client can be initialized as follows:
+
+```ruby
+client = WhatsAppCloudApi::Client.new(
+  access_token: 'AccessToken',
+  environment: Environment::PRODUCTION,
+  version: 'v13.0',
+)
+```
+
+## Authorization
+
+This API uses `OAuth 2 Bearer token`.
+
+## List of APIs
+
+* [Business Profiles](doc/controllers/business-profiles.md)
+* [Phone Numbers](doc/controllers/phone-numbers.md)
+* [Two-Step Verification](doc/controllers/two-step-verification.md)
+* [Messages](doc/controllers/messages.md)
+* [Registration](doc/controllers/registration.md)
+* [Media](doc/controllers/media.md)
+
+## Classes Documentation
+
+* [Utility Classes](doc/utility-classes.md)
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+

data/lib/whats_app_cloud_api/api_helper.rb

@@ -0,0 +1,277 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # API utility class
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs).
+    # @param [String] The name of the parameter.
+    # @param [Array] The value of the parameter.
+    # @param [String] The format of the serialization.
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      tuples += case formatting
+                when 'csv'
+                  [[key, array.map { |element| CGI.escape(element.to_s) }.join(',')]]
+                when 'psv'
+                  [[key, array.map { |element| CGI.escape(element.to_s) }.join('|')]]
+                when 'tsv'
+                  [[key, array.map { |element| CGI.escape(element.to_s) }.join("\t")]]
+                else
+                  array.map { |element| [key, element] }
+                end
+      tuples
+    end
+
+    # Replaces template parameters in the given url.
+    # @param [String] The query string builder to replace the template
+    # parameters.
+    # @param [Hash] The parameters to replace in the url.
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\" is
+          invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, val|
+        if val.nil?
+          replace_value = ''
+        elsif val['value'].instance_of? Array
+          if val['encode'] == true
+            val['value'].map! { |element| CGI.escape(element.to_s) }
+          else
+            val['value'].map!(&:to_s)
+          end
+          replace_value = val['value'].join('/')
+        else
+          replace_value = if val['encode'] == true
+                            CGI.escape(val['value'].to_s)
+                          else
+                            val['value'].to_s
+                          end
+        end
+
+        # Find the template parameter and replace it with its value.
+        query_builder = query_builder.gsub("{#{key}}", replace_value)
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string.
+    # @param [String] The query string builder to add the query parameters to.
+    # @param [Hash] The parameters to append.
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # Perform parameter validation.
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\"
+          is invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      array_serialization = 'indexed'
+      parameters = process_complex_types_parameters(parameters, array_serialization)
+
+      parameters.each do |key, value|
+        seperator = query_builder.include?('?') ? '&' : '?'
+        unless value.nil?
+          if value.instance_of? Array
+            value.compact!
+            APIHelper.serialize_array(
+              key, value, formatting: array_serialization
+            ).each do |element|
+              seperator = query_builder.include?('?') ? '&' : '?'
+              query_builder += "#{seperator}#{element[0]}=#{element[1]}"
+            end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url.
+    # @param [String] The given Url to process.
+    # @return [String] Pre-processed Url as string.
+    def self.clean_url(url)
+      # Perform parameter validation.
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # Ensure that the urls are absolute.
+      matches = url.match(%r{^(https?://[^/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # Get the http protocol match.
+      protocol = matches[1]
+
+      # Check if parameters exist.
+      index = url.index('?')
+
+      # Remove redundant forward slashes.
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{//+}, '/')
+
+      # Get the parameters.
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # Return processed url.
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      JSON.parse(json)
+    rescue StandardError
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      array_serialization = 'indexed'
+      encoded = {}
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode(value, key, formatting:
+          array_serialization))
+      end
+      encoded
+    end
+
+    # Process complex types in query_params.
+    # @param [Hash] The hash of query parameters.
+    # @return [Hash] A hash with the processed query parameters.
+    def self.process_complex_types_parameters(query_parameters, array_serialization)
+      processed_params = {}
+      query_parameters.each do |key, value|
+        processed_params.merge!(APIHelper.form_encode(value, key, formatting:
+          array_serialization))
+      end
+      processed_params
+    end
+
+    def self.custom_merge(a, b)
+      x = {}
+      a.each do |key, value_a|
+        b.each do |k, value_b|
+          next unless key == k
+
+          x[k] = []
+          if value_a.instance_of? Array
+            value_a.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_a)
+          end
+          if value_b.instance_of? Array
+            value_b.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_b)
+          end
+          a.delete(k)
+          b.delete(k)
+        end
+      end
+      x.merge!(a)
+      x.merge!(b)
+      x
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form
+    # of a hash.
+    def self.form_encode(obj, instance_name, formatting: 'indexed')
+      retval = {}
+
+      serializable_types = [String, Numeric, TrueClass,
+                            FalseClass, Date, DateTime]
+
+      # If this is a structure, resolve it's field names.
+      obj = obj.to_hash if obj.is_a? BaseModel
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      elsif obj.instance_of? Array
+        if formatting == 'indexed'
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
+          end
+        elsif serializable_types.map { |x| obj[0].is_a? x }.any?
+          obj.each do |value|
+            abc = if formatting == 'unindexed'
+                    APIHelper.form_encode(value, "#{instance_name}[]",
+                                          formatting: formatting)
+                  else
+                    APIHelper.form_encode(value, instance_name,
+                                          formatting: formatting)
+                  end
+            retval = APIHelper.custom_merge(retval, abc)
+          end
+        else
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]",
+                                                formatting: formatting))
+          end
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{key}]",
+                                              formatting: formatting))
+        end
+      elsif obj.instance_of? File
+        retval[instance_name] = UploadIO.new(
+          obj, 'application/octet-stream', File.basename(obj.path)
+        )
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+
+    # Retrieves a field from a Hash/Array based on an Array of keys/indexes
+    # @param [Hash, Array] The hash to extract data from
+    # @param [Array<String, Integer>] The keys/indexes to use
+    # @return [Object] The extracted value
+    def self.map_response(obj, keys)
+      val = obj
+      begin
+        keys.each do |key|
+          val = if val.is_a? Array
+                  if key.to_i.to_s == key
+                    val[key.to_i]
+                  else
+                    val = nil
+                  end
+                else
+                  val.fetch(key.to_sym)
+                end
+        end
+      rescue NoMethodError, TypeError, IndexError
+        val = nil
+      end
+      val
+    end
+  end
+end

data/lib/whats_app_cloud_api/client.rb

@@ -0,0 +1,68 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  #  whats_app_cloud_api client class.
+  class Client
+    attr_reader :config
+
+    # Access to business_profiles controller.
+    # @return [BusinessProfilesController] Returns the controller instance.
+    def business_profiles
+      @business_profiles ||= BusinessProfilesController.new config
+    end
+
+    # Access to messages controller.
+    # @return [MessagesController] Returns the controller instance.
+    def messages
+      @messages ||= MessagesController.new config
+    end
+
+    # Access to media controller.
+    # @return [MediaController] Returns the controller instance.
+    def media
+      @media ||= MediaController.new config
+    end
+
+    # Access to phone_numbers controller.
+    # @return [PhoneNumbersController] Returns the controller instance.
+    def phone_numbers
+      @phone_numbers ||= PhoneNumbersController.new config
+    end
+
+    # Access to registration controller.
+    # @return [RegistrationController] Returns the controller instance.
+    def registration
+      @registration ||= RegistrationController.new config
+    end
+
+    # Access to two_step_verification controller.
+    # @return [TwoStepVerificationController] Returns the controller instance.
+    def two_step_verification
+      @two_step_verification ||= TwoStepVerificationController.new config
+    end
+
+    def initialize(connection: nil, adapter: Faraday.default_adapter,
+                   timeout: 60, max_retries: 0, retry_interval: 1,
+                   backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put],
+                   environment: Environment::PRODUCTION, version: 'v13.0',
+                   access_token: '', config: nil)
+      @config = if config.nil?
+                  Configuration.new(connection: connection, adapter: adapter,
+                                    timeout: timeout, max_retries: max_retries,
+                                    retry_interval: retry_interval,
+                                    backoff_factor: backoff_factor,
+                                    retry_statuses: retry_statuses,
+                                    retry_methods: retry_methods,
+                                    environment: environment, version: version,
+                                    access_token: access_token)
+                else
+                  config
+                end
+    end
+  end
+end

data/lib/whats_app_cloud_api/configuration.rb

@@ -0,0 +1,132 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration
+    # The attribute readers for properties.
+    attr_reader :http_client, :connection, :adapter, :timeout, :max_retries, :retry_interval,
+                :backoff_factor, :retry_statuses, :retry_methods, :environment, :version,
+                :access_token
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(connection: nil, adapter: Faraday.default_adapter,
+                   timeout: 60, max_retries: 0, retry_interval: 1,
+                   backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put],
+                   environment: Environment::PRODUCTION, version: 'v13.0',
+                   access_token: '')
+      # The Faraday connection object passed by the SDK user for making requests
+      @connection = connection
+
+      # The Faraday adapter object passed by the SDK user for performing http requests
+      @adapter = adapter
+
+      # The value to use for connection timeout
+      @timeout = timeout
+
+      # The number of times to retry an endpoint call if it fails
+      @max_retries = max_retries
+
+      # Pause in seconds between retries
+      @retry_interval = retry_interval
+
+      # The amount to multiply each successive retry's interval amount
+      # by in order to provide backoff
+      @backoff_factor = backoff_factor
+
+      # A list of HTTP statuses to retry
+      @retry_statuses = retry_statuses
+
+      # A list of HTTP methods to retry
+      @retry_methods = retry_methods
+
+      # Current API environment
+      @environment = String(environment)
+
+      # version value
+      @version = version
+
+      # The OAuth 2.0 Access Token to use for API requests.
+      @access_token = access_token
+
+      # The Http Client to use for making requests.
+      @http_client = create_http_client
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, environment: nil,
+                   version: nil, access_token: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      environment ||= self.environment
+      version ||= self.version
+      access_token ||= self.access_token
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods, environment: environment,
+                        version: version, access_token: access_token)
+    end
+
+    def create_http_client
+      FaradayClient.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods, connection: connection,
+                        adapter: adapter)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://graph.facebook.com/{Version}'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'Version' => { 'value' => version, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+  end
+end

data/lib/whats_app_cloud_api/controllers/base_controller.rb

@@ -0,0 +1,52 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => get_user_agent
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back&.on_before_request(request)
+
+      APIHelper.clean_hash(request.headers)
+      request.headers.merge!(@global_headers)
+
+      response = if binary
+                   config.http_client.execute_as_binary(request)
+                 else
+                   config.http_client.execute_as_string(request)
+                 end
+      @http_call_back&.on_after_response(response)
+
+      response
+    end
+
+    def validate_response(response)
+      raise APIException.new 'HTTP Response Not OK', response unless
+        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+
+    def get_user_agent
+      user_agent = 'APIMATIC 3.0'
+      user_agent
+    end
+  end
+end