SFDO-API 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee72501902798d88fe262d4de5a4116e2ad25c0f
+  data.tar.gz: 5561b32e32ed186f309f254356ed0d7664fa185b
+SHA512:
+  metadata.gz: 49aa21b2262711aa7496cd78f1ec5f2eabee87c29ae5f11877876ed9bf104799877ffb91297dd46c502520eea9d6c2e9116d87dab7f38df732ef5b03445887b8
+  data.tar.gz: 5129c3ccfbe7ad2b077df709647797295159d0fb97fe2dc76994fb51675ab25bbcd8114e0f244f701537e2846253d0990118017b79e353eab277585307a63a9d

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,53 @@
+# SFDO::API
+
+SFDO-API is a convenient way to manipulate valid Salesforce objects in a target environment. It accepts commands from
+the calling script, and then lets the restforce Ruby gem deal directly with the Salesforce API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'SFDO-API'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install SFDO-API
+
+## Usage
+
+To create a simple Account and get the ID for that Account:
+```ruby
+  def create_account_via_api(client_name)
+    @account_id = create 'Account', Name: client_name
+  end
+```
+You can also address the Restforce API client directly if you want, for example to issue a 'select' query:
+```ruby
+  def create_contact_via_api(client_name, street = '', city = '', state = '', country = '', zip = '')
+    @contact_id = create 'Contact', LastName: client_name,
+                                    MailingStreet: street,
+                                    MailingCity: city,
+                                    MailingState: state,
+                                    MailingCountry: country,
+                                    MailingPostalCode: zip
+    account_object = @api_client.query("select AccountId from Contact where Id = '#{@contact_id}'")
+    my_account_object = account_object.first
+    @account_id_for_contact = my_account_object.AccountId
+  end
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SalesforceFoundation/SFDO-API.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/SFDO-API.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'SFDO/API/version'
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "SFDO-API"
+  spec.version       = SFDO::API::VERSION
+  spec.authors       = ["Chris McMahon", "Kevin Poorman"]
+  spec.email         = ["cmcmahon@salesforce.com"]
+
+  spec.summary       = %q{Manipulates records via the Salesforce API using Restforce}
+  spec.description   = %q{Primarily used for automated browser tests, this is a convenient way to manipulate generic Salesforce objects}
+  spec.homepage      = "https://github.com/SalesforceFoundation/SFDO-API"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "restforce", "~> 2.1.1"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "SFDO/API"
+
+# 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/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/lib/SFDO/API.rb

@@ -0,0 +1,55 @@
+require 'SFDO/API/version'
+
+module SfdoAPI
+
+  def api_client
+    @api_client ||= Restforce.new api_version: '32.0',
+                                  refresh_token: ENV['SF_REFRESH_TOKEN'],
+                                  client_id: ENV['SF_CLIENT_KEY'],
+                                  client_secret: ENV['SF_CLIENT_SECRET']
+    yield
+  end
+
+  def create(type, obj_hash)
+    if is_valid_obj_hash?(type, obj_hash, @fields_acceptibly_nil)
+      obj_id = api_client do
+        @api_client.create! type, obj_hash
+      end
+    end
+    obj_id
+  end
+
+  def is_valid_obj_hash?(object_name, obj_hash, fields_acceptibly_nil)
+    required_fields = get_object_describe(object_name).map(&:fieldName)
+    #   [name, id, required_field_1__c, etc]
+    valid = true
+    required_fields.each do |f|
+
+      valid = false if (!obj_hash.key? f.to_sym) && (begin
+        !fields_acceptibly_nil[object_name].contains? f
+        puts 'This field must be populated in order to create this object in this environment: ' +  f.inspect
+      rescue
+        false
+      end)
+    end
+    valid
+  end
+
+  def get_object_describe(object_name)
+    api_client do
+      @description = @api_client.get("/services/data/v35.0/sobjects/#{object_name}/describe")
+
+      describeobject = Hashie::Mash.new(@description.body)
+
+      required = describeobject.fields.map do |x|
+        Hashie::Mash.new(
+          fieldName: x.name,
+          required: (!x.nillable && !x.defaultedOnCreate),
+          default: x.defaultValue)
+      end
+      required.select(&:required)
+    end
+  end
+end
+# INCLUDE HERE RATHER THAN IN THE PRODUCT-SPECIFIC CODE USING THIS GEM
+include SfdoAPI

data/lib/SFDO/API/version.rb

@@ -0,0 +1,5 @@
+module SFDO
+  module API
+    VERSION = "0.1.0"
+  end
+end

data/lib/SFDO/LICENSE.md

@@ -0,0 +1,29 @@
+
+Copyright (c) 2015, 2016 
+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 NPSP-Browser-Tests 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.
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: SFDO-API
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris McMahon
+- Kevin Poorman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-04 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: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: Primarily used for automated browser tests, this is a convenient way
+  to manipulate generic Salesforce objects
+email:
+- cmcmahon@salesforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- SFDO-API.gemspec
+- bin/console
+- bin/setup
+- lib/SFDO/API.rb
+- lib/SFDO/API/version.rb
+- lib/SFDO/LICENSE.md
+homepage: https://github.com/SalesforceFoundation/SFDO-API
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Manipulates records via the Salesforce API using Restforce
+test_files: []