salesforce_flo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8f1c9187f49decf64aad3602dbc666dcb779efa
+  data.tar.gz: 6d03df17236eda0d75991259868a9b9ddb40a895
+SHA512:
+  metadata.gz: 1e0bae2a9bc59b73225660edb54d2256b5948eca1809c1224aa46ab5bdef40d401238b92696a8fd90fb69617d24e78273c441413700d81a6cd1ea89b1c310769
+  data.tar.gz: d14d35b63e01e18da55d39028ec6794e449163ae5a2a7e0b9ff8fbc165a7f8246d88dcf82ac5b9e77200224d92dd8d9e11e6947938c5f228d6e7c4d842ef1d78

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salesforce_flo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2017, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,76 @@
+# SalesforceFlo
+[![Gem Version](https://badge.fury.io/rb/salesforce_flo.svg)](https://badge.fury.io/rb/salesforce_flo) [![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate) [![Build Status](https://semaphoreci.com/api/v1/justinpowers/salesforce_flo/branches/master/shields_badge.svg)](https://semaphoreci.com/justinpowers/salesforce_flo)
+
+SalesforceFlo is a Salesforce plugin for the Flo workflow automation library.  If you aren't familiar with Flo, then please start [here](https://github.com/salesforce/flo)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'salesforce_flo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salesforce_flo
+
+## Configuration
+
+In your Flo configuration file, configure salesforce inside the `config` block
+
+```ruby
+config do |cfg|
+  cfg.provider :salesforce_flo, { client: Restforce.new(oauth_token: 'access_token', instance_url: 'instance url', api_version: '38.0') }
+end
+```
+
+See the [RestForce gem](https://github.com/ejholmes/restforce) for information on setting up the client.
+
+## Oauth Authentication Flow
+
+The RestForce gem does not provide a mechanism for initiating the oauth authorization flow to retrieve the initial access token.  If you wish to authenticate with Oauth, you can use the Oauth wrapper
+
+```ruby
+config do |cfg|
+cfg.provider :salesforce_flo, { client: SalesforceFlo::Authentication::OauthWrapper.new }
+end
+```
+
+This enables the browser Oauth authorization flow.  It will open up the Salesforce authorization flow in the browser so that the user can authorize SalesforceFlo to make requests on the user's behalf.  It will also open up a local webserver on port 8000, which will accept the redirect at the end of the authorization flow so that SalesforceFlo can obtain the access token.
+
+## Usage
+
+Specify the commands you wish to run in the `register_command` block.  For example
+```ruby
+# Updates the `agf__ADM_Work__c` object, so that the `agf__Status__c` field is set to 'In Progress'
+perform :salesforce_flo, :update_object, { sobject: 'agf__ADM_Work__c', name: work_id, fields: { agf__Status__c: 'In Progress' } }
+```
+
+## Contributing
+
+1. Fork it (http://github.com/your-github-username/salesforce_flo/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 new Pull Request
+
+
+## License
+
+>Copyright (c) 2017, Salesforce.com, Inc.
+>All rights reserved.
+>
+>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+>
+>* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+>
+>* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+>
+>* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+>
+>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,15 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/flo/provider/salesforce_flo.rb

@@ -0,0 +1,52 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'pry'
+
+module Flo
+  module Provider
+    class SalesforceFlo
+
+
+      # Creates a new SalesforceFlo Provider instance
+      #
+      # @param [Hash] opts The options needed to create the provider
+      # @option opts [Restforce, #call] :client An instance of a Restforce client, or
+      #   an object that will produce a client when #call is invoked
+      #
+      def initialize(opts={})
+        @client = if opts[:client].respond_to? :call
+          opts[:client].call
+        else
+          opts[:client]
+        end
+      end
+
+      # Updates a Salesforce object using the client
+      #
+      # @param [Hash] opts The options needed to update the object
+      # @option opts [String] :sobject The api name of the sobject to update
+      # @option opts [String] :name The name of the object instance you wish to update
+      # @option opts [Hash] :fields A mapping of the field names and values you wish to update
+      #
+      def update_object(opts={})
+        sobject = opts.delete(:sobject)
+
+        object = @client.find(sobject, opts.delete(:name), 'Name')
+        @client.update(sobject, opts[:fields].merge(Id: object.Id))
+        OpenStruct.new(success?: true)
+      end
+
+      # Provides the current state of a Salesforce object
+      #
+      # @param sobject [String] The api name of sobject to query
+      # @param object_name [String] The name of the object instance to search for
+      def object(sobject, object_name)
+        @client.find(sobject, object_name, 'Name')
+      end
+
+    end
+  end
+end

data/lib/salesforce_flo/authentication/oauth_wrapper.rb

@@ -0,0 +1,123 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'webrick'
+require 'launchy'
+require 'json'
+require 'restforce'
+
+module SalesforceFlo
+  module Authentication
+    class OauthWrapper
+
+      SFDC_URI = 'https://login.salesforce.com/services/oauth2/authorize'
+      DEFAULT_CLIENT_ID = '3MVG9CEn_O3jvv0zPd34OzgiH037XR5Deez3GW8PpsMdzoxecdKUW1s.8oYU9GoLS2Tykr4qTrCizaQBjRXNT'
+      DEFAULT_REDIRECT_HOSTNAME = 'localhost'
+      DEFAULT_LISTEN_PORT = '3835'
+
+      # Creates a new OauthWrapper instance
+      #
+      # @param [Hash] opts The options needed to create the provider
+      # @option opts [String] :client_id The client id of the connected app for Oauth authorization
+      # @option opts [String] :redirect_hostname (http://localhost:3835) The hostname portion of the uri
+      # that the user will be redirected to at the end of the Oauth authorization flow.  This MUST match the
+      # redirect URL specified in the connected app settings.
+      # @option opts [String] :port (3835) The port that the user will be redirected to at the end of the Oauth
+      # flow.  This will be appended to the redirect_hostname
+      # @option opts [#call] :client An object that produces a client when called with initialization options
+      # @raise [ArgumentError] If client object does not respond_to?(:call)
+      #
+      def initialize(opts={})
+        @client_id = opts[:client_id] || DEFAULT_CLIENT_ID
+        @redirect_hostname = opts[:redirect_hostname] || DEFAULT_REDIRECT_HOSTNAME
+        @port = opts[:port] || DEFAULT_LISTEN_PORT
+        @client = opts[:client] || -> (options) { Restforce.new(options) }
+        raise ArgumentError.new(':client must respond to #call, try a lambda') unless @client.respond_to?(:call)
+      end
+
+      # Starts a temporary webserver on the specified port, and initiates an Oauth authorization flow, which will
+      # redirect the user back to localhost on the specified port.
+      #
+      # @param [Hash] opts Options that will be passed to the client when called, which will be merged with the response
+      # from the salesforce that includes the access token
+      # @return The result of invoking #call on the client object
+      def call(opts={})
+        server = WEBrick::HTTPServer.new :Port => @redirect_hostname
+        auth_details = {}
+
+        server.mount_proc('/') do |req, res|
+          res.body = js_template
+        end
+
+        server.mount_proc('/send_token') do |req, res|
+          auth_details = JSON.parse(req.body)
+          res.body = 'token sent'
+
+          server.shutdown # server will shutdown after completing the request
+        end
+
+        trap "INT" do server.shutdown end
+
+        Launchy.open("#{SFDC_URI}?#{oauth_query_string}")
+        server.start
+
+        merged_options = opts.merge(auth_details).merge(client_id: @client_id, api_version: '38.0').inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+        @client.call(merged_options)
+      end
+
+      private
+
+      def oauth_query_string
+        query_string = URI.encode_www_form([['client_id', @client_id], ['response_type', 'token'], ['redirect_uri', redirect_uri]])
+      end
+
+      def redirect_uri
+        "http://#{@redirect_hostname}:#{@port}"
+      end
+
+      def js_template
+        <<-TEMPLATE
+          <html>
+          <head></head>
+          <body onload="sendHashParams()">
+            OAuth authentication completed successfully.  This window will close shortly.
+            <script>
+              function getHashParams() {
+
+                  var hashParams = {};
+                  var e,
+                      a = /\\+/g,  // Regex for replacing addition symbol with a space
+                      r = /([^&;=]+)=?([^&;]*)/g,
+                      d = function (s) { return decodeURIComponent(s.replace(a, " ")); },
+                      q = window.location.hash.substring(1);
+
+                  while (e = r.exec(q))
+                     hashParams[d(e[1])] = d(e[2]);
+
+                  return hashParams;
+              }
+
+              function sendHashParams() {
+                xhr = new XMLHttpRequest();
+                var url = "http://localhost:8000/send_token";
+                xhr.open("POST", url, true);
+                xhr.setRequestHeader("Content-type", "application/json");
+                var data = JSON.stringify(getHashParams());
+                xhr.send(data);
+
+                setTimeout(function() {
+                  window.close;
+                }, (10 * 1000))
+              }
+            </script>
+          </body>
+        </html>
+        TEMPLATE
+      end
+
+    end
+  end
+end

data/lib/salesforce_flo/version.rb

@@ -0,0 +1,8 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+module SalesforceFlo
+  VERSION = "0.0.1"
+end

data/lib/salesforce_flo.rb

@@ -0,0 +1,10 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require "salesforce_flo/version"
+
+module SalesforceFlo
+  # Your code goes here...
+end

data/salesforce_flo.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce_flo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce_flo"
+  spec.version       = SalesforceFlo::VERSION
+  spec.authors       = ['Justin Powers']
+  spec.email         = ['justin.powers@salesforce.com']
+
+  spec.summary       = %q{"Salesforce plugin for Flo"}
+  spec.homepage      = "https://github.com/salesforce/salesforce_flo"
+  spec.license       = "BSD-3-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency 'restforce'
+  spec.add_dependency 'launchy'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_flo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Powers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  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: 
+email:
+- justin.powers@salesforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/flo/provider/salesforce_flo.rb
+- lib/salesforce_flo.rb
+- lib/salesforce_flo/authentication/oauth_wrapper.rb
+- lib/salesforce_flo/version.rb
+- salesforce_flo.gemspec
+homepage: https://github.com/salesforce/salesforce_flo
+licenses:
+- BSD-3-Clause
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: '"Salesforce plugin for Flo"'
+test_files: []