crapi 0.1.3 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
data/docs/CrAPI.html ADDED
@@ -0,0 +1,157 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: CrAPI
8
+
9
+ &mdash; Documentation by YARD 0.9.28
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "CrAPI";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (C)</a> &raquo;
40
+
41
+
42
+ <span class="title">CrAPI</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: CrAPI
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/crapi.rb<span class="defines">,<br />
82
+ lib/crapi/proxy.rb,<br /> lib/crapi/client.rb,<br /> lib/crapi/errors.rb,<br /> lib/crapi/version.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Overview</h2><div class="docstring">
89
+ <div class="discussion">
90
+ <p>The CrAPI module houses the <span class='object_link'><a href="CrAPI/Client.html" title="CrAPI::Client (class)">CrAPI::Client</a></span> and <span class='object_link'><a href="CrAPI/Proxy.html" title="CrAPI::Proxy (class)">CrAPI::Proxy</a></span> classes
91
+ in this gem.</p>
92
+
93
+
94
+ </div>
95
+ </div>
96
+ <div class="tags">
97
+
98
+
99
+ </div><h2>Defined Under Namespace</h2>
100
+ <p class="children">
101
+
102
+
103
+
104
+
105
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="CrAPI/ArgumentError.html" title="CrAPI::ArgumentError (class)">ArgumentError</a></span>, <span class='object_link'><a href="CrAPI/BadHttpResponseError.html" title="CrAPI::BadHttpResponseError (class)">BadHttpResponseError</a></span>, <span class='object_link'><a href="CrAPI/Client.html" title="CrAPI::Client (class)">Client</a></span>, <span class='object_link'><a href="CrAPI/Error.html" title="CrAPI::Error (class)">Error</a></span>, <span class='object_link'><a href="CrAPI/Proxy.html" title="CrAPI::Proxy (class)">Proxy</a></span>
106
+
107
+
108
+ </p>
109
+
110
+
111
+ <h2>
112
+ Constant Summary
113
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
114
+ </h2>
115
+
116
+ <dl class="constants">
117
+
118
+ <dt id="VERSION-constant" class="">VERSION =
119
+ <div class="docstring">
120
+ <div class="discussion">
121
+ <p>The canonical <strong>crapi</strong> gem version.</p>
122
+
123
+ <p>This should only ever be updated <em>immediately</em> before a release; the commit that updates this
124
+ value should be pushed <strong>by</strong> the <code>rake release</code> process.</p>
125
+
126
+
127
+ </div>
128
+ </div>
129
+ <div class="tags">
130
+
131
+
132
+ </div>
133
+ </dt>
134
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
135
+
136
+ </dl>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ </div>
148
+
149
+ <div id="footer">
150
+ Generated on Mon Jan 2 15:16:45 2023 by
151
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152
+ 0.9.28 (ruby-3.0.4).
153
+ </div>
154
+
155
+ </div>
156
+ </body>
157
+ </html>
data/docs/Net/HTTP.html CHANGED
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  Class: Net::HTTP
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.28
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "Net::HTTP";
19
19
  relpath = '../';
20
20
  </script>
@@ -37,7 +37,7 @@
37
37
  <div id="menu">
38
38
 
39
39
  <a href="../_index.html">Index (H)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Crapi.html" title="Crapi (module)">Crapi</a></span></span> &raquo; <span class='title'>Net</span>
40
+ <span class='title'><span class='object_link'><a href="../CrAPI.html" title="CrAPI (module)">CrAPI</a></span></span> &raquo; <span class='title'>Net</span>
41
41
  &raquo;
42
42
  <span class="title">HTTP</span>
43
43
 
@@ -101,9 +101,7 @@
101
101
 
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
-
105
- <p>Net::HTTP needs a shortcut instance method for PUT calls like it does for
106
- GET/DELETE/PATCH/POST.</p>
104
+ <p>Net::HTTP needs a shortcut instance method for PUT calls like it does for GET/DELETE/PATCH/POST.</p>
107
105
 
108
106
 
109
107
  </div>
@@ -143,8 +141,7 @@ GET/DELETE/PATCH/POST.</p>
143
141
 
144
142
 
145
143
 
146
- <span class="summary_desc"><div class='inline'>
147
- <p>Convenience PUT method monkey-patched into Net::HTTP.</p>
144
+ <span class="summary_desc"><div class='inline'><p>Convenience PUT method monkey-patched into Net::HTTP.</p>
148
145
  </div></span>
149
146
 
150
147
  </li>
@@ -170,13 +167,11 @@ GET/DELETE/PATCH/POST.</p>
170
167
 
171
168
  </h3><div class="docstring">
172
169
  <div class="discussion">
173
-
174
- <p>Convenience PUT method monkey-patched into Net::HTTP.</p>
170
+ <p>Convenience PUT method monkey-patched into Net::HTTP.</p>
175
171
 
176
- <p>Net::HTTP provides handy methods for DELETE, GET, HEAD, OPTIONS, PATCH, and
177
- POST, <strong>but not PUT</strong>, so we have to monkey-patch one in. The
178
- parameters listed below were chosen to match those in use for the other
179
- Net::HTTP request methods in both name and meaning.</p>
172
+ <p>Net::HTTP provides handy methods for DELETE, GET, HEAD, OPTIONS, PATCH, and POST, <strong>but not
173
+ PUT</strong>, so we have to monkey-patch one in. The parameters listed below were chosen to match
174
+ those in use for the other Net::HTTP request methods in both name and meaning.</p>
180
175
 
181
176
 
182
177
  </div>
@@ -262,12 +257,12 @@ Net::HTTP request methods in both name and meaning.</p>
262
257
  <pre class="lines">
263
258
 
264
259
 
265
- 357
266
- 358
267
- 359</pre>
260
+ 353
261
+ 354
262
+ 355</pre>
268
263
  </td>
269
264
  <td>
270
- <pre class="code"><span class="info file"># File 'lib/crapi/client.rb', line 357</span>
265
+ <pre class="code"><span class="info file"># File 'lib/crapi/client.rb', line 353</span>
271
266
 
272
267
  <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_initheader'>initheader</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_dest'>dest</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
273
268
  <span class='id identifier rubyid_send_entity'>send_entity</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_initheader'>initheader</span><span class='comma'>,</span> <span class='id identifier rubyid_dest'>dest</span><span class='comma'>,</span> <span class='const'>Put</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
@@ -282,9 +277,9 @@ Net::HTTP request methods in both name and meaning.</p>
282
277
  </div>
283
278
 
284
279
  <div id="footer">
285
- Generated on Wed May 30 11:27:03 2018 by
286
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
287
- 0.9.12 (ruby-2.5.1).
280
+ Generated on Mon Jan 2 15:16:45 2023 by
281
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
282
+ 0.9.28 (ruby-3.0.4).
288
283
  </div>
289
284
 
290
285
  </div>
data/docs/_index.html CHANGED
@@ -4,15 +4,15 @@
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
6
  <title>
7
- Documentation by YARD 0.9.12
7
+ Documentation by YARD 0.9.28
8
8
 
9
9
  </title>
10
10
 
11
- <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
12
12
 
13
- <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
14
14
 
15
- <script type="text/javascript" charset="utf-8">
15
+ <script type="text/javascript">
16
16
  pathId = null;
17
17
  relpath = '';
18
18
  </script>
@@ -52,7 +52,7 @@
52
52
  <div class="clear"></div>
53
53
  </div>
54
54
 
55
- <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.12</h1>
55
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.28</h1>
56
56
  <div id="listing">
57
57
  <h1 class="alphaindex">Alphabetic Index</h1>
58
58
 
@@ -81,9 +81,9 @@
81
81
  <ul>
82
82
 
83
83
  <li>
84
- <span class='object_link'><a href="Crapi/ArgumentError.html" title="Crapi::ArgumentError (class)">ArgumentError</a></span>
84
+ <span class='object_link'><a href="CrAPI/ArgumentError.html" title="CrAPI::ArgumentError (class)">ArgumentError</a></span>
85
85
 
86
- <small>(Crapi)</small>
86
+ <small>(CrAPI)</small>
87
87
 
88
88
  </li>
89
89
 
@@ -96,9 +96,9 @@
96
96
  <ul>
97
97
 
98
98
  <li>
99
- <span class='object_link'><a href="Crapi/BadHttpResponseError.html" title="Crapi::BadHttpResponseError (class)">BadHttpResponseError</a></span>
99
+ <span class='object_link'><a href="CrAPI/BadHttpResponseError.html" title="CrAPI::BadHttpResponseError (class)">BadHttpResponseError</a></span>
100
100
 
101
- <small>(Crapi)</small>
101
+ <small>(CrAPI)</small>
102
102
 
103
103
  </li>
104
104
 
@@ -111,14 +111,14 @@
111
111
  <ul>
112
112
 
113
113
  <li>
114
- <span class='object_link'><a href="Crapi/Client.html" title="Crapi::Client (class)">Client</a></span>
114
+ <span class='object_link'><a href="CrAPI/Client.html" title="CrAPI::Client (class)">Client</a></span>
115
115
 
116
- <small>(Crapi)</small>
116
+ <small>(CrAPI)</small>
117
117
 
118
118
  </li>
119
119
 
120
120
  <li>
121
- <span class='object_link'><a href="Crapi.html" title="Crapi (module)">Crapi</a></span>
121
+ <span class='object_link'><a href="CrAPI.html" title="CrAPI (module)">CrAPI</a></span>
122
122
 
123
123
  </li>
124
124
 
@@ -131,9 +131,9 @@
131
131
  <ul>
132
132
 
133
133
  <li>
134
- <span class='object_link'><a href="Crapi/Error.html" title="Crapi::Error (class)">Error</a></span>
134
+ <span class='object_link'><a href="CrAPI/Error.html" title="CrAPI::Error (class)">Error</a></span>
135
135
 
136
- <small>(Crapi)</small>
136
+ <small>(CrAPI)</small>
137
137
 
138
138
  </li>
139
139
 
@@ -161,9 +161,9 @@
161
161
  <ul>
162
162
 
163
163
  <li>
164
- <span class='object_link'><a href="Crapi/Proxy.html" title="Crapi::Proxy (class)">Proxy</a></span>
164
+ <span class='object_link'><a href="CrAPI/Proxy.html" title="CrAPI::Proxy (class)">Proxy</a></span>
165
165
 
166
- <small>(Crapi)</small>
166
+ <small>(CrAPI)</small>
167
167
 
168
168
  </li>
169
169
 
@@ -179,9 +179,9 @@
179
179
  </div>
180
180
 
181
181
  <div id="footer">
182
- Generated on Wed May 30 11:27:01 2018 by
183
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
184
- 0.9.12 (ruby-2.5.1).
182
+ Generated on Mon Jan 2 15:16:45 2023 by
183
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
184
+ 0.9.28 (ruby-3.0.4).
185
185
  </div>
186
186
 
187
187
  </div>
data/docs/class_list.html CHANGED
@@ -4,9 +4,9 @@
4
4
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
5
  <meta charset="utf-8" />
6
6
 
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
8
 
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
10
 
11
11
 
12
12
 
@@ -43,7 +43,7 @@
43
43
 
44
44
  <ul id="full_list" class="class">
45
45
  <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
46
- <li id='object_Crapi' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Crapi.html" title="Crapi (module)">Crapi</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Crapi::ArgumentError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Crapi/ArgumentError.html" title="Crapi::ArgumentError (class)">ArgumentError</a></span> &lt; Error<small class='search_info'>Crapi</small></div></li><li id='object_Crapi::BadHttpResponseError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Crapi/BadHttpResponseError.html" title="Crapi::BadHttpResponseError (class)">BadHttpResponseError</a></span> &lt; Error<small class='search_info'>Crapi</small></div></li><li id='object_Crapi::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Crapi/Client.html" title="Crapi::Client (class)">Client</a></span> &lt; Object<small class='search_info'>Crapi</small></div></li><li id='object_Crapi::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Crapi/Error.html" title="Crapi::Error (class)">Error</a></span> &lt; StandardError<small class='search_info'>Crapi</small></div></li><li id='object_Crapi::Proxy' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Crapi/Proxy.html" title="Crapi::Proxy (class)">Proxy</a></span> &lt; Object<small class='search_info'>Crapi</small></div></li></ul></li><li id='object_Net::HTTP' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Net/HTTP.html" title="Net::HTTP (class)">Net::HTTP</a></span> &lt; Object<small class='search_info'>Net</small></div></li>
46
+ <li id='object_CrAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="CrAPI.html" title="CrAPI (module)">CrAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_CrAPI::ArgumentError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="CrAPI/ArgumentError.html" title="CrAPI::ArgumentError (class)">ArgumentError</a></span> &lt; Error<small class='search_info'>CrAPI</small></div></li><li id='object_CrAPI::BadHttpResponseError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="CrAPI/BadHttpResponseError.html" title="CrAPI::BadHttpResponseError (class)">BadHttpResponseError</a></span> &lt; Error<small class='search_info'>CrAPI</small></div></li><li id='object_CrAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="CrAPI/Client.html" title="CrAPI::Client (class)">Client</a></span> &lt; Object<small class='search_info'>CrAPI</small></div></li><li id='object_CrAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="CrAPI/Error.html" title="CrAPI::Error (class)">Error</a></span> &lt; StandardError<small class='search_info'>CrAPI</small></div></li><li id='object_CrAPI::Proxy' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="CrAPI/Proxy.html" title="CrAPI::Proxy (class)">Proxy</a></span> &lt; Object<small class='search_info'>CrAPI</small></div></li></ul></li><li id='object_Net::HTTP' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Net/HTTP.html" title="Net::HTTP (class)">Net::HTTP</a></span> &lt; Object<small class='search_info'>Net</small></div></li>
47
47
 
48
48
  </ul>
49
49
  </div>
data/docs/css/style.css CHANGED
@@ -52,6 +52,7 @@ body {
52
52
  background: #fff;
53
53
  padding: 1.2em;
54
54
  padding-top: 0.2em;
55
+ box-sizing: border-box;
55
56
  }
56
57
 
57
58
  @media (max-width: 920px) {
@@ -245,6 +246,7 @@ ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
245
246
 
246
247
  dl.constants { margin-left: 10px; }
247
248
  dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
249
+ dl.constants.compact dt { display: inline-block; font-weight: normal }
248
250
  dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
249
251
  dl.constants .docstring .note:first-child { margin-top: 5px; }
250
252
 
@@ -326,13 +328,9 @@ ul.summary a, ul.summary a:visited {
326
328
  text-decoration: none; font-size: 1.1em;
327
329
  }
328
330
  ul.summary li { margin-bottom: 5px; }
329
- .summary .summary_signature {
330
- padding: 4px 8px;
331
- background: #f8f8f8;
332
- border: 1px solid #f0f0f0;
333
- border-radius: 5px;
334
- }
331
+ .summary_signature { padding: 4px 8px; background: #f8f8f8; border: 1px solid #f0f0f0; border-radius: 5px; }
335
332
  .summary_signature:hover { background: #CFEBFF; border-color: #A4CCDA; cursor: pointer; }
333
+ .summary_signature.deprecated { background: #ffe5e5; border-color: #e9dada; }
336
334
  ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
337
335
  ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
338
336
  #content .summary_signature:hover a,
@@ -425,8 +423,8 @@ li.r2 { background: #fafafa; }
425
423
  #toc ol { padding-left: 1.8em; }
426
424
  #toc li { font-size: 1.1em; line-height: 1.7em; }
427
425
  #toc > ol > li { font-size: 1.1em; font-weight: bold; }
428
- #toc ol > ol { font-size: 0.9em; }
429
- #toc ol ol > ol { padding-left: 2.3em; }
426
+ #toc ol > li > ol { font-size: 0.9em; }
427
+ #toc ol ol > li > ol { padding-left: 2.3em; }
430
428
  #toc ol + li { margin-top: 0.3em; }
431
429
  #toc.hidden { padding: 10px; background: #fefefe; box-shadow: none; }
432
430
  #toc.hidden:hover { background: #fafafa; }
@@ -485,7 +483,7 @@ pre.code .rubyid_nth_ref { color: #6D79DE; }
485
483
  pre.code .regexp, .dregexp { color: #036A07; }
486
484
  pre.code a { border-bottom: 1px dotted #bbf; }
487
485
  /* inline code */
488
- p > code {
486
+ *:not(pre) > code {
489
487
  padding: 1px 3px 1px 3px;
490
488
  border: 1px solid #E1E1E8;
491
489
  background: #F7F7F9;