ripple-rest 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Yeechan Lu
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ripple-rest.rb

@@ -0,0 +1,72 @@
+module RippleRest; end
+  
+require 'json'
+require 'cgi'
+require 'bigdecimal'
+require 'autoparse'
+require 'rest-client'
+require 'ripple-rest/version'
+require 'ripple-rest/errors'
+require 'ripple-rest/schemas/json'
+require 'ripple-rest/schemas/account'
+require 'ripple-rest/schemas/account_settings'
+require 'ripple-rest/schemas/trustlines'
+require 'ripple-rest/schemas/balance'
+require 'ripple-rest/schemas/notifications'
+require 'ripple-rest/schemas/order'
+require 'ripple-rest/schemas/amount'
+require 'ripple-rest/schemas/payments'
+
+class << RippleRest
+  def setup endpoint
+    @endpoint = endpoint.gsub %r|/$|, ""
+  end
+  
+  def get uri, args = {}
+    wrap_error { RestClient.get "#{@endpoint}/#{uri}", args }
+  end
+  
+  def post uri, args = {}
+    wrap_error { RestClient.post "#{@endpoint}/#{uri}", args, :content_type => :json }
+  end
+  
+  def wrap_error
+    unless @endpoint
+      raise ArgumentError.new "You have to setup RippleRest first."
+    end
+    
+    begin
+      response = yield
+    rescue => e
+      response = e.response if e.respond_to? :response
+    end
+    
+    json = JSON.parse response.to_str rescue nil
+    if json
+      raise RippleRest::RippleRestError.new(json["message"], json) unless json["success"]
+    end
+  
+    if !response || response.code != 200
+      raise RippleRest::ProtocolError.new "Protocol is wrong or network is down", response
+    end
+    
+    json || response.to_str
+  end
+  
+  def get_transaction hash
+    get("v1/transactions/#{hash}")["transaction"]
+  end
+  
+  def server_connected?
+    get("v1/server/connected")["connected"]
+  end
+  
+  def server_info
+    get("v1/server")
+  end
+  
+  def next_uuid
+    get("v1/uuid")["uuid"]
+  end
+end
+  

data/lib/ripple-rest/errors.rb

@@ -0,0 +1,17 @@
+module RippleRest
+  class ProtocolError < RuntimeError
+    attr_accessor :response
+    def initialize message, response
+      super message
+      @response = response
+    end
+  end
+  
+  class RippleRestError < RuntimeError
+    attr_accessor :response
+    def initialize message, response
+      super message
+      @response = response
+    end
+  end
+end

data/lib/ripple-rest/schemas/account.rb

@@ -0,0 +1,57 @@
+module RippleRest
+  class Account
+    attr_accessor :address
+    attr_accessor :secret
+    
+    def initialize address, secret = nil
+      @address = address
+      @secret = secret
+    end
+    
+    def balances
+      RippleRest
+        .get("v1/accounts/#{@address}/balances")["balances"]
+        .map(&Balance.method(:new))
+    end
+    
+    def trustlines
+      data = RippleRest
+        .get("v1/accounts/#{@address}/trustlines")["trustlines"]
+        .map(&Trustline.method(:new))
+      obj = Trustlines.new data
+      obj.account = self
+      obj
+    end
+    
+    def settings
+      data = RippleRest.get("v1/accounts/#{@address}/settings")["settings"]
+      obj = AccountSettings.new data
+      obj.account = self
+      obj
+    end
+    
+    def notifications
+      @notifications ||= lambda {
+        obj = Notifications.new
+        obj.account = self
+        obj
+      }.call
+    end
+      
+    def require_secret
+      raise ArgumentError.new("Secret is required for this operation.") unless secret
+    end
+    
+    def payments
+      payments ||= lambda {
+        obj = Payments.new
+        obj.account = self
+        obj
+      }.call
+    end
+    
+    def to_s
+      address
+    end
+  end
+end

data/lib/ripple-rest/schemas/account_settings.rb

@@ -0,0 +1,18 @@
+module RippleRest
+  generate_schema :AccountSettings
+  
+  class AccountSettings
+    attr_accessor :account
+    
+    def save
+      raise ArgumentError.new("Account is missing.") unless account
+      
+      account.require_secret
+      
+      hash = to_hash
+      hash["secret"] = account.secret
+      
+      RippleRest.post "v1/accounts/#{account.address}/settings", hash
+    end
+  end
+end

data/lib/ripple-rest/schemas/amount.rb

@@ -0,0 +1,20 @@
+module RippleRest
+  generate_schema :Amount
+
+  class Amount
+    def to_s
+      "#{value}+#{currency}#{issuer.to_s.size > 0 ? ("+" + issuer) : ""}"
+    end
+    
+    def self.from_string s
+      return s if s.is_a?(Amount)
+      
+      arr = s.split("+")
+      Amount.new({
+        "value" => arr[0],
+        "currency" => arr[1],
+        "issuer" => arr[2]
+      })
+    end
+  end
+end

data/lib/ripple-rest/schemas/balance.rb

@@ -0,0 +1,9 @@
+module RippleRest
+  generate_schema :Balance
+
+  class Balance
+    def inspect
+      "#{value.to_s} #{currency}#{counterparty.to_s.size > 0 ? " (#{counterparty})" : ""}"
+    end
+  end
+end

data/lib/ripple-rest/schemas/json.rb

@@ -0,0 +1,17 @@
+module RippleRest
+  SCHEMA_ROOT = File.join(File.dirname(__FILE__), "json")
+  
+  def self.generate_schema(fn)
+    RippleRest.const_set fn, AutoParse.generate(JSON.parse(File.read(File.join(SCHEMA_ROOT, "#{fn}.json"))), :uri => "#{fn}")
+  end
+  
+  generate_schema :Currency
+  generate_schema :FloatString
+  generate_schema :Hash128
+  generate_schema :Hash256
+  generate_schema :ResourceId
+  generate_schema :RippleAddress
+  generate_schema :Timestamp
+  generate_schema :UINT32
+  generate_schema :URL
+end

data/lib/ripple-rest/schemas/json/AccountSettings.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "AccountSettings",
+  "description": "An object ",
+  "type": "object",
+  "properties": {
+    "account": {
+      "description": "The Ripple address of the account in question",
+      "$ref": "RippleAddress"
+    },
+    "regular_key": {
+      "description": "The hash of an optional additional public key that can be used for signing and verifying transactions",
+      "$ref": "RippleAddress"
+    },
+    "url": {
+      "description": "The domain associated with this account. The ripple.txt file can be looked up to verify this information",
+      "$ref": "URL"
+    },
+    "email_hash": {
+      "description": "The MD5 128-bit hash of the account owner's email address",
+      "$ref": "Hash128"
+    },
+    "message_key": {
+      "description": "An optional public key, represented as hex, that can be set to allow others to send encrypted messages to the account owner",
+      "type": "string",
+      "pattern": "^([0-9a-fA-F]{2}){0,33}$"
+    },
+    "transfer_rate": {
+      "description": "A number representation of the rate charged each time a holder of currency issued by this account transfers it. By default the rate is 100. A rate of 101 is a 1% charge on top of the amount being transferred. Up to nine decimal places are supported",
+      "type": "float"
+    },
+    "require_destination_tag": {
+      "description": "If set to true incoming payments will only be validated if they include a destination_tag. This may be used primarily by gateways that operate exclusively with hosted wallets",
+      "type": "boolean"
+    },
+    "require_authorization": {
+      "description": "If set to true incoming trustlines will only be validated if this account first creates a trustline to the counterparty with the authorized flag set to true. This may be used by gateways to prevent accounts unknown to them from holding currencies they issue",
+      "type": "boolean"
+    },
+    "disallow_xrp": {
+      "description": "If set to true incoming XRP payments will be allowed",
+      "type": "boolean"
+    },
+    "transaction_sequence": {
+      "description": "A string representation of the last sequence number of a validated transaction created by this account",
+      "$ref": "UINT32"
+    },
+    "trustline_count": {
+      "description": "The number of trustlines owned by this account. This value does not include incoming trustlines where this account has not explicitly reciprocated trust",
+      "$ref": "UINT32"
+    },
+    "ledger": {
+      "description": "The string representation of the index number of the ledger containing these account settings or, in the case of historical queries, of the transaction that modified these settings",
+      "type": "string",
+      "pattern": "^[0-9]+$"
+    },
+    "hash": {
+      "description": "If this object was returned by a historical query this value will be the hash of the transaction that modified these settings. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction",
+      "$ref": "Hash256"
+    }
+},
+  "required": ["account"]
+}

data/lib/ripple-rest/schemas/json/Amount.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Amount",
+  "description": "An Amount on the Ripple Protocol, used also for XRP in the ripple-rest API",
+  "type": "object",
+  "properties": {
+    "value": {
+      "description": "The quantity of the currency, denoted as a string to retain floating point precision",
+      "type": "string",
+      "$ref": "FloatString"
+    },
+    "currency": {
+      "description": "The currency expressed as a three-character code",
+      "$ref": "Currency"
+    },
+    "issuer": {
+      "description": "The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP",
+      "type": "string",
+      "pattern": "^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$"
+    },
+    "counterparty": {
+      "description": "The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP",
+      "type": "string",
+      "pattern": "^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$"
+    }
+  },
+  "required": ["value", "currency"]
+}

data/lib/ripple-rest/schemas/json/Balance.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Balance",
+  "description": "A simplified representation of an account Balance",
+  "type": "object",
+  "properties": {
+    "value": {
+      "description": "The quantity of the currency, denoted as a string to retain floating point precision",
+      "type": "string",
+      "$ref": "FloatString"
+    },
+    "currency": {
+      "description": "The currency expressed as a three-character code",
+      "$ref": "Currency"
+    },
+    "counterparty": {
+      "description": "The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP",
+      "type": "string",
+      "pattern": "^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$"
+    }
+  },
+  "required": [ "value", "currency" ]
+}

data/lib/ripple-rest/schemas/json/Currency.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Currency",
+  "description": "The three-character code or hex string used to denote currencies",
+  "type": "string",
+  "pattern": "^([a-zA-Z0-9]{3}|[A-Fa-f0-9]{40})$"
+}

data/lib/ripple-rest/schemas/json/FloatString.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "FloatString",
+  "description": "A string representation of a floating point number",
+  "type": "string",
+  "pattern": "^[-+]?[0-9]*[.]?[0-9]+([eE][-+]?[0-9]+)?$"
+}

data/lib/ripple-rest/schemas/json/Hash128.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Hash128",
+  "description": "The hex representation of a 128-bit hash",
+  "type": "string",
+  "pattern": "^$|^[A-Fa-f0-9]{32}$"
+}

data/lib/ripple-rest/schemas/json/Hash256.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Hash256",
+  "description": "The hex representation of a 256-bit hash",
+  "type": "string",
+  "pattern": "^$|^[A-Fa-f0-9]{64}$"
+}

data/lib/ripple-rest/schemas/json/Notification.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Notification",
+  "description": "A ",
+  "type": "object",
+  "properties": {
+    "account": {
+      "description": "The Ripple address of the account to which the notification pertains",
+      "$ref": "RippleAddress"
+    },
+    "type": {
+      "description": "The resource type this notification corresponds to. Possible values are \"payment\", \"order\", \"trustline\", \"accountsettings\"",
+      "type": "string",
+      "pattern": "^payment|order|trustline|accountsettings$" 
+    },
+    "direction": {
+      "description": "The direction of the transaction, from the perspective of the account being queried. Possible values are \"incoming\", \"outgoing\", and \"passthrough\"",
+      "type": "string",
+      "pattern": "^incoming|outgoing|passthrough$"
+    },
+    "state": {
+      "description": "The state of the transaction from the perspective of the Ripple Ledger. Possible values are \"validated\" and \"failed\"",
+      "type": "string",
+      "pattern": "^validated|failed$" 
+    },
+    "result": {
+      "description": "The rippled code indicating the success or failure type of the transaction. The code \"tesSUCCESS\" indicates that the transaction was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: \"tec\", \"tef\", \"tel\", or \"tej\"",
+      "type": "string",
+      "pattern": "te[cfjlms][A-Za-z_]+"
+    },
+    "ledger": {
+      "description": "The string representation of the index number of the ledger containing the validated or failed transaction. Failed payments will only be written into the Ripple Ledger if they fail after submission to a rippled and a Ripple Network fee is claimed",
+      "type": "string",
+      "pattern": "^[0-9]+$"
+    },
+    "hash": {
+      "description": "The 256-bit hash of the transaction. This is used throughout the Ripple protocol as the unique identifier for the transaction",
+      "$ref": "Hash256"
+    },
+    "timestamp": {
+      "description": "The timestamp representing when the transaction was validated and written into the Ripple ledger",
+      "$ref": "Timestamp"
+    },
+    "transaction_url": {
+      "description": "A URL that can be used to fetch the full resource this notification corresponds to",
+      "type": "string"
+    },
+    "previous_notification_url": {
+      "description": "A URL that can be used to fetch the notification that preceded this one chronologically",
+      "type": "string"
+    },
+    "next_notification_url": {
+      "description": "A URL that can be used to fetch the notification that followed this one chronologically",
+      "type": "string"
+    }
+  },
+  "required": []
+}

data/lib/ripple-rest/schemas/json/Order.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Order",
+  "description": "A simplified Order object used by the ripple-rest API (note that \"orders\" are referred to elsewhere in the Ripple protocol as \"offers\")",
+  "type": "object",
+  "properties": {
+    "account": {
+      "description": "The Ripple account address of the order's creator",
+      "$ref": "RippleAddress"
+    },
+    "buy": {
+      "description": "If set to true the order it indicates that the creator is looking to receive the base_amount in exchange for the counter_amount. If undefined or set to false it indicates that the creator is looking to sell the base_amount to receive the counter_amount",
+      "type": "boolean"
+    },
+    "base_amount": {
+      "description": "The amount of currency the seller_account is seeking to buy. If other orders take part of this one, this value will change to represent the amount left in the order. This may be specified along with the counter_amount OR exchange_rate but not both. When the order is parsed from the Ripple Ledger the base currency will be determined according to the Priority Ranking of Currencies (XRP,EUR,GBP,AUD,NZD,USD,CAD,CHF,JPY,CNY) and if neither currency is listed in the ranking the base currency will be the one that is alphabetically first",
+      "$ref": "Amount"
+    },
+    "counter_amount": {
+      "description": "The amount of currency being sold. If other orders take part of this one, this value will change to represent the amount left in the order. This may be specified along with the base_amount OR the exchange_rate but not both",
+      "$ref": "Amount"
+    },
+    "exchange_rate": {
+      "description": "A string representation of the order price, defined as the cost one unit of the base currency in terms of the counter currency. This may be specified along with the base_amount OR the counter_amount but not both. If it is unspecified it will be computed automatically based on the counter_amount divided by the base_amount",
+      "$ref": "FloatString"
+    },
+    "expiration_timestamp": {
+      "description": "The ISO combined date and time string representing the point beyond which the order will no longer be considered active or valid",
+      "$ref": "Timestamp"
+    },
+    "ledger_timeout": {
+      "description": "A string representation of the number of ledger closes after submission during which the order should be considered active",
+      "type": "string",
+      "pattern": "^[0-9]*$"
+    },
+    "immediate_or_cancel": {
+      "description": "If set to true this order will only take orders that are available at the time of execution and will not create an entry in the Ripple Ledger",
+      "type": "boolean"
+    },
+    "fill_or_kill": {
+      "description": "If set to true this order will only take orders that fill the base_amount and are available at the time of execution and will not create an entry in the Ripple Ledger",
+      "type": "boolean"
+    },
+    "maximize_buy_or_sell": {
+      "description": "If set to true and it is a buy order it will buy up to the base_amount even if the counter_amount is exceeded, if it is a sell order it will sell up to the counter_amount even if the base_amount is exceeded",
+      "type": "boolean"
+    },
+    "cancel_replace": {
+      "description": "If this is set to the sequence number of an outstanding order, that order will be cancelled and replaced with this one",
+      "type": "string",
+      "pattern": "^d*$"
+    },
+    "sequence": {
+      "description": "The sequence number of this order from the perspective of the seller_account. The seller_account and the sequence number uniquely identify the order in the Ripple Ledger",
+      "type": "string",
+      "pattern": "^[0-9]*$"
+    },
+    "fee": {
+      "description": "The Ripple Network transaction fee, represented in whole XRP (NOT \"drops\", or millionths of an XRP, which is used elsewhere in the Ripple protocol) used to create the order",
+      "$ref": "FloatString"
+    },
+    "state": {
+      "description": "If the order is active the state will be \"active\". If this object represents a historical order the state will be \"validated\", \"filled\" if the order was removed because it was fully filled, \"cancelled\" if it was deleted by the owner, \"expired\" if it reached the expiration_timestamp, or \"failed\" if there was an error with the initial attempt to place the order",
+      "type": "string",
+      "pattern": "^active|validated|filled|cancelled|expired|failed$"
+    },
+    "ledger": {
+      "description": "The string representation of the index number of the ledger containing this order or, in the case of historical queries, of the transaction that modified this Order. ",
+      "type": "string",
+      "pattern": "^[0-9]+$"
+    },
+    "hash": {
+      "description": "When returned as the result of a historical query this will be the hash of Ripple transaction that created, modified, or deleted this order. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction",
+      "$ref": "Hash256"
+    },
+    "previous": {
+      "description": "If the order was modified or partially filled this will be a full Order object. If the previous object also had a previous object that will be removed to reduce data complexity. Order changes can be walked backwards by querying the API for previous.hash repeatedly",
+      "$ref": "Order"
+    }
+  },
+  "required": ["account"]
+}

data/lib/ripple-rest/schemas/json/Payment.json

@@ -0,0 +1,98 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Payment",
+  "description": "A flattened Payment object used by the ripple-rest API",
+  "type": "object",
+  "properties": {
+    "source_account": {
+      "description": "The Ripple account address of the Payment sender",
+      "$ref": "RippleAddress"
+    },
+    "source_tag": {
+      "description": "A string representing an unsigned 32-bit integer most commonly used to refer to a sender's hosted account at a Ripple gateway",
+      "$ref": "UINT32"
+    },
+    "source_amount": {
+      "description": "An optional amount that can be specified to constrain cross-currency payments",
+      "$ref": "Amount"
+    },
+    "source_slippage": {
+      "description": "An optional cushion for the source_amount to increase the likelihood that the payment will succeed. The source_account will never be charged more than source_amount.value + source_slippage",
+      "$ref": "FloatString"
+    },
+    "destination_account": {
+      "$ref": "RippleAddress"
+    },
+    "destination_tag": {
+      "description": "A string representing an unsigned 32-bit integer most commonly used to refer to a receiver's hosted account at a Ripple gateway",
+      "$ref": "UINT32"
+    },
+    "destination_amount": {
+      "description": "The amount the destination_account will receive",
+      "$ref": "Amount"
+    },
+    "invoice_id": {
+      "description": "A 256-bit hash that can be used to identify a particular payment",
+      "$ref": "Hash256"
+    },
+    "paths ": {
+      "description": "A \"stringified\" version of the Ripple PathSet structure that users should treat as opaque",
+      "type": "string"
+    },
+    "partial_payment": {
+      "description": "A boolean that, if set to true, indicates that this payment should go through even if the whole amount cannot be delivered because of a lack of liquidity or funds in the source_account account",
+      "type": "boolean"
+    },
+    "no_direct_ripple": {
+      "description": "A boolean that can be set to true if paths are specified and the sender would like the Ripple Network to disregard any direct paths from the source_account to the destination_account. This may be used to take advantage of an arbitrage opportunity or by gateways wishing to issue balances from a hot wallet to a user who has mistakenly set a trustline directly to the hot wallet",
+      "type": "boolean"
+    },
+    "direction": {
+      "description": "The direction of the payment, from the perspective of the account being queried. Possible values are \"incoming\", \"outgoing\", and \"passthrough\"",
+      "type": "string",
+      "pattern": "^incoming|outgoing|passthrough$"
+    },
+    "state": {
+      "description": "The state of the payment from the perspective of the Ripple Ledger. Possible values are \"validated\" and \"failed\" and \"new\" if the payment has not been submitted yet",
+      "type": "string",
+      "pattern": "^validated|failed|new$" 
+    },
+    "result": {
+      "description": "The rippled code indicating the success or failure type of the payment. The code \"tesSUCCESS\" indicates that the payment was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: \"tec\", \"tef\", \"tel\", or \"tej\"",
+      "type": "string",
+      "pattern": "te[cfjlms][A-Za-z_]+"
+    },
+    "ledger": {
+      "description": "The string representation of the index number of the ledger containing the validated or failed payment. Failed payments will only be written into the Ripple Ledger if they fail after submission to a rippled and a Ripple Network fee is claimed",
+      "type": "string",
+      "pattern": "^[0-9]+$"
+    },
+    "hash": {
+      "description": "The 256-bit hash of the payment. This is used throughout the Ripple protocol as the unique identifier for the transaction",
+      "$ref": "Hash256"
+    },
+    "timestamp": {
+      "description": "The timestamp representing when the payment was validated and written into the Ripple ledger",
+      "$ref": "Timestamp"
+    },
+    "fee": {
+      "description": "The Ripple Network transaction fee, represented in whole XRP (NOT \"drops\", or millionths of an XRP, which is used elsewhere in the Ripple protocol)",
+      "$ref": "FloatString"
+    },
+    "source_balance_changes": {
+      "description": "Parsed from the validated transaction metadata, this array represents all of the changes to balances held by the source_account. Most often this will have one amount representing the Ripple Network fee and, if the source_amount was not XRP, one amount representing the actual source_amount that was sent",
+      "type": "array",
+      "items": {
+        "$ref": "Amount"
+      }
+    },
+    "destination_balance_changes": {
+      "description": "Parsed from the validated transaction metadata, this array represents the changes to balances held by the destination_account. For those receiving payments this is important to check because if the partial_payment flag is set this value may be less than the destination_amount",
+      "type": "array",
+      "items": {
+        "$ref": "Amount"
+      }
+    }
+  },
+  "required": ["source_account", "destination_account", "destination_amount"]
+}

data/lib/ripple-rest/schemas/json/ResourceId.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "ResourceId",
+  "description": "A client-supplied unique identifier (ideally a UUID) for this transaction used to prevent duplicate payments and help confirm the transaction's final status. All ASCII printable characters are allowed. Note that 256-bit hex strings are disallowed because of the potential confusion with transaction hashes.",
+  "type": "string",
+  "pattern": "^(?!$|^[A-Fa-f0-9]{64})[ -~]{1,255}$"
+}

data/lib/ripple-rest/schemas/json/RippleAddress.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "RippleAddress",
+  "description": "A Ripple account address",
+  "type": "string",
+  "pattern": "^r[1-9A-HJ-NP-Za-km-z]{25,33}$"
+}

data/lib/ripple-rest/schemas/json/Timestamp.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Timestamp",
+  "description": "An ISO 8601 combined date and time timestamp",
+  "type": "string",
+  "pattern": "^$|^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9](Z|[+](2[0-3]|[01][0-9]):[0-5][0-9])$"
+}

data/lib/ripple-rest/schemas/json/Trustline.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Trustline",
+  "description": "A simplified Trustline object used by the ripple-rest API",
+  "type": "object",
+  "properties": {
+    "account": {
+      "description": "The account from whose perspective this trustline is being viewed",
+      "$ref": "RippleAddress"
+    },
+    "counterparty": {
+      "description": "The other party in this trustline",
+      "$ref": "RippleAddress"
+    },
+    "currency": {
+      "description": "The code of the currency in which this trustline denotes trust",
+      "$ref": "Currency"
+    },
+    "limit": {
+      "description": "The maximum value of the currency that the account may hold issued by the counterparty",
+      "$ref": "FloatString"
+    },
+    "reciprocated_limit": {
+      "description": "The maximum value of the currency that the counterparty may hold issued by the account",
+      "$ref": "FloatString"
+    },
+    "authorized_by_account": {
+      "description": "Set to true if the account has explicitly authorized the counterparty to hold currency it issues. This is only necessary if the account's settings include require_authorization_for_incoming_trustlines",
+      "type": "boolean"
+    },
+    "authorized_by_counterparty": {
+      "description": "Set to true if the counterparty has explicitly authorized the account to hold currency it issues. This is only necessary if the counterparty's settings include require_authorization_for_incoming_trustlines",
+      "type": "boolean"
+    },
+    "account_allows_rippling": {
+      "description": "If true it indicates that the account allows pairwise rippling out through this trustline",
+      "type": "boolean"
+    },
+    "counterparty_allows_rippling": {
+      "description": "If true it indicates that the counterparty allows pairwise rippling out through this trustline",
+      "type": "boolean"
+    },
+    "ledger": {
+      "description": "The string representation of the index number of the ledger containing this trustline or, in the case of historical queries, of the transaction that modified this Trustline",
+      "type": "string",
+      "pattern": "^[0-9]+$"
+    },
+    "hash": {
+      "description": "If this object was returned by a historical query this value will be the hash of the transaction that modified this Trustline. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction",
+      "$ref": "Hash256"
+    },
+    "previous": {
+      "description": "If the trustline was changed this will be a full Trustline object representing the previous values. If the previous object also had a previous object that will be removed to reduce data complexity. Trustline changes can be walked backwards by querying the API for previous.hash repeatedly",
+      "$ref": "Trustline"
+    }
+  },
+  "required": ["account", "limit"]
+}

data/lib/ripple-rest/schemas/json/UINT32.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "UINT32",
+  "description": "A string representation of an unsigned 32-bit integer (0-4294967295)",
+  "type": "string",
+  "pattern": "^$|^(429496729[0-5]|42949672[0-8][0-9]|4294967[01][0-9]{2}|429496[0-6][0-9]{3}|42949[0-5][0-9]{4}|4294[0-8][0-9]{5}|429[0-3][0-9]{6}|42[0-8][0-9]{7}|4[01][0-9]{8}|[1-3][0-9]{9}|[1-9][0-9]{8}|[1-9][0-9]{7}|[1-9][0-9]{6}|[1-9][0-9]{5}|[1-9][0-9]{4}|[1-9][0-9]{3}|[1-9][0-9]{2}|[1-9][0-9]|[0-9])$"
+}

data/lib/ripple-rest/schemas/json/URL.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "URL",
+  "description": "A standard URL",
+  "type": "string",
+  "pattern": "^(ftp:\/\/|http:\/\/|https:\/\/)?([A-Za-z0-9_]+:{0,1}[A-Za-z0-9_]*@)?(^([ \t\r\n\f])+)(:[0-9]+)?(\/|\/([[A-Za-z0-9_]#!:.?+=&%@!-\/]))?$"
+}

data/lib/ripple-rest/schemas/notifications.rb

@@ -0,0 +1,12 @@
+module RippleRest
+  generate_schema :Notification
+  
+  class Notifications
+    attr_accessor :account
+    
+    def [] hash
+      Notification.new RippleRest
+        .get("v1/accounts/#{account.address}/notifications/#{hash}")["notification"]
+    end
+  end
+end

data/lib/ripple-rest/schemas/order.rb

@@ -0,0 +1,6 @@
+module RippleRest
+  generate_schema :Order
+
+  class Order
+  end
+end

data/lib/ripple-rest/schemas/payments.rb

@@ -0,0 +1,72 @@
+module RippleRest
+  generate_schema :Payment
+
+  class Payment
+    def account
+      @account
+    end
+    
+    def account= val
+      @account = val
+      self.source_account = val.address
+    end
+    
+    def submit
+      @account.require_secret
+      
+      hash = {}
+      hash["payment"] = self.to_hash
+      hash["secret"] = @account.secret
+      hash["client_resource_id"] = client_resource_id = RippleRest.next_uuid
+      
+      RippleRest.post("v1/payments", hash)["client_resource_id"]
+    end
+    
+    attr_accessor :client_resource_id
+  end
+  
+  class Payments
+    attr_accessor :account
+    
+    def [] hash
+      Payment.new RippleRest
+        .get("v1/accounts/#{account.address}/payments/#{hash}")["payment"]
+    end
+    
+    def find_path destination_account, destination_amount, source_currencies = nil
+      uri = "v1/accounts/#{account.address}/payments/paths/#{destination_account.to_s}/#{destination_amount.to_s}"
+      
+      if source_currencies
+        cur = source_currencies.join(",")
+        uri += "?#{cur}"
+      end
+      
+      RippleRest.get(uri)["payments"].map(&Payment.method(:new)).map do |i|
+        i.account = account
+      end
+    end
+    
+    def create destination_account, destination_amount
+      payment = Payment.new
+      payment.account = account
+      payment.destination_account = destination_account.to_s
+      payment.destination_amount = Amount.from_string(destination_amount)
+      payment
+    end
+    
+    def query options = {}
+      qs = ""
+      if options && options.size > 0
+        qs = "?" + options.map { |k,v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&')
+      end
+      
+      uri = "v1/accounts/#{account.address}/payments#{qs}"
+      
+      RippleRest.get(uri)["payments"].map do |i|
+        payment = Payment.new(i["payment"])
+        payment.client_resource_id = i["client_resource_id"]
+        payment
+      end
+    end
+  end
+end

data/lib/ripple-rest/schemas/trustlines.rb

@@ -0,0 +1,33 @@
+module RippleRest
+  
+  generate_schema :Trustline
+  class Trustlines
+    include Enumerable
+    
+    attr_accessor :account
+    
+    def initialize data
+      @data = data
+    end
+    
+    def each *args, &block
+      @data.each *args, &block
+    end
+    
+    def add obj
+      raise ArgumentError.new("Account is missing.") unless account
+      account.require_secret
+      
+      hash = {}
+      hash["secret"] = account.secret
+      
+      if obj.is_a? String
+        hash["trustline"] = { "limit" => obj }
+      else
+        hash["trustline"] = obj.to_hash
+      end
+      
+      RippleRest.post "v1/accounts/#{account.address}/trustlines", hash
+    end
+  end
+end

data/lib/ripple-rest/version.rb

@@ -0,0 +1,3 @@
+module RippleRest
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ripple-rest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yeechan Lu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: autoparse
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+description: A ruby wrapper for Ripple REST API.
+email: ripple-rest@orzfly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ripple-rest/schemas/json.rb
+- lib/ripple-rest/schemas/trustlines.rb
+- lib/ripple-rest/schemas/payments.rb
+- lib/ripple-rest/schemas/amount.rb
+- lib/ripple-rest/schemas/account_settings.rb
+- lib/ripple-rest/schemas/balance.rb
+- lib/ripple-rest/schemas/notifications.rb
+- lib/ripple-rest/schemas/order.rb
+- lib/ripple-rest/schemas/account.rb
+- lib/ripple-rest/version.rb
+- lib/ripple-rest/errors.rb
+- lib/ripple-rest.rb
+- lib/ripple-rest/schemas/json/Notification.json
+- lib/ripple-rest/schemas/json/Hash256.json
+- lib/ripple-rest/schemas/json/Hash128.json
+- lib/ripple-rest/schemas/json/Order.json
+- lib/ripple-rest/schemas/json/Timestamp.json
+- lib/ripple-rest/schemas/json/RippleAddress.json
+- lib/ripple-rest/schemas/json/ResourceId.json
+- lib/ripple-rest/schemas/json/FloatString.json
+- lib/ripple-rest/schemas/json/AccountSettings.json
+- lib/ripple-rest/schemas/json/Payment.json
+- lib/ripple-rest/schemas/json/Balance.json
+- lib/ripple-rest/schemas/json/Amount.json
+- lib/ripple-rest/schemas/json/Trustline.json
+- lib/ripple-rest/schemas/json/URL.json
+- lib/ripple-rest/schemas/json/Currency.json
+- lib/ripple-rest/schemas/json/UINT32.json
+- LICENSE
+- ROADMAP.md
+- CHANGELOG.md
+- README.md
+homepage: http://github.com/orzFly/ruby-ripple-rest
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -284765535
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ripple-rest
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for Ripple REST API.
+test_files: []