warb 1.0.0 → 1.0.1

data/examples/sticker.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "../lib/warb"
+require_relative '../lib/warb'
 
 # Configure your variables here
 
-access_token = ""
-business_id = ""
-sender_id = ""
-recipient_number = ""
+access_token = ''
+business_id = ''
+sender_id = ''
+recipient_number = ''
 
-image_link = ""
+image_link = ''
 
 # We recommend testing one section at a time, as it can be overwhelming to see all the messages at once.
 # So you can comment out the sections you don't want to test.
@@ -25,8 +25,8 @@ warb_from_setup = Warb.setup do |config|
 end
 
 # To send sticker using its ID, you may need to retrieve it first, which can be retrieved this way
-file_path = "" # fill this in with the file path pointing to wherever the sticker is located
-file_type = "image/webp" # fill this in with the mimetype of the sticker to be uploaded
+file_path = '' # fill this in with the file path pointing to wherever the sticker is located
+file_type = 'image/webp' # fill this in with the mimetype of the sticker to be uploaded
 # only image/webp is allowed for sticker file type
 image_id = warb_from_setup.sticker.upload(file_path: file_path, file_type: file_type)
 # if you already have an sticker id, you can simply replace the above line with such id
@@ -53,8 +53,8 @@ warb_from_new = Warb.new(
 )
 
 # Same as stated above, if you need a sticker id, you can upload it this way
-file_path = "" # fill this in with the file path pointing to wherever the sticker is located
-file_type = "" # fill this in with the mimetype of the sticker to be uploaded
+file_path = '' # fill this in with the file path pointing to wherever the sticker is located
+file_type = '' # fill this in with the mimetype of the sticker to be uploaded
 # allow values for file_type: sticker/aac, sticker/amr, sticker/mpeg, sticker/mp4 or sticker/ogg
 image_id = warb_from_setup.sticker.upload(file_path: file_path, file_type: file_type)
 # if you already have a sticker id, you can simply replace the above line with such id

data/examples/video.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "../lib/warb"
+require_relative '../lib/warb'
 
 # Configure your variables here
 
-access_token = ""
-business_id = ""
-sender_id = ""
-recipient_number = ""
+access_token = ''
+business_id = ''
+sender_id = ''
+recipient_number = ''
 
-video_link = ""
+video_link = ''
 
 # We recommend testing one section at a time, as it can be overwhelming to see all the messages at once.
 # So you can comment out the sections you don't want to test.
@@ -25,24 +25,24 @@ warb_from_setup = Warb.setup do |config|
 end
 
 # To send video using its ID, you may need to retrieve it first, which can be retrieved this way
-file_path = "" # fill this in with the file path pointing to wherever the video is located
-file_type = "" # fill this in with the mimetype of the video to be uploaded. allowed values: "video/3gpp" or "video/mp4"
+file_path = '' # fill this in with the file path pointing to wherever the video is located
+file_type = '' # fill this in with the mimetype of the video to be uploaded. allowed values: "video/3gpp" or "video/mp4"
 video_id = warb_from_setup.video.upload(file_path: file_path, file_type: file_type)
 # if you already have a video id, you can simply replace the above line with such id
 
 warb_from_setup.video.dispatch(recipient_number, media_id: video_id)
-warb_from_setup.video.dispatch(recipient_number, media_id: video_id, caption: "OPTIONAL - Image caption")
+warb_from_setup.video.dispatch(recipient_number, media_id: video_id, caption: 'OPTIONAL - Image caption')
 warb_from_setup.video.dispatch(recipient_number, link: video_link)
-warb_from_setup.video.dispatch(recipient_number, link: video_link, caption: "OPTIONAL - Image caption")
+warb_from_setup.video.dispatch(recipient_number, link: video_link, caption: 'OPTIONAL - Image caption')
 
 warb_from_setup.video.dispatch(recipient_number) do |builder|
   builder.media_id = video_id
-  builder.caption = "OPTIONAL - Image caption"
+  builder.caption = 'OPTIONAL - Image caption'
 end
 
 warb_from_setup.video.dispatch(recipient_number) do |builder|
   builder.link = video_link
-  builder.caption = "OPTIONAL - Image caption"
+  builder.caption = 'OPTIONAL - Image caption'
 end
 
 # ############################################ #
@@ -56,24 +56,24 @@ warb_from_new = Warb.new(
 )
 
 # Same as stated above, if you need a video id, you can upload it this way
-file_path = "" # fill this in with the file path pointing to wherever the video is located
-file_type = "" # fill this in with the mimetype of the video to be uploaded. allowed values: "video/3gpp" or "video/mp4"
+file_path = '' # fill this in with the file path pointing to wherever the video is located
+file_type = '' # fill this in with the mimetype of the video to be uploaded. allowed values: "video/3gpp" or "video/mp4"
 video_id = warb_from_setup.video.upload(file_path: file_path, file_type: file_type)
 # if you already have a video id, you can simply replace the above line with such id
 
 warb_from_new.video.dispatch(recipient_number, media_id: video_id)
-warb_from_new.video.dispatch(recipient_number, media_id: video_id, caption: "OPTIONAL - Image caption")
+warb_from_new.video.dispatch(recipient_number, media_id: video_id, caption: 'OPTIONAL - Image caption')
 warb_from_new.video.dispatch(recipient_number, link: video_link)
-warb_from_new.video.dispatch(recipient_number, link: video_link, caption: "OPTIONAL - Image caption")
+warb_from_new.video.dispatch(recipient_number, link: video_link, caption: 'OPTIONAL - Image caption')
 
 warb_from_new.video.dispatch(recipient_number) do |builder|
   builder.media_id = video_id
-  builder.caption = "OPTIONAL - Image caption"
+  builder.caption = 'OPTIONAL - Image caption'
 end
 
 warb_from_new.video.dispatch(recipient_number) do |builder|
   builder.link = video_link
-  builder.caption = "OPTIONAL - Image caption"
+  builder.caption = 'OPTIONAL - Image caption'
 end
 
 # ################################################# #
@@ -81,16 +81,16 @@ end
 # ################################################# #
 
 Warb.video.dispatch(recipient_number, media_id: video_id)
-Warb.video.dispatch(recipient_number, media_id: video_id, caption: "OPTIONAL - Image caption")
+Warb.video.dispatch(recipient_number, media_id: video_id, caption: 'OPTIONAL - Image caption')
 Warb.video.dispatch(recipient_number, link: video_link)
-Warb.video.dispatch(recipient_number, link: video_link, caption: "OPTIONAL - Image caption")
+Warb.video.dispatch(recipient_number, link: video_link, caption: 'OPTIONAL - Image caption')
 
 Warb.video.dispatch(recipient_number) do |builder|
   builder.media_id = video_id
-  builder.caption = "OPTIONAL - Image caption"
+  builder.caption = 'OPTIONAL - Image caption'
 end
 
 Warb.video.dispatch(recipient_number) do |builder|
   builder.link = video_link
-  builder.caption = "OPTIONAL - Image caption"
+  builder.caption = 'OPTIONAL - Image caption'
 end

data/examples/webhook.rb

@@ -1,35 +1,69 @@
-require "sinatra/base"
-require "faraday"
+# frozen_string_literal: true
+
+require_relative '../lib/warb'
+require 'sinatra/base'
+require 'faraday'
+require 'openssl'
 
 class Webhook < Sinatra::Base
+
+  Warb.setup do |config|
+    config.access_token = token
+    config.business_id = business
+    config.sender_id = sender
+  end
+
   configure do
-    set :bind, "0.0.0.0"
+    set :bind, '0.0.0.0'
     set :port, 3000
     set :host_authorization, { permitted_hosts: [] }
   end
 
-  post "/webhook" do
-    request_body = JSON.parse(request.body.read)
+  helpers do
+    def verify_signature!(raw_body)
+      header = request.env['HTTP_X_HUB_SIGNATURE_256']
+
+      halt 400, 'Missing X-Hub-Signature-256' if APP_SECRET && (!header || header.empty?)
+
+      received = header.sub('sha256=', '')
+      expected = OpenSSL::HMAC.hexdigest('SHA256', APP_SECRET, raw_body)
+
+      unless Rack::Utils.secure_compare(received, expected)
+        puts "⚠️  Invalid webhook signature."
+        halt 403, 'Invalid signature'
+      end
+
+      true
+    end
+  end
+
+  post '/webhook' do
+    request.body.rewind
+    raw_body = request.body.read
+
+    verify_signature!(raw_body)
+
+    request_body = JSON.parse(raw_body)
 
     puts "\n🪝 Incoming webhook message: #{request_body}"
 
-    message = request_body.dig("entry", 0, "changes", 0, "value", "messages", 0)
+    message = request_body.dig('entry', 0, 'changes', 0, 'value', 'messages', 0)
 
-    if message && message["type"] == "text"
-      message_id = message["id"]
+    if message && message['type'] == 'text'
+      message_id = message['id']
 
       Warb.indicator.mark_as_read(message_id)
 
-      Warb.message.dispatch(message["from"], reply_to: message_id, message: "Echo #{message["text"]["body"]}")
+      Warb.message.dispatch(message['from'], reply_to: message_id, message: "Echo #{message['text']['body']}")
 
       reaction = {
         message_id:,
-        emoji: "✅"
+        emoji: '✅'
       }
 
-      Warb.reaction.dispatch(message["from"], **reaction)
-    elsif message && message["type"] == "location"
-      message_id = message["id"]
+      Warb.reaction.dispatch(message['from'], **reaction)
+    elsif message && message['type'] == 'location'
+      message_id = message['id']
 
       Warb.indicator.mark_as_read(message_id)
 
@@ -40,15 +74,15 @@ class Webhook < Sinatra::Base
       sleep 2
 
       location = {
-        latitude: message["location"]["latitude"],
-        longitude: message["location"]["longitude"],
-        name: message["location"]["name"],
-        address: message["location"]["address"]
+        latitude: message['location']['latitude'],
+        longitude: message['location']['longitude'],
+        name: message['location']['name'],
+        address: message['location']['address']
       }
 
-      Warb.location.dispatch(message["from"], reply_to: message_id, **location)
-    elsif message && message["type"] == "image"
-      message_id = message["id"]
+      Warb.location.dispatch(message['from'], reply_to: message_id, **location)
+    elsif message && message['type'] == 'image'
+      message_id = message['id']
 
       Warb.indicator.mark_as_read(message_id)
 
@@ -67,39 +101,39 @@ class Webhook < Sinatra::Base
       # below, we resend the received image, using its id.
 
       image = {
-        media_id: message["image"]["id"],
-        link: message["image"]["link"],
-        caption: message["image"]["caption"]
+        media_id: message['image']['id'],
+        link: message['image']['link'],
+        caption: message['image']['caption']
       }
 
-      Warb.image.dispatch(message["from"], reply_to: message_id, **image)
+      Warb.image.dispatch(message['from'], reply_to: message_id, **image)
 
       # and here, we download the received image
       Warb.image.download(media_id: image[:media_id], file_path: "#{Time.now}.jpg")
-    elsif message && message["type"] == "document"
-      message_id = message["id"]
+    elsif message && message['type'] == 'document'
+      message_id = message['id']
 
       Warb.indicator.mark_as_read(message_id)
 
       document = {
-        id: message["document"]["id"],
-        link: message["document"]["link"],
-        caption: message["document"]["caption"],
-        filename: message["document"]["filename"]
+        id: message['document']['id'],
+        link: message['document']['link'],
+        caption: message['document']['caption'],
+        filename: message['document']['filename']
       }
 
-      Warb.document.dispatch(message["from"], reply_to: message_id, **document)
-    elsif message && message["type"] == "sticker"
-      message_id = message["id"]
+      Warb.document.dispatch(message['from'], reply_to: message_id, **document)
+    elsif message && message['type'] == 'sticker'
+      message_id = message['id']
 
       Warb.indicator.mark_as_read(message_id)
 
       sticker = {
-        media_id: message["sticker"]["id"],
-        link: message["sticker"]["link"]
+        media_id: message['sticker']['id'],
+        link: message['sticker']['link']
       }
 
-      Warb.sticker.dispatch(message["from"], reply_to: message_id, **sticker)
+      Warb.sticker.dispatch(message['from'], reply_to: message_id, **sticker)
       # you could keep adding verifications for different types of messages...
       # elsif message && message["type"] == "image"
       # elsif message && message["type"] == "video"
@@ -115,12 +149,12 @@ class Webhook < Sinatra::Base
   # this is the endpoint which gets called to verify the server within the Meta's API
   # you can do whatever you want here to verify your server
   # returning the challenge value which was received as query param is enough
-  get "/webhook" do
-    mode = params["hub.mode"]
-    token = params["hub.verify_token"]
-    challenge = params["hub.challenge"]
+  get '/webhook' do
+    mode = params['hub.mode']
+    token = params['hub.verify_token']
+    challenge = params['hub.challenge']
 
-    if mode == "subscribe" && token == Warb.configuration.webhook_verify_token
+    if mode == 'subscribe' && token == Warb.configuration.webhook_verify_token
       status 200
       body challenge
 
@@ -135,8 +169,8 @@ class Webhook < Sinatra::Base
   private
 
   def conn
-    @conn ||= Faraday.new("https://graph.facebook.com/v22.0") do |conn|
-      conn.headers["Authorization"] = "Bearer #{Warb.configuration.access_token}" if Warb.configuration.access_token
+    @conn ||= Faraday.new('https://graph.facebook.com/v22.0') do |conn|
+      conn.headers['Authorization'] = "Bearer #{Warb.configuration.access_token}" if Warb.configuration.access_token
       conn.request(:json)
       conn.response(:json)
     end

data/lib/warb/category.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Warb
+  module Category
+    MARKETING = 'MARKETING'
+    UTILITY = 'UTILITY'
+  end
+end

data/lib/warb/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "connection"
+require_relative 'connection'
 module Warb
   class Client
     include DispatcherConcern
@@ -10,6 +10,7 @@ module Warb
 
     def_delegators :@configuration, :access_token, :sender_id, :business_id, :adapter, :logger
 
+    # rubocop:disable Metrics/ParameterLists
     def initialize(configuration = nil, access_token: nil, sender_id: nil, business_id: nil,
                    adapter: nil, logger: nil)
       @configuration = (configuration || Warb.configuration).dup
@@ -20,21 +21,22 @@ module Warb
       @configuration.adapter = adapter || @configuration.adapter
       @configuration.logger = logger || @configuration.logger
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def get(endpoint, data = {}, **args)
-      conn.send_request(http_method: "get", endpoint: endpoint, data: data, **args)
+      conn.send_request(http_method: 'get', endpoint: endpoint, data: data, **args)
     end
 
     def post(endpoint, data = {}, **args)
-      conn.send_request(http_method: "post", endpoint: endpoint, data: data, **args)
+      conn.send_request(http_method: 'post', endpoint: endpoint, data: data, **args)
     end
 
     def put(endpoint, data = {}, **args)
-      conn.send_request(http_method: "put", endpoint: endpoint, data: data, **args)
+      conn.send_request(http_method: 'put', endpoint: endpoint, data: data, **args)
     end
 
     def delete(endpoint, data = {}, **args)
-      conn.send_request(http_method: "delete", endpoint: endpoint, data: data, **args)
+      conn.send_request(http_method: 'delete', endpoint: endpoint, data: data, **args)
     end
 
     private

data/lib/warb/components/action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Warb
   module Components
     class Row
@@ -24,12 +26,12 @@ module Warb
         @rows = rows
       end
 
-      def add_row(**args, &block)
+      def add_row(**args, &)
         row = Row.new(**args)
 
         @rows << row
 
-        block_given? ? row.tap(&block) : row
+        block_given? ? row.tap(&) : row
       end
 
       def to_h
@@ -37,7 +39,7 @@ module Warb
           title: @title,
           rows: @rows.map.with_index do |row, index|
             row_title = row.title.slice(0, 10)
-            title = row_title.normalize.gsub(/\s/, "").downcase
+            title = row_title.normalize.gsub(/\s/, '').downcase
             id = "#{title}_#{index}"
 
             row.to_h.merge(id: id)
@@ -54,12 +56,12 @@ module Warb
         @sections = sections
       end
 
-      def add_section(**args, &block)
+      def add_section(**args, &)
         section = Section.new(**args)
 
         @sections << section
 
-        block_given? ? section.tap(&block) : section
+        block_given? ? section.tap(&) : section
       end
 
       def to_h
@@ -77,14 +79,15 @@ module Warb
         @buttons_texts = buttons_texts
       end
 
+      # rubocop:disable Metrics/MethodLength
       def to_h
         {
           buttons: @buttons_texts.map.with_index do |button_text, index|
-            text = button_text.normalize.gsub(/\s/, "").downcase
+            text = button_text.normalize.gsub(/\s/, '').downcase
             id = "#{text}_#{index}"
 
             {
-              type: "reply",
+              type: 'reply',
               reply: {
                 id: id,
                 title: button_text
@@ -93,6 +96,7 @@ module Warb
           end
         }
       end
+      # rubocop:enable Metrics/MethodLength
 
       def add_button_text(button_text)
         @buttons_texts << button_text
@@ -109,7 +113,7 @@ module Warb
 
       def to_h
         {
-          name: "cta_url",
+          name: 'cta_url',
           parameters: {
             display_text: @button_text,
             url: @url

data/lib/warb/components/button.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Warb
+  module Components
+    class Button < Component
+      attr_accessor :index, :sub_type
+
+      def initialize(**params)
+        params[:sub_type] = button_type unless params[:sub_type]
+
+        super
+      end
+
+      def to_h
+        {
+          type: 'button',
+          sub_type: sub_type || @params[:sub_type],
+          index: index || @params[:index]
+        }
+      end
+
+      private
+
+      def button_type
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/warb/components/component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Warb
+  module Components
+    class Component
+      def initialize(**params)
+        @params = params
+      end
+
+      def to_h
+        raise NotImplementedError
+      end
+
+      protected
+
+      attr_reader :params
+    end
+  end
+end

data/lib/warb/components/copy_code_button.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Warb
+  module Components
+    class CopyCodeButton < Button
+      BUTTON_TYPE = 'copy_code'
+
+      attr_accessor :coupon_code
+
+      def to_h
+        button_payload = super
+
+        if coupon_code || @params[:coupon_code]
+          button_payload[:parameters] = Array.new(1, {
+                                                    type: 'coupon_code',
+                                                    coupon_code: coupon_code || @params[:coupon_code]
+                                                  })
+        end
+
+        button_payload
+      end
+
+      private
+
+      def button_type
+        BUTTON_TYPE
+      end
+    end
+  end
+end

data/lib/warb/components/flow_button.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Warb
+  module Components
+    class FlowButton < Button
+      BUTTON_TYPE = 'flow'
+
+      attr_accessor :flow_token, :flow_action_data
+
+      def to_h
+        button_payload = super
+
+        token = flow_token || @params[:flow_token]
+        data  = flow_action_data || @params[:flow_action_data]
+
+        action = {}
+        action[:flow_token] = token if token
+        action[:flow_action_data] = data if data
+
+        button_payload[:parameters] = [{ type: 'action', action: action }]
+
+        button_payload
+      end
+
+      private
+
+      def button_type
+        BUTTON_TYPE
+      end
+    end
+  end
+end

data/lib/warb/components/quick_reply_button.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Warb
+  module Components
+    class QuickReplyButton < Button
+      BUTTON_TYPE = 'quick_reply'
+
+      private
+
+      def button_type
+        BUTTON_TYPE
+      end
+    end
+  end
+end

data/lib/warb/components/url_button.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Warb
+  module Components
+    class UrlButton < Button
+      BUTTON_TYPE = 'url'
+
+      attr_accessor :text
+
+      def to_h
+        button_payload = super
+
+        if text || @params[:text]
+          button_payload[:parameters] = Array.new(1, {
+                                                    type: 'text',
+                                                    text: text || @params[:text]
+                                                  })
+        end
+
+        button_payload
+      end
+
+      private
+
+      def button_type
+        BUTTON_TYPE
+      end
+    end
+  end
+end

data/lib/warb/components/voice_call_button.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Warb
+  module Components
+    class VoiceCallButton < Button
+      BUTTON_TYPE = 'voice_call'
+
+      private
+
+      def button_type
+        BUTTON_TYPE
+      end
+    end
+  end
+end

data/lib/warb/configuration.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Warb
   class Configuration
-    attr_accessor :access_token, :sender_id, :business_id, :adapter, :logger
+    attr_accessor :access_token, :sender_id, :business_id, :adapter, :logger, :custom_errors
 
     def initialize(access_token: nil, sender_id: nil, business_id: nil, adapter: nil, logger: nil)
       @access_token = access_token
@@ -8,6 +10,7 @@ module Warb
       @business_id = business_id
       @adapter = adapter || Faraday.default_adapter
       @logger = logger || Logger.new($stdout)
+      @custom_errors = CustomErrors.new.build
     end
   end
 end