lockstep_rails 0.3.36 → 0.3.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05bd7ba3de1568889d934bc0160f923ecf173f1fe5f357856a9fc221d07fe039
-  data.tar.gz: 4a1458573f08c1b33aa11da01487df04ca403e9bff7f9e8039f723284e47f62b
+  metadata.gz: d5879e82b6ba39f2a29081df8b406a7941498eb55880a3e29266d27c29e2a915
+  data.tar.gz: 388b574fb28fbe6d43e2f6afca0b725cbcc87043893c6f9e36e70331411be6f7
 SHA512:
-  metadata.gz: 887d60f6868d2d525de634193da364ff24a86447d3b1e5616421d7c4ccefcb3c5b55d55c64ff3be0c7ec6f9ad94e794e3951ada7e0e9ffb3eef3834c4da6824f
-  data.tar.gz: 7adadb32cc6a971a5c9e4c816cd2e12f15aa85c845a73dab446f645cb1061d9f0f38d82da34b9d30cc3c0c84c161de4170d0cb5336b7e34c1309e981a37205da
+  metadata.gz: 1a195119cac110be1ebe2cb059eefb2601a70c83ca1ca28aa6671a32ba5fffa7aea25926a4fb88c44c579d2fa6d7d34d788d8401b2f1410080e83053dcd38ee6
+  data.tar.gz: 1672ecd3aa13b7d8b16aba27267fc0f210508740d3f57a06a1e3e3753cec1a8a38bdb2fba51a8ead77b4e084d4a1581f6d3f66dc3cb21d6ff186d5b1d00eeea3

data/README.md

@@ -61,6 +61,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 * Lockstep::ReportPayablesComingDueSummary
 * Lockstep::ApiKey
 * Lockstep::InvoiceAtRiskSummary
+* Lockstep::MagicLink
 
 ## ActiveModel Interfaces
 

data/app/concepts/lockstep/api_record.rb

@@ -544,6 +544,10 @@ module Lockstep
       query_builder.where(*args)
     end
 
+    def self.additional_query_params(args)
+      query_builder.additional_query_params(args)
+    end
+
     def self.execute
       query_builder.execute
     end

data/app/concepts/lockstep/client.rb

@@ -29,6 +29,13 @@ module Lockstep
       RequestStore.store[:lockstep_api_key]
     end
 
+    def self.set_internal_service_key(key)
+      RequestStore.store[:internal_service_key] = key
+    end
+
+    def internal_service_key
+      RequestStore.store[:internal_service_key]
+    end
 
     ##
     # Construct a new Lockstep API client targeting the specified server.
@@ -115,6 +122,7 @@ module Lockstep
       request["SdkType"] = 'Ruby'
       request["SdkVersion"] = '2022.4.32.0'
       request["MachineName"] = Socket.gethostname
+      request["LS-InternalService"] = internal_service_key if internal_service_key_set?
       body = body.to_json unless body.is_a?(String)
       request.body = body
 
@@ -155,6 +163,14 @@ module Lockstep
       request(:delete, path, {}, {})
     end
 
+    def post_magic_link(path, body: {}, params: {})
+      request(:post, path, body, params)
+    end
+
+    def internal_service_key_set?
+      !!internal_service_key
+    end
+
     def with_logger(&block)
       block.call
     end

data/app/concepts/lockstep/query.rb

@@ -51,6 +51,12 @@ class Lockstep::Query
     end
   end
 
+  def additional_query_params(args)
+    with_clone do
+      criteria[:additional_query_params] ||= args
+    end
+  end
+
   def convert_arg(arg)
     return arg.to_pointer if arg.is_a?(Lockstep::ApiRecord)
     return Lockstep::ApiRecord.to_date_object(arg) if arg.is_a?(Time) || arg.is_a?(Date)
@@ -198,6 +204,7 @@ class Lockstep::Query
     params.merge!({ :include => criteria[:include].join(",") }) if criteria[:include]
     params.merge!({ :order => criteria[:order].join(",") }) if criteria[:order]
     params.merge!({ :pageSize => 2 }) if criteria[:count]
+    params.merge!(criteria[:additional_query_params]) if criteria[:additional_query_params]
     params.reject! { |k, v| v.blank? }
     params
   end

data/app/models/lockstep/customer_summary.rb

@@ -3,4 +3,9 @@ class Lockstep::CustomerSummary < Lockstep::ApiRecord
   self.id_ref = "company_id"
   self.query_path = ""
   load_schema(Schema::CustomerSummary)
+
+  def self.with_report_date(report_date)
+  	additional_query_params({"reportDate": report_date})
+  end
+
 end

data/app/models/lockstep/magic_link.rb

@@ -0,0 +1,10 @@
+class Lockstep::MagicLink < Lockstep::ApiRecord
+  self.model_name_uri = "v1/useraccounts/magic-links"
+  self.id_ref = "magicLinkId"
+  self.query_path = ""
+
+  def self.generate(email_id, expiry, app_id, user_role)
+    body = {email: email_id, expiresInMinutes: expiry, applicationId: app_id, userRole: user_role}
+    resource.post_magic_link('', body: body, params: {})
+  end
+end

data/app/models/lockstep/vendor_summary.rb

@@ -3,4 +3,9 @@ class Lockstep::VendorSummary < Lockstep::ApiRecord
   self.id_ref = "vendor_id"
   self.query_path = ""
   load_schema(Schema::VendorSummary)
+
+  def self.with_report_date(report_date)
+  	additional_query_params({"reportDate": report_date})
+  end
+
 end

data/app/platform_api/schema/ar_header_info.rb

@@ -5,9 +5,9 @@ def self.id_ref
   nil
 end
 
-  # The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this
-  # account will share the same GroupKey value.  GroupKey values cannot be changed once created.
-  # 
+  # The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this
+  # account will share the same GroupKey value.  GroupKey values cannot be changed once created.
+  # 
   # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
   # @type: string
   # @format: uuid
@@ -16,12 +16,7 @@ end
   # The date of the report
   # @type: string
   # @format: date
-  field :report_date
-
-  # The date of the report
-  # @type: string
-  # @format: uuid
-  field :company_id
+  field :report_period
 
   # The total number of customers.
   # @type: integer

data/lib/lockstep_rails/version.rb

@@ -1,3 +1,3 @@
 module LockstepRails
-  VERSION = "0.3.36"
+  VERSION = "0.3.37"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.36
+  version: 0.3.37
 platform: ruby
 authors:
 - Vivek AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -46,10 +46,8 @@ files:
 - app/concepts/lockstep/relation_array.rb
 - app/helpers/types.rb
 - app/models/lockstep/account.rb
-- app/models/lockstep/ap_header.rb
 - app/models/lockstep/api_key.rb
 - app/models/lockstep/app_enrollment.rb
-- app/models/lockstep/ar_header.rb
 - app/models/lockstep/connection.rb
 - app/models/lockstep/contact.rb
 - app/models/lockstep/customer_summary.rb
@@ -57,6 +55,7 @@ files:
 - app/models/lockstep/invoice_at_risk_summary.rb
 - app/models/lockstep/invoice_summary.rb
 - app/models/lockstep/invoices/address.rb
+- app/models/lockstep/magic_link.rb
 - app/models/lockstep/note.rb
 - app/models/lockstep/payment.rb
 - app/models/lockstep/payment_summary.rb
@@ -80,7 +79,6 @@ files:
 - app/platform_api/schema/activity_x_ref.rb
 - app/platform_api/schema/aging.rb
 - app/platform_api/schema/ap_aging_header_info.rb
-- app/platform_api/schema/ap_header_info.rb
 - app/platform_api/schema/api_key.rb
 - app/platform_api/schema/api_key_fetch_result.rb
 - app/platform_api/schema/app_enrollment.rb

data/app/models/lockstep/ap_header.rb

@@ -1,32 +0,0 @@
-class Lockstep::ApHeader < Lockstep::ApiRecord
-  self.model_name_uri = "v1/Reports/ap-header"
-  self.id_ref = "group_key"
-  self.query_path= ""
-  load_schema(Schema::ApHeaderInfo)
-
-end
-
-class Lockstep::Query
-  # Overriding the build_params method to just add attributes in params without filter option
-  def build_params
-    params = {}
-    criteria[:conditions].first.each do |key|
-      params.merge!({ :"#{key[0].to_s.camelize(:lower)}" => key[1] })
-    end
-    return params
-  end
-
-  # Overrinding the get_results method to parse the single object coming from v1.
-  def get_results(params = {})
-  resp = @klass.resource.get(@klass.query_path, :params => params)
-
-  return [] if %w(404).include?(resp.code.to_s)
-  # TODO handle non 200 response code. Throwing an exception for now
-  raise StandardError.new("#{resp.code} error while fetching: #{resp.body}") unless %w(201 200).include?(resp.code.to_s)
-
-  parsed_response = JSON.parse(resp.body)
-
-  r = parsed_response.transform_keys { |key| key.underscore }
-  @klass.model_name.to_s.constantize.new(r, false)
-  end
-end

data/app/models/lockstep/ar_header.rb

@@ -1,32 +0,0 @@
-class Lockstep::ArHeader < Lockstep::ApiRecord
-  self.model_name_uri = "v1/Reports/ar-header"
-  self.id_ref = "group_key"
-  self.query_path= ""
-  load_schema(Schema::ArHeaderInfo)
-
-end
-
-class Lockstep::Query
-  # Overriding the build_params method to just add attributes in params without filter option
-  def build_params
-    params = {}
-    criteria[:conditions].first.each do |key|
-      params.merge!({ :"#{key[0].to_s.camelize(:lower)}" => key[1] })
-    end
-    return params
-  end
-
-  # Overrinding the get_results method to parse the single object coming from v1.
-  def get_results(params = {})
-  resp = @klass.resource.get(@klass.query_path, :params => params)
-
-  return [] if %w(404).include?(resp.code.to_s)
-  # TODO handle non 200 response code. Throwing an exception for now
-  raise StandardError.new("#{resp.code} error while fetching: #{resp.body}") unless %w(201 200).include?(resp.code.to_s)
-
-  parsed_response = JSON.parse(resp.body)
-
-  r = parsed_response.transform_keys { |key| key.underscore }
-  @klass.model_name.to_s.constantize.new(r, false)
-  end
-end

data/app/platform_api/schema/ap_header_info.rb

@@ -1,148 +0,0 @@
-class Schema::ApHeaderInfo < Lockstep::ApiRecord
-
-# ApiRecord will crash unless `id_ref` is defined
-def self.id_ref
-  nil
-end
-
-  # The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this
-  # account will share the same GroupKey value.  GroupKey values cannot be changed once created.
-  # 
-  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
-  # @type: string
-  # @format: uuid
-  field :group_key
-
-  # The date of the report
-  # @type: string
-  # @format: date
-  field :report_date
-
-  # The date of the report
-  # @type: string
-  # @format: uuid
-  field :company_id
-
-  # The total number of vendors..
-  # @type: integer
-  # @format: int32
-  field :total_vendors
-
-  # The total number of bills.
-  # @type: integer
-  # @format: int32
-  field :total_bills
-
-  # The total amount billed.
-  # @type: number
-  # @format: double
-  field :total_billed_amount
-
-  # The total number of advance payments.
-  # @type: number
-  # @format: double
-  field :total_advance_payments
-
-  # The total amount paid.
-  # @type: number
-  # @format: double
-  field :total_paid
-
-  # The total accounts payable amount.
-  # @type: number
-  # @format: double
-  field :total_ap_amount
-
-  # The number of paid bills.
-  # @type: integer
-  # @format: int32
-  field :total_bills_paid
-
-  # The number of past due bills.
-  # @type: integer
-  # @format: int32
-  field :total_bills_past_due
-
-  # The number of bills 90+ days past due.
-  # @type: integer
-  # @format: int32
-  field :total_bills90_days_past_due
-
-  # The total amount past due.
-  # @type: number
-  # @format: double
-  field :total_past_due_amount
-
-  # The total amount for bills 90+ days past due.
-  # @type: number
-  # @format: double
-  field :total_past_due_amount90_days
-
-  # Portion of Total AP that is Past due.
-  # @type: number
-  # @format: double
-  field :percentage_of_total_ap
-
-  # The total amount billed, due this year.
-  # @type: number
-  # @format: double
-  field :total_billed_amount_current_year
-
-  # The total amount billed, due last year.
-  # @type: number
-  # @format: double
-  field :total_billed_amount_previous_year
-
-  # The total of all payments made this year.
-  # @type: number
-  # @format: double
-  field :total_paid_amount_current_year
-
-  # Portion of Total AP that is 90+ days Past due.
-  # @type: number
-  # @format: double
-  field :percentage_of_total_ap90_days_past_due
-
-  # The number of vendors who were paid within the past thirty days.
-  # @type: integer
-  # @format: int32
-  field :vendors_paid_past_thirty_days
-
-  # The total amount paid over the past thirty days.
-  # @type: number
-  # @format: double
-  field :amount_paid_past_thirty_days
-
-  # The amount in advance from the payments made over the past thirty days.
-  # @type: number
-  # @format: double
-  field :advance_payment_amount_past_thirty_days
-
-  # The number of bills paid over the past thirty days.
-  # @type: integer
-  # @format: int32
-  field :bills_paid_past_thirty_days
-
-  # The number of vendors that sent bills over the the past thirty days.
-  # @type: integer
-  # @format: int32
-  field :billing_vendors_past_thirty_days
-
-  # The total amount billed over the past thirty days.
-  # @type: number
-  # @format: double
-  field :amount_billed_past_thirty_days
-
-  # The amount outstanding on the bills received over the past thirty days.
-  # @type: number
-  # @format: double
-  field :amount_due_past_thirty_days
-
-  # The number of bills received over the past thirty days.
-  # @type: integer
-  # @format: int32
-  field :bills_past_thirty_days
-
-
-
-end