sequence-sdk 1.5.2 → 2.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3b88f59594a3357d97526b9cf9710abb67faa89b
-  data.tar.gz: 9a40a16ed0dc8ebbba81427678c896252f5076f1
+SHA256:
+  metadata.gz: aa8125eb52fe8dbf7b905442ded7cae137c144161723ec224fffde4640dee208
+  data.tar.gz: 283e350688c0bea9a07c375ae6502743f0ceb50442a2a9398bc2673604c67736
 SHA512:
-  metadata.gz: 25ef34d1bd3bb887588eed59d26a94e147bf75670656c0dd14333e65aba9aa6c724fa63ff89797f8652bc54063c4703ffda2ebaf74a937c5d1208036a7da7bf7
-  data.tar.gz: 07f70a61daff65872b8e75c022d04116a7bdb471c1cb92f503117d2bde22a78d168d1a3d903001a83148043f58817f675ee9c5309adf61a846fcfccdf716fabf
+  metadata.gz: 7e3209b59c2b9e36a8c8e9e19926a923c23080cb31d46bed62425e2d4bde804b1924889caa3c4c8d0242e91c2d7622bd129ef44be388f6bbf8633a195b465737
+  data.tar.gz: c1d1a73d56753146d5c78788743d553cd0c74975d133bad62ea8586787b5fc3d87efddd47a78a7feb53bece656643eb4b3d069f18fff2f8c3c5af4316bf0df16

data/README.md

@@ -7,14 +7,14 @@
 The Ruby SDK is available
 [via Rubygems](https://rubygems.org/gems/sequence-sdk).
 
-Ruby >= 2.2 is required. We recommend upgrading to Ruby >= 2.3. See
+Ruby >= 2.3 is required. See
 [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/)
 for the language's schedule for security and bug fixes.
 
 Add the following to your `Gemfile`:
 
 ```ruby
-gem 'sequence-sdk', '~> 1.5.2'
+gem 'sequence-sdk', '~> 2-rc.1'
 ```
 
 ### In your code

data/lib/sequence/account.rb

@@ -6,32 +6,20 @@ require_relative './query'
 require_relative './response_object'
 
 module Sequence
-  # A container for asset balances on a ledger.
+  # An account is an object in Sequence that tracks ownership of tokens on a
+  # blockchain by creating and tracking control programs.
   class Account < ResponseObject
     # @!attribute [r] id
-    #   Unique, auto-generated identifier.
+    #   Unique identifier of the account.
     # @return [String]
     attrib :id
 
-    # @!attribute [r] alias
-    #   Deprecated. Use {#id} instead.
-    #   Unique, user-specified identifier.
-    # @return [String]
-    attrib :alias
-
     # @!attribute [r] key_ids
     #   The set of key IDs used for signing transactions that spend from the
     #   account.
     # @return [Array<String>]
     attrib(:key_ids)
 
-    # @!attribute [r] keys
-    #   Deprecated. Use {#key_ids} instead.
-    #   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.
@@ -43,115 +31,54 @@ module Sequence
     # @return [Hash]
     attrib :tags
 
-    # @deprecated Use {#key_ids} instead.
     class Key < ResponseObject
       attrib :id
-      attrib :alias
     end
 
     class ClientModule < Sequence::ClientModule
-      # Creates a new account in the ledger.
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [String] id
-      #   Unique, user-specified identifier.
-      # @option opts [String] alias
-      #   Deprecated. Use :id instead.
-      #   Unique, user-specified identifier.
-      # @option opts [Array<String>] key_ids
+      # Create a new account in the ledger.
+      # @param key_ids [Array<String>]
       #   The key IDs used for signing transactions that spend from the account.
-      # @option opts [Array<Hash>, Array<Sequence::Key>] keys
-      #   Deprecated. Use :key_ids instead.
-      #   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
+      # @param id [String]
+      #   Unique identifier. Auto-generated if not specified.
+      # @param quorum [Integer]
       #   The number of keys required to sign transactions that spend from the
       #   account. Defaults to the number of keys provided.
-      # @option opts [Hash] tags
+      # @param tags [Hash]
       #   User-specified key-value data describing the account.
       # @return [Account]
-      def create(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :alias,
-          :id,
-          :key_ids,
-          :keys,
-          :quorum,
-          :tags,
+      def create(key_ids:, id: nil, quorum: nil, tags: nil)
+        raise ArgumentError, ':key_ids cannot be empty' if key_ids == []
+        Account.new(
+          client.session.request(
+            'create-account',
+            id: id,
+            key_ids: key_ids,
+            quorum: quorum,
+            tags: tags,
+          ),
         )
-        if (opts[:key_ids].nil? || opts[:key_ids].empty?) &&
-           (opts[:keys].nil? || opts[:keys].empty?)
-          raise(
-            ArgumentError,
-            ':key_ids or :keys (but not both) must be provided',
-          )
-        end
-        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
-      #   Deprecated. Use :id instead.
-      #   The alias of the account. Either an ID or alias should be provided,
-      #   but not both.
-      # @option opts [Hash] tags
+      # Update an account's tags.
+      # @param id [String]
+      #   The ID of the account.
+      # @param tags [Hash]
       #   A new set of tags, which will replace the existing tags.
       # @return [void]
-      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)
+      def update_tags(id:, tags: nil)
+        raise ArgumentError, ':id cannot be blank' if id == ''
+        client.session.request('update-account-tags', id: id, tags: tags)
       end
 
-      # @deprecated Use list instead.
-      # Executes a query, returning an enumerable over individual accounts.
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [String] filter
+      # Filter accounts.
+      # @param filter [String]
       #   A filter expression.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   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 = {})
-        validate_inclusion_of!(
-          opts,
-          :filter,
-          :filter_params,
-          :page_size,
-          :after,
-        )
-        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)
+      def list(filter: nil, filter_params: nil)
+        Query.new(client, filter: filter, filter_params: filter_params)
       end
     end
 

data/lib/sequence/action.rb

@@ -53,79 +53,27 @@ module Sequence
     # @return [Hash]
     attrib :snapshot, snapshot: true
 
-    # @!attribute [r] asset_id
-    #   Deprecated. Use {#flavor_id} instead.
-    #   The ID of the asset held by the action.
-    # @return [String]
-    attrib :asset_id
-
-    # @!attribute [r] asset_alias
-    #   Deprecated. Use {#flavor_id} instead.
-    #   The alias of the asset held by the action.
-    # @return [String]
-    attrib :asset_alias
-
-    # @!attribute [r] asset_tags
-    #   Deprecated. Use {#snapshot} instead.
-    #   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
-    #   Deprecated. Use {#source_account_id} instead.
-    #   The alias of the source account executing the action.
-    # @return [String]
-    attrib :source_account_alias
-
-    # @!attribute [r] source_account_tags
-    #   Deprecated. Use {#snapshot} instead.
-    #   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
-    #   Deprecated. Use {#destination_account_id} instead.
-    #   The alias of the destination account affected by the action.
-    # @return [String]
-    attrib :destination_account_alias
-
-    # @!attribute [r] destination_account_tags
-    #   Deprecated. Use {#snapshot} instead.
-    #   The tags of the destination account affected by the action.
-    # @return [Hash]
-    attrib :destination_account_tags
-
     # @!attribute [r] tags
     #   User-specified key-value data embedded in the action.
     # @return [Hash]
     attrib :tags
 
-    # @!attribute [r] reference_data
-    #   Deprecated. Use {#tags} instead.
-    #   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
+      # Execute a query, returning an enumerable over individual actions.
+      # @param filter [String]
       #   A filter expression.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   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]
       # @example List all actions after a certain time
       #    ledger.actions.list(
@@ -135,38 +83,25 @@ module Sequence
       #      puts 'timestamp: ' + action.timestamp
       #      puts 'amount: ' + action.amount
       #    end
-      def list(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :filter,
-          :filter_params,
-          :page_size,
-          :after,
-        )
-        ListQuery.new(client, opts)
+      def list(filter: nil, filter_params: nil)
+        ListQuery.new(client, filter: filter, filter_params: filter_params)
       end
 
-      # Executes a query, returning an enumerable over individual actionsums.
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [String] filter
+      # Execute a query, returning an enumerable over sums of actions.
+      # @param filter [String]
       #   A filter expression.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   A list of values that will be interpolated into the filter expression.
-      # @option opts [Array<String>] group_by
+      # @param group_by [Array<String>]
       #   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,
+      def sum(filter: nil, filter_params: nil, group_by: nil)
+        SumQuery.new(
+          client,
+          filter: filter,
+          filter_params: filter_params,
+          group_by: group_by,
         )
-        SumQuery.new(client, opts)
       end
     end
 

data/lib/sequence/client.rb

@@ -2,12 +2,10 @@
 
 require_relative './account'
 require_relative './action'
-require_relative './asset'
-require_relative './balance'
-require_relative './contract'
 require_relative './dev_utils'
 require_relative './feed'
 require_relative './flavor'
+require_relative './http_wrapper'
 require_relative './key'
 require_relative './stats'
 require_relative './token'
@@ -15,28 +13,29 @@ require_relative './transaction'
 
 module Sequence
   class Client
-    # @param [Hash] opts
-    #   Options hash
-    # @option opts [String] ledger_name
+    # Set up a Sequence client.
+    # This is the entry point for all other Sequence interaction.
+    # @param ledger_name [String]
     #   Ledger name.
-    # @option opts [String] ledger
-    #   Deprecated. Use :ledger_name instead.
-    #   Ledger name.
-    # @option opts [String] credential
+    # @param credential [String]
     #   API credential secret.
     # @return [Query]
-    def initialize(opts = {})
-      if (opts[:ledger_name].nil? || opts[:ledger_name].empty?) == (opts[:ledger].nil? || opts[:ledger].empty?)
-        raise ArgumentError, ':ledger_name or :ledger (but not both) must be provided'
+    def initialize(ledger_name:, credential:)
+      if ledger_name.nil? || ledger_name == ''
+        raise ArgumentError, ':ledger_name cannot be blank'
       end
-      if opts[:credential].nil? || opts[:credential].empty?
-        raise ArgumentError, ':credential must be provided'
+      if credential.nil? || credential == ''
+        raise ArgumentError, ':credential cannot be blank'
       end
 
-      if opts[:ledger_name].nil? || opts[:ledger_name].empty?
-        opts[:ledger_name] = opts[:ledger]
-      end
-      @opts = opts
+      addr = ENV['SEQADDR'] || 'api.seq.com'
+      api = HttpWrapper.new('https://' + addr, credential)
+      @opts = {
+        addr: addr,
+        credential: credential,
+        ledger_name: ledger_name,
+        team_name: team_name(api),
+      }
     end
 
     # @private
@@ -55,11 +54,6 @@ module Sequence
       @accounts ||= Account::ClientModule.new(self)
     end
 
-    # @return [Asset::ClientModule]
-    def assets
-      @assets ||= Asset::ClientModule.new(self)
-    end
-
     # @return [Flavor::ClientModule]
     def flavors
       @flavors ||= Flavor::ClientModule.new(self)
@@ -70,11 +64,6 @@ module Sequence
       @actions ||= Action::ClientModule.new(self)
     end
 
-    # @return [Balance::ClientModule]
-    def balances
-      @balances ||= Balance::ClientModule.new(self)
-    end
-
     # @return [Key::ClientModule]
     def keys
       @keys ||= Key::ClientModule.new(self)
@@ -95,11 +84,6 @@ module Sequence
       @feeds ||= Feed::ClientModule.new(self)
     end
 
-    # @return [Contract::ClientModule]
-    def contracts
-      @contracts ||= Contract::ClientModule.new(self)
-    end
-
     # @private
     # @return [Stats::ClientModule]
     def stats
@@ -110,5 +94,11 @@ module Sequence
     def dev_utils
       @dev_utils ||= DevUtils::ClientModule.new(self)
     end
+
+    private
+
+    def team_name(api)
+      api.post(SecureRandom.hex(10), '/hello', {})[:parsed_body]['team_name']
+    end
   end
 end