restforce 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c96509bc04d200ffecb44942433ace9c40127ea
-  data.tar.gz: 71f6f9c56bb1834a9579efc527a11a40219a5268
+  metadata.gz: ffde6a2ff06c51931a6bab34f4d1f65cca529dab
+  data.tar.gz: fe9a373b83dbfef51434a2045c4dfa698094d0fb
 SHA512:
-  metadata.gz: 52a228602bf185b74729c4b1b4655a1d1bf4752d094d14ca6d9fb582d9127a6f860e6638db1f23d9212db960abf74934cc418d859b2ce919ff0cd05539a78748
-  data.tar.gz: 1a2bd510e619a82f7912ec854c74f6cd595b1aa170ea1f0ab8bafe58c3ce8e76f99bc04294e5e4b33489f0a35a136ddc55dfae7ad6b8ca6dff504467bf52f33c
+  metadata.gz: d2215c530292416152291284e81842411a02cc9e19a29b1e08ce745a63d53abb9fd68cea37f13b52138849e537c57aa255c80562c6a0a78062469541e3b74e2d
+  data.tar.gz: 09a8ae9879b0dca63e789f6bdb8ffdd9d2c92f9a297fcbafe051f240ff5c0a01c58108cf796d2b11791025b8922e34f53c4d61d4350d082d3a91a549b051ae73

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.2.1 (Jun 6, 2016)
+
+* Added support for `get_deleted` call (@adambird)
+
 ## 2.2.0 (Mar 16, 2016)
 
 * Raise a `Faraday::Error::ClientError` for `300` responses triggered by a conflicting external ID, providing access to the response, which contains an array of the conflicting IDs (@timrogers, @michaelminter)

data/README.md

@@ -56,7 +56,7 @@ If you're using the gem to interact with a single org (maybe you're building som
 salesforce integration internally?) then you should use the username/password
 authentication method.
 
-It is also important to note that the client object should not be reused across different threads, otherwise you may encounter thread-safety issues.
+It is also important to note that the client object should not be reused across different threads, otherwise you may encounter [thread-safety issues](https://www.youtube.com/watch?v=p5zQOkyCACc).
 
 #### OAuth token authentication
 
@@ -172,7 +172,7 @@ You can change the `api_version` setting from the default either on a per-client
 client = Restforce.new api_version: "32.0" # ...
 ```
 
-or, you may set it globally for Restofrce as a whole:
+or, you may set it globally for Restforce as a whole:
 
 ```ruby
 Restforce.configure do |config|
@@ -380,6 +380,18 @@ client.get_updated('Account', Time.local(2015,8,18), Time.local(2015,8,19))
 
 * * *
 
+### get_deleted
+
+Retrieves the list of IDs and time of deletion for records that have been deleted within the given timespan for the specified object
+
+```ruby
+# Get the list of accounts which have been deleted in the last day
+client.get_deleted('Account', Time.local(2015,8,18), Time.local(2015,8,19))
+# => { ... }
+```
+
+* * *
+
 ### authenticate!
 
 Performs an authentication and returns the response. In general, calling this
@@ -408,7 +420,7 @@ Using the new [Blob Data](http://www.salesforce.com/us/developer/docs/api_rest/C
 client.create 'Document', FolderId: '00lE0000000FJ6H',
   Description: 'Document test',
   Name: 'My image',
-  Body: Restforce::UploadIO.new(File.expand_path('image.jpg', __FILE__), 'image/jpeg'))
+  Body: Restforce::UploadIO.new(File.expand_path('image.jpg', __FILE__), 'image/jpeg')
 ```
 
 Using base64 encoded data (37.5mb limit):

data/lib/restforce/concerns/api.rb

@@ -84,6 +84,26 @@ module Restforce
         api_get(url).body
       end
 
+      # Public: Gets the IDs of sobjects of type [sobject]
+      # which have been deleted between startDateTime and endDateTime.
+      #
+      # Examples
+      #
+      #   # get deleted sobject Whizbangs between yesterday and today
+      #   startDate = Time.new(2002, 10, 31, 2, 2, 2, "+02:00")
+      #   endDate = Time.new(2002, 11, 1, 2, 2, 2, "+02:00")
+      #   client.get_deleted('Whizbang', startDate, endDate)
+      #
+      # Returns a Restforce::Collection if Restforce.configuration.mashify is true.
+      # Returns an Array of Hash for each record in the result if
+      # Restforce.configuration.mashify is false.
+      def get_deleted(sobject, start_time, end_time)
+        start_time = start_time.utc.iso8601
+        end_time = end_time.utc.iso8601
+        url = "/sobjects/#{sobject}/deleted/?start=#{start_time}&end=#{end_time}"
+        api_get(url).body
+      end
+
       # Public: Returns a detailed describe result for the specified sobject
       #
       # sobject - Stringish name of the sobject (default: nil).

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '2.2.0'
+  VERSION = '2.2.1'
 end

data/spec/fixtures/sobject/get_deleted_success_response.json

@@ -0,0 +1,11 @@
+{
+    "deletedRecords" :
+    [
+        {
+            "id" : "a00D0000008pQRAIA2",
+            "deletedDate" : "2013-05-07T22:07:19.000+0000"
+        }
+    ],
+    "earliestDateAvailable" : "2013-05-03T15:57:00.000+0000",
+    "latestDateCovered" : "2013-05-08T21:20:00.000+0000"
+}

data/spec/integration/abstract_client_spec.rb

@@ -45,6 +45,17 @@ shared_examples_for Restforce::AbstractClient do
     it { should be_an Enumerable }
   end
 
+  describe '.get_deleted' do
+    let(:start_date) { Time.new(2015, 8, 17, 0, 0, 0, "+02:00")  }
+    let(:end_date) { Time.new(2016, 8, 19, 0, 0, 0, "+02:00") }
+    end_string = '2016-08-18T22:00:00Z'
+    start_string = '2015-08-16T22:00:00Z'
+    requests "sobjects/Whizbang/deleted/\\?end=#{end_string}&start=#{start_string}",
+             fixture: 'sobject/get_deleted_success_response'
+    subject { client.get_deleted('Whizbang', start_date, end_date) }
+    it { should be_an Enumerable }
+  end
+
   describe '.search' do
     requests 'search\?q=FIND%20%7Bbar%7D', fixture: 'sobject/search_success_response'
 

data/spec/unit/concerns/api_spec.rb

@@ -35,6 +35,22 @@ describe Restforce::Concerns::API do
     end
   end
 
+  describe '.get_deleted' do
+    let(:start_date_time) { Time.new(2002, 10, 31, 2, 2, 2, "+02:00") }
+    let(:end_date_time) { Time.new(2003, 10, 31, 2, 2, 2, "+02:00") }
+    let(:sobject) { 'Whizbang' }
+    subject(:results) { client.get_deleted(sobject, start_date_time, end_date_time) }
+    it 'returns the body' do
+      start_string = '2002-10-31T00:02:02Z'
+      end_string = '2003-10-31T00:02:02Z'
+      url = "/sobjects/Whizbang/deleted/?start=#{start_string}&end=#{end_string}"
+      client.should_receive(:api_get).
+        with(url).
+        and_return(response)
+      expect(results).to eq response.body
+    end
+  end
+
   describe '.list_sobjects' do
     subject { client.list_sobjects }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -221,6 +221,7 @@ files:
 - spec/fixtures/sobject/create_success_response.json
 - spec/fixtures/sobject/delete_error_response.json
 - spec/fixtures/sobject/describe_sobjects_success_response.json
+- spec/fixtures/sobject/get_deleted_success_response.json
 - spec/fixtures/sobject/get_updated_success_response.json
 - spec/fixtures/sobject/list_sobjects_success_response.json
 - spec/fixtures/sobject/org_query_response.json
@@ -314,6 +315,7 @@ test_files:
 - spec/fixtures/sobject/create_success_response.json
 - spec/fixtures/sobject/delete_error_response.json
 - spec/fixtures/sobject/describe_sobjects_success_response.json
+- spec/fixtures/sobject/get_deleted_success_response.json
 - spec/fixtures/sobject/get_updated_success_response.json
 - spec/fixtures/sobject/list_sobjects_success_response.json
 - spec/fixtures/sobject/org_query_response.json