RubyGems - jsonview - Versions diffs - 0.0.1 - Mend

jsonview 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

data/Gemfile ADDED

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

data/LICENSE ADDED

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Preston Guillory
+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 ADDED

@@ -0,0 +1,15 @@
+# Jsonview
+Jsonview is a Rack middleware to help with inspecting JSON API responses in a browser. When the browser asks for HTML and *not* JSON and the server returns JSON anyway, this middleware will convert the response into a pretty-printed HTML representation. API calls made from Javascript or a server will not have Accept:text/html headers and should be unaffected.
+Inspired by http://jsonview.com/
+## Installation
+Add this line to your application's Gemfile:
+    gem 'jsonview'
+In Rails apps, it will add the middleware automatically. In other environments, you'll have to add it manually:
+    use Jsonview::Middleware

data/Rakefile ADDED

	@@ -0,0 +1,2 @@
1	+ #!/usr/bin/env rake
2	+ require "bundler/gem_tasks"

data/jsonview.gemspec ADDED

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jsonview/version', __FILE__)
+Gem::Specification.new do |gem|
+  gem.authors       = ["Preston Guillory"]
+  gem.email         = ["pguillory@gmail.com"]
+  gem.description   = %q{JSONView for Rack}
+  gem.summary       = %q{Rack middleware to convert JSON responses into attractive HTML representations. Mimics the JSONView browser plugin.}
+  gem.homepage      = "https://github.com/pguillory/jsonview"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "jsonview"
+  gem.require_paths = ["lib"]
+  gem.version       = Jsonview::VERSION
+end

data/lib/jsonview.rb ADDED

@@ -0,0 +1,7 @@
+require "jsonview/version"
+require "jsonview/middleware"
+require "jsonview/railtie" if defined? Rails
+module Jsonview
+  # Your code goes here...
+end

data/lib/jsonview/middleware.rb ADDED

@@ -0,0 +1,69 @@
+module Jsonview
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+    def call(env)
+      response = @app.call(env)
+      accept = env['HTTP_ACCEPT'] || ''
+      if accept =~ /html/ && !(accept =~ /json/)
+        status, headers, body = response
+        content_type = headers['Content-Type'] || ''
+        if content_type =~ /json/
+          json = body.to_enum(:each).to_a.join
+          html = html_document(JSON.parse(json))
+          headers['Content-Type'] = "text/html;charset=utf-8"
+          headers['Content-Length'] = html.bytesize.to_s
+          response = [status, headers, [html]]
+        end
+      end
+      response
+    end
+    def html_document(value)
+      <<-HTML
+        <html>
+          <head>
+            <style>
+              null { color: red }
+              string { color: green }
+              number, boolean { color: blue }
+              hash, array { display: block; margin-left: 20px }
+              key { font-weight: bold }
+            </style>
+          </head>
+          <body>
+            #{represent(value)}
+          </body>
+        </html>
+      HTML
+    end
+    def represent(value)
+      case value
+      when nil
+        "<null>NULL</null>"
+      when String
+        "<string>\"#{encode(value)}\"</string>"
+      when Fixnum
+        "<number>#{value.to_s}</number>"
+      when TrueClass, FalseClass
+        "<boolean>#{value.to_s}</boolean>"
+      when Array
+        "[\n#{value.map{|v| "<array>#{represent(v)}</array>\n" }.join}]\n"
+      when Hash
+        "{\n#{value.to_a.map{|(k, v)| "<hash><key>#{encode(k.to_s)}</key>: #{represent(v)}</hash>\n" }.join}}\n"
+      else
+        raise "Didn't expect a #{value.class}"
+      end
+    end
+    def encode(string)
+      string.gsub /[<>&"]/, '<' => '&lt;', '>' => '&gt;', '&' => '&amp;', '"' => '&quot;'
+    end
+  end
+end

data/lib/jsonview/railtie.rb ADDED

@@ -0,0 +1,7 @@
+module Jsonview
+  class Railtie < Rails::Railtie
+    initializer "Jsonview.insert_middleware" do |app|
+      app.config.middleware.use "Jsonview::Middleware"
+    end
+  end
+end

data/lib/jsonview/version.rb ADDED

@@ -0,0 +1,3 @@
+module Jsonview
+  VERSION = "0.0.1"
+end

metadata ADDED

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: jsonview
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease:
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Preston Guillory
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00 Z
+dependencies: []
+description: JSONView for Rack
+email:
+- pguillory@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jsonview.gemspec
+- lib/jsonview.rb
+- lib/jsonview/middleware.rb
+- lib/jsonview/railtie.rb
+- lib/jsonview/version.rb
+homepage: https://github.com/pguillory/jsonview
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Rack middleware to convert JSON responses into attractive HTML representations. Mimics the JSONView browser plugin.
+test_files: []