ripple-rest 0.0.2 → 1.0.0

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

@@ -1,98 +0,0 @@
-{
-  "$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

@@ -1,7 +0,0 @@
-{
-  "$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

@@ -1,7 +0,0 @@
-{
-  "$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

@@ -1,7 +0,0 @@
-{
-  "$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

@@ -1,58 +0,0 @@
-{
-  "$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

@@ -1,7 +0,0 @@
-{
-  "$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

@@ -1,7 +0,0 @@
-{
-  "$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/json/_generate.rb

@@ -1,73 +0,0 @@
-require 'json'
-schemas = {}
-Dir["*.json"].each do |i|
-  key = File.basename(i, ".json")
-  schemas[key] = JSON.parse File.read i
-end
-
-puts <<'EOF'
-require 'autoparse'
-
-module RippleRest
-  # @!group Private APIs
-  # @api private
-  def self.generate_schema(fn)
-    RippleRest.const_set fn, AutoParse.generate(JSON.parse(File.read(File.join(File.join(File.dirname(__FILE__), "json"), "#{fn}.json"))), :uri => "#{fn}")
-  end
-  # @!endgroup
-  
-  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  
-  
-  generate_schema :Order
-  generate_schema :Balance
-  generate_schema :Notification
-  generate_schema :Payment
-  generate_schema :Trustline
-  generate_schema :AccountSettings
-  generate_schema :Amount
-  
-EOF
-schemas.values.select{|i|i["type"] == "object"}.each do |json|
-  key = json["title"]
-  puts "  # #{json["description"]}"
-  puts "  class #{key} < AutoParse::Instance"
-  
-  json["properties"].each do |k, v|
-    type = ""
-    if v["type"] == "string" && v["pattern"]
-      type = "[String] +#{v["pattern"].inspect}+"
-    elsif v["type"] == "string"
-      type = "[String]"
-    elsif v["type"] == "boolean"
-      type = "[Boolean]"
-    elsif v["type"] == "float"
-      type = "[Float]"
-    elsif v["$ref"] == "FloatString"
-      type = "[String<FloatString>]" # BigDecimal
-    elsif v["$ref"] == "UInt32"
-      type = "[UInt32]"
-    elsif v["$ref"] && schemas[v["$ref"]]["type"] == "string"
-      type = "[String<#{v["$ref"]}>] +#{schemas[v["$ref"]]["pattern"].inspect}+"
-    elsif v["$ref"]
-      type = "[#{v["$ref"]}]"
-    elsif
-      type = "[#{v["type"]}]"
-    end
-    
-    puts "    # @!attribute #{k}"
-    puts "    #   #{v["description"]}"
-    puts "    #   @return #{type}"
-    puts
-    puts
-  end
-  puts "  end"
-end
-puts "end"

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

@@ -1,19 +0,0 @@
-module RippleRest
-  class Notifications
-    # @return [Account]
-    attr_accessor :account
-    
-    # Get notifications.
-    # 
-    # Clients using notifications to monitor their account activity should pay particular attention to the `state` and `result` fields. The `state` field will either be `validated` or `failed` and represents the finalized status of that transaction. The `result` field will be `tesSUCCESS` if the `state` was validated. If the transaction failed, `result` will contain the `rippled` or `ripple-lib` error code.
-    # 
-    # Notifications have `next_notification_url` and `previous_notification_url`'s. Account notifications can be polled by continuously following the `next_notification_url`, and handling the resultant notifications, until the `next_notification_url` is an empty string. This means that there are no new notifications but, as soon as there are, querying the same URL that produced this notification in the first place will return the same notification but with the `next_notification_url` set.
-    # @raise [RippleRestError] if RippleRest server returns an error
-    # @raise [ProtocolError] if protocol is wrong or network is down
-    # @return [Notification]
-    def [] hash
-      Notification.new RippleRest
-        .get("v1/accounts/#{account.address}/notifications/#{hash}")["notification"]
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-module RippleRest
-  class Trustlines
-    include Enumerable
-    
-    # @return [Account]
-    attr_accessor :account
-    
-    def initialize data
-      @data = data
-    end
-    
-    # Use with Enumerable
-    def each *args, &block
-      @data.each *args, &block
-    end
-    
-    # Add trustline
-    # @param obj [String, Hash] Either a string representation of trustline limit, Hash containing value, currency, counterparty or a string form value/currency/counterparty.
-    # @param allow_rippling [Boolean] See [here](https://ripple.com/wiki/No_Ripple) for details
-    # @raise [ArgumentError] if secret is missing from the Account object
-    # @raise [RippleRestError] if RippleRest server returns an error
-    # @raise [ProtocolError] if protocol is wrong or network is down
-    def add obj, allow_rippling = true
-      raise ArgumentError.new("Account is missing.") unless account
-      account.require_secret
-      
-      hash = {}
-      hash["allow_rippling"] = allow_rippling
-      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