whatsapp_sdk 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f391a609a7230a7772cf0328b570c84be187ce2c94d5f9858cb7fe3776798e4
-  data.tar.gz: 393eebc7cbb96780d02329f9f167b4c1c904bf1e900b9bf31baef72ef2ea4de8
+  metadata.gz: 78aea6934c0189c059dbce4818236b2299319a19b41e8c5ca7d0eca21e8facd3
+  data.tar.gz: 1afd90036deb2f2f2010e2925c09f440215f5bad874d1b0038f4f65f110e1002
 SHA512:
-  metadata.gz: 96005fff84e2b54ae069ebc7dd49e3dcce72ce58f7269a5d20f8a9f25b29ba6fab6e42d2a1fbf33b0c8eb02b9e66663fcf8d441d86557cf5a21032906936e80c
-  data.tar.gz: c17e00d76ca9a9bd3d9348ae95bea014241dccd101c4f224a0844f85b28c8f7d80223aac542997b006515fb8bfb90a00aa4d4ca4a6479ac74253b28cff46ed01
+  metadata.gz: fcf1df484e0246c5d78110089208391bda6ffcaca8914b518d7b95f38b0f7ea5fb8be9c251b0cf24cb7276122b1c8ead1031b612c351697bb0cf22e0996f1c97
+  data.tar.gz: b39fb20cc9af081b217e4478432190a3941e2d87f6abe85e69626e6891293d6065b180075160e6cf8c84a1a61442cb585a186740a984bfcefd5d650fce903627

data/.rubocop.yml

@@ -1,6 +1,7 @@
 require:
   - rubocop-minitest
   - rubocop-performance
+  - rubocop-sorbet
 
 AllCops:
   NewCops: enable

data/CHANGELOG.md

@@ -1,7 +1,12 @@
-# unreleased 
-  
+# Unreleased 
+
+# v 0.7.2
+- Added new fields to phone numbers API. @ignacio-chiazzo [#73](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/73)
+- Upgraded API version to v16. @ignacio-chiazzo [#73](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/73)
+- Make sorbet-runtime a runtime dependency. @ignacio-chiazzo [#70](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/70)
+
 # v 0.7.1
-Add Register API [#65](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/65)
+Add Register API @andresyebra [#65](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/65)
 
 # v 0.7.0
 Add message reaction @sanchezpaco [#58](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/58)

data/Gemfile

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 source "https://rubygems.org"
 
@@ -17,6 +17,7 @@ group(:test) do
   gem('rubocop', require: false)
   gem('rubocop-minitest', require: false)
   gem('rubocop-performance', require: false)
+  gem('rubocop-sorbet', require: false)
   gem('webmock')
 end
 

data/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.7.0)
-      faraday (>= 2.3.0)
+    whatsapp_sdk (0.7.2)
+      faraday (~> 2.3.0)
       faraday-multipart (~> 1.0.4)
       oj (~> 3.13.13)
-      sorbet
-      sorbet-runtime
+      sorbet-runtime (~> 0.5.1)
       zeitwerk (~> 2.6.0)
 
 GEM
@@ -19,12 +18,12 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    faraday (2.5.2)
-      faraday-net_http (>= 2.0, < 3.1)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.0.0)
+    faraday-net_http (2.1.0)
     hashdiff (1.0.1)
     method_source (1.0.0)
     minitest (5.16.1)
@@ -66,6 +65,8 @@ GEM
     rubocop-performance (1.14.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
+    rubocop-sorbet (0.7.0)
+      rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sorbet (0.5.10346)
@@ -125,6 +126,7 @@ DEPENDENCIES
   rubocop
   rubocop-minitest
   rubocop-performance
+  rubocop-sorbet
   sorbet
   sorbet-runtime
   spoom

data/README.md

@@ -373,6 +373,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 - **Sorbet Typecheck:** run `srb tc`
 - **Linters:** `bundle exec rubocop`
 
+
+To update the Cloud API version update the version in `lib/whatsapp_sdk/api/api_configuration.rb`. Check the [Cloud API changelog for API udpates](https://developers.facebook.com/docs/whatsapp/business-platform/changelog#api-error-response-behavior).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk) This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 require "bundler/gem_tasks"
 require "rake/testtask"

data/bin/tapioca

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 #
 # This file was generated by Bundler.

data/lib/whatsapp_sdk/api/api_configuration.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Api
+    module ApiConfiguration
+      extend T::Sig
+
+      API_VERSION = T.let("v16.0", String)
+      API_URL = T.let("https://graph.facebook.com/#{API_VERSION}/", String)
+    end
+  end
+end

data/lib/whatsapp_sdk/api/business_profile.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "request"
 require_relative "response"

data/lib/whatsapp_sdk/api/client.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require "faraday"
 require "faraday/multipart"
@@ -10,9 +10,6 @@ module WhatsappSdk
     class Client
       extend T::Sig
 
-      API_VERSION = T.let("v14.0", String)
-      API_CLIENT = T.let("https://graph.facebook.com/#{API_VERSION}/", String)
-
       sig { params(access_token: String).void }
       def initialize(access_token)
         @access_token = access_token
@@ -28,7 +25,7 @@ module WhatsappSdk
         ).returns(T.nilable(T::Hash[T.untyped, T.untyped]))
       end
       def send_request(endpoint: "", full_url: nil, http_method: "post", params: {}, headers: {})
-        url = full_url || API_CLIENT
+        url = full_url || ApiConfiguration::API_URL
 
         faraday_request = T.unsafe(faraday(url))
 

data/lib/whatsapp_sdk/api/medias.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require "faraday"
 require "faraday/multipart"

data/lib/whatsapp_sdk/api/messages.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "request"
 require_relative "response"
@@ -9,7 +9,7 @@ module WhatsappSdk
     class Messages < Request
       extend T::Sig
 
-      DEFAULT_HEADERS = T.let({ 'Content-Type' => 'application/json' }, Hash)
+      DEFAULT_HEADERS = T.let({ 'Content-Type' => 'application/json' }.freeze, Hash)
 
       class MissingArgumentError < StandardError
         extend T::Sig

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "request"
 require_relative "response"
@@ -7,6 +7,12 @@ require_relative "response"
 module WhatsappSdk
   module Api
     class PhoneNumbers < Request
+      DEFAULT_FIELDS = %i[
+        id is_official_business_account display_phone_number verified_name account_mode quality_rating
+        certificate code_verification_status eligibility_for_api_business_global_search is_pin_enabled
+        name_status new_name_status status search_visibility messaging_limit_tier
+      ].join(",").freeze
+
       # Get list of registered numbers.
       #
       # @param business_id [Integer] Business Id.
@@ -15,7 +21,7 @@ module WhatsappSdk
       def registered_numbers(business_id)
         response = send_request(
           http_method: "get",
-          endpoint: "#{business_id}/phone_numbers"
+          endpoint: "#{business_id}/phone_numbers?fields=#{DEFAULT_FIELDS}"
         )
 
         WhatsappSdk::Api::Response.new(
@@ -32,7 +38,7 @@ module WhatsappSdk
       def registered_number(phone_number_id)
         response = send_request(
           http_method: "get",
-          endpoint: phone_number_id.to_s
+          endpoint: "#{phone_number_id}?fields=#{DEFAULT_FIELDS}"
         )
 
         WhatsappSdk::Api::Response.new(

data/lib/whatsapp_sdk/api/request.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Api

data/lib/whatsapp_sdk/api/response.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "responses/message_data_response"
 require_relative "responses/phone_number_data_response"

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "data_response"
 

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Api

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "data_response"
 

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "data_response"
 

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "../request"
 require_relative "data_response"

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "error_response"
 

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "data_response"
 
@@ -19,12 +19,32 @@ module WhatsappSdk
         sig { returns(String) }
         attr_accessor :quality_rating
 
+        sig { returns(T::Boolean) }
+        attr_accessor :is_pin_enabled, :is_official_business_account
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :account_mode, :code_verification_status, :eligibility_for_api_business_global_search,
+                      :certificate, :name_status, :new_name_status, :status, :search_visibility
+
         sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response)
           @id = T.let(response["id"], String)
           @verified_name = T.let(response["verified_name"], String)
           @display_phone_number = T.let(response["display_phone_number"], String)
           @quality_rating = T.let(response["quality_rating"], String)
+          @is_pin_enabled = T.let(response["is_pin_enabled"], T::Boolean)
+          @is_official_business_account = T.let(response["is_official_business_account"], T.nilable(T::Boolean))
+          @account_mode = T.let(response["account_mode"], T.nilable(String))
+          @certificate = T.let(response["certificate"], T.nilable(String))
+          @code_verification_status = T.let(response["code_verification_status"], T.nilable(String))
+          @eligibility_for_api_business_global_search = T.let(response["eligibility_for_api_business_global_search"],
+                                                              T.nilable(String))
+          @name_status = T.let(response["name_status"], T.nilable(String))
+          @new_name_status = T.let(response["new_name_status"], T.nilable(String))
+          @status = T.let(response["status"], T.nilable(String))
+          @search_visibility = T.let(response["search_visibility"], T.nilable(String))
+          @messaging_limit_tier = T.let(response["messaging_limit_tier"], T.nilable(String))
+
           super(response)
         end
 

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "data_response"
 require_relative "phone_number_data_response"

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "../request"
 require_relative "data_response"

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require_relative "data_response"
 

data/lib/whatsapp_sdk/configuration.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   # This module allows client instantiating the client as a singleton like the following example:

data/lib/whatsapp_sdk/error.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   class Error < StandardError; end

data/lib/whatsapp_sdk/resource/address.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/address_type.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/button_parameter.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/component.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/contact.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/contact_response.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/currency.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/date_time.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/email.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/media.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource
@@ -100,16 +100,24 @@ module WhatsappSdk
 
       sig { returns(T::Boolean) }
       def validate_media
-        if filename && (type != Type::Document)
-          raise InvalidMedia.new(:filename, "filename can only be used with document")
-        end
+        raise InvalidMedia.new(:filename, "filename can only be used with document") if filename && !supports_filename?
 
-        if caption && !(type == Type::Document || type == Type::Image)
+        if caption && !supports_caption?
           raise InvalidMedia.new(:caption, "caption can only be used with document or image")
         end
 
         true
       end
+
+      sig { returns(T::Boolean) }
+      def supports_filename?
+        type == Type::Document
+      end
+
+      sig { returns(T::Boolean) }
+      def supports_caption?
+        type == Type::Document || type == Type::Image
+      end
     end
   end
 end

data/lib/whatsapp_sdk/resource/message.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/name.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/org.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/parameter_object.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/phone_number.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/resource/url.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
   module Resource

data/lib/whatsapp_sdk/version.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module WhatsappSdk
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

data/lib/whatsapp_sdk.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 require "zeitwerk"
 require "faraday"

data/sorbet/tapioca/require.rb

@@ -1,5 +1,4 @@
 # typed: true
 # frozen_string_literal: true
-# typed: true
 
 # Add your extra requires here (`bin/tapioca require` can be used to boostrap this list)

data/whatsapp_sdk.gemspec

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 require_relative 'lib/whatsapp_sdk/version'
 
@@ -43,10 +43,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", "~> 12.3.3"
-  spec.add_dependency('sorbet')
-  spec.add_dependency('sorbet-runtime')
+  spec.add_development_dependency('sorbet', "~>0.5.1")
+
+  spec.add_runtime_dependency('sorbet-runtime', "~>0.5.1")
 
-  spec.add_dependency("faraday", ">= 2.3.0")
+  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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,42 +56,42 @@ dependencies:
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 0.5.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
@@ -166,6 +166,7 @@ files:
 - bin/tapioca
 - example.rb
 - lib/whatsapp_sdk.rb
+- lib/whatsapp_sdk/api/api_configuration.rb
 - lib/whatsapp_sdk/api/business_profile.rb
 - lib/whatsapp_sdk/api/client.rb
 - lib/whatsapp_sdk/api/medias.rb