selfsdk 0.0.124

data/lib/services/facts.rb

@@ -0,0 +1,138 @@
+# 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 authentication requests on self network.
+    class Facts
+      # 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 = 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 block with a street name for each result.
+      #  @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.
+      #  @return [Object] SelfSDK:::Messages::FactRequest
+      def request(selfid, facts, opts = {}, &block)
+        SelfSDK.logger.info "authenticating #{selfid}"
+
+        req = SelfSDK::Messages::FactRequest.new(@messaging)
+        req.populate(selfid, prepare_facts(facts), opts)
+
+        body = @client.jwt.prepare(req.body)
+        return body unless opts.fetch(:request, true)
+
+        # 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
+      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(&block)
+        @messaging.subscribe(:fact_response, &block)
+      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://selfid.page.link/?link=#{callback}%3Fqr=#{body}&apn=net.selfid.app"
+        elsif @client.env == 'development'
+          return "https://selfid.page.link/?link=#{callback}%3Fqr=#{body}&apn=net.selfid.app.dev"
+        end
+        "https://selfid.page.link/?link=#{callback}%3Fqr=#{body}&apn=net.selfid.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|
+          fs << if f.is_a?(Hash)
+                  f
+                else
+                  { fact: f }
+                end
+        end
+        fs
+      end
+    end
+  end
+end

data/lib/services/identity.rb

@@ -0,0 +1,44 @@
+# 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
+    # Input class to request for identities and apps
+    class Identity
+      # Creates a new identity service.
+      # Identity service allows you request information for your connected users / apps.
+      #
+      # @param [SelfSDK::Client] client http client object.
+      #
+      # @return [SelfSDK::Services::Identity] facts service.
+      def initialize(client)
+        @client = client
+      end
+
+      # Gets registered devices for a self identity
+      #
+      # @param [String] selfid identity/app selfID
+      # @return [Array] array of device ids for the given selfid
+      def devices(selfid)
+        @client.devices(selfid)
+      end
+
+      # Gets an identity public keys
+      #
+      # @param [String] selfid gets the identity details (app/user)
+      # @return [Array] with the identity public keys
+      def public_keys(selfid)
+        @client.public_keys(selfid)
+      end
+
+      # Gets an app/identity details
+      #
+      # @param [String] selfid gets the identity details (app/user)
+      # @return [Hash] with identity details
+      def get(selfid)
+        @client.entity(selfid)
+      end
+    end
+  end
+end

data/lib/services/messaging.rb

@@ -0,0 +1,100 @@
+# 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
+    # Input class to interact with self network messaging.
+    class Messaging
+      # TODO : we should try to remove this accessor.
+      # @attr_accessor [SelfSDK::Messaging] internal messaging client.
+      attr_accessor :client
+
+      # Creates a new messaging service.
+      # Messaging service basically allows you to subscribe to certain types of messages,
+      # and manage who can send you messages or not.
+      #
+      # @param client [SelfSDK::Messaging] messaging object.
+      #
+      # @return [SelfSDK::Services::Messaging] authentication service.
+      def initialize(client)
+        @client = client
+      end
+
+      # 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
+      # @yield [SelfSDK::Messages::Message] receives incoming message.
+      def subscribe(type, &block)
+        @client.subscribe(type, &block)
+      end
+
+      # Permits incoming messages from the a identity.
+      #
+      # @param [String] selfid to be allowed.
+      # @return [Boolean] success / failure
+      def permit_connection(selfid)
+        acl.allow selfid
+      end
+
+      # Lists app allowed connections.
+      # @return [Array] array of self ids allowed to connect to your app.
+      def allowed_connections
+        acl.list
+      end
+
+      # Revokes incoming messages from the given identity.
+      #
+      # @param [String] selfid to be denied
+      # @return [Boolean] success / failure
+      def revoke_connection(selfid)
+        acl.deny selfid
+      end
+
+      # Gets the device id for the authenticated app.
+      #
+      # @return [String] device_id of the running app.
+      def device_id
+        @client.device_id
+      end
+
+      # Get the observer by uuid
+      #
+      # @param [String] cid conversation id
+      def observer(cid)
+        @client.uuid_observer[cid]
+      end
+
+
+      # Send custom mmessage
+      #
+      # @param recipient [string] recipient for the message
+      # @param type [string] message type
+      # @param request [hash] message to be sent
+      def send(recipient, request)
+        request[:jti] = SecureRandom.uuid
+        request[:iss] = @client.jwt.id
+        request[:sub] = recipient
+        request[:iat] = SelfSDK::Time.now.strftime('%FT%TZ'),
+        request[:exp] = (SelfSDK::Time.now + 300).strftime('%FT%TZ'),
+        request[:cid] = SecureRandom.uuid unless request.include? :cid
+
+        @client.send_custom(recipient, request)
+      end
+
+      def notify(recipient, message)
+        send recipient, {
+            typ: 'identities.notify',
+            description: message
+          }
+      end
+
+      private
+
+      def acl
+        @acl ||= ACL.new(@client)
+      end
+    end
+  end
+end

data/lib/sources.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module SelfSDK
+  FACT_EMAIL = "email_address"
+  FACT_PHONE = "phone_number"
+  FACT_DISPLAY_NAME = "display_name"
+  FACT_DOCUMENT_NUMBER = "document_number"
+  FACT_GIVEN_NAMES = "given_names"
+  FACT_SURNAME = "surname"
+  FACT_SEX = "sex"
+  FACT_ISSUING_AUTHORITY = "issuing_authority"
+  FACT_NATIONALITY = "nationality"
+  FACT_ADDRESS = "address"
+  FACT_PLACE_OF_BIRTH = "place_of_birth"
+  FACT_DATE_OF_BIRTH = "date_of_birth"
+  FACT_DATE_OF_ISSUANCE = "date_of_issuance"
+  FACT_DATE_OF_EXPIRATION = "date_of_expiration"
+
+  SOURCE_USER_SPECIFIED = "user_specified"
+  SOURCE_PASSPORT = "passport"
+  SOURCE_DRIVING_LICENSE = "driving_license"
+
+  class << self
+    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,
+                fact_response: SelfSDK::Messages::FactResponse::MSG_TYPE }
+      raise "invalid message type" unless types.key? s
+      return types[s]
+    end
+
+    def operator(input)
+      operators = { equals: '==',
+                    different: '!=',
+                    great_or_equal_than: '>=',
+                    less_or_equal: '<=',
+                    great_than: '>',
+                    less_than: '<' }
+      get(operators, input, "operator")
+    end
+
+    def fact_name(input)
+      facts = { email_address: FACT_EMAIL,
+                phone_number: FACT_PHONE,
+                display_name: FACT_DISPLAY_NAME,
+                document_number: FACT_DOCUMENT_NUMBER,
+                given_names: FACT_GIVEN_NAMES,
+                surname: FACT_SURNAME,
+                sex: FACT_SEX,
+                issuing_authority: FACT_ISSUING_AUTHORITY,
+                nationality: FACT_NATIONALITY,
+                address: FACT_ADDRESS,
+                place_of_birth: FACT_PLACE_OF_BIRTH,
+                date_of_birth: FACT_DATE_OF_BIRTH,
+                date_of_issuance: FACT_DATE_OF_ISSUANCE,
+                date_of_expiration: FACT_DATE_OF_EXPIRATION }
+      get(facts, input, "fact")
+    end
+
+    def source(input)
+      sources = { user_specified: SOURCE_USER_SPECIFIED,
+                passport: SOURCE_PASSPORT,
+                driving_license: SOURCE_DRIVING_LICENSE }
+      get(sources, input, "source")
+    end
+
+    def get(options, input, option_type)
+      if input.is_a? Symbol
+        raise "invalid #{option_type} '#{input.to_s}'" unless options.key? input
+        return options[input]
+      end
+      raise "invalid #{option_type} '#{input}'" unless options.values.include? input
+      input
+    end
+
+  end
+end

metadata

@@ -0,0 +1,354 @@
+--- !ruby/object:Gem::Specification
+name: selfsdk
+version: !ruby/object:Gem::Version
+  version: 0.0.124
+platform: ruby
+authors:
+- Aldgate Ventures
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: pry
+  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: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: webmock
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: semantic
+  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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acl.rb
+- lib/authenticated.rb
+- lib/client.rb
+- 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/fact.rb
+- lib/messages/fact_request.rb
+- lib/messages/fact_response.rb
+- lib/messages/message.rb
+- lib/messaging.rb
+- lib/ntptime.rb
+- lib/proto/acl_pb.rb
+- lib/proto/aclcommand_pb.rb
+- lib/proto/auth_pb.rb
+- lib/proto/errtype_pb.rb
+- lib/proto/header_pb.rb
+- lib/proto/message_pb.rb
+- lib/proto/msgtype_pb.rb
+- lib/proto/notification_pb.rb
+- lib/selfsdk.rb
+- lib/services/auth.rb
+- lib/services/facts.rb
+- lib/services/identity.rb
+- lib/services/messaging.rb
+- lib/sources.rb
+homepage: https://www.joinself.com/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/proto
+- lib/messages
+- lib/services
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: self id gem
+test_files: []