warb 1.0.0 → 1.0.1

data/lib/warb/connection.rb

@@ -8,28 +8,34 @@ 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 = 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
+      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
     end
+    # rubocop:enable Metrics/ParameterLists
 
     private
 
-    def set_connection(url:, multipart:)
-      url ||= "https://graph.facebook.com/v22.0"
+    def 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Warb
   class Dispatcher
     def initialize(klass, client)
@@ -6,11 +8,10 @@ module Warb
     end
 
     def dispatch(recipient_number, reply_to: nil, **args, &block)
-      resource = block_given? ? @klass.new.tap(&block) : @klass.new(**args)
+      resource = block_given? ? @klass.new(**args).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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Warb
   module DispatcherConcern
     def message
@@ -56,6 +58,10 @@ 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/errors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Warb
+  class RequestError < StandardError; end
+  class BadRequest < RequestError; end
+  class Unauthorized < RequestError; end
+  class Forbidden < RequestError; end
+  class NotFound < RequestError; end
+  class InternalServerError < RequestError; end
+  class ServiceUnavailable < RequestError; end
+
+  # custom error classes
+  class IntegrityError < Forbidden; end
+  class InvalidBusinessNumber < BadRequest; end
+
+  class CustomErrors
+    def build
+      {
+        400 => {
+          33 => InvalidBusinessNumber
+        }
+      }
+    end
+  end
+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/language.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Warb
+  module Language
+    ENGLISH_US = 'en_US'
+    PORTUGUESE_BR = 'pt_BR'
+  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.open(file_path, "wb") do |file|
-        file.write(resp.body)
-      end
+      File.binwrite(file_path, resp.body)
     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]

data/lib/warb/resources/contact.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "../components/address"
-require_relative "../components/name"
-require_relative "../components/email"
-require_relative "../components/org"
-require_relative "../components/phone"
-require_relative "../components/url"
+require_relative '../components/address'
+require_relative '../components/name'
+require_relative '../components/email'
+require_relative '../components/org'
+require_relative '../components/phone'
+require_relative '../components/url'
 
 module Warb
   module Resources
@@ -13,7 +13,7 @@ module Warb
       attr_accessor :addresses, :emails, :phones, :urls, :name, :org, :birthday
 
       def initialize(**params)
-        super(**params)
+        super
 
         @org = @params[:org]
         @name = @params[:name]
@@ -24,9 +24,10 @@ module Warb
         @urls = @params.fetch(:urls, [])
       end
 
+      # rubocop:disable Metrics/MethodLength
       def build_payload
         {
-          type: "contacts",
+          type: 'contacts',
           contacts: [
             {
               birthday: birthday,
@@ -40,49 +41,50 @@ module Warb
           ]
         }
       end
+      # rubocop:enable Metrics/MethodLength
 
-      def add_address(**params, &block)
+      def add_address(**params, &)
         address = Components::Address.new(**params)
 
         @addresses << address
 
-        block_given? ? address.tap(&block) : address
+        block_given? ? address.tap(&) : address
       end
 
-      def add_email(**params, &block)
+      def add_email(**params, &)
         email = Components::Email.new(**params)
 
         @emails << email
 
-        block_given? ? email.tap(&block) : email
+        block_given? ? email.tap(&) : email
       end
 
-      def add_phone(**params, &block)
+      def add_phone(**params, &)
         phone = Components::Phone.new(**params)
 
         @phones << phone
 
-        block_given? ? phone.tap(&block) : phone
+        block_given? ? phone.tap(&) : phone
       end
 
-      def add_url(**params, &block)
+      def add_url(**params, &)
         url = Components::URL.new(**params)
 
         @urls << url
 
-        block_given? ? url.tap(&block) : url
+        block_given? ? url.tap(&) : url
       end
 
-      def build_name(**params, &block)
+      def build_name(**params, &)
         @name = Warb::Components::Name.new(**params)
 
-        block_given? ? @name.tap(&block) : @name
+        block_given? ? @name.tap(&) : @name
       end
 
-      def build_org(**params, &block)
+      def build_org(**params, &)
         @org = Warb::Components::Org.new(**params)
 
-        block_given? ? @org.tap(&block) : @org
+        block_given? ? @org.tap(&) : @org
       end
     end
   end

data/lib/warb/resources/currency.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Warb
+  module Resources
+    class Currency < Resource
+      BRL = 'BRL'
+      USD = 'USD'
+
+      attr_accessor :amount, :code, :fallback
+
+      def initialize(**params)
+        super
+
+        @code = params[:code]
+        @amount = params[:amount]
+        @fallback = params[:fallback]
+      end
+
+      def build_template_named_parameter(parameter_name)
+        common_currency_params.merge(parameter_name: parameter_name)
+      end
+
+      def build_template_positional_parameter
+        common_currency_params
+      end
+
+      private
+
+      # rubocop:disable Naming/VariableNumber
+      def common_currency_params
+        {
+          type: 'currency',
+          currency: {
+            amount_1000: amount * 1000,
+            code: code,
+            fallback_value: fallback || default_fallback_value
+          }
+        }
+      end
+      # rubocop:enable Naming/VariableNumber
+
+      def default_fallback_value
+        "#{amount} (#{code})"
+      end
+    end
+  end
+end

data/lib/warb/resources/date_time.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Warb
+  module Resources
+    class DateTime < Resource
+      attr_accessor :date_time
+
+      def initialize(date_time = nil, **params)
+        super(**params)
+
+        @date_time = date_time || params[:date_time]
+      end
+
+      def build_template_named_parameter(parameter_name)
+        common_date_time_params.merge(parameter_name: parameter_name)
+      end
+
+      def build_template_positional_parameter
+        common_date_time_params
+      end
+
+      private
+
+      def common_date_time_params
+        {
+          type: 'date_time',
+          date_time: {
+            fallback_value: date_time
+          }
+        }
+      end
+    end
+  end
+end

data/lib/warb/resources/document.rb

@@ -19,7 +19,7 @@ module Warb
 
       def common_document_params
         {
-          type: "document",
+          type: 'document',
           document: {
             id: media_id || @params[:media_id],
             filename: filename || @params[:filename],

data/lib/warb/resources/flow.rb

@@ -3,31 +3,93 @@
 module Warb
   module Resources
     class Flow < Resource
-      attr_accessor :flow_id, :screen
+      include Helpers::Header
+
+      attr_accessor :flow_id, :screen, :flow_action, :mode,
+                    :flow_cta, :flow_token, :body, :header, :footer, :data,
+                    :draft, :data_exchange
 
       def build_payload
+        validate!
+
         {
-          type: "interactive",
-          interactive: {
-            type: "flow",
-            body: {
-              text: "Not shown in draft mode"
-            },
-            action: {
-              name: "flow",
-              parameters: {
-                flow_message_version: "3",
-                flow_action: "navigate",
-                flow_id: flow_id || @params[:flow_id],
-                flow_cta: "Not shown in draft mode",
-                mode: "draft",
-                flow_action_payload: {
-                  screen: screen || @params[:screen]
-                }
-              }
-            }
+          type: 'interactive',
+          interactive: build_interactive
+        }
+      end
+
+      private
+
+      def build_interactive
+        interactive = {
+          type: 'flow',
+          action: {
+            name: 'flow',
+            parameters: build_action_parameters
           }
         }
+
+        header = resolve(:header)
+        if header.is_a?(Hash)
+          interactive[:header] = header
+        elsif header.respond_to?(:build_header)
+          interactive[:header] = header.build_header
+        end
+
+        resolve(:body)
+          .then { |body| interactive[:body] = { text: body } }
+
+        resolve(:footer)
+          .then { |footer| interactive[:footer] = { text: footer } unless blank?(footer) }
+
+        interactive
+      end
+
+      def build_action_parameters
+        params = {
+          flow_message_version: '3',
+          flow_id: resolve(:flow_id),
+          flow_action: final_action,
+          mode: final_mode
+        }
+
+        resolve(:flow_cta)
+          .then { |label| params[:flow_cta] = label unless blank?(label) }
+
+        resolve(:flow_token)
+          .then { |token| params[:flow_token] = token unless blank?(token) }
+
+        if final_action == 'navigate'
+          payload = { screen: resolve(:screen) }
+          initial = resolve(:data)
+          payload[:data] = initial unless blank?(initial)
+          params[:flow_action_payload] = payload
+        end
+
+        params
+      end
+
+      def final_action
+        explicit = raw_value(:flow_action)
+        return explicit.to_s unless blank?(explicit)
+
+        resolve(:data_exchange) ? 'data_exchange' : 'navigate'
+      end
+
+      def final_mode
+        explicit = raw_value(:mode)
+        return explicit.to_s unless blank?(explicit)
+
+        resolve(:draft) ? 'draft' : 'published'
+      end
+
+      def validate!
+        validates :flow_id, required: true
+        validates :body,    required: true
+
+        validates :screen,
+                  required: -> { final_action == 'navigate' },
+                  message: 'screen is required for flow_action=navigate'
       end
     end
   end

data/lib/warb/resources/helpers/header.rb

@@ -0,0 +1,35 @@
+module Warb
+  module Resources
+    module Helpers
+      module Header
+        def add_text_header(content: nil, message: nil, text: nil, parameter_name: nil, &block)
+          add_header(Warb::Resources::Text.new(content:, message:, text:, parameter_name:), &block)
+        end
+
+        def add_image_header(media_id: nil, link: nil, &block)
+          add_header(Warb::Resources::Image.new(media_id:, link:), &block)
+        end
+
+        def add_document_header(media_id: nil, link: nil, filename: nil, &block)
+          add_header(Warb::Resources::Document.new(media_id:, link:, filename:), &block)
+        end
+
+        def add_video_header(media_id: nil, link: nil, &block)
+          add_header(Warb::Resources::Video.new(media_id:, link:), &block)
+        end
+
+        def add_location_header(latitude: nil, longitude: nil, address: nil, name: nil, &block)
+          add_header(Warb::Resources::Location.new(latitude:, longitude:, address:, name:), &block)
+        end
+
+        private
+
+        def add_header(instance, &)
+          @header = instance
+
+          block_given? ? @header.tap(&) : @header
+        end
+      end
+    end
+  end
+end

data/lib/warb/resources/image.rb

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

data/lib/warb/resources/interactive_call_to_action_url.rb

@@ -5,11 +5,12 @@ module Warb
     class InteractiveCallToActionUrl < Resource
       attr_accessor :header, :body, :footer, :action
 
+      # rubocop:disable Metrics/MethodLength
       def build_payload
         {
-          type: "interactive",
+          type: 'interactive',
           interactive: {
-            type: "cta_url",
+            type: 'cta_url',
             header: header || @params[:header]&.to_h,
             body: {
               text: body || @params[:body]
@@ -21,27 +22,28 @@ module Warb
           }
         }
       end
+      # rubocop:enable Metrics/MethodLength
 
-      def set_text_header(text)
+      def add_text_header(text)
         @header = Warb::Resources::Text.new(text:).build_header
       end
 
-      def set_image_header(link: nil)
+      def add_image_header(link: nil)
         @header = Warb::Resources::Image.new(link:).build_header
       end
 
-      def set_video_header(link: nil)
+      def add_video_header(link: nil)
         @header = Warb::Resources::Video.new(link:).build_header
       end
 
-      def set_document_header(link: nil, filename: nil)
+      def add_document_header(link: nil, filename: nil)
         @header = Warb::Resources::Document.new(link:, filename:).build_header
       end
 
-      def build_action(**params, &block)
+      def build_action(**params, &)
         @action = Warb::Components::CTAAction.new(**params)
 
-        block_given? ? @action.tap(&block) : @action
+        block_given? ? @action.tap(&) : @action
       end
     end
   end

data/lib/warb/resources/interactive_list.rb

@@ -5,11 +5,12 @@ module Warb
     class InteractiveList < Resource
       attr_accessor :header, :body, :footer, :action
 
+      # rubocop:disable Metrics/MethodLength
       def build_payload
         {
-          type: "interactive",
+          type: 'interactive',
           interactive: {
-            type: "list",
+            type: 'list',
             header: header || @params[:header]&.to_h,
             body: {
               text: body || @params[:body]
@@ -21,15 +22,16 @@ module Warb
           }
         }
       end
+      # rubocop:enable Metrics/MethodLength
 
-      def set_text_header(text)
+      def add_text_header(text)
         @header = Warb::Resources::Text.new(text:).build_header
       end
 
-      def build_action(**params, &block)
+      def build_action(**params, &)
         @action = Warb::Components::ListAction.new(**params)
 
-        block_given? ? @action.tap(&block) : @action
+        block_given? ? @action.tap(&) : @action
       end
     end
   end