restforce 0.1.3 → 0.1.4

data/README.md

@@ -11,6 +11,7 @@ It attempts to solve a couple of key issues that the databasedotcom gem has been
 * Remove the need to materialize constants.
 * Support for the Streaming API
 * Support for blob data types.
+* Support for GZIP compression.
 * A clean and modular architecture using [Faraday middleware](https://github.com/technoweenie/faraday)
 * Support for decoding [Force.com Canvas](http://www.salesforce.com/us/developer/docs/platform_connectpre/canvas_framework.pdf) signed requests. (NEW!)
 
@@ -345,27 +346,19 @@ Restforce.log = true
 client = Restforce.new.query('select Id, Name from Account')
 ```
 
-**Log Output**
+Another awesome feature about restforce is that, because it is based on
+Faraday, you can insert your own middleware. For example, if you were using
+Restforce in a rails app, you can setup custom logging using
+ActiveSupport::Notifications:
 
-```
-I, [2012-09-11T21:54:00.488991 #24032]  INFO -- : post https://login.salesforce.com/services/oauth2/token
-D, [2012-09-11T21:54:00.489078 #24032] DEBUG -- request: 
-I, [2012-09-11T21:54:00.997295 #24032]  INFO -- Status: 200
-D, [2012-09-11T21:54:00.997391 #24032] DEBUG -- response headers: server: ""
-content-type: "application/json; charset=UTF-8"
-transfer-encoding: "chunked"
-date: "Wed, 12 Sep 2012 04:53:59 GMT"
-connection: "close"
-D, [2012-09-11T21:54:00.997431 #24032] DEBUG -- response body: { ... }
-I, [2012-09-11T21:54:00.998985 #24032]  INFO -- : get https://na9.salesforce.com/services/data/v24.0/query?q=select+Id%2C+Name+from+Account
-D, [2012-09-11T21:54:00.999040 #24032] DEBUG -- request: Authorization: "OAuth token"
-I, [2012-09-11T21:54:01.622874 #24032]  INFO -- Status: 200
-D, [2012-09-11T21:54:01.623001 #24032] DEBUG -- response headers: server: ""
-content-type: "application/json; charset=UTF-8"
-transfer-encoding: "chunked"
-date: "Wed, 12 Sep 2012 04:54:00 GMT"
-connection: "close"
-D, [2012-09-11T21:54:01.623058 #24032] DEBUG -- response body: { ... }
+```ruby
+client = Restforce.new
+client.middleware.insert_after Restforce::Middleware::InstanceURL, FaradayMiddleware::Instrumentation
+
+# config/initializers/notifications.rb
+ActiveSupport::Notifications.subscribe('request.faraday') do |name, start, finish, id, payload|  
+  Rails.logger.debug(['notification:', name, "#{(finish - start) * 1000}ms", payload[:status]].join(" "))  
+end
 ```
 
 ## Contributing

data/lib/restforce.rb

@@ -24,6 +24,19 @@ module Restforce
     def new(options = {})
       Restforce::Client.new(options)
     end
+
+    # Public: Decodes a signed request received from Force.com Canvas.
+    #
+    # message       - The POST message containing the signed request from Salesforce.
+    # client_secret - The oauth client secret used to encrypt the message.
+    #
+    # Returns the Hash context if the message is valid.
+    def decode_signed_request(message, client_secret)
+      encryped_secret, payload = message.split('.')
+      digest = OpenSSL::Digest::Digest.new('sha256')
+      signature = Base64.encode64(OpenSSL::HMAC.hexdigest(digest, client_secret, payload))
+      JSON.parse(Base64.decode64(payload)) if encryped_secret == signature
+    end
   end
 
   class AuthenticationError < StandardError; end

data/lib/restforce/client.rb

@@ -3,28 +3,35 @@ module Restforce
     # Public: Creates a new client instance
     #
     # options - A hash of options to be passed in (default: {}).
-    #           :username       - The String username to use (required for password authentication).
-    #           :password       - The String password to use (required for password authentication).
-    #           :security_token - The String security token to use 
-    #                             (required for password authentication).
+    #           :username               - The String username to use (required for password authentication).
+    #           :password               - The String password to use (required for password authentication).
+    #           :security_token         - The String security token to use 
+    #                                     (required for password authentication).
     #
-    #           :oauth_token    - The String oauth access token to authenticate api
-    #                             calls (required unless password
-    #                             authentication is used).
-    #           :refresh_token  - The String refresh token to obtain fresh
-    #                             oauth access tokens (required if oauth
-    #                             authentication is used).
-    #           :instance_url   - The String base url for all api requests
-    #                             (required if oauth authentication is used).
+    #           :oauth_token            - The String oauth access token to authenticate api
+    #                                     calls (required unless password
+    #                                     authentication is used).
+    #           :refresh_token          - The String refresh token to obtain fresh
+    #                                     oauth access tokens (required if oauth
+    #                                     authentication is used).
+    #           :instance_url           - The String base url for all api requests
+    #                                     (required if oauth authentication is used).
     #
-    #           :client_id      - The oauth client id to use. Needed for both
-    #                             password and oauth authentication
-    #           :client_secret  - The oauth client secret to use.
+    #           :client_id              - The oauth client id to use. Needed for both
+    #                                     password and oauth authentication
+    #           :client_secret          - The oauth client secret to use.
     #
-    #           :host           - The String hostname to use during
-    #                             authentication requests (default: 'login.salesforce.com').
+    #           :host                   - The String hostname to use during
+    #                                     authentication requests (default: 'login.salesforce.com').
     #
-    #           :api_version    - The String REST api version to use (default: '24.0')
+    #           :api_version            - The String REST api version to use (default: '24.0')
+    #
+    #           :authentication_retries - The number of times that client
+    #                                     should attempt to reauthenticate
+    #                                     before raising an exception (default: 3).
+    #
+    #           :compress               - Set to true to have Salesforce compress the
+    #                                     response (default: false).
     #
     # Examples
     #
@@ -51,7 +58,7 @@ module Restforce
     def initialize(options = {})
       raise 'Please specify a hash of options' unless options.is_a?(Hash)
       @options = {}.tap do |options|
-        [:username, :password, :security_token, :client_id, :client_secret, :host,
+        [:username, :password, :security_token, :client_id, :client_secret, :host, :compress,
          :api_version, :oauth_token, :refresh_token, :instance_url, :cache, :authentication_retries].each do |option|
           options[option] = Restforce.configuration.send option
         end
@@ -289,10 +296,7 @@ module Restforce
     # Returns the Hash context if the message is valid.
     def decode_signed_request(message)
       raise 'client_secret not set' unless @options[:client_secret]
-      encryped_secret, payload = message.split('.')
-      digest = OpenSSL::Digest::Digest.new('sha256')
-      signature = Base64.encode64(OpenSSL::HMAC.hexdigest(digest, @options[:client_secret], payload))
-      JSON.parse(Base64.decode64(payload)) if encryped_secret == signature
+      Restforce.decode_signed_request(message, @options[:client_secret])
     end
 
     # Public: Helper methods for performing arbitrary actions against the API using
@@ -338,6 +342,19 @@ module Restforce
       end
     end
 
+    # Public: The Faraday::Builder instance used for the middleware stack. This
+    # can be used to insert an custom middleware.
+    #
+    # Examples
+    #
+    #   # Add the instrumentation middleware for Rails.
+    #   client.middleware.use FaradayMiddleware::Instrumentation
+    #
+    # Returns the Faraday::Builder for the Faraday connection.
+    def middleware
+      connection.builder
+    end
+
   private
 
     # Internal: Returns a path to an api endpoint
@@ -364,9 +381,9 @@ module Restforce
         builder.use      FaradayMiddleware::FollowRedirects
         builder.use      Restforce::Middleware::RaiseError
         builder.use      Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
+        builder.use      Restforce::Middleware::Gzip, self, @options
         builder.adapter  Faraday.default_adapter
       end
-      @connection
     end
 
     # Internal: Determines what middleware will be used based on the options provided
@@ -404,7 +421,7 @@ module Restforce
     # Internal: Returns true if the middlware stack includes the
     # Restforce::Middleware::Mashify middleware.
     def mashify?
-      connection.builder.handlers.find { |handler| handler == Restforce::Middleware::Mashify }
+      middleware.handlers.index(Restforce::Middleware::Mashify)
     end
 
     # Internal: Errors that should be rescued from in non-bang methods

data/lib/restforce/config.rb

@@ -63,6 +63,9 @@ module Restforce
     # The number of times reauthentication should be tried before failing.
     attr_accessor :authentication_retries
 
+    # Set to true if you want responses from Salesforce to be gzip compressed.
+    attr_accessor :compress
+
     def initialize
       @api_version            ||= '24.0'
       @host                   ||= 'login.salesforce.com'

data/lib/restforce/middleware.rb

@@ -1,33 +1,29 @@
 module Restforce
-
   # Base class that all middleware can extend. Provides some convenient helper
   # functions.
   class Middleware < Faraday::Middleware
+    autoload :RaiseError,     'restforce/middleware/raise_error'
+    autoload :Authentication, 'restforce/middleware/authentication'
+    autoload :Authorization,  'restforce/middleware/authorization'
+    autoload :InstanceURL,    'restforce/middleware/instance_url'
+    autoload :Multipart,      'restforce/middleware/multipart'
+    autoload :Mashify,        'restforce/middleware/mashify'
+    autoload :Caching,        'restforce/middleware/caching'
+    autoload :Logger,         'restforce/middleware/logger'
+    autoload :Gzip,           'restforce/middleware/gzip'
 
     def initialize(app, client, options)
-      @app     = app
-      @client  = client
-      @options = options
+      @app, @client, @options = app, client, options
     end
 
+    # Internal: Proxy to the client.
     def client
       @client
     end
 
+    # Internal: Proxy to the client's faraday connection.
     def connection
       client.send(:connection)
     end
-
   end
 end
-
-require 'restforce/middleware/raise_error'
-require 'restforce/middleware/authentication'
-require 'restforce/middleware/authentication/password'
-require 'restforce/middleware/authentication/token'
-require 'restforce/middleware/authorization'
-require 'restforce/middleware/instance_url'
-require 'restforce/middleware/mashify'
-require 'restforce/middleware/multipart'
-require 'restforce/middleware/caching'
-require 'restforce/middleware/logger'

data/lib/restforce/middleware/authentication.rb

@@ -1,11 +1,14 @@
 module Restforce
-
   # Faraday middleware that allows for on the fly authentication of requests.
-  # When a request fails (ie. A status of 401 is returned). The middleware
+  # When a request fails (a status of 401 is returned), the middleware
   # will attempt to either reauthenticate (username and password) or refresh
   # the oauth access token (if a refresh token is present).
   class Middleware::Authentication < Restforce::Middleware
+    autoload :Password, 'restforce/middleware/authentication/password'
+    autoload :Token,    'restforce/middleware/authentication/token'
 
+    # Rescue from 401's, authenticate then raise the error again so the client
+    # can reissue the request.
     def call(env)
       @app.call(env)
     rescue Restforce::UnauthorizedError
@@ -13,6 +16,7 @@ module Restforce
       raise
     end
 
+    # Internal: Performs the authentication and returns the response body.
     def authenticate!
       response = connection.post '/services/oauth2/token' do |req|
         req.body = URI.encode_www_form params
@@ -23,10 +27,12 @@ module Restforce
       response.body
     end
 
+    # Internal: The params to post to the OAuth service.
     def params
       raise 'not implemented'
     end
 
+    # Internal: Faraday connection to use when sending an authentication request.
     def connection
       @connection ||= Faraday.new(:url => "https://#{@options[:host]}") do |builder|
         builder.use Restforce::Middleware::Mashify, nil, @options
@@ -36,10 +42,9 @@ module Restforce
       end
     end
 
+    # Internal: The parsed error response.
     def error_message(response)
       "#{response.body['error']}: #{response.body['error_description']}"
     end
-  
   end
-
 end

data/lib/restforce/middleware/gzip.rb

@@ -0,0 +1,31 @@
+require 'zlib'
+
+module Restforce
+  # Middleware to uncompress GZIP compressed responses from Salesforce.
+  class Middleware::Gzip < Restforce::Middleware
+    ACCEPT_ENCODING_HEADER  = 'Accept-Encoding'.freeze
+    CONTENT_ENCODING_HEADER = 'Content-Encoding'.freeze
+    ENCODING                = 'gzip'.freeze
+
+    def call(env)
+      env[:request_headers][ACCEPT_ENCODING_HEADER] = ENCODING if @options[:compress]
+      @app.call(env).on_complete do |environment|
+        on_complete(environment)
+      end
+    end
+
+    def on_complete(env)
+      env[:body] = decompress(env[:body]) if gzipped?(env)
+    end
+
+    # Internal: Returns true if the response is gzipped.
+    def gzipped?(env)
+      env[:response_headers][CONTENT_ENCODING_HEADER] == ENCODING
+    end
+
+    # Internal: Decompresses a gzipped string.
+    def decompress(body)
+      Zlib::GzipReader.new(StringIO.new(body)).read
+    end
+  end
+end

data/lib/restforce/middleware/raise_error.rb

@@ -17,7 +17,7 @@ module Restforce
     end
 
     def body
-      @body ||= JSON.parse(@env[:body])
+      JSON.parse(@env[:body])
     end
   end
 end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/lib/client_spec.rb

@@ -70,7 +70,8 @@ shared_examples_for 'methods' do
   describe '.describe' do
     context 'with no arguments' do
       before do
-        @request = stub_api_request :sobjects, with: 'sobject/describe_sobjects_success_response'
+        @request = stub_api_request :sobjects,
+          with: 'sobject/describe_sobjects_success_response'
       end
 
       after do
@@ -83,7 +84,8 @@ shared_examples_for 'methods' do
 
     context 'with an argument' do
       before do
-        @request = stub_api_request 'sobjects/Whizbang/describe', with: 'sobject/sobject_describe_success_response'
+        @request = stub_api_request 'sobjects/Whizbang/describe',
+          with: 'sobject/sobject_describe_success_response'
       end
 
       after do
@@ -97,7 +99,8 @@ shared_examples_for 'methods' do
 
   describe '.query' do
     before do
-      @request = stub_api_request 'query\?q=SELECT%20some,%20fields%20FROM%20object', with: 'sobject/query_success_response'
+      @request = stub_api_request 'query\?q=SELECT%20some,%20fields%20FROM%20object',
+        with: 'sobject/query_success_response'
     end
 
     after do
@@ -110,7 +113,8 @@ shared_examples_for 'methods' do
 
   describe '.search' do
     before do
-      @request = stub_api_request 'search\?q=FIND%20%7Bbar%7D', with: 'sobject/search_success_response'
+      @request = stub_api_request 'search\?q=FIND%20%7Bbar%7D',
+        with: 'sobject/search_success_response'
     end
 
     after do
@@ -124,7 +128,8 @@ shared_examples_for 'methods' do
 
   describe '.org_id' do
     before do
-      @request = stub_api_request 'query\?q=select%20id%20from%20Organization', with: 'sobject/org_query_response'
+      @request = stub_api_request 'query\?q=select%20id%20from%20Organization',
+        with: 'sobject/org_query_response'
     end
 
     after do
@@ -138,7 +143,10 @@ shared_examples_for 'methods' do
   describe '.create' do
     context 'without multipart' do
       before do
-        @request = stub_api_request 'sobjects/Account', with: 'sobject/create_success_response', method: :post, body: "{\"Name\":\"Foobar\"}"
+        @request = stub_api_request 'sobjects/Account',
+          with: 'sobject/create_success_response',
+          method: :post,
+          body: "{\"Name\":\"Foobar\"}"
       end
 
       after do
@@ -151,7 +159,10 @@ shared_examples_for 'methods' do
 
     context 'with multipart' do
       before do
-        @request = stub_api_request 'sobjects/Account', with: 'sobject/create_success_response', method: :post, body: %r(----boundary_string\r\nContent-Disposition: form-data; name=\"entity_content\";\r\nContent-Type: application/json\r\n\r\n{\"Name\":\"Foobar\"}\r\n----boundary_string\r\nContent-Disposition: form-data; name=\"Blob\"; filename=\"blob.jpg\"\r\nContent-Length: 42171\r\nContent-Type: image/jpeg\r\nContent-Transfer-Encoding: binary)
+        @request = stub_api_request 'sobjects/Account',
+          with: 'sobject/create_success_response',
+          method: :post,
+          body: %r(----boundary_string\r\nContent-Disposition: form-data; name=\"entity_content\";\r\nContent-Type: application/json\r\n\r\n{\"Name\":\"Foobar\"}\r\n----boundary_string\r\nContent-Disposition: form-data; name=\"Blob\"; filename=\"blob.jpg\"\r\nContent-Length: 42171\r\nContent-Type: image/jpeg\r\nContent-Transfer-Encoding: binary)
       end
 
       after do
@@ -166,7 +177,11 @@ shared_examples_for 'methods' do
   describe '.update!' do
     context 'with invalid Id' do
       before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :patch, body: "{\"Name\":\"Foobar\"}", status: 404
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
+          with: 'sobject/delete_error_response',
+          method: :patch,
+          body: "{\"Name\":\"Foobar\"}",
+          status: 404
       end
 
       after do
@@ -186,7 +201,11 @@ shared_examples_for 'methods' do
 
     context 'with invalid Id' do
       before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :patch, body: "{\"Name\":\"Foobar\"}", status: 404
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
+          with: 'sobject/delete_error_response',
+          method: :patch,
+          body: "{\"Name\":\"Foobar\"}",
+          status: 404
       end
 
       after do
@@ -199,7 +218,9 @@ shared_examples_for 'methods' do
 
     context 'with success' do
       before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe', method: :patch, body: "{\"Name\":\"Foobar\"}"
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
+          method: :patch,
+          body: "{\"Name\":\"Foobar\"}"
       end
 
       after do
@@ -221,7 +242,9 @@ shared_examples_for 'methods' do
   describe '.upsert!' do
     context 'when updated' do
       before do
-        @request = stub_api_request 'sobjects/Account/External__c/foobar', method: :patch, body: "{\"Name\":\"Foobar\"}"
+        @request = stub_api_request 'sobjects/Account/External__c/foobar',
+          method: :patch,
+          body: "{\"Name\":\"Foobar\"}"
       end
 
       after do
@@ -241,7 +264,10 @@ shared_examples_for 'methods' do
 
     context 'when created' do
       before do
-        @request = stub_api_request 'sobjects/Account/External__c/foobar', method: :patch, body: "{\"Name\":\"Foobar\"}", with: 'sobject/upsert_created_success_response'
+        @request = stub_api_request 'sobjects/Account/External__c/foobar',
+          method: :patch,
+          body: "{\"Name\":\"Foobar\"}",
+          with: 'sobject/upsert_created_success_response'
       end
 
       after do
@@ -265,7 +291,10 @@ shared_examples_for 'methods' do
 
     context 'with invalid Id' do
       before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :delete, status: 404
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
+          with: 'sobject/delete_error_response',
+          method: :delete,
+          status: 404
       end
 
       after do
@@ -293,7 +322,10 @@ shared_examples_for 'methods' do
 
     context 'with invalid Id' do
       before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :delete, status: 404
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
+          with: 'sobject/delete_error_response',
+          method: :delete,
+          status: 404
       end
 
       after do
@@ -318,10 +350,9 @@ shared_examples_for 'methods' do
 
   describe '.authenticate!' do
     before do
-      @request = stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
-        with(:body => "grant_type=password&client_id=client_id&client_secret=" \
-        "client_secret&username=foo&password=barsecurity_token").
-        to_return(:status => 200, :body => fixture(:auth_success_response))
+      @request = stub_login_request(body: "grant_type=password&client_id=client_id&client_secret=" \
+        "client_secret&username=foo&password=barsecurity_token")
+        .to_return(status: 200, body: fixture(:auth_success_response))
     end
 
     after do
@@ -360,11 +391,25 @@ shared_examples_for 'methods' do
     end
   end
 
+  describe '.middleware' do
+    subject { client.middleware }
+    it { should eq client.send(:connection).builder }
+
+    context 'adding middleware' do
+      before do
+        client.middleware.use FaradayMiddleware::Instrumentation
+      end
+
+      its(:handlers) { should include FaradayMiddleware::Instrumentation }
+    end
+  end
+
   describe '.without_caching' do
     let(:cache) { double('cache') }
 
     before do
-      @request = stub_api_request 'query\?q=SELECT%20some,%20fields%20FROM%20object', with: 'sobject/query_success_response'
+      @request = stub_api_request 'query\?q=SELECT%20some,%20fields%20FROM%20object',
+        with: 'sobject/query_success_response'
       cache.should_receive(:fetch).never
     end
 
@@ -400,11 +445,12 @@ shared_examples_for 'methods' do
   describe 'authentication retries' do
     context 'when retries reaches 0' do
       before do
-        @auth_request = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object', status: 401, with: 'expired_session_response')
-        @query_request = stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
-          .with(:body => "grant_type=password&client_id=client_id&client_secret=" \
+        @auth_request = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object',
+          status: 401,
+          with: 'expired_session_response')
+        @query_request = stub_login_request(body: "grant_type=password&client_id=client_id&client_secret=" \
           "client_secret&username=foo&password=barsecurity_token")
-          .to_return(:status => 200, :body => fixture(:auth_success_response))
+          .to_return(status: 200, body: fixture(:auth_success_response))
       end
 
       subject { client.query('SELECT some, fields FROM object') }
@@ -430,13 +476,12 @@ shared_examples_for 'methods' do
     let(:cache) { MockCache.new }
 
     before do
-      @query = stub_request(:get, /query\?q=SELECT%20some,%20fields%20FROM%20object/)
+      @query = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object')
         .with(headers: { 'Authorization' => "OAuth #{oauth_token}" })
         .to_return(status: 401, body: fixture('expired_session_response')).then
         .to_return(status: 200, body: fixture('sobject/query_success_response'))
 
-      @login = stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
-        .with(:body => "grant_type=password&client_id=client_id&client_secret=" \
+      @login = stub_login_request(body: "grant_type=password&client_id=client_id&client_secret=" \
         "client_secret&username=foo&password=barsecurity_token")
         .to_return(status: 200, body: fixture(:auth_success_response))
     end
@@ -485,7 +530,7 @@ end
 
 describe 'without mashify middleware' do
   before do
-    client.send(:connection).builder.delete(Restforce::Middleware::Mashify)
+    client.middleware.delete(Restforce::Middleware::Mashify)
   end
 
   describe Restforce::Client do

data/spec/lib/config_spec.rb

@@ -15,15 +15,15 @@ describe Restforce do
       its(:host)                   { should eq 'login.salesforce.com' }
       its(:authentication_retries) { should eq 3 }
       [:username, :password, :security_token, :client_id, :client_secret,
-       :oauth_token, :refresh_token, :instance_url].each do |attr|
+       :oauth_token, :refresh_token, :instance_url, :compress].each do |attr|
         its(attr) { should be_nil }
       end
     end
   end
 
   describe '#configure' do
-    [:username, :password, :security_token, :client_id, :client_secret,
-     :oauth_token, :refresh_token, :instance_url, :api_version, :host].each do |attr|
+    [:username, :password, :security_token, :client_id, :client_secret, :compress,
+     :oauth_token, :refresh_token, :instance_url, :api_version, :host, :authentication_retries].each do |attr|
       it "allows #{attr} to be set" do
         Restforce.configure do |config|
           config.send("#{attr}=", 'foobar')

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

@@ -16,17 +16,15 @@ describe Restforce::Middleware::Authentication::Password do
 
   it_behaves_like 'authentication middleware' do
     let(:success_request) do
-      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
-        with(:body => "grant_type=password&client_id=client_id&client_secret=" \
-        "client_secret&username=foo&password=barsecurity_token").
-        to_return(:status => 200, :body => fixture(:auth_success_response))
+      stub_login_request(body: "grant_type=password&client_id=client_id&client_secret=" \
+        "client_secret&username=foo&password=barsecurity_token")
+        .to_return(status: 200, body: fixture(:auth_success_response))
     end
 
     let(:fail_request) do
-      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
-        with(:body => "grant_type=password&client_id=client_id&client_secret=" \
-        "client_secret&username=foo&password=barsecurity_token").
-        to_return(:status => 400, :body => fixture(:auth_error_response))
+      stub_login_request(body: "grant_type=password&client_id=client_id&client_secret=" \
+        "client_secret&username=foo&password=barsecurity_token")
+        .to_return(status: 400, body: fixture(:auth_error_response))
     end
   end
 

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

@@ -14,17 +14,15 @@ describe Restforce::Middleware::Authentication::Token do
 
   it_behaves_like 'authentication middleware' do
     let(:success_request) do
-      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
-        with(:body => "grant_type=refresh_token&refresh_token=refresh_token&" \
-        "client_id=client_id&client_secret=client_secret").
-        to_return(:status => 200, :body => fixture(:auth_success_response))
+      stub_login_request(body: "grant_type=refresh_token&refresh_token=refresh_token&" \
+        "client_id=client_id&client_secret=client_secret")
+        .to_return(:status => 200, :body => fixture(:auth_success_response))
     end
 
     let(:fail_request) do
-      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
-        with(:body => "grant_type=refresh_token&refresh_token=refresh_token&" \
-        "client_id=client_id&client_secret=client_secret").
-        to_return(:status => 400, :body => fixture(:refresh_error_response))
+      stub_login_request(body: "grant_type=refresh_token&refresh_token=refresh_token&" \
+        "client_id=client_id&client_secret=client_secret")
+        .to_return(:status => 400, :body => fixture(:refresh_error_response))
     end
   end
 end

data/spec/lib/middleware/gzip_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::Gzip do
+  let(:app)        { double('app')            }
+  let(:env)        { { request_headers: {}, response_headers: {} }  }
+  let(:options)    { { oauth_token: 'token' } }
+  let(:middleware) { described_class.new app, nil, options }
+
+  # Return a gzipped string.
+  def gzip(str)
+    StringIO.new.tap do |io|
+      gz = Zlib::GzipWriter.new(io)
+      gz.write(str)
+      gz.close
+    end.string
+  end
+
+  describe 'request' do
+    before do
+      app.should_receive(:on_complete) { middleware.on_complete(env) }
+      app.should_receive(:call).and_return(app)
+    end
+
+    context 'when :compress is false' do
+      it 'does not add the Accept-Encoding header' do
+        middleware.call(env)
+        env[:request_headers]['Accept-Encoding'].should be_nil
+      end
+    end
+
+    context 'when :compress is true' do
+      before do
+        options[:compress] = true
+      end
+
+      it 'adds the Accept-Encoding header' do
+        middleware.call(env)
+        env[:request_headers]['Accept-Encoding'].should eq 'gzip'
+      end
+    end
+  end
+
+  describe 'response' do
+    before do
+      app.should_receive(:on_complete) { middleware.on_complete(env) }
+      app.should_receive(:call) do
+        env[:body] = gzip fixture('sobject/query_success_response')
+        env[:response_headers]['Content-Encoding'] = 'gzip'
+        app
+      end
+    end
+
+    it 'decompresses the response body' do
+      middleware.call(env)
+      env[:body].should eq fixture('sobject/query_success_response')
+    end
+  end
+
+  describe '.decompress' do
+    let(:body) { gzip fixture('sobject/query_success_response') }
+
+    subject { middleware.decompress(body) }
+    it { should eq fixture('sobject/query_success_response') }
+  end
+
+  describe '.gzipped?' do
+    subject { middleware.gzipped?(env) }
+
+    context 'when gzipped' do
+      before do
+        env[:response_headers]['Content-Encoding'] = 'gzip'
+      end
+
+      it { should be_true }
+    end
+
+    context 'when not gzipped' do
+      it { should be_false }
+    end
+  end
+end

data/spec/support/fixture_helpers.rb

@@ -2,15 +2,26 @@ module FixtureHelpers
 
   def stub_api_request(endpoint, options = {})
     options = {
-      :method => :get,
-      :status => 200,
-      :api_version => '24.0',
-      :with => nil
+      method: :get,
+      status: 200,
+      api_version: '24.0',
+      with: nil
     }.merge(options)
 
     stub = stub_request(options[:method], %r{/services/data/v#{options[:api_version]}/#{endpoint}})
-    stub = stub.with(:body => options[:body]) if options[:body]
-    stub = stub.to_return(:status => options[:status], :body => options[:with] ? fixture(options[:with]) : '')
+    stub = stub.with(body: options[:body]) if options[:body]
+    stub = stub.to_return(status: options[:status], body: fixture(options[:with])) if options[:with]
+    stub
+  end
+
+  def stub_login_request(options = {})
+    options = {
+      body: nil
+    }.merge(options)
+
+    stub = stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
+    stub = stub.with(body: options[:body]) if options[:body]
+    stub
   end
 
   def fixture(f)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-25 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -180,6 +180,7 @@ files:
 - lib/restforce/middleware/authentication/token.rb
 - lib/restforce/middleware/authorization.rb
 - lib/restforce/middleware/caching.rb
+- lib/restforce/middleware/gzip.rb
 - lib/restforce/middleware/instance_url.rb
 - lib/restforce/middleware/logger.rb
 - lib/restforce/middleware/mashify.rb
@@ -228,6 +229,7 @@ files:
 - spec/lib/middleware/authentication/token_spec.rb
 - spec/lib/middleware/authentication_spec.rb
 - spec/lib/middleware/authorization_spec.rb
+- spec/lib/middleware/gzip_spec.rb
 - spec/lib/middleware/instance_url_spec.rb
 - spec/lib/middleware/logger_spec.rb
 - spec/lib/middleware/mashify_spec.rb
@@ -301,6 +303,7 @@ test_files:
 - spec/lib/middleware/authentication/token_spec.rb
 - spec/lib/middleware/authentication_spec.rb
 - spec/lib/middleware/authorization_spec.rb
+- spec/lib/middleware/gzip_spec.rb
 - spec/lib/middleware/instance_url_spec.rb
 - spec/lib/middleware/logger_spec.rb
 - spec/lib/middleware/mashify_spec.rb