whatsapp_sdk 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dabd5d87a1a3988caaafc2a090c9b85bcea77cc764132a169227a5ca1c4b409
-  data.tar.gz: 1ac41750e5e737fbf9a606e013015d796b68c328e3950241cad051c8eef6d674
+  metadata.gz: 309171f5666c8ab046ca3e386ea48486076ba6aa1412eb088b9a884e30d06bf3
+  data.tar.gz: 3bf929a941471762f0f35333b7179fc03c6c48c227a6fbd83246169f0739c505
 SHA512:
-  metadata.gz: 183f8600f1e74a46b4a38f290c806f479a0e52a20ec7c6d836b2fe3ac8038e4c91620e83d8780810907a2395555169aa8911fd5385299adcd3830a3492bea9a7
-  data.tar.gz: ce2cb90d04e06dc62d0294bcd395b3cf6cdffb2e60c24a8671539825de486299b11647eab9cf875007f290b8a35af350aadb7a985cad4bad2bcc415d85955cd3
+  metadata.gz: cb2485c108c4c8ec5fd431bb906fd6f82046fb12344fa2fdda23eea9dc2eac97753f47cf600871d7c81a043d1c14fdcfa518d20e9c5fa3363cb4c88224c0f179
+  data.tar.gz: 157afd0a17d5e310c803c7d7e36b88fcb7c8ea4d33d0bff2800aec57459442f08a2bb820b137e0184f4d5edf87177d2f3643f445bc07e0b1a3bd8f0fee954999

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '20 22 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/CHANGELOG.md

@@ -1,11 +1,13 @@
 # Unreleased
 
+# v 0.3.1
+- Update Meta API to v14
+
 # v 0.3.0
 - Allow Apps to have a singleton global authentication client.
 
 # v 0.2.0
 - Added Media API
-- Update Facebook API to v14
 - Added error and sucess responses
 - Added faraday-multiplart as part of the library
  

data/Gemfile

@@ -8,6 +8,7 @@ gem("faraday")
 gem("faraday-multipart")
 gem("oj")
 gem("rake", ">= 12.3.3")
+gem("zeitwerk", ">= 2.6.0")
 
 group(:test) do
   gem('mocha')

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.2.0)
+    whatsapp_sdk (0.3.0)
       faraday (~> 2.3.0)
       faraday-multipart (~> 1.0.4)
       oj (~> 3.13.13)
+      zeitwerk (~> 2.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -53,6 +54,7 @@ GEM
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   x86_64-darwin-21
@@ -71,6 +73,7 @@ DEPENDENCIES
   rubocop-minitest
   rubocop-performance
   whatsapp_sdk!
+  zeitwerk (>= 2.6.0)
 
 BUNDLED WITH
    2.3.9

data/README.md

@@ -4,7 +4,7 @@
 <a href="https://codeclimate.com/github/ignacio-chiazzo/ruby_whatsapp_sdk/maintainability"><img src="https://api.codeclimate.com/v1/badges/169cce95450272e4ad7d/maintainability" /></a>
 
 The SDK provides a set of operations and classes to use the Whatsapp API.
-Send stickers, messages, audio, videos, locations or just ask for the phone numbers through this library in a few steps!
+Send stickers, messages, audio, videos, and locations or just ask for the phone numbers through this library in a few steps!
 
 
 https://user-images.githubusercontent.com/11672878/173238826-6fc0a6f8-d0ee-4eae-8947-7dfd3b8b3446.mov
@@ -28,9 +28,9 @@ Or install it yourself as:
 
 ## Quick Start
 
-There are three primary resources, `Messages`, `Media` and `PhoneNumbers`. The first one allows clients to send any kind of message (text, audio, location, video, image, etc.), and the latter will enable clients to query the phone numbers associated.
+There are three primary resources, `Messages`, `Media` and `PhoneNumbers`. `Messages` allows users to send any kind of message (text, audio, location, video, image, etc.). `Media` allows users to manage media, and `Phone Numbers` enable clients to query the associated phone numbers.
 
-To use `Messages`, `Media` or `PhoneNumbers` you need to initialize the `Client` that contain auth information. There are two ways to do it
+To use `Messages`, `Media` or `PhoneNumbers`, you need to initialize the `Client` that contains auth information. There are two ways to do it
 
 1) Using an initializer
   
@@ -39,7 +39,7 @@ WhatsappSdk.configure do |config|
   config.access_token = ACCESS_TOKEN
 end
 ```
-OR creating an instance and pass it to the Messages or PhoneNumbers instance like this:
+OR 2) creating a `Client` instance and pass it to the `Messages`, `Medias` or `PhoneNumbers` instance like this:
 
 ```ruby
 client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access token
@@ -244,7 +244,7 @@ Visit [the example file](/example.rb) with examples to call the API in a single
 
 ## Troubleshooting
 
-- If the API response is success but the message is not delivered, make sure the device you're sending the message to is using a supported Whatsapp version. [Check documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/troubleshooting#message-not-delivered)
+- If the API response is `success` but the message is not delivered, make sure the device you're sending the message to is using a supported Whatsapp version. [Check documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/troubleshooting#message-not-delivered)
 
 ## Development
 

data/example.rb

@@ -11,7 +11,7 @@ gemfile(true) do
 
   git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-  gem "whatsapp_sdk"
+  gem "whatsapp_sdk", path: "/Users/ignaciochiazzo/src/whatsapp_sdk"
   gem "pry"
   gem "pry-nav"
 end
@@ -22,11 +22,13 @@ require "pry-nav"
 
 ################# UPDATE CONSTANTS #################
 
-ACCESS_TOKEN = "<TODO replace>"
-SENDER_ID = "<TODO replace>"
-RECIPIENT_NUMBER = "<TODO replace>"
-BUSINESS_ID = "<TODO replace>"
-IMAGE_LINK = "<TODO replace>"
+ACCESS_TOKEN = "EAAHwuHDNkqoBAOtjFZAw1MUOXsFOv4EMP8Hi2mtzvcHSPbYWD4HLLLRapjPIDQWagke3cF2IIZCbtlhMZCluO1sH7C594q0q9UqZAXwufTqBtebRlssZCLwKeC69l6Emdmt2gRYGDnhTJH0mrM7L5ivZAWezhjOvtzdnKJ7xBZALiQRKB6JrEAgAZBcnBMfBZC75xR0ZACXQUPoplhjN1a5FTA" # replace this with a valid access_token # TODO replace
+SENDER_ID = 107_878_721_936_019
+RECIPIENT_NUMBER = 13_437_772_910
+BUSINESS_ID = 114_503_234_599_312
+IMAGE_LINK = "https://ignaciochiazzo.com/static/4c403819b9750c8ad8b20a75308f2a8a/876d5/profile-pic.avif"
+binding.pry
+# message_sent = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, message: "holis")
 
 ################# Initialize Client #################
 WhatsappSdk.configure do |config|
@@ -57,6 +59,7 @@ uploaded_media = medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/whatsap
 puts "Uploaded media id: #{uploaded_media.data&.id}"
 
 # get a media
+uploaded_media = medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/whatsapp.png", type: "image/png")
 media = medias_api.media(media_id: uploaded_media.data&.id).data
 puts "Media info: #{media.raw_data_response}"
 
@@ -64,9 +67,9 @@ puts "Media info: #{media.raw_data_response}"
 download_image = medias_api.download(url: media&.url, file_path: 'tmp/downloaded_whatsapp.png')
 puts "Downloaded: #{download_image.data.success?}"
 
-# delete a media
-deleted_media = medias_api.delete(media_id: media&.id)
-puts "Deleted: #{deleted_media.data.success?}"
+# # delete a media
+# deleted_media = medias_api.delete(media_id: media&.id)
+# puts "Deleted: #{deleted_media.data.success?}"
 
 ############################## Messages API ##############################
 
@@ -205,3 +208,8 @@ response_with_json = messages_api.send_template(
   ]
 )
 puts response_with_json
+
+
+# # delete a media
+deleted_media = medias_api.delete(media_id: media&.id)
+puts "Deleted: #{deleted_media.data.success?}"

data/lib/version.rb

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

data/lib/whatsapp_sdk/api/request.rb

@@ -3,7 +3,7 @@
 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 = WhatsappSdk.configuration.client)

data/lib/whatsapp_sdk/configuration.rb

@@ -7,17 +7,6 @@ module WhatsappSdk
   # end
   #
   # The gem have access to the client through WhatsappSdk.configuration.client
-
-  class << self
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def configure
-      yield(configuration)
-    end
-  end
-
   class Configuration
     attr_accessor :access_token
 

data/lib/whatsapp_sdk.rb

@@ -1,38 +1,17 @@
 # frozen_string_literal: true
 
-# Configuration
-require_relative "whatsapp_sdk/configuration"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
 
-# APIs
-require_relative "whatsapp_sdk/api/phone_numbers"
-require_relative "whatsapp_sdk/api/messages"
-require_relative "whatsapp_sdk/api/medias"
-require_relative "whatsapp_sdk/api/client"
+module WhatsappSdk
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-# 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/message_error_response"
-require_relative "whatsapp_sdk/api/responses/data_response"
-require_relative "whatsapp_sdk/api/responses/read_message_data_response"
-require_relative "whatsapp_sdk/api/responses/media_data_response"
-require_relative "whatsapp_sdk/api/responses/success_response"
-require_relative "whatsapp_sdk/api/responses/error_response"
-
-# 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

@@ -45,5 +45,6 @@ Gem::Specification.new do |spec|
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.13.13
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 description: |2
       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.
@@ -104,6 +118,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/dependency-review.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"