soapforce 0.1.1 → 0.1.2

data/lib/soapforce/actions

@@ -0,0 +1,38 @@
+login
+describe_s_object
+describe_s_objects
+describe_global
+describe_data_category_groups
+describe_data_category_group_structures
+describe_layout
+describe_softphone_layout
+describe_search_layouts
+describe_search_scope_order
+describe_tabs
+create
+update
+upsert
+merge
+delete
+undelete
+empty_recycle_bin
+retrieve
+process
+convert_lead
+logout
+invalidate_sessions
+get_deleted
+get_updated
+query
+query_all
+query_more
+search
+get_server_timestamp
+set_password
+reset_password
+get_user_info
+send_email_message
+send_email
+perform_quick_actions
+describe_quick_actions
+describe_available_quick_actions

data/lib/soapforce/client.rb

@@ -165,23 +165,131 @@ module Soapforce
       call_soap_api(:search, {:searchString => sosl})
     end
 
+    # Public: Insert a new record.
+    #
+    # sobject - String name of the sobject.
+    # attrs   - Hash of attributes to set on the new record.
+    #
+    # Examples
+    #
+    #   # Add a new account
+    #   client.create('Account', Name: 'Foobar Inc.')
+    #   # => '0016000000MRatd'
+    #
+    # Returns the String Id of the newly created sobject.
+    # Returns false if something bad happens.
     def create(sobject_type, properties)
+      create!(sobject_type, properties)
+    rescue => e
+      false
+    end
+
+    # Public: Insert a new record.
+    #
+    # sobject - String name of the sobject.
+    # attrs   - Hash of attributes to set on the new record.
+    #
+    # Examples
+    #
+    #   # Add a new account
+    #   client.create('Account', Name: 'Foobar Inc.')
+    #   # => '0016000000MRatd'
+    #
+    # Returns the String Id of the newly created sobject.
+    # Raises exceptions if an error is returned from Salesforce.
+    def create!(sobject_type, properties)
       call_soap_api(:create, sobjects_hash(sobject_type, properties))
     end
 
+    # Public: Update a record.
+    #
+    # sobject - String name of the sobject.
+    # attrs   - Hash of attributes to set on the record.
+    #
+    # Examples
+    #
+    #   # Update the Account with Id '0016000000MRatd'
+    #   client.update('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
+    #
+    # Returns Hash if the sobject was successfully updated.
+    # Returns false if there was an error.
     def update(sobject_type, properties)
+      update!(sobject_type, properties)
+    rescue => e
+      false
+    end
+
+    # Public: Update a record.
+    #
+    # sobject - String name of the sobject.
+    # attrs   - Hash of attributes to set on the record.
+    #
+    # Examples
+    #
+    #   # Update the Account with Id '0016000000MRatd'
+    #   client.update!('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
+    #
+    # Returns Hash if the sobject was successfully updated.
+    # Raises an exception if an error is returned from Salesforce
+    def update!(sobject_type, properties)
       call_soap_api(:update, sobjects_hash(sobject_type, properties))
     end
 
+
+    # Public: Update or create a record based on an external ID
+    #
+    # sobject - The name of the sobject to created.
+    # field   - The name of the external Id field to match against.
+    # attrs   - Hash of attributes for the record.
+    #
+    # Examples
+    #
+    #   # Update the record with external ID of 12
+    #   client.upsert!('Account', 'External__c', External__c: 12, Name: 'Foobar')
+    #
+    # Returns Hash if the record was found and updated or newly created.
+    # Raises an exception if an error is returned from Salesforce.
     def upsert(sobject_type, external_id_field_name, objects)
       message = {externalIDFieldName: external_id_field_name}.merge(sobjects_hash(sobject_type, objects))
       call_soap_api(:upsert, message)
     end
 
+    # Public: Delete a record.
+    #
+    # sobject - String name of the sobject.
+    # id      - The Salesforce ID of the record.
+    #
+    # Examples
+    #
+    #   # Delete the Account with Id '0016000000MRatd'
+    #   client.delete('Account', '0016000000MRatd')
+    #
+    # Returns true if the sobject was successfully deleted.
+    # Returns false if an error is returned from Salesforce.
     def delete(id)
+      delete!(id)
+    rescue => e
+      false
+    end
+    alias_method :destroy, :delete
+
+    # Public: Delete a record.
+    #
+    # sobject - String name of the sobject.
+    # id      - The Salesforce ID of the record.
+    #
+    # Examples
+    #
+    #   # Delete the Account with Id '0016000000MRatd'
+    #   client.delete!('Account', '0016000000MRatd')
+    #
+    # Returns Hash if the sobject was successfully deleted.
+    # Raises an exception if an error is returned from Salesforce.
+    def delete!(id)
       ids = id.is_a?(Array) ? id : [id]
       call_soap_api(:delete, {:ids => ids})
     end
+    alias_method :destroy!, :delete
 
     # Public: Finds a single record and returns all fields.
     #
@@ -308,10 +416,18 @@ module Soapforce
       end
       # Convert SOAP XML to Hash
       response = response.to_hash
+
       # Get Response Body
       response_body = response["#{method}_response".to_sym]
+
       # Grab result section if exists.
       result = response_body ? response_body[:result] : nil
+
+      # Raise error when response contains errors
+      if result && result.is_a?(Hash) && result[:success] == false && result[:errors]
+        raise Savon::Error.new("#{result[:errors][:status_code]}: #{result[:errors][:message]}")
+      end
+
       return result
     end
 

data/lib/soapforce/version.rb

@@ -1,3 +1,3 @@
 module Soapforce
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/fixtures/create_response_failure.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<soapenv:Body>
+	<createResponse>
+		<result>
+			<errors>
+				<message>insufficient access rights on cross-reference id</message>
+				<statusCode>INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY</statusCode>
+			</errors>
+			<id xsi:nil="true"/>
+			<success>false</success>
+		</result>
+	</createResponse>
+</soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/delete_response_failure.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<soapenv:Body>
+	<deleteResponse>
+		<result>
+			<errors>
+				<message>bad id 006i000004DAKd</message>
+				<statusCode>MALFORMED_ID</statusCode>
+			</errors>
+			<id xsi:nil="true"/>
+			<success>false</success>
+		</result>
+	</deleteResponse>
+</soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/update_response_failure.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<soapenv:Body>
+	<updateResponse>
+		<result>
+			<errors>
+				<message>insufficient access rights on cross-reference id</message>
+				<statusCode>INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY</statusCode>
+			</errors>
+			<id xsi:nil="true"/>
+			<success>false</success>
+		</result>
+	</updateResponse>
+</soapenv:Body>
+</soapenv:Envelope>

data/spec/lib/client_spec.rb

@@ -246,56 +246,137 @@ describe Soapforce::Client do
   end
 
   describe "#create" do
+    before(:each) do
+      @body = "<tns:create><tns:sObjects><ins0:type>Opportunity</ins0:type><tns:Name>SOAPForce Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Prospecting</tns:StageName></tns:sObjects></tns:create>"
+      @params = { Name: "SOAPForce Opportunity", CloseDate: '2013-08-12', StageName: 'Prospecting' }
+    end
+
     it "should create new object" do
 
-      body = "<tns:create><tns:sObjects><ins0:type>Opportunity</ins0:type><tns:Name>SOAPForce Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Prospecting</tns:StageName></tns:sObjects></tns:create>"
-      stub = stub_api_request(endpoint, {with_body: body, fixture: 'create_response'})
-      
-      params = { Name: "SOAPForce Opportunity", CloseDate: '2013-08-12', StageName: 'Prospecting' }
-      response = subject.create("Opportunity", params)
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'create_response'})
+      response = subject.create("Opportunity", @params)
+
+      response[:success].should be_true
+      response[:id].should == "006A000000LbiizIAB"
+    end
+
+    it "should return false if object not created" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'create_response_failure'})
+      response = subject.create("Opportunity", @params)
+      response.should be_false
+    end
+
+    it "creates! new object" do
+
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'create_response'})
+      response = subject.create!("Opportunity", @params)
 
       response[:success].should be_true
       response[:id].should == "006A000000LbiizIAB"
     end
+
+    it "raises exception when create! fails" do
+
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'create_response_failure'})
+      expect {
+        response = subject.create!("Opportunity", @params)
+      }.to raise_error(Savon::Error)
+
+    end
   end
 
   describe "#update" do
-    it "should update existing object" do
+    before(:each) do
+      @body = "<tns:update><tns:sObjects><ins0:type>Opportunity</ins0:type><ins0:Id>003ABCDE</ins0:Id><tns:Name>SOAPForce Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Closed Won</tns:StageName></tns:sObjects></tns:update>"
+      @params = { Id: '003ABCDE', Name: "SOAPForce Opportunity", CloseDate: '2013-08-12', StageName: 'Closed Won' }
+    end
 
-      body = "<tns:update><tns:sObjects><ins0:type>Opportunity</ins0:type><ins0:Id>003ABCDE</ins0:Id><tns:Name>SOAPForce Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Closed Won</tns:StageName></tns:sObjects></tns:update>"
-      stub = stub_api_request(endpoint, {with_body: body, fixture: 'update_response'})
+    it "updates existing object" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'update_response'})
+      response = subject.update("Opportunity", @params)
 
-      params = { Id: '003ABCDE', Name: "SOAPForce Opportunity", CloseDate: '2013-08-12', StageName: 'Closed Won' }
-      response = subject.update("Opportunity", params)
+      response[:success].should be_true
+      response[:id].should == "006A000000LbiizIAB"
+    end
+
+    it "updates! existing object" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'update_response'})
+      response = subject.update!("Opportunity", @params)
 
       response[:success].should be_true
       response[:id].should == "006A000000LbiizIAB"
     end
-  end
 
-  describe "#upsert" do
-    it "should insert new and update existing objects" do
+    it "returns false when update fails" do
+
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'update_response_failure'})
+      response = subject.update("Opportunity", @params)
+      response.should be_false
+    end
 
-      body = "<tns:upsert><tns:externalIDFieldName>External_Id__c</tns:externalIDFieldName><tns:sObjects><ins0:type>Opportunity</ins0:type><tns:Name>New Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Prospecting</tns:StageName></tns:sObjects><tns:sObjects><ins0:type>Opportunity</ins0:type><ins0:Id>003ABCDE</ins0:Id><tns:Name>Existing Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Closed Won</tns:StageName></tns:sObjects></tns:upsert>"
-      stub = stub_api_request(endpoint, {with_body: body, fixture: 'upsert_response'})
+    it "raises exception when update fails" do
 
-      objects = [
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'update_response_failure'})
+      expect {
+        response = subject.update!("Opportunity", @params)
+      }.to raise_error(Savon::Error)
+
+    end
+  end
+
+  describe "#upsert" do
+    before(:each) do
+      @body = "<tns:upsert><tns:externalIDFieldName>External_Id__c</tns:externalIDFieldName><tns:sObjects><ins0:type>Opportunity</ins0:type><tns:Name>New Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Prospecting</tns:StageName></tns:sObjects><tns:sObjects><ins0:type>Opportunity</ins0:type><ins0:Id>003ABCDE</ins0:Id><tns:Name>Existing Opportunity</tns:Name><tns:CloseDate>2013-08-12</tns:CloseDate><tns:StageName>Closed Won</tns:StageName></tns:sObjects></tns:upsert>"
+      @objects = [
         { Name: "New Opportunity", CloseDate: '2013-08-12', StageName: 'Prospecting' },
         { Id: '003ABCDE', Name: "Existing Opportunity", CloseDate: '2013-08-12', StageName: 'Closed Won' }
       ]
-      subject.upsert("Opportunity", "External_Id__c", objects)
     end
+
+    it "inserts new and updates existing objects" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'upsert_response'})
+      subject.upsert("Opportunity", "External_Id__c", @objects)
+    end
+
   end
 
   describe "#delete" do
-    it "should delete existing objects" do
-      body = "<tns:delete><tns:ids>003ABCDE</tns:ids></tns:delete>"
-      stub = stub_api_request(endpoint, {with_body: body, fixture: 'delete_response'})
-      response = subject.delete("003ABCDE")
+    before(:each) do
+      @body = "<tns:delete><tns:ids>006A000000LbiizIAB</tns:ids></tns:delete>"
+      @id = "006A000000LbiizIAB"
+    end
+
+    it "deletes existing object" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'delete_response'})
+      response = subject.delete(@id)
 
       response[:success].should be_true
-      response[:id].should == "006A000000LbiizIAB"
+      response[:id].should == @id
     end
+
+    it "returns false if delete fails" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'delete_response_failure'})
+      response = subject.delete(@id)
+
+      response.should be_false
+    end
+
+    it "deletes existing object with a bang" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'delete_response'})
+      response = subject.delete!(@id)
+
+      response[:success].should be_true
+      response[:id].should == @id
+    end
+
+    it "raises an exception if delete fails" do
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'delete_response_failure'})
+      expect {
+        subject.delete!(@id)
+      }.to raise_error(Savon::Error)
+    end
+
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soapforce
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -89,6 +89,7 @@ files:
 - README.md
 - Rakefile
 - lib/soapforce.rb
+- lib/soapforce/actions
 - lib/soapforce/client.rb
 - lib/soapforce/configuration.rb
 - lib/soapforce/query_result.rb
@@ -97,7 +98,9 @@ files:
 - resources/partner.wsdl.xml
 - soapforce.gemspec
 - spec/fixtures/create_response.xml
+- spec/fixtures/create_response_failure.xml
 - spec/fixtures/delete_response.xml
+- spec/fixtures/delete_response_failure.xml
 - spec/fixtures/describe_global_response.xml
 - spec/fixtures/describe_s_object_response.xml
 - spec/fixtures/describe_s_objects_response.xml
@@ -110,6 +113,7 @@ files:
 - spec/fixtures/retrieve_response.xml
 - spec/fixtures/search_response.xml
 - spec/fixtures/update_response.xml
+- spec/fixtures/update_response_failure.xml
 - spec/fixtures/upsert_response.xml
 - spec/lib/client_spec.rb
 - spec/lib/configuration_spec.rb
@@ -145,7 +149,9 @@ summary: Wraps Savon with helper methods and custom types for interacting with t
   Salesforce SOAP API.
 test_files:
 - spec/fixtures/create_response.xml
+- spec/fixtures/create_response_failure.xml
 - spec/fixtures/delete_response.xml
+- spec/fixtures/delete_response_failure.xml
 - spec/fixtures/describe_global_response.xml
 - spec/fixtures/describe_s_object_response.xml
 - spec/fixtures/describe_s_objects_response.xml
@@ -158,6 +164,7 @@ test_files:
 - spec/fixtures/retrieve_response.xml
 - spec/fixtures/search_response.xml
 - spec/fixtures/update_response.xml
+- spec/fixtures/update_response_failure.xml
 - spec/fixtures/upsert_response.xml
 - spec/lib/client_spec.rb
 - spec/lib/configuration_spec.rb