adsedare 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ecc75a51b623a2c9319dee4fb2ed9f276ec02789876663375bc73dc3abd7bae
-  data.tar.gz: 6715ec7cf9f373608e442ba4916a097b1094efee050a05639fe14dfaf1c0dead
+  metadata.gz: 5ac823e1a7112068b8ad2a7df14432af30254bf2172f8faeca7e793c4abf5a36
+  data.tar.gz: 0251b7ec744b21bc36bc77c04fb92101496cbc3290b012a846cbb0a1ff67cd0e
 SHA512:
-  metadata.gz: 1251ab137c4071f94587385a0211273f71e93652d3714f7da8ac20a87df8caf5e55d8003a1b6a419b7ac33f9dccae7e89f1d6e71ae8bde1f7a7512c7dc171229
-  data.tar.gz: 5cbb5c9c206799a6a7d70923e42494ef4ba9deb8ede37afc4fe5a8a6e8ed94847d7587a76afbc64aa7a4a547aab9a81e49cb04ef91e85c20fe3d1cb940307682
+  metadata.gz: 722fb50d3a51c1e0b734aa1ba0e0312e99d6486b6bf5ce6cd182a5e0023392a6557d05592b9b370bb7584e31020c6ff33955ed93f9bb0d2ff0ec74eec9c71fb0
+  data.tar.gz: 5404f7537f7536d2e83b58a092df634a77b585a126a1614f79fa6dbcb32759504ae86be8b261c3e81fa53ad9dcad2e04d80cdcd0f98ec05a9d08ce6fe079154d

data/README.md

@@ -1,35 +1,87 @@
-# Adsedare
+# AdSedare
 
-TODO: Delete this and the text below, and describe your gem
+*(from Latin **"Ad Sedare"** — *to calm*)*
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/adsedare`. To experiment with that code, run `bin/console` for an interactive prompt.
+**AdSedare** is a Ruby library that makes iOS **ad-hoc distribution** smooth and stress-free. With AdSedare, you can stop dealing with the chaotic mess of:
 
-## Installation
+- Manually adding every new tester device across countless ad-hoc profiles
+- Keeping certificate capabilities and app group settings in sync
+- Regenerating expired provisioning profiles one painful click at a time
+- Writing clunky shell scripts to build keychains or install profiles from App Store
+- Patching `xcodeproj` files to support ad-hoc builds, then reverting everything for production
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+AdSedare does all of this for you. It reads your Xcode project, understands its structure, and automates the entire profile and signing setup. It can even register new bundle IDs and request fresh provisioning profiles on the fly.
 
-Install the gem and add to the application's Gemfile by executing:
+## Why the Name?
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+The name **AdSedare** comes from personal suffering.
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+After over a year of managing internal iOS testing by hand, I was completely fried. I’d wrestled with Fastlane and similar tools, and while powerful, they were often too rigid or bloated for the very specific pain of ad-hoc distribution. So I built something with a **single mission**:
+Make internal iOS testing **as chill as a cucumber in a snowstorm**.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## Docs
 
-## Usage
+Right now, AdSedare is provided as a **Ruby library**, with plans to add CLI support later this year (™).
 
-TODO: Write usage instructions here
+### `Adsedare::renew_profiles(project_path = nil, certificate_id = nil, team_id = nil)`
 
-## Development
+This is the **crown jewel** of the library.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- Traverses all targets in your `.xcodeproj`
+- Inspects capabilities and entitlements
+- Creates or renews **all necessary provisioning profiles**
+- Adds any missing test devices
+- Works with `APPLE_DEVELOPER_USERNAME` and `APPLE_DEVELOPER_PASSWORD` (due to App Store Connect API being... _gently nerfed into the ground_)
+- Handles 2FA with a **scriptable interface** — meaning you can hook in an SMS relay or similar system to auto-respond
+- Stores sessions for up to \~2 weeks to avoid repeated logins
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### `patch_project(project_path, team_id = nil)`
 
-## Contributing
+Need to prep your Xcode project for ad-hoc builds? This does it cleanly:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/adsedare.
+- Fetches correct provisioning profile names
+- Applies them to each target's `PROVISIONING_PROFILE_SPECIFIER`
+- Optionally overwrites `team_id` if provided
+- **Does NOT** use username/password — instead, expects:
 
-## License
+  - `APPSTORE_CONNECT_KEY_ID`
+  - `APPSTORE_CONNECT_ISSUER_ID`
+  - `APPSTORE_CONNECT_KEY`
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This makes it more CI-friendly and avoids the 2FA headache entirely.
+
+### `install_profiles(project_path = nil)`
+
+- Downloads and installs all ad-hoc profiles needed by your project
+- Places them in the correct location for Xcode to pick up
+- Warns you if profiles are missing or expired
+- Requires the same Connect API credentials as `patch_project`
+
+### `create_keychain(keychain_path = nil, keychain_password = nil, make_default = true)`
+
+**Arguably the second most powerful** feature, built from many hours of trial, error, and mild mental anguish.
+
+- Creates a dedicated build keychain
+- Imports required certificate chains and partition settings
+- If provided with `AD_HOC_CERTIFICATE`, `AD_HOC_PRIVATE_KEY`, and `AD_HOC_KEY_PASSWORD`, will add your ad-hoc distribution cert too
+
+💡 This function deliberately **does not** pull certificates from App Store Connect (unlike `match`) — because:
+
+- You can’t download private keys from Apple
+- Recreating certs in CI constantly is a _certified bad idea™_
+- Relying on third-party key storage wasn’t a hill I wanted to die on
+
+### `make_export_options(project_path = nil, export_path = nil, team_id = nil, options = {})`
+
+Creates a ready-to-use `exportOptions.plist`:
+
+- Automatically fills in correct profile names (fetched from App Store Connect)
+- Adds sensible defaults
+- Supports optional overrides like `thinning`, `compileBitcode`, etc.
+
+## Final Words
+
+**AdSedare isn’t here to replace Fastlane.**
+But it _is_ here to offer a lighter, simpler alternative for **one very specific — but very common — pain**: ad-hoc iOS testing.
+
+It’s already running in production and saving devs real time and real headaches. If you find a bug or have an idea, feel free to open an issue or PR — I’ll be more than happy to help.

data/lib/adsedare/export_options.rb

@@ -5,6 +5,18 @@ require_relative "../appstoreconnect"
 
 module Adsedare
   class << self
+    # Create export options for a project
+    # Expects environment variables to be set:
+    #
+    # - APPSTORE_CONNECT_KEY_ID Key ID from Apple Developer Portal
+    # - APPSTORE_CONNECT_ISSUER_ID Issuer ID from Apple Developer Portal
+    # - APPSTORE_CONNECT_KEY P8 key content from Apple Developer Portal
+    #
+    # @param project_path [String] The path to the Xcode project
+    # @param export_path [String] The path to the export options plist
+    # @param team_id [String] The team ID (optional)
+    # @param options [Hash] Additional options (optional)
+    # @return [void]
     def make_export_options(project_path = nil, export_path = nil, team_id = nil, options = {})
       raise "Project path is not set" unless project_path
       raise "Export path is not set" unless export_path

data/lib/adsedare/install_profiles.rb

@@ -6,6 +6,15 @@ require_relative "../appstoreconnect"
 
 module Adsedare
   class << self
+    # Install provisioning profiles for a project
+    # Expects environment variables to be set:
+    #
+    # - APPSTORE_CONNECT_KEY_ID Key ID from Apple Developer Portal
+    # - APPSTORE_CONNECT_ISSUER_ID Issuer ID from Apple Developer Portal
+    # - APPSTORE_CONNECT_KEY P8 key content from Apple Developer Portal
+    #
+    # @param project_path [String] The path to the Xcode project
+    # @return [void]
     def install_profiles(project_path = nil)
       raise "Project path is not set" unless project_path
 

data/lib/adsedare/keychain.rb

@@ -21,6 +21,17 @@ module Adsedare
   APPLE_WWDRCA = "https://developer.apple.com/certificationauthority/AppleWWDRCA.cer"
 
   class << self
+    # Create a build keychain with all required intermediate certificates
+    # Set following environment variables to add project specific certificates:
+    #
+    # - AD_HOC_CERTIFICATE Path to the ad-hoc certificate
+    # - AD_HOC_PRIVATE_KEY Path to the ad-hoc private key
+    # - AD_HOC_KEY_PASSWORD Password for the ad-hoc private key
+    #
+    # @param keychain_path [String] The path to the keychain
+    # @param keychain_password [String] The password for the keychain
+    # @param make_default [Boolean] Whether to make the keychain the default
+    # @return [void]
     def create_keychain(keychain_path = nil, keychain_password = nil, make_default = true)
       raise "Keychain path is not set" unless keychain_path
       raise "Keychain password is not set" unless keychain_password

data/lib/adsedare/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Adsedare
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/adsedare/xcodeproj.rb

@@ -5,6 +5,17 @@ require_relative "../appstoreconnect"
 
 module Adsedare
   class << self
+    # Patch a project with App Store Connect profiles & settings for ad-hoc distribution
+    # Will overwrite Team ID in project if provided
+    # Expects environment variables to be set:
+    #
+    # - APPSTORE_CONNECT_KEY_ID Key ID from Apple Developer Portal
+    # - APPSTORE_CONNECT_ISSUER_ID Issuer ID from Apple Developer Portal
+    # - APPSTORE_CONNECT_KEY P8 key content from Apple Developer Portal
+    #
+    # @param project_path [String] The path to the Xcode project
+    # @param team_id [String] The team ID (optional)
+    # @return [void]
     def patch_project(project_path, team_id = nil)
       raise "Project path is not set" unless project_path
 

data/lib/adsedare.rb

@@ -23,6 +23,16 @@ module Adsedare
   class << self
     include Logging
 
+    # Renew profiles for a project
+    # Expects environment variables to be set:
+    #
+    # - APPLE_DEVELOPER_USERNAME Apple Developer Portal username
+    # - APPLE_DEVELOPER_PASSWORD Apple Developer Portal password
+    #
+    # @param project_path [String] The path to the Xcode project
+    # @param certificate_id [String] The certificate ID
+    # @param team_id [String] The team ID (optional)
+    # @return [void]
     def renew_profiles(project_path = nil, certificate_id = nil, team_id = nil)
       raise "Project path is not set" unless project_path
       raise "Certificate ID is not set" unless certificate_id

data/lib/starship/auth_helper.rb

@@ -15,7 +15,7 @@ require_relative "../logging"
 module Starship
   class Error < StandardError; end
 
-  # AuthHelper handles authentication with Apple"s developer portal
+  # AuthHelper handles authentication with Apple's developer portal
   class AuthHelper
     include Logging
 

data/lib/starship.rb

@@ -5,6 +5,8 @@ require "json"
 
 require_relative "starship/auth_helper"
 
+# Starship is a wrapper around Apple's developer portal API
+# Inspired by Fatslane's Spaceship
 module Starship
   class Client
     DEV_SERVICES_V1 = "https://developer.apple.com/services-account/v1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adsedare
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - alexstrnik