fastlane-plugin-screenshotslive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b94c48f4980b7913c607efb064dadd0ba7c6a11ccf4f57abdde1f106d1d8869
+  data.tar.gz: d4be2bd39be2b82127efc03cae00f242c5ccdb5b240165e6ab522754ee8e9eb3
+SHA512:
+  metadata.gz: 11e03828263b8cd463c488a402ff055bc6469157ec734e0ac4e7c6d6c774fe48b3d8cc330e5b65224600e442bd83f3906e6b1fd999a1c626ee29d7cc2dadecb6
+  data.tar.gz: c725e75991717d9c63e63cb267d2ca7c7a9500fee6b35b8b1333b57a1d25a4f98ed95b3aa2f25734f53b60ebc2238a22fab94c31db69c8ff7b27fb4123e614f2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eric Isensee - Screenshots.live
+
+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,97 @@
+# fastlane-plugin-screenshotslive
+
+Generate app store screenshots via the [Screenshots.live](https://screenshots.live) REST API. Design templates once in the visual editor, then render all device sizes and locales automatically from your Fastlane pipeline.
+
+## Installation
+
+```bash
+fastlane add_plugin screenshotslive
+```
+
+Or add to your `Gemfile`:
+
+```ruby
+gem "fastlane-plugin-screenshotslive"
+```
+
+## Usage
+
+```ruby
+# Fastfile
+lane :screenshots do
+  screenshotslive(
+    api_key: ENV["SCREENSHOTSLIVE_API_KEY"],
+    yaml_config: "./screenshots.yml",
+    output_directory: "./fastlane/screenshots"
+  )
+
+  # Upload to App Store Connect
+  deliver(skip_metadata: true, skip_binary_upload: true)
+end
+```
+
+## Parameters
+
+| Key | Env Var | Description | Default |
+|-----|---------|-------------|---------|
+| `api_key` | `SCREENSHOTSLIVE_API_KEY` | Your API key from screenshots.live/app/api-access | Required |
+| `yaml_config` | - | Path to your YAML render configuration | Required |
+| `output_directory` | - | Where to extract rendered screenshots | `./screenshots` |
+| `base_url` | `SCREENSHOTSLIVE_BASE_URL` | Override API URL (for testing) | `https://api.screenshots.live` |
+
+## Output Structure
+
+Screenshots are extracted into Fastlane-compatible folders:
+
+```
+screenshots/
+  en-US/
+    iPhone 6.5/
+      screenshot_01.png
+      screenshot_02.png
+    iPad 12.9/
+      screenshot_01.png
+      screenshot_02.png
+    phoneScreenshots/
+      screenshot_01.png
+    tenInchScreenshots/
+      screenshot_01.png
+```
+
+## YAML Configuration
+
+Export your template's YAML config from the Screenshots.live editor, or write one manually:
+
+```yaml
+templateId: "your-template-uuid"
+locales:
+  - code: "en-US"
+    overrides:
+      headline: "Your App Name"
+      subtitle: "The best app ever"
+  - code: "de-DE"
+    overrides:
+      headline: "Ihr App-Name"
+      subtitle: "Die beste App aller Zeiten"
+```
+
+## Migrating from frameit
+
+Replace your `frameit` call:
+
+```ruby
+# Before
+frameit(silver: true)
+
+# After
+screenshotslive(
+  api_key: ENV["SCREENSHOTSLIVE_API_KEY"],
+  yaml_config: "./screenshots.yml"
+)
+```
+
+Screenshots.live gives you everything frameit does plus: dynamic text/image overlays, multi-platform porting, localization via API, and a visual editor for designing templates.
+
+## License
+
+MIT

data/lib/fastlane/plugin/screenshotslive/actions/screenshotslive_action.rb

@@ -0,0 +1,124 @@
+require "zip"
+require "fileutils"
+require_relative "../helper/api_client"
+
+module Fastlane
+  module Actions
+    class ScreenshotsliveAction < Action
+      def self.run(params)
+        api_key = params[:api_key]
+        yaml_path = params[:yaml_config]
+        output_dir = params[:output_directory]
+        base_url = params[:base_url]
+
+        yaml_config = File.read(yaml_path)
+        UI.message("Dispatching render via Screenshots.live API...")
+
+        client = Screenshotslive::ApiClient.new(api_key: api_key, base_url: base_url)
+
+        result = client.render(yaml_config: yaml_config)
+        job_id = result.dig("data", "id") || result["id"]
+        UI.message("Render job dispatched: #{job_id}")
+
+        UI.message("Waiting for render to complete...")
+        job = client.poll_job(job_id: job_id)
+
+        download_url = job.dig("data", "downloadUrl") || job["downloadUrl"]
+        unless download_url
+          raise "Render completed but no download URL returned"
+        end
+
+        UI.message("Downloading rendered screenshots...")
+        zip_data = client.download(url: download_url)
+
+        FileUtils.mkdir_p(output_dir)
+        zip_path = File.join(output_dir, "screenshots.zip")
+        File.binwrite(zip_path, zip_data)
+
+        UI.message("Extracting to #{output_dir}...")
+        Zip::File.open(zip_path) do |zip_file|
+          zip_file.each do |entry|
+            dest = File.join(output_dir, entry.name)
+            FileUtils.mkdir_p(File.dirname(dest))
+            entry.extract(dest) { true }
+          end
+        end
+
+        File.delete(zip_path)
+
+        UI.success("Screenshots rendered and extracted to #{output_dir}")
+        output_dir
+      end
+
+      def self.description
+        "Generate app store screenshots via the Screenshots.live REST API"
+      end
+
+      def self.authors
+        ["Eric Isensee"]
+      end
+
+      def self.return_value
+        "Path to the output directory containing rendered screenshots in Fastlane-compatible folder structure"
+      end
+
+      def self.details
+        "Sends a YAML configuration to the Screenshots.live render API, polls for completion, " \
+        "downloads the rendered ZIP, and extracts it into a Fastlane-compatible folder structure " \
+        "(iPhone 6.5, iPad 12.9, phoneScreenshots, tenInchScreenshots). " \
+        "Use this as a drop-in replacement for frameit with full template customization."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :api_key,
+            env_name: "SCREENSHOTSLIVE_API_KEY",
+            description: "Your Screenshots.live API key",
+            sensitive: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :yaml_config,
+            description: "Path to the YAML configuration file for the render",
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("YAML config file not found: #{value}") unless File.exist?(value)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :output_directory,
+            description: "Directory to extract rendered screenshots into",
+            default_value: "./screenshots",
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :base_url,
+            env_name: "SCREENSHOTSLIVE_BASE_URL",
+            description: "Override the API base URL (for testing)",
+            optional: true,
+            type: String
+          ),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      def self.category
+        :screenshots
+      end
+
+      def self.example_code
+        [
+          'screenshotslive(
+            api_key: ENV["SCREENSHOTSLIVE_API_KEY"],
+            yaml_config: "./screenshots.yml",
+            output_directory: "./fastlane/screenshots"
+          )',
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/screenshotslive/helper/api_client.rb

@@ -0,0 +1,76 @@
+require "faraday"
+require "json"
+
+module Fastlane
+  module Screenshotslive
+    class ApiClient
+      BASE_URL = "https://api.screenshots.live"
+      RENDER_PATH = "/render-api"
+      POLL_INTERVAL = 3
+      MAX_POLL_ATTEMPTS = 200
+
+      def initialize(api_key:, base_url: nil)
+        @api_key = api_key
+        @conn = Faraday.new(url: base_url || BASE_URL) do |f|
+          f.request :multipart
+          f.request :url_encoded
+          f.adapter Faraday.default_adapter
+        end
+      end
+
+      def render(yaml_config:)
+        response = @conn.post(RENDER_PATH) do |req|
+          req.headers["Authorization"] = "Bearer #{@api_key}"
+          req.headers["Content-Type"] = "application/json"
+          req.body = JSON.generate({ yamlConfig: yaml_config })
+        end
+
+        unless response.success?
+          body = JSON.parse(response.body) rescue {}
+          raise "Screenshots.live API error (#{response.status}): #{body["message"] || response.body}"
+        end
+
+        JSON.parse(response.body)
+      end
+
+      def poll_job(job_id:)
+        attempts = 0
+        loop do
+          attempts += 1
+          if attempts > MAX_POLL_ATTEMPTS
+            raise "Render job #{job_id} timed out after #{MAX_POLL_ATTEMPTS * POLL_INTERVAL}s"
+          end
+
+          response = @conn.get("/render-jobs/#{job_id}") do |req|
+            req.headers["Authorization"] = "Bearer #{@api_key}"
+          end
+
+          unless response.success?
+            raise "Failed to check job status (#{response.status})"
+          end
+
+          job = JSON.parse(response.body)
+          status = job.dig("data", "status") || job["status"]
+
+          case status
+          when "Completed"
+            return job
+          when "Failed"
+            error = job.dig("data", "error") || "Unknown error"
+            raise "Render job failed: #{error}"
+          end
+
+          sleep(POLL_INTERVAL)
+        end
+      end
+
+      def download(url:)
+        response = Faraday.get(url)
+        unless response.success?
+          raise "Failed to download render output (#{response.status})"
+        end
+        response.body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Screenshotslive
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/screenshotslive.rb

@@ -0,0 +1,13 @@
+require "fastlane/plugin/screenshotslive/version"
+
+module Fastlane
+  module Screenshotslive
+    def self.all_classes
+      Dir[File.expand_path("**/{actions,helper}/*.rb", File.dirname(__FILE__))]
+    end
+  end
+end
+
+Fastlane::Screenshotslive.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-screenshotslive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Isensee
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.200.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.200.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'
+email: contact@screenshots.live
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/screenshotslive.rb
+- lib/fastlane/plugin/screenshotslive/actions/screenshotslive_action.rb
+- lib/fastlane/plugin/screenshotslive/helper/api_client.rb
+- lib/fastlane/plugin/screenshotslive/version.rb
+homepage: https://github.com/screenshots-live/fastlane-plugin-screenshotslive
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Generate app store screenshots via the Screenshots.live API
+test_files: []