spyke 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccd9957900a277390812c84d78b30985292cb2a9
-  data.tar.gz: c5cdb9be619f68febc8b20a51d339db19fcb7d4e
+  metadata.gz: 0d5dfe590d65f64f97fda8760b3c75ea3900d494
+  data.tar.gz: be9546662e362944f6ea66373c76821e23d1acb1
 SHA512:
-  metadata.gz: af321cc8a304dc3e169ce7d31f113db4a7032de30f4b96e886d3ad8db6961a66b8f88ae932f732aa733b272a69a9840dc5226e9692cb40b3047bc4b44dadbe16
-  data.tar.gz: cddd07072bde4a26fe0bfa5b497747f612f09327f7e7edb35f8f9e428959b32fdbaa90d1bd87e611e500e916e16b730fdfd05460a8e9b7d983ccd4c85ac460c5
+  metadata.gz: af83b406e410df06ea8fcb0ab4eee9c811ec1a38e3ebaefefd0d83bcac4ced8436130b4f49ed370264795d21a11bdfe32f6abc0bad3443d25d4fcc061f5f68a5
+  data.tar.gz: 10a68a38089bf195ace08b6a9e90010e383113dba3e6c6b11e7bf49079bdbde93fb94367a3e8333400ce269b967b3a096ebab641f038b7a9d30294aeb99c9c49

data/README.md

@@ -14,7 +14,7 @@
 
 ---
 
-Spyke basically ~~rips off~~ takes inspiration :innocent: from [Her](https://github.com/remiprev/her), a gem which we sadly had to abandon as it showed significant performance problems and maintenance seemed to had gone stale.
+Spyke basically ~~rips off~~ takes inspiration :innocent: from [Her](https://github.com/remiprev/her), a gem which we sadly had to abandon as it gave us some performance problems and maintenance seemed to had gone stale.
 
 We therefore made Spyke which adds a few fixes/features that we needed for our projects:
 
@@ -34,7 +34,7 @@ gem 'spyke'
 Like Her, Spyke uses Faraday to handle requests and expects it to return a hash in the following format:
 
 ```ruby
-{ data: { id: 1, name: 'Bob' }, metadata: {} }
+{ data: { id: 1, name: 'Bob' }, metadata: {}, errors: [] }
 ```
 
 The simplest possible configuration that can work is something like this:
@@ -69,8 +69,19 @@ Adding a class and inheriting from `Spyke::Base` will allow you to interact with
 ```ruby
 class User < Spyke::Base
   has_many :posts
+
+  scope :active, -> { where(active: true) }
 end
 
+User.all
+# => GET http://api.com/users
+
+User.active
+# => GET http://api.com/users?active=true
+
+User.where(age: 3).active
+# => GET http://api.com/users?active=true&age=3
+
 user = User.find(3)
 # => GET http://api.com/users/3
 
@@ -108,28 +119,17 @@ user.posts # => GET http://api.com/posts/for_user/3
 Post.find(4) # => GET http://api.com/posts/4
 ```
 
-### Logging/Debugging
+### Log output
 
-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`.
+When used with Rails, Spyke will automatically output helpful
+ActiveRecord-like messages to the main log:
 
 ```bash
 Started GET "/posts" for 127.0.0.1 at 2014-12-01 14:31:20 +0000
 Processing by PostsController#index as HTML
   Parameters: {}
-  GET http://api.com/posts [200]
-```
-
-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
+  Spyke (40.3ms)  GET http://api.com/posts [200]
+Completed 200 OK in 75ms (Views: 64.6ms | Spyke: 40.3ms | ActiveRecord: 0ms)
 ```
 
 ## Contributing

data/lib/spyke.rb

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

data/lib/spyke/http.rb

@@ -23,15 +23,18 @@ module Spyke
       end
 
       def request(method, path, params = {})
-        response = connection.send(method) do |request|
-          if method == :get
-            request.url path.to_s, params
-          else
-            request.url path.to_s
-            request.body = params
+        ActiveSupport::Notifications.instrument('request.spyke', method: method) do |payload|
+          response = connection.send(method) do |request|
+            if method == :get
+              request.url path.to_s, params
+            else
+              request.url path.to_s
+              request.body = params
+            end
           end
+          payload[:url], payload[:status] = response.env.url, response.status
+          Result.new_from_response(response)
         end
-        Result.new_from_response(response)
       end
 
       def new_or_collection_from_result(result)

data/lib/spyke/instrumentation.rb

@@ -0,0 +1,8 @@
+require 'spyke/instrumentation/log_subscriber'
+require 'spyke/instrumentation/controller_runtime'
+
+Spyke::Instrumentation::LogSubscriber.attach_to :spyke
+
+ActiveSupport.on_load(:action_controller) do
+  include Spyke::Instrumentation::ControllerRuntime
+end

data/lib/spyke/instrumentation/controller_runtime.rb

@@ -0,0 +1,38 @@
+module Spyke
+  module Instrumentation
+    module ControllerRuntime
+      extend ActiveSupport::Concern
+
+      protected
+
+        attr_internal :spyke_runtime
+
+        def process_action(action, *args)
+          Spyke::Instrumentation::LogSubscriber.reset_runtime
+          super
+        end
+
+        def cleanup_view_runtime
+          spyke_runtime_before_render = Spyke::Instrumentation::LogSubscriber.reset_runtime
+          self.spyke_runtime = (spyke_runtime || 0) + spyke_runtime_before_render
+          runtime = super
+          spyke_runtime_after_render = Spyke::Instrumentation::LogSubscriber.reset_runtime
+          self.spyke_runtime += spyke_runtime_after_render
+          runtime - spyke_runtime_after_render
+        end
+
+        def append_info_to_payload(payload)
+          super
+          payload[:spyke_runtime] = (spyke_runtime || 0) + Spyke::Instrumentation::LogSubscriber.reset_runtime
+        end
+
+        module ClassMethods
+          def log_process_action(payload)
+            messages, spyke_runtime = super, payload[:spyke_runtime]
+            messages << ("Spyke: %.1fms" % spyke_runtime.to_f) if spyke_runtime
+            messages
+          end
+        end
+    end
+  end
+end

data/lib/spyke/instrumentation/log_subscriber.rb

@@ -0,0 +1,26 @@
+module Spyke
+  module Instrumentation
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      def self.runtime=(value)
+        Thread.current['spyke_request_runtime'] = value
+      end
+
+      def self.runtime
+        Thread.current['spyke_request_runtime'] ||= 0
+      end
+
+      def self.reset_runtime
+        rt, self.runtime = runtime, 0
+        rt
+      end
+
+      def request(event)
+        return unless logger.debug?
+        self.class.runtime += event.duration
+        name = '%s (%.1fms)' % ["Spyke", event.duration]
+        details = "#{event.payload[:method].upcase} #{event.payload[:url]} [#{event.payload[:status]}]"
+        debug "  #{color(name, GREEN, true)}  #{color(details, BOLD, true)}"
+      end
+    end
+  end
+end

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -276,7 +276,9 @@ files:
 - lib/spyke/config.rb
 - lib/spyke/exceptions.rb
 - lib/spyke/http.rb
-- lib/spyke/middleware/rails_logger.rb
+- lib/spyke/instrumentation.rb
+- lib/spyke/instrumentation/controller_runtime.rb
+- lib/spyke/instrumentation/log_subscriber.rb
 - lib/spyke/orm.rb
 - lib/spyke/path.rb
 - lib/spyke/relation.rb

data/lib/spyke/middleware/rails_logger.rb

@@ -1,34 +0,0 @@
-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