sequence-sdk 2.1 → 2.2.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da2edb02eda3ac971bd102181b56b78339a16a30d12c7c06c123569a09180584
-  data.tar.gz: a8e9ffb7f528e3679f817ab2b06e1399ed90013d474601dcbb01f8e92e2a5cd1
+  metadata.gz: 6246691bbc9fe8915c626d2013e33c0dbb4950606d3a56a505365889e26c1660
+  data.tar.gz: 18be34a81476f9cb75855aef2126f68e2fa36f8849ea727e1bef278b40a442c3
 SHA512:
-  metadata.gz: 807d33a14ca05d631003907294f6e2ca6f0618838615907853feb071f661a98268b26b5f70216670a8d36ac2c2ae32540cacd02ffba18461655c8729bf784df7
-  data.tar.gz: ea5d6ec64d2809b8a744efdf178b5ffde5721499f706652427c2dbe0e5ff556493b1fa327f09835d0150917e8bb1198950997f0c07b132002cb9b1df008257ab
+  metadata.gz: 88bbd9ececed4673dd0dc2547ca3e1feb1a02bcb5e23366dbe906f5106832f6da18c2c0114e2cd3de15bb50911569b929df56c75de597db773e39c329090a821
+  data.tar.gz: b4a4340dd743d635d52a17c6977e5ed589ed38b344026054337273fdb2d00f2d21aeeb7a0217aff0b12deedc10ef1e8f4c62fad5f69c55e4e0c4ff9b0d263e32

data/lib/sequence/action.rb

@@ -87,6 +87,17 @@ module Sequence
         ListQuery.new(client, filter: filter, filter_params: filter_params)
       end
 
+      # Update an action's tags.
+      # @param id [String]
+      #    The ID of the action.
+      # @param tags [Hash]
+      #    A new set of tags, which will replace the existing tags.
+      # @return [void]
+      def update_tags(id:, tags: nil)
+        raise ArgumentError, ':id cannot be blank' if id == ''
+        client.session.request('update-action-tags', id: id, tags: tags)
+      end
+
       # Execute a query, returning an enumerable over sums of actions.
       # @param filter [String]
       #   A filter expression.

data/lib/sequence/client.rb

@@ -6,6 +6,7 @@ require_relative './dev_utils'
 require_relative './feed'
 require_relative './flavor'
 require_relative './http_wrapper'
+require_relative './index'
 require_relative './key'
 require_relative './stats'
 require_relative './token'
@@ -28,14 +29,11 @@ module Sequence
         raise ArgumentError, ':credential cannot be blank'
       end
 
-      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),
       }
+      @session = Session.new(@opts)
     end
 
     # @private
@@ -45,23 +43,31 @@ module Sequence
 
     # @private
     # @return [Session]
-    def session
-      @session ||= Session.new(@opts)
-    end
+    attr_reader :session
 
     # @return [Account::ClientModule]
     def accounts
       @accounts ||= Account::ClientModule.new(self)
     end
 
+    # @return [Action::ClientModule]
+    def actions
+      @actions ||= Action::ClientModule.new(self)
+    end
+
+    # @return [Feed::ClientModule]
+    def feeds
+      @feeds ||= Feed::ClientModule.new(self)
+    end
+
     # @return [Flavor::ClientModule]
     def flavors
       @flavors ||= Flavor::ClientModule.new(self)
     end
 
-    # @return [Action::ClientModule]
-    def actions
-      @actions ||= Action::ClientModule.new(self)
+    # @return [Index::ClientModule]
+    def indexes
+      @indexes ||= Index::ClientModule.new(self)
     end
 
     # @return [Key::ClientModule]
@@ -69,6 +75,12 @@ module Sequence
       @keys ||= Key::ClientModule.new(self)
     end
 
+    # @private
+    # @return [Stats::ClientModule]
+    def stats
+      @stats ||= Stats::ClientModule.new(self)
+    end
+
     # @return [Token::ClientModule]
     def tokens
       @tokens ||= Token::ClientModule.new(self)
@@ -79,26 +91,9 @@ module Sequence
       @transactions ||= Transaction::ClientModule.new(self)
     end
 
-    # @return [Feed::ClientModule]
-    def feeds
-      @feeds ||= Feed::ClientModule.new(self)
-    end
-
-    # @private
-    # @return [Stats::ClientModule]
-    def stats
-      @stats ||= Stats::ClientModule.new(self)
-    end
-
     # @return [DevUtils::ClientModule]
     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

data/lib/sequence/hello.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Sequence
+  # @private
+  class Hello
+    def initialize(api)
+      @api = api
+    end
+
+    def call
+      b = @api.post(SecureRandom.hex(10), '/hello', {})[:parsed_body]
+      [b['team_name'], b['addr'], b['addr_ttl_seconds'].to_i]
+    end
+  end
+end

data/lib/sequence/index.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative './client_module'
+require_relative './session'
+require_relative './query'
+require_relative './response_object'
+
+module Sequence
+  # Indexes are used to precompute queries that could
+  # potentially be slow. When an application submits a
+  # query where the filter and group-by params match
+  # one of the defined indexes, the results can be
+  # returned from quickly from precomputed storage.
+  class Index < ResponseObject
+    # @!attribute [r] id
+    # Unique identifier of the index
+    # @return [String]
+    attrib :id
+
+    # @!attribute [r] type
+    # Type of index, "action" or "token".
+    # @return [String]
+    attrib :type
+
+    # @!attribute [r] filter
+    # The query filter used to select matching items.
+    # @return [String]
+    attrib :filter
+
+    # @!attribute [r] group_by
+    # Token/Action object fields to group by.
+    # @return [String]
+    attrib :group_by
+
+    class ClientModule < Sequence::ClientModule
+      # Create an index.
+      # @param id [String]
+      #   Unique identifier. Auto-generated if not specified.
+      # @return [Index]
+      def create(id: nil, type:, filter:, group_by: [])
+        Index.new(client.session.request(
+                    'create-index',
+                    id: id,
+                    type: type,
+                    filter: filter,
+                    group_by: group_by,
+                  ))
+      end
+
+      # Delete index by id.
+      # @option id [String] The unique ID of an index.
+      # @return [void]
+      def delete(id:)
+        client.session.request('delete-index', id: id)
+        nil
+      end
+
+      # List all indexes.
+      # Executes a query, returning an enumerable over individual indexes.
+      # @return [Query]
+      def list
+        Query.new(client)
+      end
+    end
+
+    class Query < Sequence::Query
+      def fetch(query)
+        client.session.request('list-indexes', query)
+      end
+
+      def translate(obj)
+        Index.new(obj)
+      end
+    end
+  end
+end

data/lib/sequence/session.rb

@@ -5,6 +5,7 @@ require 'json'
 require_relative './http_wrapper'
 require_relative './errors'
 require_relative './version'
+require_relative './hello'
 
 module Sequence
   # @private
@@ -19,11 +20,11 @@ module Sequence
         ArgumentError,
         'missing credential',
       )
-      @team_name = @opts[:team_name] || raise(
-        ArgumentError,
-        'missing team_name',
-      )
-      @ledger_api = HttpWrapper.new('https://' + @opts[:addr], @credential, @opts)
+
+      @lock = Mutex.new # protects the following instance variables
+      @team_name, @addr, ttl_seconds = hello.call
+      @api = api(@addr)
+      @deadline = now + ttl_seconds
     end
 
     def dup
@@ -36,7 +37,20 @@ module Sequence
 
     def request_full_resp(id, path, body = {})
       id ||= SecureRandom.hex(10)
-      @ledger_api.post(id, ledger_url(path), body) do |response|
+      deadline = nil
+      api = nil
+
+      @lock.synchronize do
+        deadline = @deadline
+        api = @api
+        path = "/#{@team_name}/#{@ledger}/#{path}".gsub('//', '/')
+      end
+
+      if now >= deadline
+        refresh
+      end
+
+      api.post(id, path, body) do |response|
         # require that the response contains the Chain-Request-ID
         # http header. Since the Sequence API will always set this
         # header, its absence indicates that the request stopped at
@@ -52,9 +66,44 @@ module Sequence
 
     private
 
-    def ledger_url(path)
-      path = path[1..-1] if path.start_with?('/')
-      "/#{@team_name}/#{@ledger}/#{path}"
+    def refresh
+      Thread.new do
+        # extend the deadline long enough to get a fresh addr
+        @lock.synchronize do
+          @deadline = now + HttpWrapper::RETRY_TIMEOUT_SECS
+        end
+
+        begin
+          new_team_name, new_addr, ttl_seconds = hello.call
+        rescue StandardError # rubocop:disable Lint/HandleExceptions
+          # use existing values while trying for a successful /hello
+        else
+          @lock.synchronize do
+            @deadline = now + ttl_seconds
+
+            # unless addr changed, use existing API client
+            # in order to re-use the TLS connection
+            if @addr != new_addr
+              @addr = new_addr
+              @api = api(new_addr)
+            end
+
+            @team_name = new_team_name
+          end
+        end
+      end
+    end
+
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC).to_i
+    end
+
+    def hello
+      Sequence::Hello.new(api(ENV['SEQADDR'] || 'api.seq.com'))
+    end
+
+    def api(addr)
+      HttpWrapper.new('https://' + addr, @credential, @opts)
     end
   end
 end

data/lib/sequence/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sequence
-  VERSION = '2.1'
+  VERSION = '2.2.rc.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequence-sdk
 version: !ruby/object:Gem::Version
-  version: '2.1'
+  version: 2.2.rc.1
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.1
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +123,9 @@ files:
 - lib/sequence/errors.rb
 - lib/sequence/feed.rb
 - lib/sequence/flavor.rb
+- lib/sequence/hello.rb
 - lib/sequence/http_wrapper.rb
+- lib/sequence/index.rb
 - lib/sequence/key.rb
 - lib/sequence/page.rb
 - lib/sequence/query.rb
@@ -162,9 +150,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6