cassette_explorer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 565db288bd62dcbd44e712bd0e5f6f84af54e656
+  data.tar.gz: 7ee23f6229a282aa669f4f82d769605050eb57e0
+SHA512:
+  metadata.gz: 74d975de6175f17c9367567b575373bad68d8d67de142514b0ed5ffd0f89c3de02718c7495b11afd4d81a2508a308bb55db5446783f31b721c6a67a9fbec0bf9
+  data.tar.gz: ac84df6d4aace1d43583ceac36dcbea757933888f1fafc9301d5dbc0f6e11815267b08fbeb72dd9c4eadcb0ca56e77c0fd8f6d6fd5724aeb091fabb79fc52f06

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Zequez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# CassetteExplorer
+
+CasetteExplorer is a command line utility that allow you to mount a webserver to load the
+[VCR](https://github.com/vcr/vcr) cassettes in the browser.
+
+## Installation
+
+```
+$ gem install cassette_explorer
+```
+
+## Usage
+
+```
+$ cassette_explorer -h
+Usage: cassette_explorer /path/to/vcr/cassettes/directory [options]
+    -r, --no-replace-urls            Replace relative URLs with absolute URLs. Default: true
+    -f, --load-in-iframe             Default the views to load in an iframe (it can be toggled from the page). Default: false
+    -w, --watch                      Watches the cassettes for changes. Default: true
+    -p, --port PORT                  Port to mount the server
+    -h, --help                       Prints this help
+```
+
+## TODO
+
+- Write better tests
+- Make the view a folder tree
+
+## Contributing
+
+1. Fork it ( https://github.com/Zequez/cassette_explorer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/cassette_explorer

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+begin
+  require File.dirname(THIS_FILE) + '/../lib/cassette_explorer'
+rescue LoadError
+  require 'cassette_explorer'
+end
+
+server = CassetteExplorer::Server.from_command_line(ARGV)
+if server
+  server.run
+end

data/cassette_explorer.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cassette_explorer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cassette_explorer'
+  spec.version       = CassetteExplorer::VERSION
+  spec.authors       = ['Zequez']
+  spec.email         = ['zequez@gmail.com']
+  spec.summary       = %q{VCR Cassette Explorer}
+  spec.description   = %q{Mounts a webserver to serve VCR cassettes for visualization on your browser}
+  spec.homepage      = 'http://github.com/Zequez/cassette_explorer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = 'cassette_explorer'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'listen', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'guard', '~> 2.13'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'typhoeus', '~> 0.7'
+  spec.add_development_dependency 'nokogiri', '~> 1.6'
+  spec.add_development_dependency 'capybara', '~> 2.4'
+  spec.add_development_dependency 'selenium-webdriver', '~> 2.46'
+  spec.add_development_dependency 'poltergeist', '~> 1.6'
+end

data/lib/cassette_explorer.rb

@@ -0,0 +1,20 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+
+require 'webrick'
+require 'yaml'
+require 'erb'
+require 'listen'
+require 'optparse'
+require 'ostruct'
+require 'base64'
+
+require "cassette_explorer/version"
+require "cassette_explorer/page"
+require "cassette_explorer/reader"
+require "cassette_explorer/template"
+require "cassette_explorer/server"
+
+module CassetteExplorer
+  ROOT = Pathname.new(__dir__) + '..'
+end

data/lib/cassette_explorer/page.rb

@@ -0,0 +1,54 @@
+module CassetteExplorer
+  class Page
+    attr_reader :request
+
+    def initialize(request)
+      @request = request
+    end
+
+    def method
+      @request['request']['method'].upcase
+    end
+
+    def status
+      @request['response']['status']['code']
+    end
+
+    def title
+      @title ||= html_raw.scan(/<title>([^<]+)<\/title>/).flatten.first
+    end
+
+    def html(relative_urls = false)
+      if relative_urls
+        html_with_relative_urls
+      else
+        html_raw
+      end
+    end
+
+    def url
+      @request['request']['uri']
+    end
+
+    def uri
+      @uri ||= URI.parse(url)
+    end
+
+    def html_raw
+      body = @request['response']['body']
+
+      if body['base64_string']
+        html = Base64.decode64 body['base64_string']
+      else
+        html = body['string']
+      end
+    end
+
+    def html_with_relative_urls
+      base_path = uri.scheme + '://' + uri.host + uri.path.sub(/[^\/]+$/, '')
+      html_raw
+        .gsub('href="./', "href=\"#{base_path}")
+        .gsub('src="./', "src=\"#{base_path}")
+    end
+  end
+end

data/lib/cassette_explorer/reader.rb

@@ -0,0 +1,32 @@
+module CassetteExplorer
+  class Reader
+    def initialize(path)
+      @path = File.expand_path(path)
+    end
+
+    def read
+
+      files = Dir["#{@path}/**/**"]
+
+      sections = {}
+
+      files.reject{ |f| File.directory? f }.each do |file|
+        section_name = section_name_from_file_path(file)
+        sections[section_name] ||= []
+
+        data = YAML.load_file(file)
+        if data['http_interactions']
+          data['http_interactions'].each do |request|
+            sections[section_name].push Page.new(request)
+          end
+        end
+      end
+
+      sections
+    end
+
+    def section_name_from_file_path(file_path)
+      file_path.gsub(@path, '')
+    end
+  end
+end

data/lib/cassette_explorer/server.rb

@@ -0,0 +1,105 @@
+module CassetteExplorer
+  class Server
+    def self.from_command_line(argv)
+      options = {}
+
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: cassette_explorer /path/to/vcr/cassettes/directory [options]'
+
+        opts.on('-r', '--no-replace-urls', 'Replace relative URLs with absolute URLs. Default: true') do |v|
+          options[:relative_urls] = !v
+        end
+
+        opts.on(
+          '-f',
+          '--load-in-iframe',
+          'Default the views to load in an iframe (it can be toggled from the page). Default: false'
+        ) do |v|
+          options[:load_in_iframe] = v
+        end
+
+        opts.on('-w', '--watch', 'Watches the cassettes for changes. Default: true') do |v|
+          options[:watch] = v
+        end
+
+        opts.on('-p', '--port PORT', 'Port to mount the server') do |v|
+          options[:port] = v
+        end
+
+        opts.on('-h', '--help', 'Prints this help') do |v|
+          options[:help] = v
+        end
+      end
+
+      begin
+        parser.parse!(argv)
+        raise OptionParser::InvalidOption if argv.size != 1
+        options[:path] = argv.pop
+      rescue OptionParser::InvalidOption
+        options[:help] = true
+      end
+
+      if options[:help]
+        puts parser.help
+      else
+        new options
+      end
+    end
+
+    def initialize(options = {})
+      @options = {
+        port: 2332,
+        path: './spec/fixtures/vcr_cassettes/',
+        template: __dir__ + '/templates/index.erb',
+        relative_urls: true,
+        watch: true,
+        load_in_iframe: false
+      }.merge(options)
+
+      @reader = Reader.new(@options[:path])
+    end
+
+    def run(blocking = true)
+      @sections = @reader.read
+
+      listener = Listen.to(@options[:path]) do
+        puts 'Change detected, reloading cassettes'
+        @sections = @reader.read
+      end
+
+      listener.start # doesn't block
+
+      server = WEBrick::HTTPServer.new Port: @options[:port]
+      server.mount_proc '/' do |req, res|
+        url = req.query['url']
+        file = req.query['file']
+        data = req.query['data']
+
+        if file and url
+          section = @sections[file]
+          page = section.detect{ |p| p.url == url }
+
+          if data
+            res.body = YAML::dump(page.request)
+          else
+            res.body = page.html(@options[:relative_urls])
+          end
+        else
+          res.body = render_index(@sections)
+        end
+      end
+
+      if blocking
+        server.start
+      else
+        Thread.new do
+          server.start
+        end
+      end
+    end
+
+    def render_index(data)
+      Template.new(files: data, load_in_iframe: @options[:load_in_iframe]).render(@options[:template])
+    end
+  end
+end

data/lib/cassette_explorer/template.rb

@@ -0,0 +1,14 @@
+module CassetteExplorer
+  class Template < OpenStruct
+    include ERB::Util
+
+    def render(template_file)
+      template = File.read template_file
+      ERB.new(template).result(binding)
+    end
+
+    def page_path(file, page)
+      "?file=#{u file}&url=#{u page.url}"
+    end
+  end
+end

data/lib/cassette_explorer/templates/index.erb

@@ -0,0 +1,87 @@
+<!DOCTYPE html>
+<html>
+  <title>List of pages</title>
+  <style>
+    body {
+      margin: 0;
+      font-family: monospace;
+      font-size: 16px;
+      line-height: 24px;
+    }
+
+    .file {
+      color: grey;
+    }
+
+    .method {
+      font-weight: bold;
+    }
+
+    .method.get {
+      color: green;
+    }
+
+    .method.post {
+      color: red;
+    }
+
+    .link {
+
+    }
+
+    .status {
+      font-weight: bold;
+      color: red;
+    }
+
+    .status.status-200 {
+      color: green;
+    }
+
+    .iframe-toggle-container {
+      position: absolute;
+      top: 0;
+      right: 0;
+    }
+
+    iframe {
+      width: 100%;
+      height: 1000px;
+      border: 0;
+    }
+  </style>
+  <body>
+    <ul>
+      <% files.each_pair do |file, pages| %>
+        <li class="file"><%= file %></li>
+        <ul>
+          <% pages.each do |page| %>
+            <li>
+              <a class="interaction-link" href="<%=page_path file, page%>&data">Data</a>
+              <span class="method <%= page.method.downcase %>"><%= page.method %></span>
+              <a class="link" href="<%=page_path file, page%>"><%= page.url %></a>
+              <span class="status status-<%= page.status %>">=> <%= page.status %></span>
+              <span class="title"><%= page.title and %Q{"#{page.title}"} %></span>
+            </li>
+          <% end %>
+        </ul>
+      <% end %>
+    </ul>
+    <label class="iframe-toggle-container">
+      Load in iframe
+      <input type="checkbox" id="iframe-toggle" <%=load_in_iframe ? 'checked' : ''%>/>
+    </label>
+    <iframe src=""></iframe>
+
+    <script>
+      var iframe = document.getElementsByTagName('iframe')[0];
+      var iframeToggle = document.getElementById('iframe-toggle');
+      document.body.addEventListener('click', function(ev){
+        if (iframeToggle.checked && ev.target.tagName == 'A') {
+          iframe.src = ev.target.href;
+          ev.preventDefault();
+        }
+      });
+    </script>
+  </body>
+</html>