apitome 0.0.8 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +5 -5
  2. data/MIT.LICENSE +2 -2
  3. data/README.md +99 -40
  4. data/app/assets/javascripts/apitome/application.js +16 -0
  5. data/app/assets/stylesheets/apitome/application.css +10 -0
  6. data/app/controllers/apitome/docs_controller.rb +83 -45
  7. data/app/helpers/apitome/docs_helper.rb +19 -0
  8. data/app/views/apitome/docs/_all_examples.html.erb +6 -2
  9. data/app/views/apitome/docs/_body.html.erb +1 -1
  10. data/app/views/apitome/docs/_curl.html.erb +1 -1
  11. data/app/views/apitome/docs/_endpoint.html.erb +4 -0
  12. data/app/views/apitome/docs/_example.html.erb +10 -6
  13. data/app/views/apitome/docs/_explanation.html.erb +3 -3
  14. data/app/views/apitome/docs/_headers.html.erb +6 -4
  15. data/app/views/apitome/docs/_navigation.html.erb +14 -10
  16. data/app/views/apitome/docs/_params.html.erb +4 -4
  17. data/app/views/apitome/docs/_query.html.erb +1 -1
  18. data/app/views/apitome/docs/_resource_explanation.html.erb +3 -0
  19. data/app/views/apitome/docs/_response_fields.html.erb +1 -1
  20. data/app/views/apitome/docs/_route.html.erb +1 -1
  21. data/app/views/apitome/docs/_status.html.erb +1 -1
  22. data/app/views/apitome/docs/index.html.erb +11 -6
  23. data/app/views/apitome/docs/show.html.erb +2 -1
  24. data/app/views/layouts/apitome/application.html.erb +4 -4
  25. data/config/locales/en.yml +14 -11
  26. data/config/locales/es.yml +14 -10
  27. data/lib/apitome.rb +5 -5
  28. data/lib/apitome/configuration.rb +36 -15
  29. data/lib/apitome/engine.rb +13 -7
  30. data/lib/apitome/exceptions.rb +5 -1
  31. data/lib/apitome/version.rb +1 -1
  32. data/lib/generators/apitome/install/POST_INSTALL +1 -1
  33. data/lib/generators/apitome/install/install_generator.rb +7 -8
  34. data/lib/generators/apitome/install/templates/initializer.rb +35 -13
  35. data/vendor/assets/javascripts/apitome/highlight.min.js +2 -1
  36. data/vendor/assets/stylesheets/apitome/highlight_themes/agate.css +108 -0
  37. data/vendor/assets/stylesheets/apitome/highlight_themes/androidstudio.css +66 -0
  38. data/vendor/assets/stylesheets/apitome/highlight_themes/arduino-light.css +88 -0
  39. data/vendor/assets/stylesheets/apitome/highlight_themes/arta.css +41 -126
  40. data/vendor/assets/stylesheets/apitome/highlight_themes/ascetic.css +31 -36
  41. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-cave-dark.css +83 -0
  42. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-cave-light.css +85 -0
  43. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-dune-dark.css +69 -0
  44. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-dune-light.css +69 -0
  45. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-estuary-dark.css +84 -0
  46. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-estuary-light.css +84 -0
  47. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-forest-dark.css +69 -0
  48. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-forest-light.css +69 -0
  49. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-heath-dark.css +69 -0
  50. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-heath-light.css +69 -0
  51. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-lakeside-dark.css +69 -0
  52. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-lakeside-light.css +69 -0
  53. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-plateau-dark.css +84 -0
  54. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-plateau-light.css +84 -0
  55. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-savanna-dark.css +84 -0
  56. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-savanna-light.css +84 -0
  57. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-seaside-dark.css +69 -0
  58. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-seaside-light.css +69 -0
  59. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-sulphurpool-dark.css +69 -0
  60. data/vendor/assets/stylesheets/apitome/highlight_themes/atelier-sulphurpool-light.css +69 -0
  61. data/vendor/assets/stylesheets/apitome/highlight_themes/brown-paper.css +64 -0
  62. data/vendor/assets/stylesheets/apitome/highlight_themes/{brown_papersq.png → brown-papersq.png} +0 -0
  63. data/vendor/assets/stylesheets/apitome/highlight_themes/codepen-embed.css +60 -0
  64. data/vendor/assets/stylesheets/apitome/highlight_themes/color-brewer.css +71 -0
  65. data/vendor/assets/stylesheets/apitome/highlight_themes/dark.css +41 -81
  66. data/vendor/assets/stylesheets/apitome/highlight_themes/darkula.css +74 -0
  67. data/vendor/assets/stylesheets/apitome/highlight_themes/default.css +74 -110
  68. data/vendor/assets/stylesheets/apitome/highlight_themes/docco.css +97 -0
  69. data/vendor/assets/stylesheets/apitome/highlight_themes/dracula.css +76 -0
  70. data/vendor/assets/stylesheets/apitome/highlight_themes/far.css +46 -86
  71. data/vendor/assets/stylesheets/apitome/highlight_themes/foundation.css +88 -0
  72. data/vendor/assets/stylesheets/apitome/highlight_themes/github-gist.css +71 -0
  73. data/vendor/assets/stylesheets/apitome/highlight_themes/github.css +53 -81
  74. data/vendor/assets/stylesheets/apitome/highlight_themes/googlecode.css +48 -103
  75. data/vendor/assets/stylesheets/apitome/highlight_themes/grayscale.css +101 -0
  76. data/vendor/assets/stylesheets/apitome/highlight_themes/gruvbox-dark.css +108 -0
  77. data/vendor/assets/stylesheets/apitome/highlight_themes/gruvbox-light.css +108 -0
  78. data/vendor/assets/stylesheets/apitome/highlight_themes/hopscotch.css +83 -0
  79. data/vendor/assets/stylesheets/apitome/highlight_themes/hybrid.css +102 -0
  80. data/vendor/assets/stylesheets/apitome/highlight_themes/idea.css +40 -64
  81. data/vendor/assets/stylesheets/apitome/highlight_themes/ir-black.css +73 -0
  82. data/vendor/assets/stylesheets/apitome/highlight_themes/kimbie.dark.css +74 -0
  83. data/vendor/assets/stylesheets/apitome/highlight_themes/kimbie.light.css +74 -0
  84. data/vendor/assets/stylesheets/apitome/highlight_themes/magula.css +36 -87
  85. data/vendor/assets/stylesheets/apitome/highlight_themes/mono-blue.css +59 -0
  86. data/vendor/assets/stylesheets/apitome/highlight_themes/monokai-sublime.css +83 -0
  87. data/vendor/assets/stylesheets/apitome/highlight_themes/monokai.css +50 -94
  88. data/vendor/assets/stylesheets/apitome/highlight_themes/obsidian.css +88 -0
  89. data/vendor/assets/stylesheets/apitome/highlight_themes/paraiso-dark.css +72 -0
  90. data/vendor/assets/stylesheets/apitome/highlight_themes/paraiso-light.css +72 -0
  91. data/vendor/assets/stylesheets/apitome/highlight_themes/pojoaque.css +45 -66
  92. data/vendor/assets/stylesheets/apitome/highlight_themes/purebasic.css +96 -0
  93. data/vendor/assets/stylesheets/apitome/highlight_themes/qtcreator_dark.css +83 -0
  94. data/vendor/assets/stylesheets/apitome/highlight_themes/qtcreator_light.css +83 -0
  95. data/vendor/assets/stylesheets/apitome/highlight_themes/railscasts.css +106 -0
  96. data/vendor/assets/stylesheets/apitome/highlight_themes/rainbow.css +48 -77
  97. data/vendor/assets/stylesheets/apitome/highlight_themes/school-book.css +72 -0
  98. data/vendor/assets/stylesheets/apitome/highlight_themes/{school_book.png → school-book.png} +0 -0
  99. data/vendor/assets/stylesheets/apitome/highlight_themes/solarized-dark.css +84 -0
  100. data/vendor/assets/stylesheets/apitome/highlight_themes/solarized-light.css +84 -0
  101. data/vendor/assets/stylesheets/apitome/highlight_themes/sunburst.css +55 -111
  102. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-blue.css +75 -0
  103. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-bright.css +74 -0
  104. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-eighties.css +74 -0
  105. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night.css +75 -0
  106. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow.css +43 -20
  107. data/vendor/assets/stylesheets/apitome/highlight_themes/vs.css +50 -68
  108. data/vendor/assets/stylesheets/apitome/highlight_themes/xcode.css +55 -116
  109. data/vendor/assets/stylesheets/apitome/highlight_themes/xt256.css +92 -0
  110. data/vendor/assets/stylesheets/apitome/highlight_themes/zenburn.css +49 -84
  111. metadata +80 -65
  112. data/config/routes.rb +0 -4
  113. data/spec/apitome/configuration_spec.rb +0 -0
  114. data/spec/apitome/engine_spec.rb +0 -0
  115. data/spec/dummy/Rakefile +0 -7
  116. data/spec/dummy/config.ru +0 -15
  117. data/spec/dummy/config/application.rb +0 -16
  118. data/spec/dummy/config/boot.rb +0 -7
  119. data/spec/dummy/config/environment.rb +0 -5
  120. data/spec/dummy/config/environments/development.rb +0 -27
  121. data/spec/dummy/config/environments/test.rb +0 -29
  122. data/spec/dummy/config/initializers/apitome.rb +0 -44
  123. data/spec/dummy/config/routes.rb +0 -2
  124. data/spec/dummy/doc/api.md +0 -20
  125. data/spec/dummy/public/favicon.ico +0 -0
  126. data/spec/dummy/script/rails +0 -6
  127. data/vendor/assets/stylesheets/apitome/highlight_themes/brown_paper.css +0 -104
  128. data/vendor/assets/stylesheets/apitome/highlight_themes/ir_black.css +0 -104
  129. data/vendor/assets/stylesheets/apitome/highlight_themes/school_book.css +0 -111
  130. data/vendor/assets/stylesheets/apitome/highlight_themes/solarized_dark.css +0 -88
  131. data/vendor/assets/stylesheets/apitome/highlight_themes/solarized_light.css +0 -88
  132. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night.css +0 -52
  133. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_blue.css +0 -52
  134. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_bright.css +0 -51
  135. data/vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_eighties.css +0 -51
@@ -0,0 +1,74 @@
1
+ /*
2
+
3
+ Darkula color scheme from the JetBrains family of IDEs
4
+
5
+ */
6
+
7
+
8
+ .hljs {
9
+ display: block;
10
+ overflow-x: auto;
11
+ padding: 0.5em;
12
+ background: #2b2b2b;
13
+ }
14
+
15
+ .hljs {
16
+ color: #bababa;
17
+ }
18
+
19
+ .hljs-strong,
20
+ .hljs-emphasis {
21
+ color: #a8a8a2;
22
+ }
23
+
24
+ .hljs-bullet,
25
+ .hljs-quote,
26
+ .hljs-link,
27
+ .hljs-number,
28
+ .hljs-regexp,
29
+ .hljs-literal {
30
+ color: #6896ba;
31
+ }
32
+
33
+ .hljs-code,
34
+ .hljs-selector-class {
35
+ color: #a6e22e;
36
+ }
37
+
38
+ .hljs-emphasis {
39
+ font-style: italic;
40
+ }
41
+
42
+ .hljs-keyword,
43
+ .hljs-selector-tag,
44
+ .hljs-section,
45
+ .hljs-attribute,
46
+ .hljs-name,
47
+ .hljs-variable {
48
+ color: #cb7832;
49
+ }
50
+
51
+ .hljs-params {
52
+ color: #b9b9b9;
53
+ }
54
+
55
+ .hljs-string,
56
+ .hljs-subst,
57
+ .hljs-type,
58
+ .hljs-built_in,
59
+ .hljs-builtin-name,
60
+ .hljs-symbol,
61
+ .hljs-selector-id,
62
+ .hljs-selector-attr,
63
+ .hljs-selector-pseudo,
64
+ .hljs-template-tag,
65
+ .hljs-template-variable,
66
+ .hljs-addition {
67
+ color: #e0c46c;
68
+ }
69
+
70
+ .hljs-comment,
71
+ .hljs-deletion,
72
+ .hljs-meta {
73
+ color: #7f7f7f;
74
+ }
@@ -1,135 +1,99 @@
1
1
  /*
2
2
 
3
- Original style from softwaremaniacs.org (c) Ivan Sagalaev <Maniac@SoftwareManiacs.Org>
3
+ Original highlight.js style (c) Ivan Sagalaev <maniac@softwaremaniacs.org>
4
4
 
5
5
  */
6
6
 
7
- pre code {
8
- display: block; padding: 0.5em;
7
+ .hljs {
8
+ display: block;
9
+ overflow-x: auto;
10
+ padding: 0.5em;
9
11
  background: #F0F0F0;
10
12
  }
11
13
 
12
- pre code,
13
- pre .subst,
14
- pre .tag .title,
15
- pre .lisp .title,
16
- pre .clojure .built_in,
17
- pre .nginx .title {
18
- color: black;
19
- }
20
14
 
21
- pre .string,
22
- pre .title,
23
- pre .constant,
24
- pre .parent,
25
- pre .tag .value,
26
- pre .rules .value,
27
- pre .rules .value .number,
28
- pre .preprocessor,
29
- pre .ruby .symbol,
30
- pre .ruby .symbol .string,
31
- pre .aggregate,
32
- pre .template_tag,
33
- pre .django .variable,
34
- pre .smalltalk .class,
35
- pre .addition,
36
- pre .flow,
37
- pre .stream,
38
- pre .bash .variable,
39
- pre .apache .tag,
40
- pre .apache .cbracket,
41
- pre .tex .command,
42
- pre .tex .special,
43
- pre .erlang_repl .function_or_atom,
44
- pre .markdown .header {
45
- color: #800;
15
+ /* Base color: saturation 0; */
16
+
17
+ .hljs,
18
+ .hljs-subst {
19
+ color: #444;
46
20
  }
47
21
 
48
- pre .comment,
49
- pre .annotation,
50
- pre .template_comment,
51
- pre .diff .header,
52
- pre .chunk,
53
- pre .markdown .blockquote {
54
- color: #888;
22
+ .hljs-comment {
23
+ color: #888888;
55
24
  }
56
25
 
57
- pre .number,
58
- pre .date,
59
- pre .regexp,
60
- pre .literal,
61
- pre .smalltalk .symbol,
62
- pre .smalltalk .char,
63
- pre .go .constant,
64
- pre .change,
65
- pre .markdown .bullet,
66
- pre .markdown .link_url {
67
- color: #080;
26
+ .hljs-keyword,
27
+ .hljs-attribute,
28
+ .hljs-selector-tag,
29
+ .hljs-meta-keyword,
30
+ .hljs-doctag,
31
+ .hljs-name {
32
+ font-weight: bold;
68
33
  }
69
34
 
70
- pre .label,
71
- pre .javadoc,
72
- pre .ruby .string,
73
- pre .decorator,
74
- pre .filter .argument,
75
- pre .localvars,
76
- pre .array,
77
- pre .attr_selector,
78
- pre .important,
79
- pre .pseudo,
80
- pre .pi,
81
- pre .doctype,
82
- pre .deletion,
83
- pre .envvar,
84
- pre .shebang,
85
- pre .apache .sqbracket,
86
- pre .nginx .built_in,
87
- pre .tex .formula,
88
- pre .erlang_repl .reserved,
89
- pre .prompt,
90
- pre .markdown .link_label,
91
- pre .vhdl .attribute,
92
- pre .clojure .attribute,
93
- pre .coffeescript .property {
94
- color: #88F
35
+
36
+ /* User color: hue: 0 */
37
+
38
+ .hljs-type,
39
+ .hljs-string,
40
+ .hljs-number,
41
+ .hljs-selector-id,
42
+ .hljs-selector-class,
43
+ .hljs-quote,
44
+ .hljs-template-tag,
45
+ .hljs-deletion {
46
+ color: #880000;
95
47
  }
96
48
 
97
- pre .keyword,
98
- pre .id,
99
- pre .phpdoc,
100
- pre .title,
101
- pre .built_in,
102
- pre .aggregate,
103
- pre .css .tag,
104
- pre .javadoctag,
105
- pre .phpdoc,
106
- pre .yardoctag,
107
- pre .smalltalk .class,
108
- pre .winutils,
109
- pre .bash .variable,
110
- pre .apache .tag,
111
- pre .go .typename,
112
- pre .tex .command,
113
- pre .markdown .strong,
114
- pre .request,
115
- pre .status {
49
+ .hljs-title,
50
+ .hljs-section {
51
+ color: #880000;
116
52
  font-weight: bold;
117
53
  }
118
54
 
119
- pre .markdown .emphasis {
120
- font-style: italic;
55
+ .hljs-regexp,
56
+ .hljs-symbol,
57
+ .hljs-variable,
58
+ .hljs-template-variable,
59
+ .hljs-link,
60
+ .hljs-selector-attr,
61
+ .hljs-selector-pseudo {
62
+ color: #BC6060;
63
+ }
64
+
65
+
66
+ /* Language color: hue: 90; */
67
+
68
+ .hljs-literal {
69
+ color: #78A960;
70
+ }
71
+
72
+ .hljs-built_in,
73
+ .hljs-bullet,
74
+ .hljs-code,
75
+ .hljs-addition {
76
+ color: #397300;
77
+ }
78
+
79
+
80
+ /* Meta color: hue: 200 */
81
+
82
+ .hljs-meta {
83
+ color: #1f7199;
121
84
  }
122
85
 
123
- pre .nginx .built_in {
124
- font-weight: normal;
86
+ .hljs-meta-string {
87
+ color: #4d99bf;
125
88
  }
126
89
 
127
- pre .coffeescript .javascript,
128
- pre .javascript .xml,
129
- pre .tex .formula,
130
- pre .xml .javascript,
131
- pre .xml .vbscript,
132
- pre .xml .css,
133
- pre .xml .cdata {
134
- opacity: 0.5;
90
+
91
+ /* Misc effects */
92
+
93
+ .hljs-emphasis {
94
+ font-style: italic;
95
+ }
96
+
97
+ .hljs-strong {
98
+ font-weight: bold;
135
99
  }
@@ -0,0 +1,97 @@
1
+ /*
2
+ Docco style used in http://jashkenas.github.com/docco/ converted by Simon Madine (@thingsinjars)
3
+ */
4
+
5
+ .hljs {
6
+ display: block;
7
+ overflow-x: auto;
8
+ padding: 0.5em;
9
+ color: #000;
10
+ background: #f8f8ff;
11
+ }
12
+
13
+ .hljs-comment,
14
+ .hljs-quote {
15
+ color: #408080;
16
+ font-style: italic;
17
+ }
18
+
19
+ .hljs-keyword,
20
+ .hljs-selector-tag,
21
+ .hljs-literal,
22
+ .hljs-subst {
23
+ color: #954121;
24
+ }
25
+
26
+ .hljs-number {
27
+ color: #40a070;
28
+ }
29
+
30
+ .hljs-string,
31
+ .hljs-doctag {
32
+ color: #219161;
33
+ }
34
+
35
+ .hljs-selector-id,
36
+ .hljs-selector-class,
37
+ .hljs-section,
38
+ .hljs-type {
39
+ color: #19469d;
40
+ }
41
+
42
+ .hljs-params {
43
+ color: #00f;
44
+ }
45
+
46
+ .hljs-title {
47
+ color: #458;
48
+ font-weight: bold;
49
+ }
50
+
51
+ .hljs-tag,
52
+ .hljs-name,
53
+ .hljs-attribute {
54
+ color: #000080;
55
+ font-weight: normal;
56
+ }
57
+
58
+ .hljs-variable,
59
+ .hljs-template-variable {
60
+ color: #008080;
61
+ }
62
+
63
+ .hljs-regexp,
64
+ .hljs-link {
65
+ color: #b68;
66
+ }
67
+
68
+ .hljs-symbol,
69
+ .hljs-bullet {
70
+ color: #990073;
71
+ }
72
+
73
+ .hljs-built_in,
74
+ .hljs-builtin-name {
75
+ color: #0086b3;
76
+ }
77
+
78
+ .hljs-meta {
79
+ color: #999;
80
+ font-weight: bold;
81
+ }
82
+
83
+ .hljs-deletion {
84
+ background: #fdd;
85
+ }
86
+
87
+ .hljs-addition {
88
+ background: #dfd;
89
+ }
90
+
91
+ .hljs-emphasis {
92
+ font-style: italic;
93
+ }
94
+
95
+ .hljs-strong {
96
+ font-weight: bold;
97
+ }
@@ -0,0 +1,76 @@
1
+ /*
2
+
3
+ Dracula Theme v1.2.0
4
+
5
+ https://github.com/zenorocha/dracula-theme
6
+
7
+ Copyright 2015, All rights reserved
8
+
9
+ Code licensed under the MIT license
10
+ http://zenorocha.mit-license.org
11
+
12
+ @author Éverton Ribeiro <nuxlli@gmail.com>
13
+ @author Zeno Rocha <hi@zenorocha.com>
14
+
15
+ */
16
+
17
+ .hljs {
18
+ display: block;
19
+ overflow-x: auto;
20
+ padding: 0.5em;
21
+ background: #282a36;
22
+ }
23
+
24
+ .hljs-keyword,
25
+ .hljs-selector-tag,
26
+ .hljs-literal,
27
+ .hljs-section,
28
+ .hljs-link {
29
+ color: #8be9fd;
30
+ }
31
+
32
+ .hljs-function .hljs-keyword {
33
+ color: #ff79c6;
34
+ }
35
+
36
+ .hljs,
37
+ .hljs-subst {
38
+ color: #f8f8f2;
39
+ }
40
+
41
+ .hljs-string,
42
+ .hljs-title,
43
+ .hljs-name,
44
+ .hljs-type,
45
+ .hljs-attribute,
46
+ .hljs-symbol,
47
+ .hljs-bullet,
48
+ .hljs-addition,
49
+ .hljs-variable,
50
+ .hljs-template-tag,
51
+ .hljs-template-variable {
52
+ color: #f1fa8c;
53
+ }
54
+
55
+ .hljs-comment,
56
+ .hljs-quote,
57
+ .hljs-deletion,
58
+ .hljs-meta {
59
+ color: #6272a4;
60
+ }
61
+
62
+ .hljs-keyword,
63
+ .hljs-selector-tag,
64
+ .hljs-literal,
65
+ .hljs-title,
66
+ .hljs-section,
67
+ .hljs-doctag,
68
+ .hljs-type,
69
+ .hljs-name,
70
+ .hljs-strong {
71
+ font-weight: bold;
72
+ }
73
+
74
+ .hljs-emphasis {
75
+ font-style: italic;
76
+ }