match 0.1.0

data/lib/match/options.rb

@@ -0,0 +1,94 @@
+require 'fastlane_core'
+require 'credentials_manager'
+
+module Match
+  class Options
+    def self.available_options
+      user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
+      user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+      [
+        FastlaneCore::ConfigItem.new(key: :git_url,
+                                     env_name: "MATCH_GIT_URl",
+                                     description: "URL to the git repo containing all the certificates",
+                                     optional: false,
+                                     short_option: "-r",
+                                     verify_block: proc do |value|
+                                       unless value.start_with?("https://") || value.start_with?("git")
+                                         raise "git_url must start with either https:// or git://".red
+                                       end
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :type,
+                                     env_name: "MATCH_TYPE",
+                                     description: "Create a development certificate instead of a distribution one",
+                                     is_string: true,
+                                     short_option: "-y",
+                                     default_value: 'development',
+                                     verify_block: proc do |value|
+                                       unless Match.environments.include?(value)
+                                         raise "Unsupported environment #{value}, must be in #{Match.environments.join(', ')}".red
+                                       end
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                     short_option: "-a",
+                                     env_name: "MATCH_APP_IDENTIFIER",
+                                     description: "The bundle identifier of your app",
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
+        FastlaneCore::ConfigItem.new(key: :username,
+                                     short_option: "-u",
+                                     env_name: "MATCH_USERNAME",
+                                     description: "Your Apple ID Username",
+                                     default_value: user),
+        FastlaneCore::ConfigItem.new(key: :keychain_name,
+                                     short_option: "-s",
+                                     env_name: "MATCH_KEYCHAIN_NAME",
+                                     description: "Keychain the items should be imported to",
+                                     default_value: "login.keychain"),
+        FastlaneCore::ConfigItem.new(key: :readonly,
+                                     env_name: "MATCH_READONLY",
+                                     description: "Only fetch existing certificates and profiles, don't generate new ones",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :team_id,
+                                     short_option: "-b",
+                                     env_name: "MATCH_TEAM_ID",
+                                     description: "The ID of your team if you're in multiple teams",
+                                     optional: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_ID"] = value
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :team_name,
+                                     short_option: "-l",
+                                     env_name: "MATCH_TEAM_NAME",
+                                     description: "The name of your team if you're in multiple teams",
+                                     optional: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_name),
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_NAME"] = value
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :verbose,
+                                     env_name: "MATCH_VERBOSE",
+                                     description: "Print out extra information and all commands",
+                                     is_string: false,
+                                     default_value: false,
+                                     verify_block: proc do |value|
+                                       $verbose = true if value
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :force,
+                                     env_name: "MATCH_FORCE",
+                                     description: "Renew the provisioning profiles every time you run match",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :workspace,
+                                     description: nil,
+                                     verify_block: proc do |value|
+                                       unless Helper.test?
+                                         raise "Specify the `git_url` instead of the `path`".red unless value.start_with?("/var/folders")
+                                       end
+                                     end,
+                                     optional: true)
+      ]
+    end
+  end
+end

data/lib/match/runner.rb

@@ -0,0 +1,93 @@
+module Match
+  class Runner
+    attr_accessor :changes_to_commit
+
+    def run(params)
+      FastlaneCore::PrintTable.print_values(config: params,
+                                         hide_keys: [:workspace],
+                                             title: "Summary for match #{Match::VERSION}")
+
+      params[:workspace] = GitHelper.clone(params[:git_url])
+      spaceship = SpaceshipEnsure.new(params[:username]) unless params[:readonly]
+
+      # Verify the App ID (as we don't want 'match' to fail at a later point)
+      spaceship.bundle_identifier_exists(params) if spaceship
+
+      # Certificate
+      cert_id = certificate(params: params)
+      spaceship.certificate_exists(params, cert_id) if spaceship
+
+      # Provisioning Profile
+      uuid = profile(params: params,
+                     certificate_id: cert_id)
+      spaceship.profile_exists(params, uuid) if spaceship
+
+      # Done
+      if self.changes_to_commit
+        message = GitHelper.generate_commit_message(params)
+        GitHelper.commit_changes(params[:workspace], message, params[:git_url])
+      else
+        GitHelper.clear_changes
+      end
+
+      TablePrinter.print_summary(params, uuid)
+
+      UI.success "All required keys, certificates and provisioning profiles are installed 🙌".green
+    end
+
+    def certificate(params: nil)
+      cert_type = :distribution
+      cert_type = :development if params[:type] == "development"
+
+      certs = Dir[File.join(params[:workspace], "certs", cert_type.to_s, "*.cer")]
+      keys = Dir[File.join(params[:workspace], "certs", cert_type.to_s, "*.p12")]
+
+      if certs.count == 0 or keys.count == 0
+        UI.important "Couldn't find a valid code signing identity in the git repo for #{cert_type}... creating one for you now"
+        UI.crash!("No code signing identity found and can not create a new one because you enabled `readonly`") if params[:readonly]
+        cert_path = Generator.generate_certificate(params, cert_type)
+        self.changes_to_commit = true
+      else
+        cert_path = certs.last
+        UI.message "Installing certificate..."
+
+        if FastlaneCore::CertChecker.installed?(cert_path)
+          UI.verbose "Certificate '#{File.basename(cert_path)}' is already installed on this machine"
+        else
+          Utils.import(cert_path, params[:keychain_name])
+        end
+
+        # Import the private key
+        # there seems to be no good way to check if it's already installed - so just install it
+        Utils.import(keys.last, params[:keychain_name])
+      end
+
+      return File.basename(cert_path).gsub(".cer", "") # Certificate ID
+    end
+
+    def profile(params: nil, certificate_id: nil)
+      prov_type = params[:type].to_sym
+
+      profile_name = [prov_type.to_s, params[:app_identifier]].join("_").gsub("*", '\*') # this is important, as it shouldn't be a wildcard
+      profiles = Dir[File.join(params[:workspace], "profiles", prov_type.to_s, "#{profile_name}.mobileprovision")]
+
+      # Install the provisioning profiles
+      profile = profiles.last
+      if profile.nil? or params[:force]
+        UI.crash!("No matching provisioning profiles found and can not create a new one because you enabled `readonly`") if params[:readonly]
+        profile = Generator.generate_provisioning_profile(params: params,
+                                                       prov_type: prov_type,
+                                                  certificate_id: certificate_id)
+        self.changes_to_commit = true
+      end
+
+      FastlaneCore::ProvisioningProfile.install(profile)
+
+      parsed = FastlaneCore::ProvisioningProfile.parse(profile)
+      uuid = parsed["UUID"]
+      Utils.fill_environment(params, uuid)
+
+      return uuid
+    end
+  end
+end

data/lib/match/setup.rb

@@ -0,0 +1,20 @@
+module Match
+  class Setup
+    def run(path)
+      template = File.read("#{Helper.gem_path('match')}/lib/assets/MatchfileTemplate")
+
+      UI.important "Please create a new, private git repository"
+      UI.important "to store the certificates and profiles there"
+      url = ask("URL of the Git Repo: ")
+
+      template.gsub!("[[GIT_URL]]", url)
+      File.write(path, template)
+      UI.success "Successfully created '#{path}'. You can open the file using a code editor."
+
+      UI.important "You can now run `match development`, `match adhoc` and `fastlane appstore`"
+      UI.message "On the first run for each environment it will create the provisioning profiles and"
+      UI.message "certificates for you. From then on, it will automatically import the existing profiles."
+      UI.message "For more information visit https://github.com/fastlane/match"
+    end
+  end
+end

data/lib/match/spaceship_ensure.rb

@@ -0,0 +1,64 @@
+module Match
+  # Ensures the certificate and profiles are also available on iTunes Connect
+  class SpaceshipEnsure
+    def initialize(user)
+      # We'll try to manually fetch the password
+      # to tell the user that a password is optional
+      require 'credentials_manager'
+
+      keychain_entry = CredentialsManager::AccountManager.new(user: user)
+
+      if keychain_entry.password(ask_if_missing: false).to_s.length == 0
+        UI.important("You can also run `match` in readonly mode to not require any access to the")
+        UI.important("Developer Portal. This way you only share the keys and credentials")
+        UI.command("match --readonly")
+        UI.important("More information https://github.com/fastlane/match#access-control")
+      end
+
+      UI.message("Verifying that the certificate and profile are still valid on the Dev Portal...")
+      Spaceship.login(user)
+      Spaceship.select_team
+    end
+
+    def bundle_identifier_exists(params)
+      found = Spaceship.app.find(params[:app_identifier])
+      return if found
+
+      require 'sigh'
+      Sigh::Runner.new.print_produce_command({
+        username: params[:username],
+        app_identifier: params[:app_identifier]
+      })
+      UI.error("An app with that bundle ID needs to exist in order to create a provisioning profile for it")
+      UI.error("================================================================")
+      UI.error("Make sure to run `match` with the same user and team every time.")
+      UI.user_error!("Couldn't find bundle identifier '#{params[:app_identifier]}' for the user '#{params[:username]}'")
+    end
+
+    def certificate_exists(params, certificate_id)
+      found = Spaceship.certificate.all.find do |cert|
+        cert.id == certificate_id
+      end
+      return if found
+
+      UI.error("Certificate '#{certificate_id}' (stored in your git repo) is not available on the Developer Portal")
+      UI.error("for the user #{params[:username]}")
+      UI.error("Make sure to use the same user and team every time you run 'match' for this")
+      UI.error("Git repository. This might be caused by revoking the certificate on the Dev Portal")
+      UI.user_error!("To reset the certificates of your Apple account, you can use the `match nuke` feature, more information on https://github.com/fastlane/match")
+    end
+
+    def profile_exists(params, uuid)
+      found = Spaceship.provisioning_profile.all.find do |profile|
+        profile.uuid == uuid
+      end
+      return if found
+
+      UI.error("Provisioning profile '#{uuid}' is not available on the Developer Portal")
+      UI.error("for the user #{params[:username]}")
+      UI.error("Make sure to use the same user and team every time you run 'match' for this")
+      UI.error("Git repository. This might be caused by deleting the provisioning profile on the Dev Portal")
+      UI.user_error!("To reset the provisioning profiles of your Apple account, you can use the `match nuke` feature, more information on https://github.com/fastlane/match")
+    end
+  end
+end

data/lib/match/table_printer.rb

@@ -0,0 +1,20 @@
+module Match
+  class TablePrinter
+    def self.print_summary(params, uuid)
+      rows = []
+
+      rows << ["App Identifier", params[:app_identifier]]
+      rows << ["Type", params[:type]]
+      rows << ["UUID", uuid]
+      rows << ["Environment Variable", Utils.environment_variable_name(params)]
+
+      params = {}
+      params[:rows] = rows
+      params[:title] = "Installed Provisioning Profile".green
+
+      puts ""
+      puts Terminal::Table.new(params)
+      puts ""
+    end
+  end
+end

data/lib/match/utils.rb

@@ -0,0 +1,24 @@
+module Match
+  class Utils
+    def self.import(item_path, keychain)
+      command = "security import #{item_path.shellescape} -k ~/Library/Keychains/#{keychain.shellescape}"
+      command << " -T /usr/bin/codesign" # to not be asked for permission when running a tool like `gym`
+      command << " -T /usr/bin/security"
+      command << "&> /dev/null" # we couldn't care less about the output
+
+      Helper.backticks(command, print: $verbose)
+    end
+
+    # Fill in the UUID of the profiles in environment variables, much recycling
+    def self.fill_environment(params, uuid)
+      # instead we specify the UUID of the profiles
+      key = environment_variable_name(params)
+      UI.important "Setting environment variable '#{key}' to '#{uuid}'" if $verbose
+      ENV[key] = uuid
+    end
+
+    def self.environment_variable_name(params)
+      ["sigh", params[:app_identifier], params[:type]].join("_")
+    end
+  end
+end

data/lib/match/version.rb

@@ -0,0 +1,4 @@
+module Match
+  VERSION = "0.1.0"
+  DESCRIPTION = "Easily sync your certificates and profiles across your team using git"
+end

metadata

@@ -0,0 +1,303 @@
+--- !ruby/object:Gem::Specification
+name: match
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Krause
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: security
+  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: fastlane_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: credentials_manager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: spaceship
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sigh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: cert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: fastlane
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+description: Easily sync your certificates and profiles across your team using git
+email:
+- match@krausefx.com
+executables:
+- match
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/match
+- lib/assets/MatchfileTemplate
+- lib/assets/READMETemplate.md
+- lib/match.rb
+- lib/match/encrypt.rb
+- lib/match/generator.rb
+- lib/match/git_helper.rb
+- lib/match/nuke.rb
+- lib/match/options.rb
+- lib/match/runner.rb
+- lib/match/setup.rb
+- lib/match/spaceship_ensure.rb
+- lib/match/table_printer.rb
+- lib/match/utils.rb
+- lib/match/version.rb
+homepage: https://fastlane.tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.0
+signing_key: 
+specification_version: 4
+summary: Easily sync your certificates and profiles across your team using git
+test_files: []
+has_rdoc: