spyke 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 351feb9aa7e6aa5486ac90bfee67db3088e1bba3
-  data.tar.gz: dce508b409ac67d45c30746a5608d3e0911d8475
+  metadata.gz: 454a7844a87f1ba6d9797d519a754a02b0ea6da0
+  data.tar.gz: 454dcbda6c25ccc881169c2c0e57bf0498add944
 SHA512:
-  metadata.gz: cec924b0be7293242a30fd358de54aaa9c4d8357fccdc3dd5e1ba3b408f993d4b0d20fa9f81b57ff49fb8cbac7c43620a14d7ba0b5a35a7af505ecde76ac209b
-  data.tar.gz: 5507ca04b4f70ca3a2c5d6b624029c23409414ae14adcfbfd15e55576c6c6c670a0c59ea3817f2e2d77d693adc54ba337c17926840e9008d48e6c38c17459958
+  metadata.gz: b5edf38fa1f17dbf4eac1daad618622b7e0bdfb451e6871a3087f2ee8b32bad74fc9ad06bbeb606136c10da059b5f08ad54b29bc537af38f1010cdf5550809b3
+  data.tar.gz: 4a5f406bcb26f80e40e9cfd341af96c0e2ee334add9c3db2f067ecb6a25a327e8a4af0abc64be5595c51a606ee0d2b8adac6410639d18ba20a0198f43fbe2cb2

data/README.md

@@ -89,6 +89,23 @@ user.posts # => GET http://api.com/posts/for_user/3
 Post.find(4) # => GET http://api.com/posts/4
 ```
 
+### Logging/Debugging
+
+Spyke comes with Faraday middleware for Rails that will output helpful
+ActiveRecord-like output to the main log as well as keep a record of
+request/responses in  `/log/faraday.log`.
+
+To use it, simply add it to the stack of middleware:
+
+```ruby
+Spyke::Config.connection = Faraday.new(url: 'http://api.com') do |c|
+  c.request   :json
+  c.use       JSONParser
+  c.use       Spyke::Middleware::RailsLogger if Rails.env.development?
+  c.use       Faraday.default_adapter
+end
+```
+
 ## Contributing
 
 If possible please take a look at the tests marked "wishlisted"!

data/lib/spyke.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext'
 require 'spyke/base'
+require 'spyke/middleware/rails_logger' if defined?(Rails)
 require 'spyke/version'
 
 module Spyke

data/lib/spyke/middleware/rails_logger.rb

@@ -0,0 +1,34 @@
+module Spyke
+  module Middleware
+    class RailsLogger < Faraday::Middleware
+      CLEAR   = "\e[0m"
+      BOLD    = "\e[1m"
+      MAGENTA = "\e[35m"
+
+      def call(env)
+        logger.formatter = -> (severity, datetime, progname, msg) { msg }
+
+        logger.debug "\n\n\n\n#{env[:method].upcase} #{env[:url]}"
+        logger.debug "\n  Headers: #{env[:request_headers]}"
+        logger.debug "\n  Body: #{env[:body]}" if env[:body]
+
+        @app.call(env).on_complete do
+          Rails.logger.debug "  #{BOLD}#{MAGENTA}#{env[:method].upcase} #{env[:url]} [#{env[:status]}]#{CLEAR}"
+          logger.debug "\n\nCompleted #{env[:status]}"
+          logger.debug "\n  Headers: #{env[:response_headers]}"
+          logger.debug "\n  Body: #{truncate_binary_values env[:body]}" if env[:body]
+        end
+      end
+
+      private
+
+        def logger
+          @logger ||= Logger.new Rails.root.join('log', 'faraday.log')
+        end
+
+        def truncate_binary_values(body)
+          body.gsub(/(data:)([^"]+)/, 'data:...')
+        end
+    end
+  end
+end

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2014-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -260,6 +260,7 @@ files:
 - lib/spyke/config.rb
 - lib/spyke/exceptions.rb
 - lib/spyke/http.rb
+- lib/spyke/middleware/rails_logger.rb
 - lib/spyke/orm.rb
 - lib/spyke/path.rb
 - lib/spyke/relation.rb