whatsapp_sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f270a981b63f318f63b07d8d7812e27a925ce5b96e8b46cec457b11647d531e2
+  data.tar.gz: ca9c1316ae6e4df8c01e809bee3693512cafba6840aff6b1ff6d471acc75b63c
+SHA512:
+  metadata.gz: 9dd7789b53c1c5b570698a4b03da3726acc899330aa2b123625ef833c410e1d21abe1ed35415abbcd79626b5698b80e64d71dfc98212a4cb4325ddbc555b729a
+  data.tar.gz: adb2fd6df0007660d4e88edc455cc3bf540407820212b4b7b6c7a7d5303da654430e8b29a7bc805e350bdb334e87d72a6d13c0b15c7408ecd094f4450b915a9f

data/.circleci/config.yml

@@ -0,0 +1,22 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.0.4
+jobs:
+  test:
+    docker:
+      - image: cimg/ruby:2.7.5
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run tests
+          command: bundle exec rake
+      - run:
+          name: Run Styling
+          command: bundle exec rubocop
+      
+workflows:
+  version: 2
+  deploy:
+    jobs:
+      - test

data/.github/workflows/dependency-review.yml

@@ -0,0 +1,20 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v1

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+DELETE_ME
+REMOVE.rb
+
+*.gem
+*.rbc
+/.config
+/pkg/
+
+.byebug_history
+
+.ruby-version
+.ruby-gemset
+
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,24 @@
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+# Wait until https://github.com/rubocop/rubocop/issues/8761 is fixed
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 3.0.0
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ignaciochiazzo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in whatsapp_sdk.gemspec
+gem("faraday")
+gem("oj")
+
+group(:test) do
+  gem('mocha')
+end
+
+group(:development) do
+  gem('pry')
+  gem('pry-nav')
+  gem('rubocop', require: false)
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    whatsapp_sdk (0.0.1)
+      faraday (~> 2.3.0)
+      oj (~> 3.13.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    mocha (1.14.0)
+    oj (3.13.13)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-nav (1.0.0)
+      pry (>= 0.9.10, < 0.15)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.30.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  bundler (~> 2.3)
+  faraday
+  minitest (~> 5.0)
+  mocha
+  oj
+  pry
+  pry-nav
+  rake (~> 10.0)
+  rubocop
+  whatsapp_sdk!
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 ignacio-chiazzo
+
+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.

data/README.md

@@ -0,0 +1,225 @@
+# Ruby Whatsapp SDK
+
+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!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-whatsapp-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-whatsapp-sdk
+
+## Quick Start
+
+There are two primary resources, `Messages` 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.
+
+To use `Messages` or `PhoneNumbers` you need to create a `Client` instance by passing the `access_token` like this:
+
+```ruby
+client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access token
+```
+
+Each API operation returns a `WhatsappSdk::Api::Response` that contains `data` and `error` and a couple of helpful functions such as `ok?` and `error?`. There are three types of response `WhatsappSdk::Api::MessageDataResponse`, `WhatsappSdk::Api::PhoneNumberDataResponse` and `WhatsappSdk::Api::PhoneNumbersDataResponse`. Each of them contains different attributes.
+
+## Operations
+First, create the client and then create an instance `WhatsappSdk::Api::Messages` that requires a client as a param like this:
+
+```ruby
+client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access_token
+messages_api = WhatsappSdk::Api::Messages.new(client)
+phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new(client)
+```
+
+### Phone numbers API
+Get the list of phone numbers registered
+```ruby
+phone_numbers_api.registered_numbers("123456") # accepts a business_id
+```
+
+Get the a phone number by id
+```ruby
+phone_numbers_api.registered_numbers("123456") # accepts a phone_number_id
+```
+
+### Messages API
+
+**Send a text message**
+
+```ruby
+messages_api.send_text(sender_id: 1234, recipient_number: "112345678", message: "hola")
+```
+
+**Send a location message**
+
+```ruby
+messages_api.send_location(
+  sender_id: 123123, recipient_number: "56789", 
+  longitude: 45.4215, latitude: 75.6972, name: "nacho", address: "141 cooper street"
+)
+```
+
+**Send an image message**
+It could use a link or an image_id.
+```ruby
+# with a link 
+messages_api.send_image(
+  sender_id: 123123, recipient_number: "56789", link: "image_link", caption: "Ignacio Chiazzo Profile"
+)
+
+# with an image id 
+messages_api.send_image(
+  sender_id: 123123, recipient_number: "56789", image_id: "1234", caption: "Ignacio Chiazzo Profile"
+)
+```
+
+**Send an audio message**
+It could use a link or an audio_id.
+```ruby
+# with a link 
+messages_api.send_audio(sender_id: 123123, recipient_number: "56789", link: "audio_link")
+
+# with an audio id 
+messages_api.send_audio(sender_id: 123123, recipient_number: "56789", audio_id: "1234")
+```
+
+**Send a document message**
+It could use a link or a document_id.
+```ruby
+# with a link 
+messages_api.send_document(
+  sender_id: 123123, recipient_number: "56789", link: "document_link", caption: "Ignacio Chiazzo"
+)
+
+# with a document id 
+messages_api.send_document(
+  sender_id: 123123, recipient_number: "56789", document_id: "1234", caption: "Ignacio Chiazzo"
+)
+```
+
+**Send a sticker message**
+It could use a link or a sticker_id.
+```ruby
+# with a link 
+messages_api.send_sticker(sender_id: 123123, recipient_number: "56789", link: "link")
+
+# with a sticker_id
+messages_api.send_sticker(sender_id: 123123, recipient_number: "56789", sticker_id: "1234")
+```
+
+**Send contacts message**
+To send a contact, you need to create a Contact instance object that contain objects embedded like 
+`addresses`, `birthday`, `emails`, `name`, `org`. See this [guide](/test/contact_helper.rb) to learn how to create contacts objects.
+
+```ruby
+contacts = [create_contact(params)]
+messages_api.send_contacts(sender_id: 123123, recipient_number: "56789", contacts: contacts)
+```
+
+## Example
+
+<details><summary>Example in a single file. </summary>
+    
+1) Copy this code into a file and save it `example.rb`
+2) Replace the `ACCESS_TOKEN` constant with a valid `access_token`. 
+3) Run the file with the command `ruby example.rb`
+
+```ruby
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "whatsapp_sdk", path: "/Users/ignaciochiazzo/src/whatsapp_sdk"
+  gem "pry"
+  gem "pry-nav"
+end
+
+require 'whatsapp_sdk'
+require "pry"
+require "pry-nav"
+
+ACCESS_TOKEN = "12345" # replace this with a valid access_token
+SENDER_ID = 107878721936019
+RECEIPIENT_NUMBER = "1234"
+
+client = WhatsappSdk::Api::Client.new(ACCESS_TOKEN) # replace this with a valid access_token
+messages_api = WhatsappSdk::Api::Messages.new(client)
+phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new(client)
+
+phone_numbers_api.registered_number("107878721936019")
+phone_numbers_api.registered_numbers("114503234599312") 
+
+messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, message: "hola")
+messages_api.send_location(
+  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, 
+  longitude: 45.4215, latitude: 75.6972, name: "nacho", address: "141 cooper street"
+)
+
+# Send images
+
+## with a link 
+messages_api.send_image(
+  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "image_link", caption: "Ignacio Chiazzo Profile"
+)
+
+## with an image id 
+messages_api.send_image(
+  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, image_id: "1234", caption: "Ignacio Chiazzo Profile"
+)
+
+# Send audios
+## with a link 
+messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "audio_link")
+
+## with an audio id 
+messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, audio_id: "1234")
+
+# Send documents
+## with a link 
+messages_api.send_document(
+  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "document_link", caption: "Ignacio Chiazzo"
+)
+
+## with a document id 
+messages_api.send_document(
+  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, document_id: "1234", caption: "Ignacio Chiazzo"
+)
+
+# send stickers
+## with a link 
+messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "link")
+
+## with a sticker_id
+messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, sticker_id: "1234")
+binding.pry
+
+```
+</details>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ignacio-chiazzo/whatsapp_sdk](https://github.com/ignacio-chiazzo/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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "whatsapp_sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/version.rb

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

data/lib/whatsapp_sdk/api/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "oj"
+
+module WhatsappSdk
+  module Api
+    class Client
+      API_VERSION = "v13.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|
+          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