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.
- checksums.yaml +7 -0
- data/.codeclimate.yml +19 -0
- data/.gitignore +5 -0
- data/.rubocop.yml +1156 -0
- data/.travis.yml +12 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +78 -0
- data/README.md +133 -0
- data/Rakefile +39 -0
- data/doc/OBarc.html +210 -0
- data/doc/OBarc/Api.html +883 -0
- data/doc/OBarc/Session.html +5399 -0
- data/doc/OBarc/Utils.html +117 -0
- data/doc/OBarc/Utils/Exceptions.html +115 -0
- data/doc/OBarc/Utils/Exceptions/InvalidArgumentError.html +230 -0
- data/doc/OBarc/Utils/Exceptions/InvalidElementError.html +218 -0
- data/doc/OBarc/Utils/Exceptions/InvalidWordError.html +218 -0
- data/doc/OBarc/Utils/Exceptions/MissingArgumentError.html +230 -0
- data/doc/OBarc/Utils/Exceptions/OBarcArgumentError.html +151 -0
- data/doc/OBarc/Utils/Exceptions/OBarcError.html +291 -0
- data/doc/OBarc/Utils/Exceptions/OBarcResponseError.html +520 -0
- data/doc/OBarc/Utils/Exceptions/OverLimitError.html +218 -0
- data/doc/OBarc/Utils/Exceptions/TimeOutError.html +218 -0
- data/doc/OBarc/Utils/Helper.html +115 -0
- data/doc/OBarc/Utils/Helper/ObjectExtensions.html +105 -0
- data/doc/_index.html +239 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +229 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +229 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +465 -0
- data/doc/top-level-namespace.html +112 -0
- data/graphics/obarc-logo.png +0 -0
- data/graphics/obarc-logo.xcf +0 -0
- data/lib/obarc.rb +14 -0
- data/lib/obarc/api.rb +220 -0
- data/lib/obarc/session.rb +514 -0
- data/lib/obarc/utils/exceptions.rb +35 -0
- data/lib/obarc/utils/helper.rb +18 -0
- data/lib/obarc/version.rb +3 -0
- data/obarc.gemspec +32 -0
- metadata +276 -0
data/doc/file_list.html
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<title>File List</title>
|
|
19
|
+
<base id="base_target" target="_parent" />
|
|
20
|
+
</head>
|
|
21
|
+
<body>
|
|
22
|
+
<script type="text/javascript" charset="utf-8">
|
|
23
|
+
var hasFrames = false;
|
|
24
|
+
try {
|
|
25
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
26
|
+
} catch (e) { }
|
|
27
|
+
if (hasFrames) {
|
|
28
|
+
document.getElementById('base_target').target = 'main';
|
|
29
|
+
document.body.className = 'frames';
|
|
30
|
+
}
|
|
31
|
+
</script>
|
|
32
|
+
<div id="content">
|
|
33
|
+
<h1 id="full_list_header">File List</h1>
|
|
34
|
+
<div id="nav">
|
|
35
|
+
|
|
36
|
+
<span><a target="_self" href="class_list.html">
|
|
37
|
+
Classes
|
|
38
|
+
</a></span>
|
|
39
|
+
|
|
40
|
+
<span><a target="_self" href="method_list.html">
|
|
41
|
+
Methods
|
|
42
|
+
</a></span>
|
|
43
|
+
|
|
44
|
+
<span><a target="_self" href="file_list.html">
|
|
45
|
+
Files
|
|
46
|
+
</a></span>
|
|
47
|
+
|
|
48
|
+
</div>
|
|
49
|
+
<div id="search">Search: <input type="text" /></div>
|
|
50
|
+
|
|
51
|
+
<ul id="full_list" class="file">
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
<li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</ul>
|
|
58
|
+
</div>
|
|
59
|
+
</body>
|
|
60
|
+
</html>
|
data/doc/frames.html
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
|
3
|
+
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|
7
|
+
<title>Documentation by YARD 0.8.7.6</title>
|
|
8
|
+
</head>
|
|
9
|
+
<script type="text/javascript" charset="utf-8">
|
|
10
|
+
window.onload = function() {
|
|
11
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
|
12
|
+
var name = match ? match[1] : 'index.html';
|
|
13
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
|
14
|
+
document.writeln('<frameset cols="20%,*">' +
|
|
15
|
+
'<frame name="list" src="class_list.html" />' +
|
|
16
|
+
'<frame name="main" src="' + escape(name) + '" />' +
|
|
17
|
+
'</frameset>');
|
|
18
|
+
}
|
|
19
|
+
</script>
|
|
20
|
+
<noscript>
|
|
21
|
+
<frameset cols="20%,*">
|
|
22
|
+
<frame name="list" src="class_list.html" />
|
|
23
|
+
<frame name="main" src="index.html" />
|
|
24
|
+
</frameset>
|
|
25
|
+
</noscript>
|
|
26
|
+
</html>
|
data/doc/index.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
|
+
— 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> »
|
|
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'>'</span><span class='tstring_content'>obarc</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>obarc</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>username</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>password</span><span class='tstring_end'>'</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">{"profile":
|
|
106
|
+
{"website": "website",
|
|
107
|
+
"public_key": "b7d8f6ee04453e1babde87d12198ecd14be00aa998e85636767d8b00d2603e6d",
|
|
108
|
+
.
|
|
109
|
+
.
|
|
110
|
+
.
|
|
111
|
+
"primary_color": 16777215,
|
|
112
|
+
"background_color": 12832757,
|
|
113
|
+
"email": "email@bogus.com"}}</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'>'</span><span class='tstring_content'>big@vendor.com</span><span class='tstring_end'>'</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'>"</span><span class='tstring_content'>success</span><span class='label_end'>":</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'>"</span><span class='tstring_content'>peers</span><span class='label_end'>":</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>5.37.3.8</span><span class='tstring_end'>"</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'>"</span><span class='tstring_content'>num_peers</span><span class='label_end'>":</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
|
+
'iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAC91JREFUWAktl3mQHOV5xn99zH3u7K1d7Uq7CEkIpNVZRhagQDjKCcaxSIJNIJTjI5XCuakKceXyHy5XnJSr')
|
|
130
|
+
</code> <code>json {"image_hashes":
|
|
131
|
+
["a89810619833ef29d373c124ce05f362a313929e"],
|
|
132
|
+
"success": 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'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
139
|
+
<span class='label'>metadata_category:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>physical good</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
140
|
+
<span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Black Dress</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
141
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A pretty black dress.</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
142
|
+
<span class='label'>currency_code:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>USD</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
143
|
+
<span class='label'>price:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>19.95</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
144
|
+
<span class='label'>process_time:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>3 Business Days</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
145
|
+
<span class='label'>nsfw:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>false</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
146
|
+
<span class='label'>shipping_origin:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>UNITED_STATES</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
147
|
+
<span class='label'>ships_to:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>UNITED_STATES</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
148
|
+
<span class='label'>est_delivery_domestic:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>5-7 Business Days</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
149
|
+
<span class='label'>est_delivery_international:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
150
|
+
<span class='label'>terms_conditions:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>We cannot ship to PO Boxes/APO's\n * We cannot combine shipping.\n * No Local Pickup.</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
151
|
+
<span class='label'>returns:</span> <span class='tstring'><span class='tstring_beg'>"</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'>"</span></span><span class='comma'>,</span>
|
|
152
|
+
<span class='label'>shipping_currency_code:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>USD</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>dress</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
156
|
+
<span class='label'>category:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
157
|
+
<span class='label'>condition:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>New</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
158
|
+
<span class='label'>sku:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123456789</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
159
|
+
<span class='label'>image_urls:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://i.imgur.com/2KXXHSt.jpg</span><span class='tstring_end'>'</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'>"</span><span class='tstring_content'>success</span><span class='label_end'>":</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're using OBarc, I'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'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>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
function createSourceLinks() {
|
|
2
|
+
$('.method_details_list .source_code').
|
|
3
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
4
|
+
$('.toggleSource').toggle(function() {
|
|
5
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
6
|
+
$(this).text("Hide source");
|
|
7
|
+
},
|
|
8
|
+
function() {
|
|
9
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
10
|
+
$(this).text("View source");
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
function createDefineLinks() {
|
|
15
|
+
var tHeight = 0;
|
|
16
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
17
|
+
$('.toggleDefines').toggle(function() {
|
|
18
|
+
tHeight = $(this).parent().prev().height();
|
|
19
|
+
$(this).prev().show();
|
|
20
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
21
|
+
$(this).text("(less)");
|
|
22
|
+
},
|
|
23
|
+
function() {
|
|
24
|
+
$(this).prev().hide();
|
|
25
|
+
$(this).parent().prev().height(tHeight);
|
|
26
|
+
$(this).text("more...");
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function createFullTreeLinks() {
|
|
31
|
+
var tHeight = 0;
|
|
32
|
+
$('.inheritanceTree').toggle(function() {
|
|
33
|
+
tHeight = $(this).parent().prev().height();
|
|
34
|
+
$(this).parent().toggleClass('showAll');
|
|
35
|
+
$(this).text("(hide)");
|
|
36
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
37
|
+
},
|
|
38
|
+
function() {
|
|
39
|
+
$(this).parent().toggleClass('showAll');
|
|
40
|
+
$(this).parent().prev().height(tHeight);
|
|
41
|
+
$(this).text("show all");
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function fixBoxInfoHeights() {
|
|
46
|
+
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
|
47
|
+
$(this).prev().height($(this).height());
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameLinks() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
function toggleSearchFrame(id, link) {
|
|
59
|
+
var frame = $('#search_frame');
|
|
60
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
61
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
|
62
|
+
frame.slideUp(100);
|
|
63
|
+
$('#search a').removeClass('active inactive');
|
|
64
|
+
}
|
|
65
|
+
else {
|
|
66
|
+
$(id).addClass('active').removeClass('inactive');
|
|
67
|
+
frame.attr('src', link).slideDown(100);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
function linkSummaries() {
|
|
72
|
+
$('.summary_signature').click(function() {
|
|
73
|
+
document.location = $(this).find('a').attr('href');
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
function framesInit() {
|
|
78
|
+
if (hasFrames) {
|
|
79
|
+
document.body.className = 'frames';
|
|
80
|
+
$('#menu .noframes a').attr('href', document.location);
|
|
81
|
+
try {
|
|
82
|
+
window.top.document.title = $('html head title').text();
|
|
83
|
+
} catch(error) {
|
|
84
|
+
// some browsers will not allow this when serving from file://
|
|
85
|
+
// but we don't want to stop the world.
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
else {
|
|
89
|
+
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function keyboardShortcuts() {
|
|
94
|
+
if (window.top.frames.main) return;
|
|
95
|
+
$(document).keypress(function(evt) {
|
|
96
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
|
97
|
+
if (typeof evt.target !== "undefined" &&
|
|
98
|
+
(evt.target.nodeName == "INPUT" ||
|
|
99
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
|
100
|
+
switch (evt.charCode) {
|
|
101
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
|
102
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
|
103
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
|
104
|
+
default: break;
|
|
105
|
+
}
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
function summaryToggle() {
|
|
110
|
+
$('.summary_toggle').click(function() {
|
|
111
|
+
if (localStorage) {
|
|
112
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
113
|
+
}
|
|
114
|
+
$('.summary_toggle').each(function() {
|
|
115
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
116
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
117
|
+
if (next.hasClass('compact')) {
|
|
118
|
+
next.toggle();
|
|
119
|
+
next.nextAll('ul.summary').first().toggle();
|
|
120
|
+
}
|
|
121
|
+
else if (next.hasClass('summary')) {
|
|
122
|
+
var list = $('<ul class="summary compact" />');
|
|
123
|
+
list.html(next.html());
|
|
124
|
+
list.find('.summary_desc, .note').remove();
|
|
125
|
+
list.find('a').each(function() {
|
|
126
|
+
$(this).html($(this).find('strong').html());
|
|
127
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
128
|
+
});
|
|
129
|
+
next.before(list);
|
|
130
|
+
next.toggle();
|
|
131
|
+
}
|
|
132
|
+
});
|
|
133
|
+
return false;
|
|
134
|
+
});
|
|
135
|
+
if (localStorage) {
|
|
136
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
137
|
+
$('.summary_toggle').first().click();
|
|
138
|
+
}
|
|
139
|
+
else localStorage.summaryCollapsed = "expand";
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
function fixOutsideWorldLinks() {
|
|
144
|
+
$('a').each(function() {
|
|
145
|
+
if (window.location.host != this.host) this.target = '_parent';
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
function generateTOC() {
|
|
150
|
+
if ($('#filecontents').length === 0) return;
|
|
151
|
+
var _toc = $('<ol class="top"></ol>');
|
|
152
|
+
var show = false;
|
|
153
|
+
var toc = _toc;
|
|
154
|
+
var counter = 0;
|
|
155
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
156
|
+
var i;
|
|
157
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
158
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
159
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
160
|
+
$(tags.join(', ')).each(function() {
|
|
161
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
162
|
+
if (this.id == "filecontents") return;
|
|
163
|
+
show = true;
|
|
164
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
165
|
+
if (this.id.length === 0) {
|
|
166
|
+
var proposedId = $(this).attr('toc-id');
|
|
167
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
168
|
+
else {
|
|
169
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
170
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
171
|
+
this.id = proposedId;
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
if (thisTag > lastTag) {
|
|
175
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
176
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
if (thisTag < lastTag) {
|
|
180
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
181
|
+
}
|
|
182
|
+
var title = $(this).attr('toc-title');
|
|
183
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
184
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
185
|
+
lastTag = thisTag;
|
|
186
|
+
});
|
|
187
|
+
if (!show) return;
|
|
188
|
+
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
|
189
|
+
$('#content').prepend(html);
|
|
190
|
+
$('#toc').append(_toc);
|
|
191
|
+
$('#toc .hide_toc').toggle(function() {
|
|
192
|
+
$('#toc .top').slideUp('fast');
|
|
193
|
+
$('#toc').toggleClass('hidden');
|
|
194
|
+
$('#toc .title small').toggle();
|
|
195
|
+
}, function() {
|
|
196
|
+
$('#toc .top').slideDown('fast');
|
|
197
|
+
$('#toc').toggleClass('hidden');
|
|
198
|
+
$('#toc .title small').toggle();
|
|
199
|
+
});
|
|
200
|
+
$('#toc .float_toc').toggle(function() {
|
|
201
|
+
$(this).text('float');
|
|
202
|
+
$('#toc').toggleClass('nofloat');
|
|
203
|
+
}, function() {
|
|
204
|
+
$(this).text('left');
|
|
205
|
+
$('#toc').toggleClass('nofloat');
|
|
206
|
+
});
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
$(framesInit);
|
|
210
|
+
$(createSourceLinks);
|
|
211
|
+
$(createDefineLinks);
|
|
212
|
+
$(createFullTreeLinks);
|
|
213
|
+
$(fixBoxInfoHeights);
|
|
214
|
+
$(searchFrameLinks);
|
|
215
|
+
$(linkSummaries);
|
|
216
|
+
$(keyboardShortcuts);
|
|
217
|
+
$(summaryToggle);
|
|
218
|
+
$(fixOutsideWorldLinks);
|
|
219
|
+
$(generateTOC);
|