lockstep_rails 0.3.22

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/lockstep_rails/engine.rb

@@ -0,0 +1,4 @@
+module LockstepRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/lockstep_rails/version.rb

@@ -0,0 +1,3 @@
+module LockstepRails
+  VERSION = "0.3.22"
+end

data/lib/lockstep_rails.rb

@@ -0,0 +1,5 @@
+require "lockstep_rails/engine"
+
+module LockstepRails
+  # Your code goes here...
+end

data/lib/tasks/lockstep_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lockstep_rails do
+#   # Task goes here
+# end

data/lib/tasks/update_api_schema.rake

@@ -0,0 +1,159 @@
+require "open-uri"
+require "json"
+require "pry"
+require "erb"
+
+task :update_api_schema do
+  # download_schema!
+  create_models
+end
+
+class SchemaBinding
+  attr_accessor :model_name, :fields, :belongs_to_relations, :has_many_relations
+
+  def initialize(model_name, fields, belongs_to_relations, has_many_relations)
+    self.model_name = model_name
+    self.fields = fields
+    self.belongs_to_relations = belongs_to_relations
+    self.has_many_relations = has_many_relations
+  end
+
+  def class_name
+    len = model_name.length
+    "#{model_name[0].upcase}#{model_name[1..len - 1]}".gsub("Model", "")
+  end
+
+  # Expose private binding() method.
+  def get_binding
+    binding()
+  end
+end
+
+SCHEMA_SWAGGER_URL = "https://api.lockstep.io/swagger/v1/swagger.json"
+SCHEMA_FILE_PATH = "app/platform_api/swagger.json"
+TEMPLATE = "app/platform_api/model_template.rb.erb"
+SCHEMA_PATH = "app/platform_api/schema"
+
+def download_schema!
+  open(SCHEMA_FILE_PATH, "wb") do |file|
+    file.truncate(0)
+    file << open(SCHEMA_SWAGGER_URL).read
+  end
+end
+
+def create_models
+  schema = JSON.parse(File.read(SCHEMA_FILE_PATH))
+  # models = schema["components"]["schemas"].keys
+  schema["components"]["schemas"].each do |schema_name, schema|
+    next unless schema["type"] == "object"
+    next unless schema["properties"].class.name == "Hash"
+
+    model_name = underscore(schema_name)
+
+    # models[model_name] = {
+    #   fields: {},
+    #   belongs_to_relations: {},
+    #   has_many_relations: {},
+    # }
+
+    fields = build_fields(schema_name, schema["properties"])
+    belongs_to_relations = build_belongs_to_relations(schema_name, schema["properties"])
+    has_many_relations = build_has_many_relations(schema_name, schema["properties"])
+
+    schema_binding = SchemaBinding.new(schema_name, fields, belongs_to_relations, has_many_relations)
+    renderer = ERB.new(File.read(TEMPLATE), nil, "-")
+    file_contents = renderer.result(schema_binding.get_binding)
+
+    open("#{SCHEMA_PATH}/#{model_name.gsub("_model", "")}.rb", "wb") do |f|
+      f.truncate(0)
+      f << file_contents
+    end
+  end
+end
+
+# types => ["array", "string", "boolean", "number", nil, "integer", "object"]
+# formats => [nil, "uuid", "date-time", "double", "int32", "uri", "date", "int64", "email", "float"]
+def schema_property_type(property)
+  return "Types::Params::DateTime" if property["type"] == "string" && property["format"] == "date-time"
+
+  nil
+end
+
+def underscore(camel_cased_word)
+  camel_cased_word.to_s.gsub(/::/, "/").
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+    gsub(/([a-z\d])([A-Z])/, '\1_\2').
+    tr("-", "_").
+    downcase
+end
+
+def class_name(name)
+  len = name.length
+  "Lockstep::#{name[0].upcase}#{name[1..len - 1]}".gsub("Model", "")
+end
+
+def build_fields(schema_name, properties)
+  fields = {}
+  properties.each do |property_name, property|
+    next if !property["items"].nil? and !property["items"]["$ref"].nil?
+
+    property["value_type"] = schema_property_type(property)
+    fields[underscore(property_name)] = property
+  end
+  fields
+end
+
+BELONGS_TO_RELATIONS = {
+  connection: {
+    keys: %w[customerId],
+    class_name: "Lockstep::Connection",
+    primary_key: :company_id,
+  },
+  account: {
+    keys: %w[companyId],
+    class_name: "Lockstep::Account",
+    primary_key: :company_id,
+  },
+  created_user: {
+    keys: %w[createdUserId],
+    class_name: "Lockstep::User",
+    primary_key: :user_id,
+  },
+  modified_user: {
+    keys: %w[modifiedUserId],
+    class_name: "Lockstep::User",
+    primary_key: :user_id,
+  },
+}
+
+def build_belongs_to_relations(schema_name, properties)
+  belongs_to_relations = {}
+  properties.each do |property_name, property|
+    BELONGS_TO_RELATIONS.each do |relation_name, config|
+      next unless config[:keys].include?(property_name)
+
+      belongs_to_relations[underscore(property_name).to_s.gsub("_id", "")] = { class_name: config[:class_name], primary_key: config[:primary_key], foreign_key: underscore(property_name) }
+      belongs_to_relations[underscore(relation_name)] = { class_name: config[:class_name], primary_key: config[:primary_key], foreign_key: underscore(property_name) }
+    end
+  end
+  belongs_to_relations
+end
+
+def build_has_many_relations(schema_name, properties)
+  has_many_relations = {}
+  properties.each do |property_name, property|
+    next unless property["type"] == "array"
+    next if property["items"].nil?
+    next if property["items"]["$ref"].nil?
+
+    ref = property["items"]["$ref"].split("/").last.gsub("Model", "")
+
+    case property_name
+    when "notes"
+      has_many_relations[underscore(property_name)] = { class_name: "Lockstep::Note", included: true, foreign_key: :object_key, polymorphic: { table_key: schema_name.gsub("Model", "") } }
+    else
+      has_many_relations[underscore(property_name)] = { class_name: "Schema::#{ref}", included: true }
+    end
+  end
+  has_many_relations
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: lockstep_rails
+version: !ruby/object:Gem::Version
+  version: 0.3.22
+platform: ruby
+authors:
+- Vivek AG
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails interface for Lockstep Platform API
+email:
+- vivek.a@finly.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/lockstep_rails_manifest.js
+- app/concepts/lockstep/active_records/association.rb
+- app/concepts/lockstep/api_record.rb
+- app/concepts/lockstep/api_records/scopes.rb
+- app/concepts/lockstep/client.rb
+- app/concepts/lockstep/error.rb
+- app/concepts/lockstep/exceptions.rb
+- app/concepts/lockstep/query.rb
+- app/concepts/lockstep/query_methods.rb
+- app/concepts/lockstep/relation_array.rb
+- app/helpers/types.rb
+- app/models/lockstep/account.rb
+- app/models/lockstep/connection.rb
+- app/models/lockstep/contact.rb
+- app/models/lockstep/customer_summary.rb
+- app/models/lockstep/invoice.rb
+- app/models/lockstep/invoice_summary.rb
+- app/models/lockstep/invoices/address.rb
+- app/models/lockstep/note.rb
+- app/models/lockstep/payment.rb
+- app/models/lockstep/payment_summary.rb
+- app/models/lockstep/user.rb
+- app/platform_api/model_template.rb.erb
+- app/platform_api/schema/action_result.rb
+- app/platform_api/schema/activity.rb
+- app/platform_api/schema/activity_fetch_result.rb
+- app/platform_api/schema/activity_stream_item.rb
+- app/platform_api/schema/activity_x_ref.rb
+- app/platform_api/schema/aging.rb
+- app/platform_api/schema/api_key.rb
+- app/platform_api/schema/api_key_fetch_result.rb
+- app/platform_api/schema/app_enrollment.rb
+- app/platform_api/schema/app_enrollment_custom_field.rb
+- app/platform_api/schema/app_enrollment_custom_field_fetch_result.rb
+- app/platform_api/schema/app_enrollment_fetch_result.rb
+- app/platform_api/schema/application.rb
+- app/platform_api/schema/application_fetch_result.rb
+- app/platform_api/schema/ar_aging_header_info.rb
+- app/platform_api/schema/ar_header_info.rb
+- app/platform_api/schema/assembly.rb
+- app/platform_api/schema/at_risk_invoice_summary.rb
+- app/platform_api/schema/at_risk_invoice_summary_fetch_result.rb
+- app/platform_api/schema/attachment.rb
+- app/platform_api/schema/attachment_fetch_result.rb
+- app/platform_api/schema/attachment_header_info.rb
+- app/platform_api/schema/batch_sync.rb
+- app/platform_api/schema/bulk_currency_conversion.rb
+- app/platform_api/schema/cashflow_report.rb
+- app/platform_api/schema/code_definition.rb
+- app/platform_api/schema/code_definition_fetch_result.rb
+- app/platform_api/schema/company.rb
+- app/platform_api/schema/company_fetch_result.rb
+- app/platform_api/schema/company_sync.rb
+- app/platform_api/schema/connector_info.rb
+- app/platform_api/schema/constructor_info.rb
+- app/platform_api/schema/contact.rb
+- app/platform_api/schema/contact_fetch_result.rb
+- app/platform_api/schema/contact_sync.rb
+- app/platform_api/schema/country.rb
+- app/platform_api/schema/country_fetch_result.rb
+- app/platform_api/schema/credit_memo_applied.rb
+- app/platform_api/schema/credit_memo_applied_fetch_result.rb
+- app/platform_api/schema/credit_memo_applied_sync.rb
+- app/platform_api/schema/credit_memo_invoice.rb
+- app/platform_api/schema/currency.rb
+- app/platform_api/schema/currency_fetch_result.rb
+- app/platform_api/schema/currency_rate.rb
+- app/platform_api/schema/custom_attribute_data.rb
+- app/platform_api/schema/custom_attribute_named_argument.rb
+- app/platform_api/schema/custom_attribute_typed_argument.rb
+- app/platform_api/schema/custom_field_definition.rb
+- app/platform_api/schema/custom_field_definition_fetch_result.rb
+- app/platform_api/schema/custom_field_sync.rb
+- app/platform_api/schema/custom_field_value.rb
+- app/platform_api/schema/custom_field_value_fetch_result.rb
+- app/platform_api/schema/customer_details.rb
+- app/platform_api/schema/customer_details_payment.rb
+- app/platform_api/schema/customer_summary.rb
+- app/platform_api/schema/customer_summary_fetch_result.rb
+- app/platform_api/schema/daily_sales_outstanding_report.rb
+- app/platform_api/schema/developer_account_submit.rb
+- app/platform_api/schema/email.rb
+- app/platform_api/schema/email_fetch_result.rb
+- app/platform_api/schema/erp.rb
+- app/platform_api/schema/erp_fetch_result.rb
+- app/platform_api/schema/erp_info.rb
+- app/platform_api/schema/erp_info_data.rb
+- app/platform_api/schema/event_info.rb
+- app/platform_api/schema/exception.rb
+- app/platform_api/schema/field_info.rb
+- app/platform_api/schema/financial_account.rb
+- app/platform_api/schema/financial_account_balance_history.rb
+- app/platform_api/schema/financial_account_balance_history_fetch_result.rb
+- app/platform_api/schema/financial_account_fetch_result.rb
+- app/platform_api/schema/financial_year_setting.rb
+- app/platform_api/schema/financial_year_setting_fetch_result.rb
+- app/platform_api/schema/invite.rb
+- app/platform_api/schema/invite_data.rb
+- app/platform_api/schema/invite_submit.rb
+- app/platform_api/schema/invoice.rb
+- app/platform_api/schema/invoice_address.rb
+- app/platform_api/schema/invoice_fetch_result.rb
+- app/platform_api/schema/invoice_history.rb
+- app/platform_api/schema/invoice_history_fetch_result.rb
+- app/platform_api/schema/invoice_line.rb
+- app/platform_api/schema/invoice_line_sync.rb
+- app/platform_api/schema/invoice_payment_detail.rb
+- app/platform_api/schema/invoice_summary.rb
+- app/platform_api/schema/invoice_summary_fetch_result.rb
+- app/platform_api/schema/invoice_sync.rb
+- app/platform_api/schema/lead.rb
+- app/platform_api/schema/member_info.rb
+- app/platform_api/schema/method_base.rb
+- app/platform_api/schema/method_info.rb
+- app/platform_api/schema/module.rb
+- app/platform_api/schema/module_handle.rb
+- app/platform_api/schema/note.rb
+- app/platform_api/schema/note_fetch_result.rb
+- app/platform_api/schema/parameter_info.rb
+- app/platform_api/schema/payment.rb
+- app/platform_api/schema/payment_applied.rb
+- app/platform_api/schema/payment_applied_fetch_result.rb
+- app/platform_api/schema/payment_applied_sync.rb
+- app/platform_api/schema/payment_detail.rb
+- app/platform_api/schema/payment_detail_fetch_result.rb
+- app/platform_api/schema/payment_detail_header.rb
+- app/platform_api/schema/payment_fetch_result.rb
+- app/platform_api/schema/payment_summary.rb
+- app/platform_api/schema/payment_summary_fetch_result.rb
+- app/platform_api/schema/payment_sync.rb
+- app/platform_api/schema/problem_details.rb
+- app/platform_api/schema/property_info.rb
+- app/platform_api/schema/provisioning.rb
+- app/platform_api/schema/provisioning_finalize_request.rb
+- app/platform_api/schema/provisioning_response.rb
+- app/platform_api/schema/risk_rate.rb
+- app/platform_api/schema/runtime_field_handle.rb
+- app/platform_api/schema/runtime_method_handle.rb
+- app/platform_api/schema/runtime_type_handle.rb
+- app/platform_api/schema/state.rb
+- app/platform_api/schema/state_fetch_result.rb
+- app/platform_api/schema/status.rb
+- app/platform_api/schema/struct_layout_attribute.rb
+- app/platform_api/schema/sync_entity_result.rb
+- app/platform_api/schema/sync_request.rb
+- app/platform_api/schema/sync_request_fetch_result.rb
+- app/platform_api/schema/sync_submit.rb
+- app/platform_api/schema/test_argument_exception.rb
+- app/platform_api/schema/test_timeout_exception.rb
+- app/platform_api/schema/transfer_owner.rb
+- app/platform_api/schema/transfer_owner_submit.rb
+- app/platform_api/schema/type.rb
+- app/platform_api/schema/type_info.rb
+- app/platform_api/schema/uri.rb
+- app/platform_api/schema/user_account.rb
+- app/platform_api/schema/user_account_fetch_result.rb
+- app/platform_api/schema/user_role.rb
+- app/platform_api/schema/user_role_fetch_result.rb
+- app/platform_api/schema/webhook.rb
+- app/platform_api/schema/webhook_fetch_result.rb
+- app/platform_api/schema/webhook_history_table_storage.rb
+- app/platform_api/schema/webhook_history_table_storage_fetch_result.rb
+- app/platform_api/swagger.json
+- config/routes.rb
+- lib/lockstep_rails.rb
+- lib/lockstep_rails/engine.rb
+- lib/lockstep_rails/version.rb
+- lib/tasks/lockstep_rails_tasks.rake
+- lib/tasks/update_api_schema.rake
+homepage: https://lockstep.io
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Rails interface for Lockstep Platform API
+test_files: []