sequence-sdk 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da13e33f0caa12bd428d4a97a545e42603369f68
-  data.tar.gz: b660490b8b64779fa01eb22ddfbb94a609946955
+  metadata.gz: d3f404ef05907abe4fc55a63fb30df360c3f7737
+  data.tar.gz: f0413842e1753dd1900cc1a21817a545536fcc36
 SHA512:
-  metadata.gz: 184219f173c60a722b8f8356801f24897c17dc420c114fbf7609285135ae7dbc211bbc1a23fa185d5a97bb97436e401fdd74751f2eca88eff1e910e14117bab2
-  data.tar.gz: c7309542abbea40fbbd42a29072a1751b61693f06dd133ea4778ff85638fcc62b177916ded02a84b46c936d0b4c7d197a5ed151dc1ddb2da16dec3372d6599ab
+  metadata.gz: 709080c4bc1c622863c7c3cd1d657f0301df71c895fcd3bb98ac77d6838efdf281a0c8982ed4cfdb4893ef4e716d5030c6d8462b3146dfa36a39c1e7555ad1e6
+  data.tar.gz: 268eb83516a6ff005c7e031af68f18a99bae51d92797241d02805c8bbaea0429f28cfa491f0d7d74b1917e9dd180bdf6847fc2de02f67c16c9c21350e7edfc06

data/README.md

@@ -13,17 +13,17 @@ for the language's schedule for security and bug fixes.
 
 Add the following to your `Gemfile`:
 
-```
-gem 'sequence-sdk'
+```ruby
+gem 'sequence-sdk', '~> 1.1.0'
 ```
 
 ### In your code
 
-```
+```ruby
 require 'sequence'
 
 ledger = Sequence::Client.new(
-  ledger: 'ledger',
+  ledger_name: 'ledger',
   credential: '...'
 )
 ```

data/lib/sequence/account.rb

@@ -12,6 +12,7 @@ module Sequence
     attrib :id
 
     # @!attribute [r] alias
+    #   Deprecated. Use {#id} instead.
     #   Unique, user-specified identifier.
     # @return [String]
     attrib :alias
@@ -42,7 +43,10 @@ module Sequence
       # 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<Hash>, Array<Sequence::Key>] keys
       #   The keys used for signing transactions that spend from the account. A
@@ -55,7 +59,7 @@ module Sequence
       #   User-specified key-value data describing the account.
       # @return [Account]
       def create(opts = {})
-        validate_inclusion_of!(opts, :alias, :keys, :quorum, :tags)
+        validate_inclusion_of!(opts, :alias, :id, :keys, :quorum, :tags)
         validate_required!(opts, :keys)
         Account.new(client.session.request('create-account', opts))
       end
@@ -67,6 +71,7 @@ module Sequence
       #   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

data/lib/sequence/action.rb

@@ -60,6 +60,7 @@ module Sequence
     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
@@ -75,6 +76,7 @@ module Sequence
     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
@@ -100,6 +102,14 @@ module Sequence
       # @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(
+      #      filter: 'timestamp > $1',
+      #      filter_params: ['1985-10-26T01:21:00Z']
+      #    ).each do |action|
+      #      puts 'timestamp: ' + action.timestamp
+      #      puts 'amount: ' + action.amount
+      #    end
       def list(opts = {})
         validate_inclusion_of!(
           opts,

data/lib/sequence/client.rb

@@ -12,19 +12,25 @@ module Sequence
   class Client
     # @param [Hash] opts
     #   Options hash
+    # @option opts [String] ledger_name
+    #   Ledger name.
     # @option opts [String] ledger
+    #   Deprecated. Use :ledger_name instead.
     #   Ledger name.
     # @option opts [String] credential
     #   API credential secret.
     # @return [Query]
     def initialize(opts = {})
-      if opts[:ledger].nil? || opts[:ledger].empty?
-        raise ArgumentError, ':ledger must be provided'
+      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'
       end
       if opts[:credential].nil? || opts[:credential].empty?
         raise ArgumentError, ':credential must be provided'
       end
 
+      if opts[:ledger_name].nil? || opts[:ledger_name].empty?
+        opts[:ledger_name] = opts[:ledger]
+      end
       @opts = opts
     end
 

data/lib/sequence/contract.rb

@@ -46,6 +46,7 @@ module Sequence
     attrib :account_id
 
     # @!attribute [r] account_alias
+    #   Deprecated. Use {#account_id} instead
     #   The alias of the account controlling the contract.
     # @return [String]
     attrib :account_alias

data/lib/sequence/http_wrapper.rb

@@ -1,7 +1,6 @@
 require 'net/http'
 require 'net/https'
 require 'openssl'
-require 'thread'
 require 'securerandom'
 
 module Sequence
@@ -59,6 +58,9 @@ module Sequence
             req['Macaroon'] = @macaroon
             req['Discharge-Macaroon'] = @dis_macaroon
           end
+          if !@opts[:user].nil? && !@opts[:pass].nil?
+            req.basic_auth(@opts[:user], @opts[:pass])
+          end
           unless @connection.started?
             @connection.start
           end
@@ -127,7 +129,7 @@ module Sequence
 
       # TLS configuration
       connection.use_ssl = true
-      connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      connection.verify_mode = @opts[:verify_mode] || OpenSSL::SSL::VERIFY_PEER
       [:ca_file, :cert, :key].each do |k|
         next unless @opts.key?(:ssl_params) && @opts[:ssl_params].key?(k)
         connection.send("#{k}=", @opts[:ssl_params][k])

data/lib/sequence/key.rb

@@ -12,6 +12,7 @@ module Sequence
     attrib :id
 
     # @!attribute [r] alias
+    #   Deprecated. Use {#id} instead.
     #   Unique, user-specified identifier of the key.
     # @return [String]
     attrib :alias
@@ -20,11 +21,14 @@ module Sequence
       # Creates a key.
       # @param [Hash] opts
       #   Options hash
+      # @option opts [String] id
+      #   Unique, user-specified identifier of the key.
       # @option opts [String] alias
+      #   Deprecated. Use :id instead.
       #   Unique, user-specified identifier of the key.
       # @return [Key]
       def create(opts = {})
-        validate_inclusion_of!(opts, :alias)
+        validate_inclusion_of!(opts, :alias, :id)
         Key.new(client.session.request('create-key', opts))
       end
 
@@ -32,12 +36,15 @@ module Sequence
       # @param [Hash] opts
       #   Options hash
       # @option opts [Array<String>] aliases
+      #   Deprecated. Use :ids instead.
       #   A list of aliases of keys to retrieve.
+      # @option opts [Array<String>] ids
+      #   A list of ids of keys to retrieve.
       # @option opts [Integer>] page_size
       #   The number of items to return in the result set.
       # @return [Query]
       def query(opts = {})
-        validate_inclusion_of!(opts, :aliases, :page_size, :after)
+        validate_inclusion_of!(opts, :aliases, :ids, :page_size, :after)
         Query.new(client, opts)
       end
     end

data/lib/sequence/session.rb

@@ -11,8 +11,9 @@ module Sequence
       @opts = opts
       @host = @opts[:host] || 'https://api.seq.com'
       @session_host = @opts[:session_host] || 'https://session-api.seq.com'
-      @ledger = @opts[:ledger] || raise(ArgumentError, "missing ledger")
+      @ledger = @opts[:ledger_name] || raise(ArgumentError, "missing ledger_name")
       @macaroon = @opts[:credential] || raise(ArgumentError, "missing credential")
+      @request_id = @opts[:request_id]
 
       # Start at 0 to trigger an immediate refresh
       @refresh_at = 0
@@ -42,7 +43,7 @@ module Sequence
     end
 
     def request(path, body = {})
-      request_full_resp(nil, path, body)[:parsed_body]
+      request_full_resp(@request_id, path, body)[:parsed_body]
     end
 
     def request_full_resp(id, path, body = {})

data/lib/sequence/transaction.rb

@@ -128,6 +128,7 @@ module Sequence
       attrib :source_account_id
 
       # @!attribute [r] source_account_alias
+      #   Deprecated. Use {#source_account_id} instead
       #   The alias of the account serving as the source of asset units. Null
       #   for issuances.
       # @return [String]
@@ -145,6 +146,7 @@ module Sequence
       attrib :destination_account_id
 
       # @!attribute [r] destination_account_alias
+      #   Deprecated. Use {#destination_account_id} instead
       #   The alias of the account receiving the asset units. Null for
       #   retirements.
       # @return [String]
@@ -215,6 +217,7 @@ module Sequence
       #   ID of the account receiving the asset units. You must specify a
       #   destination account ID or alias.
       # @option opts [String] :destination_account_alias
+      #   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] :reference_data
@@ -256,6 +259,7 @@ module Sequence
       #   ID of the account serving as the source of asset units. You must
       #   specify a source account ID, account alias, or contract ID.
       # @option opts [String] :source_account_alias
+      #   Deprecated. Use :source_account_id instead
       #   Alias of the account serving as the source of asset units You must
       #   specify a source account ID, account alias, or contract ID.
       # @option opts [String] :source_contract_id
@@ -265,6 +269,7 @@ module Sequence
       #   ID of the account receiving the asset units. You must specify a
       #   destination account ID or alias.
       # @option opts [String] :destination_account_alias
+      #   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] :reference_data
@@ -317,6 +322,7 @@ module Sequence
       #   ID of the account serving as the source of asset units. You must
       #   specify a source account ID, account alias, or contract ID.
       # @option opts [String] :source_account_alias
+      #   Deprecated. Use :source_account_id instead
       #   Alias of the account serving as the source of asset units You must
       #   specify a source account ID, account alias, or contract ID.
       # @option opts [String] :source_contract_id

data/lib/sequence/version.rb

@@ -1,3 +1,3 @@
 module Sequence
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequence-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,7 @@ files:
 - lib/sequence/transaction.rb
 - lib/sequence/validations.rb
 - lib/sequence/version.rb
-homepage: https://dashboard.seq.com
+homepage: https://github.com/sequence/sequence-sdk-ruby
 licenses:
 - Apache-2.0
 metadata: {}