apiaryio 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d1f7b93ee67ce7410a17db97727e31798890639
-  data.tar.gz: e9ea2a78542a7df2b2694ab33a40f3aa7dc182e5
+  metadata.gz: 6e639544bbbeeeccb5ee418216fccdd4931adfd1
+  data.tar.gz: c1adc732daf47c4a9a988d15a65098c5fb52633d
 SHA512:
-  metadata.gz: 4b435dbff98370af119a89103d516c05a1680c174144ba4ff41194c84010288888c91a0b7dd80a8b7bd7be2b03aa8f1afc50cb89564a7f658bb047852b19a194
-  data.tar.gz: 7eaea8e80f97c7afadc64d6e1e7ddb6585182c74d38604c39d4f95178587729012a7a274789dd8ebb72dc587272a65345e9b11e681329716202abff39be94205
+  metadata.gz: 45a77fc5663fde0d5079acb6021e8f4607cf87816079edea83ff8f27ffc33578c9ee9cab39dfbd05c0e5033a4c93591f60192954dd68390a2b8b9bd5f9577799
+  data.tar.gz: 6e8940c09315916b67f5ff75448aac975d87fd1d9cc4ec35a4b9388752e92ca5308f91777978eb61a1ba11afe44d88b24122e4ad5c607051d4dbfcf07038bf27

data/.rubocop_todo.yml

@@ -9,6 +9,9 @@ Lint/UnusedBlockArgument:
 Metrics/AbcSize:
   Max: 33
 
+Metrics/ClassLength:
+  Max: 150 # or whatever ends up being appropriate
+
 Metrics/PerceivedComplexity:
   Max: 12
 

data/README.md

@@ -98,6 +98,7 @@ Options:
   [--server], [--no-server]  # Start standalone web server on port 8080
   [--port=PORT]              # Set port for --server option
   [--host=HOST]              # Set host for --server option
+  [--watch], [--no-watch]    # Reload API documentation when API Description Document has changed
 
 Show API documentation in browser or write it to file
 ```

data/apiary.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'thor', '~> 0.19.1'
   gem.add_runtime_dependency 'json', '~> 1.8'
   gem.add_runtime_dependency 'launchy', '~> 2.4'
+  gem.add_runtime_dependency 'listen', '~> 2.0'
 
   gem.add_development_dependency 'bundler', '~> 1.12'
   gem.add_development_dependency 'rake', '~> 10.0'

data/lib/apiary/cli.rb

@@ -25,6 +25,7 @@ module Apiary
     method_option :server, type: :boolean, desc: 'Start standalone web server on port 8080'
     method_option :port, type: :numeric, banner: 'PORT', desc: 'Set port for --server option'
     method_option :host, type: :string, desc: 'Set host for --server option'
+    method_option :watch, type: :boolean, desc: 'Reload API documentation when API Description Document has changed'
 
     def preview
       cmd = Apiary::Command::Preview.new options

data/lib/apiary/command/preview.rb

@@ -6,6 +6,7 @@ require 'json'
 require 'tmpdir'
 require 'erb'
 require 'launchy'
+require 'listen'
 
 require 'apiary/agent'
 require 'apiary/helpers'
@@ -29,6 +30,8 @@ module Apiary::Command
       @options.proxy        ||= ENV['http_proxy']
       @options.server       ||= false
       @options.json         ||= false
+      @options.watch        ||= false
+      @options.interval     ||= 1000
       @options.host         ||= '127.0.0.1'
       @options.headers      ||= {
         accept: 'text/html',
@@ -36,6 +39,8 @@ module Apiary::Command
         user_agent: Apiary.user_agent
       }
 
+      @changed = timestamp
+
       begin
         @source_path = api_description_source_path(@options.path)
       rescue StandardError => e
@@ -45,17 +50,44 @@ module Apiary::Command
 
     def execute
       if @options.server
+        watch
         server
       else
         show
       end
     end
 
+    def watch
+      if @options.watch
+        listener = Listen.to(File.dirname(@source_path), only: /#{File.basename(@source_path)}/) do |modified|
+          @changed = timestamp
+        end
+
+        listener.start
+      end
+    end
+
+    def timestamp
+      Time.now.getutc.to_i.to_s
+    end
+
     def server
-      app = rack_app do
+      generate_app = get_app('/') do
         generate
       end
 
+      change_app = get_app('/changed') do
+        @changed
+      end
+
+      source_app = get_app('/source') do
+        api_description_source(@source_path)
+      end
+
+      app = Rack::Builder.new do
+        run Rack::Cascade.new([source_app, change_app, generate_app])
+      end
+
       Rack::Server.start(Port: @options.port, Host: @options.host, app: app)
     end
 
@@ -69,9 +101,11 @@ module Apiary::Command
       end
     end
 
-    def rack_app
+    def get_app(path)
       Rack::Builder.new do
-        run ->(env) { [200, {}, [yield]] }
+        map path do
+          run ->(env) { [200, {}, [yield]] }
+        end
       end
     end
 
@@ -104,7 +138,9 @@ module Apiary::Command
 
       data = {
         title: File.basename(@source_path, '.*'),
-        source: source
+        source: source,
+        interval: @options.interval,
+        watch: @options.watch
       }
 
       template.result(binding)

data/lib/apiary/file_templates/preview.erb

@@ -10,6 +10,35 @@
     var embed = new Apiary.Embed({
       apiBlueprint: "<%= escape_javascript data[:source] %>"
     });
+
+    if (<%= data[:watch] %>) {
+        var changed = null
+        var xhrChanged = new XMLHttpRequest();
+        var xhrData = new XMLHttpRequest();
+        setInterval(function() {
+            xhrChanged.open('GET', window.location.href + "/changed", true);
+            xhrChanged.send();
+
+            xhrChanged.onreadystatechange = function() {
+                if (xhrChanged.readyState == 4 && xhrChanged.status == 200) {
+                    if (!changed) {
+                        changed = xhrChanged.responseText
+                    }
+                    if (changed != xhrChanged.responseText) {
+                        changed = xhrChanged.responseText
+                        xhrData.open('GET', window.location.href + "/source", true);
+                        xhrData.send();
+
+                        xhrData.onreadystatechange = function() {
+                            if (xhrData.readyState == 4 && xhrData.status == 200) {
+                                embed.iframeElement.contentWindow.postMessage({"origin": embed.ORIGIN, "eventType": "anonymousPreview", "data": {"code": xhrData.responseText}}, '*');
+                            }
+                        }
+                    }
+                }
+            }
+        }, <%= data[:interval] %>);
+    }
   </script>
 </body>
 </html>

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Apiary Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2017-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement