sequence-sdk 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94c78d487e125ca4d9436ba7651feeaa4df4e42c
-  data.tar.gz: 4686db08afa33c144752c475e682e133b3e7dad7
+  metadata.gz: 13297573e64f55ffcba16f88365a13ee4540d7c3
+  data.tar.gz: e94b5d7ab7f11a8dfe48140fceea4c921d56b2d9
 SHA512:
-  metadata.gz: 3b8efcc73ad670aa4df6b2adadc9e6be07043b77e06b0098f918e332dd3df4563e870f31ea561a4bde52e2720d5c3a8904a20cb8db36c30743713dd1caf0c8b6
-  data.tar.gz: 46da2a5e7ab4800d88c47dc98725da383fa56c54eb8b64a08ed232a50fb750b87277904d90d48a9163c88a34a7ba70a2d80d71389ff7df9d35276ac653e5084b
+  metadata.gz: f3231c2b04e1e9a99a8318aac330fdd4ea1eb1bb54ab0510c9cbfa49335454fbfaaa8114d823bc70a799ce89ef6617c9502940f33c48ae4dd5240bd2a2939dea
+  data.tar.gz: dad7408ea6e7c10eb8e793faffa29150e95cdaf39a4c651c7566eea2760c46ed0a16e60a545b6993f3e1aab48921dfd03b624a7fa9c96e2511c528c5f0d311d5

data/lib/sequence/account.rb

@@ -47,7 +47,7 @@ module Sequence
       # @return [Account]
       def create(opts)
         opts = {client_token: SecureRandom.uuid}.merge(opts)
-        Account.new(client.conn.request('create-account', opts))
+        Account.new(client.session.request('create-account', opts))
       end
 
       # Updates an account's tags.
@@ -57,7 +57,7 @@ module Sequence
       # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
       # @return [void]
       def update_tags(opts)
-        client.conn.request('update-account-tags', opts)
+        client.session.request('update-account-tags', opts)
       end
 
       # Executes a query, returning an enumerable over individual accounts.
@@ -72,7 +72,7 @@ module Sequence
 
     class Query < Sequence::Query
       def fetch(query)
-        client.conn.request('list-accounts', query)
+        client.session.request('list-accounts', query)
       end
 
       def translate(raw)

data/lib/sequence/asset.rb

@@ -49,7 +49,7 @@ module Sequence
       # @return [Asset]
       def create(opts)
         opts = {client_token: SecureRandom.uuid}.merge(opts)
-        Asset.new(client.conn.request('create-asset', opts))
+        Asset.new(client.session.request('create-asset', opts))
       end
 
       # Updates an asset's tags.
@@ -59,7 +59,7 @@ module Sequence
       # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
       # @return [void]
       def update_tags(opts)
-        client.conn.request('update-asset-tags', opts)
+        client.session.request('update-asset-tags', opts)
       end
 
       # Executes a query, returning an enumerable over individual assets.
@@ -74,7 +74,7 @@ module Sequence
 
     class Query < Sequence::Query
       def fetch(query)
-        client.conn.request('list-assets', query)
+        client.session.request('list-assets', query)
       end
 
       def translate(raw)

data/lib/sequence/balance.rb

@@ -34,7 +34,7 @@ module Sequence
 
     class Query < Sequence::Query
       def fetch(query)
-        client.conn.request('list-balances', query)
+        client.session.request('list-balances', query)
       end
 
       def translate(raw)

data/lib/sequence/client.rb

@@ -15,9 +15,13 @@ module Sequence
     # @option opts [String] access_token The ledger access token.
     # @return [Query]
     def initialize(opts = {})
-      if !opts.key?(:url) || opts[:url].empty?
-        raise ArgumentError.new('missing :url parameter')
+      if !opts.key?(:ledger) || opts[:ledger].empty?
+        raise ArgumentError.new('missing :ledger parameter')
       end
+      if !opts.key?(:credential) || opts[:credential].empty?
+        raise ArgumentError.new('missing :credential parameter')
+      end
+
       @opts = opts
     end
 
@@ -25,9 +29,9 @@ module Sequence
       @opts.dup
     end
 
-    # @return [Connection]
-    def conn
-      @conn ||= Connection.new(@opts)
+    # @return [Session]
+    def session
+      @session ||= Session.new(@opts)
     end
 
     # @return [Account::ClientModule]

data/lib/sequence/contract.rb

@@ -74,7 +74,7 @@ module Sequence
 
     class Query < Sequence::Query
       def fetch(query)
-        client.conn.request('list-contracts', query)
+        client.session.request('list-contracts', query)
       end
 
       def translate(raw)

data/lib/sequence/dev_utils.rb

@@ -8,7 +8,7 @@ module Sequence
     class ClientModule < Sequence::ClientModule
       # Deletes all data in the ledger.
       def reset
-        client.conn.request('/reset', client_token: SecureRandom.uuid)
+        client.session.request('/reset', client_token: SecureRandom.uuid)
       end
     end
   end

data/lib/sequence/errors.rb

@@ -11,7 +11,7 @@ module Sequence
     attr_accessor :response
 
     def initialize(response)
-      super "Response HTTP header field Sequence-Request-ID is unset. There may be network issues. Please check your local network settings."
+      super 'Response HTTP header field Chain-Request-ID is unset. There may be network issues. Please check your local network settings.'
       self.response = response
     end
   end
@@ -53,7 +53,7 @@ module Sequence
       self.temporary = body['temporary']
 
       self.response = response
-      self.request_id = response['Sequence-Request-ID'] if response
+      self.request_id = response['Chain-Request-ID'] if response
 
       super self.class.format_error_message(code, chain_message, detail, request_id)
     end

data/lib/sequence/http_wrapper.rb

@@ -0,0 +1,111 @@
+require 'net/http'
+require 'net/https'
+require 'openssl'
+require 'thread'
+
+module Sequence
+  class HttpWrapper
+
+    # Parameters to the retry exponential backoff function.
+    MAX_RETRIES = 10
+    RETRY_BASE_DELAY_MS = 40
+    RETRY_MAX_DELAY_MS = 4000
+
+    NETWORK_ERRORS = [
+      InvalidRequestIDError,
+      SocketError,
+      EOFError,
+      IOError,
+      Timeout::Error,
+      Errno::ECONNABORTED,
+      Errno::ECONNRESET,
+      Errno::ETIMEDOUT,
+      Errno::EHOSTUNREACH,
+      Errno::ECONNREFUSED,
+    ]
+
+    attr_accessor :dis_macaroon
+
+    def initialize(host, macaroon, opts={})
+      @mutex = Mutex.new
+      @host = URI(host)
+      @macaroon = macaroon
+      @dis_macaroon = nil
+      @opts = opts
+      @http = setup_http
+    end
+
+    def post(url, body)
+      attempts = 0
+      begin
+        attempts += 1
+        # If this is a retry and not the first attempt, sleep before making the
+        # retry request.
+        sleep(backoff_delay(attempts)) if attempts > 1
+
+        @mutex.synchronize do
+          req = Net::HTTP::Post.new(url)
+          req.body = JSON.dump(body)
+          req['Accept'] = 'application/json'
+          req['Content-Type'] = 'application/json'
+          req['User-Agent'] = 'chain-sdk-ruby/' + Sequence::VERSION
+          if @macaroon != nil && @dis_macaroon != nil
+            req['Macaroon'] = @macaroon
+            req['Discharge-Macaroon'] = @dis_macaroon
+          end
+          return @http.request(req)
+        end
+      rescue *NETWORK_ERRORS => e
+        raise e if attempts > MAX_RETRIES
+        retry
+      rescue APIError => e
+        raise e if attempts > MAX_RETRIES
+        retry if e.retriable?
+        raise e
+      end
+    end
+
+    private
+
+    MILLIS_TO_SEC = 0.001
+
+    def backoff_delay(attempt)
+      max = RETRY_BASE_DELAY_MS * 2**(attempt-1)
+      max = [max, RETRY_MAX_DELAY_MS].min
+      millis = rand(max) + 1
+      millis * MILLIS_TO_SEC
+    end
+
+    def setup_http
+      args = [@host.hostname, @host.port]
+
+      # Proxy configuration
+      if @opts.key?(:proxy_addr)
+        args += [@opts[:proxy_addr], @opts[:proxy_port]]
+        if @opts.key?(:proxy_user)
+          args += [@opts[:proxy_user], @opts[:proxy_pass]]
+        end
+      end
+
+      http = Net::HTTP.new(*args)
+      http.set_debug_output($stdout) if ENV['DEBUG']
+
+      # TLS configuration
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      [:ca_file, :cert, :key].each do |k|
+        next unless @opts.key?(:ssl_params) && @opts[:ssl_params].key?(k)
+        http.send("#{k}=", @opts[:ssl_params][k])
+      end
+
+      # Timeout configuration
+      [:open_timeout, :read_timeout, :ssl_timeout].each do |k|
+        next unless @opts.key?(k)
+        http.send "#{k}=", @opts[k]
+      end
+
+      return http
+    end
+
+  end
+end

data/lib/sequence/key.rb

@@ -1,5 +1,5 @@
 require_relative './client_module'
-require_relative './connection'
+require_relative './session'
 require_relative './query'
 require_relative './response_object'
 
@@ -23,7 +23,7 @@ module Sequence
       # @option opts [String] alias Unique, user-specified identifier of the key.
       # @return [Key]
       def create(opts = {})
-        Key.new(client.conn.request('create-key', opts))
+        Key.new(client.session.request('create-key', opts))
       end
 
       # Executes a query, returning an enumerable over individual keys.
@@ -37,7 +37,7 @@ module Sequence
 
     class Query < Sequence::Query
       def fetch(query)
-        client.conn.request('list-keys', query)
+        client.session.request('list-keys', query)
       end
 
       def translate(obj)

data/lib/sequence/session.rb

@@ -0,0 +1,95 @@
+require 'json'
+
+require_relative './http_wrapper'
+require_relative './errors'
+require_relative './version'
+
+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] || raise(ArgumentError, "missing ledger")
+      @macaroon = @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
+        if !@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
+
+      @session_api = HttpWrapper.new(@session_host, nil)
+      @ledger_api = HttpWrapper.new(@host, @macaroon, @opts)
+    end
+
+    # Returns a copy of the configuration options
+    def opts
+      @opts.dup
+    end
+
+    def request(path, body = {})
+      request_full_resp(path, body)[:parsed_body]
+    end
+
+    def request_full_resp(path, body={})
+      refresh!
+
+      response = @ledger_api.post(ledger_url(path), body)
+      req_id = response['Chain-Request-ID']
+      unless req_id.is_a?(String) && req_id.size > 0
+        raise InvalidRequestIDError.new(response)
+      end
+
+      status = Integer(response.code)
+      parsed_body = nil
+      if status != 204 # No Content
+        begin
+          parsed_body = JSON.parse(response.body)
+        rescue JSON::JSONError
+          raise JSONError.new(req_id, response)
+        end
+      end
+      if status / 100 != 2
+        klass = status == 401 ? UnauthorizedError : APIError
+        raise klass.new(parsed_body, response)
+      end
+
+      {parsed_body: parsed_body, response: response}
+    end
+
+    private
+
+    def ledger_url(path)
+      path = path[1..-1] if path.start_with?("/")
+      "/#{@team_name}/#{@ledger}/#{path}"
+    end
+
+    def refresh!
+      return if @refresh_at > Time.now.to_i
+
+      result = if @refresh_method
+        @refresh_method.call(@macaroon)
+      else
+        r = @session_api.post('/sessions/validate', {macaroon: @macaroon})
+        JSON.parse(r.body)
+      end
+
+      @team_name = result['team_name']
+      @refresh_at = Integer(result['refresh_at'])
+      @ledger_api.dis_macaroon = result['refresh_token']
+    end
+  end
+end

data/lib/sequence/stats.rb

@@ -25,7 +25,7 @@ module Sequence
       # Gets stats from the ledger.
       # @return [Stats]
       def get
-        Stats.new(client.conn.request('stats'))
+        Stats.new(client.session.request('stats'))
       end
     end
 

data/lib/sequence/transaction.rb

@@ -50,12 +50,12 @@ module Sequence
           builder = Builder.new(&block)
         end
 
-        tpl = client.conn.request('build-transaction', builder)
-        tpl = client.conn.request(
+        tpl = client.session.request('build-transaction', builder)
+        tpl = client.session.request(
           '/sign-transaction',
           transaction: tpl,
         )
-        Transaction.new(client.conn.request(
+        Transaction.new(client.session.request(
           'submit-transaction',
           {transaction: tpl}
         ))
@@ -75,7 +75,7 @@ module Sequence
 
     class Query < Sequence::Query
       def fetch(query)
-        client.conn.request('list-transactions', query)
+        client.session.request('list-transactions', query)
       end
 
       def translate(raw)

data/lib/sequence/version.rb

@@ -1,3 +1,3 @@
 module Sequence
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,137 +1,137 @@
 --- !ruby/object:Gem::Specification
 name: sequence-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !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
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.5
 description: SDK for Sequence
@@ -140,25 +140,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - LICENSE
+- README.md
+- lib/sequence.rb
 - lib/sequence/account.rb
 - lib/sequence/asset.rb
 - lib/sequence/balance.rb
 - lib/sequence/client.rb
 - lib/sequence/client_module.rb
-- lib/sequence/connection.rb
 - lib/sequence/contract.rb
 - lib/sequence/dev_utils.rb
 - lib/sequence/errors.rb
+- lib/sequence/http_wrapper.rb
 - lib/sequence/key.rb
 - lib/sequence/page.rb
 - lib/sequence/query.rb
 - lib/sequence/response_object.rb
+- lib/sequence/session.rb
 - lib/sequence/stats.rb
 - lib/sequence/transaction.rb
 - lib/sequence/version.rb
-- lib/sequence.rb
 homepage: https://dashboard.sequenceledger.com
 licenses:
 - Apache-2.0
@@ -169,17 +170,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: SDK for Sequence

data/lib/sequence/connection.rb

@@ -1,164 +0,0 @@
-require 'json'
-require 'net/http'
-require 'net/https'
-require 'openssl'
-require 'thread'
-
-require_relative './errors'
-require_relative './version'
-
-module Sequence
-  class Connection
-
-    # Parameters to the retry exponential backoff function.
-    MAX_RETRIES = 10
-    RETRY_BASE_DELAY_MS = 40
-    RETRY_MAX_DELAY_MS = 4000
-
-    NETWORK_ERRORS = [
-      InvalidRequestIDError,
-      SocketError,
-      EOFError,
-      IOError,
-      Timeout::Error,
-      Errno::ECONNABORTED,
-      Errno::ECONNRESET,
-      Errno::ETIMEDOUT,
-      Errno::EHOSTUNREACH,
-      Errno::ECONNREFUSED,
-    ]
-
-    def initialize(opts)
-      @opts = opts
-      @url = URI(@opts[:url])
-      @access_token = @opts[:access_token] || @url.userinfo
-      @http_mutex = Mutex.new
-    end
-
-    # Returns a copy of the configuration options
-    def opts
-      @opts.dup
-    end
-
-    def request(path, body = {})
-      _request_with_retries(path, body)[:body]
-    end
-
-    def _request_with_retries(path, body)
-      attempts = 0
-
-      begin
-        attempts += 1
-
-        # If this is a retry and not the first attempt, sleep before making the
-        # retry request.
-        sleep(backoff_delay(attempts)) if attempts > 1
-
-        _single_request(path, body)
-      rescue *NETWORK_ERRORS => e
-        raise e if attempts > MAX_RETRIES
-        retry
-      rescue APIError => e
-        raise e if attempts > MAX_RETRIES
-        retry if e.retriable?
-        raise e
-      end
-    end
-
-    def _single_request(path, body)
-      @http_mutex.synchronize do
-        # Timeout configuration
-        [:open_timeout, :read_timeout, :ssl_timeout].each do |k|
-          next unless @opts.key?(k)
-          http.send "#{k}=", @opts[k]
-        end
-
-        full_path = @url.request_uri.chomp('/')
-        full_path += (path[0] == '/') ? path : '/' + path
-
-        req = Net::HTTP::Post.new(full_path)
-        req['Accept'] = 'application/json'
-        req['Content-Type'] = 'application/json'
-        req['User-Agent'] = 'chain-sdk-ruby/' + Sequence::VERSION
-        req.body = JSON.dump(body)
-
-        if @access_token
-          user, pass = @access_token.split(':')
-          req.basic_auth(user, pass)
-        end
-
-        response = http.request(req)
-
-        req_id = response['Chain-Request-ID']
-        unless req_id.is_a?(String) && req_id.size > 0
-          raise InvalidRequestIDError.new(response)
-        end
-
-        status = Integer(response.code)
-        parsed_body = nil
-
-        if status != 204 # No Content
-          begin
-            parsed_body = JSON.parse(response.body)
-          rescue JSON::JSONError
-            raise JSONError.new(req_id, response)
-          end
-        end
-
-        if status / 100 != 2
-          klass = status == 401 ? UnauthorizedError : APIError
-          raise klass.new(parsed_body, response)
-        end
-
-        {body: parsed_body, response: response}
-      end
-    end
-
-    private
-
-    MILLIS_TO_SEC = 0.001
-
-    def backoff_delay(attempt)
-      max = RETRY_BASE_DELAY_MS * 2**(attempt-1)
-      max = [max, RETRY_MAX_DELAY_MS].min
-      millis = rand(max) + 1
-      millis * MILLIS_TO_SEC
-    end
-
-    def http
-      return @http if @http
-
-      args = [@url.host, @url.port]
-
-      # Proxy configuration
-      if @opts.key?(:proxy_addr)
-        args += [@opts[:proxy_addr], @opts[:proxy_port]]
-        if @opts.key?(:proxy_user)
-          args += [@opts[:proxy_user], @opts[:proxy_pass]]
-        end
-      end
-
-      @http = Net::HTTP.new(*args)
-
-      @http.set_debug_output($stdout) if ENV['DEBUG']
-      if @url.scheme == 'https'
-        @http.use_ssl = true
-        @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        if @opts.key?(:ssl_params)
-          ssl_params = @opts[:ssl_params]
-          if ssl_params.key?(:ca_file)
-            @http.ca_file = ssl_params[:ca_file]
-          end
-          if ssl_params.key?(:cert)
-            @http.cert = ssl_params[:cert]
-          end
-          if ssl_params.key?(:key)
-            @http.key = ssl_params[:key]
-          end
-        end
-      end
-
-      @http
-    end
-  end
-end