sequence-sdk 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13297573e64f55ffcba16f88365a13ee4540d7c3
-  data.tar.gz: e94b5d7ab7f11a8dfe48140fceea4c921d56b2d9
+  metadata.gz: da13e33f0caa12bd428d4a97a545e42603369f68
+  data.tar.gz: b660490b8b64779fa01eb22ddfbb94a609946955
 SHA512:
-  metadata.gz: f3231c2b04e1e9a99a8318aac330fdd4ea1eb1bb54ab0510c9cbfa49335454fbfaaa8114d823bc70a799ce89ef6617c9502940f33c48ae4dd5240bd2a2939dea
-  data.tar.gz: dad7408ea6e7c10eb8e793faffa29150e95cdaf39a4c651c7566eea2760c46ed0a16e60a545b6993f3e1aab48921dfd03b624a7fa9c96e2511c528c5f0d311d5
+  metadata.gz: 184219f173c60a722b8f8356801f24897c17dc420c114fbf7609285135ae7dbc211bbc1a23fa185d5a97bb97436e401fdd74751f2eca88eff1e910e14117bab2
+  data.tar.gz: c7309542abbea40fbbd42a29072a1751b61693f06dd133ea4778ff85638fcc62b177916ded02a84b46c936d0b4c7d197a5ed151dc1ddb2da16dec3372d6599ab

data/README.md

@@ -4,14 +4,17 @@
 
 ### Get the gem
 
-The Ruby SDK is available [via Rubygems](https://rubygems.org/gems/sequence-sdk).
+The Ruby SDK is available
+[via Rubygems](https://rubygems.org/gems/sequence-sdk).
 
-Ruby 2.0 or greater is required. We strongly recommend upgrading to Ruby 2.1 or greater, as [Ruby 2.0 has reached end-of-life](https://www.ruby-lang.org/en/downloads/branches/) and will no longer receive security updates and bugfixes.
+Ruby >= 2.2 is required. We recommend upgrading to Ruby >= 2.3. See
+[Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/)
+for the language's schedule for security and bug fixes.
 
-For most applications, you can simply add the following to your `Gemfile`:
+Add the following to your `Gemfile`:
 
 ```
-gem 'sequence-sdk', '~> 1.0.0'
+gem 'sequence-sdk'
 ```
 
 ### In your code
@@ -20,11 +23,12 @@ gem 'sequence-sdk', '~> 1.0.0'
 require 'sequence'
 
 ledger = Sequence::Client.new(
-  url: 'https://example-ledger.sequenceledger.com',
-  access_token: '...'
+  ledger: 'ledger',
+  credential: '...'
 )
 ```
 
 ### Documentation
 
-Comprehensive instructions and examples are available in the [developer documentation](https://dashboard.sequenceledger.com/docs).
+Comprehensive instructions and examples are available in the
+[developer documentation](https://dashboard.seq.com/docs).

data/lib/sequence/account.rb

@@ -6,29 +6,30 @@ require_relative './response_object'
 module Sequence
   # A container for asset balances on a ledger.
   class Account < ResponseObject
-
     # @!attribute [r] id
-    # Unique, auto-generated identifier.
+    #   Unique, auto-generated identifier.
     # @return [String]
     attrib :id
 
     # @!attribute [r] alias
-    # Unique, user-specified identifier.
+    #   Unique, user-specified identifier.
     # @return [String]
     attrib :alias
 
     # @!attribute [r] keys
-    # The set of keys used for signing transactions that spend from the account.
+    #   The set of keys used for signing transactions that spend from the
+    #   account.
     # @return [Array<Key>]
     attrib(:keys) { |raw| raw.map { |k| Key.new(k) } }
 
     # @!attribute [r] quorum
-    # The number of keys required to sign transactions that spend from the account.
+    #   The number of keys required to sign transactions that spend from the
+    #   account.
     # @return [Integer]
     attrib :quorum
 
     # @!attribute [r] tags
-    # User-specified key-value data describing the account.
+    #   User-specified key-value data describing the account.
     # @return [Hash]
     attrib :tags
 
@@ -39,33 +40,65 @@ module Sequence
 
     class ClientModule < Sequence::ClientModule
       # Creates a new account in the ledger.
-      # @param [Hash] opts Options hash
-      # @option opts [String] alias Unique, user-specified identifier.
-      # @option opts [Array<Hash>, Array<Sequence::Key>] keys The set of keys used for signing transactions that spend from the account. A key can be either a key object, or a hash containing either an `id` or `alias` field.
-      # @option opts [Integer] quorum	The number of keys required to sign transactions that spend from the account. Defaults to the number of keys provided.
-      # @option opts [Hash] tags User-specified key-value data describing the account.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] alias
+      #   Unique, user-specified identifier.
+      # @option opts [Array<Hash>, Array<Sequence::Key>] keys
+      #   The keys used for signing transactions that spend from the account. A
+      #   key can be either a key object, or a hash containing either an `id` or
+      #   `alias` field.
+      # @option opts [Integer] quorum
+      #   The number of keys required to sign transactions that spend from the
+      #   account. Defaults to the number of keys provided.
+      # @option opts [Hash] tags
+      #   User-specified key-value data describing the account.
       # @return [Account]
-      def create(opts)
-        opts = {client_token: SecureRandom.uuid}.merge(opts)
+      def create(opts = {})
+        validate_inclusion_of!(opts, :alias, :keys, :quorum, :tags)
+        validate_required!(opts, :keys)
         Account.new(client.session.request('create-account', opts))
       end
 
       # Updates an account's tags.
-      # @param [Hash] opts Options hash
-      # @option opts [String] id The ID of the account. Either an ID or alias should be provided, but not both.
-      # @option opts [String] alias The alias of the account. Either an ID or alias should be provided, but not both.
-      # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] id
+      #   The ID of the account. Either an ID or alias should be provided, but
+      #   not both.
+      # @option opts [String] alias
+      #   The alias of the account. Either an ID or alias should be provided,
+      #   but not both.
+      # @option opts [Hash] tags
+      #   A new set of tags, which will replace the existing tags.
       # @return [void]
-      def update_tags(opts)
+      def update_tags(opts = {})
+        validate_inclusion_of!(opts, :id, :alias, :tags)
+        if (opts[:id].nil? || opts[:id].empty?) &&
+           (opts[:alias].nil? || opts[:alias].empty?)
+          raise ArgumentError, ':id or :alias (but not both) must be provided'
+        end
         client.session.request('update-account-tags', opts)
       end
 
       # Executes a query, returning an enumerable over individual accounts.
-      # @param [Hash] opts Options hash
-      # @option opts [String] filter A filter expression.
-      # @option opts [Array<String|Integer>] filter_params A list of values that will be interpolated into the filter expression.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] filter
+      #   A filter expression.
+      # @option opts [Array<String|Integer>] filter_params
+      #   A list of values that will be interpolated into the filter expression.
+      # @option opts [Integer>] page_size
+      #   The number of items to return in the result set.
       # @return [Query]
       def query(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+          :page_size,
+          :after,
+        )
         Query.new(client, opts)
       end
     end
@@ -79,6 +112,5 @@ module Sequence
         Account.new(raw)
       end
     end
-
   end
 end

data/lib/sequence/action.rb

@@ -0,0 +1,158 @@
+require_relative './client_module'
+require_relative './response_object'
+require_relative './query'
+
+module Sequence
+  # Each transaction contains one or more actions. Action queries are designed
+  # to provide insights into those actions. There are two types of queries you
+  # can run against them; one is "list", one is "sum". List query simply returns
+  # a list of Action objects that match the filter; Sum query sums over the
+  # amount fields based on the filter and the group_by param and return
+  # ActionSum objects. Different from other regular API objects, the amount
+  # field in ActionSum represents the summation of the amount fields of those
+  # matching actions, and all other fields represent the parameters by which to
+  # group actions.
+  class Action < ResponseObject
+    # @!attribute [r] amount
+    #   Summation of action amounts.
+    # @return [Integer]
+    attrib :amount
+
+    # @!attribute [r] type
+    #   The type of the action. Currently, there are three options: "issue",
+    #   "transfer", "retire".
+    # @return [String]
+    attrib :type
+
+    # @!attribute [r] id
+    #   A unique ID.
+    # @return [String]
+    attrib :id
+
+    # @!attribute [r] transaction_id
+    #   The ID of the transaction in which the action appears.
+    # @return [String]
+    attrib :transaction_id
+
+    # @!attribute [r] timestamp
+    #   Time of the action.
+    # @return [Time]
+    attrib :timestamp, rfc3339_time: true
+
+    # @!attribute [r] asset_id
+    #   The ID of the asset held by the action.
+    # @return [String]
+    attrib :asset_id
+
+    # @!attribute [r] asset_alias
+    #   The alias of the asset held by the action.
+    # @return [String]
+    attrib :asset_alias
+
+    # @!attribute [r] asset_tags
+    #   The tags of the asset held by the action.
+    # @return [Hash]
+    attrib :asset_tags
+
+    # @!attribute [r] source_account_id
+    #   The ID of the source account executing the action.
+    # @return [String]
+    attrib :source_account_id
+
+    # @!attribute [r] source_account_alias
+    #   The alias of the source account executing the action.
+    # @return [String]
+    attrib :source_account_alias
+
+    # @!attribute [r] source_account_tags
+    #   The tags of the source account executing the action.
+    # @return [Hash]
+    attrib :source_account_tags
+
+    # @!attribute [r] destination_account_id
+    #   The ID of the destination account affected by the action.
+    # @return [String]
+    attrib :destination_account_id
+
+    # @!attribute [r] destination_account_alias
+    #   The alias of the destination account affected by the action.
+    # @return [String]
+    attrib :destination_account_alias
+
+    # @!attribute [r] destination_account_tags
+    #   The tags of the destination account affected by the action.
+    # @return [Hash]
+    attrib :destination_account_tags
+
+    # @!attribute [r] reference_data
+    #   User-specified key-value data embedded in the action.
+    # @return [Hash]
+    attrib :reference_data
+
+    class ClientModule < Sequence::ClientModule
+      # Executes a query, returning an enumerable over individual actions.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] filter
+      #   A filter expression.
+      # @option opts [Array<String|Integer>] filter_params
+      #   A list of values that will be interpolated into the filter expression.
+      # @option opts [Integer>] page_size
+      #   The number of items to return in the result set.
+      # @return [Query]
+      def list(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+          :page_size,
+          :after,
+        )
+        ListQuery.new(client, opts)
+      end
+
+      # Executes a query, returning an enumerable over individual actionsums.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] filter
+      #   A filter expression.
+      # @option opts [Array<String|Integer>] filter_params
+      #   A list of values that will be interpolated into the filter expression.
+      # @option opts [Array<String>] group_by
+      #   A list of fields along which action values will be summed.
+      # @option opts [Integer>] page_size
+      #   The number of items to return in the result set.
+      # @return [Query]
+      def sum(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+          :group_by,
+          :page_size,
+        )
+        SumQuery.new(client, opts)
+      end
+    end
+
+    class ListQuery < Sequence::Query
+      def fetch(query)
+        client.session.request('list-actions', query)
+      end
+
+      def translate(raw)
+        Action.new(raw)
+      end
+    end
+
+    class SumQuery < Sequence::Query
+      def fetch(query)
+        client.session.request('sum-actions', query)
+      end
+
+      def translate(raw)
+        Action.new(raw)
+      end
+    end
+  end
+end

data/lib/sequence/asset.rb

@@ -8,29 +8,28 @@ require_relative './response_object'
 module Sequence
   # A type or class of value that can be tracked on a ledger.
   class Asset < ResponseObject
-
     # @!attribute [r] id
-    # Unique, auto-generated identifier.
+    #   Unique, auto-generated identifier.
     # @return [String]
     attrib :id
 
     # @!attribute [r] alias
-    # Unique, user-specified identifier.
+    #   Unique, user-specified identifier.
     # @return [String]
     attrib :alias
 
     # @!attribute [r] keys
-    # The set of keys used to sign transactions that issue the asset.
+    #   The set of keys used to sign transactions that issue the asset.
     # @return [Array<Key>]
     attrib(:keys) { |raw| raw.map { |k| Key.new(k) } }
 
     # @!attribute [r] quorum
-    # The number of keys required to sign transactions that issue the asset.
+    #   The number of keys required to sign transactions that issue the asset.
     # @return [Integer]
     attrib :quorum
 
     # @!attribute [r] tags
-    # User-specified key-value data describing the asset.
+    #   User-specified key-value data describing the asset.
     # @return [Hash]
     attrib :tags
 
@@ -41,33 +40,65 @@ module Sequence
 
     class ClientModule < Sequence::ClientModule
       # Creates a new asset in the ledger.
-      # @param [Hash] opts Options hash
-      # @option opts [String] alias Unique, user-specified identifier.
-      # @option opts [Array<Hash>, Array<Sequence::Key>] keys The set of keys used for signing transactions that issue the asset. A key can be either a key object, or a hash containing either an `id` or `alias` field.
-      # @option opts [Integer] quorum The number of keys required to sign transactions that issue the asset. Defaults to the number of keys provided.
-      # @option opts [Hash] tags User-specified key-value data describing the asset.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] alias
+      #   Unique, user-specified identifier.
+      # @option opts [Array<Hash>, Array<Sequence::Key>] keys
+      #   The set of keys used for signing transactions that issue the asset. A
+      #   key can be either a key object, or a hash containing either an `id` or
+      #   `alias` field.
+      # @option opts [Integer] quorum
+      #   The number of keys required to sign transactions that issue the asset.
+      #   Defaults to the number of keys provided.
+      # @option opts [Hash] tags
+      #   User-specified key-value data describing the asset.
       # @return [Asset]
-      def create(opts)
-        opts = {client_token: SecureRandom.uuid}.merge(opts)
+      def create(opts = {})
+        validate_inclusion_of!(opts, :alias, :keys, :quorum, :tags)
+        validate_required!(opts, :keys)
         Asset.new(client.session.request('create-asset', opts))
       end
 
       # Updates an asset's tags.
-      # @param [Hash] opts Options hash
-      # @option opts [String] id The ID of the asset. Either an ID or alias should be provided, but not both.
-      # @option opts [String] alias The alias of the asset. Either an ID or alias should be provided, but not both.
-      # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] id
+      #   The ID of the asset. Either an ID or alias should be provided, but not
+      #   both.
+      # @option opts [String] alias
+      #   The alias of the asset. Either an ID or alias should be provided, but
+      #   not both.
+      # @option opts [Hash] tags
+      #   A new set of tags, which will replace the existing tags.
       # @return [void]
-      def update_tags(opts)
+      def update_tags(opts = {})
+        validate_inclusion_of!(opts, :id, :alias, :tags)
+        if (opts[:id].nil? || opts[:id].empty?) &&
+           (opts[:alias].nil? || opts[:alias].empty?)
+          raise ArgumentError, ':id or :alias (but not both) must be provided'
+        end
         client.session.request('update-asset-tags', opts)
       end
 
       # Executes a query, returning an enumerable over individual assets.
-      # @param [Hash] opts Options hash
-      # @option opts [String] filter A filter expression.
-      # @option opts [Array<String|Integer>] filter_params A list of values that will be interpolated into the filter expression.
+      # @param [Hash] opts
+      #   Options hash
+      # @option opts [String] filter
+      #   A filter expression.
+      # @option opts [Array<String|Integer>] filter_params
+      #   A list of values that will be interpolated into the filter expression.
+      # @option opts [Integer>] page_size
+      #   The number of items to return in the result set.
       # @return [Query]
       def query(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+          :page_size,
+          :after,
+        )
         Query.new(client, opts)
       end
     end
@@ -81,6 +112,5 @@ module Sequence
         Asset.new(raw)
       end
     end
-
   end
 end