whatsapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dc5df79a0df03527f9af0b731cab5aa86d4555d82c622719abe3d5a57d30f6a
+  data.tar.gz: 9917d7853f64b765ee69f7fdd768c268f1cf2c1ffd2eed4fb54db93f74233a9b
+SHA512:
+  metadata.gz: 919cf020ce02a91dca4bed6fa3070f126e0afd6c12015d19a92577e16d719e3897fe3674dfc3ea6de8a97b49480698b3f2b7df953b2216139b4ea68761117294
+  data.tar.gz: 53487ff2c96ffc761c48b3b31f843ce65c7f0f9e157b530b89fc8fbfdd85987ae44dbdde6aa837aa7983b1aa1da7a536cd458a7dba99bc58be4f5fd9ec401498

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in whatsapp.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    whatsapp (0.1.0)
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.23)
+    hashdiff (0.3.7)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+  whatsapp!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bruno Soares
+
+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,69 @@
+# WhatsApp
+
+An ruby interface to WhatsApp Enterprise API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "whatsapp"
+```
+
+## Usage
+
+### Instantiation
+
+Create an instance of the API client passing the base path of your endpoint:
+
+```ruby
+whats = Whats::Api.new("https://my-whatsapp-endpoint.com")
+```
+
+### Check Contacts
+
+Take a look [here](https://developers.facebook.com/docs/whatsapp/check-contacts) (WhatsApp Check Contacts doc) for more information.
+
+```ruby
+whats.check_contacts(["+5511942424242"])
+
+# output:
+{
+  "meta" => {
+    "waent version" => "2.18.4"
+  },
+  "payload" => {
+    "results" => [
+      {
+        "input_number" => "+5511942424242",
+        "wa_exists" => true,
+        "wa_username" => "5511942424242"
+      }
+    ],
+    "total" => 1
+  },
+  "error" => false
+}
+```
+
+### Send Message
+
+Take a look [here](https://developers.facebook.com/docs/whatsapp/send-api) (WhatsApp Send Message doc) for more information.
+
+*The first parameter is the WhatsApp **username**!*
+
+```ruby
+whats.send_message("5511942424242", "Message goes here.")
+
+# output:
+
+{
+  "meta" => {
+    "waent version" => "2.18.4"
+  },
+  "payload" => {
+    "message_id" => "BAEC4D1D7549842627"
+  },
+  "error" => false
+}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whatsapp"
+
+# 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/whats/actions/check_contacts.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Whats
+  module Actions
+    class CheckContacts
+      PATH = "/api/check_contacts.php"
+
+      def initialize(client, numbers)
+        @client  = client
+        @numbers = numbers
+      end
+
+      def call
+        client.request PATH, payload
+      end
+
+      private
+
+      attr_reader :client, :numbers
+
+      def payload
+        {
+          payload: {
+            blocking: "wait",
+            users:    numbers
+          }
+        }
+      end
+    end
+  end
+end

data/lib/whats/actions/send_hsm_message.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Whats
+  module Actions
+    class SendHsmMessage
+      PATH = "/api/rest_send.php"
+
+      def initialize(client, username, namespace, element_name, params)
+        @client       = client
+        @username     = username
+        @namespace    = namespace
+        @element_name = element_name
+        @params       = params
+      end
+
+      def call
+        client.request PATH, payload
+      end
+
+      private
+
+      attr_reader :client, :username, :namespace, :element_name, :params
+
+      def payload
+        {
+          payload: {
+            to: username,
+            hsm: {
+              namespace:          namespace,
+              element_name:       element_name,
+              localizable_params: params
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/whats/actions/send_message.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Whats
+  module Actions
+    class SendMessage
+      PATH = "/api/rest_send.php"
+
+      def initialize(client, username, body)
+        @client   = client
+        @username = username
+        @body     = body
+      end
+
+      def call
+        client.request PATH, payload
+      end
+
+      private
+
+      attr_reader :client, :username, :body
+
+      def payload
+        {
+          payload: {
+            to:   username,
+            body: body
+          }
+        }
+      end
+    end
+  end
+end

data/lib/whats/api.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "whats/actions/check_contacts"
+require "whats/actions/send_message"
+require "whats/actions/send_hsm_message"
+
+module Whats
+  class Api
+    def initialize(base_path)
+      @base_path = base_path
+    end
+
+    def check_contacts(numbers)
+      Actions::CheckContacts.new(client, numbers).call
+    end
+
+    def check_contact(number)
+      response = check_contacts([number])
+
+      result = \
+        response["payload"]["results"].reduce({}) do |temp, hash|
+          temp.merge(hash["input_number"] => hash)
+        end
+
+      result[number]
+    end
+
+    def send_message(username, body)
+      Actions::SendMessage.new(client, username, body).call
+    end
+
+    def send_hsm_message(username, namespace, element_name, params)
+      Actions::SendHsmMessage.new(
+        client,
+        username,
+        namespace,
+        element_name,
+        params
+      ).call
+    end
+
+    private
+
+    attr_reader :base_path
+
+    def client
+      @client ||= Whats::Client.new(base_path)
+    end
+  end
+end

data/lib/whats/client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Whats
+  class Client
+    def initialize(base_path)
+      @base_path = base_path
+    end
+
+    def request(path, payload)
+      full_path = "#{base_path}#{path}"
+
+      response = Typhoeus.post(
+        full_path,
+        headers: { "Content-Type" => "application/json" },
+        body: payload.to_json
+      )
+
+      unless response.success?
+        raise Whats::Errors::RequestError.new("API request error.", response)
+      end
+
+      JSON.parse(response.response_body)
+    end
+
+    private
+
+    attr_reader :base_path
+  end
+end

data/lib/whats/errors/request_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whats
+  module Errors
+    class RequestError < StandardError
+      attr_reader :response
+
+      def initialize(message, response)
+        @response = response
+
+        super message
+      end
+    end
+  end
+end

data/lib/whats/version.rb

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

data/lib/whatsapp.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "whats/version"
+require "whats/errors/request_error"
+require "whats/client"
+require "whats/api"

data/whatsapp.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "whats/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "whatsapp"
+  spec.version = Whats::VERSION
+  spec.authors = ["Bruno Soares", "GetNinjas"]
+  spec.email   = ["bruno@bsoares.com", "tech@getninjas.com.br"]
+
+  spec.description = spec.summary = "An interface to WhatsApp Enterprise API."
+  spec.homepage    = "https://github.com/getninjas/whatsapp"
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "typhoeus"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: whatsapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Soares
+- GetNinjas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An interface to WhatsApp Enterprise API.
+email:
+- bruno@bsoares.com
+- tech@getninjas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/whats/actions/check_contacts.rb
+- lib/whats/actions/send_hsm_message.rb
+- lib/whats/actions/send_message.rb
+- lib/whats/api.rb
+- lib/whats/client.rb
+- lib/whats/errors/request_error.rb
+- lib/whats/version.rb
+- lib/whatsapp.rb
+- whatsapp.gemspec
+homepage: https://github.com/getninjas/whatsapp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: An interface to WhatsApp Enterprise API.
+test_files: []