whatsapp_sdk 0.13.0 → 1.0.0

data/lib/whatsapp_sdk/api/templates.rb

@@ -1,12 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "request"
-require_relative "response"
-require_relative 'responses/success_response'
-require_relative 'responses/message_template_namespace_data_response'
-require_relative 'responses/generic_error_response'
-require_relative 'responses/template_data_response'
-require_relative 'responses/templates_data_response'
 require_relative "../resource/languages"
 
 module WhatsappSdk
@@ -36,7 +30,7 @@ module WhatsappSdk
       # @param allow_category_change [Boolean] Optional Allow category change.
       # Set to true to allow us to assign a category based on the template guidelines and the template's contents.
       #   This can prevent your template from being rejected for miscategorization.
-      # @return [Response] Response object.
+      # @return [Template] Template object.
       def create(
         business_id:, name:, category:, language:, components_json: nil, allow_category_change: nil
       )
@@ -63,19 +57,15 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::TemplateDataResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        Resource::Template.from_hash(response)
       end
 
       # Get templates
       #
       # @param business_id [Integer] The business ID.
       # @param limit [Integer] Optional. Number of templates to return in a single page.
-      # @return [Response] Response object.
-      def templates(business_id:, limit: 100)
+      # @return [Template] Pagination Record containing an array of Template objects.
+      def list(business_id:, limit: 100)
         params = {}
         params["limit"] = limit if limit
 
@@ -85,18 +75,23 @@ module WhatsappSdk
           params: params
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::TemplatesDataResponse,
-          error_class_type: Responses::GenericErrorResponse
+        Api::Responses::PaginationRecords.new(
+          records: parse_templates(response['data']),
+          before: response['paging']['cursors']['before'],
+          after: response['paging']['cursors']['after']
         )
       end
 
+      def templates(business_id:)
+        warn "[DEPRECATION] `templates` is deprecated. Please use `list` instead."
+        list(business_id: business_id)
+      end
+
       # Get Message Template Namespace
       # The message template namespace is required to send messages using the message templates.
       #
       # @param business_id [Integer] The business ID.
-      # @return [Response] Response object.
+      # @return [MessageTemplateNamespace] MessageTemplateNamespace object.
       def get_message_template_namespace(business_id:)
         response = send_request(
           endpoint: business_id.to_s,
@@ -104,11 +99,7 @@ module WhatsappSdk
           params: { "fields" => "message_template_namespace" }
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::MessageTemplateNamespaceDataResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        WhatsappSdk::Resource::MessageTemplateNamespace.from_hash(response)
       end
 
       # Edit Template
@@ -120,7 +111,7 @@ module WhatsappSdk
       #
       # @param id [String] Required. The message_template-id.
       # @param components_json [Json] Components that make up the template..
-      # return [Response] Response object.
+      # @return [Boolean] Whether the update was successful.
       def update(template_id:, category: nil, components_json: nil)
         if category && !WhatsappSdk::Resource::Template::Category.valid?(category)
           raise InvalidCategoryError.new(category: category)
@@ -137,11 +128,7 @@ module WhatsappSdk
           headers: { "Content-Type" => "application/json" }
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::SuccessResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
       end
 
       # Delete Template
@@ -155,7 +142,7 @@ module WhatsappSdk
       # @param name [String] Required. The template's name.
       # @param hsm_id [String] Optional. The template's id.
       #
-      # @return [Response] Response object.
+      # @return [Boolean] Whether the deletion was successful.
       def delete(business_id:, name:, hsm_id: nil)
         params = { name: name }
         params[:hsm_id] = hsm_id if hsm_id
@@ -166,11 +153,15 @@ module WhatsappSdk
           params: params
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::SuccessResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
+      end
+
+      private
+
+      def parse_templates(templates_data)
+        templates_data.map do |template|
+          Resource::Template.from_hash(template)
+        end
       end
     end
   end

data/lib/whatsapp_sdk/resource/business_profile.rb

@@ -7,6 +7,34 @@ module WhatsappSdk
         UNDEFINED OTHER AUTO BEAUTY APPAREL EDU ENTERTAIN EVENT_PLAN FINANCE GROCERY
         GOVT HOTEL HEALTH NONPROFIT PROF_SERVICES RETAIL TRAVEL RESTAURANT NOT_A_BIZ
       ].freeze
+
+      attr_accessor :about, :address, :description, :email, :messaging_product,
+                    :profile_picture_url, :vertical, :websites
+
+      def self.from_hash(hash)
+        business_profile = BusinessProfile.new
+        business_profile.about = hash["about"]
+        business_profile.address = hash["address"]
+        business_profile.description = hash["description"]
+        business_profile.email = hash["email"]
+        business_profile.messaging_product = hash["messaging_product"]
+        business_profile.profile_picture_url = hash["profile_picture_url"]
+        business_profile.vertical = hash["vertical"]
+        business_profile.websites = hash["websites"]
+
+        business_profile
+      end
+
+      def ==(other)
+        about == other.about &&
+          address == other.address &&
+          description == other.description &&
+          email == other.email &&
+          messaging_product == other.messaging_product &&
+          profile_picture_url == other.profile_picture_url &&
+          vertical == other.vertical &&
+          websites == other.websites
+      end
     end
   end
 end

data/lib/whatsapp_sdk/resource/errors.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "error"
+
 module WhatsappSdk
   module Resource
     module Errors

data/lib/whatsapp_sdk/resource/media.rb

@@ -3,21 +3,6 @@
 module WhatsappSdk
   module Resource
     class Media
-      class InvalidMedia < StandardError
-        attr_reader :field, :message
-
-        def initialize(field, message)
-          @field = field
-          @message = message
-          super(message)
-        end
-      end
-
-      # Returns media id.
-      #
-      # @returns id [String].
-      attr_accessor :id
-
       module Type
         AUDIO = 'audio'
         DOCUMENT = 'document'
@@ -26,61 +11,26 @@ module WhatsappSdk
         STICKER = 'sticker'
       end
 
-      # @returns type [String]. Valid options ar audio, document, image, video and sticker.
-      attr_accessor :type
-
-      # The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.
-      # Do not use this field when the message type is set to text.
-      #
-      # @returns link [String].
-      attr_accessor :link
-
-      # Describes the specified document or image media.
-      #
-      # @returns caption [String].
-      attr_accessor :caption
-
-      # Describes the filename for the specific document. Use only with document media.
-      #
-      # @returns filename [String].
-      attr_accessor :filename
-
-      def initialize(type:, id: nil, link: nil, caption: nil, filename: nil)
-        @type = type
-        @id = id
-        @link = link
-        @caption = caption
-        @filename = filename
-        validate_media
-      end
-
-      def to_json
-        json = {}
-        json[:id] = id unless id.nil?
-        json[:link] = link unless link.nil?
-        json[:caption] = caption unless caption.nil?
-        json[:filename] = filename unless filename.nil?
-        json
-      end
-
-      private
-
-      def validate_media
-        raise InvalidMedia.new(:filename, "filename can only be used with document") if filename && !supports_filename?
-
-        if caption && !supports_caption?
-          raise InvalidMedia.new(:caption, "caption can only be used with document or image")
-        end
-
-        true
-      end
-
-      def supports_filename?
-        type == Type::DOCUMENT
+      attr_accessor :file_size, :id, :messaging_product, :mime_type, :sha256, :url
+
+      def self.from_hash(hash)
+        media = new
+        media.id = hash["id"]
+        media.file_size = hash["file_size"]
+        media.messaging_product = hash["messaging_product"]
+        media.mime_type = hash["mime_type"]
+        media.sha256 = hash["sha256"]
+        media.url = hash["url"]
+        media
       end
 
-      def supports_caption?
-        type == Type::DOCUMENT || type == Type::IMAGE
+      def ==(other)
+        id == other.id &&
+          file_size == other.file_size &&
+          messaging_product == other.messaging_product &&
+          mime_type == other.mime_type &&
+          sha256 == other.sha256 &&
+          url == other.url
       end
     end
   end

data/lib/whatsapp_sdk/resource/media_component.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# The media used by a component (button, header, body, footer) etc.
+
+module WhatsappSdk
+  module Resource
+    class MediaComponent
+      class InvalidMedia < StandardError
+        attr_reader :field, :message
+
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      # Returns media id.
+      #
+      # @returns id [String].
+      attr_accessor :id
+
+      module Type
+        AUDIO = 'audio'
+        DOCUMENT = 'document'
+        IMAGE = 'image'
+        VIDEO = 'video'
+        STICKER = 'sticker'
+      end
+
+      # @returns type [String]. Valid options ar audio, document, image, video and sticker.
+      attr_accessor :type
+
+      # The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.
+      # Do not use this field when the message type is set to text.
+      #
+      # @returns link [String].
+      attr_accessor :link
+
+      # Describes the specified document or image media.
+      #
+      # @returns caption [String].
+      attr_accessor :caption
+
+      # Describes the filename for the specific document. Use only with document media.
+      #
+      # @returns filename [String].
+      attr_accessor :filename
+
+      def initialize(type:, id: nil, link: nil, caption: nil, filename: nil)
+        @type = type
+        @id = id
+        @link = link
+        @caption = caption
+        @filename = filename
+        validate_media
+      end
+
+      def to_json
+        json = {}
+        json[:id] = id unless id.nil?
+        json[:link] = link unless link.nil?
+        json[:caption] = caption unless caption.nil?
+        json[:filename] = filename unless filename.nil?
+        json
+      end
+
+      private
+
+      def validate_media
+        raise InvalidMedia.new(:filename, "filename can only be used with document") if filename && !supports_filename?
+
+        if caption && !supports_caption?
+          raise InvalidMedia.new(:caption, "caption can only be used with document or image")
+        end
+
+        true
+      end
+
+      def supports_filename?
+        type == Type::DOCUMENT
+      end
+
+      def supports_caption?
+        type == Type::DOCUMENT || type == Type::IMAGE
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/message_template_namespace.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class MessageTemplateNamespace
+      attr_accessor :id, :message_template_namespace
+
+      def self.from_hash(hash)
+        message_template_namespace = new
+        message_template_namespace.id = hash["id"]
+        message_template_namespace.message_template_namespace = hash["message_template_namespace"]
+
+        message_template_namespace
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/phone_number.rb

@@ -3,21 +3,51 @@
 module WhatsappSdk
   module Resource
     class PhoneNumber
-      attr_accessor :phone, :wa_id, :type
+      attr_accessor :id, :verified_name, :display_phone_number, :quality_rating, :is_pin_enabled,
+                    :is_official_business_account, :account_mode, :certificate, :code_verification_status,
+                    :eligibility_for_api_business_global_search, :name_status, :new_name_status, :status,
+                    :search_visibility, :messaging_limit_tier # , :phone, :wa_id, :type
 
-      def initialize(phone:, type:, wa_id:)
-        @phone = phone
-        @type = type
-        @wa_id = wa_id
+      def self.from_hash(hash)
+        phone_number = PhoneNumber.new
+        phone_number.id = hash["id"]
+        phone_number.verified_name = hash["verified_name"]
+        phone_number.display_phone_number = hash["display_phone_number"]
+        phone_number.quality_rating = hash["quality_rating"]
+        phone_number.is_pin_enabled = hash["is_pin_enabled"]
+        phone_number.is_official_business_account = hash["is_official_business_account"]
+        phone_number.account_mode = hash["account_mode"]
+        phone_number.certificate = hash["certificate"]
+        phone_number.code_verification_status = hash["code_verification_status"]
+        phone_number.eligibility_for_api_business_global_search = hash["eligibility_for_api_business_global_search"]
+        phone_number.name_status = hash["name_status"]
+        phone_number.new_name_status = hash["new_name_status"]
+        phone_number.status = hash["status"]
+        phone_number.search_visibility = hash["search_visibility"]
+        phone_number.messaging_limit_tier = hash["messaging_limit_tier"]
+
+        phone_number
       end
 
-      def to_h
-        {
-          phone: @phone,
-          type: @type,
-          wa_id: @wa_id
-        }
+      # rubocop:disable Metrics/PerceivedComplexity
+      def ==(other)
+        id == other.id &&
+          verified_name == other.verified_name &&
+          display_phone_number == other.display_phone_number &&
+          quality_rating == other.quality_rating &&
+          is_pin_enabled == other.is_pin_enabled &&
+          is_official_business_account == other.is_official_business_account &&
+          account_mode == other.account_mode &&
+          certificate == other.certificate &&
+          code_verification_status == other.code_verification_status &&
+          eligibility_for_api_business_global_search == other.eligibility_for_api_business_global_search &&
+          name_status == other.name_status &&
+          new_name_status == other.new_name_status &&
+          status == other.status &&
+          search_visibility == other.search_visibility &&
+          messaging_limit_tier == other.messaging_limit_tier
       end
+      # rubocop:enable Metrics/PerceivedComplexity
     end
   end
 end

data/lib/whatsapp_sdk/resource/phone_number_component.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# The media used by a component (button, header, body, footer) etc.
+
+module WhatsappSdk
+  module Resource
+    class PhoneNumberComponent
+      attr_accessor :phone, :wa_id, :type
+
+      def initialize(phone:, type:, wa_id:)
+        @phone = phone
+        @type = type
+        @wa_id = wa_id
+      end
+
+      def to_h
+        {
+          phone: @phone,
+          type: @type,
+          wa_id: @wa_id
+        }
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/template.rb

@@ -46,6 +46,26 @@ module WhatsappSdk
         @name = name
         @components_json = components_json
       end
+
+      def self.from_hash(hash)
+        new(
+          id: hash["id"],
+          status: hash["status"],
+          category: hash["category"],
+          language: hash["language"],
+          name: hash["name"],
+          components_json: hash["components"]
+        )
+      end
+
+      def ==(other)
+        id == other.id &&
+          status == other.status &&
+          category == other.category &&
+          language == other.language &&
+          name == other.name &&
+          components_json == other.components_json
+      end
     end
   end
 end

data/lib/whatsapp_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhatsappSdk
-  VERSION = "0.13.0"
+  VERSION = "1.0.0"
 end

data/whatsapp_sdk.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   DESCRIPTION
   spec.homepage      = "https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk"
   spec.license       = "MIT"
-  spec.required_ruby_version = '>= 1.8.6'
+  spec.required_ruby_version = '>= 2.7.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".cursorrules"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/codeql-analysis.yml"
@@ -133,21 +134,12 @@ files:
 - lib/whatsapp_sdk/api/messages.rb
 - lib/whatsapp_sdk/api/phone_numbers.rb
 - lib/whatsapp_sdk/api/request.rb
-- lib/whatsapp_sdk/api/response.rb
-- lib/whatsapp_sdk/api/responses/business_profile_data_response.rb
-- lib/whatsapp_sdk/api/responses/data_response.rb
-- lib/whatsapp_sdk/api/responses/error_response.rb
 - lib/whatsapp_sdk/api/responses/generic_error_response.rb
-- lib/whatsapp_sdk/api/responses/media_data_response.rb
+- lib/whatsapp_sdk/api/responses/http_response_error.rb
+- lib/whatsapp_sdk/api/responses/id_response.rb
 - lib/whatsapp_sdk/api/responses/message_data_response.rb
-- lib/whatsapp_sdk/api/responses/message_error_response.rb
-- lib/whatsapp_sdk/api/responses/message_template_namespace_data_response.rb
-- lib/whatsapp_sdk/api/responses/phone_number_data_response.rb
-- lib/whatsapp_sdk/api/responses/phone_numbers_data_response.rb
-- lib/whatsapp_sdk/api/responses/read_message_data_response.rb
+- lib/whatsapp_sdk/api/responses/pagination_records.rb
 - lib/whatsapp_sdk/api/responses/success_response.rb
-- lib/whatsapp_sdk/api/responses/template_data_response.rb
-- lib/whatsapp_sdk/api/responses/templates_data_response.rb
 - lib/whatsapp_sdk/api/templates.rb
 - lib/whatsapp_sdk/configuration.rb
 - lib/whatsapp_sdk/error.rb
@@ -173,12 +165,15 @@ files:
 - lib/whatsapp_sdk/resource/languages.rb
 - lib/whatsapp_sdk/resource/location.rb
 - lib/whatsapp_sdk/resource/media.rb
+- lib/whatsapp_sdk/resource/media_component.rb
 - lib/whatsapp_sdk/resource/media_types.rb
 - lib/whatsapp_sdk/resource/message.rb
+- lib/whatsapp_sdk/resource/message_template_namespace.rb
 - lib/whatsapp_sdk/resource/name.rb
 - lib/whatsapp_sdk/resource/org.rb
 - lib/whatsapp_sdk/resource/parameter_object.rb
 - lib/whatsapp_sdk/resource/phone_number.rb
+- lib/whatsapp_sdk/resource/phone_number_component.rb
 - lib/whatsapp_sdk/resource/template.rb
 - lib/whatsapp_sdk/resource/url.rb
 - lib/whatsapp_sdk/version.rb
@@ -200,7 +195,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.6
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/whatsapp_sdk/api/response.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-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/message_error_response"
-require_relative "responses/business_profile_data_response"
-
-module WhatsappSdk
-  module Api
-    class Response
-      attr_accessor :error, :data, :raw_response
-
-      def initialize(response:, data_class_type:, error_class_type: Responses::MessageErrorResponse)
-        @raw_response = response
-        @data = data_class_type.build_from_response(response: response)
-        @error = error_class_type.build_from_response(response: response)
-      end
-
-      # @return [Boolean] Whether or not the response is successful.
-      def ok?
-        @error.nil?
-      end
-
-      # @return [Boolean] Whether or not the response has an error.
-      def error?
-        !!@error
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "data_response"
-
-module WhatsappSdk
-  module Api
-    module Responses
-      class BusinessProfileDataResponse < DataResponse
-        attr_accessor :about, :address, :description, :email, :messaging_product,
-                      :profile_picture_url, :vertical, :websites
-
-        def initialize(response)
-          @about = response["data"][0]["about"]
-          @address = response["data"][0]["address"]
-          @description = response["data"][0]["description"]
-          @email = response["data"][0]["email"]
-          @messaging_product = response["data"][0]["messaging_product"]
-          @profile_picture_url = response["data"][0]["profile_picture_url"]
-          @vertical = response["data"][0]["vertical"]
-          @websites = response["data"][0]["websites"]
-
-          super(response)
-        end
-
-        def self.build_from_response(response:)
-          return nil if response['error']
-
-          new(response)
-        end
-      end
-    end
-  end
-end