ledger_sync 1.1.3 → 1.3.1

data/lib/ledger_sync/adaptors/netsuite/operation/update.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative '../operation'
+
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      module Operation
+        class Update
+          include NetSuite::Operation::Mixin
+
+          private
+
+          def update_in_ledger
+            case response.status
+            when 200..299
+              LedgerSync::Result.Success(response)
+            else
+              failure(
+                Error::OperationError.new(
+                  operation: self,
+                  response: response
+                )
+              )
+            end
+          end
+
+          def find
+            resource.ledger_id = ledger_id
+
+            self.class.operations_module::Find.new(
+              adaptor: adaptor,
+              resource: resource
+            ).perform
+          end
+
+          def ledger_id
+            @ledger_id ||= response.headers['Location'].split('/').last
+          end
+
+          def operate
+            update_in_ledger
+              .and_then { success }
+          end
+
+          def response
+            ledger_hash = ledger_serializer.to_ledger_hash
+            ledger_hash.delete('entityId')
+
+            @response ||= adaptor.patch(
+              body: ledger_hash,
+              path: ledger_serializer.class.api_resource_path(resource: resource)
+            )
+          end
+
+          def success
+            find.and_then do |find_result|
+              super(
+                resource: find_result.resource,
+                response: response
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/netsuite/record/http_method.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+#
+# Parser for OpenAPI 3.0 data for a given record method
+#
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      module Record
+        class HTTPMethod
+          attr_reader :method,
+                      :parameters,
+                      :path,
+                      :raw,
+                      :summary
+
+          def initialize(method:, parameters:, path:, raw:, summary:)
+            @method = method
+            @parameters = parameters
+            @path = path
+            @raw = raw
+            @summary = summary
+          end
+
+          def self.new_from_hash(data:, method:, path:)
+            new(
+              method: method,
+              parameters: data['parameters'],
+              path: path,
+              raw: data,
+              summary: data['summary']
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/netsuite/record/metadata.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      module Record
+        #
+        # Helper class for retrieving record metadata:
+        # - available http_methods
+        # - record properties/attributes
+        #
+        class Metadata
+          BASE_PATH = 'metadata-catalog/record'
+
+          attr_reader :adaptor,
+                      :record
+
+          def initialize(adaptor:, record:)
+            @adaptor = adaptor
+            @record = record
+          end
+
+          def http_methods
+            @http_methods ||= begin
+              ret = []
+
+              http_methods_response.body['paths'].each do |path, path_data|
+                path_data.each do |method, method_data|
+                  ret << HTTPMethod.new_from_hash(
+                    data: method_data,
+                    method: method,
+                    path: path
+                  )
+                end
+              end
+
+              ret
+            end
+          end
+
+          def http_methods_response
+            @http_methods_response = begin
+              adaptor.get(
+                headers: {
+                  'Accept' => 'application/swagger+json'
+                },
+                path: "#{BASE_PATH}?select=#{record}"
+              )
+            end
+          end
+
+          def properties
+            @properties = properties_response.body['properties'].map do |key, data|
+              Property.new_from_hash(
+                data: data,
+                key: key
+              )
+            end
+          end
+
+          def properties_response
+            @properties_response = begin
+              adaptor.get(
+                headers: {
+                  'Accept' => 'application/swagger+json'
+                },
+                path: "#{BASE_PATH}/#{record}"
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/netsuite/record/property.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+#
+# Parser for OpenAPI 3.0 data for a given record method
+#
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      module Record
+        class Property
+          attr_reader :enum,
+                      :format,
+                      :key,
+                      :title,
+                      :type
+
+          def initialize(
+            enum: [],
+            format: nil,
+            key:,
+            title:,
+            type:
+          )
+
+            @enum = enum
+            @format = format
+            @key = key
+            @title = title
+            @type = type
+          end
+
+          def self.new_from_hash(data:, key:)
+            new(
+              enum: data['enum'],
+              format: data['format'],
+              key: key,
+              title: data['title'],
+              type: data['type']
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/netsuite/searcher.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      class Searcher < Adaptors::Searcher
+        include Mixins::OffsetAndLimitPaginationSearcherMixin
+
+        private
+
+        def default_offset
+          0
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/netsuite/token.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+# ref: https://docs.oracle.com/cloud/latest/netsuitecs_gs/NSATH/NSATH.pdf
+# ref: Search "The Signature for Web Services and RESTlets" in NetSuite documentation (must have an account)
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      class Token
+        DEFAULT_SIGNATURE_METHOD = 'HMAC-SHA256'
+        OAUTH_VERSION = '1.0'
+
+        attr_reader :body,
+                    :body_json_string,
+                    :consumer_key,
+                    :consumer_secret,
+                    :method,
+                    :signature_method,
+                    :token_id,
+                    :token_secret,
+                    :url
+
+        def initialize(body: {}, consumer_key:, consumer_secret:, method:, nonce: nil, signature_method: nil, timestamp: nil, token_id:, token_secret:, url:)
+          @body = body || {}
+          @body_json_string = body.to_json
+          @consumer_key = consumer_key
+          @consumer_secret = consumer_secret
+          @method = method.to_s.upcase
+          @nonce = nonce
+          @signature_method = signature_method || DEFAULT_SIGNATURE_METHOD
+          @timestamp = timestamp
+          @token_id = token_id
+          @token_secret = token_secret
+          @url = url
+        end
+
+        def alphanumerics
+          [*'0'..'9', *'A'..'Z', *'a'..'z']
+        end
+
+        def headers(realm:)
+          @headers ||= begin
+            authorization_parts = [
+              [:realm, realm],
+              [:oauth_consumer_key, escape(consumer_key)],
+              [:oauth_token, escape(token_id)],
+              [:oauth_signature_method, signature_method],
+              [:oauth_timestamp, timestamp],
+              [:oauth_nonce, escape(nonce)],
+              [:oauth_version, OAUTH_VERSION],
+              [:oauth_signature, escape(signature)]
+            ]
+
+            ret = {
+              'Authorization' => "OAuth #{authorization_parts.map { |k, v| "#{k}=\"#{v}\"" }.join(',')}"
+            }
+
+            ret
+          end
+        end
+
+        def nonce
+          @nonce ||= Array.new(20) { alphanumerics.sample }.join
+        end
+
+        def signature
+          @signature ||= compute_digest(signature_data_string)
+        end
+
+        # Ref: https://tools.ietf.org/html/rfc5849#section-3.4.1.3.2
+        def signature_data_string
+          @signature_data_string ||= begin
+            [
+              method,
+              escape(url_without_params),
+              escape(parameters_string)
+            ].join('&')
+          end
+        end
+
+        def signature_key
+          @signature_key ||= [
+            consumer_secret,
+            token_secret
+          ].join('&')
+        end
+
+        def timestamp
+          @timestamp ||= Time.now.to_i
+        end
+
+        private
+
+        def body_array
+          @body_array ||= body.to_param.split('&').map { |k| k.split('=').map { |v| unescape(v) } }
+        end
+
+        def compute_digest(str)
+          signer = Util::Signer.new(str: str)
+
+          case signature_method
+          when 'HMAC-SHA1'
+            signer.hmac_sha1(key: signature_key)
+          when 'HMAC-SHA256'
+            signer.hmac_sha256(key: signature_key)
+          end
+        end
+
+        def escape(val)
+          Util::Signer.escape(str: val.to_s)
+        end
+
+        def oauth_parameters_array
+          {
+            oauth_consumer_key: consumer_key,
+            oauth_nonce: nonce,
+            oauth_signature_method: signature_method,
+            oauth_timestamp: timestamp,
+            oauth_token: token_id,
+            oauth_version: OAUTH_VERSION
+          }.to_a
+        end
+
+        def parameters_string
+          @parameters_string ||= sorted_encoded_parameters
+                                 .map { |e| "#{e[0]}=#{e[1]}" }
+                                 .join('&')
+        end
+
+        def sorted_encoded_parameters
+          @sorted_encoded_parameters ||= url_params
+                                         .to_a
+                                         .concat(oauth_parameters_array)
+                                         .map { |k, v| [escape(k), escape(v)] }
+                                         .sort { |a, b| a <=> b }
+        end
+
+        def unescape(val)
+          Util::Signer.unescape(str: val.to_s)
+        end
+
+        def uri
+          @uri ||= URI(url)
+        end
+
+        def url_params
+          return {} if uri.query.nil?
+
+          @url_params ||= Hash[CGI.parse(uri.query).map { |k, v| [k, v.first] }]
+        end
+
+        def url_without_params
+          @url_without_params ||= begin
+            temp_url = uri.dup
+            temp_url.fragment = nil
+            temp_url.query = nil
+            temp_url.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/netsuite/vendor/ledger_deserializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      module Vendor
+        class LedgerDeserializer < NetSuite::LedgerSerializer
+          id
+
+          attribute ledger_attribute: :companyName,
+                    resource_attribute: :company_name
+
+          attribute ledger_attribute: :email,
+                    resource_attribute: :email
+
+          attribute ledger_attribute: :phone,
+                    resource_attribute: :phone_number
+
+          attribute ledger_attribute: :firstName,
+                    resource_attribute: :first_name
+
+          attribute ledger_attribute: :lastName,
+                    resource_attribute: :last_name
+
+          attribute ledger_attribute: :subsidiary,
+                    resource_attribute: :subsidiary,
+                    type: LedgerSerializerType::SubsidiaryType
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/netsuite/vendor/ledger_serializer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module NetSuite
+      module Vendor
+        class LedgerSerializer < NetSuite::LedgerSerializer
+          api_resource_type :vendor
+
+          attribute ledger_attribute: :companyName,
+                    resource_attribute: :company_name
+
+          attribute ledger_attribute: :entityId,
+                    resource_attribute: :external_id
+
+          attribute ledger_attribute: :externalId,
+                    resource_attribute: :external_id
+
+          attribute ledger_attribute: :email,
+                    resource_attribute: :email
+
+          attribute ledger_attribute: :firstName,
+                    resource_attribute: :first_name
+
+          attribute ledger_attribute: :lastName,
+                    resource_attribute: :last_name
+
+          attribute ledger_attribute: :subsidiary,
+                    resource_attribute: :subsidiary,
+                    type: LedgerSerializerType::SubsidiaryType
+        end
+      end
+    end
+  end
+end