feat: #81 add webhooks for invoices (#106)

jdenquin · web-flow · commit a851fd8afb17 · 2022-04-26T16:27:23.000+02:00
* Add Webhook url to organizations, create Lago Http Client

* add sequential id into serializer

* fix last review

* fix spec
diff --git a/.dockerignore b/.dockerignore
@@ -1 +1,3 @@
-/tmp/*
+/tmp/*
+.rsa_private.pem
+.rsa_public.pem
diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml
@@ -25,6 +25,8 @@ jobs:
         with:
           ruby-version: 3.0.1
           bundler-cache: true
+      - name: Generate RSA keys
+        run: ./scripts/generate.rsa.sh
       - name: Set up database schema
         run: bin/rails db:schema:load
       - name: Run tests
diff --git a/.gitignore b/.gitignore
@@ -37,3 +37,6 @@
 
 # Ignore Simplecov coverage status
 /coverage/*
+
+.rsa_private.pem
+.rsa_public.pem
diff --git a/.rspec b/.rspec
@@ -1 +1 @@
---require spec_helper
+--require spec_helper
diff --git a/Dockerfile b/Dockerfile
@@ -14,6 +14,7 @@ RUN apk add --no-cache \
   nodejs \
   python2 \
   tzdata \
+  openssl \
   postgresql-dev
 
 RUN bundle config build.nokogiri --use-system-libraries &&\
diff --git a/Dockerfile.dev b/Dockerfile.dev
@@ -4,6 +4,7 @@ WORKDIR /app
 
 COPY ./Gemfile /app/Gemfile
 COPY ./Gemfile.lock /app/Gemfile.lock
+COPY ./scripts/generate.rsa.sh /app/scripts/generate.rsa.sh
 
 RUN apk add --no-cache \
   git \
@@ -15,9 +16,12 @@ RUN apk add --no-cache \
   python2 \
   tzdata \
   postgresql-dev \
+  openssl \
   gcompat
 
 RUN bundle config build.nokogiri --use-system-libraries &&\
  bundle install
 
-CMD ["./start.dev.sh"]
+RUN ./scripts/generate.rsa.sh
+
+CMD ["./scripts/start.dev.sh"]
diff --git a/app/jobs/send_webhook_job.rb b/app/jobs/send_webhook_job.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require Rails.root.join('lib/lago_http_client/lago_http_client')
+
+class SendWebhookJob < ApplicationJob
+  queue_as 'webhook'
+
+  retry_on LagoHttpClient::HttpError, wait: :exponentially_longer, attempts: 3
+
+  def perform(webhook_type, object)
+    case webhook_type
+    when :invoice
+      Webhooks::InvoicesService.new(object).call
+    else
+      raise NotImplementedError
+    end
+  end
+end
diff --git a/app/models/fee.rb b/app/models/fee.rb
@@ -32,4 +32,22 @@ def compute_vat
     self.vat_amount_cents = (amount_cents * vat_rate / 100).to_i
     self.vat_amount_currency = amount_currency
   end
+
+  def item_type
+    return 'charge' if charge_fee?
+
+    'subscription'
+  end
+
+  def item_code
+    return billable_metric.code if charge_fee?
+
+    subscription.plan.code
+  end
+
+  def item_name
+    return billable_metric.name if charge_fee?
+
+    subscription.plan.name
+  end
 end
diff --git a/app/models/organization.rb b/app/models/organization.rb
@@ -13,6 +13,7 @@ class Organization < ApplicationRecord
   before_create :generate_api_key
 
   validates :name, presence: true
+  validates :webhook_url, url: true, allow_nil: true
 
   private
 
diff --git a/app/serializers/v1/fee_serializer.rb b/app/serializers/v1/fee_serializer.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module V1
+  class FeeSerializer < ModelSerializer
+    def serialize
+      {
+        item: {
+          type: model.item_type,
+          code: model.item_code,
+          name: model.item_name,
+        },
+        amount_cents: model.amount_cents,
+        amount_currency: model.amount_currency,
+        vat_amount_cents: model.vat_amount_cents,
+        vat_amount_currency: model.vat_amount_currency,
+      }
+    end
+  end
+end
diff --git a/app/serializers/v1/invoice_serializer.rb b/app/serializers/v1/invoice_serializer.rb
@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module V1
+  class InvoiceSerializer < ModelSerializer
+    def serialize
+      payload = {
+        lago_id: model.id,
+        sequential_id: model.sequential_id,
+        from_date: model.from_date,
+        to_date: model.to_date,
+        issuing_date: model.issuing_date,
+        amount_cents: model.amount_cents,
+        amount_currency: model.amount_currency,
+        vat_amount_cents: model.vat_amount_cents,
+        vat_amount_currency: model.vat_amount_currency,
+        total_amount_cents: model.total_amount_cents,
+        total_amount_currency: model.total_amount_currency,
+      }
+
+      payload = payload.merge(customer) if include?(:customer)
+      payload = payload.merge(subscription) if include?(:subscription)
+      payload = payload.merge(fees) if include?(:fees)
+
+      payload
+    end
+
+    private
+
+    def customer
+      {
+        customer: ::V1::CustomerSerializer.new(model.customer).serialize,
+      }
+    end
+
+    def subscription
+      {
+        subscription: ::V1::SubscriptionSerializer.new(model.subscription).serialize,
+      }
+    end
+
+    def fees
+      ::CollectionSerializer.new(model.fees, ::V1::FeeSerializer, collection_name: 'fees').serialize
+    end
+  end
+end
diff --git a/app/serializers/v1/subscription_serializer.rb b/app/serializers/v1/subscription_serializer.rb
@@ -12,7 +12,7 @@ def serialize
         started_at: model.started_at,
         terminated_at: model.terminated_at,
         canceled_at: model.canceled_at,
-        created_at: model.created_at
+        created_at: model.created_at,
       }
     end
   end
diff --git a/app/services/invoices/create_service.rb b/app/services/invoices/create_service.rb
@@ -23,6 +23,8 @@ def create
 
         compute_amounts(invoice)
 
+        SendWebhookJob.perform_later(:invoice, invoice)
+
         result.invoice = invoice
       end
 
diff --git a/app/services/webhooks/base_service.rb b/app/services/webhooks/base_service.rb
@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'lago_http_client'
+
+module Webhooks
+  # NOTE: Abstract Service, should not be used directly
+  class BaseService
+    def initialize(object)
+      @object = object
+    end
+
+    def call
+      payload = object_serializer.serialize
+      payload.merge(webhook_type: webhook_type)
+
+      http_client = LagoHttpClient::Client.new(current_organization.webhook_url)
+      headers = generate_headers(payload)
+      http_client.post(payload, headers)
+    end
+
+    private
+
+    attr_reader :object
+
+    def object_serializer
+      # Empty
+    end
+
+    def current_organization
+      # Empty
+    end
+
+    def webhook_type
+      # Empty
+    end
+
+    def generate_headers(payload)
+      [
+        'X-Lago-Signature' => generate_signature(payload),
+      ]
+    end
+
+    def generate_signature(payload)
+      JWT.encode(
+        payload.to_json,
+        RsaPrivateKey,
+        'RS256',
+      )
+    end
+  end
+end
diff --git a/app/services/webhooks/invoices_service.rb b/app/services/webhooks/invoices_service.rb
@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Webhooks
+  class InvoicesService < Webhooks::BaseService
+    private
+
+    def current_organization
+      @current_organization ||= object.organization
+    end
+
+    def object_serializer
+      ::V1::InvoiceSerializer.new(
+        object,
+        root_name: 'invoice',
+        includes: %i[customer subscription fees],
+      )
+    end
+
+    def webhook_type
+      'invoice.created'
+    end
+  end
+end
diff --git a/app/validators/url_validator.rb b/app/validators/url_validator.rb
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class UrlValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, :url_invalid) unless url_valid?(value)
+  end
+
+  private
+
+  def url_valid?(url)
+    url = URI.parse(url)
+    url.is_a?(URI::HTTP) || url.is_a?(URI::HTTPS)
+  rescue StandardError
+    false
+  end
+end
diff --git a/config/application.rb b/config/application.rb
@@ -7,24 +7,10 @@
 Bundler.require(*Rails.groups)
 
 module LagoApi
-  # Application
   class Application < Rails::Application
-    # Initialize configuration defaults for originally generated Rails version.
-    config.load_defaults 7.0
-
-    # Configuration for the application, engines, and railties goes here.
-    #
-    # These settings can be overridden in specific environments using the files
-    # in config/environments, which are processed later.
-    #
-    # config.time_zone = "Central Time (US & Canada)"
-    # config.eager_load_paths << Rails.root.join("extras")
-
-    # Only loads a smaller set of middleware suitable for API only apps.
-    # Middleware like session, flash, cookies can be added back manually.
-    # Skip views, helpers and assets when generating a new resource.
+    config.load_defaults(7.0)
+    config.eager_load_paths << Rails.root.join('lib/lago_http_client')
     config.api_only = true
-
     config.active_job.queue_adapter = :sidekiq
   end
 end
diff --git a/config/environment.rb b/config/environment.rb
@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Load the Rails application.
-require_relative "application"
+require_relative 'application'
 
 # Initialize the Rails application.
 Rails.application.initialize!
diff --git a/config/initializers/rsa_keys.rb b/config/initializers/rsa_keys.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+if Rails.env.development? || Rails.env.test?
+  private_key_string = File.read(Rails.root.join('.rsa_private.pem'))
+  RsaPrivateKey = OpenSSL::PKey::RSA.new(private_key_string)
+  RsaPublicKey = RsaPrivateKey.public_key
+else
+  RsaPrivateKey = ENV['RSA_PRIVATE_KEY']
+  RsaPublicKey = ENV['RSA_PUBLIC_KEY']
+end
diff --git a/config/sidekiq.yml b/config/sidekiq.yml
@@ -5,6 +5,7 @@ queues:
   - default
   - clock
   - billing
+  - webhook
 
 production:
   concurrency: 10
diff --git a/db/migrate/20220425094657_add_webhook_url_to_organizations.rb b/db/migrate/20220425094657_add_webhook_url_to_organizations.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddWebhookUrlToOrganizations < ActiveRecord::Migration[7.0]
+  def change
+    add_column :organizations, :webhook_url, :string
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
diff --git a/lib/lago_http_client/lago_http_client.rb b/lib/lago_http_client/lago_http_client.rb
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+require 'lago_http_client/client'
+require 'lago_http_client/http_error'
+
+module LagoHttpClient; end
diff --git a/lib/lago_http_client/lago_http_client/client.rb b/lib/lago_http_client/lago_http_client/client.rb
diff --git a/lib/lago_http_client/lago_http_client/http_error.rb b/lib/lago_http_client/lago_http_client/http_error.rb
diff --git a/scripts/generate.rsa.sh b/scripts/generate.rsa.sh
diff --git a/scripts/start.dev.sh b/scripts/start.dev.sh
diff --git a/spec/jobs/send_webhook_job_spec.rb b/spec/jobs/send_webhook_job_spec.rb
diff --git a/spec/models/organization_spec.rb b/spec/models/organization_spec.rb
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
diff --git a/spec/services/invoices/create_service_spec.rb b/spec/services/invoices/create_service_spec.rb
diff --git a/spec/services/webhooks/invoices_service_spec.rb b/spec/services/webhooks/invoices_service_spec.rb

-Original file line number
+Diff line change
@@ @@ -1 +1,3 @@ @@
 -/tmp/*
 +/tmp/*
 +.rsa_private.pem
 +.rsa_public.pem
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`---require spec_helper`
	`1`	`+--require spec_helper`