restforce 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c67387ede73e74537b9a9350642597ce127e65da
-  data.tar.gz: 5a467ccbed367d30f5ad7e5d7ac560c768bd8a2c
+  metadata.gz: c933281225117c041f54a23bd3141f5c8d1f9e8d
+  data.tar.gz: 153b2c10c1dca6035afb0675d5ebeab94ce27df9
 SHA512:
-  metadata.gz: e3733f5db2df0daa8a00adee9b483d5927f7cafe808df32f2518c2c1fcfebb83eadf0408825ce68cd02dfaf54e3da61fea0d28e3cd0756ee7fdc08b3639d7d31
-  data.tar.gz: a009788abb56352ef24e8e6681877769df80f27aedecbac5ad18ac8f8ab6f7a51302f594c1e86558a6b9a19241c53c038e867874c53ca447aaec53e30f5e6e25
+  metadata.gz: fac6beab45f4f1819edbb8f58195c9a6b9e085cc5dfb9fce2903231fe6bed89a3da30e142053b86860e7636ec7d331424cd0f9c3e5b29b6692bc3a5e1fd1b145
+  data.tar.gz: aa9bcae26b2041087aa53d81ee27b77d3b224f54f8e0732a54b8a0210680aaaf33f174aa35666599646e49cbf96d56d272b43c18b77eb9c2f8caa9b85f531089

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.1.1 (Aug 20, 2015)
+
+* Added support for `get_updated` call (@web-connect)
+* Respect Faraday adapter option in authentication middleware (@stenlarsson)
+
 ## 2.1.0 (Jun 29, 2015)
 
 * Added support for `query_all`, `explain` and `limits` API calls (which require a newer `api_version` than the default of 26.0) (@theSteveMitchell, @zenchild)

data/README.md

@@ -1,6 +1,7 @@
 # Restforce
 
 [![travis-ci](https://travis-ci.org/ejholmes/restforce.png?branch=master)](https://travis-ci.org/ejholmes/restforce) [![Code Climate](https://codeclimate.com/github/ejholmes/restforce.png)](https://codeclimate.com/github/ejholmes/restforce) [![Dependency Status](https://gemnasium.com/ejholmes/restforce.png)](https://gemnasium.com/ejholmes/restforce)
+![](https://img.shields.io/gem/dt/restforce.svg)
 
 Restforce is a ruby gem for the [Salesforce REST api](http://www.salesforce.com/us/developer/docs/api_rest/index.htm).
 It's meant to be a lighter weight alternative to the [databasedotcom gem](https://github.com/heroku/databasedotcom) that offers
@@ -13,6 +14,7 @@ Features include:
 * Support for parent-to-child relationships.
 * Support for aggregate queries.
 * Support for the [Streaming API](#streaming)
+* Support for the GetUpdated API
 * Support for blob data types.
 * Support for GZIP compression.
 * Support for [custom Apex REST endpoints](#custom-apex-rest-endpoints).
@@ -345,6 +347,18 @@ limits["DailyApiRequests"]
 
 * * *
 
+### get_updated
+
+Retrieves the list of individual record IDs that have been updated (added or changed) within the given timespan for the specified object
+
+```ruby
+# Get the ids of all accounts which have been updated in the last day
+client.get_updated('Account', Time.local(2015,8,18) Time.local(2015,8,19))
+# => { ... }
+```
+
+* * *
+
 ### authenticate!
 
 Performs an authentication and returns the response. In general, calling this
@@ -587,6 +601,4 @@ Using the scripts in `./script` instead of `bundle exec rspec`, `bundle console`
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-[Restforce::Collection]: https://github.com/ejholmes/restforce/blob/master/lib/restforce/collection.rb "Restforce::Collection"
+5. Create new Pull Request

data/lib/restforce/concerns/api.rb

@@ -64,6 +64,26 @@ module Restforce
         version_guard(29.0) { api_get("limits").body }
       end
 
+      # Public: Gets the IDs of sobjects of type [sobject]
+      # which have changed between startDateTime and endDateTime.
+      #
+      # Examples
+      #
+      #   # get changes for sobject Whizbang 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_updated('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_updated(sobject, start_time, end_time)
+        start_time = start_time.utc.iso8601
+        end_time = end_time.utc.iso8601
+        url = "/sobjects/#{sobject}/updated/?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/middleware/authentication.rb

@@ -52,7 +52,7 @@ module Restforce
                     Restforce.configuration.logger,
                     @options if Restforce.log?
 
-        builder.adapter Faraday.default_adapter
+        builder.adapter @options[:adapter]
       end
     end
 

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/spec/fixtures/sobject/get_updated_success_response.json

@@ -0,0 +1,12 @@
+{
+  "ids": [ 
+    "003q000000KvQ1tAAF",
+    "003q000000KvQ2DAAV",
+    "003q000000KwKFhAAN",
+    "003q000000KwKJoAAN",
+    "003q000000KwJyqAAF",
+    "003q000000KwJwLAAV",
+    "003q000000KwYFaAAN"
+    ],
+  "latestDateCovered" : "2015-08-19T08:17:00.000+0000"
+}

data/spec/integration/abstract_client_spec.rb

@@ -34,6 +34,17 @@ shared_examples_for Restforce::AbstractClient do
     it { should be_an Enumerable }
   end
 
+  describe '.get_updated' 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/updated/\\?end=#{end_string}&start=#{start_string}",
+             fixture: 'sobject/get_updated_success_response'
+    subject { client.get_updated('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

@@ -19,6 +19,22 @@ describe Restforce::Concerns::API do
     end
   end
 
+  describe '.get_updated' 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_updated(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/updated/?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 }
 

data/spec/unit/middleware/authentication/password_spec.rb

@@ -7,7 +7,8 @@ describe Restforce::Middleware::Authentication::Password do
       password: 'bar',
       security_token: 'security_token',
       client_id: 'client_id',
-      client_secret: 'client_secret' }
+      client_secret: 'client_secret',
+      adapter: :net_http }
   end
 
   it_behaves_like 'authentication middleware' do

data/spec/unit/middleware/authentication/token_spec.rb

@@ -5,7 +5,8 @@ describe Restforce::Middleware::Authentication::Token do
     { host: 'login.salesforce.com',
       refresh_token: 'refresh_token',
       client_id: 'client_id',
-      client_secret: 'client_secret' }
+      client_secret: 'client_secret',
+      adapter: :net_http }
   end
 
   it_behaves_like 'authentication middleware' do

data/spec/unit/middleware/authentication_spec.rb

@@ -4,7 +4,8 @@ describe Restforce::Middleware::Authentication do
   let(:options) do
     { host: 'login.salesforce.com',
       proxy_uri: 'https://not-a-real-site.com',
-      authentication_retries: retries }
+      authentication_retries: retries,
+      adapter: :net_http }
   end
 
   describe '.authenticate!' do
@@ -69,6 +70,16 @@ describe Restforce::Middleware::Authentication do
                          Restforce::Middleware::Logger, Faraday::Adapter::NetHttp
         }
       end
+
+      context 'with specified adapter' do
+        before do
+          options[:adapter] = :typhoeus
+        end
+
+        its(:handlers) {
+          should include FaradayMiddleware::ParseJson, Faraday::Adapter::Typhoeus
+        }
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -219,6 +219,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_updated_success_response.json
 - spec/fixtures/sobject/list_sobjects_success_response.json
 - spec/fixtures/sobject/org_query_response.json
 - spec/fixtures/sobject/query_aggregate_success_response.json
@@ -311,6 +312,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_updated_success_response.json
 - spec/fixtures/sobject/list_sobjects_success_response.json
 - spec/fixtures/sobject/org_query_response.json
 - spec/fixtures/sobject/query_aggregate_success_response.json
@@ -367,3 +369,4 @@ test_files:
 - spec/unit/signed_request_spec.rb
 - spec/unit/sobject_spec.rb
 - spec/unit/tooling/client_spec.rb
+has_rdoc: