soapforce 0.2.1 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDZjNzkzNzYxNzA5YmJhZmM4ZjA1ODZhYTgxMTVkYzYwMjU1MTEyYQ==
-  data.tar.gz: !binary |-
-    Y2Q5MThhZTIzZmQ3NGRiYjQ0MzM0MmViNDM1YThlODhhNTY4OGVmNQ==
+SHA1:
+  metadata.gz: 9ad9594a32904ff7305f9fed654cc0a71148e7e0
+  data.tar.gz: 0fb2ff0b93f97172a1e6ce0eb53591e91e9c3441
 SHA512:
-  metadata.gz: !binary |-
-    OGIzYzM3YTk1NjBlM2I5ZmMyOGZjNDYwM2VhYjJjM2UwNTNjODcwODE1ZjZl
-    YjIzZDM1MmQ5MzYyZGU1Mjg3ZjRlYTA2MjMzZDlkNWJmMjU0OTlkYWIzZGZl
-    YWVlNGQ3N2FhNzY1NzlmNDk2NTU3NjNkZWIxMzJmZGU5NmYzOWE=
-  data.tar.gz: !binary |-
-    ZmJkNDM4ZmY2NDJkYTNkNDQyMDcxNzMzYzlkYzExN2U3YmIwNzcwMGVkNTNk
-    NTYyMGY5MmU3MTJhYjc3NGU0ZDlhMjIwZjM2NDMwODdlOWNjMGI2MzJmM2Ix
-    OWQ3NDU0YWQzNDIyZDI1ZTM0NDE0NTUzYWM2YTkyZjIzOWQxODg=
+  metadata.gz: 56920bf8ee1aa09ef84d071011b39c8a9a791cb183659bad3de9924adb9f1dd5599f5373db8e64fcd8ca42437e96a42c17c16ad61373f7db916457bf51deeeca
+  data.tar.gz: fda094cc5420a8a8848549937f5207d31b9fbdf1cb786b8eb2361fe3fb41aea2c4005872fd909224344ba300904e3116dc9fa1fd0c8314d245edf5d96e4b8d3f

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+## 0.3.0 (Mar 25, 2015)
+
+* Adds merge command.
+
+## 0.2.1 (November 17, 2014)
+
+* Widen Savon dependency
+* Switch to TLS. SSLv3 has been disabled.
+
+## 0.2.0 (November 16, 2014)
+
+* Adds support for accessing sandbox or custom endpoint. #4
+* Adds describe_layout operation
+* Adds configurable logger. Disabled by default.
+
+## 0.1.3 (October 25, 2014)
+
+* Adds support for process operation (ProcessSubmitRequest and ProcessWorkItemRequest)
+
+## 0.1.2 (September 11, 2013)
+
+* Adds create!, update!, delete! methods that raise Exceptions on error.
+
+## 0.1.0 (August 13, 2013)
+
+* Initial Release

data/lib/soapforce/client.rb

@@ -339,6 +339,46 @@ module Soapforce
     end
     alias_method :destroy!, :delete
 
+    # Public: Merges records together
+    #
+    # sobject       - String name of the sobject
+    # master_record - Hash of the master record that other records will be merged into
+    # ids           - Array of Salesforce Ids that will be merged into the master record
+    #
+    # Examples
+    #
+    #   client.merge('Account', Id: '0016000000MRatd', ['012000000000000AAA'])
+    #
+    # Returns Hash if the records were merged successfully
+    # Raises an exception if an error is returned from Salesforce.
+    def merge!(sobject_type, master_record_hash, ids)
+      call_soap_api(
+        :merge,
+        request: {
+          masterRecord: master_record_hash.merge(:'@xsi:type' => sobject_type),
+          recordToMergeIds: ids
+        }
+      )
+    end
+
+    # Public: Merges records together
+    #
+    # sobject       - String name of the sobject
+    # master_record - Hash of the master record that other records will be merged into
+    # ids           - Array of Salesforce Ids that will be merged into the master record
+    #
+    # Examples
+    #
+    #   client.merge('Account', Id: '0016000000MRatd', ['012000000000000AAA'])
+    #
+    # Returns Hash if the records were merged successfully
+    # Raises an exception if an error is returned from Salesforce.
+    def merge(sobject_type, master_record_hash, ids)
+      merge!(sobject_type, master_record_hash, ids)
+    rescue => e
+      false
+    end
+
     # Public: Finds a single record and returns all fields.
     #
     # sobject - The String name of the sobject.
@@ -532,4 +572,4 @@ module Soapforce
       {sObjects: sobjects}
     end
   end
-end
+end

data/lib/soapforce/version.rb

@@ -1,3 +1,3 @@
 module Soapforce
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/fixtures/merge_response.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com">
+  <soapenv:Body>
+    <mergeResponse>
+      <result>
+        <id>001160000000000AAG</id>
+        <mergedRecordIds>001140000000000AA4</mergedRecordIds>
+        <mergedRecordIds>001150000000000AAO</mergedRecordIds>
+        <success>true</success>
+      </result>
+    </mergeResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/merge_response_failure.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com">
+  <soapenv:Body>
+    <mergeResponse>
+      <result>
+        <errors>
+          <message>bad id in recordsToMerge: 0011500000000</message>
+          <statusCode>MALFORMED_ID</statusCode>
+        </errors>
+        <id>001160000000000AAG</id>
+        <success>false</success>
+      </result>
+    </mergeResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/lib/client_spec.rb

@@ -400,6 +400,46 @@ describe Soapforce::Client do
 
   end
 
+  describe "#merge" do
+    before(:each) do
+      @body = "<tns:merge><tns:request><tns:masterRecord xsi:type=\"Account\"><tns:id>001160000000000AAG</tns:id></tns:masterRecord><tns:recordToMergeIds>001140000000000AA4</tns:recordToMergeIds><tns:recordToMergeIds>001150000000000AAO</tns:recordToMergeIds></tns:request></tns:merge>"
+      @object   = { id: "001160000000000AAG" }
+      @to_merge = ['001140000000000AA4','001150000000000AAO']
+    end
+
+    it "merges objects together" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'merge_response'})
+      response = subject.merge("Account", @object, @to_merge)
+
+      response[:success].should be_true
+      response[:id].should == @object[:id]
+      response[:merged_record_ids].sort.should == @to_merge
+    end
+
+    it "returns false if merge fails" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'merge_response_failure'})
+      response = subject.merge("Account", @object, @to_merge)
+
+      response.should be_false
+    end
+
+    it "merges objects with a bang" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'merge_response'})
+      response = subject.merge!("Account", @object, @to_merge)
+
+      response[:success].should be_true
+      response[:id].should == @object[:id]
+      response[:merged_record_ids].sort.should == @to_merge
+    end
+
+    it "raises an exception if merge fails" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'merge_response_failure'})
+      expect {
+        subject.merge!('Account', @object, @to_merge)
+      }.to raise_error(Savon::Error)
+    end
+  end
+
   describe "process" do
 
     it "process submit request without approvers" do

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: soapforce
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Joe Heth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
     - - <
@@ -24,7 +24,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
     - - <
@@ -37,7 +37,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
@@ -47,7 +47,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
@@ -57,7 +57,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.17.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.17.0
   type: :development
@@ -67,7 +67,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.17.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.17.0
 - !ruby/object:Gem::Dependency
@@ -77,7 +77,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
@@ -87,7 +87,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.0
 description: A ruby client for the Salesforce SOAP API based on Savon.
@@ -100,6 +100,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -122,6 +123,8 @@ files:
 - spec/fixtures/describe_s_objects_response.xml
 - spec/fixtures/get_user_info_response.xml
 - spec/fixtures/login_response.xml
+- spec/fixtures/merge_response.xml
+- spec/fixtures/merge_response_failure.xml
 - spec/fixtures/org_id_response.xml
 - spec/fixtures/process_submit_request_response.xml
 - spec/fixtures/process_workitem_request_response.xml
@@ -149,17 +152,17 @@ 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.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Wraps Savon with helper methods and custom types for interacting with the
@@ -175,6 +178,8 @@ test_files:
 - spec/fixtures/describe_s_objects_response.xml
 - spec/fixtures/get_user_info_response.xml
 - spec/fixtures/login_response.xml
+- spec/fixtures/merge_response.xml
+- spec/fixtures/merge_response_failure.xml
 - spec/fixtures/org_id_response.xml
 - spec/fixtures/process_submit_request_response.xml
 - spec/fixtures/process_workitem_request_response.xml