sequence-sdk 1.2.0 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7b66d906a04f01900203dc177533f0553b9a50c8
-  data.tar.gz: 71e07a3fd57e6ef1139883bfa2028dc1ffe983af
+SHA256:
+  metadata.gz: e09d4689bbc276d717124a3bc897d1a39fb8d2615f42e6ef5b034dd83baa2b9c
+  data.tar.gz: 2c045c5197ca3fadf832f94db50bdfd5d7644f403c1c6c02d048b01570c30033
 SHA512:
-  metadata.gz: a8e2b3b1d2203f6dec039726340dcb4eb6e36b4625923ac1f861e8a00b1bcc972979dab084a6266b118e4ad5d6fcec47b12aa9c1339dd3413c52d6ef0b6fadd8
-  data.tar.gz: 7ff33dc5a42c4be3e5552071095f458082ccdeaf3c5fda1765301e3c5cbf362b566b5b7a60f62fc57d2f8489bb876ad0935930a95da7983aac86f4b894e75075
+  metadata.gz: 787a26b9b6d8a199ba3a22e665a3ef670bcf35427c36b83289b0406a07db2aa494847b558f5800dd4941879d51aaba15d91289902e511314c7a782be2d3cf143
+  data.tar.gz: 9e54a051eff305522130abf1073720ce3b0dedf1e4def79d0a4435fddab759c9ac60429948ac4db486b253f1dd83c81bc3767fe07b8e5ffb6fb97b291030cb8b

data/README.md

@@ -14,7 +14,7 @@ for the language's schedule for security and bug fixes.
 Add the following to your `Gemfile`:
 
 ```ruby
-gem 'sequence-sdk', '~> 1.2.0'
+gem 'sequence-sdk', '~> 1.3.0'
 ```
 
 ### In your code

data/lib/sequence/account.rb

@@ -94,6 +94,7 @@ module Sequence
       # @option opts [Array<String|Integer>] filter_params
       #   A list of values that will be interpolated into the filter expression.
       # @option opts [Integer>] page_size
+      #   Deprecated. Use list.page(size: size) instead.
       #   The number of items to return in the result set.
       # @return [Query]
       def query(opts = {})
@@ -106,6 +107,24 @@ module Sequence
         )
         Query.new(client, opts)
       end
+
+      # Filters 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.
+      # @return [Query]
+      def list(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+        )
+        Query.new(client, opts)
+      end
     end
 
     class Query < Sequence::Query

data/lib/sequence/action.rb

@@ -45,8 +45,9 @@ module Sequence
     attrib :flavor_id
 
     # @!attribute [r] snapshot
-    #   A copy of the associated tags (flavor, source account, and destination
-    #   account) as they existed at the time of the transaction.
+    #   A copy of the associated tags (flavor, source account, destination
+    #   account, action, and token) as they existed at the time of the
+    #   transaction.
     # @return [Hash]
     attrib :snapshot
 

data/lib/sequence/balance.rb

@@ -6,6 +6,7 @@ module Sequence
   # A summation of contract amounts. Contracts are selected using a filter, and
   # their values are summed using the common values of one or more contract
   # fields.
+  # @deprecated Use {Token::ClientModule#sum} instead.
   class Balance < ResponseObject
     # @!attribute [r] amount
     #   Summation of contract amounts.

data/lib/sequence/client.rb

@@ -7,6 +7,7 @@ require_relative './dev_utils'
 require_relative './flavor'
 require_relative './key'
 require_relative './stats'
+require_relative './token'
 require_relative './transaction'
 
 module Sequence
@@ -76,6 +77,11 @@ module Sequence
       @keys ||= Key::ClientModule.new(self)
     end
 
+    # @return [Token::ClientModule]
+    def tokens
+      @tokens ||= Token::ClientModule.new(self)
+    end
+
     # @return [Transaction::ClientModule]
     def transactions
       @transactions ||= Transaction::ClientModule.new(self)

data/lib/sequence/contract.rb

@@ -4,6 +4,7 @@ require_relative './query'
 
 module Sequence
   # An entry in the ledger that contains value that can be spent.
+  # @deprecated Use {Token::ClientModule#list} instead.
   class Contract < ResponseObject
     # @!attribute [r] id
     #   A unique ID.

data/lib/sequence/flavor.rb

@@ -55,7 +55,6 @@ module Sequence
         if opts[:keys].nil? || opts[:keys].empty?
           raise ArgumentError, ':keys must be provided'
         end
-        opts = { client_token: SecureRandom.uuid }.merge(opts)
         Flavor.new(client.session.request('create-flavor', opts))
       end
 
@@ -69,7 +68,7 @@ module Sequence
       # @return [void]
       def update_tags(opts = {})
         validate_inclusion_of!(opts, :id, :tags)
-        if (opts[:id].nil? || opts[:id].empty?)
+        if opts[:id].nil? || opts[:id].empty?
           raise ArgumentError, ':id must be provided'
         end
         client.session.request('update-flavor-tags', opts)
@@ -88,8 +87,6 @@ module Sequence
           opts,
           :filter,
           :filter_params,
-          :page_size,
-          :after,
         )
         Query.new(client, opts)
       end

data/lib/sequence/http_wrapper.rb

@@ -26,9 +26,9 @@ module Sequence
 
     attr_accessor :dis_macaroon
 
-    def initialize(host, macaroon, opts = {})
+    def initialize(base_url, macaroon, opts = {})
       @mutex = Mutex.new
-      @host = URI(host)
+      @base_url = URI(base_url)
       @macaroon = macaroon
       @dis_macaroon = nil
       @opts = opts
@@ -114,13 +114,7 @@ module Sequence
     end
 
     def setup_connection
-      args = [@host.hostname, @host.port]
-
-      # Override host+port for local development.
-      env_addr = ENV['SEQADDR']
-      if env_addr
-        args = (env_addr.split(':') + [nil])[0...2]
-      end
+      args = [@base_url.hostname, @base_url.port]
 
       # Proxy configuration
       if @opts.key?(:proxy_addr)

data/lib/sequence/key.rb

@@ -41,12 +41,20 @@ module Sequence
       # @option opts [Array<String>] ids
       #   A list of ids of keys to retrieve.
       # @option opts [Integer>] page_size
+      #   Deprecated. Use list.page(size: size) instead.
       #   The number of items to return in the result set.
       # @return [Query]
       def query(opts = {})
         validate_inclusion_of!(opts, :aliases, :ids, :page_size, :after)
         Query.new(client, opts)
       end
+
+      # Lists all keys.
+      # Executes a query, returning an enumerable over individual keys.
+      # @return [Query]
+      def list
+        Query.new(client)
+      end
     end
 
     class Query < Sequence::Query

data/lib/sequence/page.rb

@@ -3,18 +3,26 @@ require_relative './response_object'
 module Sequence
   # @private
   class Page < ResponseObject
+    include ::Enumerable
+
     # @!attribute [r] items
     # List of items.
     # @return [Array]
     attrib :items
 
     # @!attribute [r] next
-    # Query object to request next page of items
+    # Deprecated. Use {#cursor} instead.
+    # Query object to request next page of items.
     # @return [Hash]
     attrib :next
 
+    # @!attribute [r] cursor
+    # String encoding the query object to request the next page of items.
+    # @return [String]
+    attrib :cursor
+
     # @!attribute [r] last_page
-    # Indicator of whether there are more pages to load
+    # Indicator of whether there are more pages to load.
     # @return [Boolean]
     attrib :last_page
 
@@ -22,5 +30,11 @@ module Sequence
       super(raw_attribs)
       @items = @items.map { |i| translate.call(i) }
     end
+
+    def each
+      @items.to_a.each do |item|
+        yield item
+      end
+    end
   end
 end

data/lib/sequence/query.rb

@@ -3,6 +3,7 @@ require_relative './page'
 module Sequence
   class Query
     include ::Enumerable
+    include Sequence::Validations
 
     # @private
     # @return [Client]
@@ -48,6 +49,15 @@ module Sequence
       PageQuery.new(client, query, method(:fetch), method(:translate))
     end
 
+    def page(opts = {})
+      validate_inclusion_of!(opts, :size, :cursor)
+      unless opts[:size].nil? || opts[:size].zero?
+        opts[:page_size] = opts.delete(:size)
+      end
+      @query = @query.merge(opts)
+      pages.page
+    end
+
     # @private
     class PageQuery
       include ::Enumerable
@@ -76,6 +86,10 @@ module Sequence
         end
       end
 
+      def page
+        Page.new(@fetch.call(@query), @translate)
+      end
+
       alias_method :all, :to_a
     end
   end

data/lib/sequence/session.rb

@@ -9,8 +9,6 @@ module Sequence
   class Session
     def initialize(opts)
       @opts = opts
-      @host = @opts[:host] || 'https://api.seq.com'
-      @session_host = @opts[:session_host] || 'https://session-api.seq.com'
       @ledger = @opts[:ledger_name] || raise(ArgumentError, "missing ledger_name")
       @macaroon = @opts[:credential] || raise(ArgumentError, "missing credential")
 
@@ -32,8 +30,9 @@ module Sequence
         end
       end
 
-      @session_api = HttpWrapper.new(@session_host, nil)
-      @ledger_api = HttpWrapper.new(@host, @macaroon, @opts)
+      addr = ENV['SEQADDR'] || 'api.seq.com'
+      @session_api = HttpWrapper.new('https://session-' + addr, nil)
+      @ledger_api = HttpWrapper.new('https://' + addr, @macaroon, @opts)
     end
 
     def dup

data/lib/sequence/token.rb

@@ -0,0 +1,134 @@
+require_relative './client_module'
+require_relative './response_object'
+require_relative './query'
+
+module Sequence
+  #  More info: {https://dashboard.seq.com/docs/tokens}
+  module Token
+    class ClientModule < Sequence::ClientModule
+      # @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.
+      # @return [Query]
+      def list(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+        )
+        GroupQuery.new(client, opts)
+      end
+
+      # @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 token fields to be summed.
+      # @return [Query]
+      def sum(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+          :group_by,
+        )
+        SumQuery.new(client, opts)
+      end
+    end
+
+    class GroupQuery < Sequence::Query
+      def fetch(query)
+        client.session.request('list-tokens', query)
+      end
+
+      def translate(raw)
+        Group.new(raw)
+      end
+    end
+
+    class Group < Sequence::ResponseObject
+      # @!attribute [r] amount
+      #   The amount of tokens in the group.
+      # @return [Integer]
+      attrib :amount
+
+      # @!attribute [r] flavor_id
+      #   The flavor of the tokens in the group.
+      # @return [String]
+      attrib :flavor_id
+
+      # @!attribute [r] flavor_tags
+      #   The tags of the flavor of the tokens in the group.
+      # @return [Hash]
+      attrib :flavor_tags
+
+      # @!attribute [r] account_id
+      #   The account containing the tokens.
+      # @return [String]
+      attrib :account_id
+
+      # @!attribute [r] account_tags
+      #   The tags of the account containing the tokens.
+      # @return [Hash]
+      attrib :account_tags
+
+      # @!attribute [r] tags
+      #   The tags of the tokens in the group.
+      # @return [Hash]
+      attrib :tags
+    end
+
+    class SumQuery < Sequence::Query
+      def fetch(query)
+        client.session.request('sum-tokens', query)
+      end
+
+      def translate(raw)
+        Sum.new(raw)
+      end
+    end
+
+    class Sum < Sequence::ResponseObject
+      # @!attribute [r] amount
+      #   The amount of tokens in the group.
+      # @return [Integer]
+      attrib :amount
+
+      # @!attribute [r] flavor_id
+      #   The flavor of the tokens in the group.
+      #   Is nil unless included in `group_by` request parameter.
+      # @return [String]
+      attrib :flavor_id
+
+      # @!attribute [r] flavor_tags
+      #   The tags of the flavor of the tokens in the group.
+      #   Is nil unless included in `group_by` request parameter.
+      # @return [Hash]
+      attrib :flavor_tags
+
+      # @!attribute [r] account_id
+      #   The account containing the tokens.
+      #   Is nil unless included in `group_by` request parameter.
+      # @return [String]
+      attrib :account_id
+
+      # @!attribute [r] account_tags
+      #   The tags of the account containing the tokens.
+      #   Is nil unless included in `group_by` request parameter.
+      # @return [Hash]
+      attrib :account_tags
+
+      # @!attribute [r] tags
+      #   The tags of the tokens in the group.
+      #   Is nil unless included in `group_by` request parameter.
+      # @return [Hash]
+      attrib :tags
+    end
+  end
+end

data/lib/sequence/transaction.rb

@@ -25,6 +25,12 @@ module Sequence
     # @return [Integer]
     attrib :sequence_number
 
+    # @!attribute [r] token_tags
+    #   User specified, unstructured data embedded within a token
+    #   (possibly null).
+    # @return [Hash]
+    attrib :token_tags
+
     # @!attribute [r] reference_data
     #   User-specified key-value data embedded into the transaction.
     # @return [Hash]
@@ -76,11 +82,28 @@ module Sequence
       #   A Unix timestamp in milliseconds of the most recent transaction
       #   timestamp to include in the query results.
       # @option opts [Integer>] page_size
+      #   Deprecated. Use list.page(size: size) instead.
       #   The number of items to return in the result set.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)
       end
+
+      # Executes a query, returning an enumerable over individual transactions.
+      # @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.
+      # @return [Query]
+      def list(opts = {})
+        validate_inclusion_of!(
+          opts,
+          :filter,
+          :filter_params,
+        )
+        Query.new(client, opts)
+      end
     end
 
     class Query < Sequence::Query
@@ -107,8 +130,9 @@ module Sequence
       attrib :flavor_id
 
       # @!attribute [r] snapshot
-      #   A copy of the associated tags (flavor, source account, and destination
-      #   account) as they existed at the time of the transaction.
+      #   A copy of the associated tags (flavor, source account, destination
+      #   account, action, and token) as they existed at the time of the
+      #   transaction.
       # @return [Hash]
       attrib :snapshot
 
@@ -241,6 +265,8 @@ module Sequence
       #   Deprecated. Use :destination_account_id instead.
       #   Alias of the account receiving the asset units. You must specify a
       #   destination account ID or alias.
+      # @option opts [Hash] :token_tags
+      #   Tags to add to the receiving tokens.
       # @option opts [Hash] :reference_data
       #   Reference data for the action.
       # @return [Builder]
@@ -253,6 +279,7 @@ module Sequence
           :asset_alias,
           :destination_account_id,
           :destination_account_alias,
+          :token_tags,
           :reference_data,
         )
         validate_either!(opts, :flavor_id, :asset_id, :asset_alias)
@@ -277,6 +304,10 @@ module Sequence
       #   Deprecated. Use :flavor_id instead.
       #   ID of the asset to be transferred. You must specify either an ID or an
       #   alias.
+      # @option opts [String] filter
+      #   Token filter string. See {https://dashboard.seq.com/docs/filters}.
+      # @option opts [Array<String|Integer>] filter_params
+      #   A list of parameter values for filter string (if needed).
       # @option opts [String] :asset_alias
       #   Deprecated. Use :flavor_id instead.
       #   Asset alias of the asset to be transferred. You must specify either an
@@ -298,9 +329,12 @@ module Sequence
       #   Deprecated. Use :destination_account_id instead.
       #   Alias of the account receiving the asset units. You must specify a
       #   destination account ID or alias.
+      # @option opts [Hash] :token_tags
+      #   Tags to add to the receiving tokens.
       # @option opts [Hash] :reference_data
       #   reference data for the action.
       # @option opts [Hash] :change_reference_data
+      #   Deprecated. This happens automatically when using token tags.
       #   reference data for the change contract.
       # @return [Builder]
       def transfer(opts = {})
@@ -308,6 +342,8 @@ module Sequence
           opts,
           :amount,
           :flavor_id,
+          :filter,
+          :filter_params,
           :asset_id,
           :asset_alias,
           :source_account_id,
@@ -315,6 +351,7 @@ module Sequence
           :source_contract_id,
           :destination_account_id,
           :destination_account_alias,
+          :token_tags,
           :reference_data,
           :change_reference_data,
         )
@@ -341,6 +378,10 @@ module Sequence
       #   Amount of the flavor to be retired.
       # @option opts [String] :flavor_id
       #   ID of the flavor to be retired.
+      # @option opts [String] filter
+      #   Token filter string. See {https://dashboard.seq.com/docs/filters}.
+      # @option opts [Array<String|Integer>] filter_params
+      #   A list of parameter values for filter string (if needed).
       # @option opts [String] :asset_id
       #   Deprecated. Use :flavor_id instead.
       #   ID of the asset to be retired. You must specify either an ID or an
@@ -362,6 +403,7 @@ module Sequence
       # @option opts [Hash] :reference_data
       #   Reference data for the action.
       # @option opts [Hash] :change_reference_data
+      #   Deprecated. This happens automatically when using token tags.
       #   Reference data for the change contract.
       # @return [Builder]
       def retire(opts = {})
@@ -369,6 +411,8 @@ module Sequence
           opts,
           :amount,
           :flavor_id,
+          :filter,
+          :filter_params,
           :asset_id,
           :asset_alias,
           :source_account_id,

data/lib/sequence/version.rb

@@ -1,3 +1,3 @@
 module Sequence
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequence-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: '1.3'
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies: []
 description: SDK for Sequence
 email: 
@@ -36,6 +36,7 @@ files:
 - lib/sequence/response_object.rb
 - lib/sequence/session.rb
 - lib/sequence/stats.rb
+- lib/sequence/token.rb
 - lib/sequence/transaction.rb
 - lib/sequence/validations.rb
 - lib/sequence/version.rb
@@ -59,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SDK for Sequence