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
@@ -4,151 +4,90 @@ XCode style (c) Angel Garcia <angelgarcia.mail@gmail.com>
4
4
 
5
5
  */
6
6
 
7
- pre code {
8
- display: block; padding: 0.5em;
9
- background: #fff; color: black;
10
- }
11
-
12
- pre .comment,
13
- pre .template_comment,
14
- pre .javadoc,
15
- pre .comment * {
16
- color: rgb(0,106,0);
17
- }
18
-
19
- pre .keyword,
20
- pre .literal,
21
- pre .nginx .title {
22
- color: rgb(170,13,145);
23
- }
24
- pre .method,
25
- pre .list .title,
26
- pre .tag .title,
27
- pre .setting .value,
28
- pre .winutils,
29
- pre .tex .command,
30
- pre .http .title,
31
- pre .request,
32
- pre .status {
33
- color: #008;
7
+ .hljs {
8
+ display: block;
9
+ overflow-x: auto;
10
+ padding: 0.5em;
11
+ background: #fff;
12
+ color: black;
34
13
  }
35
14
 
36
- pre .envvar,
37
- pre .tex .special {
38
- color: #660;
15
+ .hljs-comment,
16
+ .hljs-quote {
17
+ color: #006a00;
39
18
  }
40
19
 
41
- pre .string {
42
- color: rgb(196,26,22);
43
- }
44
- pre .tag .value,
45
- pre .cdata,
46
- pre .filter .argument,
47
- pre .attr_selector,
48
- pre .apache .cbracket,
49
- pre .date,
50
- pre .regexp {
51
- color: #080;
20
+ .hljs-keyword,
21
+ .hljs-selector-tag,
22
+ .hljs-literal {
23
+ color: #aa0d91;
52
24
  }
53
25
 
54
- pre .sub .identifier,
55
- pre .pi,
56
- pre .tag,
57
- pre .tag .keyword,
58
- pre .decorator,
59
- pre .ini .title,
60
- pre .shebang,
61
- pre .prompt,
62
- pre .hexcolor,
63
- pre .rules .value,
64
- pre .css .value .number,
65
- pre .symbol,
66
- pre .symbol .string,
67
- pre .number,
68
- pre .css .function,
69
- pre .clojure .title,
70
- pre .clojure .built_in {
71
- color: rgb(28,0,207);
72
- }
73
-
74
- pre .class .title,
75
- pre .haskell .type,
76
- pre .smalltalk .class,
77
- pre .javadoctag,
78
- pre .yardoctag,
79
- pre .phpdoc,
80
- pre .typename,
81
- pre .tag .attribute,
82
- pre .doctype,
83
- pre .class .id,
84
- pre .built_in,
85
- pre .setting,
86
- pre .params,
87
- pre .clojure .attribute {
88
- color: rgb(92,38,153);
89
- }
90
-
91
- pre .variable {
92
- color: rgb(63,110,116);
93
- }
94
- pre .css .tag,
95
- pre .rules .property,
96
- pre .pseudo,
97
- pre .subst {
98
- color: #000;
26
+ .hljs-name {
27
+ color: #008;
99
28
  }
100
29
 
101
- pre .css .class, pre .css .id {
102
- color: #9B703F;
30
+ .hljs-variable,
31
+ .hljs-template-variable {
32
+ color: #660;
103
33
  }
104
34
 
105
- pre .value .important {
106
- color: #ff7700;
107
- font-weight: bold;
35
+ .hljs-string {
36
+ color: #c41a16;
108
37
  }
109
38
 
110
- pre .rules .keyword {
111
- color: #C5AF75;
39
+ .hljs-regexp,
40
+ .hljs-link {
41
+ color: #080;
112
42
  }
113
43
 
114
- pre .annotation,
115
- pre .apache .sqbracket,
116
- pre .nginx .built_in {
117
- color: #9B859D;
44
+ .hljs-title,
45
+ .hljs-tag,
46
+ .hljs-symbol,
47
+ .hljs-bullet,
48
+ .hljs-number,
49
+ .hljs-meta {
50
+ color: #1c00cf;
118
51
  }
119
52
 
120
- pre .preprocessor,
121
- pre .preprocessor * {
122
- color: rgb(100,56,32);
53
+ .hljs-section,
54
+ .hljs-class .hljs-title,
55
+ .hljs-type,
56
+ .hljs-attr,
57
+ .hljs-built_in,
58
+ .hljs-builtin-name,
59
+ .hljs-params {
60
+ color: #5c2699;
123
61
  }
124
62
 
125
- pre .tex .formula {
126
- background-color: #EEE;
127
- font-style: italic;
63
+ .hljs-attribute,
64
+ .hljs-subst {
65
+ color: #000;
128
66
  }
129
67
 
130
- pre .diff .header,
131
- pre .chunk {
132
- color: #808080;
133
- font-weight: bold;
68
+ .hljs-formula {
69
+ background-color: #eee;
70
+ font-style: italic;
134
71
  }
135
72
 
136
- pre .diff .change {
137
- background-color: #BCCFF9;
73
+ .hljs-addition {
74
+ background-color: #baeeba;
138
75
  }
139
76
 
140
- pre .addition {
141
- background-color: #BAEEBA;
77
+ .hljs-deletion {
78
+ background-color: #ffc8bd;
142
79
  }
143
80
 
144
- pre .deletion {
145
- background-color: #FFC8BD;
81
+ .hljs-selector-id,
82
+ .hljs-selector-class {
83
+ color: #9b703f;
146
84
  }
147
85
 
148
- pre .comment .yardoctag {
86
+ .hljs-doctag,
87
+ .hljs-strong {
149
88
  font-weight: bold;
150
89
  }
151
90
 
152
- pre .method .id {
153
- color: #000;
91
+ .hljs-emphasis {
92
+ font-style: italic;
154
93
  }
@@ -0,0 +1,92 @@
1
+
2
+ /*
3
+ xt256.css
4
+
5
+ Contact: initbar [at] protonmail [dot] ch
6
+ : github.com/initbar
7
+ */
8
+
9
+ .hljs {
10
+ display: block;
11
+ overflow-x: auto;
12
+ color: #eaeaea;
13
+ background: #000;
14
+ padding: 0.5;
15
+ }
16
+
17
+ .hljs-subst {
18
+ color: #eaeaea;
19
+ }
20
+
21
+ .hljs-emphasis {
22
+ font-style: italic;
23
+ }
24
+
25
+ .hljs-strong {
26
+ font-weight: bold;
27
+ }
28
+
29
+ .hljs-builtin-name,
30
+ .hljs-type {
31
+ color: #eaeaea;
32
+ }
33
+
34
+ .hljs-params {
35
+ color: #da0000;
36
+ }
37
+
38
+ .hljs-literal,
39
+ .hljs-number,
40
+ .hljs-name {
41
+ color: #ff0000;
42
+ font-weight: bolder;
43
+ }
44
+
45
+ .hljs-comment {
46
+ color: #969896;
47
+ }
48
+
49
+ .hljs-selector-id,
50
+ .hljs-quote {
51
+ color: #00ffff;
52
+ }
53
+
54
+ .hljs-template-variable,
55
+ .hljs-variable,
56
+ .hljs-title {
57
+ color: #00ffff;
58
+ font-weight: bold;
59
+ }
60
+
61
+ .hljs-selector-class,
62
+ .hljs-keyword,
63
+ .hljs-symbol {
64
+ color: #fff000;
65
+ }
66
+
67
+ .hljs-string,
68
+ .hljs-bullet {
69
+ color: #00ff00;
70
+ }
71
+
72
+ .hljs-tag,
73
+ .hljs-section {
74
+ color: #000fff;
75
+ }
76
+
77
+ .hljs-selector-tag {
78
+ color: #000fff;
79
+ font-weight: bold;
80
+ }
81
+
82
+ .hljs-attribute,
83
+ .hljs-built_in,
84
+ .hljs-regexp,
85
+ .hljs-link {
86
+ color: #ff00ff;
87
+ }
88
+
89
+ .hljs-meta {
90
+ color: #fff;
91
+ font-weight: bolder;
92
+ }
@@ -5,111 +5,76 @@ based on dark.css by Ivan Sagalaev
5
5
 
6
6
  */
7
7
 
8
- pre code {
9
- display: block; padding: 0.5em;
10
- background: #3F3F3F;
11
- color: #DCDCDC;
8
+ .hljs {
9
+ display: block;
10
+ overflow-x: auto;
11
+ padding: 0.5em;
12
+ background: #3f3f3f;
13
+ color: #dcdcdc;
12
14
  }
13
15
 
14
- pre .keyword,
15
- pre .tag,
16
- pre .css .class,
17
- pre .css .id,
18
- pre .lisp .title,
19
- pre .nginx .title,
20
- pre .request,
21
- pre .status,
22
- pre .clojure .attribute {
23
- color: #E3CEAB;
16
+ .hljs-keyword,
17
+ .hljs-selector-tag,
18
+ .hljs-tag {
19
+ color: #e3ceab;
24
20
  }
25
21
 
26
- pre .django .template_tag,
27
- pre .django .variable,
28
- pre .django .filter .argument {
29
- color: #DCDCDC;
22
+ .hljs-template-tag {
23
+ color: #dcdcdc;
30
24
  }
31
25
 
32
- pre .number,
33
- pre .date {
34
- color: #8CD0D3;
26
+ .hljs-number {
27
+ color: #8cd0d3;
35
28
  }
36
29
 
37
- pre .dos .envvar,
38
- pre .dos .stream,
39
- pre .variable,
40
- pre .apache .sqbracket {
41
- color: #EFDCBC;
30
+ .hljs-variable,
31
+ .hljs-template-variable,
32
+ .hljs-attribute {
33
+ color: #efdcbc;
42
34
  }
43
35
 
44
- pre .dos .flow,
45
- pre .diff .change,
46
- pre .python .exception,
47
- pre .python .built_in,
48
- pre .literal,
49
- pre .tex .special {
50
- color: #EFEFAF;
36
+ .hljs-literal {
37
+ color: #efefaf;
51
38
  }
52
39
 
53
- pre .diff .chunk,
54
- pre .subst {
55
- color: #8F8F8F;
40
+ .hljs-subst {
41
+ color: #8f8f8f;
56
42
  }
57
43
 
58
- pre .dos .keyword,
59
- pre .python .decorator,
60
- pre .title,
61
- pre .haskell .type,
62
- pre .diff .header,
63
- pre .ruby .class .parent,
64
- pre .apache .tag,
65
- pre .nginx .built_in,
66
- pre .tex .command,
67
- pre .prompt {
68
- color: #efef8f;
44
+ .hljs-title,
45
+ .hljs-name,
46
+ .hljs-selector-id,
47
+ .hljs-selector-class,
48
+ .hljs-section,
49
+ .hljs-type {
50
+ color: #efef8f;
69
51
  }
70
52
 
71
- pre .dos .winutils,
72
- pre .ruby .symbol,
73
- pre .ruby .symbol .string,
74
- pre .ruby .string {
75
- color: #DCA3A3;
53
+ .hljs-symbol,
54
+ .hljs-bullet,
55
+ .hljs-link {
56
+ color: #dca3a3;
76
57
  }
77
58
 
78
- pre .diff .deletion,
79
- pre .string,
80
- pre .tag .value,
81
- pre .preprocessor,
82
- pre .built_in,
83
- pre .sql .aggregate,
84
- pre .javadoc,
85
- pre .smalltalk .class,
86
- pre .smalltalk .localvars,
87
- pre .smalltalk .array,
88
- pre .css .rules .value,
89
- pre .attr_selector,
90
- pre .pseudo,
91
- pre .apache .cbracket,
92
- pre .tex .formula {
93
- color: #CC9393;
59
+ .hljs-deletion,
60
+ .hljs-string,
61
+ .hljs-built_in,
62
+ .hljs-builtin-name {
63
+ color: #cc9393;
94
64
  }
95
65
 
96
- pre .shebang,
97
- pre .diff .addition,
98
- pre .comment,
99
- pre .java .annotation,
100
- pre .template_comment,
101
- pre .pi,
102
- pre .doctype {
103
- color: #7F9F7F;
66
+ .hljs-addition,
67
+ .hljs-comment,
68
+ .hljs-quote,
69
+ .hljs-meta {
70
+ color: #7f9f7f;
104
71
  }
105
72
 
106
- pre .coffeescript .javascript,
107
- pre .javascript .xml,
108
- pre .tex .formula,
109
- pre .xml .javascript,
110
- pre .xml .vbscript,
111
- pre .xml .css,
112
- pre .xml .cdata {
113
- opacity: 0.5;
73
+
74
+ .hljs-emphasis {
75
+ font-style: italic;
114
76
  }
115
77
 
78
+ .hljs-strong {
79
+ font-weight: bold;
80
+ }