rack-faraday_inspector 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95fdbd002b5be9a4b528166a62e9eb9e3bfa5cb0
-  data.tar.gz: c0249d1e1963c4dcc899468ae4b722bc533b4499
+  metadata.gz: 497118808554cb3dc0a5e578bfe4768512a58f56
+  data.tar.gz: 6d4b861d47740da72fda849139742b9ec7c6156d
 SHA512:
-  metadata.gz: 885457a8bf7c316204a1eeada3102947d8eee6d326648fc43ac0fcf1da0e3e9e545239dac91cadedd3be252589a8a2f4b5d5dc9e9a57d846c85ec38757a3e6af
-  data.tar.gz: 19fd5656a9fa66ee65df837a49dc8157bca02326e0872669eaf1b133a705bf77688a17b3962333cb1c31e6a6015510a51c82ddf87c06591ba46a99b182dcd0e7
+  metadata.gz: 31e113cc13671ed00f4102688a58d1c0cb5fb138bc789150b95810df2f4ed81a0a104a0e04e0bb0d9fcd9980cef9bf1d52fe6f4293543d056b4429a42bd2774c
+  data.tar.gz: 7399a9aa212df6f1173b72b8d63cd0317630797cd8aa7ac72db38094b5c0681a2debdce7e115f31283dfe105c95aab9bac7ac11b15c05b33aae7817b007192b3

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+*.gem
+.sass-cache

data/README.md

@@ -1,6 +1,8 @@
 # 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::FaradayInspector renders a bit of HTML at the bottom of your pages that allows you to inspect all of the HTTP requests Faraday made during the current Rails action.
+
+It's like your browser's developer tools network view, but for your backend API requests.
 
 ![rack-faraday_inspector](https://cloud.githubusercontent.com/assets/29424/13030496/029e5f7a-d262-11e5-886c-1b8e3b8a6260.gif)
 
@@ -14,21 +16,30 @@ Add this line to your application's Gemfile:
 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.
+I'm still actively working on this Gem, so pull from GitHub.
 
 ## Usage
 
-To view requests, simply add the middleware to each of the Faraday connections you want to inspect:
+In order to instrument and show Faraday requests, you'll need to add the middleware to your connection:
 
 ```ruby
-require 'rack/faraday_inspector'
-
 Faraday.new url: 'http://www.sushi.com' do |faraday|
   faraday.use :inspector
   # ...
 end
 ```
 
+By default the inspector web UI is disabled. To enable the inspector, add the following to an initializer, or better yet, to the specific Rails environment configurations that you want to enable the inspector for:
+
+i.e. in `config/environments/development.rb`:
+
+```ruby
+Rails.application.configure do
+  # ...
+  Rack::FaradayInspector.enabled = true
+end
+```
+
 Note: only in the `development` environment will requests be instrumented and the inspector rendered.
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,27 @@
 require "bundler/gem_tasks"
-task :default => :spec
+
+task default: :spec
+
+desc "compile SASS stylesheets"
+task :compile_sass do
+  `sass assets/sass/style.scss --style compressed > assets/css/style.css`
+end
+
+# copied from rack-mini-profiler
+desc "update asset version file"
+task update_asset_version: :compile_sass do
+  require 'digest/md5'
+  h = []
+  Dir.glob('assets/**/*.{js,css}').each do |f|
+    h << Digest::MD5.hexdigest(::File.read(f))
+  end
+
+  File.open('lib/rack/faraday_inspector/asset_version.rb','w') do |f|
+    f.write \
+"module Rack
+  class FaradayInspector
+    ASSET_VERSION = '#{Digest::MD5.hexdigest(h.sort.join(''))}'.freeze
+  end
+end"
+  end
+end

data/assets/css/style.css

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

data/assets/html/inspector.html.erb

@@ -3,7 +3,13 @@
   <%= @css %>
 -->
 </style>
-<h1>I'm here!</h1>
+
+<script type="text/javascript">
+//<![CDATA[
+  <%= @javascript %>
+//]]>
+</script>
+
 <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 %>
@@ -12,20 +18,30 @@
   <table class='faraday_inspector-requests'>
     <% Thread.current[:faraday_requests].to_a.each do |event| %>
       <% req = event[:env] %>
+      <% request_id = event.hash %>
+      <% is_json = req[:body].present? && req[:response_header].try(:[], 'content-type').to_s.include?('json') || req.url.host.include?('json') %>
       <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='duration'><%= event[:duration].round(3) %>s</td>
         <td class='status'><%= req.status %></td>
       </tr>
       <tr>
         <td colspan='5'>
-          <div class='request'>
+          <div class='request <%= 'json' if is_json %>' id='request-<%= request_id %>'>
             <% 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 />") %>
+              <% if is_json %>
+                <pre></pre>
+                <script type="text/javascript">
+                //<![CDATA[
+                  var responseObject = <%= req[:body] %>;
+                  $('#request-<%= request_id %> pre').html(library.json.prettyPrint(responseObject));
+                //]]>
+                </script>
+              <% else %>
+                <%= CGI.escapeHTML(req[:body]).gsub("\n", "<br />") %>
+              <% end %>
             <% else %>
               (No body for this request.)
             <% end %>
@@ -35,26 +51,3 @@
     <% 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/javascripts/inspector.js

@@ -0,0 +1,83 @@
+// for now, this project depends on jQuery but the frontend is not complex
+// and so it could probably be written without jQuery...
+
+if (window.jQuery) {
+  window.jQuery(function(){
+    var setItem = function(name, value) {
+      if(typeof(Storage) !== "undefined") {
+        localStorage.setItem(name, value);
+      }
+    };
+
+    var getItem = function(name, default_value) {
+      if(typeof(Storage) !== "undefined") {
+        return localStorage[name];
+      } else {
+        return default_value;
+      }
+    };
+
+    var closeFaradayInspector = function(e) {
+      setItem("rack_faraday_inspector_open", 'false');
+      toggleFardayInspector();
+    };
+
+    var openFaradayInspector = function(e) {
+      setItem("rack_faraday_inspector_open", 'true');
+      toggleFardayInspector();
+    };
+
+    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');
+    };
+
+    if(getItem('rack_faraday_inspector_open', 'false') == 'true') {
+      $('.faraday_inspector').removeClass('minimized');
+      $('.faraday_inspector').addClass('open');
+    }
+
+    $('.faraday_inspector tr.event').click(showFaradayRequest);
+    $('.faraday_inspector .close').click(closeFaradayInspector);
+    $('.faraday_inspector .prompt').click(openFaradayInspector);
+  });
+}
+
+if (!library)
+  var library = {};
+
+library.json = {
+  replacer: function(match, pIndent, pKey, pVal, pEnd) {
+    var key = "<span class='json-item json-key'>";
+    var val = "<span class='json-item json-value'>";
+    var str = "<span class='json-item json-string'>";
+    var r = pIndent || '';
+    if (pKey)
+      r = r + key + pKey.replace(/[": ]/g, '') + '</span>: ';
+    if (pVal)
+      r = r + (pVal[0] == '"' ? str : val) + pVal + '</span>';
+    var rval = r + (pEnd || '');
+    return "<span class='json-line'>" + rval + "</span>";
+  },
+  prettyPrint: function(obj) {
+    var jsonLine = /^( *)("[\w]+": )?("[^"]*"|[\w.+-]*)?([,[{])?$/mg;
+    return JSON.stringify(obj, null, 3)
+      .replace(/&/g, '&amp;').replace(/\\"/g, '&quot;')
+      .replace(/</g, '&lt;').replace(/>/g, '&gt;')
+      .replace(jsonLine, library.json.replacer);
+  }
+};

data/assets/sass/{styles.scss → style.scss}

@@ -5,20 +5,26 @@
   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; }
+    table {
+      display: none;
+    }
+    .request {
+      display: none;
+    }
+    .close {
+      display: none;
+    }
   }
-
   &.open {
     width: 100%;
     border-top: 1px solid #eee;
-    .prompt { display: none; }
+    .prompt {
+      display: none;
+    }
     .close {
       display: inline-block;
       position: absolute;
@@ -28,15 +34,30 @@
       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; }
+    .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;
@@ -46,17 +67,32 @@
     background-color: #fff;
     // border: 1px solid #aaa;
     padding: 8px;
+    &.json {
+      background-color: ghostwhite;
+      border: 1px solid silver;
+      padding: 10px 20px;
+      margin: 20px;
+      .json-key {
+        color: brown;
+      }
+      .json-value {
+        color: navy;
+      }
+      .json-string {
+        color: olive;
+      }
+    }
   }
-
-  .prompt, .close {
+  .prompt,
+  .close {
     cursor: pointer;
     cursor: hand;
     font-weight: bold;
   }
-
   table {
     width: 100%;
     font-family: 'Source Code Pro Light', 'Menlo', monospace;
+    border-spacing: 0;
     .request {
       display: none;
     }

data/lib/rack/faraday_inspector.rb

@@ -1,4 +1,18 @@
 require 'faraday/inspector'
 require 'rack/faraday_inspector/version'
 require 'rack/faraday_inspector/middleware'
-require 'rack/faraday_inspector/railtie'
+require 'active_support/configurable'
+
+if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
+  require 'rack/faraday_inspector/railtie'
+end
+
+module Rack
+  module FaradayInspector
+    include ActiveSupport::Configurable
+
+    config.development_mode = false
+    config.enabled = false
+    config_accessor :enabled
+  end
+end

data/lib/rack/faraday_inspector/asset_version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class FaradayInspector
+    ASSET_VERSION = '917c2e48461c5aa5f5c910233dae2e9b'.freeze
+  end
+end

data/lib/rack/faraday_inspector/middleware.rb

@@ -5,33 +5,46 @@ module Rack
         @app = app
       end
 
-      def template_path(*paths)
+      def config
+        Rack::FaradayInspector.config
+      end
+
+      def asset_path(*paths)
         ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'assets', *paths))
       end
 
-      def css_template_path
-        template_path('sass', 'styles.scss')
+      def compile_css
+        path_to_sass = asset_path('sass', 'style.scss')
+        @css = Sass::Engine.new(::File.open(path_to_sass).read,
+                                cache: true,
+                                syntax: :scss,
+                                style: :compressed,
+                                filename: path_to_sass).render
+      end
+
+      def should_compile_css_at_runtime?
+        config.development_mode && defined?(Sass)
       end
 
-      def css_template
-        ::File.open(css_template_path).read
+      def read_compiled_css
+        ::File.open(asset_path('css', 'style.css')).read
       end
 
-      def render_css
-        @css = Sass::Engine.new(css_template,{
-          cache: true,
-          syntax: :scss,
-          style: :compressed,
-          filename: css_template_path,
-        }).render
+      def set_javascript
+        @javascript = ::File.open(asset_path('javascripts', 'inspector.js')).read
+      end
+
+      def set_css
+        @css = should_compile_css_at_runtime? ? compile_css : read_compiled_css
       end
 
       def template
-        ::File.open(template_path('html', 'inspector.html.erb')).read
+        ::File.open(asset_path('html', 'inspector.html.erb')).read
       end
 
       def content
-        render_css
+        set_css
+        set_javascript
         ERB.new(template).result(binding)
       end
 
@@ -39,26 +52,31 @@ module Rack
         Thread.current[:faraday_requests] = nil
       end
 
+      def inject_inspector_into(response)
+        new_response = []
+        response.each do |body|
+          partition = body.rpartition('</body>')
+          partition[0] += content.to_s
+          new_response << partition.join
+        end
+        new_response
+      end
+
+      def should_inject_inspector?(headers)
+        config.enabled && headers['Content-Type'].to_s.include?('text/html')
+      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
+        if should_inject_inspector?(headers)
+          response = inject_inspector_into(response)
+          headers['Content-Length'] = response.inject(0) do |len, body|
+            len + body.bytesize
           end.to_s
-
-          [status, headers, new_response]
-        else
-          [status, headers, response]
         end
+
+        [status, headers, response]
       ensure
         clear_requests
       end

data/lib/rack/faraday_inspector/version.rb

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

data/rack-faraday_inspector.gemspec

@@ -4,22 +4,24 @@ $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.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.authors       = ['Chris Bielinski']
+  spec.email         = ['chris@shadow.io']
+  spec.summary       = 'A web UI for inspecting your Faraday HTTP requests'
+  spec.description   = 'Provides the ability to inspect your backend Faraday requests via a web UI.'
+  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_dependency 'awesome_print', '>= 1.6.1'
+  spec.add_dependency 'activesupport', '>= 4.1.0'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency 'sass'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-faraday_inspector
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Bielinski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +80,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: View Faraday requests made in your controllers on rendered pages
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides the ability to inspect your backend Faraday requests via a web
+  UI.
 email:
 - chris@shadow.io
 executables: []
@@ -63,12 +120,15 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- assets/css/style.css
 - assets/html/inspector.html.erb
-- assets/sass/styles.scss
+- assets/javascripts/inspector.js
+- assets/sass/style.scss
 - bin/console
 - bin/setup
 - lib/faraday/inspector.rb
 - lib/rack/faraday_inspector.rb
+- lib/rack/faraday_inspector/asset_version.rb
 - lib/rack/faraday_inspector/middleware.rb
 - lib/rack/faraday_inspector/railtie.rb
 - lib/rack/faraday_inspector/version.rb
@@ -96,6 +156,6 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: View Faraday requests made in your controllers on rendered pages
+summary: A web UI for inspecting your Faraday HTTP requests
 test_files: []
 has_rdoc: