warb 0.1.4 → 1.0.0

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,69 +1,35 @@
-# frozen_string_literal: true
-
-require_relative '../lib/warb'
-require 'sinatra/base'
-require 'faraday'
-require 'openssl'
+require "sinatra/base"
+require "faraday"
 
 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
 
-  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)
+  post "/webhook" do
+    request_body = JSON.parse(request.body.read)
 
     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)
 
@@ -74,15 +40,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)
 
@@ -101,39 +67,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"
@@ -149,12 +115,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
 
@@ -169,8 +135,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/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'connection'
+require_relative "connection"
 module Warb
   class Client
     include DispatcherConcern
@@ -10,7 +10,6 @@ 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
@@ -21,22 +20,21 @@ 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,5 +1,3 @@
-# frozen_string_literal: true
-
 module Warb
   module Components
     class Row
@@ -26,12 +24,12 @@ module Warb
         @rows = rows
       end
 
-      def add_row(**args, &)
+      def add_row(**args, &block)
         row = Row.new(**args)
 
         @rows << row
 
-        block_given? ? row.tap(&) : row
+        block_given? ? row.tap(&block) : row
       end
 
       def to_h
@@ -39,7 +37,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)
@@ -56,12 +54,12 @@ module Warb
         @sections = sections
       end
 
-      def add_section(**args, &)
+      def add_section(**args, &block)
         section = Section.new(**args)
 
         @sections << section
 
-        block_given? ? section.tap(&) : section
+        block_given? ? section.tap(&block) : section
       end
 
       def to_h
@@ -79,15 +77,14 @@ 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
@@ -96,7 +93,6 @@ module Warb
           end
         }
       end
-      # rubocop:enable Metrics/MethodLength
 
       def add_button_text(button_text)
         @buttons_texts << button_text
@@ -113,7 +109,7 @@ module Warb
 
       def to_h
         {
-          name: 'cta_url',
+          name: "cta_url",
           parameters: {
             display_text: @button_text,
             url: @url

data/lib/warb/configuration.rb

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

data/lib/warb/connection.rb

@@ -8,34 +8,28 @@ module Warb
       @client = client
     end
 
-    # rubocop:disable Metrics/ParameterLists
     def send_request(http_method:, endpoint:, url: nil, data: {}, headers: {}, multipart: false,
                      endpoint_prefix: :sender_id)
-      conn = connection(url:, multipart:)
-      response = conn.send(http_method, handle_endpoint(endpoint:, endpoint_prefix:), data, headers)
-      if response.success?
-        Warb::Response.new(response.body)
-      else
-        Warb::ResponseErrorHandler.new(response.body, response.status).handle
-      end
-    rescue Faraday::Error => e
-      msg = e.response_body || e.message
-      raise RequestError, msg
+      conn = set_connection(url:, multipart:)
+      conn.send(http_method, handle_endpoint(endpoint:, endpoint_prefix:), data, headers)
+    rescue StandardError => e
+      @client.logger.error e.inspect
+      e.response
     end
-    # rubocop:enable Metrics/ParameterLists
 
     private
 
-    def connection(url:, multipart:)
-      url ||= 'https://graph.facebook.com/v22.0'
+    def set_connection(url:, multipart:)
+      url ||= "https://graph.facebook.com/v22.0"
 
       Faraday.new(url) do |conn|
         conn.request(:multipart) if multipart
         conn.request(:url_encoded) if multipart
         conn.request(:json)
         conn.response(:json)
-        conn.headers['Authorization'] = "Bearer #{@client.access_token}" unless @client.access_token.nil?
+        conn.headers["Authorization"] = "Bearer #{@client.access_token}" unless @client.access_token.nil?
         conn.adapter(@client.adapter)
+        conn.response :raise_error
       end
     end
 

data/lib/warb/dispatcher.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Warb
   class Dispatcher
     def initialize(klass, client)
@@ -8,10 +6,11 @@ module Warb
     end
 
     def dispatch(recipient_number, reply_to: nil, **args, &block)
-      resource = block_given? ? @klass.new(**args).tap(&block) : @klass.new(**args)
+      resource = block_given? ? @klass.new.tap(&block) : @klass.new(**args)
 
       data = resource.call(recipient_number, reply_to:)
-      @client.post('messages', data)
+
+      @client.post("messages", data)
     end
   end
 end

data/lib/warb/dispatcher_concern.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Warb
   module DispatcherConcern
     def message
@@ -58,10 +56,6 @@ module Warb
       @contact ||= Dispatcher.new Resources::Contact, dispatcher
     end
 
-    def template
-      @template ||= TemplateDispatcher.new Resources::Template, dispatcher
-    end
-
     def flow
       @flow ||= Dispatcher.new Resources::Flow, dispatcher
     end

data/lib/warb/indicator_dispatcher.rb

@@ -7,15 +7,15 @@ module Warb
     end
 
     def send_typing_indicator(message_id)
-      data = common_indicator_params(message_id).merge(typing_indicator: { type: 'text' })
+      data = common_indicator_params(message_id).merge(typing_indicator: { type: "text" })
 
-      @client.post('messages', data)
+      @client.post("messages", data)
     end
 
     def mark_as_read(message_id)
       data = common_indicator_params(message_id)
 
-      @client.post('messages', data)
+      @client.post("messages", data)
     end
 
     private
@@ -24,7 +24,7 @@ module Warb
       {
         messaging_product: Warb::MESSAGING_PRODUCT,
         message_id: message_id,
-        status: 'read'
+        status: "read"
       }
     end
   end

data/lib/warb/media_dispatcher.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
 module Warb
   class MediaDispatcher < Dispatcher
-    def upload(file_path:, file_type: 'text/plain')
+    def upload(file_path:, file_type: "text/plain")
       file = Faraday::UploadIO.new(file_path, file_type)
 
       data = { file:, messaging_product: Warb::MESSAGING_PRODUCT }
 
-      @client.post('media', data, multipart: true).body['id']
+      @client.post("media", data, multipart: true).body["id"]
     end
 
     def download(file_path:, media_url: nil, media_id: nil)
-      media_url ||= retrieve(media_id)['url']
+      media_url ||= retrieve(media_id)["url"]
 
       resp = downloaded_media_response(media_url)
 
-      File.binwrite(file_path, resp.body)
+      File.open(file_path, "wb") do |file|
+        file.write(resp.body)
+      end
     end
 
     def retrieve(media_id)
@@ -25,9 +25,9 @@ module Warb
     def delete(media_id)
       response_body = @client.delete(media_id, endpoint_prefix: nil).body
 
-      return response_body['success'] if response_body['success']
+      return response_body["success"] if response_body["success"]
 
-      response_body['error']['message']
+      response_body["error"]["message"]
     end
 
     private
@@ -36,9 +36,9 @@ module Warb
       uri = URI(url)
 
       request = Net::HTTP::Get.new(uri)
-      request['Authorization'] = "Bearer #{@client.access_token}"
+      request["Authorization"] = "Bearer #{@client.access_token}"
 
-      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
         http.request(request)
       end
     end

data/lib/warb/resources/audio.rb

@@ -7,7 +7,7 @@ module Warb
 
       def build_payload
         {
-          type: 'audio',
+          type: "audio",
           audio: {
             id: media_id || @params[:media_id],
             link: link || @params[:link]