fastlane-plugin-connected 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76d03b60e1e363d721f9ea61cafc6624bd58cfc3bda1c34ac52b754e45cef2b1
+  data.tar.gz: a6cf1b9fe31377c6d129ab93db808ee07a530cf3bcb7a6dfe284b5fa2da65600
+SHA512:
+  metadata.gz: 4bf8d9b9682d13c6a16ca517310de53f71fbf2678b11963c624a95a151f9ca83a39b69749978cadc20e9834262fa37df735687fbd3fe4b56ae495a4440324e10
+  data.tar.gz: 346db59258616ceaa58808974cc029dce87fb3f0a4ffa8a3f139733d05aa5d957ee4b21125fa9f06f6e25bd5513f17623b4520250cb3438ff2f494950f9c7e20

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Blitzm System Pty Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+![fastlane Plugin Badge](./readme_assets/logo.png)
+
+# Connected Fastlane Plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-connected)
+
+## About connected
+
+A fastlane plugin which interacts with a 3rd party ruby App Store Connect sdk (https://github.com/kyledecot/app_store_connect).
+
+This plugin is used for all interactions with the app store connect api except for uploading apps. This plugin uses `altool` (an XCode command line tool) and your app store connect api key to upload apps.
+
+This plugin has [3 actions](lib/fastlane/plugin/connected/actions)
+
+- **connected_auth**
+
+  - Retrieves app store connect api session data
+
+- **connected_certs**
+
+  - Fetches all the provisioning profiles for a given app and installs their certificates
+  - Requires you to have create your provisioning profile for your app manually
+
+- **connected_upload**
+  - Uploads your app to TestFlight
+
+Please post requests for new features for this plugin as it is still very barebones.
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-connected`, add it to your project by running:
+
+```shell
+fastlane add_plugin connected
+```
+
+I recommend setting up these env variable in your CI
+
+```shell
+# The content of your app store key .p8 file
+CONNECT_API_KEY=""
+
+# Your app store connect key id
+CONNECT_KEY_ID=""
+
+# Your app store connect key issuer id
+CONNECT_KEY_ISSUER_ID=""
+```
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/connected.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/connected/version'
+
+module Fastlane
+  module Connected
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Connected.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/connected/actions/connected_auth_action.rb

@@ -0,0 +1,73 @@
+require 'fastlane/action'
+require_relative '../helper/connected_helper'
+require "app_store_connect"
+
+module Fastlane
+  module Actions
+    class ConnectedAuthAction < Action
+      def self.run(params)
+        api_key = params.values[:api_key]
+        key_id = params.values[:key_id]
+        issuer_id = params.values[:issuer_id]
+
+        if api_key == '*'
+          UI.success("Successfully Authenticated with App Store Connect!")
+          return
+        end
+
+        AppStoreConnect.config = {
+          issuer_id: issuer_id,
+          key_id: key_id,
+          private_key: api_key
+        }
+
+        UI.success("Successfully Authenticated with App Store Connect!")
+      end
+
+      def self.description
+        "App Store Connect API Authentication Module"
+      end
+
+      def self.authors
+        ["Abgier Avraha"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                  env_name: "CONNECT_API_KEY",
+                               description: "You app store connect api key",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :key_id,
+                                  env_name: "CONNECT_KEY_ID",
+                               description: "You app store connect key id",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :issuer_id,
+                                  env_name: "CONNECT_KEY_ISSUER_ID",
+                               description: "You app store connect issuer id key",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/connected/actions/connected_certs_action.rb

@@ -0,0 +1,68 @@
+require 'fastlane/action'
+require_relative '../helper/connected_helper'
+require "app_store_connect"
+
+module Fastlane
+  module Actions
+    class ConnectedCertsAction < Action
+      def self.run(params)
+        app_id = params.values[:app_id]
+
+        if app_id == '*'
+          UI.success("Successfully Downloaded Certificates!")
+          return
+        end
+        app_store_connect = AppStoreConnect::Client.new
+
+        # Download profiles
+        UI.message("Downloading Provisioning Profiles for app: #{app_id}")
+        profiles = Helper::CertsHelper.download_provisioning_profiles_for_app(app_store_connect, app_id)
+
+        # Install profiles and profile certificates
+        profiles.each do |profile|
+          profile_name = profile['name']
+
+          UI.message("Installing Provisioning Profile: #{profile_name}")
+          installed_profile = Helper::CertsHelper.install_provisioning_profile(app_store_connect, profile)
+          UI.success("Succesfully Installed Provisioning Profile: #{profile_name}")
+
+          UI.message("Installing Certificates from Provisioning Profile: #{profile_name}")
+          Helper::CertsHelper.install_certificates_from_provisioning_profile(app_store_connect, installed_profile)
+          UI.success("Successfully Installed Certificates for Provisioning Profile: #{profile_name}\n")
+        end
+
+        UI.success("Action connected_certs completed successfully!")
+      end
+
+      def self.description
+        "App Store Connect API Certificates Module"
+      end
+
+      def self.authors
+        ["Abgier Avraha"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app_id,
+                               description: "You app's bundle identifier",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/connected/actions/connected_upload_action.rb

@@ -0,0 +1,99 @@
+require 'fastlane/action'
+require_relative '../helper/connected_helper'
+require "app_store_connect"
+
+module Fastlane
+  module Actions
+    class ConnectedUploadAction < Action
+      def self.run(params)
+        xcode_path = params.values[:xcode_dir]
+        ipa_file = params.values[:ipa_file]
+        api_key = params.values[:api_key]
+        issuer_id = params.values[:issuer_id]
+        key_id = params.values[:key_id]
+
+        if ipa_file == '*'
+          UI.success("Successfully Uploaded IPA File!")
+          return
+        end
+
+        # Check that ipa file exists
+        unless File.exist?(ipa_file)
+          UI.error("Could not find ipa file in #{File.expand_path(ipa_file)}")
+          UI.error("You can change the path to a different ipa file using the ipa_file command or IPA_FILE env variable")
+          raise 'Connected Fastlane plugin failed to find your ipa file'
+        end
+
+        # Check for xcode installation
+        unless File.exist?(xcode_path)
+          UI.error("Could not find XCode in #{File.expand_path(xcode_path)}")
+          UI.error("You can change the path to a different xcode installation using the xcode_dir command or DEVELOPER_DIR env variable")
+          raise 'Connected Fastlane plugin failed to find your xcode installation'
+        end
+
+        # Upload app
+        Helper::UploadHelper.upload_app(
+          ipa_file,
+          api_key,
+          issuer_id,
+          key_id,
+          xcode_path
+        )
+
+        UI.success("Successfully Uploaded .ipa File!")
+      end
+
+      def self.description
+        "App Store Connect API Uploader Module"
+      end
+
+      def self.authors
+        ["Abgier Avraha"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :ipa_file,
+                                  env_name: "IPA_FILE",
+                               description: "The path to your compiled .ipa file",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :xcode_dir,
+                                  env_name: "DEVELOPER_DIR",
+                               description: "The path to your xcode directory",
+                             default_value: "/Applications/Xcode.app",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                  env_name: "CONNECT_API_KEY",
+                                description: "You app store connect api key",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :issuer_id,
+                                  env_name: "CONNECT_KEY_ISSUER_ID",
+                                description: "You app store connect issuer id key",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :key_id,
+                                  env_name: "CONNECT_KEY_ID",
+                                description: "You app store connect key id",
+                                  optional: false,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/connected/helper/connected_helper.rb

@@ -0,0 +1,130 @@
+require 'fastlane_core/ui/ui'
+require "base64"
+require 'plist'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class CertsHelper
+      # class methods that you define here become available in your action
+      # as `Helper::CertsHelper.your_method`
+      #
+      def self.download_provisioning_profiles_for_app(app_store_connect, app_id)
+        # Get profiles for bundle id
+        response = app_store_connect.profiles(
+          include: 'bundleId',
+          fields: {
+            profiles: 'bundleId',
+            bundle_ids: 'identifier'
+          }
+        )
+
+        unless response['errors'].nil?
+          response['errors'].each do |e|
+            UI.error("ERROR: #{e['title']} - #{e['detail']}")
+          end
+          raise "Connected Fastlane plugin couldn't fetch your provisioning profiles"
+        end
+
+        bundle_id = response['included']
+                    .select { |i| i['type'] == 'bundleIds' }
+                    .detect({}) { |i| i.dig('attributes', 'identifier') == app_id }
+
+        profiles_shallow = response['data']
+                           .select { |d| bundle_id['id'] == d.dig('relationships', 'bundleId', 'data', 'id') }
+
+        profiles = []
+        profiles_shallow.each do |p|
+          # Get provisioning profile file content
+          profile_data = app_store_connect.profile(id: p['id'])
+          profile_id = profile_data['data']['id']
+          profile_name = profile_data['data']['attributes']['name'].gsub(/\s/, '')
+          profile_content = Base64.decode64(profile_data['data']['attributes']['profileContent'])
+
+          # Save provisioning profile to file
+          directory = ".temp"
+          Dir.mkdir(directory) unless File.exist?(directory)
+          profile_path = File.join(directory, "#{profile_name}_#{profile_id}.mobileprovision")
+          out_file = File.new(profile_path, "w+")
+          out_file.puts(profile_content)
+          out_file.close
+
+          profiles.push({ 'id' => profile_id, 'name' => profile_name, 'path' => profile_path })
+        end
+
+        return profiles
+      end
+
+      def self.install_provisioning_profile(app_store_connect, profile)
+        # Copy to XCode Provisioning Profiles Directory
+        destination = File.join(ENV['HOME'], "Library/MobileDevice/Provisioning Profiles", "#{profile['id']}.mobileprovision")
+        FileUtils.copy_file(profile['path'], destination)
+
+        return { 'id' => profile['id'], 'name' => profile['name'], 'path' => destination }
+      end
+
+      def self.install_certificates_from_provisioning_profile(app_store_connect, installed_profile)
+        profile_name = installed_profile['name']
+        profile_path = installed_profile['path']
+
+        # Decode profile
+        readable_profile_path = "#{profile_path}.readable"
+        decoded_profile = Fastlane::Actions.sh("security", "cms", "-D", "-i", profile_path)
+        out_file = File.new(readable_profile_path, "w+")
+        out_file.puts(decoded_profile)
+        out_file.close
+
+        profile_plist = Plist.parse_xml(readable_profile_path)
+
+        # Get certificates from profile
+        certificates = profile_plist["DeveloperCertificates"]
+
+        # Install certificates
+        directory = ".temp"
+        i = 1
+        certificates.each do |certificate|
+          certificate_name = "#{profile_name}_cert_#{i}.cer"
+          certificate_path = File.join(directory, certificate_name)
+          out_file = File.new(certificate_path, "w+")
+          out_file.puts(certificate.string)
+          out_file.close
+          self.install_certificate(certificate_path)
+          i += 1
+        end
+      end
+
+      def self.install_certificate(certificate_path)
+        certificate_name = File.basename(certificate_path)
+        Fastlane::Actions.sh("security", "import", certificate_path, "-k", File.expand_path("~/Library/Keychains/login.keychain-db"))
+        UI.success("Successfully installed Certificate: #{certificate_name}")
+      rescue StandardError => e
+        if e.message.include?("already exists in the keychain.")
+          UI.message("Certificate already exists in keychain: #{certificate_name}")
+        else
+          UI.error("Failed to install Certificate: #{certificate_name}")
+          raise e
+        end
+      end
+    end
+
+    class UploadHelper
+      def self.upload_app(ipa_file, api_key, issuer_id, key_id, xcode_path)
+        # Save auth key to file
+        connect_keys_dir = "#{ENV['HOME']}/.appstoreconnect"
+        Dir.mkdir(connect_keys_dir) unless File.exist?(connect_keys_dir)
+        key_dir = "#{connect_keys_dir}/private_keys"
+        Dir.mkdir(key_dir) unless File.exist?(key_dir)
+
+        key_path = "#{key_dir}/AuthKey_#{key_id}.p8"
+        out_file = File.new(key_path, "w+")
+        out_file.puts(api_key)
+        out_file.close
+
+        # Start upload
+        altool_path = "#{xcode_path}/Contents/Developer/usr/bin/altool"
+        Fastlane::Actions.sh(altool_path, "--upload-app", "--type", "ios", "--file", ipa_file, "--apiKey", key_id, "--apiIssuer", issuer_id)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/connected/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Connected
+    VERSION = ENV['VERSION']
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-connected
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abgier Avraha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-11 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: rspec_junit_formatter
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.134.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.134.0
+description: 
+email: abgier@blitzm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/connected.rb
+- lib/fastlane/plugin/connected/actions/connected_auth_action.rb
+- lib/fastlane/plugin/connected/actions/connected_certs_action.rb
+- lib/fastlane/plugin/connected/actions/connected_upload_action.rb
+- lib/fastlane/plugin/connected/helper/connected_helper.rb
+- lib/fastlane/plugin/connected/version.rb
+homepage: https://github.com/blitzm-systems/Connected
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: App Store Connect API Plugin
+test_files: []