restforce-db 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1278678ebc70c7c955fb0dd857dbabe6f2bb2df1
-  data.tar.gz: e2368e5b966d3e7934e3395c350917d3563549d1
+  metadata.gz: 426c96af98332d2afd82da60f56121eaae4197e2
+  data.tar.gz: 7d6fdb0c0b304e9ce2cd4149e502a85cf6b98263
 SHA512:
-  metadata.gz: 0fab8292b39f202beb9b5c43080d0ed67d3077a9d5048919683d6ce9fbc05c537c4900b7798623aaeb8c679e1fdb828af00fba24c87a0568f4bc769cdc0330e5
-  data.tar.gz: aa2c720cdd35f01cb23bedbc58000f8baed4b9d582ac49ab0021024b2f0e1a23e0d0a6b5067f4a12e42dcecd44d91ec5175ed36455c57dc69ce6663e5947c947
+  metadata.gz: ed5d4a11b2b27fe9003e81c9ed0b68cd86fd43cc706d77443d43ee182f8726f35030efe030a65d17ba2a72439850da7a03d03e8941276b523cf3af10a451fe17
+  data.tar.gz: 9226923f587bbefa6e041a0a918e7e36b9e22ddcd5d78f991449a630854cdf1ec9684b3e4c7d37ad6f17fed4913fbce385f9e2f11491e897cc641c1427f12676

data/README.md

@@ -319,6 +319,10 @@ If you're testing your integration, and using something like VCR to record your
 
   Restforce::DB attempts to mitigate this effect by tracking change timestamps for internal updates.
 
+## Instrumentation
+
+Restforce::DB uses a [Faraday](https://github.com/lostisland/faraday) middleware to add API interaction [instrumentation](https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/instrumentation.rb), as described in [Restforce's documentation](https://github.com/ejholmes/restforce#loggingdebugginginstrumenting) through [Active Support notifications](http://guides.rubyonrails.org/active_support_instrumentation.html).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/restforce/db/middleware/store_request_body.rb

@@ -0,0 +1,31 @@
+module Restforce
+
+  module DB
+
+    module Middleware
+
+      # Public: A Faraday middleware to store the request body in the environment.
+      #
+      # This works around an issue with Faraday where the request body is squashed by
+      # the response body, once a request has been made.
+      #
+      # See also:
+      # - https://github.com/lostisland/faraday/issues/163
+      # - https://github.com/lostisland/faraday/issues/297
+      class StoreRequestBody < Faraday::Middleware
+
+        # Public: Executes this middleware.
+        #
+        # request_env - The request's Env from Faraday.
+        def call(request_env)
+          request_env[:request_body] = request_env[:body]
+          @app.call(request_env)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/restforce/db/version.rb

@@ -3,7 +3,7 @@ module Restforce
   # :nodoc:
   module DB
 
-    VERSION = "3.2.2"
+    VERSION = "3.3.0"
 
   end
 

data/lib/restforce/db.rb

@@ -5,6 +5,7 @@ require "restforce/extensions"
 
 require "restforce/db/version"
 require "restforce/db/client"
+require "restforce/db/middleware/store_request_body"
 require "restforce/db/configuration"
 require "restforce/db/registry"
 require "restforce/db/strategy"
@@ -96,20 +97,36 @@ module Restforce
           timeout:        configuration.timeout,
           adapter:        configuration.adapter,
         )
-
-        # NOTE: By default, the Retry middleware will catch timeout exceptions,
-        # and retry up to two times. For more information, see:
-        # https://github.com/lostisland/faraday/blob/master/lib/faraday/request/retry.rb
-        client.middleware.insert(
-          -2,
-          Faraday::Request::Retry,
-          methods: [:get, :head, :options, :put, :patch, :delete],
-        )
-
+        setup_middleware(client)
         client
       end
     end
 
+    # Internal: Sets up the Restforce client's middleware handlers.
+    #
+    # Returns nothing.
+    def self.setup_middleware(client)
+      # NOTE: By default, the Retry middleware will catch timeout exceptions,
+      # and retry up to two times. For more information, see:
+      # https://github.com/lostisland/faraday/blob/master/lib/faraday/request/retry.rb
+      client.middleware.insert(
+        -2,
+        Faraday::Request::Retry,
+        methods: [:get, :head, :options, :put, :patch, :delete],
+      )
+
+      client.middleware.insert_after(
+        Restforce::Middleware::InstanceURL,
+        FaradayMiddleware::Instrumentation,
+        name: "request.restforce_db",
+      )
+
+      client.middleware.insert_before(
+        FaradayMiddleware::Instrumentation,
+        Restforce::DB::Middleware::StoreRequestBody,
+      )
+    end
+
     # Public: Get the ID of the Salesforce user which is being used to access
     # the Salesforce API.
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -230,6 +230,7 @@ files:
 - lib/restforce/db/instances/base.rb
 - lib/restforce/db/instances/salesforce.rb
 - lib/restforce/db/mapping.rb
+- lib/restforce/db/middleware/store_request_body.rb
 - lib/restforce/db/model.rb
 - lib/restforce/db/railtie.rb
 - lib/restforce/db/record_cache.rb