freshchat_whatsapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a00641e28830515002f70ff8fc0d281f6fee0947be06a6070f3aadecbd4f94b
+  data.tar.gz: f0c2c1df08034f51f39b3e97a6ae3b03b4f0679ea0d8c2352fe7e6d4ceb501be
+SHA512:
+  metadata.gz: b04214f2a11575259557d3720e82cf36fbae3a3575d0b2e9b32b842faad174ddecb1329ed5311ae15e6b5aeacd6f14eb3a40e8d4bba977873ed8846cf6304d93
+  data.tar.gz: 967e1b994fce291b89fc00a41768666e38cfa8264137f3a8130863973ac43fb48d35f9c7fdb6790787c0dd9eaee303b39a2d57ee8ccb42893fc914134771cbd5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freshchat_whatsapp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Arvind Vyas
+
+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,113 @@
+# FreshchatWhatsapp
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/freshchat_whatsapp`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freshchat_whatsapp'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install freshchat_whatsapp
+
+### Configuration
+
+Before you can send messages there's some Configuration to be done. Set the base path, api_key
+
+```ruby
+ FreshchatWhatsapp.configure do |config|
+   config.base_path = "https://example.freshchat.com"
+   config.api_key = "api_key"
+ end
+
+```
+
+Create an instance of the API client, which is going to be used from now on to interact with whatsapp
+```ruby
+fresh_chat = FreshchatWhatsapp::Api.new
+```
+
+
+### Send HSM (templated) messages
+
+so freshchat use to give facility to design your template so what ever params you are asking to send into the template you have to prepare as this part is total dynamic by the given method 
+
+this is example template generated you have you change according to your template 
+```ruby
+def generate_rich_template_data(url, name)
+  {
+    'rich_template_data' => {
+      'button' => {
+        'subType' => 'url',
+        'params' => [
+          {
+            'data' => url
+          }
+        ]
+      },
+      'body' => {
+        'params' => [
+          {
+            'data' => name
+          }
+        ]
+      }
+    }
+  }
+end
+```
+
+prepare params , if we talk about url freshchat will not allow to send you full url you can just sent the part dynamic part.
+```ruby
+params = generate_rich_template_data('/example/13213', 'MR JACK')
+```
+
+This method generates the 'rich_template_data' section for a Freshchat WhatsApp payload.
+
+Parameters:
+- `from_number`: is the number regiester to send the number
+
+- `namespace`: Provided by the Freshchat team.
+- `to_number`: Recipient's phone number for message delivery.
+- `template_name`: Template used for passing data.
+- `language`: Default language set to 'en'.
+- `params`: Data set using the method above.
+
+```ruby
+fresh_chat.send_hsm_message(from_number, to_number, namespace, template_name,language, params)
+
+# output:
+
+{"request_id"=>"48a79993-9b2f", "request_process_time"=>"1", "link"=>{"rel"=>"outbound-messages", "href"=>"/v2/outbound-messages?request_id=48a79993-9b2f", "type"=>"GET"}, "status"=>"Request created successfully. Check delivery status using status API"} 
+```
+
+### Check message status
+
+```ruby
+fresh_chat.check_message_status('48a79993-9b2f')
+{"outbound_messages"=>[{"message_id"=>"0c204f712c2e", "from"=>{"phone_number"=>"+91XXXXXXXX"}, "provider"=>"whatsapp", "to"=>{"phone_number"=>"+91XXXXXXX"}, "data"=>{"message_template"=>{"storage"=>"conversation", "template_name"=>"corporate_sales_client_phone_number_verification_staging", "namespace"=>"e98e3c87a2", "language"=>{"policy"=>"deterministic", "code"=>"en"}, "rich_template_data"=>{"body"=>{"params"=>[{"data"=>"MR JACK"}]}, "button"=>{"subType"=>"url", "params"=>[{"data"=>"/example/13213"}]}}}}, "request_id"=>"6ac508a0d1", "status"=>"READ", "created_on"=>1700193764196}]} 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/arvindvyas/freshchat_whatsapp.
+
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'freshchat_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/freshchat_whatsapp.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/freshchat_whatsapp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'freshchat_whatsapp'
+  spec.version       = FreshchatWhatsapp::VERSION
+  spec.authors       = ['Arvind Vyas']
+  spec.email         = ['arvindvyas07@gmail.com']
+
+  spec.summary       = 'The Ruby gem enables seamless integration of WhatsApp into Ruby apps via Freshchat, streamlining customer communication and support. It simplifies adding WhatsApp as a channel for enhanced interactions within Ruby-based projects.'
+  spec.description   = "The Ruby gem support for Freshchat WhatsApp integration enables seamless communication by leveraging the power of Freshchat within Ruby applications. It allows developers to integrate WhatsApp messaging functionalities into their Ruby-based projects using Freshchat's comprehensive features. This integration simplifies the process of incorporating WhatsApp as a communication channel, offering a convenient solution for Ruby developers to enhance customer "
+  spec.homepage      = 'https://github.com/arvindvyas/freshchat_whatsapp'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/arvindvyas/freshchat_whatsapp'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'faraday', '>= 2.0', '< 3'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/freshchat_whatsapp/actions/check_message_status.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module FreshchatWhatsapp
+  module Actions
+    class CheckMessageStatus
+      PATH = '/v2/outbound-messages'
+
+      def initialize(client, request_id)
+        @client = client
+        @request_id = request_id
+      end
+
+      def call
+        client.get_request "#{PATH}?request_id=#{request_id}"
+      end
+
+      private
+
+      attr_reader :client, :request_id
+    end
+  end
+end

data/lib/freshchat_whatsapp/actions/send_hsm_message.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module FreshchatWhatsapp
+  module Actions
+    class SendHsmMessage
+      PATH = '/v2/outbound-messages/whatsapp'
+
+      def initialize(client, from_number, wtsapp_phone_number, namespace, template_name, language, params)
+        @from_number = from_number
+        @phone_number = wtsapp_phone_number
+        @namespace = namespace
+        @template_name = template_name
+        @language = language
+        @params = params
+        @client = client
+      end
+
+      def call
+        client.request PATH, payload
+      end
+
+      private
+
+      attr_reader :client, :wtsapp_phone_number, :namespace, :template_name, :language, :params
+
+      def payload
+        payload = {
+          'from': {
+            'phone_number': @from_number
+          },
+          'to': [
+            {
+              'phone_number': @phone_number
+            }
+          ],
+          'data': {
+            'message_template': {
+              'storage': 'conversation',
+              'namespace': @namespace,
+              'template_name': @template_name,
+              'language': {
+                'policy': 'deterministic',
+                'code': 'en'
+              }
+            }
+          }
+        }
+
+        payload[:data][:message_template].merge!(params)
+        payload
+      end
+    end
+  end
+end

data/lib/freshchat_whatsapp/api.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'freshchat_whatsapp/actions/send_hsm_message'
+require 'freshchat_whatsapp/actions/check_message_status'
+
+module FreshchatWhatsapp
+  class Api
+    def initialize
+      @base_path = FreshchatWhatsapp.configuration.base_path
+    end
+
+    def send_hsm_message(from_number, to_number, namespace, template_name, language, params)
+      Actions::SendHsmMessage.new(
+        client,
+        from_number,
+        to_number,
+        namespace,
+        template_name,
+        language,
+        params
+      ).call
+    end
+
+    def check_message_status(request_id)
+      Actions::CheckMessageStatus.new(
+        client,
+        request_id
+      ).call
+    end
+
+    private
+
+    attr_reader :base_path
+
+    def client
+      @client = FreshchatWhatsapp::Client.new
+    end
+  end
+end

data/lib/freshchat_whatsapp/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module FreshchatWhatsapp
+  class Client
+    def initialize(token_type = :bearer)
+      @base_path = FreshchatWhatsapp.configuration.base_path
+      @token = FreshchatWhatsapp.configuration.api_key
+      @token_type = token_type
+    end
+
+    def request(path, payload = nil)
+      full_path = "#{base_path}#{path}"
+      conn = Faraday.new(url: full_path, headers: headers)
+      response = conn.post { |request| request.body = body(payload) }
+
+      unless response.success?
+        raise FreshchatWhatsapp::Errors::RequestError.new('FreshchatWhatsapp API request error.', response.body)
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def get_request(path, payload = nil)
+      full_path = "#{base_path}#{path}"
+      conn = Faraday.new(url: full_path, headers: headers)
+      response = conn.get { |request| request.body = body(payload) }
+
+      unless response.success?
+        raise FreshchatWhatsapp::Errors::RequestError.new('FreshchatWhatsapp API request error.', response.body)
+      end
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    attr_reader :base_path, :token, :token_type
+
+    def token_name
+      case token_type
+      when :bearer
+        'Bearer'
+      end
+    end
+
+    def headers
+      {
+        'Authorization' => "#{token_name} #{token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def body(payload)
+      payload&.to_json
+    end
+  end
+end

data/lib/freshchat_whatsapp/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FreshchatWhatsapp
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :base_path, :api_key
+  end
+end

data/lib/freshchat_whatsapp/errors/request_error.rb

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

data/lib/freshchat_whatsapp/version.rb

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

data/lib/freshchat_whatsapp.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Dependencies
+require 'json'
+require 'faraday'
+
+# Source
+require 'freshchat_whatsapp/configuration'
+require 'freshchat_whatsapp/version'
+require 'freshchat_whatsapp/actions/send_hsm_message'
+require 'freshchat_whatsapp/errors/request_error'
+require 'freshchat_whatsapp/client'
+require 'freshchat_whatsapp/api'

data/lib/whatsapp/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Whatsapp
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :base_path, :api_key
+  end
+end

data/lib/whatsapp/errors/request_error.rb

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

data/lib/whatsapp/version.rb

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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: freshchat_whatsapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arvind Vyas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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'
+description: 'The Ruby gem support for Freshchat WhatsApp integration enables seamless
+  communication by leveraging the power of Freshchat within Ruby applications. It
+  allows developers to integrate WhatsApp messaging functionalities into their Ruby-based
+  projects using Freshchat''s comprehensive features. This integration simplifies
+  the process of incorporating WhatsApp as a communication channel, offering a convenient
+  solution for Ruby developers to enhance customer '
+email:
+- arvindvyas07@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freshchat_whatsapp.gemspec
+- lib/.DS_Store
+- lib/freshchat_whatsapp.rb
+- lib/freshchat_whatsapp/actions/check_message_status.rb
+- lib/freshchat_whatsapp/actions/send_hsm_message.rb
+- lib/freshchat_whatsapp/api.rb
+- lib/freshchat_whatsapp/client.rb
+- lib/freshchat_whatsapp/configuration.rb
+- lib/freshchat_whatsapp/errors/request_error.rb
+- lib/freshchat_whatsapp/version.rb
+- lib/whatsapp/configuration.rb
+- lib/whatsapp/errors/request_error.rb
+- lib/whatsapp/version.rb
+homepage: https://github.com/arvindvyas/freshchat_whatsapp
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/arvindvyas/freshchat_whatsapp
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: The Ruby gem enables seamless integration of WhatsApp into Ruby apps via
+  Freshchat, streamlining customer communication and support. It simplifies adding
+  WhatsApp as a channel for enhanced interactions within Ruby-based projects.
+test_files: []