doc/file.README.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
File: README
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!file.README.html";
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><div id='filecontents'>
<h1 id="label-OpenBazaar+API+Ruby+Client"><a href="https://github.com/inertia186/obarc">OpenBazaar API Ruby Client</a></h1>
<p><a href="https://travis-ci.org/inertia186/obarc"><img
src="https://travis-ci.org/inertia186/obarc.svg?branch=master"></a> <a
href="https://codeclimate.com/github/inertia186/obarc"><img
src="https://codeclimate.com/github/inertia186/obarc/badges/gpa.svg"></a>
<a href="https://codeclimate.com/github/inertia186/obarc"><img
src="https://codeclimate.com/github/inertia186/obarc/badges/coverage.svg"></a></p>
<p>A simple OpenBazaar API client for Ruby.</p>
<h4 id="label-Fixes+in+0.5.2">Fixes in 0.5.2</h4>
<ul><li>
<p>Support for gem release.</p>
</li><li>
<p>Dependency refresh.</p>
</li><li>
<p>Deprecation removal.</p>
</li></ul>
<h3 id="label-Installation">Installation</h3>
<p>Add the gem to your Gemfile:</p>
<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>
</code></pre>
<p>Then:</p>
<pre class="code ruby"><code class="ruby">$ bundle install</code></pre>
<h3 id="label-Usage">Usage</h3>
<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>
<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>
<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>
</code></pre>
<pre class="code ruby"><code class="ruby">{"profile":
{"website": "website",
"public_key": "b7d8f6ee04453e1babde87d12198ecd14be00aa998e85636767d8b00d2603e6d",
.
.
.
"primary_color": 16777215,
"background_color": 12832757,
"email": "email@bogus.com"}}</code></pre>
<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>
</code></pre>
<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>
</code></pre>
<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>
</code></pre>
<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>
</code></pre>
<p>If you want to manually upload an image, this will return the image hash.
<code>ruby session.upload_image(image:
'iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAC91JREFUWAktl3mQHOV5xn99zH3u7K1d7Uq7CEkIpNVZRhagQDjKCcaxSIJNIJTjI5XCuakKceXyHy5XnJSr')
</code> <code>json {"image_hashes":
["a89810619833ef29d373c124ce05f362a313929e"],
"success": true} </code></p>
<p>You can also add a new listing with image URLs in the hash. The client will
upload them and save the image hashes to the contract.</p>
<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>
<span class='label'>expiration_date:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<span class='label'>shipping_domestic:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>shipping_international:</span> <span class='kw'>false</span><span class='comma'>,</span>
<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>
<span class='label'>category:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
<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>
<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>
<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>
<span class='label'>free_shipping:</span> <span class='kw'>true</span>
<span class='rparen'>)</span>
</code></pre>
<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>
</code></pre>
<h2 id="label-Tests">Tests</h2>
<ul><li>
<p>Clone the client repository into a directory of your choice:</p>
</li><li>
<p><code>git clone https://github.com/inertia186/obarc.git</code></p>
</li><li>
<p>Navigate into the new folder</p>
</li><li>
<p><code>cd obarc</code></p>
</li><li>
<p>Basic tests can be invoked as follows:</p>
</li><li>
<p><code>rake</code></p>
</li><li>
<p>To run tests with parallelization and local code coverage:</p>
</li><li>
<p><code>HELL_ENABLED=true rake</code></p>
</li><li>
<p>To run tests against a testnet server:</p>
</li><li>
<p><code>TEST_NET=true OB_SERVER_HOST=localhost OB_USERNAME=username
OB_PASSWORD=password rake</code></p>
</li></ul>
<h2 id="label-Docmentation">Docmentation</h2>
<ul><li>
<p><a
href="http://www.rubydoc.info/github/inertia186/obarc/master/OBarc/Session">Session</a>
- Most of what you need in your app is explained here.</p>
</li></ul>
<h2 id="label-Requirements">Requirements</h2>
<ul><li>
<p><code>ruby 2.1.5</code></p>
</li><li>
<p><code>bundler 1.11</code></p>
</li><li>
<p><code>OpenBazaar-Server 1.1.15</code></p>
</li></ul>
<h2 id="label-Get+in+touch-21">Get in touch!</h2>
<p>If you're using OBarc, I'd love to hear from you. Drop me a line
and tell me what you think!</p>
<center>
<img src="https://cl.ly/233t0q0v2j0p/obarc-logo.png" />
</center>
<h2 id="label-Licence">Licence</h2>
<p>I don't believe in intellectual “property”. If you do, consider OBarc
as licensed under a Creative Commons <a
href="http://creativecommons.org/publicdomain/zero/1.0/"><img
src="http://i.creativecommons.org/p/zero/1.0/80x15.png"></a> License.</p>
</div></div>
<div id="footer">
Generated on Tue Apr 4 17:29:29 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.5).
</div>
</body>
</html>