fn-salesforce 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56c8050e52f4dd1c6895fd3e89c12eeab60e8f19
+  data.tar.gz: 7ade6ae5a5a2fbaa5da19dd9d8de761b5e16e769
+SHA512:
+  metadata.gz: 94bde1299413a5afd4612cb0e632a54cc453a9fff90b0e2d493a71e1e4d19843cb495852a7694870f28839f421e83d8ced4196d4fba84d86fd56b6f1ef6a3ffe
+  data.tar.gz: c0a9885db5ac8165562a582854d252de327c23c7260cd11aa5c79f7597273335d928e383f0abe77177329ff4a7d5e99857ae3355a6783e8d4004ff23aded4505

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fn-salesforce.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,53 @@
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stuart Corbishley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# OpenFn Salesforce Adaptor
+
+*pre-release*
+
+CLI Tool and Adaptor for working with Salesforce.
+
+Intended to be used in conjunction with OpenFn, but has been designed
+with standalone use in mind.
+
+Leveraging JSON-Schema, fn-salesforce acts as a bridge between Salesforce
+and external data. It supports nested JSON data, and can resolve
+basic dependency graphs while providing access to intermediary data
+formats.
+
+
+Artifacts
+---------
+
+* **Credentials**  
+  In order to communicate with Salesforce, a set of API credentials should
+  be available at processing time.
+
+* **Destination Message**  
+  Generic JSON document provided to the Saleforce adaptor.
+
+* **Prepared Messages / Plan**
+  Intermediary JSON document used internally to represent the order and
+  the unfulfilled dependent values at the time of execution.
+
+  The array of objects received are assumed to be in a reliable order.
+
+* **Schema**
+  JSON Schema document used to assemble a plan, linking up the SObject names
+  with the relationship keys found on the destination message.
+
+- - -
+
+## prepare
+
+Flattens out a message into an array of objects to be sent to Salesforce.
+
+See the **push** interface below.
+
+```
+fn-salesforce prepare -v -s schema.json payload.json 1> plan.json
+```
+
+
+## push
+
+Using a prepared message, the push step sends the objects in order to
+Salesforce and fills in `$ref` values just in time.
+
+Example message:
+
+```js
+[
+  {
+    "sObject": "my__ObjectName__c",
+    "properties": {
+      "Id": "12345"
+    }
+  },
+  {
+    "sObject": "my__ObjectName__c",
+    "properties": {
+      "my__Custom_Reference__c": {
+        "$ref": "/0/properties/Id"
+      }
+    }
+  }
+]
+```
+
+`$ref` values use [JSON Pointers](https://tools.ietf.org/html/rfc6901)
+as a lookup value. At the time of resolving the reference, the message
+list will only contain the objects before it.
+
+If you need to look ahead, it's best solved in the original data source.
+So it's actually only useful in the scenario where it's impossible to know
+the value without talking to Salesforce first.
+
+The array of objects received are assumed to be in a reliable order.
+
+## describe
+
+Returns the object description from Salesforce.
+
+```
+$ fn-salesforce describe -c ./.credentials.json -v my__Custom_Object__c
+```
+
+It's a pretty big JSON document, so you will probably want to send it to
+a file using a redirect.
+
+`$ fn-salesforce describe ... 1>object_description.json`
+
+
+CLI
+---
+
+`$ fn-salesforce COMMAND [options] [subject]`
+
+There are a few switches used to configure the CLI client, every command
+needs login credentials to communicate with Salesforce.
+
+- `-c` `--credentials`  
+  Provide a credentials file for communicating with Salesforce.
+- `-v` `--verbose`  
+  Show extra detail when executing commands.
+
+`$ fn-salesforce push PAYLOAD`
+
+Process a JSON document and create Salesforce objects.
+
+Example
+
+`fn-salesforce push payload.json`
+
+`$ fn-salesforce describe OBJECT`
+
+Describes an object. Returns JSON by default.
+
+Example
+
+`fn-salesforce describe User`
+
+Tests
+-----
+
+`rspec`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fn-salesforce/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require "rake/notes/rake_task"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fn/salesforce"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/fn-salesforce

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'optparse'
+require 'fn/salesforce'
+require 'fn/salesforce/cli'
+
+options = {}
+
+base = OptionParser.new do |opts|
+  opts.banner = "Usage: fn-salesforce COMMAND [options] [subject]"
+
+  opts.separator ""
+  opts.separator <<HELP
+Commonly used command are:
+  push :     Push a JSON document to Salesforce
+  describe : Describe a Salesforce object
+  See 'fn-salesforce COMMAND --help' for more information on a specific command.
+HELP
+
+end
+
+commands = { 
+  prepare: OptionParser.new  { |opts|
+    opts.banner = "Usage: prepare [options] PAYLOAD"
+    opts.on("-sSCHEMA", "--schema SCHEMA", "JSON-Schema description of payload") do |n|
+      options[:schema] = n
+    end
+    opts.on("-v", "--verbose", "Enable verbose output") do |v|
+      options[:verbose] = v
+    end
+  },
+  push: OptionParser.new  { |opts|
+    opts.banner = "Usage: push [options] PLAN"
+    opts.on("-cCREDENTIALS", "--credentials CREDENTIALS", "API Credentials for Salesforce") do |f|
+      options[:credentials] = f
+    end
+    opts.on("-v", "--verbose", "Enable verbose output") do |v|
+      options[:verbose] = v
+    end
+  },
+  describe: OptionParser.new { |opts|
+    options[:format] = "json"
+
+    opts.banner = "Usage: describe [options] OBJECT"
+    opts.on("-cCREDENTIALS", "--credentials CREDENTIALS", "API Credentials for Salesforce") do |f|
+      options[:credentials] = f
+    end
+    opts.on("-f", "--format", "Output format (json, raw, schema)") do |f|
+      options[:format] = f
+    end
+    opts.on("-v", "--verbose", "Enable verbose output") do |v|
+      options[:verbose] = v
+    end
+  } 
+}
+
+command_key = (ARGV.shift || "").to_sym
+command = commands[command_key] || base
+
+command.parse!
+
+case command_key
+when :describe
+
+  options.merge!( {target:ARGV.slice(-1)} )
+  Fn::Salesforce::CLI.describe(options)
+
+when :push
+
+  options.merge!( {plan:ARGV.slice(-1)} )
+  Fn::Salesforce::CLI.push(options)
+
+when :prepare
+
+  options.merge!( {message:ARGV.slice(-1)} )
+  Fn::Salesforce::CLI.prepare(options)
+
+else
+  puts command
+end
+  
+

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/README.md

@@ -0,0 +1,85 @@
+Creating Child Objects
+======================
+
+In order to handle nested objects, we key the children by the relationship
+name.
+
+We need to make the schema available to the parser, so that the parent's ID
+can be placed in the correct field on the child record.
+
+```js
+{
+  "type" : "object",
+  "$schema" : "http://json-schema.org/draft-04/schema#",
+  "title" : "Test Event",
+  "properties" : {
+    "vera__Attendance__r" : {
+      "type" : "array",
+      "id" : "vera__Attendance__c"
+    },
+
+   // We can't rely on the key names as the destination objects location
+   // since an object may have multiple FK associations to the same object.
+   // So it's important that we key by the relationship.
+
+   // That means that we have to discover the object name for the given
+   // key.
+
+   // i.e. `vera__Boats__r` and `vera__Boats_Frilitanger__r` both
+   // are associated with `vera__Boat__c`, and have different FKs.
+
+    "vera__Boats__r" : {
+      // At this node we are reflecting the 'relationship'
+      "type" : "array",
+
+      // NOTE: This is likely to change.
+      //       Need to have a look around how other projects handle 'metadata'
+
+      // For now we can use the `foreignKey` handle to describe which key to use
+      // when the primary key is available.
+      "foreignKey" : "vera__Third_Event__c",
+      "sObject" :    "vera__Boat__c",
+
+
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "vera__Third_Event__c": { "type": "string" },
+          "vera__Boat_Maker__c":  { "type": "string" }
+        }
+      }
+    },
+
+
+    "vera__Boats_Frilitanger__r" : {
+      "type" : "array",
+      "id" : "vera__Boat__c",
+      "foreignKey" : "vera__Test_Event__c"
+    }
+  }
+}
+
+```
+
+Scenario
+--------
+
+**TODO: write out expectation around parsing against a schema**
+Given: foo schema, bar message
+When: parsing bar 
+Then: expect array of template ready objects, linked by reference.
+
+Using JSONPath style selectors, we inspect the embedded data on the schema for
+that given property.
+
+We use template string values to set up the child objects foreign key value.
+
+```js
+{ "vera__Third_Event__c": "{parent.Id}" }
+```
+
+The idea is to have perform parse and template the values out.
+
+The reasoning behind this 2 step approach is so that we test and review
+outputs without hitting the servers. A core focus for these tools is to assist
+in debugging and testing as much as possible.

data/fn-salesforce.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fn/salesforce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fn-salesforce"
+  spec.version       = Fn::Salesforce::VERSION
+  spec.authors       = ["Stuart Corbishley"]
+  spec.email         = ["corbish@gmail.com"]
+
+  spec.summary       = %q{Salesforce support adaptor for OpenFn}
+  spec.description = <<-EOF
+    CLI Tool and Adaptor for working with Salesforce.
+
+    Intended to be used in conjunction with OpenFn, but has been designed
+    with standalone use in mind.
+
+    Leveraging JSON-Schema, fn-salesforce acts as a bridge between Salesforce
+    and external data. It supports nested JSON data, and can resolve
+    basic dependency graphs while providing access to intermediary data
+    formats.
+  EOF
+  spec.homepage      = "https://github.com/stuartc/fn-salesforce"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = [ "fn-salesforce" ]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake-notes"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_dependency "restforce", "~> 2.1.0"
+  spec.add_dependency "jsonpath", "~> 0.5.7"
+  spec.add_dependency "hana", "~> 1.3.1"
+  spec.add_dependency "virtus", "~> 1.0.5"
+end

data/lib/fn/salesforce.rb

@@ -0,0 +1,84 @@
+require "json"
+require "fn/salesforce/version"
+require "fn/salesforce/environment"
+require "fn/salesforce/options"
+require "fn/salesforce/object"
+require "fn/salesforce/object_factory"
+require "fn/salesforce/walker"
+require "restforce"
+require "hana"
+
+module Fn
+  module Salesforce
+
+    # Push
+    # ----
+    # Takes a prepared payload, and sends it to Salesforce.
+    def self.push(credentials, message)
+
+      client = Restforce.new(credentials)
+      message.
+        inject([]) { |plan,obj| 
+
+        begin
+          obj["properties"].merge! obj["properties"].
+            map { |k,v| 
+            if v.is_a?(Hash) && v["$ref"]
+              v = Hana::Pointer.new(v["$ref"]).eval(plan)
+            end
+            [k,v]
+          }.
+          map { |i| Hash[*i] }.inject(&:merge)
+
+          $stderr.puts "Creating #{obj["sObject"]}: #{ obj["properties"] }"
+          id = client.create!(obj["sObject"], obj["properties"])
+
+          obj["properties"]["Id"] = id
+          plan.push obj
+
+        rescue Exception => e
+          $stderr.puts e
+          if plan.any?
+            $stderr.puts "Rolling back previous objects"
+            plan.each { |obj| 
+              id = obj["properties"]["Id"]
+              object = obj["sObject"]
+              $stderr.puts "Deleting #{object}##{id}"
+              client.destroy(object, id) 
+            }
+          end
+          break
+        end
+
+      }
+    end
+
+    # Prepare
+    # -------
+    # Unpack the message, and return a data object ready for sending.
+    def self.prepare(schema, message)
+      factory = Fn::Salesforce::ObjectFactory.new(schema)
+
+      raw_payload = []
+      Walker.parse(message) do |key, properties, parent|
+        obj = factory.create(key, properties, parent)
+        $stderr.puts obj
+        raw_payload << obj
+
+        raw_payload.index obj
+      end
+
+      raw_payload
+
+    end
+
+    # Describe
+    # --------
+    def self.describe(credentials, target)
+
+     client = Restforce.new(credentials)
+     client.describe(target)
+
+    end
+  end
+end

data/lib/fn/salesforce/cli.rb

@@ -0,0 +1,75 @@
+require 'pry-byebug'
+module Fn::Salesforce
+  class CLI
+    class << self
+
+      # TODO: Move options validation from bin to CLI class
+      def push(opts,schema,file)
+        begin
+          payload = JSON.parse(File.read(file))
+          schema = JSON.parse(File.read(schema))
+
+          pp Fn::Salesforce.push({}, schema, payload)
+
+        rescue => e
+          logger = Logger.new(STDERR)
+          logger.level = Logger::DEBUG
+          logger.error e
+          logger.debug e.backtrace.join("\n") if opts[:verbose]
+        ensure
+          exit(1)
+        end
+
+      end
+
+      def prepare(opts)
+        Environment.new(opts) do
+          logger.debug "Preparing"
+
+          prepare(schema, message) { |plan|
+            puts JSON.pretty_generate plan
+          }
+
+        end
+
+        exit(0)
+      end
+
+      def describe(opts)
+        Environment.new(opts) do
+          logger.debug "Describing: #{target}"
+          logger.debug "Credentials:"
+          logger.debug credentials
+
+          describe(credentials, target) { |description|
+            case format
+            when 'raw'
+              puts description
+            when 'json'
+              puts JSON.pretty_generate description
+            end
+          }
+
+        end
+
+        exit(0)
+      end
+
+      def push(opts)
+        Environment.new(opts) do
+          logger.debug "Pushing to Salesforce"
+          logger.debug "Credentials:"
+          logger.debug credentials
+
+          push(credentials, plan) { |results|
+            pp results
+          }
+
+        end
+
+        exit(0)
+      end
+
+    end
+  end
+end

data/lib/fn/salesforce/environment.rb

@@ -0,0 +1,75 @@
+# Fn Salesforce Environment
+# =========================
+#
+# Interface for performing operations, sets up the logger and provides
+# access to configuration objects.
+#
+# Since using the tool via the CLI and API requires slightly different 
+# handling for errors and feedback, this can be used to facilitate that.
+
+require 'logger'
+require 'forwardable'
+
+# Fn::Salesforce::Environment.new({schema: "SCHEMA"}) do
+#   begin
+#     prepare(schema, payload) { |plan|
+#       raise "hell"
+#     }
+#   rescue
+#     logger.error "Hello"
+#     exit(1)
+#   end
+# end
+
+class Fn::Salesforce::Environment
+  extend Forwardable
+  def_delegators :@options, :credentials, :schema, :payload, :target, 
+    :format, :message, :plan
+
+  attr_reader :logger
+
+  def initialize(options, &block)
+    @options = Fn::Salesforce::Options.new(options)
+    @logger = Logger.new(STDERR)
+    @logger.level = Logger::DEBUG
+
+    instance_eval &block
+    
+  end
+
+  # ## Prepare
+  # ```rb
+  # prepare(schema, payload) { |plan|
+  #   puts plan.inspect
+  #   logger.info plan.inspect
+  # }
+  # ```
+
+  def prepare(schema, payload, &block)
+    yield Fn::Salesforce.prepare(schema, payload)
+  end
+
+  # ## Describe
+  # ```rb
+  # describe(credentials, target) { |description|
+  #   pp description.inspect
+  # }
+  # ```
+
+  def describe(credentials, target, &block)
+    yield Fn::Salesforce.describe(credentials, target)
+  end
+
+  # ## Push
+  # ```rb
+  # push(credentials, plan) { |results|
+  #   pp results
+  # }
+  # ```
+
+  def push(credentials, plan, &block)
+    yield Fn::Salesforce.push(credentials, plan)
+  end
+
+end
+

data/lib/fn/salesforce/object.rb

@@ -0,0 +1,14 @@
+require 'virtus'
+
+class Fn::Salesforce::Object
+  include Virtus.model(:finalize => false)
+end
+
+class Fn::Salesforce::Object
+  attribute :sobject, String
+  attribute :parent, Fn::Salesforce::Object
+  attribute :properties, Hash
+
+end
+
+Virtus.finalize

data/lib/fn/salesforce/object_factory.rb

@@ -0,0 +1,37 @@
+# ObjectFactory
+# =============
+#
+# Factory class to help reconcile source data and the target schema.
+# 
+# By providing a JSON schema, that describes the relationships between 
+# objects when traversing the message structure, we can prepare an object
+# for sending.
+
+require 'jsonpath'
+
+class Fn::Salesforce::ObjectFactory
+
+  attr_reader :schema
+  def initialize(schema)
+    raise ArgumentError, "Schema must be a hash." unless schema.is_a? Hash
+    @schema = schema
+  end
+
+  def create(key, properties, parent=nil)
+    sobject = sobject_for(key) || key
+    properties.merge! Hash[foreign_key_for(key), {"$ref" => "/#{parent}/properties/Id"}] if parent
+
+    {
+      "sObject" => sobject,
+      "properties" => properties
+    }
+  end
+
+  def sobject_for(key)
+    JsonPath.on(schema,"..properties.#{key}.sObject").first
+  end
+
+  def foreign_key_for(relationship_key)
+    JsonPath.on(schema,"..properties.#{relationship_key}.foreignKey").first
+  end
+end

data/lib/fn/salesforce/options.rb

@@ -0,0 +1,51 @@
+require 'hashie'
+
+class Fn::Salesforce::Options
+
+  def initialize(attributes)
+    @attributes = attributes
+  end
+
+
+  def credentials
+    return @credentials if @credentials
+
+    credentials = JSON.parse(File.read(@attributes[:credentials]))
+    @credentials = Hashie::Mash.new( {
+      username:       credentials["username"],
+      password:       credentials["password"],
+      security_token: credentials["token"],
+      client_id:      credentials["key"],
+      client_secret:  credentials["secret"],
+      host:           credentials["host"]
+    } ).to_hash(symbolize_keys: true)
+
+  end
+
+  def schema
+    return @schema if @schema
+
+    @schema = JSON.parse(File.read(@attributes[:schema]))
+  end
+
+  def message
+    return @message if @message
+
+    @message = JSON.parse(File.read(@attributes[:message]))
+  end
+
+  def plan
+    return @plan if @plan
+
+    @plan = JSON.parse(File.read(@attributes[:plan]))
+  end
+
+  def target
+    @attributes[:target]
+  end
+
+  def format
+    @attributes[:format]
+  end
+  
+end

data/lib/fn/salesforce/version.rb

@@ -0,0 +1,5 @@
+module Fn
+  module Salesforce
+    VERSION = "0.1.0.pre"
+  end
+end

data/lib/fn/salesforce/walker.rb

@@ -0,0 +1,43 @@
+# Payload Tree Walker
+# ===================
+#
+# Object Emitter for JSON payloads.
+class Fn::Salesforce::Walker
+
+  # Parse
+  # -----
+  #
+  # ```ruby
+  # counter = 0
+  # parse(tree) do |key,properties|
+  #   puts key
+  #   puts properties
+  #
+  #   # The return result is passed back to the caller,
+  #   # this way we can pass down the resulting `id` after the parent
+  #   # object has been created.
+  #   counter+= 1
+  # end
+  # ```
+
+  def self.parse(tree, parent=nil, &block)
+    tree.each { |obj,properties|
+      # We assume all properties that belong to this object are not arrays.
+      immediate_properties = properties.select { |k,v| !v.is_a?(Array) }
+
+      # Without the child objects present, we send it out for processing.
+      # Grab the result and carry on.
+      result = block.call(obj, immediate_properties, parent)
+
+      children = properties.select { |k,v| v.is_a?(Array) } \
+        # We map out the array of child objects to single key/value hashes.
+        .collect { |k,v| v.map { |v| {k => v} } }.flatten \
+        # And send them off individually for processing.
+        .each { |child|
+          # The handle to the direct parent's result is made available.
+          parse(child, result, &block)
+        }
+    }
+  end
+
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: fn-salesforce
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Stuart Corbishley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-notes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+- !ruby/object:Gem::Dependency
+  name: hana
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: |2
+      CLI Tool and Adaptor for working with Salesforce.
+
+      Intended to be used in conjunction with OpenFn, but has been designed
+      with standalone use in mind.
+
+      Leveraging JSON-Schema, fn-salesforce acts as a bridge between Salesforce
+      and external data. It supports nested JSON data, and can resolve
+      basic dependency graphs while providing access to intermediary data
+      formats.
+email:
+- corbish@gmail.com
+executables:
+- fn-salesforce
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/fn-salesforce
+- bin/setup
+- docs/README.md
+- fn-salesforce.gemspec
+- lib/fn/salesforce.rb
+- lib/fn/salesforce/cli.rb
+- lib/fn/salesforce/environment.rb
+- lib/fn/salesforce/object.rb
+- lib/fn/salesforce/object_factory.rb
+- lib/fn/salesforce/options.rb
+- lib/fn/salesforce/version.rb
+- lib/fn/salesforce/walker.rb
+homepage: https://github.com/stuartc/fn-salesforce
+licenses:
+- MIT
+metadata: {}
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Salesforce support adaptor for OpenFn
+test_files: []