selfsdk 0.0.196 → 0.0.197

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19017fa46da285bdfa8c3a36adca6321fa3f6f1b84eccb34d7949761f87736a5
-  data.tar.gz: 4e15f24fd771ea496cf3f5e00d7a29e7cef88eb701d9228a217c5d9533f71c70
+  metadata.gz: 88cd6714a5c258e5777b5c7ce465c998b9215fb16459e1687282e3695961fb2a
+  data.tar.gz: b05a49bc266ba95b6a957bea27b31edd5216afeea30dc159ca134b65ecf59261
 SHA512:
-  metadata.gz: 4648c3554ce576e4dcdf0198b4fa7fabf0afe43d93f1406cd02a618501d9d024e0309bd5446c6a12ec277467bec2d8ca10da9fd9dbbbb4e2958979a28cf9017f
-  data.tar.gz: 74938c4b8b9f4361af474cbd87082ae2d335c1585ed9783a1b03c41fc93aa7a3a7c68f885f6b942ff6aa40b3fd4f88858ef3c98ec281aa17c9f33d6fbc62ba8c
+  metadata.gz: e9bea262aad81d5125dce00ce7afebb05b454eec6e7c26ab8a147ac5177894add5ae827158418100944bd729f8378c59d0296b57a792e688658edf917f2f7b01
+  data.tar.gz: 2aafa0e3b09648a67e95d662e19694faa9fb56fe90161cb44f045108f5aee004611390e9e702e0b198a0d9516d21e90ec61170a9b79d70f4b66c1a8694b87a3b

data/lib/authenticated.rb

@@ -14,6 +14,7 @@ module SelfSDK
 
     def accepted?
       return false if @payload.nil?
+      return false if @payload[:auth] != true
 
       @payload[:status] == "accepted"
     end

data/lib/messages/fact_request.rb

@@ -12,7 +12,12 @@ module SelfSDK
       MSG_TYPE = "identities.facts.query.req"
       DEFAULT_EXP_TIMEOUT = 900
 
-      attr_accessor :facts, :options
+      attr_accessor :facts, :options, :auth
+
+      def initialize(messaging)
+        @typ = MSG_TYPE
+        super
+      end
 
       def parse_facts(facts)
         @facts = []
@@ -82,6 +87,7 @@ module SelfSDK
         b = {
           typ: MSG_TYPE,
           iss: @jwt.id,
+          aud: @to,
           sub: @to,
           iat: SelfSDK::Time.now.strftime('%FT%TZ'),
           exp: (SelfSDK::Time.now + @exp_timeout).strftime('%FT%TZ'),

data/lib/messages/fact_response.rb

@@ -13,6 +13,11 @@ module SelfSDK
 
       attr_accessor :facts, :audience, :auth
 
+      def initialize(messaging)
+        @typ = MSG_TYPE
+        super
+      end
+
       def parse(input, envelope=nil)
         @input = input
         @typ = MSG_TYPE
@@ -84,6 +89,10 @@ module SelfSDK
           auth: @auth }
       end
 
+      def auth_response?
+        @auth == true
+      end
+
       protected
 
       def proto(to_device)

data/lib/messages/message.rb

@@ -4,8 +4,6 @@
 
 require_relative "fact_request"
 require_relative "fact_response"
-require_relative "authentication_resp"
-require_relative "authentication_req"
 require_relative "chat_message"
 require_relative "chat_message_read"
 require_relative "chat_message_delivered"
@@ -30,18 +28,12 @@ module SelfSDK
       payload = JSON.parse(messaging.jwt.decode(jwt[:payload]), symbolize_names: true)
 
       case payload[:typ]
-      when "identities.facts.query.req"
+      when SelfSDK::Messages::FactRequest::MSG_TYPE
         m = FactRequest.new(messaging)
         m.parse(body, envelope)
-      when "identities.facts.query.resp"
+      when SelfSDK::Messages::FactResponse::MSG_TYPE
         m = FactResponse.new(messaging)
         m.parse(body, envelope)
-      when "identities.authenticate.resp"
-        m = AuthenticationResp.new(messaging)
-        m.parse(body, envelope)
-      when "identities.authenticate.req"
-        m = AuthenticationReq.new(messaging)
-        m.parse(body, envelope)
       when SelfSDK::Messages::ChatMessage::MSG_TYPE
         m = ChatMessage.new(messaging)
         m.parse(body, envelope)

data/lib/selfsdk.rb

@@ -17,6 +17,7 @@ require_relative 'authenticated'
 require_relative 'acl'
 require_relative 'sources'
 require_relative 'services/auth'
+require_relative 'services/requester'
 require_relative 'services/facts'
 require_relative 'services/identity'
 require_relative 'services/messaging'
@@ -66,12 +67,12 @@ module SelfSDK
 
     # Provides access to SelfSDK::Services::Facts service
     def facts
-      @facts ||= SelfSDK::Services::Facts.new(messaging, @client)
+      @facts ||= SelfSDK::Services::Facts.new(requester)
     end
 
     # Provides access to SelfSDK::Services::Authentication service
     def authentication
-      @authentication ||= SelfSDK::Services::Authentication.new(messaging, @client)
+      @authentication ||= SelfSDK::Services::Authentication.new(requester)
     end
 
     # Provides access to SelfSDK::Services::Identity service
@@ -109,6 +110,10 @@ module SelfSDK
 
     protected
 
+      def requester
+        @requester ||= SelfSDK::Services::Requester.new(messaging, @client)
+      end
+
       def base_url(opts)
         return opts[:base_url] if opts.key? :base_url
         return "https://api.#{opts[:env].to_s}.joinself.com" if opts.key? :env

data/lib/services/auth.rb

@@ -16,10 +16,8 @@ module SelfSDK
       # @param client [SelfSDK::Client] http client object.
       #
       # @return [SelfSDK::Services::Authentication] authentication service.
-      def initialize(messaging, client)
-        @messaging = messaging.client
-        @messaging_service = messaging
-        @client = client
+      def initialize(requester)
+        @requester = requester
       end
 
       # Sends an authentication request to the specified selfid.
@@ -30,6 +28,7 @@ module SelfSDK
       #  @param [String] selfid the receiver of the authentication request.
       #  @param [Hash] opts the options to authenticate.
       #  @option opts [String] :cid The unique identifier of the authentication request.
+      #  @option opts [Array] :facts array of facts to be requested
       #  @yield [request] Invokes the block with an authentication response for each result.
       #  @return [String, String] conversation id or encoded body.
       #
@@ -38,29 +37,21 @@ module SelfSDK
       #  @param [Hash] opts the options to authenticate.
       #  @option [Boolean] :async if the request is asynchronous.
       #  @option opts [String] :cid The unique identifier of the authentication request.
+      #  @option opts [Array] :facts array of facts to be requested
       #  @return [String, String] conversation id or encoded body.
       def request(selfid, opts = {}, &block)
-        SelfSDK.logger.info "authenticating #{selfid}"
-        rq = opts.fetch(:request, true)
-        if rq
-          raise "You're not permitting connections from #{selfid}" unless @messaging_service.is_permitted?(selfid)
-        end
-
-        req = SelfSDK::Messages::AuthenticationReq.new(@messaging)
-        req.populate(selfid, opts)
-
-        body = @client.jwt.prepare(req.body)
-        return body unless rq
-        return req.send_message if opts.fetch(:async, false)
-
-        # when a block is given the request will always be asynchronous.
-        if block_given?
-          @messaging.set_observer(req, timeout: req.exp_timeout, &block)
-          return req.send_message
-        end
-
-        # Otherwise the request is synchronous
-        req.request
+        opts[:auth] = true
+        facts = opts.fetch(:facts, [])
+
+        @requester.request(selfid, facts, opts, &block)
+      end
+
+      # Adds an observer for a fact response
+      # Whenever you receive a fact response registered observers will receive a notification.
+      #
+      #  @yield [request] Invokes the block with a fact response message.
+      def subscribe(&block)
+        @requester.subscribe(true, &block)
       end
 
       # Generates a QR code so users can authenticate to your app.
@@ -70,10 +61,10 @@ module SelfSDK
       #
       # @return [String, String] conversation id or encoded body.
       def generate_qr(opts = {})
-        opts[:request] = false
-        selfid = opts.fetch(:selfid, "-")
-        req = request(selfid, opts)
-        ::RQRCode::QRCode.new(req, level: 'l')
+        opts[:auth] = true
+        facts = opts.fetch(:facts, [])
+
+        @requester.generate_qr(facts, opts)
       end
 
       # Generates a deep link to authenticate with self app.
@@ -84,24 +75,10 @@ module SelfSDK
       #
       # @return [String, String] conversation id or encoded body.
       def generate_deep_link(callback, opts = {})
-        opts[:request] = false
-        selfid = opts.fetch(:selfid, "-")
-        body = @client.jwt.encode(request(selfid, opts))
-
-        if @client.env.empty?
-          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
-        elsif @client.env == 'development'
-          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
-        end
-        "https://#{@client.env}.links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{@client.env}"
-      end
+        opts[:auth] = true
+        facts = opts.fetch(:facts, [])
 
-      # Adds an observer for an authentication response
-      def subscribe(&block)
-        @messaging.subscribe :authentication_response do |res|
-          valid_payload(res.input)
-          yield(res)
-        end
+        @requester.generate_deep_link(facts, callback, opts)
       end
 
       private
@@ -130,27 +107,6 @@ module SelfSDK
         nil
       end
 
-      # Prepares an authentication payload to be sent to a user.
-      #
-      # @param selfid [string] the selfid of the user you want to send the auth request to.
-      # @param cid [string] the conversation id to be used.
-      def prepare_payload(selfid, cid)
-        # TODO should this be moved to its own message/auth_req.rb?
-        body = {
-            typ: 'identities.authenticate.req',
-            aud: @client.self_url,
-            iss: @client.jwt.id,
-            sub: selfid,
-            iat: SelfSDK::Time.now.strftime('%FT%TZ'),
-            exp: (SelfSDK::Time.now + 3600).strftime('%FT%TZ'),
-            cid: cid,
-            jti: SecureRandom.uuid,
-            device_id: @messaging.device_id,
-        }
-
-        @client.jwt.prepare(body)
-      end
-
       def parse_payload(response)
         jws = @client.jwt.parse(response)
         return unless jws.include? :payload
@@ -161,7 +117,7 @@ module SelfSDK
         identity = @client.entity(payload[:sub])
         return if identity.nil?
 
-        return payload
+        payload
       end
     end
   end

data/lib/services/facts.rb

@@ -18,10 +18,8 @@ module SelfSDK
       # @param client [SelfSDK::Client] http client object.
       #
       # @return [SelfSDK::Services::Facts] facts service.
-      def initialize(messaging, client)
-        @messaging = messaging.client
-        @messaging_service = messaging
-        @client = client
+      def initialize(requester)
+        @requester = requester
       end
 
       # Sends a fact request to the specified selfid.
@@ -29,45 +27,24 @@ module SelfSDK
       # permission.
       #
       # @overload request(selfid, facts, opts = {}, &block)
-      #  @param selfid [string] the receiver of the authentication request.
-      #  @param [Hash] opts the options to authenticate.
-      #  @option opts [String] :cid The unique identifier of the authentication request.
+      #  @param selfid [string] the receiver of the fact request.
+      #  @param facts [Array] array of facts to be requested
+      #  @param [Hash] opts the options to process the request.
+      #  @option opts [String] :cid The unique identifier of the fact request.
       # @yield [request] Invokes the given block when a response is received.
       #  @return [Object] SelfSDK:::Messages::FactRequest
       #
       # @overload request(selfid, facts, opts = {})
-      #  @param selfid [string] the receiver of the authentication request.
-      #  @param [Hash] opts the options to authenticate.
-      #  @option opts [String] :cid The unique identifier of the authentication request.
+      #  @param selfid [string] the receiver of the fact request.
+      #  @param facts [Array] array of facts to be requested
+      #  @param [Hash] opts the options to request.
+      #  @option opts [String] :cid The unique identifier of the fact request.
       #  @option opts [Integer] :exp_timeout timeout in seconds to expire the request.
       #  @option opts [Integer] :allowed_for number of seconds for enabling recurrent requests.
-      #  @option opts [Boolean] :auth allows displaying the request as anuthentication request with facts.
       #  @return [Object] SelfSDK:::Messages::FactRequest
       def request(selfid, facts, opts = {}, &block)
-        SelfSDK.logger.info "authenticating #{selfid}"
-        rq = opts.fetch(:request, true)
-        if rq
-          raise "You're not permitting connections from #{selfid}" unless @messaging_service.is_permitted?(selfid)
-        end
-
-        req = SelfSDK::Messages::FactRequest.new(@messaging)
-        req.populate(selfid, prepare_facts(facts), opts)
-
-        body = @client.jwt.prepare(req.body)
-        return body unless rq
-
-        # when a block is given the request will always be asynchronous.
-        if block_given?
-          @messaging.set_observer(req, timeout: req.exp_timeout, &block)
-          return req.send_message
-        end
-
-        if opts[:async] == true
-          return req.send_message
-        end
-
-        # Otherwise the request is synchronous
-        req.request
+        opts[:auth] = false # force auth to false as you have auth service to make auth requests
+        @requester.request(selfid, facts, opts, &block)
       end
 
       # Sends a request through an intermediary.
@@ -81,8 +58,7 @@ module SelfSDK
       #  @option opts [String] intermediary an intermediary identity to be used.
       #  @return [Object] SelfSDK:::Messages::FactRequest
       def request_via_intermediary(selfid, facts, opts = {}, &block)
-        opts[:intermediary] = opts.fetch(:intermediary, DEFAULT_INTERMEDIARY)
-        request(selfid, facts, opts, &block)
+        @requester.request_via_intermediary(selfid, facts, opts, &block)
       end
 
       # Adds an observer for a fact response
@@ -90,7 +66,7 @@ module SelfSDK
       #
       #  @yield [request] Invokes the block with a fact response message.
       def subscribe(&block)
-        @messaging.subscribe(:fact_response, &block)
+        @requester.subscribe(false, &block)
       end
 
       # Generates a QR code so users can send facts to your app.
@@ -101,10 +77,8 @@ module SelfSDK
       #
       # @return [String, String] conversation id or encoded body.
       def generate_qr(facts, opts = {})
-        opts[:request] = false
-        selfid = opts.fetch(:selfid, "-")
-        req = request(selfid, facts, opts)
-        ::RQRCode::QRCode.new(req, level: 'l')
+        opts[:auth] = false
+        @requester.generate_qr(facts, opts)
       end
 
       # Generates a deep link to authenticate with self app.
@@ -116,114 +90,8 @@ module SelfSDK
       #
       # @return [String, String] conversation id or encoded body.
       def generate_deep_link(facts, callback, opts = {})
-        opts[:request] = false
-        selfid = opts.fetch(:selfid, "-")
-        body = @client.jwt.encode(request(selfid, facts, opts))
-
-        if @client.env.empty?
-          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
-        elsif @client.env == 'development'
-          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
-        end
-        "https://#{@client.env}.links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{@client.env}"
-      end
-
-      private
-
-      # As request facts can accept an array of strings this populates with necessary
-      # structure this short fact definitions.
-      #
-      # @param facts [Array] an array of strings or hashes.
-      # @return [Array] a list of hashed facts.
-      def prepare_facts(facts)
-        fs = []
-        facts.each do |f|
-          fact = if f.is_a?(Hash)
-                   f
-                 else
-                   { fact: f }
-                 end
-          # validate_fact!(fact)
-          fs << fact
-        end
-        fs
-      end
-
-      def validate_fact!(f)
-        errInvalidFactToSource = 'provided source does not support given fact'
-        errInvalidSource = 'provided fact does not specify a valid source'
-
-        raise 'provided fact does not specify a name' if f[:fact].empty?
-        return unless f.has_key? :sources
-
-        valid_sources = [SOURCE_USER_SPECIFIED,
-                         SOURCE_PASSPORT,
-                         SOURCE_DRIVING_LICENSE,
-                         SOURCE_IDENTITY_CARD,
-                         SOURCE_TWITTER,
-                         SOURCE_LINKEDIN,
-                         SOURCE_FACEBOK]
-        fact_for_passport = [FACT_DOCUMENT_NUMBER,
-                             FACT_SURNAME,
-                             FACT_GIVEN_NAMES,
-                             FACT_DATE_OF_BIRTH,
-                             FACT_DATE_OF_EXPIRATION,
-                             FACT_SEX,
-                             FACT_NATIONALITY,
-                             FACT_COUNTRY_OF_ISSUANCE]
-
-        facts_for_dl = [FACT_DOCUMENT_NUMBER,
-                        FACT_SURNAME,
-                        FACT_GIVEN_NAMES,
-                        FACT_DATE_OF_BIRTH,
-                        FACT_DATE_OF_ISSUANCE,
-                        FACT_DATE_OF_EXPIRATION,
-                        FACT_ADDRESS, 
-                        FACT_ISSUING_AUTHORITY,
-                        FACT_PLACE_OF_BIRTH, 
-                        FACT_COUNTRY_OF_ISSUANCE]
-
-        facts_for_user = [FACT_DOCUMENT_NUMBER,
-                          FACT_DISPLAY_NAME,
-                          FACT_EMAIL,
-                          FACT_PHONE]
-
-        facts_for_twitter = [FACT_ACCOUNT_ID, FACT_NICKNAME]
-        facts_for_linkedin = [FACT_ACCOUNT_ID, FACT_NICKNAME]
-        facts_for_facebook = [FACT_ACCOUNT_ID, FACT_NICKNAME]
-        facts_for_live = [FACT_SELFIE]
-
-        f[:sources].each do |s|
-          raise errInvalidSource unless valid_sources.include? s.to_s
-
-          if s.to_s == SOURCE_PASSPORT || s.to_s == SOURCE_IDENTITY_CARD
-            raise errInvalidFactToSource unless fact_for_passport.include? f[:fact]
-          end
-
-          if s.to_s == SOURCE_DRIVING_LICENSE
-            raise errInvalidFactToSource unless facts_for_dl.include? f[:fact]
-          end
-
-          if s.to_s == SOURCE_USER_SPECIFIED
-            raise errInvalidFactToSource unless facts_for_user.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_TWITTER
-            raise errInvalidFactToSource unless facts_for_twitter.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_LINKEDIN
-            raise errInvalidFactToSource unless facts_for_linkedin.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_FACEBOOK
-            raise errInvalidFactToSource unless facts_for_facebook.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_LIVE
-            raise errInvalidFactToSource unless facts_for_live.include? f[:fact].to_s
-          end
-        end
+        opts[:auth] = false
+        @requester.generate_deep_link(facts, callback, opts)
       end
     end
   end

data/lib/services/messaging.rb

@@ -26,7 +26,7 @@ module SelfSDK
       # Subscribes to a specific message type and attaches the given observer
       # which will be executed when a meeting criteria message is received.
       #
-      # @param [String] type message type (ex: SelfSDK::Messages::AuthenticationResp.MSG_TYPE
+      # @param [String] type message type (ex: SelfSDK::Messages::FactRequest.MSG_TYPE
       # @yield [SelfSDK::Messages::Message] receives incoming message.
       def subscribe(type, &block)
         @client.subscribe(type, &block)

data/lib/services/requester.rb

@@ -0,0 +1,242 @@
+# Copyright 2020 Self Group Ltd. All Rights Reserved.
+
+# frozen_string_literal: true
+
+# Namespace for classes and modules that handle SelfSDK gem
+module SelfSDK
+  # Namespace for classes and modules that handle selfsdk-gem public ui
+  module Services
+    # Self provides this self-hosted verified intermediary.
+    DEFAULT_INTERMEDIARY = "self_intermediary"
+    # Input class to handle fact requests on self network.
+    class Requester
+      # Creates a new facts service.
+      # Facts service mainly manages fact requests against self users wanting
+      # to share their verified facts with your app.
+      #
+      # @param messaging [SelfSDK::Messaging] messaging object.
+      # @param client [SelfSDK::Client] http client object.
+      #
+      # @return [SelfSDK::Services::Facts] facts service.
+      def initialize(messaging, client)
+        @messaging = messaging.client
+        @messaging_service = messaging
+        @client = client
+      end
+
+      # Sends a fact request to the specified selfid.
+      # An fact request allows your app to access trusted facts of your user with its
+      # permission.
+      #
+      # @overload request(selfid, facts, opts = {}, &block)
+      #  @param selfid [string] the receiver of the authentication request.
+      #  @param [Hash] opts the options to authenticate.
+      #  @option opts [String] :cid The unique identifier of the authentication request.
+      # @yield [request] Invokes the given block when a response is received.
+      #  @return [Object] SelfSDK:::Messages::FactRequest
+      #
+      # @overload request(selfid, facts, opts = {})
+      #  @param selfid [string] the receiver of the authentication request.
+      #  @param [Hash] opts the options to authenticate.
+      #  @option opts [String] :cid The unique identifier of the authentication request.
+      #  @option opts [Integer] :exp_timeout timeout in seconds to expire the request.
+      #  @option opts [Integer] :allowed_for number of seconds for enabling recurrent requests.
+      #  @option opts [Boolean] :auth allows displaying the request as anuthentication request with facts.
+      #  @return [Object] SelfSDK:::Messages::FactRequest
+      def request(selfid, facts, opts = {}, &block)
+        SelfSDK.logger.info "authenticating #{selfid}"
+        rq = opts.fetch(:request, true)
+        if rq
+          raise "You're not permitting connections from #{selfid}" unless @messaging_service.is_permitted?(selfid)
+        end
+
+        req = SelfSDK::Messages::FactRequest.new(@messaging)
+        req.populate(selfid, prepare_facts(facts), opts)
+
+        body = @client.jwt.prepare(req.body)
+        return body unless rq
+
+        # when a block is given the request will always be asynchronous.
+        if block_given?
+          @messaging.set_observer(req, timeout: req.exp_timeout, &block)
+          return req.send_message
+        end
+
+        if opts[:async] == true
+          return req.send_message
+        end
+
+        # Otherwise the request is synchronous
+        req.request
+      end
+
+      # Sends a request through an intermediary.
+      # An intermediary is an entity trusted by the user and acting as a proxy between you
+      # and the recipient of your fact request.
+      # Intermediaries usually do not provide the original user facts, but they create its
+      # own assertions based on your request and the user's facts.
+      #
+      #  @param selfid [string] the receiver of the authentication request.
+      #  @param [Hash] opts the options to authenticate.
+      #  @option opts [String] intermediary an intermediary identity to be used.
+      #  @return [Object] SelfSDK:::Messages::FactRequest
+      def request_via_intermediary(selfid, facts, opts = {}, &block)
+        opts[:intermediary] = opts.fetch(:intermediary, DEFAULT_INTERMEDIARY)
+        request(selfid, facts, opts, &block)
+      end
+
+      # Adds an observer for a fact response
+      # Whenever you receive a fact response registered observers will receive a notification.
+      #
+      #  @yield [request] Invokes the block with a fact response message.
+      def subscribe(auth, &block)
+        if auth == true
+          @auth_subscription = block
+        else
+          @fact_subscription = block
+        end
+
+        @messaging.subscribe :fact_response do |res|
+          if res.auth_response?
+            @auth_subscription&.call(res)
+          else
+            @fact_subscription&.call(res)
+          end
+        end
+      end
+
+      # Generates a QR code so users can send facts to your app.
+      #
+      # @param facts [Array] a list of facts to be requested.
+      # @option opts [String] :cid The unique identifier of the authentication request.
+      # @option opts [String] :options Options you want to share with the identity.
+      #
+      # @return [String, String] conversation id or encoded body.
+      def generate_qr(facts, opts = {})
+        opts[:request] = false
+        selfid = opts.fetch(:selfid, "-")
+        req = request(selfid, facts, opts)
+        ::RQRCode::QRCode.new(req, level: 'l')
+      end
+
+      # Generates a deep link to authenticate with self app.
+      #
+      # @param facts [Array] a list of facts to be requested.
+      # @param callback [String] the url you'll be redirected if the app is not installed.
+      # @option opts [String] :selfid the user selfid you want to authenticate.
+      # @option opts [String] :cid The unique identifier of the authentication request.
+      #
+      # @return [String, String] conversation id or encoded body.
+      def generate_deep_link(facts, callback, opts = {})
+        opts[:request] = false
+        selfid = opts.fetch(:selfid, "-")
+        body = @client.jwt.encode(request(selfid, facts, opts))
+
+        if @client.env.empty?
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
+        elsif @client.env == 'development'
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
+        end
+        "https://#{@client.env}.links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{@client.env}"
+      end
+
+      private
+
+      # As request facts can accept an array of strings this populates with necessary
+      # structure this short fact definitions.
+      #
+      # @param facts [Array] an array of strings or hashes.
+      # @return [Array] a list of hashed facts.
+      def prepare_facts(facts)
+        fs = []
+        facts.each do |f|
+          fact = if f.is_a?(Hash)
+                   f
+                 else
+                   { fact: f }
+                 end
+          # validate_fact!(fact)
+          fs << fact
+        end
+        fs
+      end
+
+      def validate_fact!(f)
+        errInvalidFactToSource = 'provided source does not support given fact'
+        errInvalidSource = 'provided fact does not specify a valid source'
+
+        raise 'provided fact does not specify a name' if f[:fact].empty?
+        return unless f.has_key? :sources
+
+        valid_sources = [SOURCE_USER_SPECIFIED,
+                         SOURCE_PASSPORT,
+                         SOURCE_DRIVING_LICENSE,
+                         SOURCE_IDENTITY_CARD,
+                         SOURCE_TWITTER,
+                         SOURCE_LINKEDIN,
+                         SOURCE_FACEBOK]
+        fact_for_passport = [FACT_DOCUMENT_NUMBER,
+                             FACT_SURNAME,
+                             FACT_GIVEN_NAMES,
+                             FACT_DATE_OF_BIRTH,
+                             FACT_DATE_OF_EXPIRATION,
+                             FACT_SEX,
+                             FACT_NATIONALITY,
+                             FACT_COUNTRY_OF_ISSUANCE]
+
+        facts_for_dl = [FACT_DOCUMENT_NUMBER,
+                        FACT_SURNAME,
+                        FACT_GIVEN_NAMES,
+                        FACT_DATE_OF_BIRTH,
+                        FACT_DATE_OF_ISSUANCE,
+                        FACT_DATE_OF_EXPIRATION,
+                        FACT_ADDRESS, 
+                        FACT_ISSUING_AUTHORITY,
+                        FACT_PLACE_OF_BIRTH, 
+                        FACT_COUNTRY_OF_ISSUANCE]
+
+        facts_for_user = [FACT_DOCUMENT_NUMBER,
+                          FACT_DISPLAY_NAME,
+                          FACT_EMAIL,
+                          FACT_PHONE]
+
+        facts_for_twitter = [FACT_ACCOUNT_ID, FACT_NICKNAME]
+        facts_for_linkedin = [FACT_ACCOUNT_ID, FACT_NICKNAME]
+        facts_for_facebook = [FACT_ACCOUNT_ID, FACT_NICKNAME]
+        facts_for_live = [FACT_SELFIE]
+
+        f[:sources].each do |s|
+          raise errInvalidSource unless valid_sources.include? s.to_s
+
+          if s.to_s == SOURCE_PASSPORT || s.to_s == SOURCE_IDENTITY_CARD
+            raise errInvalidFactToSource unless fact_for_passport.include? f[:fact]
+          end
+
+          if s.to_s == SOURCE_DRIVING_LICENSE
+            raise errInvalidFactToSource unless facts_for_dl.include? f[:fact]
+          end
+
+          if s.to_s == SOURCE_USER_SPECIFIED
+            raise errInvalidFactToSource unless facts_for_user.include? f[:fact].to_s
+          end
+
+          if s.to_s == SOURCE_TWITTER
+            raise errInvalidFactToSource unless facts_for_twitter.include? f[:fact].to_s
+          end
+
+          if s.to_s == SOURCE_LINKEDIN
+            raise errInvalidFactToSource unless facts_for_linkedin.include? f[:fact].to_s
+          end
+
+          if s.to_s == SOURCE_FACEBOOK
+            raise errInvalidFactToSource unless facts_for_facebook.include? f[:fact].to_s
+          end
+
+          if s.to_s == SOURCE_LIVE
+            raise errInvalidFactToSource unless facts_for_live.include? f[:fact].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/source_definition.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Do not edit this file, autogenerate it with "rake sources:generate" instead
+module SelfSDK
+  SOURCE_DATA = {
+	"sources" => {
+		"user_specified" => [
+			"document_number",
+			"display_name",
+			"email_address",
+			"phone_number"
+		],
+		"passport" => [
+			"document_number",
+			"surname",
+			"given_names",
+			"date_of_birth",
+			"date_of_expiration",
+			"sex",
+			"nationality",
+			"country_of_issuance"
+		],
+		"driving_license" => [
+			"document_number",
+			"surname",
+			"given_names",
+			"date_of_birth",
+			"date_of_issuance",
+			"date_of_expiration",
+			"address",
+			"issuing_authority",
+			"place_of_birth"
+		],
+		"identity_card" => [
+			"document_number",
+			"surname",
+			"given_names",
+			"date_of_birth",
+			"date_of_expiration",
+			"sex",
+			"nationality",
+			"country_of_issuance"
+		],
+		"twitter" => [
+			"account_id",
+			"nickname"
+		],
+		"linkedin" => [
+			"account_id",
+			"nickname"
+		],
+		"facebook" => [
+			"account_id",
+			"nickname"
+		],
+		"live" => [
+			"selfie_verification"
+		]
+	}
+}
+end

data/lib/sources.rb

@@ -3,66 +3,12 @@
 # frozen_string_literal: true
 
 require "json"
+require_relative "source_definition.rb"
+
 module SelfSDK
   class Sources
     def initialize(sources_file)
-      data = JSON.parse('{
-          "sources": {
-              "user_specified": [
-                  "document_number",
-                  "display_name",
-                  "email_address",
-                  "phone_number"
-              ],
-              "passport": [
-                  "document_number",
-                  "surname",
-                  "given_names",
-                  "date_of_birth",
-                  "date_of_expiration",
-                  "sex",
-                  "nationality",
-                  "country_of_issuance"
-              ],
-              "driving_license": [
-                  "document_number",
-                  "surname",
-                  "given_names",
-                  "date_of_birth",
-                  "date_of_issuance",
-                  "date_of_expiration",
-                  "address",
-                  "issuing_authority",
-                  "place_of_birth"
-              ],
-              "identity_card": [
-                  "document_number",
-                  "surname",
-                  "given_names",
-                  "date_of_birth",
-                  "date_of_expiration",
-                  "sex",
-                  "nationality",
-                  "country_of_issuance"
-              ],
-              "twitter": [
-                  "account_id",
-                  "nickname"
-              ],
-              "linkedin": [
-                  "account_id",
-                  "nickname"
-              ],
-              "facebook": [
-                  "account_id",
-                  "nickname"
-              ],
-              "live": [
-                  "selfie_verification"
-              ]
-          }
-      }')
-      @sources = data["sources"]
+      @sources = SOURCE_DATA["sources"]
       @facts = []
       @sources.each do |source, facts|
         @facts.push(*facts)
@@ -92,9 +38,7 @@ module SelfSDK
     end
 
     def message_type(s)
-      types = { authentication_request: SelfSDK::Messages::AuthenticationReq::MSG_TYPE,
-                authentication_response: SelfSDK::Messages::AuthenticationResp::MSG_TYPE,
-                fact_request: SelfSDK::Messages::FactRequest::MSG_TYPE,
+      types = { fact_request: SelfSDK::Messages::FactRequest::MSG_TYPE,
                 fact_response: SelfSDK::Messages::FactResponse::MSG_TYPE,
                 chat_message: SelfSDK::Messages::ChatMessage::MSG_TYPE,
                 chat_message_deivered: SelfSDK::Messages::ChatMessageDelivered::MSG_TYPE,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selfsdk
 version: !ruby/object:Gem::Version
-  version: 0.0.196
+  version: 0.0.197
 platform: ruby
 authors:
 - Aldgate Ventures
@@ -334,9 +334,6 @@ files:
 - lib/jwt_service.rb
 - lib/log.rb
 - lib/messages/attestation.rb
-- lib/messages/authentication_message.rb
-- lib/messages/authentication_req.rb
-- lib/messages/authentication_resp.rb
 - lib/messages/base.rb
 - lib/messages/chat.rb
 - lib/messages/chat_invite.rb
@@ -359,7 +356,9 @@ files:
 - lib/services/facts.rb
 - lib/services/identity.rb
 - lib/services/messaging.rb
+- lib/services/requester.rb
 - lib/signature_graph.rb
+- lib/source_definition.rb
 - lib/sources.rb
 homepage: https://www.joinself.com/
 licenses:

data/lib/messages/authentication_message.rb

@@ -1,31 +0,0 @@
-# Copyright 2020 Self Group Ltd. All Rights Reserved.
-
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../ntptime'
-
-module SelfSDK
-  module Messages
-    class AuthenticationMessage < Base
-
-      def parse(input, envelope=nil)
-        @input = input
-        @typ = @typ
-        @payload = get_payload input
-        @id = payload[:cid]
-        @from = payload[:iss]
-        @to = payload[:sub]
-        @audience = payload[:aud]
-        @from_device = payload[:device_id]
-        @expires = ::Time.parse(payload[:exp])
-        @issued = ::Time.parse(payload[:iat])
-        @status = payload[:status]
-        if envelope
-          issuer = envelope.sender.split(":")
-          @from_device = issuer.last
-        end
-      end
-    end
-  end
-end

data/lib/messages/authentication_req.rb

@@ -1,55 +0,0 @@
-# Copyright 2020 Self Group Ltd. All Rights Reserved.
-
-# frozen_string_literal: true
-
-require 'self_msgproto'
-require_relative 'base'
-require_relative '../ntptime'
-require_relative 'authentication_message'
-
-module SelfSDK
-  module Messages
-    class AuthenticationReq < AuthenticationMessage
-      MSG_TYPE = "identities.authenticate.req"
-      DEFAULT_EXP_TIMEOUT = 300
-
-      def initialize(messaging)
-        @typ = MSG_TYPE
-        super
-      end
-
-      def populate(selfid, opts)
-        @id = SecureRandom.uuid
-        @from = @client.jwt.id
-        @to = selfid
-
-        @id = opts[:cid] if opts.include?(:cid)
-        @description = opts.include?(:description) ? opts[:description] : nil
-        @exp_timeout = opts.fetch(:exp_timeout, DEFAULT_EXP_TIMEOUT)
-      end
-
-      def body
-        { typ: MSG_TYPE,
-          iss: @jwt.id,
-          sub: @to,
-          aud: @to,
-          iat: SelfSDK::Time.now.strftime('%FT%TZ'),
-          exp: (SelfSDK::Time.now + @exp_timeout).strftime('%FT%TZ'),
-          cid: @id,
-          jti: SecureRandom.uuid }
-      end
-
-      protected
-
-      def proto(to_device)
-        m = SelfMsg::Message.new
-        m.id = @id
-        m.sender = "#{@jwt.id}:#{@messaging.device_id}"
-        m.recipient = "#{@to}:#{to_device}"
-        m.ciphertext = encrypt_message(@jwt.prepare(body), [{ id: @to, device_id: to_device }])
-        m
-      end
-
-    end
-  end
-end

data/lib/messages/authentication_resp.rb

@@ -1,25 +0,0 @@
-# Copyright 2020 Self Group Ltd. All Rights Reserved.
-
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../ntptime'
-require_relative 'authentication_message'
-
-module SelfSDK
-  module Messages
-    class AuthenticationResp < AuthenticationMessage
-      MSG_TYPE = "identities.authenticate.resp"
-      def initialize(messaging)
-        @typ = MSG_TYPE
-        super
-      end
-
-      protected
-
-      def proto(to_device)
-        nil
-      end
-    end
-  end
-end