RubyGems - obarc - Versions diffs - 0.5.2 - Mend

obarc 0.5.2

Files changed (49) hide show

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

@@ -0,0 +1,112 @@
+<!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>
+  Top Level Namespace
+    &mdash; 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#!top-level-namespace.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> &raquo;
+    <span class="title">Top Level Namespace</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"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="OBarc.html" title="OBarc (module)">OBarc</a></span>
+</p>
+</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>

data/graphics/obarc-logo.png ADDED

Binary file

data/graphics/obarc-logo.xcf ADDED

Binary file

data/lib/obarc.rb ADDED

@@ -0,0 +1,14 @@
+require 'obarc/version'
+require 'json'
+require 'rest-client'
+module OBarc
+  require 'obarc/utils/helper'
+  require 'obarc/session'
+  extend self
+  def login!(options)
+    options[:base_url] ||= "#{options[:protocol]}://#{options[:server_host]}:#{options[:server_port]}/api/#{options[:api_version]}"
+    Session.new(username: options[:username], password: options[:password], cookies: Api.post_login(options).cookies)
+  end
+end

data/lib/obarc/api.rb ADDED

@@ -0,0 +1,220 @@
+require 'obarc/utils/helper'
+require 'obarc/utils/exceptions'
+require 'uri'
+require 'base64'
+module OBarc
+  module Api
+    extend self
+    using Utils::Helper::ObjectExtensions
+    DEFAULT_TIMEOUT = 60 * 60 * 1
+    VALID_ACTIONS = {
+      get: %i(image profile listings followers following contracts shutdown
+        settings connected_peers routing_table notifications chat_messages
+        chat_conversations sales purchases order cases order_messages ratings
+        btc_price),
+      post: %i(login follow unfollow profile social_accounts
+        contract make_moderator unmake_moderator purchase_contract
+        confirm_order upload_image complete_order settings
+        mark_notification_as_read broadcast mark_chat_message_as_read
+        check_for_payment dispute_contract close_dispute release_funds refund
+        mark_discussion_as_read),
+      delete: %i(social_accounts contract chat_conversation)
+    }.freeze
+    # POST api/v1/login
+    def post_login(options = {})
+      url = "#{build_base_url(options)}/login"
+      auth = build_authentication(options)
+      raise Utils::Exceptions::MissingArgumentError, [:username, :password] if auth.empty?
+      execute method: :post, url: url, headers: {params: auth},
+        verify_ssl: build_verify_ssl(options)
+    end
+    def ping(options = {})
+      execute(method: :get,
+        url: "#{build_base_url(options)}/connected_peers?_=#{Time.now.to_i}",
+        headers: build_headers(options), verify_ssl: build_verify_ssl(options))
+    end
+    def respond_to_missing?(m, include_private = false)
+      verb = m.to_s.split('_')
+      rest_method = verb[0].to_sym
+      return false unless VALID_ACTIONS.keys.include?(rest_method)
+      endpoint = verb[1..-1].join('_')
+      return false if endpoint.nil?
+      VALID_ACTIONS[rest_method].include?(endpoint.to_sym)
+    end
+    def method_missing(m, *args, &block)
+      super unless respond_to_missing?(m)
+      # Many of the calls to restapi.py are uniform enough for DRY code, but the
+      # ones that aren't are mapped here.
+      rest_method, endpoint, params, options = case m
+      when :get_image then [:get, 'get_image', args[0], args[1]]
+      when :get_listings then [:get, 'get_listings', args[0], args[1]]
+      when :get_followers then [:get, 'get_followers', args[0], args[1]]
+      when :get_following then [:get, 'get_following', args[0], args[1]]
+      when :post_contract then [:post, 'contracts', args[0], args[1]]
+      when :delete_contract then [:delete, 'contracts', args[0], args[1]]
+      when :get_notifications then [:get, 'get_notifications', nil, args[0]]
+      when :get_chat_conversations then [:get, 'get_chat_conversations', nil, args[0]]
+      when :get_sales then [:get, 'get_sales', nil, args[0]]
+      when :get_purchases then [:get, 'get_purchases', nil, args[0]]
+      when :get_cases then [:get, 'get_cases', nil, args[0]]
+      when :get_ratings then [:get, 'get_ratings', args[0], args[1]]
+      else
+        verb = m.to_s.split('_')
+        a = [verb[0].to_sym, verb[1..-1].join('_')]
+        a << if args.size == 1
+          nil
+        else
+          args[0]
+        end
+        a << args[args.size - 1]
+      end
+      url = "#{build_base_url(options)}/#{endpoint}" if !!endpoint && !!options
+      if !!rest_method && !!url && !!options
+        headers = build_headers(options)
+        headers = headers.merge(params: params.compact) if !!params
+        return execute method: rest_method, url: url, headers: headers,
+          verify_ssl: build_verify_ssl(options)
+      end
+      raise Utils::Exceptions::OBarcError, "Did not handle #{m} as expected, arguments: #{args}"
+    end
+    # POST api/v1/upload_image
+    def post_upload_image(options = {})
+      elements = [:image, :avatar, :header]
+      params = options.slice(*elements)
+      options = options.delete_if { |k, v| elements.include? k }
+      url = "#{build_base_url(options)}/upload_images"
+      execute method: :post, url: url,
+        headers: build_headers(options).merge(params: params.compact),
+        verify_ssl: build_verify_ssl(options)
+    end
+    # GET api/v1/contracts
+    def get_contracts(contracts, options = {})
+      id = contracts[:id]
+      guid = contracts[:guid]
+      if !!id && id.size != 40
+        raise Utils::Exceptions::InvalidArgumentError, id: "must be 40 characters, if present (was: #{id.size})"
+      elsif !!guid && guid.size != 40
+        raise Utils::Exceptions::InvalidArgumentError, guid: "must be 40 characters, if present (was: #{guid.size})"
+      end
+      url = "#{build_base_url(options)}/contracts"
+      execute method: :get, url: url,
+        headers: build_headers(options).merge(params: contracts.compact),
+        verify_ssl: build_verify_ssl(options)
+    end
+    # GET api/v1/get_chat_messages
+    def get_chat_messages(chat_messages, options = {})
+      guid = chat_messages[:guid]
+      if guid.nil? || guid.size != 40
+        raise Utils::Exceptions::InvalidArgumentError, guid: "must be present, 40 characters (was: #{guid.inspect})"
+      end
+      url = "#{build_base_url(options)}/get_chat_messages"
+      execute method: :get, url: url,
+        headers: build_headers(options).merge(params: chat_messages.compact),
+        verify_ssl: build_verify_ssl(options)
+    end
+    # GET api/v1/get_order
+    def get_order(order, options = {})
+      order_id = order[:order_id]
+      if order_id.nil?
+        raise Utils::Exceptions::InvalidArgumentError, order_id: 'must be present'
+      end
+      url = "#{build_base_url(options)}/get_order"
+      execute method: :get, url: url,
+        headers: build_headers(options).merge(params: order.compact),
+        verify_ssl: build_verify_ssl(options)
+    end
+  private
+    def execute(options = {})
+      if options[:method] == :post
+        options[:headers][:content_type] = 'application/x-www-form-urlencoded'
+      end
+      if !!options[:headers][:params]
+        params = options[:headers].delete(:params)
+        if params.values.map(&:class).include? Array
+          # Dropping to a lower level for parameters since they're more
+          # complicated due to the presense of an Array.  Note that these
+          # parameters go # outside the header.
+          options[:url] += "?#{URI::encode_www_form params}"
+        elsif params.values.map(&:class).any? { |c| [Tempfile, File, StringIO].include?(c) }
+          # Handling (possibly) large files.
+          options[:payload] = {multipart: true}
+          params.each do |k, v|
+            if v.respond_to? :read
+              options[:payload][k] = Base64.strict_encode64(v.read)
+            else
+              options[:payload][k] = v
+              # FIXME Might want to warn that we are possibly mixing multipart
+              # with simple payload.
+            end
+          end
+        else
+          options[:headers][:params] = params
+        end
+      end
+      RestClient::Request.execute(options.merge(timeout: DEFAULT_TIMEOUT))
+    end
+    def build_authentication(options = {})
+      if options.kind_of? Session
+        {username: options.username, password: options.password}
+      else
+        options.slice(:username, :password)
+      end.compact
+    end
+    def build_base_url(options = {})
+      if options.kind_of? Session
+        options.base_url
+      elsif options.kind_of? Hash
+        options[:base_url]
+      else
+        raise Utils::Exceptions::OBarcError, "Unable to build base URL using: #{options.inspect}, expected a OBarc::Session or Hash."
+      end
+    end
+    def build_headers(options = {})
+      if options.kind_of? Session
+        {cookies: options.cookies}
+      else
+        options.slice(:cookies)
+      end
+    end
+    def build_verify_ssl(options = {})
+      if options.kind_of? Session
+        !!options.verify_ssl
+      else
+        !!options[:verify_ssl]
+      end
+    end
+  end
+end

data/lib/obarc/session.rb ADDED

@@ -0,0 +1,514 @@
+require 'obarc/api'
+require 'open-uri'
+require 'logging'
+module OBarc
+  class Session
+    OPTIONS_KEYS = %i(protocol server_host server_port api_version username
+      password base_url logger cookies verify_ssl)
+    attr_accessor :cookies, :username, :password, :verify_ssl
+    attr_writer :base_url, :logger
+    DEFAULT_OPTIONS = {
+      protocol: 'http',
+      server_host: 'localhost',
+      server_port: '18469',
+      api_version: 'v1',
+      verify_ssl: true
+    }
+    def initialize(options = {})
+      OPTIONS_KEYS.each do |k|
+        value = if options.key?(k)
+          options[k]
+        else
+          DEFAULT_OPTIONS[k]
+        end
+        instance_variable_set "@#{k}".to_sym, value
+      end
+      @base_url ||= base_url
+      @logger ||= logger
+      @cookies ||= Api::post_login(self).cookies
+    end
+    def base_url
+      @base_url ||= "#{@protocol}://#{@server_host}:#{@server_port}/api/#{@api_version}"
+    end
+    def logger
+      @logger ||= Logging.logger(STDOUT)
+    end
+    # Check if there's a valid session.
+    #
+    # @return [Boolean] True if the session is valid.
+    def ping
+      return false if !(json = Api::ping(self))
+      !!JSON[json]['num_peers']
+    rescue RestClient::Unauthorized => e
+      logger.warn(e)
+      false
+    end
+    # Returns the image for the hash specified.
+    # @param image [Hash] containing the hash: of the target image, required
+    # @return [Object] The image will be returned in .jpg format.
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-image
+    def image(image); Api::get_image(image, self); end
+    # Returns the profile data of the user’s node, or that of a target node.
+    #
+    # @param profile [Hash] containing the guid: of the target node, optional
+    #   * The global unique identifier (guid; 40 character hex string) of the node to get the profile data from
+    #   * If the guid is omitted, your own node’s profile will be returned
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-profile
+    def profile(profile = nil); JSON[Api::get_profile(profile, self)]; end
+    # Returns just the profile's social accounts of the user’s node, or that of a target node.
+    #
+    # @param profile [Hash] containing the guid: of the target node, optional
+    #   * The global unique identifier (guid; 40 character hex string) of the node to get the profile data from
+    #   * If the guid is omitted, your own node’s social accounts will be returned
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-profile
+    def social_accounts(profile = nil)
+      result = JSON[Api::get_profile(profile, self)]
+      if !!result && !!result['profile'] && !!result['profile']['social_accounts']
+        result['profile']['social_accounts']
+      else
+        []
+      end
+    end
+    # Returns the listings of the user’s node, or that of a target node.
+    #
+    # @param listings [Hash] containing the guid: of the target node, optional
+    #   * If the guid is omitted, the server will look for listings in your own node’s database.
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-get_listings
+    def listings(listings = nil); JSON[Api::get_listings(listings, self)]; end
+    # Finds the listings of the user’s node, or that of a target node.
+    #
+    # @param options [Hash] containing:
+    #     * guid: of the target node, optional
+    #         *If the guid is omitted, the server will look for listings in your own node’s database.
+    #     * pattern: [Regex] search phrase
+    # @return [Hash]
+    def query_listings(options = {})
+      pattern = options.delete(:pattern)
+      all_listings = JSON[Api::get_listings(options, self)]
+      listings = all_listings['listings']
+      if !!pattern
+        listings = listings.select do |l|
+          [l['contract_hash'], l['category'], l['title'],
+            l['price'].to_s, l['origin'], l['currency_code'],
+            l['ships_to'].join].join(' ') =~ pattern
+        end
+      end
+      return {'listings' => listings} if listings === all_listings
+      start = Time.now.to_i
+      @cache_timestamp = if (start - (@cache_timestamp ||= 0)) > 300
+        @contracts_cache = {}
+        start
+      else
+        @cache_timestamp
+      end
+      @contracts_cache ||= {}
+      (all_listings['listings'] - listings).each do |listing|
+        contract_hash = listing['contract_hash']
+        contract = @contracts_cache[contract_hash] ||= contracts(options.merge(id: listing['contract_hash']))
+        next unless !!contract
+        l = contract['vendor_offer']['listing']
+        if [l['metadata']['expiry'], l['item']['category'], l['item']['sku'],
+          l['item']['description'], l['item']['process_time'],
+          l['item']['keywords'].join].join(' ') =~ pattern
+          listings << listing && next
+        end
+      end
+      {'listings' => listings}
+    end
+    # Returns the followers of the user’s node, or that of a target node.
+    #
+    # @param followers [Hash] containing the guid: of the target node, optional
+    #   * If the guid is omitted, the server will look for followers in your own node’s database.
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-get_followers
+    def followers(followers = nil); JSON[Api::get_followers(followers, self)]; end
+    # Returns the following of the user’s node, or that of a target node.
+    #
+    # @param following [Hash] containing the guid: of the target node, optional
+    #   * If the guid is omitted, the server will look for following in your own node’s database.
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-get_following
+    def following(following = nil); JSON[Api::get_following(following, self)]; end
+    # Follows a target node and will cause you to receive notifications from
+    # that node after certain event (e.g. new listing, broadcast messages) and
+    # share some metadata (in future).
+    #
+    # @param follow [Hash] containing the guid: of the target node, required
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-follow
+    def follow(follow); JSON[Api::post_follow(follow, self)]; end
+    # Stop following a target node, will cease to receive notifications and
+    # sharing metadata.
+    #
+    # @param unfollow [Hash] containing the guid: of the target node, required
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-unfollow
+    def unfollow(unfollow); JSON[Api::post_unfollow(unfollow, self)]; end
+    # Add data related to the node's profile into the database, which will be
+    # visible to other nodes.
+    #
+    # @param profile [Hash]
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-profile
+    def update_profile(profile = {}); JSON[Api::post_profile(profile, self)]; end
+    # Adds a social account to the user profile data of the user.
+    #
+    # @param social_account [Hash] e.g.: account_type: 'TWITTER', username: '@inertia186'
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-social_accounts
+    def add_social_account(social_account = {}); JSON[Api::post_social_accounts(social_account, self)]; end
+    # Undocumented.
+    #
+    # @return [Hash]
+    def delete_social_account(social_account = {}); JSON[Api::delete_social_accounts(social_account, self)]; end
+    # Retrieves the listings created by either your node or a target node.
+    #
+    # @param contracts [Hash] containing the:
+    #   * id: Unique identifier of the contract SHA256 of the JSON formatted contract (40 character hex string), required
+    #   * guid: GUID of the node if the call is made to a target node.  If omitted, the API will search for a contract ID created by your own node
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-contracts
+    def contracts(contracts = {}); JSON[Api::get_contracts(contracts, self)]; end
+    # Creates a listing contract, which is saved to the database and local file
+    # system, as well as publish the keywords in the distributed hash table.
+    #
+    # @param contract [Hash] containing:
+    #    * expiration_date: [UTC] Formatted string.  The date the contract should expire in string formatted UTC datetime.  Example:
+    #        * "2015-11-01T00:00 UTC"
+    #        * "" if the contract never expires
+    #    * metadata_category: [category] Formatted string.  Select from:
+    #        * physical good
+    #        * digital good
+    #        * service
+    #    * title: [title text] String.  Title of the product for sale
+    #    * description: [description text] String.  Description of the item, content or service
+    #    * currency_code: [code] Formatted string.  The currency the product is priced in. may either be “btc” or a currency from this list
+    #    * price: [value] String.  The price per unit in the same currency as currency_code.
+    #    * process_time: [time] String.  The time it will take to prepare the item for shipping
+    #    * nsfw: [true/false] Boolean.  Is the item not suitable for work (i.e. 18+)
+    #    * shipping_origin: [country/region] Formatted string.  Required and only applicable if the metadata_category is a physical good
+    #        * Where the item ships from
+    #        * Must be a formatted string from this list
+    #    * shipping_regions: [locations] Formatted string.  Required and only applicable if the metadata_category is a physical good.
+    #        * A list of countries/regions where the product will ship to
+    #        * Each item in the list must be formatted from this list
+    #    * est_delivery_domestic: [time] Estimated delivery time for domestic shipments
+    #    * est_delivery_international: [time] String.  Estimated delivery time for international shipments.
+    #    * terms_conditions: [terms and conditions text] String.  Any terms or conditions the user wishes to include.
+    #    * returns: [returns policy text] String.  Return policy.
+    #    * shipping_currency_code: [currency code] Formatted string.  The currency code used to price shipping. may either be “btc” or a currency from this list.
+    #    * shipping_domestic: [price] String.  The price of domestic shipping in the selected currency code.
+    #    * shipping_international: [price] String.  The price of nternational shipping in the selected currency code.
+    #    * keywords: [keyword text] String.  A list of string search terms for the listing.  Must be fewer than 10.
+    #    * category: [category text] Sting.  A user-generated category for this product.  Will show in store’s category list.
+    #    * condition: [condition text] The condition of the product
+    #    * sku: [sku text] String.  Stock keeping unit (sku) for the listing.
+    #    * images: [String, Array<String>] 40 character hex string.  A list of SHA256 image hashes.  The images should be uploaded using the upload_image api call.
+    #        * images: '04192728d0fd8dfe6663f429a5c03a7faf907930'
+    #        * images: ['04192728d0fd8dfe6663f429a5c03a7faf907930', '0dee4786fd02d6bc673b50309a3c831acf78ec70']
+    #    * image_urls: [Array<String>] An array of image URLs for OBarc to first download then automatically store to this record.
+    #        * image_urls: 'http://i.imgur.com/YHBh57j.gif'
+    #        * image_urls: ['http://i.imgur.com/uC2KUQ6.png', 'http://i.imgur.com/RliU8Gn.jpg']
+    #    * image_data: [Array<String>] An array of Base64 images for OBarc to automatically store to this record.
+    #        * image_data: <String>
+    #        * image_data: [<String>, <String>]
+    #    * free_shipping: [boolean] "true" or "false"
+    #    * moderators: [guids] GUID: 40 character hex string.  A list of moderator GUIDs that the vendor wishes to use
+    #        * Note: the moderator must have been previously returned by the get_moderators websocket call.
+    #        * Given the UI workflow, this call should always be made before the contract is set.
+    #    * options: [options text] String.  A list of options for the product.  Example: “size”, “color”
+    #        * option: [option text] String.
+    #            * For each option in the options list, another argument should be added using that option name and a list of value
+    #            * For example, given “color” in the options list, choose from "red", "green", "purple" etc
+    # @return [Hash] containing: "success" => true or false, "id" => Integer
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-contracts
+    def create_contract(contract = {})
+      # Note, passing contract_id appears to create a clone that re-uses the
+      # original contract_id.
+      %i(image_urls image_data).each do |symbol|
+        upload_contract_images_with(symbol, contract) if !!contract[symbol]
+      end
+      JSON[Api::post_contract(contract, self)]
+    end
+    def upload_contract_images_with(symbol, contract = {})
+      contract[:images] = [contract.delete(symbol)].flatten.map do |image|
+        response = if image.size < 2000 && image =~ URI::ABS_URI
+          upload_image(image: open(image, 'rb'))
+        else
+          upload_image(image: image)
+        end
+        response['image_hashes'] if response['success']
+      end.flatten
+    end
+    # Undocumented.
+    #
+    # @return [Hash]
+    def delete_contract(contract = {}); JSON[Api::delete_contract(contract, self)]; end
+    # Sets your node as a Moderator, which is discoverable on the network.
+    #
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-make_moderator
+    def make_moderator; JSON[Api::post_make_moderator(self)]; end
+    # Removes the node as a Moderator and is no longer discoverable on the
+    # network as a Moderator.
+    #
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post--unmake_moderator
+    def unmake_moderator; JSON[Api::post_unmake_moderator(self)]; end
+    # Purchases a contract by sending the purchase into the Vendor. The Buyer
+    # waits for a response to indicate whether the purchase is successful or
+    # not. If successful, the Buyer needs to fund the direct or multisig
+    # address.
+    #
+    # @param purchase_contract [Hash]
+    # @return [Hash] containing:
+    #   * "success" => true or false
+    #   * "address" => "bitcoin address to fund"
+    #   * "amount" => "amount to fund"
+    #   * "order_id" => "purchase order id"
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-purchase_contract
+    def purchase_contract(purchase_contract = {}); JSON[Api::post_purchase_contract(purchase_contract, self)]; end
+    # Sends the order confirmation and shipping information to the Buyer. If
+    # he’s offline, it will embed this data into the dht. The API call also
+    # updates the status of the order in the database.
+    #
+    # @param confirm_order [Hash]
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-confirm_order
+    def confirm_order(confirm_order = {}); JSON[Api::post_confirm_order(confirm_order, self)]; end
+    # Saves the image in the file system and a pointer to it in the db.
+    #
+    # @param image [Hash] containing:
+    #     * image: a list of product images to upload (LIST of images in base64. data only, no base64 prefix)
+    #     * avatar: use this if uploading an avatar image (base64 image)
+    #     * header: use this if uploading a header image (base64 image)
+    # @return [Hash] containing:
+    #    * "success" => true or false
+    #    * "image_hashes" => [list_of_image_hashes]
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-upload_image
+    def upload_image(image = {}); JSON[Api::post_upload_image(image.merge(cookies: cookies, base_url: base_url, verify_ssl: verify_ssl))]; end
+    # Sends a message with a partially signed transaction releasing funds from
+    # escrow to the Vendor as well as review data.
+    #
+    # @param complete_order [Hash]
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-complete_order
+    def complete_order(complete_order = {}); JSON[Api::post_complete_order(complete_order, self)]; end
+    # Changes the settings of the node and pushes them to the database.
+    #
+    # @param settings [Hash]
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-settings
+    def update_settings(settings = {}); JSON[Api::post_settings(settings, self)]; end
+    # Returns the settings of your node.
+    #
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-settings
+    def settings; JSON[Api::get_settings(self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def connected_peers; JSON[Api::get_connected_peers(self)]; end
+    # Retreive a history of all notifications your node has received. Notifications can be sent due to:
+    # * A node following you
+    # * Events related to a purchase or sale
+    #
+    # @param FIXME not yet supported, future: limit-[number of most recent notifications]
+    #   * Default is unlimited
+    #   * Counts from most recent
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-notifications
+    def notifications; JSON[Api::get_notifications(self)]; end
+    # Retrieves all chat message received from other nodes.
+    #
+    # @param chat_messages [Hash] containing:
+    #   * guid [String] target node, required
+    #   * limit [Integer] max number of chat messages to return (ignored)
+    #   * start [FIXME] the starting point in the message list
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-get_chat_messages
+    def chat_messages(chat_messages = {}); JSON[Api::get_chat_messages(chat_messages, self)]; end
+    # Retreives a list of outstandng conversations.
+    #
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-get_chat_conversations
+    def chat_conversations; JSON[Api::get_chat_conversations(self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def delete_chat_conversation(delete_chat_conversation); JSON[Api::delete_chat_conversation(delete_chat_conversation, self)]; end
+    # Retrieves any sales made by the node.
+    #
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-get_sales
+    def sales; JSON[Api::get_sales(self)]; end
+    # Retrieves any purchases made by the node.
+    #
+    # @return [Hash]
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-get_purchases
+    def purchases; JSON[Api::get_purchases(self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def order(order); JSON[Api::get_order(order, self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def cases; JSON[Api::get_cases(self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def order_messages(order_messages); JSON[Api::get_order_messages(order_messages, self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def ratings(ratings); JSON[Api::get_ratings(ratings, self)]; end
+    # Marks a notification as read in the database.
+    #
+    # @param notification [Hash] containing id:
+    #     * 40 character hex string
+    #     * Every notification has an ID that must be referenced in order to mark as read
+    # @return [Hash] containing: "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-mark_notification_as_read
+    def mark_notification_as_read(notification = nil); JSON[Api::post_mark_notification_as_read(notification, self)]; end
+    # Sends some kind of "Twitter-like" message to all nodes that are following
+    # you.  This call can take a while to complete.
+    #
+    # @return [Hash] containing:
+    #    * "success" => true or false
+    #    * "peers_reached" => [number reached]
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-broadcast
+    def broadcast(message = {}); JSON[Api::post_broadcast(message, self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def btc_price; JSON[Api::get_btc_price(self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def routing_table; JSON[Api::get_routing_table(self)]; end
+    # Marks all chat messages with a specific node as read in the database.
+    #
+    # @param chat_message_as_read [Hash] containing:
+    #   * guid [String] GUID of the party you are chatting with
+    # @return [Hash] containing:
+    #    * "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-mark_chat_message_as_read
+    def mark_chat_message_as_read(mark_chat_message_as_read = nil); JSON[Api::post_mark_chat_message_as_read(mark_chat_message_as_read, self)]; end
+    # Sends a Twitter-like message to all nodes that are following you.
+    #
+    # @param check_for_payment [Hash] containing:
+    #   * order_id [Integer]
+    # @return [Hash] containing:
+    #    * "success" => true or false
+    # @see https://gist.github.com/drwasho/bd4b28a5a07c5a952e2f#post-check_for_payment
+    def check_for_payment(check_for_payment); JSON[Api::post_check_for_payment(check_for_payment, self)]; end
+    # Undocumented
+    #
+    # @param dispute_contract [Hash] containing:
+    #   * order_id [Integer]
+    # @return [Hash]
+    def dispute_contract(dispute_contract = nil); JSON[Api::post_dispute_contract(dispute_contract, self)]; end
+    # Undocumented
+    #
+    # @param dispute_contract [Hash] containing:
+    #   * order_id [Integer]
+    #   * resolution [String]
+    #   * buyer_percentage [Float]
+    #   * vendor_percentage [Float]
+    #   * moderator_percentage [Float]
+    #   * moderator_address [String]
+    # @return [Hash]
+    def close_dispute(close_dispute = nil); JSON[Api::post_close_dispute(close_dispute, self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def release_funds(release_funds = nil); JSON[Api::post_release_funds(release_funds, self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def refund(refund = nil); JSON[Api::post_refund(refund, self)]; end
+    # Undocumented
+    #
+    # @return [Hash]
+    def mark_discussion_as_read(mark_discussion_as_read = nil); JSON[Api::post_mark_discussion_as_read(mark_discussion_as_read, self)]; end
+    # API call to cleanly disconnect from connected nodes and shutsdown the OpenBazaar server component.
+    #
+    # @return nil
+    # @see https://gist.github.com/drwasho/742505589f62f6aa98b4#get-shutdown
+    def shutdown!
+      Api::get_shutdown(self)
+    end
+  end
+end