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

data/lib/sequence/client_module.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative './validations'
-
 module Sequence
   # Base class for ledger client components.
   # @private
   class ClientModule
-    include Sequence::Validations
-
     attr_reader :client
 
     def initialize(client)

data/lib/sequence/errors.rb

@@ -45,12 +45,8 @@ module Sequence
       :seq_code,
       :temporary,
     )
-    # Use {#seq_code} instead.
-    # @deprecated
-    attr_accessor :code
 
     def initialize(body, response)
-      self.code = body['code']
       self.chain_message = body['message']
       self.detail = body['detail']
       self.retriable = body['retriable']

data/lib/sequence/feed.rb

@@ -82,49 +82,46 @@ module Sequence
     end
 
     class ClientModule < Sequence::ClientModule
-      # @param [Hash] opts Parameters for creating a Feed.
-      # @option opts [String] id A unique id for the feed.
-      # @option opts [String] type The type of the feed: "action" or
-      #   "transaction".
-      # @option opts [String] filter A valid filter string. The feed will be
-      #   composed of items that match the filter.
-      # @option opts [Array<String|Integer>] filter_params A list of values that
-      #   will be interpolated into the filter expression.
+      # Create a feed.
+      # @param type [String] The type of the feed: "action" or "transaction".
+      # @param id [String] A unique id for the feed.
+      # @param filter [String] A valid filter string. The feed will be composed
+      #   of items that match the filter.
+      # @param filter_params [Array<String|Integer>] A list of values that will
+      #   be interpolated into the filter expression.
       # @return [Feed] Newly created feed.
-      def create(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :id,
-          :type,
-          :filter,
-          :filter_params,
-        )
-        validate_required!(opts, :type)
-        if opts[:type] != 'action' && opts[:type] != 'transaction'
+      def create(type:, id: nil, filter: nil, filter_params: nil)
+        if type != 'action' && type != 'transaction'
           raise ArgumentError, ':type must equal action or transaction'
         end
-        Feed.new(client.session.request('create-feed', opts), client.session)
+        Feed.new(
+          client.session.request(
+            'create-feed',
+            id: id,
+            type: type,
+            filter: filter,
+            filter_params: filter_params,
+          ),
+          client.session,
+        )
       end
 
-      # Get single feed given an id.
-      # @param [Hash] opts Parameters to get single feed.
-      # @option opts [String] id The unique ID of a feed.
+      # Get feed by id.
+      # @param id [String] The unique ID of a feed.
       # @return [Feed] Requested feed object.
-      def get(opts = {})
-        validate_required!(opts, :id)
-        Feed.new(client.session.request('get-feed', opts), client.session)
+      def get(id:)
+        Feed.new(client.session.request('get-feed', id: id), client.session)
       end
 
-      # @param [Hash] opts
-      # @option opts [String] id The unique ID of a feed.
+      # Delete feed by id.
+      # @option id [String] The unique ID of a feed.
       # @return [void]
-      def delete(opts = {})
-        validate_required!(opts, :id)
-        client.session.request('delete-feed', opts)
+      def delete(id:)
+        client.session.request('delete-feed', id: id)
         nil
       end
 
-      # Executes a query, returning an enumerable over individual feeds.
+      # Execute a query, returning an enumerable over individual feeds.
       # @return [Query]
       def list
         Query.new(client)

data/lib/sequence/flavor.rb

@@ -11,7 +11,7 @@ module Sequence
   # A type or class of value that can be tracked on a ledger.
   class Flavor < ResponseObject
     # @!attribute [r] id
-    #   Unique, auto-generated identifier.
+    #   Unique identifier of the flavor.
     # @return [String]
     attrib :id
 
@@ -21,13 +21,6 @@ module Sequence
     # @return [Array<String>]
     attrib(:key_ids)
 
-    # @!attribute [r] keys
-    #   Deprecated. Use {#key_ids} instead.
-    #   The set of keys used to sign transactions that issue tokens of the
-    #   flavor.
-    # @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 tokens of
     #   the flavor.
@@ -39,74 +32,55 @@ module Sequence
     # @return [Hash]
     attrib :tags
 
-    # @deprecated Use {#key_ids} instead.
     class Key < ResponseObject
       attrib :id
     end
 
     class ClientModule < Sequence::ClientModule
-      # Creates a new flavor in the ledger.
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [String] id
-      #   Unique, user-specified identifier.
-      # @option opts [Array<String>] key_ids
+      # Create a new flavor in the ledger.
+      # @param key_ids [Array<String>]
       #   The set of key IDs used for signing transactions that issue tokens of
       #   the flavor.
-      # @option opts [Array<Hash>, Array<Sequence::Key>] keys
-      #   Deprecated. Use :key_ids instead.
-      #   The set of keys used for signing transactions that issue tokens of the
-      #   flavor. A key can be either a key object, or a hash containing an
-      #   `id` 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 issue tokens of
       #   the flavor. Defaults to the number of keys provided.
-      # @option opts [Hash] tags
+      # @param tags [Hash]
       #   User-specified key-value data describing the flavor.
       # @return [Flavor]
-      def create(opts = {})
-        validate_inclusion_of!(opts, :id, :key_ids, :keys, :quorum, :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
-        Flavor.new(client.session.request('create-flavor', opts))
+      def create(key_ids:, id: nil, quorum: nil, tags: nil)
+        raise ArgumentError, ':key_ids cannot be empty' if key_ids == []
+        Flavor.new(
+          client.session.request(
+            'create-flavor',
+            id: id,
+            key_ids: key_ids,
+            quorum: quorum,
+            tags: tags,
+          ),
+        )
       end
 
-      # Updates a flavor's tags.
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [String] id
+      # Update a flavor's tags.
+      # @param id [String]
       #   The ID of the flavor.
-      # @option opts [Hash] tags
+      # @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, :tags)
-        if opts[:id].nil? || opts[:id].empty?
-          raise ArgumentError, ':id must be provided'
-        end
-        client.session.request('update-flavor-tags', opts)
+      def update_tags(id:, tags: nil)
+        raise ArgumentError, ':id cannot be blank' if id == ''
+        client.session.request('update-flavor-tags', id: id, tags: tags)
       end
 
-      # Executes a query, returning an enumerable over individual flavors.
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [String] filter
+      # Execute a query, returning an enumerable over individual flavors.
+      # @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.
       # @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/http_wrapper.rb

@@ -26,13 +26,10 @@ module Sequence
       Errno::ECONNREFUSED,
     ].freeze
 
-    attr_accessor :dis_macaroon
-
-    def initialize(base_url, macaroon, opts = {})
+    def initialize(base_url, credential, opts = {})
       @mutex = Mutex.new
       @base_url = URI(base_url)
-      @macaroon = macaroon
-      @dis_macaroon = nil
+      @credential = credential
       @opts = opts
       @connection = setup_connection
     end
@@ -57,10 +54,7 @@ module Sequence
           req['Idempotency-Key'] = idempotency_key
           req['Name-Set'] = 'snake'
           req['User-Agent'] = 'chain-sdk-ruby/' + Sequence::VERSION
-          if !@macaroon.nil? && !@dis_macaroon.nil?
-            req['Macaroon'] = @macaroon
-            req['Discharge-Macaroon'] = @dis_macaroon
-          end
+          req['Credential'] = @credential
           if !@opts[:user].nil? && !@opts[:pass].nil?
             req.basic_auth(@opts[:user], @opts[:pass])
           end
@@ -132,10 +126,13 @@ module Sequence
 
       # TLS configuration
       connection.use_ssl = true
-      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])
+      connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      if ENV['SEQTLSVERIFYNONE']
+        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      if ENV['SEQTLSCA']
+        puts "setting ca_file #{ENV['SEQTLSCA']}"
+        connection.ca_file = ENV['SEQTLSCA']
       end
 
       # Timeout configuration

data/lib/sequence/key.rb

@@ -13,46 +13,16 @@ module Sequence
     # @return [String]
     attrib :id
 
-    # @!attribute [r] alias
-    #   Deprecated. Use {#id} instead.
-    #   Unique, user-specified identifier of the key.
-    # @return [String]
-    attrib :alias
-
     class ClientModule < Sequence::ClientModule
-      # 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.
+      # Create a key.
+      # @param id [String]
+      #   Unique identifier. Auto-generated if not specified.
       # @return [Key]
-      def create(opts = {})
-        validate_inclusion_of!(opts, :alias, :id)
-        Key.new(client.session.request('create-key', opts))
-      end
-
-      # @deprecated Use list instead.
-      # Executes a query, returning an enumerable over individual keys.
-      # @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
-      #   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)
+      def create(id: nil)
+        Key.new(client.session.request('create-key', id: id))
       end
 
-      # Lists all keys.
+      # List all keys.
       # Executes a query, returning an enumerable over individual keys.
       # @return [Query]
       def list

data/lib/sequence/page.rb

@@ -12,12 +12,6 @@ module Sequence
     # @return [Array]
     attrib :items
 
-    # @!attribute [r] next
-    # 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]

data/lib/sequence/query.rb

@@ -5,8 +5,6 @@ require_relative './page'
 module Sequence
   class Query
     include ::Enumerable
-    include Sequence::Validations
-
     # @private
     # @return [Client]
     attr_reader :client
@@ -44,24 +42,17 @@ module Sequence
       raise NotImplementedError
     end
 
-    # Returns all objects, blocking until complete.
-    # Deprecated: use
-    # {https://ruby-doc.org/core-2.5.0/Enumerable.html Enumerable}
-    # methods such as to_a instead.
-    # @deprecated
-    def all
-      to_a
-    end
+    alias all to_a
 
     # @private
     def pages
       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)
+    def page(size: nil, cursor: nil)
+      opts = { size: size, cursor: cursor }
+      unless size.nil? || size.zero?
+        opts[:page_size] = size
       end
       @query = @query.merge(opts)
       pages.page
@@ -83,8 +74,7 @@ module Sequence
 
         loop do
           page = Page.new(@fetch.call(@query), @translate)
-          @query = page.next
-
+          @query = { cursor: page.cursor }
           yield page
 
           break if page.last_page
@@ -99,10 +89,7 @@ module Sequence
         Page.new(@fetch.call(@query), @translate)
       end
 
-      # @deprecated
-      def all
-        to_a
-      end
+      alias all to_a
     end
   end
 end

data/lib/sequence/session.rb

@@ -15,35 +15,15 @@ module Sequence
         ArgumentError,
         'missing ledger_name',
       )
-      @macaroon = @opts[:credential] || raise(
+      @credential = @opts[:credential] || raise(
         ArgumentError,
         'missing credential',
       )
-
-      # Start at 0 to trigger an immediate refresh
-      @refresh_at = 0
-
-      # Expect this to get set in #refresh!
-      @team_name = nil
-
-      # This can be used to avoid making an http request to get a
-      # new discharge macaroon.
-      @refresh_method = @opts[:refresh_method]
-      if @refresh_method
-        unless @refresh_method.respond_to?(:call)
-          raise ArgumentError, 'refresh_method is not a lambda'
-        end
-        if @refresh_method.arity != 1
-          raise(
-            ArgumentError,
-            'refresh_method must take 1 argument. (the macaroon)',
-          )
-        end
-      end
-
-      addr = ENV['SEQADDR'] || 'api.seq.com'
-      @session_api = HttpWrapper.new('https://session-' + addr, nil)
-      @ledger_api = HttpWrapper.new('https://' + addr, @macaroon, @opts)
+      @team_name = @opts[:team_name] || raise(
+        ArgumentError,
+        'missing team_name',
+      )
+      @ledger_api = HttpWrapper.new('https://' + @opts[:addr], @credential, @opts)
     end
 
     def dup
@@ -55,7 +35,6 @@ module Sequence
     end
 
     def request_full_resp(id, path, body = {})
-      refresh!(id)
       id ||= SecureRandom.hex(10)
       @ledger_api.post(id, ledger_url(path), body) do |response|
         # require that the response contains the Chain-Request-ID
@@ -77,23 +56,5 @@ module Sequence
       path = path[1..-1] if path.start_with?('/')
       "/#{@team_name}/#{@ledger}/#{path}"
     end
-
-    def refresh!(id)
-      return if @refresh_at > Time.now.to_i
-
-      if @refresh_method
-        result = @refresh_method.call(@macaroon)
-      else
-        result = @session_api.post(
-          id,
-          '/sessions/validate',
-          macaroon: @macaroon,
-        )[:parsed_body]
-      end
-
-      @team_name = result['team_name']
-      @refresh_at = Integer(result['refresh_at'])
-      @ledger_api.dis_macaroon = result['refresh_token']
-    end
   end
 end