Sends invoice to email (#262)

* Sends invoice to email * Added api to send invoice email
saeloun · Apr 18, 2022 · 2e7c5e7 · 2e7c5e7
1 parent ed2f1c4
commit 2e7c5e7
Show file tree

Hide file tree

Showing 14 changed files with 210 additions and 1 deletion.
diff --git a/app/controllers/internal_api/v1/invoices_controller.rb b/app/controllers/internal_api/v1/invoices_controller.rb
@@ -42,6 +42,14 @@ def update
     }
   end
 
+  def send_invoice
+    authorize invoice
+
+    invoice.send_to_email(subject: invoice_email_params[:subject], recipients: invoice_email_params[:recipients])
+
+    render json: { message: "Invoice will be sent!" }, status: :accepted
+  end
+
   private
 
     def load_client
@@ -58,4 +66,8 @@ def invoice_params
         policy(Invoice).permitted_attributes
       )
     end
+
+    def invoice_email_params
+      params.require(:invoice_email).permit(:subject, :body, recipients: [])
+    end
 end
diff --git a/app/mailers/invoice_mailer.rb b/app/mailers/invoice_mailer.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class InvoiceMailer < ApplicationMailer
+  after_action -> { @invoice.sent! }
+
+  def invoice
+    @invoice = params[:invoice]
+    recipients = params[:recipients]
+    subject = params[:subject]
+
+    mail(to: recipients, subject:)
+  end
+end
diff --git a/app/models/concerns/invoice_sendable.rb b/app/models/concerns/invoice_sendable.rb
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module InvoiceSendable
+  extend ActiveSupport::Concern
+
+  def send_to_email(subject:, recipients:)
+    InvoiceMailer.with(invoice: self, subject:, recipients:).invoice.deliver_later
+  end
+end
diff --git a/app/models/invoice.rb b/app/models/invoice.rb
@@ -29,6 +29,8 @@
 # frozen_string_literal: true
 
 class Invoice < ApplicationRecord
+  include InvoiceSendable
+
   attr_accessor :sub_total
 
   enum status: [

diff --git a/app/policies/invoice_policy.rb b/app/policies/invoice_policy.rb
@@ -17,6 +17,10 @@ def show?
     user_owner_or_admin?
   end
 
+  def send_invoice?
+    user_owner_or_admin?
+  end
+
   def permitted_attributes
     [
       :issue_date, :due_date,

diff --git a/app/views/invoice_mailer/invoice.html.erb b/app/views/invoice_mailer/invoice.html.erb
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <h1>Invoice: <%= @invoice.invoice_number %></h1>
+
+    <p>
+      Hi <%= @invoice.client_name %>, You have an invoice with amount <%= @invoice.amount %>.
+    </p>
+
+    <p>
+      The due date is <%= @invoice.due_date %>.
+    </p>
+
+    <p>Thanks!</p>
+  </body>
+</html>
diff --git a/app/views/invoice_mailer/invoice.text.erb b/app/views/invoice_mailer/invoice.text.erb
@@ -0,0 +1,8 @@
+Hi, <%= @invoice.client_name %>
+===============================================
+
+You have an invoice - <%= @invoice.invoice_number %> with amount <%= @invoice.amount %>
+due date is: <%= @invoice.due_date %>.
+
+Thanks!
+Miru
diff --git a/config/environments/test.rb b/config/environments/test.rb
@@ -45,6 +45,8 @@
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
 
+  config.active_job.queue_adapter = :test
+
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 

diff --git a/config/routes/internal_api.rb b/config/routes/internal_api.rb
@@ -13,7 +13,9 @@
     resources :timesheet_entry, only: [:index, :create, :update, :destroy]
     resources :reports, only: [:index]
     resources :workspaces, only: [:update]
-    resources :invoices, only: [:index, :create, :update]
+    resources :invoices, only: [:index, :create, :update] do
+      post :send_invoice, on: :member
+    end
     resources :generate_invoice, only: [:index, :show]
     resources :project_members, only: [:update]
     resources :company_users, only: [:index]

diff --git a/spec/mailers/invoice_mailer_spec.rb b/spec/mailers/invoice_mailer_spec.rb
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe InvoiceMailer, type: :mailer do
+  describe "invoice" do
+    let(:invoice) { create :invoice }
+    let(:recipients) { [invoice.client.email, "miru@example.com"] }
+    let(:subject) { "Invoice (#{invoice.invoice_number}) due on #{invoice.due_date}" }
+    let(:mail) { InvoiceMailer.with(invoice:, subject:, recipients:).invoice }
+
+    it "renders the headers" do
+      expect(mail.subject).to eq(subject)
+      expect(mail.to).to eq(recipients)
+      expect(mail.from).to eq(["from@example.com"])
+    end
+
+    it "renders the body" do
+      expect(mail.body.encoded).to match("You have an invoice")
+    end
+  end
+end
diff --git a/spec/mailers/previews/invoice_preview.rb b/spec/mailers/previews/invoice_preview.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Preview all emails at http://localhost:3000/rails/mailers/invoice
+
+class InvoicePreview < ActionMailer::Preview
+  def invoice
+    invoice = Invoice.first
+    recipients = [invoice.client.email, "miru@example.com"]
+    subject = "Invoice (#{invoice.invoice_number}) due on #{invoice.due_date}"
+
+    InvoiceMailer.with(invoice:, recipients:, subject:).invoice
+  end
+end
diff --git a/spec/models/invoice_spec.rb b/spec/models/invoice_spec.rb
@@ -114,4 +114,14 @@
   describe ".delegate" do
     it { is_expected.to delegate_method(:name).to(:client).with_prefix(:client) }
   end
+
+  describe ".send_to_email" do
+    let(:invoice) { create :invoice }
+    let(:recipients) { [invoice.client.email, "miru@example.com"] }
+    let(:subject) { "Invoice (#{invoice.invoice_number}) due on #{invoice.due_date}" }
+
+    it "sends the invoice on email" do
+      expect { invoice.send_to_email(subject:, recipients:) }.to have_enqueued_mail(InvoiceMailer, :invoice)
+    end
+  end
 end
diff --git a/spec/requests/internal_api/v1/invoices/send_invoice_spec.rb b/spec/requests/internal_api/v1/invoices/send_invoice_spec.rb
@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "InternalApi::V1::Invoices#send_invoice", type: :request do
+  let(:client) { create :client_with_invoices }
+  let(:company) { client.company }
+  let(:invoice) { client.invoices.first }
+  let(:user) { create :user, current_workspace_id: company.id }
+
+  context "when user is signed in" do
+    before do
+      create(:company_user, company:, user:)
+    end
+
+    let(:invoice_email) do
+      { subject: "Some Subject", recipients: [client.email, "miru@example.com"], body: "You have an invoice!" }
+    end
+
+    context "when user is an admin" do
+      before do
+        user.add_role :admin, company
+        sign_in user
+      end
+
+      it "returns a 202 response" do
+        post send_invoice_internal_api_v1_invoice_path(id: invoice.id), params: { invoice_email: }
+
+        expect(response).to have_http_status :accepted
+        expect(json_response["message"]).to eq("Invoice will be sent!")
+      end
+
+      it "enqueues an email for delivery" do
+        expect do
+          post send_invoice_internal_api_v1_invoice_path(id: invoice.id), params: { invoice_email: }
+        end.to have_enqueued_mail(InvoiceMailer, :invoice)
+      end
+
+      context "when invoice doesn't exist" do
+        it "returns 404 response" do
+          post send_invoice_internal_api_v1_invoice_path(id: "random")
+
+          expect(response).to have_http_status :not_found
+          expect(json_response["errors"]).to eq "Couldn't find Invoice with 'id'=random"
+        end
+      end
+    end
+
+    context "when user is an employee" do
+      before do
+        user.add_role :employee, company
+        sign_in user
+      end
+
+      it "returns a 403 response" do
+        post send_invoice_internal_api_v1_invoice_path(id: invoice.id)
+
+        expect(response).to have_http_status(:forbidden)
+      end
+    end
+  end
+
+  context "when user is logged out" do
+    it "returns a 401 response" do
+      post send_invoice_internal_api_v1_invoice_path(id: invoice.id)
+
+      expect(response).to have_http_status(:unauthorized)
+      expect(json_response["error"]).to eq("You need to sign in or sign up before continuing.")
+    end
+  end
+end
diff --git a/spec/support/patch.rb b/spec/support/patch.rb
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This patches rspec-rails to support rails 7.0 https://github.com/rspec/rspec-rails/issues/2531
+module RSpec
+  module Rails
+    module Matchers
+      class HaveEnqueuedMail
+        def legacy_mail?(job)
+          defined?(ActionMailer::DeliveryJob) && job[:job] <= ActionMailer::DeliveryJob
+        end
+
+        def parameterized_mail?(job)
+          RSpec::Rails::FeatureCheck.has_action_mailer_parameterized? && job[:job] <= ActionMailer::MailDeliveryJob
+        end
+
+        def unified_mail?(job)
+          RSpec::Rails::FeatureCheck.has_action_mailer_unified_delivery? && job[:job] <= ActionMailer::MailDeliveryJob
+        end
+      end
+    end
+  end
+end