obarc 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. checksums.yaml +7 -0
  2. data/.codeclimate.yml +19 -0
  3. data/.gitignore +5 -0
  4. data/.rubocop.yml +1156 -0
  5. data/.travis.yml +12 -0
  6. data/Gemfile +3 -0
  7. data/Gemfile.lock +78 -0
  8. data/README.md +133 -0
  9. data/Rakefile +39 -0
  10. data/doc/OBarc.html +210 -0
  11. data/doc/OBarc/Api.html +883 -0
  12. data/doc/OBarc/Session.html +5399 -0
  13. data/doc/OBarc/Utils.html +117 -0
  14. data/doc/OBarc/Utils/Exceptions.html +115 -0
  15. data/doc/OBarc/Utils/Exceptions/InvalidArgumentError.html +230 -0
  16. data/doc/OBarc/Utils/Exceptions/InvalidElementError.html +218 -0
  17. data/doc/OBarc/Utils/Exceptions/InvalidWordError.html +218 -0
  18. data/doc/OBarc/Utils/Exceptions/MissingArgumentError.html +230 -0
  19. data/doc/OBarc/Utils/Exceptions/OBarcArgumentError.html +151 -0
  20. data/doc/OBarc/Utils/Exceptions/OBarcError.html +291 -0
  21. data/doc/OBarc/Utils/Exceptions/OBarcResponseError.html +520 -0
  22. data/doc/OBarc/Utils/Exceptions/OverLimitError.html +218 -0
  23. data/doc/OBarc/Utils/Exceptions/TimeOutError.html +218 -0
  24. data/doc/OBarc/Utils/Helper.html +115 -0
  25. data/doc/OBarc/Utils/Helper/ObjectExtensions.html +105 -0
  26. data/doc/_index.html +239 -0
  27. data/doc/class_list.html +58 -0
  28. data/doc/css/common.css +1 -0
  29. data/doc/css/full_list.css +57 -0
  30. data/doc/css/style.css +339 -0
  31. data/doc/file.README.html +229 -0
  32. data/doc/file_list.html +60 -0
  33. data/doc/frames.html +26 -0
  34. data/doc/index.html +229 -0
  35. data/doc/js/app.js +219 -0
  36. data/doc/js/full_list.js +181 -0
  37. data/doc/js/jquery.js +4 -0
  38. data/doc/method_list.html +465 -0
  39. data/doc/top-level-namespace.html +112 -0
  40. data/graphics/obarc-logo.png +0 -0
  41. data/graphics/obarc-logo.xcf +0 -0
  42. data/lib/obarc.rb +14 -0
  43. data/lib/obarc/api.rb +220 -0
  44. data/lib/obarc/session.rb +514 -0
  45. data/lib/obarc/utils/exceptions.rb +35 -0
  46. data/lib/obarc/utils/helper.rb +18 -0
  47. data/lib/obarc/version.rb +3 -0
  48. data/obarc.gemspec +32 -0
  49. metadata +276 -0
data/doc/css/style.css ADDED
@@ -0,0 +1,339 @@
1
+ body {
2
+ padding: 0 20px;
3
+ font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
4
+ font-size: 13px;
5
+ }
6
+ body.frames { padding: 0 5px; }
7
+ h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
8
+ h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
9
+ h1.title { margin-bottom: 10px; }
10
+ h1.alphaindex { margin-top: 0; font-size: 22px; }
11
+ h2 {
12
+ padding: 0;
13
+ padding-bottom: 3px;
14
+ border-bottom: 1px #aaa solid;
15
+ font-size: 1.4em;
16
+ margin: 1.8em 0 0.5em;
17
+ }
18
+ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
19
+ .clear { clear: both; }
20
+ .inline { display: inline; }
21
+ .inline p:first-child { display: inline; }
22
+ .docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
23
+ .docstring h1 { font-size: 1.2em; }
24
+ .docstring h2 { font-size: 1.1em; }
25
+ .docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
26
+ .summary_desc .object_link, .docstring .object_link { font-family: monospace; }
27
+ .rdoc-term { padding-right: 25px; font-weight: bold; }
28
+ .rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
29
+
30
+ /* style for <table> */
31
+ #filecontents table, .docstring table { border-collapse: collapse; }
32
+ #filecontents table th, #filecontents table td,
33
+ .docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; }
34
+ #filecontents table tr:nth-child(odd),
35
+ .docstring table tr:nth-child(odd) { background: #eee; }
36
+ #filecontents table tr:nth-child(even),
37
+ .docstring table tr:nth-child(even) { background: #fff; }
38
+ #filecontents table th, .docstring table th { background: #fff; }
39
+
40
+ /* style for <ul> */
41
+ #filecontents li > p, .docstring li > p { margin: 0px; }
42
+ #filecontents ul, .docstring ul { padding-left: 20px; }
43
+ /* style for <dl> */
44
+ #filecontents dl, .docstring dl { border: 1px solid #ccc; }
45
+ #filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; }
46
+ #filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
47
+ #filecontents dd > p, .docstring dd > p { margin: 0px; }
48
+
49
+ .note {
50
+ color: #222;
51
+ -moz-border-radius: 3px; -webkit-border-radius: 3px;
52
+ background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
53
+ display: block;
54
+ }
55
+ .note.todo { background: #ffffc5; border-color: #ececaa; }
56
+ .note.returns_void { background: #efefef; }
57
+ .note.deprecated { background: #ffe5e5; border-color: #e9dada; }
58
+ .note.private { background: #ffffc5; border-color: #ececaa; }
59
+ .note.title { padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
60
+ .summary_signature + .note.title { margin-left: 7px; }
61
+ h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
62
+ .note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
63
+ .note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
64
+ .note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
65
+ .note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
66
+ .note.title.not_defined_here { background: transparent; border: none; font-style: italic; }
67
+ .discussion .note { margin-top: 6px; }
68
+ .discussion .note:first-child { margin-top: 0; }
69
+
70
+ h3.inherited {
71
+ font-style: italic;
72
+ font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
73
+ font-weight: normal;
74
+ padding: 0;
75
+ margin: 0;
76
+ margin-top: 12px;
77
+ margin-bottom: 3px;
78
+ font-size: 13px;
79
+ }
80
+ p.inherited {
81
+ padding: 0;
82
+ margin: 0;
83
+ margin-left: 25px;
84
+ }
85
+
86
+ #filecontents dl.box, dl.box {
87
+ border: 0;
88
+ width: 520px;
89
+ font-size: 1em;
90
+ }
91
+ #filecontents dl.box dt, dl.box dt {
92
+ float: left;
93
+ display: block;
94
+ width: 100px;
95
+ margin: 0;
96
+ text-align: right;
97
+ font-weight: bold;
98
+ background: transparent;
99
+ border: 1px solid #aaa;
100
+ border-width: 1px 0px 0px 1px;
101
+ padding: 6px 0;
102
+ padding-right: 10px;
103
+ }
104
+ #filecontents dl.box dd, dl.box dd {
105
+ float: left;
106
+ display: block;
107
+ width: 380px;
108
+ margin: 0;
109
+ padding: 6px 0;
110
+ padding-right: 20px;
111
+ border: 1px solid #aaa;
112
+ border-width: 1px 1px 0 0;
113
+ }
114
+ #filecontents dl.box .last, dl.box .last {
115
+ border-bottom: 1px solid #aaa;
116
+ }
117
+ #filecontents dl.box .r1, dl.box .r1 { background: #eee; }
118
+
119
+ ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
120
+ .index_inline_list { padding-left: 0; font-size: 1.1em; }
121
+ .index_inline_list li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
122
+
123
+ dl.constants { margin-left: 40px; }
124
+ dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
125
+ dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
126
+
127
+ .summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
128
+ .summary_desc tt { font-size: 0.9em; }
129
+ dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; }
130
+ dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
131
+ dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; }
132
+ dl.constants .discussion *:first-child { margin-top: 0; }
133
+ dl.constants .discussion *:last-child { margin-bottom: 0; }
134
+
135
+ .method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
136
+ .method_details.first { border: 0; }
137
+ p.signature, h3.signature {
138
+ font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
139
+ padding: 6px 10px; margin-top: 18px;
140
+ background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
141
+ }
142
+ p.signature tt,
143
+ h3.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
144
+ p.signature .overload,
145
+ h3.signature .overload { display: block; }
146
+ p.signature .extras,
147
+ h3.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
148
+ p.signature .not_defined_here,
149
+ h3.signature .not_defined_here,
150
+ p.signature .aliases,
151
+ h3.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
152
+ p.signature .aliases .names,
153
+ h3.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
154
+
155
+ .tags .tag_title { font-size: 1em; margin-bottom: 0; font-weight: bold; }
156
+ .tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
157
+ .tags ul li { margin-bottom: 3px; }
158
+ .tags ul .name { font-family: monospace; font-weight: bold; }
159
+ .tags ul .note { padding: 3px 6px; }
160
+ .tags { margin-bottom: 12px; }
161
+
162
+ .tags .examples .tag_title { margin-bottom: 10px; font-weight: bold; }
163
+ .tags .examples .inline p { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
164
+
165
+ .tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
166
+ .tags .overload .overload_item .signature {
167
+ padding: 2px 8px;
168
+ background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
169
+ }
170
+ .tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
171
+ .tags .overload .docstring { margin-top: 15px; }
172
+
173
+ .defines { display: none; }
174
+
175
+ #method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
176
+
177
+ .showSource { font-size: 0.9em; }
178
+ .showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
179
+
180
+ #content a:link, #content a:visited { text-decoration: none; color: #05a; }
181
+ #content a:hover { background: #ffffa5; }
182
+ div.docstring, p.docstring { margin-right: 6em; }
183
+
184
+ ul.summary {
185
+ list-style: none;
186
+ font-family: monospace;
187
+ font-size: 1em;
188
+ line-height: 1.5em;
189
+ }
190
+ ul.summary a:link, ul.summary a:visited {
191
+ text-decoration: none; font-size: 1.1em;
192
+ }
193
+ ul.summary li { margin-bottom: 5px; }
194
+ .summary .summary_signature {
195
+ padding: 1px 10px;
196
+ background: #eaeaff; border: 1px solid #dfdfe5;
197
+ -moz-border-radius: 3px; -webkit-border-radius: 3px;
198
+ }
199
+ .summary_signature:hover { background: #eeeeff; cursor: pointer; }
200
+ ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
201
+ ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
202
+ #content .summary_signature:hover a:link,
203
+ #content .summary_signature:hover a:visited {
204
+ background: transparent;
205
+ color: #48f;
206
+ }
207
+
208
+ p.inherited a { font-family: monospace; font-size: 0.9em; }
209
+ p.inherited { word-spacing: 5px; font-size: 1.2em; }
210
+
211
+ p.children { font-size: 1.2em; }
212
+ p.children a { font-size: 0.9em; }
213
+ p.children strong { font-size: 0.8em; }
214
+ p.children strong.modules { padding-left: 5px; }
215
+
216
+ ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
217
+ ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
218
+ ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
219
+ ul.fullTree li:first-child { padding-top: 0; background: transparent; }
220
+ ul.fullTree li:last-child { padding-bottom: 0; }
221
+ .showAll ul.fullTree { display: block; }
222
+ .showAll .inheritName { display: none; }
223
+
224
+ #search { position: absolute; right: 14px; top: 0px; }
225
+ #search a:link, #search a:visited {
226
+ display: block; float: left; margin-right: 4px;
227
+ padding: 8px 10px; text-decoration: none; color: #05a;
228
+ border: 1px solid #d8d8e5;
229
+ -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
230
+ -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
231
+ background: #eaf0ff;
232
+ -webkit-box-shadow: -1px 1px 3px #ddd;
233
+ }
234
+ #search a:hover { background: #f5faff; color: #06b; }
235
+ #search a.active {
236
+ background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
237
+ -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
238
+ -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
239
+ }
240
+ #search a.inactive { color: #999; }
241
+ .frames #search { display: none; }
242
+ .inheritanceTree, .toggleDefines { float: right; }
243
+
244
+ #menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
245
+ #menu .title, #menu a { font-size: 0.7em; }
246
+ #menu .title a { font-size: 1em; }
247
+ #menu .title { color: #555; }
248
+ #menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
249
+ #menu a:hover { color: #05a; }
250
+ #menu .noframes { display: inline; }
251
+ .frames #menu .noframes { display: inline; float: right; }
252
+
253
+ #footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
254
+ #footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
255
+ #footer a:hover { color: #05a; }
256
+
257
+ #listing ul.alpha { font-size: 1.1em; }
258
+ #listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
259
+ #listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
260
+ #listing ul.alpha ul { margin: 0; padding-left: 15px; }
261
+ #listing ul small { color: #666; font-size: 0.7em; }
262
+
263
+ li.r1 { background: #f0f0f0; }
264
+ li.r2 { background: #fafafa; }
265
+
266
+ #search_frame {
267
+ z-index: 9999;
268
+ background: #fff;
269
+ display: none;
270
+ position: absolute;
271
+ top: 36px;
272
+ right: 18px;
273
+ width: 500px;
274
+ height: 80%;
275
+ overflow-y: scroll;
276
+ border: 1px solid #999;
277
+ border-collapse: collapse;
278
+ -webkit-box-shadow: -7px 5px 25px #aaa;
279
+ -moz-box-shadow: -7px 5px 25px #aaa;
280
+ -moz-border-radius: 2px;
281
+ -webkit-border-radius: 2px;
282
+ }
283
+
284
+ #content ul.summary li.deprecated .summary_signature a:link,
285
+ #content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
286
+
287
+ #toc {
288
+ padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px;
289
+ max-width: 300px;
290
+ -webkit-box-shadow: -2px 2px 6px #bbb;
291
+ -moz-box-shadow: -2px 2px 6px #bbb;
292
+ z-index: 5000;
293
+ position: relative;
294
+ overflow-x: auto;
295
+ }
296
+ #toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }
297
+ #toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; }
298
+ #toc .title { margin: 0; }
299
+ #toc ol { padding-left: 1.8em; }
300
+ #toc li { font-size: 1.1em; line-height: 1.7em; }
301
+ #toc > ol > li { font-size: 1.1em; font-weight: bold; }
302
+ #toc ol > ol { font-size: 0.9em; }
303
+ #toc ol ol > ol { padding-left: 2.3em; }
304
+ #toc ol + li { margin-top: 0.3em; }
305
+ #toc.hidden { padding: 10px; background: #f6f6f6; -webkit-box-shadow: none; -moz-box-shadow: none; }
306
+ #filecontents h1 + #toc.nofloat { margin-top: 0; }
307
+
308
+ /* syntax highlighting */
309
+ .source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
310
+ #filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
311
+ #filecontents pre.code, .docstring pre.code { display: block; }
312
+ .source_code .lines { padding-right: 12px; color: #555; text-align: right; }
313
+ #filecontents pre.code, .docstring pre.code,
314
+ .tags pre.example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
315
+ pre.code { color: #000; }
316
+ pre.code .info.file { color: #555; }
317
+ pre.code .val { color: #036A07; }
318
+ pre.code .tstring_content,
319
+ pre.code .heredoc_beg, pre.code .heredoc_end,
320
+ pre.code .qwords_beg, pre.code .qwords_end,
321
+ pre.code .tstring, pre.code .dstring { color: #036A07; }
322
+ pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
323
+ pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
324
+ pre.code .dot + pre.code .id,
325
+ pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
326
+ pre.code .comment { color: #0066FF; }
327
+ pre.code .const, pre.code .constant { color: #585CF6; }
328
+ pre.code .label,
329
+ pre.code .symbol { color: #C5060B; }
330
+ pre.code .kw,
331
+ pre.code .rubyid_require,
332
+ pre.code .rubyid_extend,
333
+ pre.code .rubyid_include { color: #0000FF; }
334
+ pre.code .ivar { color: #318495; }
335
+ pre.code .gvar,
336
+ pre.code .rubyid_backref,
337
+ pre.code .rubyid_nth_ref { color: #6D79DE; }
338
+ pre.code .regexp, .dregexp { color: #036A07; }
339
+ pre.code a { border-bottom: 1px dotted #bbf; }
data/doc/file.README.html ADDED
@@ -0,0 +1,229 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!file.README.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: README</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'>
65
+ <h1 id="label-OpenBazaar+API+Ruby+Client"><a href="https://github.com/inertia186/obarc">OpenBazaar API Ruby Client</a></h1>
66
+
67
+ <p><a href="https://travis-ci.org/inertia186/obarc"><img
68
+ src="https://travis-ci.org/inertia186/obarc.svg?branch=master"></a> <a
69
+ href="https://codeclimate.com/github/inertia186/obarc"><img
70
+ src="https://codeclimate.com/github/inertia186/obarc/badges/gpa.svg"></a>
71
+ <a href="https://codeclimate.com/github/inertia186/obarc"><img
72
+ src="https://codeclimate.com/github/inertia186/obarc/badges/coverage.svg"></a></p>
73
+
74
+ <p>A simple OpenBazaar API client for Ruby.</p>
75
+
76
+ <h4 id="label-Fixes+in+0.5.2">Fixes in 0.5.2</h4>
77
+ <ul><li>
78
+ <p>Support for gem release.</p>
79
+ </li><li>
80
+ <p>Dependency refresh.</p>
81
+ </li><li>
82
+ <p>Deprecation removal.</p>
83
+ </li></ul>
84
+
85
+ <h3 id="label-Installation">Installation</h3>
86
+
87
+ <p>Add the gem to your Gemfile:</p>
88
+
89
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>obarc</span><span class='tstring_end'>&#39;</span></span>
90
+ </code></pre>
91
+
92
+ <p>Then:</p>
93
+
94
+ <pre class="code ruby"><code class="ruby">$ bundle install</code></pre>
95
+
96
+ <h3 id="label-Usage">Usage</h3>
97
+
98
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>obarc</span><span class='tstring_end'>&#39;</span></span>
99
+
100
+ <span class='id identifier rubyid_session'>session</span> <span class='op'>=</span> <span class='const'>OBarc</span><span class='op'>::</span><span class='const'>Session</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>username:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>username</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>password</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
101
+
102
+ <span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_profile'>profile</span>
103
+ </code></pre>
104
+
105
+ <pre class="code ruby"><code class="ruby">{&quot;profile&quot;:
106
+ {&quot;website&quot;: &quot;website&quot;,
107
+ &quot;public_key&quot;: &quot;b7d8f6ee04453e1babde87d12198ecd14be00aa998e85636767d8b00d2603e6d&quot;,
108
+ .
109
+ .
110
+ .
111
+ &quot;primary_color&quot;: 16777215,
112
+ &quot;background_color&quot;: 12832757,
113
+ &quot;email&quot;: &quot;email@bogus.com&quot;}}</code></pre>
114
+
115
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_update_profile'>update_profile</span><span class='lparen'>(</span><span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>big@vendor.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
116
+ </code></pre>
117
+
118
+ <pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>success</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span>
119
+ </code></pre>
120
+
121
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_connected_peers'>connected_peers</span>
122
+ </code></pre>
123
+
124
+ <pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>peers</span><span class='label_end'>&quot;:</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>5.37.3.8</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='int'>28467</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>num_peers</span><span class='label_end'>&quot;:</span> <span class='int'>1</span><span class='rbrace'>}</span>
125
+ </code></pre>
126
+
127
+ <p>If you want to manually upload an image, this will return the image hash.
128
+ <code>ruby session.upload_image(image:
129
+ &#39;iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAC91JREFUWAktl3mQHOV5xn99zH3u7K1d7Uq7CEkIpNVZRhagQDjKCcaxSIJNIJTjI5XCuakKceXyHy5XnJSr&#39;)
130
+ </code> <code>json {&quot;image_hashes&quot;:
131
+ [&quot;a89810619833ef29d373c124ce05f362a313929e&quot;],
132
+ &quot;success&quot;: true} </code></p>
133
+
134
+ <p>You can also add a new listing with image URLs in the hash. The client will
135
+ upload them and save the image hashes to the contract.</p>
136
+
137
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_create_contract'>create_contract</span><span class='lparen'>(</span>
138
+ <span class='label'>expiration_date:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
139
+ <span class='label'>metadata_category:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>physical good</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
140
+ <span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Black Dress</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
141
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>A pretty black dress.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
142
+ <span class='label'>currency_code:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>USD</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
143
+ <span class='label'>price:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>19.95</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
144
+ <span class='label'>process_time:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>3 Business Days</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
145
+ <span class='label'>nsfw:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>false</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
146
+ <span class='label'>shipping_origin:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>UNITED_STATES</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
147
+ <span class='label'>ships_to:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>UNITED_STATES</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
148
+ <span class='label'>est_delivery_domestic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>5-7 Business Days</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
149
+ <span class='label'>est_delivery_international:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
150
+ <span class='label'>terms_conditions:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>We cannot ship to PO Boxes/APO&#39;s\n * We cannot combine shipping.\n * No Local Pickup.</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
151
+ <span class='label'>returns:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Your satisfaction is guaranteed! If for any reason you are unhappy with your item, we can arrange a return within 14 days for a full refund, minus shipping cost. Please contact us prior to initiating a return so that we can issue you a refund authorization.</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
152
+ <span class='label'>shipping_currency_code:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>USD</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
153
+ <span class='label'>shipping_domestic:</span> <span class='kw'>true</span><span class='comma'>,</span>
154
+ <span class='label'>shipping_international:</span> <span class='kw'>false</span><span class='comma'>,</span>
155
+ <span class='label'>keywords:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dress</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
156
+ <span class='label'>category:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
157
+ <span class='label'>condition:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>New</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
158
+ <span class='label'>sku:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>123456789</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
159
+ <span class='label'>image_urls:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://i.imgur.com/2KXXHSt.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
160
+ <span class='label'>free_shipping:</span> <span class='kw'>true</span>
161
+ <span class='rparen'>)</span>
162
+ </code></pre>
163
+
164
+ <pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>success</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span>
165
+ </code></pre>
166
+
167
+ <h2 id="label-Tests">Tests</h2>
168
+ <ul><li>
169
+ <p>Clone the client repository into a directory of your choice:</p>
170
+ </li><li>
171
+ <p><code>git clone https://github.com/inertia186/obarc.git</code></p>
172
+ </li><li>
173
+ <p>Navigate into the new folder</p>
174
+ </li><li>
175
+ <p><code>cd obarc</code></p>
176
+ </li><li>
177
+ <p>Basic tests can be invoked as follows:</p>
178
+ </li><li>
179
+ <p><code>rake</code></p>
180
+ </li><li>
181
+ <p>To run tests with parallelization and local code coverage:</p>
182
+ </li><li>
183
+ <p><code>HELL_ENABLED=true rake</code></p>
184
+ </li><li>
185
+ <p>To run tests against a testnet server:</p>
186
+ </li><li>
187
+ <p><code>TEST_NET=true OB_SERVER_HOST=localhost OB_USERNAME=username
188
+ OB_PASSWORD=password rake</code></p>
189
+ </li></ul>
190
+
191
+ <h2 id="label-Docmentation">Docmentation</h2>
192
+ <ul><li>
193
+ <p><a
194
+ href="http://www.rubydoc.info/github/inertia186/obarc/master/OBarc/Session">Session</a>
195
+ - Most of what you need in your app is explained here.</p>
196
+ </li></ul>
197
+
198
+ <h2 id="label-Requirements">Requirements</h2>
199
+ <ul><li>
200
+ <p><code>ruby 2.1.5</code></p>
201
+ </li><li>
202
+ <p><code>bundler 1.11</code></p>
203
+ </li><li>
204
+ <p><code>OpenBazaar-Server 1.1.15</code></p>
205
+ </li></ul>
206
+
207
+ <h2 id="label-Get+in+touch-21">Get in touch!</h2>
208
+
209
+ <p>If you&#39;re using OBarc, I&#39;d love to hear from you. Drop me a line
210
+ and tell me what you think!</p>
211
+ <center>
212
+ <img src="https://cl.ly/233t0q0v2j0p/obarc-logo.png" />
213
+ </center>
214
+ <h2 id="label-Licence">Licence</h2>
215
+
216
+ <p>I don&#39;t believe in intellectual “property”. If you do, consider OBarc
217
+ as licensed under a Creative Commons <a
218
+ href="http://creativecommons.org/publicdomain/zero/1.0/"><img
219
+ src="http://i.creativecommons.org/p/zero/1.0/80x15.png"></a> License.</p>
220
+ </div></div>
221
+
222
+ <div id="footer">
223
+ Generated on Tue Apr 4 17:29:29 2017 by
224
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
225
+ 0.8.7.6 (ruby-2.2.5).
226
+ </div>
227
+
228
+ </body>
229
+ </html>