rack-faraday_inspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95fdbd002b5be9a4b528166a62e9eb9e3bfa5cb0
+  data.tar.gz: c0249d1e1963c4dcc899468ae4b722bc533b4499
+SHA512:
+  metadata.gz: 885457a8bf7c316204a1eeada3102947d8eee6d326648fc43ac0fcf1da0e3e9e545239dac91cadedd3be252589a8a2f4b5d5dc9e9a57d846c85ec38757a3e6af
+  data.tar.gz: 19fd5656a9fa66ee65df837a49dc8157bca02326e0872669eaf1b133a705bf77688a17b3962333cb1c31e6a6015510a51c82ddf87c06591ba46a99b182dcd0e7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-faraday_inspector.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# Rack::FaradayInspector
+
+Rack::FaradayInspector renders a bit of HTML at the bottom of your pages that allows you to inspect all of the requests Faraday made for the current request.
+
+![rack-faraday_inspector](https://cloud.githubusercontent.com/assets/29424/13030496/029e5f7a-d262-11e5-886c-1b8e3b8a6260.gif)
+
+Currently only supports Rails. Requires SASS and jQuery.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-faraday_inspector', github: 'chrisb/rack-faraday_inspector'
+```
+
+I'm still actively working on this Gem, so it has not been pushed to Rubygems yet.
+
+## Usage
+
+To view requests, simply add the middleware to each of the Faraday connections you want to inspect:
+
+```ruby
+require 'rack/faraday_inspector'
+
+Faraday.new url: 'http://www.sushi.com' do |faraday|
+  faraday.use :inspector
+  # ...
+end
+```
+
+Note: only in the `development` environment will requests be instrumented and the inspector rendered.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chrisb/rack-faraday_inspector.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/assets/html/inspector.html.erb

@@ -0,0 +1,60 @@
+<style type='text/css'>
+<!--
+  <%= @css %>
+-->
+</style>
+<h1>I'm here!</h1>
+<div class='faraday_inspector minimized'>
+  <div class='prompt'>
+    <%= Thread.current[:faraday_requests].count %> Faraday Request<%= 's' unless Thread.current[:faraday_requests].to_a.count == 1 %>
+  </div>
+  <div class='close'>&times;</div>
+  <table class='faraday_inspector-requests'>
+    <% Thread.current[:faraday_requests].to_a.each do |event| %>
+      <% req = event[:env] %>
+      <tr class='event'>
+        <td class='method'><%= req.method.upcase %></td>
+        <td class='host'><%= req.url.host %></td>
+        <td class='path'><%= req.url.path %></td>
+        <td class='duration'><%= event[:duration].round(2) %>s</td>
+        <td class='status'><%= req.status %></td>
+      </tr>
+      <tr>
+        <td colspan='5'>
+          <div class='request'>
+            <% if req[:body].present? %>
+              <% body = req[:body] %>
+              <% body = JSON.pretty_generate(JSON.parse(req[:body])) if req[:response_headers]['content-type'].to_s.include?('json') %>
+              <%= CGI.escapeHTML(body).gsub("\n", "<br />") %>
+            <% else %>
+              (No body for this request.)
+            <% end %>
+          </div>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>
+<script type="text/javascript">
+//<![CDATA[
+  var closeAllRequests = function() {
+    $('.faraday_inspector table .request').removeClass('open');
+  }
+
+  var showFaradayRequest = function(e) {
+    var $el = $(this).next().find('.request');
+    var isOpen = $el.hasClass('open');
+    closeAllRequests();
+    if(!isOpen) { $el.addClass('open'); }
+  }
+
+  var toggleFardayInspector = function(e) {
+    closeAllRequests();
+    $('.faraday_inspector').toggleClass('minimized');
+    $('.faraday_inspector').toggleClass('open');
+  };
+
+  $('.faraday_inspector tr.event').click(showFaradayRequest);
+  $('.faraday_inspector .prompt, .faraday_inspector .close').click(toggleFardayInspector);
+//]]>
+</script>

data/assets/sass/styles.scss

@@ -0,0 +1,72 @@
+.faraday_inspector {
+  position: absolute;
+  bottom: 0;
+  left: 0;
+  background-color: #f2f2f2;
+  font-size: 12px;
+  font-family: 'Helvetica Neue', sans-serif;
+
+  &.minimized {
+    border: 1px solid #eee;
+    border-top-right-radius: 8px;
+    padding: 8px;
+    table { display: none; }
+    .request { display: none; }
+    .close { display: none; }
+  }
+
+  &.open {
+    width: 100%;
+    border-top: 1px solid #eee;
+    .prompt { display: none; }
+    .close {
+      display: inline-block;
+      position: absolute;
+      top: 0;
+      right: 0;
+      padding: 6px;
+      font-size: 14px;
+    }
+  }
+
+  .event {
+    .method { font-weight: bold; }
+    .host, .duration, .status { color: #aaa; }
+    .host, .duration, .status, .method { width: 60px; }
+    .host, .duration, .status { text-align: right;  }
+    .method { text-align: center; }
+  }
+
+  .request {
+    max-height: 400px;
+    text-overflow: scroll;
+    overflow: scroll;
+    font-family: 'Source Code Pro Light', 'Menlo', monospace;
+    margin: 10px;
+    background-color: #fff;
+    // border: 1px solid #aaa;
+    padding: 8px;
+  }
+
+  .prompt, .close {
+    cursor: pointer;
+    cursor: hand;
+    font-weight: bold;
+  }
+
+  table {
+    width: 100%;
+    font-family: 'Source Code Pro Light', 'Menlo', monospace;
+    .request {
+      display: none;
+    }
+    .request.open {
+      display: block;
+    }
+    tr.event:hover {
+      cursor: hand;
+      cursor: pointer;
+      background-color: #ffe;
+    }
+  }
+}

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/faraday_inspector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/faraday/inspector.rb

@@ -0,0 +1,12 @@
+require 'faraday_middleware/instrumentation'
+
+module Faraday
+  class Inspector < FaradayMiddleware::Instrumentation
+    def initialize(app, options = {})
+      super(app)
+      @name = options.fetch(:name, 'request.faraday.inspector')
+    end
+  end
+end
+
+Faraday::Middleware.register_middleware inspector: -> { Faraday::Inspector }

data/lib/rack/faraday_inspector.rb

@@ -0,0 +1,4 @@
+require 'faraday/inspector'
+require 'rack/faraday_inspector/version'
+require 'rack/faraday_inspector/middleware'
+require 'rack/faraday_inspector/railtie'

data/lib/rack/faraday_inspector/middleware.rb

@@ -0,0 +1,67 @@
+module Rack
+  module FaradayInspector
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def template_path(*paths)
+        ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'assets', *paths))
+      end
+
+      def css_template_path
+        template_path('sass', 'styles.scss')
+      end
+
+      def css_template
+        ::File.open(css_template_path).read
+      end
+
+      def render_css
+        @css = Sass::Engine.new(css_template,{
+          cache: true,
+          syntax: :scss,
+          style: :compressed,
+          filename: css_template_path,
+        }).render
+      end
+
+      def template
+        ::File.open(template_path('html', 'inspector.html.erb')).read
+      end
+
+      def content
+        render_css
+        ERB.new(template).result(binding)
+      end
+
+      def clear_requests
+        Thread.current[:faraday_requests] = nil
+      end
+
+      def call(env)
+        status, headers, response = @app.call(env)
+
+        if headers['Content-Type'].to_s.include? 'text/html'
+          new_response = []
+          response.each do |body|
+            partition = body.rpartition('</body>')
+            partition[0] += content.to_s
+            new_response << partition.join
+          end
+
+          # Update the content-length
+          headers['Content-Length'] = new_response.inject(0) do |len, body|
+            len += body.bytesize
+          end.to_s
+
+          [status, headers, new_response]
+        else
+          [status, headers, response]
+        end
+      ensure
+        clear_requests
+      end
+    end
+  end
+end

data/lib/rack/faraday_inspector/railtie.rb

@@ -0,0 +1,21 @@
+module Rack
+  module FaradayInspector
+    class Railtie < Rails::Railtie
+      initializer 'rack.faraday_inspector.subscribe' do
+        next unless Rails.env.development?
+        ActiveSupport::Notifications.subscribe('request.faraday.inspector') do |name, starts, ends, _, env|
+          Thread.current[:faraday_requests] ||= []
+          Thread.current[:faraday_requests] << {
+            env: env,
+            duration: ends - starts
+          }
+        end
+      end
+
+      initializer "rack.faraday_inspector.inject_middleware" do
+        next unless Rails.env.development?
+        Rails.application.middleware.use Rack::FaradayInspector::Middleware
+      end
+    end
+  end
+end

data/lib/rack/faraday_inspector/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module FaradayInspector
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack_faraday_inspector.rb

@@ -0,0 +1 @@
+require 'rack/faraday_inspector'

data/rack-faraday_inspector.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/faraday_inspector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-faraday_inspector"
+  spec.version       = Rack::FaradayInspector::VERSION
+  spec.authors       = ["Chris Bielinski"]
+  spec.email         = ["chris@shadow.io"]
+
+    spec.summary       = %q{View Faraday requests made in your controllers on rendered pages}
+  spec.description   = %q{View Faraday requests made in your controllers on rendered pages}
+  spec.homepage      = "https://github.com/chrisb/rack-faraday_inspector"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rack-faraday_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Bielinski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: View Faraday requests made in your controllers on rendered pages
+email:
+- chris@shadow.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- assets/html/inspector.html.erb
+- assets/sass/styles.scss
+- bin/console
+- bin/setup
+- lib/faraday/inspector.rb
+- lib/rack/faraday_inspector.rb
+- lib/rack/faraday_inspector/middleware.rb
+- lib/rack/faraday_inspector/railtie.rb
+- lib/rack/faraday_inspector/version.rb
+- lib/rack_faraday_inspector.rb
+- rack-faraday_inspector.gemspec
+homepage: https://github.com/chrisb/rack-faraday_inspector
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: View Faraday requests made in your controllers on rendered pages
+test_files: []
+has_rdoc: