rails-salesforce-connect 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24d46e2a699ac425544c94272cce0fec1de9ac76427befc47693749f5d833b88
+  data.tar.gz: 49dd59365919bc269e7b1d06f5e2d59b92609df361e711a73a60b4a1640b2929
+SHA512:
+  metadata.gz: '085671312fc11e7d2a18f1578542afcf469dbcd3a028f795346a53134770cfd19534471920a3ca353de46770fb1fc5e5701f180b3a6c317409d4986bce279c9e'
+  data.tar.gz: 9efd38e2d532d0e1988d50249e177fa8c54b158ea03c20a032d04df95129dc286c0b584e0c2f0c02ce520e70942165503ac97841098a3916b25d04b33620ec18

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    rails-salesforce-connect (0.1.0)
+      activerecord
+      pg
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    pg (1.0.0)
+    rake (12.3.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails-salesforce-connect!
+
+BUNDLED WITH
+   1.16.1

data/Rakefile

@@ -0,0 +1 @@
+load './lib/tasks/diff_schema.rake'

data/Readme.md

@@ -0,0 +1,21 @@
+# Rails Salesforce Connect
+
+This gem eases heroku-connect based integrations with salesforce for rails projects.
+
+It provides:
+
+ * A rails generator for commonly used salesforce models
+ * A concern, `Connect::Record`, to include in salesforce-connected activerecord models
+ * A concern, `Connect::Migration`, for migrations which should only run in development (eg because heroku connect is managing the schema in production).
+ * A rake task `db:diff_schema` for describing the difference between your mapped fields in heroku and your local database.
+
+## Usage
+
+Add to your gemfile:
+
+`gem "rails-salesforce-connect"`
+
+
+## Status
+
+Alpha. This has been extracted from common code across couple of projects.

data/lib/connect/migration.rb

@@ -0,0 +1,14 @@
+require 'active_support/concern'
+
+module Connect
+  module Migration
+    extend ActiveSupport::Concern
+
+    # Skip running in production environments, since
+    # heroku connect manages those
+    def exec_migration(conn, direction)
+      super unless Rails.env.production?
+    end
+
+  end
+end

data/lib/connect/railtie.rb

@@ -0,0 +1,5 @@
+class Connect::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/diff_schema.rake'
+  end
+end

data/lib/connect/record.rb

@@ -0,0 +1,63 @@
+require 'active_support/concern'
+
+module Connect
+  module Record
+    extend ActiveSupport::Concern
+
+    included do
+      self.inheritance_column = 'rails_type'
+      self.primary_key = :sfid
+
+      alias_attribute :created_at, :createddate
+      alias_attribute :updated_at, :systemmodstamp
+    end
+
+    class_methods do
+      # Automatically update timestamps on save
+      def timestamp_attributes_for_create
+        super << "createddate"
+      end
+
+      def timestamp_attributes_for_update
+        super << "systemmodstamp"
+      end
+    end
+
+    def synced?
+      _hc_err.blank? && sfid.present?
+    end
+
+    def sync_failed?
+      _hc_err.present?
+    end
+
+    # Waits until salesforce allocates an SFID and syncs it back to heroku connect.
+    # Persistent failures can occur E.G. if there are duplication rules on the
+    # salesforce side.
+    def await_sync(timeout: 25, poll: 5, allocate_sfid_locally: !Rails.env.production?)
+      return true if synced?
+
+      if allocate_sfid_locally
+        update sfid: SecureRandom.base58(18)
+      else
+        begin
+          Timeout::timeout(timeout) do
+            loop do
+              sleep poll
+
+              if reload.synced?
+                break
+              end
+
+              return false if sync_failed? # Bail immediately if sync fails
+            end
+          end
+        rescue Timeout::Error
+          return false
+        end
+      end
+      true
+    end
+
+  end
+end

data/lib/generators/connect/models_generator.rb

@@ -0,0 +1,66 @@
+module Connect
+  class ModelsGenerator < Rails::Generators::Base
+
+    desc "Generates commonly used models for heroku connect"
+
+    class_option :module, type: :string, default: 'Salesforce'
+
+    def create_account
+      create_file "#{directory}/account.rb", <<-FILE
+  module #{modname}
+    class Account < ApplicationRecord
+      require 'connect/record'
+      include Connect::Record
+      self.table_name = "salesforce.account"
+
+      has_many :salesforce_contacts, class_name: "#{modname}::Contact",
+        foreign_key: :accountid, primary_key: :sfid, dependent: :nullify
+
+      has_one :salesforce_contract, class_name: "#{modname}::Contract",
+        foreign_key: :accountid, primary_key: :sfid, dependent: :nullify
+    end
+  end
+      FILE
+    end
+
+    def create_contact
+      create_file "#{directory}/contact.rb", <<-FILE
+  module #{modname}
+    class Contact < ApplicationRecord
+      require 'connect/record'
+      include Connect::Record
+      self.table_name = "salesforce.contact"
+
+      validates :email, presence: true, uniqueness: true
+
+      belongs_to :salesforce_account, class_name: "Salesforce::Account",
+        primary_key: :sfid, foreign_key: :accountid, optional: true
+    end
+  end
+      FILE
+    end
+
+    def create_contract
+      create_file "#{directory}/contract.rb", <<-FILE
+  module #{modname}
+    class Contract < ApplicationRecord
+      require 'connect/record'
+      include Connect::Record
+      self.table_name = "salesforce.contract"
+
+      belongs_to :salesforce_account, class_name: "Salesforce::Account",
+        primary_key: :sfid, foreign_key: :accountid
+    end
+  end
+      FILE
+    end
+
+    def modname
+      options['module']
+    end
+
+    def directory
+      "app/models/#{modname.underscore}"
+    end
+  end
+end

data/lib/rails-salesforce-connect.rb

@@ -0,0 +1,5 @@
+
+module Connect
+end
+
+require "connect/railtie" if defined?(Rails)

data/lib/tasks/diff_schema.rake

@@ -0,0 +1,72 @@
+namespace :db do
+  desc "Identify differences from your schema"
+  task :diff_schema, [:remote_connection_string] => [:environment] do |task, args|
+    require 'pg'
+
+    sql = <<-SQL
+      select
+        table_name,
+        column_name,
+        is_nullable,
+        data_type,
+        character_maximum_length,
+        numeric_precision
+      from
+        information_schema.columns
+      where
+        table_schema = 'salesforce' and
+        table_name != '_trigger_log_archive' and
+        table_name != '_trigger_log' and
+        table_name != '_sf_event_log' and
+        table_name != '_hcmeta'
+      order by
+        table_name,
+        ordinal_position
+      ;
+    SQL
+
+    remote_conn = args[:remote_connection_string] || ENV["HC_URL"] || fail(<<-MSG)
+      Must specify remote_connection_string or provide ENV[HC_URL].
+      Try
+        export HC_URL="$(heroku config:get DATABASE_URL)"
+
+    MSG
+    remote = PG::Connection.new(args[:remote_connection_string] || ENV["HC_URL"]).async_exec(sql).each.to_a
+    local = ApplicationRecord.connection.raw_connection.async_exec(sql).each.to_a
+
+    local.each do |column|
+      # Remove if it exists
+      if remote.delete(column)
+        # Same column exists in both.
+        local.delete(column)
+        next
+      end
+    end
+
+    if local.any?
+      puts "***************************************************"
+      puts "**      Extra columns locally not in remote      **"
+      puts "***************************************************"
+      local.each do |c|
+        nul = (c["is_nullable"] == "YES")
+        length = c["character_maximum_length"] ? ", length: #{c["character_maximum_length"]}" : ""
+        precision = c["numeric_precision"] ? ", precision: #{c["numeric_precision"]}" : ""
+        puts "remove_column :#{c["table_name"]}, :#{c["column_name"]}, #{c["data_type"].inspect}, null: #{nul.to_s}#{length}#{precision}"
+      end
+
+    end
+
+    if remote.any?
+      puts "***************************************************"
+      puts "** Extra columns on remote not available locally **"
+      puts "***************************************************"
+      remote.each do |c|
+        nul = (c["is_nullable"] == "YES")
+        length = c["character_maximum_length"] ? ", length: #{c["character_maximum_length"]}" : ""
+        precision = c["numeric_precision"] ? ", precision: #{c["numeric_precision"]}" : ""
+        puts "add_column :#{c["table_name"]}, :#{c["column_name"]}, #{c["data_type"].inspect}, null: #{nul.to_s} #{length} #{precision}"
+      end
+    end
+    abort "Differences found" if local.any? or remote.any?
+  end
+end

data/rails-salesforce-connect.gemspec

@@ -0,0 +1,16 @@
+# gem 'activerecord'
+Gem::Specification.new do |s|
+  s.name        = 'rails-salesforce-connect'
+  s.version     = '0.0.1'
+  s.licenses    = ['MIT']
+  s.summary     = "Tools for using heroku connect with rails"
+  s.description = "Base class for salesforce migrations, activerecord types; deduplication rules aware, and rake tasks to sync schema"
+  s.authors     = ["Daniel Heath"]
+  s.email       = 'daniel@heath.cc'
+  s.files       = `git ls-files`.lines.map( &:strip)
+  s.homepage    = 'https://github.com/reinteractive/rails-salesforce-connect'
+  s.metadata    = { "source_code_uri" => "https://github.com/reinteractive/rails-salesforce-connect" }
+  s.add_runtime_dependency "activerecord", '~> 0'
+  s.add_runtime_dependency "rake", '~> 0'
+  s.add_runtime_dependency "pg", '~> 0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rails-salesforce-connect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Heath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: Base class for salesforce migrations, activerecord types; deduplication
+  rules aware, and rake tasks to sync schema
+email: daniel@heath.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- lib/connect/migration.rb
+- lib/connect/railtie.rb
+- lib/connect/record.rb
+- lib/generators/connect/models_generator.rb
+- lib/rails-salesforce-connect.rb
+- lib/tasks/diff_schema.rake
+- rails-salesforce-connect.gemspec
+homepage: https://github.com/reinteractive/rails-salesforce-connect
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/reinteractive/rails-salesforce-connect
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Tools for using heroku connect with rails
+test_files: []