rails-salesforce-connect 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97089920b2fbb007f340056f6eefee687bb36b49f014ce716ba5f7f6b6e0809
-  data.tar.gz: c63e6dfd969e9a40b45d6c8fc845342ad694341e38d6fa315add3fea13a47d19
+  metadata.gz: 6ad61d450dcdb23872b876fc2686f3fa0f81bcff71193b6114071336325ba82a
+  data.tar.gz: e2e316121c58fc32652f7c5a3d9dbea7356de4c3cb1caeac69f1814f0bcb0f66
 SHA512:
-  metadata.gz: 6b04c1335277396cafa230e7049ce1781dbf44ac2d3acc7d2a39390e4e02ed6fca1aafd774cf4de0f0387e6217446ddeab17df0eccb660aa46f930718fd54c82
-  data.tar.gz: '069cbf7dc202df66c95e8d3f4518e34f035256537992ff163912b6c1ddf0bd78df230438b6ec4419407d7ea317f11431e8499b099ec390ee460f791870989561'
+  metadata.gz: ccaab598ba67b116fb6db22fc21381a5cf38055a18061e68c3cc5135c3aa1fb4ac4edac43928b21eb20dd4a7e9c3b803e5bae338b16f4e5eaef63f427794cf75
+  data.tar.gz: edb3ef5bd8eae1c70199cb9332ae0a2a34df291e8ee873f61d6d4c20044368f6e1a336a00e0aebb4b7b962608c10a796f486cab7e177e7a30fa8d67600ee6bd7

data/Readme.md

@@ -5,16 +5,41 @@ This gem eases heroku-connect based integrations with salesforce for rails proje
 It provides:
 
  * A rails generator for commonly used salesforce models (`rails g connect:models`)
+ * An API client constructor for RestForce (`Connect::ApiAdapter`)
  * A concern, `Connect::Record`, to include in salesforce-connected activerecord models (`require 'connect/record'`)
  * 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.
+ * A rake task `salesforce:schema:dump[heroku-app-name]` to serialize your salesforce configuration to JSON
+ * A rake task `salesforce:schema:diff[old_file,new_file]` to compare two serialized salesforce configurations
 
 ## Usage
 
 Add to your gemfile:
 
+### Classes
+
+To use `Connect::ApiAdapter`, you must provide the following environment variables:
+
+ * SALESFORCE_REST_API_HOST
+ * SALESFORCE_REST_API_CLIENT_ID
+ * SALESFORCE_REST_API_CLIENT_SECRET
+ * SALESFORCE_REST_API_USERNAME
+ * SALESFORCE_REST_API_PASSWORD
+ * SALESFORCE_REST_API_SECURITY_TOKEN
+
+### Rake tasks
+
 `gem "rails-salesforce-connect"`
 
+To use `rake db:diff_schema` you must specify a connection string or HC_URL env var.
+For instance:
+
+`export HC_URL="$(heroku config:get DATABASE_URL)"`
+
+To use `rake salesforce:schema:dump`, you must provide one of:
+
+ * Environment variables for `Connect::ApiAdapter`, or
+ * A heroku app name, which the current machine is authorized to read environment variabes from, with those variables set.
 
 ## Status
 

data/lib/connect/api_adapter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Connect
+  class ApiAdapter
+
+    class << self
+      def describe(env=ENV)
+        client(env).describe
+      end
+
+      def client(env=ENV)
+        @client ||= Restforce.new(
+          api_version:    env.fetch('API_VERSION', "41.0"),
+          host:           env["SALESFORCE_REST_API_HOST"],
+          client_id:      env["SALESFORCE_REST_API_CLIENT_ID"],
+          client_secret:  env["SALESFORCE_REST_API_CLIENT_SECRET"],
+          username:       env["SALESFORCE_REST_API_USERNAME"],
+          password:       env["SALESFORCE_REST_API_PASSWORD"],
+          security_token: env["SALESFORCE_REST_API_SECURITY_TOKEN"],
+        )
+      end
+    end
+  end
+end

data/lib/connect/migration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support/concern'
 
 module Connect

data/lib/connect/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Connect::Railtie < Rails::Railtie
   rake_tasks do
     load 'tasks/diff_schema.rake'

data/lib/connect/record.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support/concern'
 
 module Connect
@@ -6,10 +7,12 @@ module Connect
 
     included do
       self.inheritance_column = 'rails_type'
-      self.primary_key = :sfid
 
       alias_attribute :created_at, :createddate
       alias_attribute :updated_at, :systemmodstamp
+
+      class_attribute :syncs_to_salesforce
+      validates :sfid, presence: true, unless: :syncs_to_salesforce?
     end
 
     class_methods do
@@ -21,6 +24,23 @@ module Connect
       def timestamp_attributes_for_update
         super << "systemmodstamp"
       end
+
+      def syncs_to_salesforce!
+        self.syncs_to_salesforce = true
+      end
+
+      # Lets you insert to salesforce tables from tests on an opt-in basis
+      def seeding_development_data
+        old_value = self.syncs_to_salesforce
+        self.syncs_to_salesforce = true
+        yield
+        self.syncs_to_salesforce = old_value
+      end
+    end
+
+    def readonly?
+      return false unless self.class.syncs_to_salesforce?
+      super
     end
 
     def synced?

data/lib/generators/connect/models_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Connect
   class ModelsGenerator < Rails::Generators::Base
 

data/lib/rails-salesforce-connect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Connect
 end

data/lib/tasks/diff_salesforce.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+namespace :salesforce do
+
+  namespace :schema do
+    desc "Save the salesforce schema for the given app"
+    task :dump, [:app_name] => [:environment] do |_t, args|
+      env = ENV
+      outfile = 'salesforce-schema.json'
+
+      if args[:app_name].present?
+        env = Dotenv::Parser.call(`heroku config --app #{args[:app_name]} --shell`)
+        raise "Error fetching heroku config for #{args[:app_name]}" unless $?.success?
+        outfile = "salesforce-schema-#{args[:app_name]}.json"
+      end
+
+      description = Salesforce::ApiAdapter.describe(env).group_by {|e| e["name"] }
+      description.each do |k, v|
+        raise "Expected name to be unique" unless v.one?
+        description[k] = v.first
+        description[k].delete("name")
+      end
+      File.write(
+        outfile,
+        JSON.pretty_generate(description)
+      )
+    end
+
+    desc "Diff two schema files against one another"
+    task :diff, [:old, :new] => [:environment] do |_t, args|
+      old_h = JSON.parse(File.read(args[:old]))
+      new_h = JSON.parse(File.read(args[:new]))
+
+      removed = old_h.keys - new_h.keys
+      added = new_h.keys - old_h.keys
+      diff = false
+      removed.each do |r|
+        puts "Removed object: #{r}"
+        diff = true
+      end
+      added.each do |a|
+        puts "Added object: #{a}"
+        diff = true
+      end
+
+      HashDiff.diff(old_h.except(*removed), new_h.except(*added)).each do |sym, key, old, new_val|
+        diff = true
+        case sym
+        when "~"
+          puts "Changed #{key} from #{old} to #{new_val}"
+        when "-"
+          puts "Removed #{key}"
+        when "+"
+          puts "Added #{key} = #{old}"
+        else
+          raise "Unknown HashDiff symbol '#{sym}', expected one of '~', '+' or '-'."
+        end
+      end
+
+      exit(1) if diff
+    end
+  end
+end

data/lib/tasks/diff_schema.rake

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 namespace :db do
   desc "Identify differences from your schema"
-  task :diff_schema, [:remote_connection_string] => [:environment] do |task, args|
+  task :dif_schema, [:remote_connection_string] => [:environment] do |task, args|
     require 'pg'
 
     sql = <<-SQL
@@ -25,48 +26,49 @@ namespace :db do
       ;
     SQL
 
-    remote_conn = args[:remote_connection_string] || ENV["HC_URL"] || fail(<<-MSG)
+    remote_conn = args[:remote_connection_string] || ENV["HC_URL"] || ENV["HEROKUCONNECT_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
+    remote = PG::Connection.new(remote_conn).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
+    remote.each {|c| c["character_maximum_length"] = c["character_maximum_length"].to_i }
+    local.each {|c| c["character_maximum_length"] = c["character_maximum_length"].to_i }
+
+    def format_column(c)
+      nul = (c["is_nullable"] == "YES")
+      length = c["character_maximum_length"] ? ", limit: #{c["character_maximum_length"]}" : ""
+      precision = c["numeric_precision"] ? ", precision: #{c["numeric_precision"]}" : ""
+      type = c["data_type"].inspect
+      type = ':string' if c["data_type"] == "character varying"
+      "_column :#{c["table_name"]}, :#{c["column_name"]}, #{type}, null: #{nul.to_s} #{length} #{precision}"
     end
 
-    if local.any?
+    local = local.map &method(:format_column)
+    remote = remote.map &method(:format_column)
+
+    if (local - remote).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}"
+      (local - remote).each do |c|
+        puts "remove" + c
       end
 
     end
 
-    if remote.any?
+    if (remote - local).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}"
+      (remote - local).each do |c|
+        puts "add" + c
       end
     end
-    abort "Differences found" if local.any? or remote.any?
+
+    abort "Differences found" if (local - remote).any? or (remote - local).any?
   end
 end

data/rails-salesforce-connect.gemspec

@@ -1,7 +1,7 @@
 # gem 'activerecord'
 Gem::Specification.new do |s|
   s.name        = 'rails-salesforce-connect'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   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"
@@ -13,4 +13,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "activerecord"
   s.add_runtime_dependency "rake"
   s.add_runtime_dependency "pg"
+  s.add_runtime_dependency "dotenv"
+  s.add_runtime_dependency "hashdiff"
+  s.add_runtime_dependency "restforce"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-salesforce-connect
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Daniel Heath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: hashdiff
+  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: restforce
+  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
@@ -64,11 +106,13 @@ files:
 - Gemfile
 - Rakefile
 - Readme.md
+- lib/connect/api_adapter.rb
 - 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_salesforce.rake
 - lib/tasks/diff_schema.rake
 - rails-salesforce-connect.gemspec
 homepage: https://github.com/reinteractive/rails-salesforce-connect