ledger_sync 1.1.3 → 1.3.1

data/lib/ledger_sync/adaptors/quickbooks_online/webhook.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'webhook_event'
+
+# ref: https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications#validating-the-notification
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      class Webhook
+        attr_reader :notifications,
+                    :original_payload,
+                    :payload
+
+        def initialize(payload:)
+          @original_payload = payload
+          @payload = payload.is_a?(String) ? JSON.parse(payload) : payload
+
+          event_notifications_payload = @payload.dig('eventNotifications')
+          raise 'Invalid payload: Could not find eventNotifications' unless event_notifications_payload.is_a?(Array)
+
+          @notifications = []
+
+          event_notifications_payload.each do |event_notification_payload|
+            @notifications << WebhookNotification.new(
+              payload: event_notification_payload,
+              webhook: self
+            )
+          end
+        end
+
+        def events
+          notifications.map(&:events)
+        end
+
+        def resources
+          @resources ||= notifications.map(&:resources).flatten.compact
+        end
+
+        def valid?(signature:, verification_token:)
+          self.class.valid?(
+            payload: payload.to_json,
+            signature: signature,
+            verification_token: verification_token
+          )
+        end
+
+        def self.valid?(payload:, signature:, verification_token:)
+          raise 'Cannot verify non-String payload' unless payload.is_a?(String)
+
+          digest = OpenSSL::Digest.new('sha256')
+          hmac = OpenSSL::HMAC.digest(digest, verification_token, payload)
+          base64 = Base64.encode64(hmac).strip
+          base64 == signature
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/webhook_event.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# ref: https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications#validating-the-notification
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      class WebhookEvent
+        attr_reader :deleted_id,
+                    :event_operation,
+                    :last_updated_at,
+                    :ledger_id,
+                    :original_payload,
+                    :payload,
+                    :quickbooks_online_resource_type,
+                    :webhook_notification,
+                    :webhook
+
+        def initialize(payload:, webhook_notification: nil)
+          @original_payload = payload
+          @payload = payload.is_a?(String) ? JSON.parse(payload) : payload
+
+          @deleted_id = @payload.dig('deletedId')
+
+          @event_operation = @payload.dig('operation')
+          raise 'Invalid payload: Could not find operation' if @event_operation.blank?
+
+          @last_updated_at = @payload.dig('lastUpdated')
+          raise 'Invalid payload: Could not find lastUpdated' if @last_updated_at.blank?
+
+          @last_updated_at = Time.parse(@last_updated_at)
+
+          @ledger_id = @payload.dig('id')
+          raise 'Invalid payload: Could not find id' if @ledger_id.blank?
+
+          @quickbooks_online_resource_type = @payload.dig('name')
+          raise 'Invalid payload: Could not find name' if @quickbooks_online_resource_type.blank?
+
+          @webhook_notification = webhook_notification
+          @webhook = webhook_notification.try(:webhook)
+        end
+
+        def find(adaptor:)
+          find_operation(adaptor: adaptor).perform
+        end
+
+        def find_operation(adaptor:)
+          find_operation_class(adaptor: adaptor).new(
+            adaptor: adaptor,
+            resource: resource_class.new(ledger_id: ledger_id)
+          )
+        end
+
+        def find_operation_class(adaptor:)
+          adaptor.class.base_operation_module_for(resource_class: resource_class)::Find
+        end
+
+        def local_resource_type
+          @local_resource_type ||= resource_class.resource_type
+        end
+
+        def resource
+          return unless resource_class.present?
+
+          resource_class.new(ledger_id: ledger_id)
+        end
+
+        def resource!
+          raise "Resource class does not exist for QuickBooks Online object: #{quickbooks_online_resource_type}" if resource.nil?
+
+          resource
+        end
+
+        def resource_class
+          @resource_class ||= Adaptor.resource_from_ledger_type(type: quickbooks_online_resource_type.downcase)
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/webhook_notification.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'webhook_event'
+
+# ref: https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications#validating-the-notification
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      class WebhookNotification
+        attr_reader :events,
+                    :original_payload,
+                    :payload,
+                    :realm_id,
+                    :webhook
+
+        def initialize(payload:, webhook: nil)
+          @original_payload = payload
+          @payload = payload.is_a?(String) ? JSON.parse(payload) : payload
+
+          @realm_id = @payload.dig('realmId')
+          raise 'Invalid payload: Could not find realmId' if @realm_id.blank?
+
+          events_payload = @payload.dig('dataChangeEvent', 'entities')
+          raise 'Invalid payload: Could not find dataChangeEvent -> entities' unless events_payload.is_a?(Array)
+
+          @events = []
+
+          events_payload.each do |event_payload|
+            @events << WebhookEvent.new(
+              payload: event_payload,
+              webhook_notification: self
+            )
+          end
+        end
+
+        def resources
+          @resources ||= events.map(&:resource).compact
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/request.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    class Request
+      attr_reader :body,
+                  :headers,
+                  :method,
+                  :response,
+                  :url
+
+      def initialize(body: nil, headers: {}, method: nil, url: nil)
+        @body = body
+        @headers = headers
+        @method = method
+        @url = url
+      end
+
+      def perform
+        raise 'Request already performed' if performed?
+
+        faraday_response = Faraday.send(method, url) do |req|
+          req.headers = headers
+          req.body = body.to_json unless body.nil?
+        end
+
+        @response = Response.new_from_faraday_response(faraday_response: faraday_response, request: self)
+        @performed = true
+        @response
+      end
+
+      def performed?
+        @performed == true
+      end
+
+      def self.delete(**keywords)
+        new(keywords.merge(method: :delete))
+      end
+
+      def self.get(**keywords)
+        new(keywords.merge(method: :get))
+      end
+
+      def self.post(**keywords)
+        new(keywords.merge(method: :post))
+      end
+
+      def self.put(**keywords)
+        new(keywords.merge(method: :put))
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/response.rb

@@ -0,0 +1,55 @@
+module LedgerSync
+  module Adaptors
+    class Response
+      attr_reader :body,
+                  :headers,
+                  :raw,
+                  :request,
+                  :status
+
+      def initialize(body: nil, headers: {}, raw: nil, request:, status:)
+        @body = parse_json(body)
+        @headers = headers
+        @raw = raw
+        @request = request
+        @status = status
+      end
+
+      def failure?
+        !success?
+      end
+
+      def success?
+        (200..299).include?(status)
+      end
+
+      def self.new_from_faraday_response(faraday_response:, request:)
+        new(
+          body: faraday_response.body,
+          headers: faraday_response.headers,
+          raw: faraday_response,
+          request: request,
+          status: faraday_response.status
+        )
+      end
+
+      def self.new_from_oauth_response(oauth_response:, request:)
+        # Uses the same API
+        new_from_faraday_response(
+          faraday_response: oauth_response,
+          request: request
+        )
+      end
+
+      private
+
+      def parse_json(json)
+        return if json.nil?
+
+        JSON.parse(json)
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/searcher.rb

@@ -4,11 +4,13 @@ module LedgerSync
   module Adaptors
     class Searcher
       include SimplySerializable::Mixin
+      include Mixins::InferResourceClassMixin
+      include Mixins::InferLedgerSerializerMixin
 
       attr_reader :adaptor,
                   :query,
                   :pagination,
-                  :resources
+                  :request
 
       serialize only: %i[
         adaptor

data/lib/ledger_sync/adaptors/stripe/adaptor.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+
+module LedgerSync
+  module Adaptors
+    module Stripe
+      class Adaptor < LedgerSync::Adaptors::Adaptor
+        attr_reader :api_key
+
+        def initialize(
+          api_key:
+        )
+          @api_key = api_key
+        end
+
+        def url_for(resource:)
+          base_url = 'https://dashboard.stripe.com'
+          resource_path = case resource
+                          when LedgerSync::Customer
+                            "/customers/#{resource.ledger_id}"
+                          else
+                            raise Error::AdaptorError::UnknownURLFormat.new(
+                              adaptor: self,
+                              resource: resource
+                            )
+                          end
+
+          base_url + resource_path
+        end
+
+        def wrap_perform
+          ::Stripe.api_key = api_key
+          yield
+        ensure
+          ::Stripe.api_key = nil
+        end
+
+        def self.ledger_attributes_to_save
+          []
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/stripe/config.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+LedgerSync.register_adaptor(:stripe) do |config|
+  config.name = 'Stripe'
+  config.rate_limiting_wait_in_seconds = 60
+end

data/lib/ledger_sync/adaptors/stripe/customer/operations/create.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module Stripe
+      module Customer
+        module Operations
+          class Create < Stripe::Operation::Create
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:external_id).maybe(:string)
+                required(:ledger_id).value(:nil)
+                required(:email).maybe(:string)
+                required(:name).filled(:string)
+                required(:phone_number).maybe(:string)
+                optional(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+
+            private
+
+            def operate
+              stripe_customer = ::Stripe::Customer.create(
+                email: resource.email,
+                metadata: {
+                  external_id: resource.external_id
+                },
+                name: resource.name,
+                phone: resource.phone_number
+              )
+
+              resource.ledger_id = stripe_customer.id
+
+              success(
+                resource: resource,
+                response: stripe_customer
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/stripe/customer/operations/delete.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module Stripe
+      module Customer
+        module Operations
+          class Delete < Stripe::Operation::Delete
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:external_id).maybe(:string)
+                required(:ledger_id).filled(:string)
+                required(:email).maybe(:string)
+                required(:name).maybe(:string)
+                required(:phone_number).maybe(:string)
+                optional(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+
+            private
+
+            def operate
+              stripe_customer = ::Stripe::Customer.delete(resource.ledger_id)
+
+              success(
+                resource: resource,
+                response: stripe_customer
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/stripe/customer/operations/find.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module Stripe
+      module Customer
+        module Operations
+          class Find < Stripe::Operation::Find
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:external_id).maybe(:string)
+                required(:ledger_id).filled(:string)
+                optional(:email).maybe(:string)
+                optional(:name).maybe(:string)
+                optional(:phone_number).maybe(:string)
+                optional(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+
+            private
+
+            def operate
+              stripe_customer = ::Stripe::Customer.retrieve(
+                resource.ledger_id
+              )
+
+              resource.external_id = stripe_customer.metadata['external_id']
+              resource.email = stripe_customer.email
+              resource.name = stripe_customer.name
+              resource.phone_number = stripe_customer.phone
+
+              resource.ledger_id = stripe_customer.id
+
+              success(
+                resource: resource,
+                response: stripe_customer
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end