credentials_manager 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb04e90a1cb492a279df8a76e2093a1f1018d705
-  data.tar.gz: 6d3c78e61b03826aabd81be335bfcfede200d204
+  metadata.gz: 56e040d8cf60d61b4e29453dde3f9081bc9db207
+  data.tar.gz: cafa285c842eb3ffcf34d309f43caa9c7d199d08
 SHA512:
-  metadata.gz: 2a5778f917936884dd8046282306ab00b45a66912c183f5a62dbe4d43cd5a878fab1ec5492c11d25f4f5fab9ce1919b7010a7499e75342ad3706f7bdb100e377
-  data.tar.gz: f270ca861b2529631f205a20f404b3a99b704c67fa890ca1622099018fe6b2a4ecc17420f7181ed02efe4ad28cd814ee3c9b8a9e0f42c6ca1e63c1108d4c94ca
+  metadata.gz: cd17eb3bc978edfb5c48d9683b473583f52d87f113777254e6b7bea97659ab92ad7cea982728926b2ed3dcded407200928078c69e83fe3bc05730a94f6f35d49
+  data.tar.gz: ca7de8051914d4ceb75ffc5088e40afb73b11eb8b4dc2b3cef9b87f9fa3b77e123af5366fd9cbab88c28e3ee07e3f5934ed0f488aa9bf0226bd29b3c05704c80

data/README.md

@@ -3,7 +3,23 @@ CredentialsManager
 
 `CredentialsManager` is used by most components in the [fastlane.tools](https://fastlane.tools) toolchain.
 
-All code related to your username and password can be found here: [password_manager.rb](https://github.com/KrauseFx/CredentialsManager/blob/master/lib/credentials_manager/password_manager.rb)
+All code related to your username and password can be found here: [account_manager.rb](https://github.com/fastlane/CredentialsManager/blob/master/lib/credentials_manager/account_manager.rb)
+
+## Usage
+Along with the [Ruby libraries](https://github.com/fastlane/credentials_manager#implementing-a-custom-solution) you can use the command line interface to add credentials to the keychain.
+
+**Adding Credentials**
+```sh
+$ fastlane-credentials add --username tcook
+Password: *********
+Credential tcook:********* added to keychain.
+```
+
+**Removing Credentials**
+```sh
+$ fastlane-credentials remove --username tcook
+password has been deleted.
+```
 
 ## Storing in the keychain
 

data/bin/fastlane-credentials

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'credentials_manager'
+
+CredentialsManager::CLI.new.run

data/lib/credentials_manager/account_manager.rb

@@ -41,6 +41,15 @@ module CredentialsManager
       false
     end
 
+    def add_to_keychain
+      Security::InternetPassword.add(server_name, user, password)
+    end
+
+    def remove_from_keychain
+      Security::InternetPassword.delete(server: server_name)
+      @password = nil
+    end
+
     private
 
     def ask_for_login
@@ -64,7 +73,7 @@ module CredentialsManager
       return true if (/darwin/ =~ RUBY_PLATFORM).nil? # mac?, since we don't have access to the helper here
 
       # Now we store this information in the keychain
-      if Security::InternetPassword.add(server_name, user, password)
+      if add_to_keychain
         return true
       else
         puts "Could not store password in keychain".red
@@ -72,11 +81,6 @@ module CredentialsManager
       end
     end
 
-    def remove_from_keychain
-      Security::InternetPassword.delete(server: server_name)
-      @password = nil
-    end
-
     def server_name
       "deliver.#{user}"
     end

data/lib/credentials_manager/appfile_config.rb

@@ -117,7 +117,7 @@ module CredentialsManager
       if lane_name.to_s.split(" ").count > 1
         # That's the legacy syntax 'platform name'
         puts "You use deprecated syntax '#{lane_name}' in your Appfile.".yellow
-        puts "Please follow the Appfile guide: https://github.com/KrauseFx/fastlane/blob/master/docs/Appfile.md".yellow
+        puts "Please follow the Appfile guide: https://github.com/fastlane/fastlane/blob/master/docs/Appfile.md".yellow
         platform, lane_name = lane_name.split(" ")
 
         return unless platform == ENV["FASTLANE_PLATFORM_NAME"]

data/lib/credentials_manager/cli.rb

@@ -0,0 +1,66 @@
+require 'credentials_manager/version'
+require 'commander'
+
+module CredentialsManager
+  class CLI
+    include Commander::Methods
+
+    # Parses command options and executes actions
+    def run
+      program :name, 'CredentialsManager'
+      program :version, ::CredentialsManager::VERSION
+      program :description, 'Manage credentials for fastlane tools.'
+
+      # Command to add entry to Keychain
+      command :add do |c|
+        c.syntax = 'fastlane-credentials add'
+        c.description = 'Adds a fastlane credential to the keychain.'
+
+        c.option '--username username', String, 'Username to add.'
+        c.option '--password password', String, 'Password to add.'
+
+        c.action do |args, options|
+          username = options.username || ask('Username: ')
+          password = options.password || ask('Password: ') { |q| q.echo = '*' }
+
+          add(username, password)
+
+          puts "Credential #{username}:#{'*' * password.length} added to keychain."
+        end
+      end
+
+      # Command to remove credential from Keychain
+      command :remove do |c|
+        c.syntax = 'fastlane-credentials remove'
+        c.description = 'Removes a fastlane credential from the keychain.'
+
+        c.option '--username username', String, 'Username to remove.'
+
+        c.action do |args, options|
+          username = options.username || ask('Username: ')
+
+          remove(username)
+        end
+      end
+
+      run!
+    end
+
+    private
+
+    # Add entry to Apple Keychain using AccountManager
+    def add(username, password)
+      CredentialsManager::AccountManager.new(
+        user: username,
+        password: password
+      ).add_to_keychain
+    end
+
+    # Remove entry from Apple Keychain using AccountManager
+    def remove(username)
+      CredentialsManager::AccountManager.new(
+        user: username
+      ).remove_from_keychain
+    end
+  end
+end

data/lib/credentials_manager/version.rb

@@ -1,3 +1,3 @@
 module CredentialsManager
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/lib/credentials_manager.rb

@@ -1,8 +1,11 @@
-require 'credentials_manager/password_manager'
 require 'credentials_manager/account_manager'
+require 'credentials_manager/cli'
+require 'credentials_manager/appfile_config'
 
 # Third Party code
 require 'colored'
+require 'security'
+require 'highline/import' # to hide the entered password
 
 module CredentialsManager
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: credentials_manager
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.3.5
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: security
   requirement: !ruby/object:Gem::Requirement
@@ -167,16 +181,18 @@ dependencies:
 description: Password manager used in fastlane.tools
 email:
 - fastlane@krausefx.com
-executables: []
+executables:
+- fastlane-credentials
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/fastlane-credentials
 - lib/credentials_manager.rb
 - lib/credentials_manager/account_manager.rb
 - lib/credentials_manager/appfile_config.rb
-- lib/credentials_manager/password_manager.rb
+- lib/credentials_manager/cli.rb
 - lib/credentials_manager/version.rb
 homepage: https://fastlane.tools
 licenses:
@@ -203,4 +219,3 @@ signing_key:
 specification_version: 4
 summary: Password manager used in fastlane.tools
 test_files: []
-has_rdoc: 

data/lib/credentials_manager/password_manager.rb

@@ -1,118 +0,0 @@
-require 'security'
-require 'highline/import' # to hide the entered password
-require 'credentials_manager/appfile_config'
-
-module CredentialsManager
-  # Handles reading out the password from the keychain or asking for login data
-  class PasswordManager
-    # @return [String] The username / email address of the currently logged in user
-    attr_accessor :username
-    # @return [String] The password of the currently logged in user
-    attr_accessor :password
-
-    HOST = "deliver" # there *is* a string appended
-    private_constant :HOST
-
-    # A singleton object, which also makes sure, to use the correct Apple ID
-    # @param id_to_use (String) The Apple ID email address which should be used
-    # @param ask_if_missing (boolean) true by default: if no credentials are found, should the user be asked?
-    def self.shared_manager(id_to_use = nil, ask_if_missing = true)
-      @instance ||= {}
-      return @instance[id_to_use] if @instance[id_to_use]
-      if id_to_use
-        @instance[id_to_use] ||= PasswordManager.new(id_to_use, ask_if_missing)
-      else
-        # No user given, let's see if we have a previously used one
-        return @instance.values.first if @instance.values.count > 0
-
-        # Create a new one
-        @instance[id_to_use] ||= PasswordManager.new(id_to_use, ask_if_missing)
-      end
-    end
-
-    def self.logout
-      @instance = nil
-    end
-
-    # A new instance of PasswordManager.
-    #
-    # This already check the Keychain if there is a username and password stored.
-    # If that's not the case, it will ask for login data via stdin
-    # @param id_to_use (String) Apple ID (e.g. user@apple.com) which should be used for this upload.
-    #  if given, only the password will be asked/loaded.
-    # @param ask_if_missing (boolean) true by default: if no credentials are found, should the user be asked?
-    def initialize(id_to_use = nil, ask_if_missing = true)
-      self.username ||= id_to_use || ENV["DELIVER_USER"] || AppfileConfig.try_fetch_value(:apple_id) || load_from_keychain[0]
-      self.password ||= ENV["DELIVER_PASSWORD"] || load_from_keychain[1]
-
-      if (self.username || '').length == 0 or (self.password || '').length == 0
-        if ask_if_missing
-          puts "No username or password given. You can set environment variables:"
-          puts "DELIVER_USER, DELIVER_PASSWORD"
-
-          ask_for_login
-        end
-      end
-    end
-
-    # This method is called, when the iTunes backend returns that the login data is wrong
-    # This will ask the user, if he wants to re-enter the password
-    def password_seems_wrong
-      puts "It seems like the username or password for the account '#{self.username}' is wrong.".red
-      puts "Please open the Keychain app, switch to `Passwords` and search for `deliver.`".red
-      puts "You can then either remove the outdated entry or directly update it.".red
-    end
-
-    private
-
-    def ask_for_login
-      puts "-------------------------------------------------------------------------------------".green
-      puts "The login information you enter will be stored in your Mac OS Keychain".green
-      puts "More information about that on GitHub: https://github.com/fastlane/credentials_manager".green
-      puts "-------------------------------------------------------------------------------------".green
-
-      username_was_there = self.username
-
-      self.username = ask("Username: ") while (self.username || '').length == 0
-
-      self.password ||= load_from_keychain[1] # maybe there was already something stored in the keychain
-
-      if (self.password || '').length > 0
-        return true
-      else
-        while (self.password || '').length == 0
-          text = "Password: "
-          text = "Password (for #{self.username}): " if username_was_there
-          self.password = ask(text) { |q| q.echo = "*" }
-        end
-
-        # Now we store this information in the keychain
-        # Example usage taken from https://github.com/nomad/cupertino/blob/master/lib/cupertino/provisioning_portal/commands/login.rb
-        unless ENV["FASTLANE_DONT_STORE_PASSWORD"]
-          if Security::InternetPassword.add(hostname, self.username, self.password)
-            return true
-          else
-            puts "Could not store password in keychain".red
-            return false
-          end
-        end
-      end
-    end
-
-    def remove_from_keychain
-      puts "Removing keychain item: #{hostname}".yellow
-      Security::InternetPassword.delete(server: hostname)
-    end
-
-    def load_from_keychain
-      pass = Security::InternetPassword.find(server: hostname)
-
-      return [pass.attributes['acct'], pass.password] if pass
-      return [nil, nil]
-    end
-
-    def hostname
-      [HOST, self.username].join('.')
-    end
-  end
-end