Updated preview command to display new documentation.

Author: freaz

lib/apiary.rb

@@ -2,7 +2,6 @@
 require "apiary/version"
 require "apiary/cli"
 require "apiary/common"
-Dir["#{File.dirname(__FILE__)}/apiary/command/*.rb"].each { |f| require(f) }
 
 module Apiary
 end

lib/apiary/command/preview.rb

@@ -4,14 +4,20 @@
 require 'ostruct'
 require 'json'
 require 'tmpdir'
+require 'erb'
 
 require "apiary/common"
+require "apiary/helpers/javascript_helper"
 
 module Apiary
   module Command
     # Display preview of local blueprint file
     class Preview
 
+      include Apiary::Helpers::JavascriptHelper
+
+      PREVIEW_TEMPLATE_PATH = "#{File.expand_path File.dirname(__FILE__)}/../file_templates/preview.erb"
+
       BROWSERS = {
         :safari => "Safari",
         :chrome => "Google Chrome",
@@ -28,6 +34,8 @@ def initialize(opts)
         @options.port         ||= 8080
         @options.proxy        ||= ENV['http_proxy']
         @options.server       ||= false
+
+        validate_apib_file()
       end
 
       def execute
@@ -43,12 +51,12 @@ def server
       end
 
       def show
-        generate_static(@options.path)
+        generate_static
       end
 
-      def validate_apib_file(apib_file)
+      def validate_apib_file
         common = Apiary::Common.new
-        common.validate_apib_file(apib_file)
+        common.validate_apib_file(@options.path)
       end
 
       def path
@@ -67,46 +75,12 @@ def rack_app(&block)
 
       def run_server
         app = self.rack_app do
-          self.query_apiary(@options.api_host, @options.path)
+          self.generate
         end
 
         Rack::Server.start(:Port => @options.port, :app => app)
       end
 
-      def preview_path(path)
-        basename = File.basename(@options.path)
-        temp = Dir.tmpdir()
-        "#{temp}/#{basename}-preview.html"
-      end
-
-      def query_apiary(host, path)
-        url  = "https://#{host}/blueprint/generate"
-        if validate_apib_file(path)
-          begin
-            data = File.read(path)
-          rescue
-            abort "File #{path} not found."
-          end
-
-          RestClient.proxy = @options.proxy
-
-          begin
-            RestClient.post(url, data, @options.headers)
-          rescue RestClient::BadRequest => e
-            err = JSON.parse e.response
-            if err.has_key? 'parserError'
-              abort "#{err['message']}: #{err['parserError']} (Line: #{err['line']}, Column: #{err['column']})"
-            else
-              abort "Apiary service responded with an error: #{err['message']}"
-            end
-          rescue RestClient::Exception => e
-            abort "Apiary service responded with an error: #{e.message}"
-          end
-        else
-          abort "Sorry, Apiary can't display invalid blueprint."
-        end
-      end
-
       # TODO: add linux and windows systems
       def open_generated_page(path)
         exec "open #{browser_options} #{path}"
@@ -116,17 +90,49 @@ def write_generated_path(path, outfile)
         File.write(outfile, File.read(path))
       end
 
-      def generate_static(path)
-        File.open(preview_path(path), "w") do |file|
-          file.write(query_apiary(@options.api_host, path))
+      def generate
+        template = load_preview_template()
+
+        data = {
+          title: File.basename(@options.path, ".*"),
+          blueprint: load_blueprint()
+        }
+
+        template.result(binding)
+      end
+
+      def generate_static
+        preview_string = generate
+
+        File.open(preview_path, "w") do |file|
+          file.write preview_string
+          file.flush
           @options.output ? write_generated_path(file.path, @options.output) : open_generated_page(file.path)
         end
       end
 
+      def load_blueprint
+        file = File.open @options.path, "r"
+        file.read
+      end
+
+      def preview_path
+        basename = File.basename(@options.path, ".*")
+        temp = Dir.tmpdir()
+        "#{temp}/#{basename}-preview.html"
+      end
+
+      def load_preview_template
+        file = File.open(PREVIEW_TEMPLATE_PATH, "r")
+        template_string = file.read()
+        ERB.new(template_string)
+      end
+
       private
-        def browser_options
-          "-a #{BROWSERS[@options.browser.to_sym]}" if @options.browser
-        end
+
+      def browser_options
+        "-a #{BROWSERS[@options.browser.to_sym]}" if @options.browser
+      end
     end
   end
 end

lib/apiary/file_templates/preview.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title><%= data[:title] %></title>
+</head>
+<body>
+  <script src="https://api.apiary.io/seeds/embed.js"></script>
+  <script>
+    var embed = new Apiary.Embed({
+      apiBlueprint: "<%= escape_javascript data[:blueprint] %>"
+    });
+  </script>
+</body>
+</html>

lib/apiary/helpers/javascript_helper.rb

@@ -0,0 +1,28 @@
+module Apiary
+	module Helpers
+    module JavascriptHelper
+      JS_ESCAPE_MAP = {
+        '\\'    => '\\\\',
+        '</'    => '<\/',
+        "\r\n"  => '\n',
+        "\n"    => '\n',
+        "\r"    => '\n',
+        '"'     => '\\"',
+        "'"     => "\\'"
+      }
+
+      JS_ESCAPE_MAP["\342\200\250".force_encoding(Encoding::UTF_8).encode!] = '&#x2028;'
+      JS_ESCAPE_MAP["\342\200\251".force_encoding(Encoding::UTF_8).encode!] = '&#x2029;'
+
+      def escape_javascript(javascript)
+        if javascript
+          javascript.gsub(/(\\|<\/|\r\n|\342\200\250|\342\200\251|[\n\r"'])/u) {|match| JS_ESCAPE_MAP[match] }
+        else
+          ''
+        end
+      end
+
+      alias_method :j, :escape_javascript
+    end
+  end
+end

spec/command/preview_spec.rb

@@ -2,10 +2,23 @@
 
 describe Apiary::Command::Preview do
 
+  let(:command) do
+    opts = {
+      path: "#{File.expand_path File.dirname(__FILE__)}/../../features/fixtures/apiary.apib"
+    }
+    Apiary::Command::Preview.new(opts)
+  end
+
   it 'check tmp path if contains filename' do
-    opts = {}
-    command = Apiary::Command::Preview.new(opts)
-    expect(command.preview_path('apiary.apib')).to end_with('apiary.apib-preview.html')
+    expect(command.preview_path()).to end_with('apiary-preview.html')
+  end
+
+  it 'shoud contain html5 doctype' do
+    expect(command.generate()).to include('<!DOCTYPE html>')
+  end
+
+  it 'should contain embed javascript' do
+    expect(command.generate()).to include('https://api.apiary.io/seeds/embed.js')
   end
 
 end