docs_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 153fdb29014ba7653c301b836ca00ae5044207d44f8af4d611ced34db5658e94
+  data.tar.gz: f3e71e123ccc0288886061a0c9bfdca42e47e5378196b9226f5d4d9dbacf94ef
+SHA512:
+  metadata.gz: fd8612f098fc80091f024a9cc8fd4ff985699bd61c79fa296bf9ea2d47fc9532779335a9e2a5725996bd980fbbcc26676195e63110808564d83b36180123a97c
+  data.tar.gz: b137382a5b98aad3fdff07f8bc33790055493f1cf36649578b80f597f56805ec1f3ca552f4149445ed2a3a3a7a3ff227ff270d93f735dc052f9cec47a9503ee7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Alex M
+
+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,28 @@
+# DocsApi
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docs_api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install docs_api
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DocsApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/docs_api_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/docs_api .js
+//= link_directory ../stylesheets/docs_api .css

data/app/assets/javascripts/docs_api/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require_tree .

data/app/assets/stylesheets/docs_api/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/docs_api/application_controller.rb

@@ -0,0 +1,5 @@
+module DocsApi
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/docs_api/docs_controller.rb

@@ -0,0 +1,26 @@
+require_dependency 'docs_api/application_controller'
+
+module DocsApi
+  class DocsController < ApplicationController
+    def index
+      @versions = []
+      doc_dir = Rails.root.join('app', 'docs', '*')
+      Dir.glob(doc_dir).each do |entry|
+        @versions.push(entry.split('/').last) if File.directory? entry
+      end
+    end
+
+    def show
+      docs = Dir.glob(Rails.root.join('app', 'docs', params[:id], '*.md'))
+      raise ActiveRecord::RecordNotFound if docs.blank?
+
+      url = request.protocol + request.host_with_port
+      @api_text = "FORMAT: 1A\nHOST: #{url}\n# #{url}\nAPI doc\n"
+
+      docs.sort_by { |d| d.split('/').last }.each do |doc|
+        @api_text += File.read(doc) + "\n"
+      end
+      @api_text.gsub!('"', '\"').gsub!("\n", '\n')
+    end
+  end
+end

data/app/helpers/docs_api/application_helper.rb

@@ -0,0 +1,4 @@
+module DocsApi
+  module ApplicationHelper
+  end
+end

data/app/jobs/docs_api/application_job.rb

@@ -0,0 +1,4 @@
+module DocsApi
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/docs_api/application_mailer.rb

@@ -0,0 +1,6 @@
+module DocsApi
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/docs_api/application_record.rb

@@ -0,0 +1,5 @@
+module DocsApi
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/docs_api/docs/index.html.erb

@@ -0,0 +1,5 @@
+<h1>Docs <%= DocsApi::VERSION %></h1>
+
+<%- @versions.each do |version| %>
+  <%= link_to "Doc: #{version}", docs_show_path(id: version) %>
+<% end %>

data/app/views/docs_api/docs/show.html.erb

@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>Docs</title>
+</head>
+<body>
+<script src="https://api.apiary.io/seeds/embed.js"></script>
+<script>
+    var embed = new Apiary.Embed({
+        apiBlueprint: "<%== @api_text %>",
+        // preferences: {
+        //   displayHttpMethods: true
+        // },
+        // codeExamples: [ // Allows only Go and Swift code examples
+        //   'go',
+        //   'swift'
+        // ]
+    });
+
+    if (false) {
+      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}}, '*');
+                }
+              }
+            }
+          }
+        }
+      }, 1000);
+    }
+</script>
+
+</body>
+</html>

data/app/views/layouts/docs_api/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Docs API | <%= DocsApi::VERSION %></title>
+  <%= csrf_meta_tags %>
+  <%= stylesheet_link_tag    "docs_api/application", media: "all" %>
+  <%= javascript_include_tag "docs_api/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+DocsApi::Engine.routes.draw do
+  root 'docs#index'
+  get '/:id', to: 'docs#show', as: :docs_show
+end

data/lib/docs_api/engine.rb

@@ -0,0 +1,5 @@
+module DocsApi
+  class Engine < ::Rails::Engine
+    isolate_namespace DocsApi
+  end
+end

data/lib/docs_api/version.rb

@@ -0,0 +1,3 @@
+module DocsApi
+  VERSION = '0.0.1'.freeze
+end

data/lib/docs_api.rb

@@ -0,0 +1,5 @@
+require 'docs_api/engine'
+
+module DocsApi
+  # Your code goes here...
+end

data/lib/tasks/docs_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :docs_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: docs_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex M
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'TO0DO: Description of DocsApi.'
+email:
+- alexey.m@done-it.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/docs_api_manifest.js
+- app/assets/javascripts/docs_api/application.js
+- app/assets/stylesheets/docs_api/application.css
+- app/controllers/docs_api/application_controller.rb
+- app/controllers/docs_api/docs_controller.rb
+- app/helpers/docs_api/application_helper.rb
+- app/jobs/docs_api/application_job.rb
+- app/mailers/docs_api/application_mailer.rb
+- app/models/docs_api/application_record.rb
+- app/views/docs_api/docs/index.html.erb
+- app/views/docs_api/docs/show.html.erb
+- app/views/layouts/docs_api/application.html.erb
+- config/routes.rb
+- lib/docs_api.rb
+- lib/docs_api/engine.rb
+- lib/docs_api/version.rb
+- lib/tasks/docs_api_tasks.rake
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: 'TO0DO: Summary of DocsApi.'
+test_files: []