whatsapp_sdk 0.1.0 → 0.3.1

data/lib/whatsapp_sdk/api/client.rb

@@ -6,25 +6,45 @@ require "oj"
 module WhatsappSdk
   module Api
     class Client
-      API_VERSION = "v13.0"
+      API_VERSION = "v14.0"
       API_CLIENT = "https://graph.facebook.com/#{API_VERSION}/"
 
       def initialize(access_token)
         @access_token = access_token
       end
 
-      def client
-        @client ||= ::Faraday.new(API_CLIENT) do |client|
+      def send_request(endpoint: "", full_url: nil, http_method: "post", params: {})
+        url = full_url || API_CLIENT
+
+        response = faraday(url).public_send(http_method, endpoint, params)
+        Oj.load(response.body)
+      end
+
+      def download_file(url, path_to_file_name = nil)
+        uri = URI.parse(url)
+        request = Net::HTTP::Get.new(uri)
+        request["Authorization"] = "Bearer #{@access_token}"
+        req_options = { use_ssl: uri.scheme == "https" }
+
+        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+          http.request(request)
+        end
+
+        File.write(path_to_file_name, response.body) if response.code == "200" && path_to_file_name
+
+        response
+      end
+
+      private
+
+      def faraday(url)
+        ::Faraday.new(url) do |client|
+          client.request :multipart
           client.request :url_encoded
           client.adapter ::Faraday.default_adapter
           client.headers['Authorization'] = "Bearer #{@access_token}" unless @access_token.nil?
         end
       end
-
-      def send_request(endpoint:, http_method: "post", params: {})
-        response = client.public_send(http_method, endpoint, params)
-        Oj.load(response.body)
-      end
     end
   end
 end

data/lib/whatsapp_sdk/api/medias.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+
+require_relative "request"
+require_relative "response"
+require_relative '../../../lib/whatsapp_sdk/api/responses/media_data_response'
+require_relative '../../../lib/whatsapp_sdk/api/responses/success_response'
+
+module WhatsappSdk
+  module Api
+    class Medias < Request
+      class FileNotFoundError < StandardError
+        attr_reader :file_path
+
+        def initialize(file_path)
+          @file_path = file_path
+          super("Couldn't find file_path: #{file_path}")
+        end
+      end
+
+      # Get Media by ID.
+      #
+      # @param media_id [Integer] Media Id.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def media(media_id:)
+        response = send_request(
+          http_method: "get",
+          endpoint: "/#{media_id}"
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MediaDataResponse
+        )
+      end
+
+      # Download Media by URL.
+      #
+      # @param media_id [Integer] Media Id.
+      # @param file_path [String] The file_path to download the media e.g. "tmp/downloaded_image.png".
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def download(url:, file_path:)
+        response = download_file(url, file_path)
+
+        response = if response.code.to_i == 200
+                     { "success" => true }
+                   else
+                     { "error" => true, "status" => response.code }
+                   end
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse,
+          error_class_type: WhatsappSdk::Api::Responses::ErrorResponse
+        )
+      end
+
+      # Upload a media.
+      # @param sender_id [Integer] Sender' phone number.
+      # @param file_path [String] Path to the file stored in your local directory. For example: "tmp/whatsapp.png".
+      # @param type [String] Media type e.g. text/plain, video/3gp, image/jpeg, image/png. For more information,
+      # see the official documentation https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types.
+      #
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def upload(sender_id:, file_path:, type:)
+        raise FileNotFoundError, file_path unless File.file?(file_path)
+
+        params = {
+          messaging_product: "whatsapp",
+          file: Faraday::FilePart.new(file_path, type),
+          type: type
+        }
+
+        response = send_request(http_method: "post", endpoint: "#{sender_id}/media", params: params)
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MediaDataResponse
+        )
+      end
+
+      # Delete a Media by ID.
+      #
+      # @param media_id [Integer] Media Id.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def delete(media_id:)
+        response = send_request(
+          http_method: "delete",
+          endpoint: "/#{media_id}"
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse
+        )
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/messages.rb

@@ -27,7 +27,7 @@ module WhatsappSdk
           to: recipient_number,
           recipient_type: "individual",
           type: "text",
-          "text": { body: message }
+          text: { body: message }
         }
 
         response = send_request(
@@ -35,7 +35,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send location.
@@ -53,11 +56,11 @@ module WhatsappSdk
           to: recipient_number,
           recipient_type: "individual",
           type: "location",
-          "location": {
-            "longitude": longitude,
-            "latitude": latitude,
-            "name": name,
-            "address": address
+          location: {
+            longitude: longitude,
+            latitude: latitude,
+            name: name,
+            address: address
           }
         }
 
@@ -66,7 +69,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send an image.
@@ -97,7 +103,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send an audio.
@@ -123,7 +132,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send a video.
@@ -154,7 +166,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send a document.
@@ -185,7 +200,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send a document.
@@ -210,7 +228,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       # Send contacts.
@@ -235,7 +256,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       def send_interactive_button
@@ -269,7 +293,7 @@ module WhatsappSdk
 
         WhatsappSdk::Api::Response.new(
           response: response,
-          class_type: WhatsappSdk::Api::Responses::ReadMessageDataResponse
+          data_class_type: WhatsappSdk::Api::Responses::ReadMessageDataResponse
         )
       end
 
@@ -309,7 +333,7 @@ module WhatsappSdk
 
         WhatsappSdk::Api::Response.new(
           response: response,
-          class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
         )
       end
 

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -16,8 +16,10 @@ module WhatsappSdk
           endpoint: "#{business_id}/phone_numbers"
         )
 
-        WhatsappSdk::Api::Response.new(response: response,
-                                       class_type: WhatsappSdk::Api::Responses::PhoneNumbersDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumbersDataResponse
+        )
       end
 
       # Get the registered number id.
@@ -30,8 +32,10 @@ module WhatsappSdk
           endpoint: phone_number_id.to_s
         )
 
-        WhatsappSdk::Api::Response.new(response: response,
-                                       class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse
+        )
       end
     end
   end

data/lib/whatsapp_sdk/api/request.rb

@@ -3,15 +3,21 @@
 module WhatsappSdk
   module Api
     class Request
-      API_VERSION = "v13.0"
+      API_VERSION = "v14.0"
       API_CLIENT = "https://graph.facebook.com/#{API_VERSION}/"
 
-      def initialize(client)
+      def initialize(client = WhatsappSdk.configuration.client)
         @client = client
       end
 
-      def send_request(endpoint:, http_method: "post", params: {})
-        @client.send_request(http_method: http_method, endpoint: endpoint, params: params)
+      def download_file(url, path_to_file_name = nil)
+        @client.download_file(url, path_to_file_name)
+      end
+
+      def send_request(endpoint: nil, full_url: nil, http_method: "post", params: {})
+        @client.send_request(
+          http_method: http_method, full_url: full_url, endpoint: endpoint, params: params
+        )
       end
     end
   end

data/lib/whatsapp_sdk/api/response.rb

@@ -4,31 +4,24 @@ require_relative "responses/message_data_response"
 require_relative "responses/phone_number_data_response"
 require_relative "responses/phone_numbers_data_response"
 require_relative "responses/read_message_data_response"
-require_relative "responses/error_response"
+require_relative "responses/message_error_response"
 
 module WhatsappSdk
   module Api
     class Response
       attr_accessor :error, :data
 
-      CLASS_TYPE = {
-        message_data_response: Responses::MessageDataResponse,
-        phone_number_data_response: Responses::PhoneNumberDataResponse,
-        phone_numbers_data_response: Responses::PhoneNumbersDataResponse,
-        read_message_data_response: Responses::ReadMessageDataResponse
-      }.freeze
-
-      def initialize(response:, class_type:)
-        @data = class_type.build_from_response(response: response)
-        @error = Responses::ErrorResponse.build_from_response(response: response)
+      def initialize(response:, data_class_type:, error_class_type: Responses::MessageErrorResponse)
+        @data = data_class_type.build_from_response(response: response)
+        @error = error_class_type.build_from_response(response: response)
       end
 
-      # Whether or not the response is successful.
+      # @return [Boolean] Whether or not the response is successful.
       def ok?
         @error.nil?
       end
 
-      # Whether or not the response has an error.
+      # @return [Boolean] Whether or not the response has an error.
       def error?
         !!@error
       end

data/lib/whatsapp_sdk/api/responses/error_response.rb

@@ -1,32 +1,23 @@
 # frozen_string_literal: true
 
+require_relative "data_response"
+
 module WhatsappSdk
   module Api
     module Responses
-      class ErrorResponse
-        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
+      class ErrorResponse < DataResponse
+        attr_accessor :error, :status
 
-        def initialize(code:, subcode:, message:, type:, data:, fbtrace_id:)
-          @code = code
-          @subcode = subcode
-          @message = message
-          @type = type
-          @data = data
-          @fbtrace_id = fbtrace_id
+        def initialize(response:)
+          @error = response["error"]
+          @status = response["status"]
+          super(response)
         end
 
         def self.build_from_response(response:)
-          error_response = response["error"]
-          return unless error_response
+          return unless response["error"]
 
-          new(
-            code: error_response["code"],
-            subcode: error_response["error_subcode"],
-            message: error_response["message"],
-            type: error_response["type"],
-            data: error_response["data"],
-            fbtrace_id: error_response["fbtrace_id"]
-          )
+          new(response: response)
         end
       end
     end

data/lib/whatsapp_sdk/api/responses/media_data_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MediaDataResponse < DataResponse
+        attr_accessor :id, :url, :mime_type, :sha256, :file_size, :messaging_product
+
+        def initialize(response)
+          @id = response["id"]
+          @messaging_product = response["messaging_product"]
+          @url = response["url"]
+          @mime_type = response["mime_type"]
+          @sha256 = response["sha256"]
+          @file_size = response["file_size"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return unless response["id"]
+
+          new(response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/message_error_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "error_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MessageErrorResponse < ErrorResponse
+        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
+
+        def initialize(response:)
+          @code = response["code"]
+          @subcode = response["error_subcode"]
+          @message = response["message"]
+          @type = response["type"]
+          @data = response["data"]
+          @fbtrace_id = response["fbtrace_id"]
+          super(response: response)
+        end
+
+        def self.build_from_response(response:)
+          error_response = response["error"]
+          return unless error_response
+
+          new(response: error_response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/read_message_data_response.rb

@@ -9,10 +9,10 @@ module WhatsappSdk
   module Api
     module Responses
       class ReadMessageDataResponse < DataResponse
-        attr_reader :sucess
+        attr_reader :success
 
         def initialize(response:)
-          @sucess = response["sucess"]
+          @success = response["success"]
           super(response)
         end
 

data/lib/whatsapp_sdk/api/responses/success_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class SuccessResponse < DataResponse
+        def initialize(response:)
+          @success = response["success"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return unless response["success"]
+
+          new(response: response)
+        end
+
+        def success?
+          @success
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  # This module allows client instantiating the client as a singleton like the following example:
+  # WhatsappSdk.configure do |config|
+  #   config.access_token = ACCESS_TOKEN
+  # end
+  #
+  # The gem have access to the client through WhatsappSdk.configuration.client
+  class Configuration
+    attr_accessor :access_token
+
+    def initialize(access_token = nil)
+      @access_token = access_token
+    end
+
+    def client
+      return unless access_token
+
+      WhatsappSdk::Api::Client.new(access_token)
+    end
+  end
+end

data/lib/whatsapp_sdk.rb

@@ -1,31 +1,17 @@
 # frozen_string_literal: true
 
-# APIs
-require_relative "whatsapp_sdk/api/phone_numbers"
-require_relative "whatsapp_sdk/api/messages"
-require_relative "whatsapp_sdk/api/client"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
 
-# APIs responses
-require_relative "whatsapp_sdk/api/responses/message_data_response"
-require_relative "whatsapp_sdk/api/responses/phone_number_data_response"
-require_relative "whatsapp_sdk/api/responses/phone_numbers_data_response"
-require_relative "whatsapp_sdk/api/responses/error_response"
-require_relative "whatsapp_sdk/api/responses/data_response"
-require_relative "whatsapp_sdk/api/responses/read_message_data_response"
+module WhatsappSdk
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-# Resources
-require_relative "whatsapp_sdk/resource/address"
-require_relative "whatsapp_sdk/resource/button_parameter"
-require_relative "whatsapp_sdk/resource/component"
-require_relative "whatsapp_sdk/resource/contact_response"
-require_relative "whatsapp_sdk/resource/contact"
-require_relative "whatsapp_sdk/resource/currency"
-require_relative "whatsapp_sdk/resource/date_time"
-require_relative "whatsapp_sdk/resource/email"
-require_relative "whatsapp_sdk/resource/media"
-require_relative "whatsapp_sdk/resource/message"
-require_relative "whatsapp_sdk/resource/name"
-require_relative "whatsapp_sdk/resource/org"
-require_relative "whatsapp_sdk/resource/parameter_object"
-require_relative "whatsapp_sdk/resource/phone_number"
-require_relative "whatsapp_sdk/resource/url"
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/whatsapp_sdk.gemspec

@@ -9,10 +9,12 @@ Gem::Specification.new do |spec|
   spec.version = WhatsappSdk::VERSION
   spec.authors       = ["ignacio-chiazzo"]
   spec.email         = ["ignaciochiazzo@gmail.com"]
-
-  spec.summary       = "Use the Whatsapp SDK to comunicate with Whatsapp API"
-  spec.description   = "Ruby Whatsapp SDK. Use the Whatsapp API through this library"
-  spec.homepage      = "https://github.com/ignacio-chiazzo/whatsapp_sdk"
+  spec.summary       = "Use the Ruby Whatsapp SDK to comunicate with Whatsapp API using the Cloud API"
+  spec.description   = <<-DESCRIPTION
+    Use the Ruby Whatsapp SDK to comunicate with Whatsapp API using the Cloud API.
+    Create bots to send and receive messages using the Whatsapp SDK in a few minutes.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk"
   spec.license       = "MIT"
   spec.required_ruby_version = '>= 1.8.6'
 
@@ -20,11 +22,11 @@ Gem::Specification.new do |spec|
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/ignacio-chiazzo/whatsapp_sdk"
-    spec.metadata["changelog_uri"] = "https://github.com/ignacio-chiazzo/whatsapp_sdk/blob/main/CHANGELOG.md"
+    spec.metadata["source_code_uri"] = "https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk"
+    spec.metadata["changelog_uri"] = "https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/blob/main/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+          "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -38,8 +40,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
 
   spec.add_dependency("faraday",  "~> 2.3.0")
+  spec.add_dependency("faraday-multipart", "~> 1.0.4")
   spec.add_dependency("oj", "~> 3.13.13")
+  spec.add_dependency("zeitwerk", "~> 2.6.0")
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end