ripple-rest 0.0.2 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ripple-rest
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -27,56 +27,19 @@ dependencies:
     - - ~>
       - !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/_generate.rb
-- 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/account.rb
+- lib/ripple-rest/generated-schemas.rb
+- lib/ripple-rest/schemas.rb
 - lib/ripple-rest/version.rb
 - lib/ripple-rest/errors.rb
+- lib/ripple-rest/helpers.rb
+- lib/ripple-rest/rest-object.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
@@ -95,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 9938735
+      hash: -728632721
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

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

@@ -1,84 +0,0 @@
-module RippleRest
-  class Account
-    # Account's Address (rXXXXXX...)
-    # @return [String]
-    attr_accessor :address
-    
-    # Account's secret
-    # @return [String]
-    attr_accessor :secret
-    
-    def initialize address, secret = nil
-      @address = address
-      @secret = secret
-    end
-    
-    # Get an account's existing balances.
-    # This includes XRP balance (which does not include a counterparty) and trustline balances.
-    # @return [Array<Balance>]
-    # @raise [RippleRestError] if RippleRest server returns an error
-    # @raise [ProtocolError] if protocol is wrong or network is down
-    def balances
-      RippleRest
-        .get("v1/accounts/#{@address}/balances")["balances"]
-        .map(&Balance.method(:new))
-    end
-    
-    # Returns a Trustlines object for this account.
-    # @return [Trustlines]
-    # @raise [RippleRestError] if RippleRest server returns an error
-    # @raise [ProtocolError] if protocol is wrong or network is down
-    def trustlines
-      data = RippleRest
-        .get("v1/accounts/#{@address}/trustlines")["trustlines"]
-        .map(&Trustline.method(:new))
-      obj = Trustlines.new data
-      obj.account = self
-      obj
-    end
-    
-    # Returns a AccountSettings object for this account.
-    # @return [AccountSettings]
-    # @raise [RippleRestError] if RippleRest server returns an error
-    # @raise [ProtocolError] if protocol is wrong or network is down
-    def settings
-      data = RippleRest.get("v1/accounts/#{@address}/settings")["settings"]
-      obj = AccountSettings.new data
-      obj.account = self
-      obj
-    end
-    
-    # Returns a Notifications object for this account.
-    # @return [Notifications]
-    def notifications
-      @notifications ||= lambda {
-        obj = Notifications.new
-        obj.account = self
-        obj
-      }.call
-    end
-    
-    # Returns a Payments object for this account.
-    # @return [Payments]
-    def payments
-      payments ||= lambda {
-        obj = Payments.new
-        obj.account = self
-        obj
-      }.call
-    end
-    
-    # Returns the address of attribute address.
-    # @return [String]
-    def to_s
-      address
-    end
-    
-    # @!group Private APIs
-    # @api private
-    def require_secret
-      raise ArgumentError.new("Secret is required for this operation.") unless secret
-    end
-    # @!endgroup
-  end
-end

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

@@ -1,22 +0,0 @@
-module RippleRest
-  class AccountSettings
-    # @return [Account]
-    attr_accessor :account
-    
-    # Save the account settings
-    # @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
-    # @return [void]
-    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

@@ -1,21 +0,0 @@
-module RippleRest
-  class Amount
-    # @return [String]
-    def to_s
-      "#{value}+#{currency}#{issuer.to_s.size > 0 ? ("+" + issuer) : ""}"
-    end
-    
-    # @param s [String, Amount] an Amount object or a String like "1+XRP" or "1+USD+r..."
-    # @return [Amount]
-    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

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

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

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

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

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

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

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

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

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

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

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