docs_api 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/MIT-LICENSE +20 -0
- data/README.md +28 -0
- data/Rakefile +32 -0
- data/app/assets/config/docs_api_manifest.js +2 -0
- data/app/assets/javascripts/docs_api/application.js +14 -0
- data/app/assets/stylesheets/docs_api/application.css +15 -0
- data/app/controllers/docs_api/application_controller.rb +5 -0
- data/app/controllers/docs_api/docs_controller.rb +26 -0
- data/app/helpers/docs_api/application_helper.rb +4 -0
- data/app/jobs/docs_api/application_job.rb +4 -0
- data/app/mailers/docs_api/application_mailer.rb +6 -0
- data/app/models/docs_api/application_record.rb +5 -0
- data/app/views/docs_api/docs/index.html.erb +5 -0
- data/app/views/docs_api/docs/show.html.erb +52 -0
- data/app/views/layouts/docs_api/application.html.erb +14 -0
- data/config/routes.rb +4 -0
- data/lib/docs_api/engine.rb +5 -0
- data/lib/docs_api/version.rb +3 -0
- data/lib/docs_api.rb +5 -0
- data/lib/tasks/docs_api_tasks.rake +4 -0
- metadata +98 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 153fdb29014ba7653c301b836ca00ae5044207d44f8af4d611ced34db5658e94
|
4
|
+
data.tar.gz: f3e71e123ccc0288886061a0c9bfdca42e47e5378196b9226f5d4d9dbacf94ef
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: fd8612f098fc80091f024a9cc8fd4ff985699bd61c79fa296bf9ea2d47fc9532779335a9e2a5725996bd980fbbcc26676195e63110808564d83b36180123a97c
|
7
|
+
data.tar.gz: b137382a5b98aad3fdff07f8bc33790055493f1cf36649578b80f597f56805ec1f3ca552f4149445ed2a3a3a7a3ff227ff270d93f735dc052f9cec47a9503ee7
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2018 Alex M
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# DocsApi
|
2
|
+
Short description and motivation.
|
3
|
+
|
4
|
+
## Usage
|
5
|
+
How to use my plugin.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
Add this line to your application's Gemfile:
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
gem 'docs_api'
|
12
|
+
```
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
```bash
|
16
|
+
$ bundle
|
17
|
+
```
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
```bash
|
21
|
+
$ gem install docs_api
|
22
|
+
```
|
23
|
+
|
24
|
+
## Contributing
|
25
|
+
Contribution directions go here.
|
26
|
+
|
27
|
+
## License
|
28
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
begin
|
2
|
+
require 'bundler/setup'
|
3
|
+
rescue LoadError
|
4
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
5
|
+
end
|
6
|
+
|
7
|
+
require 'rdoc/task'
|
8
|
+
|
9
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
10
|
+
rdoc.rdoc_dir = 'rdoc'
|
11
|
+
rdoc.title = 'DocsApi'
|
12
|
+
rdoc.options << '--line-numbers'
|
13
|
+
rdoc.rdoc_files.include('README.md')
|
14
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
15
|
+
end
|
16
|
+
|
17
|
+
APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
|
18
|
+
load 'rails/tasks/engine.rake'
|
19
|
+
|
20
|
+
load 'rails/tasks/statistics.rake'
|
21
|
+
|
22
|
+
require 'bundler/gem_tasks'
|
23
|
+
|
24
|
+
require 'rake/testtask'
|
25
|
+
|
26
|
+
Rake::TestTask.new(:test) do |t|
|
27
|
+
t.libs << 'test'
|
28
|
+
t.pattern = 'test/**/*_test.rb'
|
29
|
+
t.verbose = false
|
30
|
+
end
|
31
|
+
|
32
|
+
task default: :test
|
@@ -0,0 +1,14 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// compiled file. JavaScript code in this file should be added after the last require_* statement.
|
9
|
+
//
|
10
|
+
// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
|
11
|
+
// about supported directives.
|
12
|
+
//
|
13
|
+
//= require rails-ujs
|
14
|
+
//= require_tree .
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the bottom of the
|
9
|
+
* compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
|
10
|
+
* files in this directory. Styles in this file should be added after the last require_* statement.
|
11
|
+
* It is generally better to create a new file per style scope.
|
12
|
+
*
|
13
|
+
*= require_tree .
|
14
|
+
*= require_self
|
15
|
+
*/
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require_dependency 'docs_api/application_controller'
|
2
|
+
|
3
|
+
module DocsApi
|
4
|
+
class DocsController < ApplicationController
|
5
|
+
def index
|
6
|
+
@versions = []
|
7
|
+
doc_dir = Rails.root.join('app', 'docs', '*')
|
8
|
+
Dir.glob(doc_dir).each do |entry|
|
9
|
+
@versions.push(entry.split('/').last) if File.directory? entry
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
def show
|
14
|
+
docs = Dir.glob(Rails.root.join('app', 'docs', params[:id], '*.md'))
|
15
|
+
raise ActiveRecord::RecordNotFound if docs.blank?
|
16
|
+
|
17
|
+
url = request.protocol + request.host_with_port
|
18
|
+
@api_text = "FORMAT: 1A\nHOST: #{url}\n# #{url}\nAPI doc\n"
|
19
|
+
|
20
|
+
docs.sort_by { |d| d.split('/').last }.each do |doc|
|
21
|
+
@api_text += File.read(doc) + "\n"
|
22
|
+
end
|
23
|
+
@api_text.gsub!('"', '\"').gsub!("\n", '\n')
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="en">
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<title>Docs</title>
|
6
|
+
</head>
|
7
|
+
<body>
|
8
|
+
<script src="https://api.apiary.io/seeds/embed.js"></script>
|
9
|
+
<script>
|
10
|
+
var embed = new Apiary.Embed({
|
11
|
+
apiBlueprint: "<%== @api_text %>",
|
12
|
+
// preferences: {
|
13
|
+
// displayHttpMethods: true
|
14
|
+
// },
|
15
|
+
// codeExamples: [ // Allows only Go and Swift code examples
|
16
|
+
// 'go',
|
17
|
+
// 'swift'
|
18
|
+
// ]
|
19
|
+
});
|
20
|
+
|
21
|
+
if (false) {
|
22
|
+
var changed = null;
|
23
|
+
var xhrChanged = new XMLHttpRequest();
|
24
|
+
var xhrData = new XMLHttpRequest();
|
25
|
+
setInterval(function() {
|
26
|
+
xhrChanged.open('GET', window.location.href + "/changed", true);
|
27
|
+
xhrChanged.send();
|
28
|
+
|
29
|
+
xhrChanged.onreadystatechange = function() {
|
30
|
+
if (xhrChanged.readyState == 4 && xhrChanged.status == 200) {
|
31
|
+
if (!changed) {
|
32
|
+
changed = xhrChanged.responseText
|
33
|
+
}
|
34
|
+
if (changed != xhrChanged.responseText) {
|
35
|
+
changed = xhrChanged.responseText
|
36
|
+
xhrData.open('GET', window.location.href + "/source", true);
|
37
|
+
xhrData.send();
|
38
|
+
|
39
|
+
xhrData.onreadystatechange = function() {
|
40
|
+
if (xhrData.readyState == 4 && xhrData.status == 200) {
|
41
|
+
embed.iframeElement.contentWindow.postMessage({"origin": embed.ORIGIN, "eventType": "anonymousPreview", "data": {"code": xhrData.responseText}}, '*');
|
42
|
+
}
|
43
|
+
}
|
44
|
+
}
|
45
|
+
}
|
46
|
+
}
|
47
|
+
}, 1000);
|
48
|
+
}
|
49
|
+
</script>
|
50
|
+
|
51
|
+
</body>
|
52
|
+
</html>
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<title>Docs API | <%= DocsApi::VERSION %></title>
|
5
|
+
<%= csrf_meta_tags %>
|
6
|
+
<%= stylesheet_link_tag "docs_api/application", media: "all" %>
|
7
|
+
<%= javascript_include_tag "docs_api/application" %>
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
|
11
|
+
<%= yield %>
|
12
|
+
|
13
|
+
</body>
|
14
|
+
</html>
|
data/config/routes.rb
ADDED
data/lib/docs_api.rb
ADDED
metadata
ADDED
@@ -0,0 +1,98 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: docs_api
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Alex M
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-07-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rails
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '5.1'
|
20
|
+
- - ">="
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 5.1.0
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - "~>"
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '5.1'
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 5.1.0
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: sqlite3
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1.0'
|
40
|
+
type: :development
|
41
|
+
prerelease: false
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1.0'
|
47
|
+
description: 'TO0DO: Description of DocsApi.'
|
48
|
+
email:
|
49
|
+
- alexey.m@done-it.net
|
50
|
+
executables: []
|
51
|
+
extensions: []
|
52
|
+
extra_rdoc_files: []
|
53
|
+
files:
|
54
|
+
- MIT-LICENSE
|
55
|
+
- README.md
|
56
|
+
- Rakefile
|
57
|
+
- app/assets/config/docs_api_manifest.js
|
58
|
+
- app/assets/javascripts/docs_api/application.js
|
59
|
+
- app/assets/stylesheets/docs_api/application.css
|
60
|
+
- app/controllers/docs_api/application_controller.rb
|
61
|
+
- app/controllers/docs_api/docs_controller.rb
|
62
|
+
- app/helpers/docs_api/application_helper.rb
|
63
|
+
- app/jobs/docs_api/application_job.rb
|
64
|
+
- app/mailers/docs_api/application_mailer.rb
|
65
|
+
- app/models/docs_api/application_record.rb
|
66
|
+
- app/views/docs_api/docs/index.html.erb
|
67
|
+
- app/views/docs_api/docs/show.html.erb
|
68
|
+
- app/views/layouts/docs_api/application.html.erb
|
69
|
+
- config/routes.rb
|
70
|
+
- lib/docs_api.rb
|
71
|
+
- lib/docs_api/engine.rb
|
72
|
+
- lib/docs_api/version.rb
|
73
|
+
- lib/tasks/docs_api_tasks.rake
|
74
|
+
homepage:
|
75
|
+
licenses:
|
76
|
+
- MIT
|
77
|
+
metadata: {}
|
78
|
+
post_install_message:
|
79
|
+
rdoc_options: []
|
80
|
+
require_paths:
|
81
|
+
- lib
|
82
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - ">="
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - ">="
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
requirements: []
|
93
|
+
rubyforge_project:
|
94
|
+
rubygems_version: 2.7.6
|
95
|
+
signing_key:
|
96
|
+
specification_version: 4
|
97
|
+
summary: 'TO0DO: Summary of DocsApi.'
|
98
|
+
test_files: []
|