Merge pull request #23 from cipherstash/add-log-in-method

Add `CipherStash::Client.login` class method

Author: CDThomas

lib/cipherstash/client.rb

@@ -31,6 +31,26 @@ def self.client_options
       Profile.profile_options
     end
 
+
+    # Log into a CipherStash workspace.
+    #
+    # If `workspace` is given, a profile will be created for that workspace.
+    # This is useful for logging into a workspace for the first time.
+    #
+    # If a workspace is not provided, this command will load an existing profile and then log in using that profile.
+    # The profile name defaults to "default", but can be overridden with the `CS_PROFILE_NAME` env var or the `defaultProfile` opt in `{cs_config_path}/config.json`.
+    #
+    # @return [TrueClass]
+    #
+    # @raise [CipherStash::Client::Error::CreateProfileFailure] if a workspace is given and a new profile could not be created.
+    #
+    # @raise [CipherStash::Client::Error::LoadProfileFailure] if a workspace is not given and an existing profile could not be loaded.
+    #
+    def self.login(workspace: nil, profile_name: nil, logger: default_logger)
+      Profile.login(workspace: workspace, profile_name: profile_name, logger: logger)
+      true
+    end
+
     # Create a new CipherStash client.
     #
     # No options are necessary in the common case.
@@ -79,7 +99,7 @@ def self.client_options
     #
     def initialize(profileName: Unspecified, logger: Unspecified, metrics: Metrics::Null.new, rpc_class: RPC, **opts)
       @logger = if logger == Unspecified
-                  Logger.new($stderr).tap { |l| l.level = Logger::WARN; l.formatter = ->(_, _, _, m) { "#{m}\n" } }
+                  self.class.default_logger
                 else
                   logger
                 end
@@ -249,6 +269,13 @@ def generate_naming_key
 
     private
 
+    def self.default_logger
+      Logger.new($stderr).tap do |l|
+        l.level = Logger::WARN
+        l.formatter = ->(_, _, _, m) { "#{m}\n" }
+      end
+    end
+
     def console
       @profile.with_access_token do |token|
         Console.new(access_token: token[:access_token], logger: @logger)

lib/cipherstash/client/profile.rb

@@ -92,7 +92,6 @@ def self.create(name, logger, **opts)
           if name == "default"
             incoming_workspace_id = opts[:workspace]
 
-
             profile_config = File.read(File.expand_path("~/.cipherstash/#{name}/profile-config.json"))
             parsed_profile_config = JSON.parse(profile_config)
 
@@ -127,6 +126,17 @@ def self.create(name, logger, **opts)
         profile.save
       end
 
+      def self.login(workspace:, profile_name:, logger:)
+        is_initial_login = !workspace.nil?
+        profile_name = resolve_profile_name(profile_name)
+
+        if is_initial_login
+          create(profile_name, logger, workspace: workspace)
+        else
+          load(profile_name, logger).login
+        end
+      end
+
       class << self
         private
 
@@ -530,6 +540,13 @@ def generate_naming_key
         end
       end
 
+      def login
+        access_token_creds_provider = access_token_provider(**symbolize_keys(identity_provider_config))
+        access_token_creds_provider.fresh_credentials
+
+        self
+      end
+
       private
 
       def access_token_provider(kind:, **opts)