fastlane-plugin-screenshotslive 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce2cfed932ddc0db4dd72bda4f1c52c70bad9947f0c6ba26a6e0ecc668123a1a
-  data.tar.gz: d6167244e7000e719e9e509dcea29e83bcbf00cc58d0a34fd4e9c36c15ef967e
+  metadata.gz: f00c007f6960d7fc53e58e9a90ba27058429a589659d80c0972f7b12fcb7d1dc
+  data.tar.gz: a442519945397411c7d5cf172407346cebea2de0b3d3036d57899a24a71b36d3
 SHA512:
-  metadata.gz: 32961972f18262e02291362bf2d105851912fabbc766a32452114ee079649980823502df0391db4a1856818c67b4a71d1e49e27747c0ecd8848c320ffa973d23
-  data.tar.gz: 6ba93c22b4ff5a4106f300c56e51039f848ffee6ff8032ea0d6b54d33c75e55f05be51a46fbaf01586ef7b0c7400014432f6e591877096d3151c35758696d758
+  metadata.gz: 5adc773e2c4f2d30f6674f9524dee239354632c5228f778edb9be08a9bfdecea9c5f331665d640580d0ff8daaf7149a26f383f688fb713a484c345763743fa6f
+  data.tar.gz: 5af4ac8b2f226a8be2ab2a4d4b9d985db5007fe61360c429ea74252208c6deaf90cdd68b827e2e654bf003dfee09df510e9864b3d807a597f37de4050e247d26

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

@@ -1,3 +1,4 @@
+require "yaml"
 require "zip"
 require "fileutils"
 require_relative "../helper/api_client"
@@ -5,18 +6,37 @@ require_relative "../helper/api_client"
 module Fastlane
   module Actions
     class ScreenshotsliveAction < Action
+      PICTURE_REF_PREFIX = "picture://"
+
       def self.run(params)
         api_key = params[:api_key]
         yaml_path = params[:yaml_config]
         output_dir = params[:output_directory]
         base_url = params[:base_url]
+        overrides = params[:overrides] || {}
+        screenshots = params[:screenshots] || {}
 
         yaml_config = File.read(yaml_path)
+
+        if !overrides.empty? || !screenshots.empty?
+          yaml_config = apply_overrides(yaml_config, overrides, screenshots)
+        end
+
         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)
+        if screenshots.empty?
+          result = client.render(yaml_config: yaml_config)
+        else
+          picture_files = {}
+          screenshots.each do |_item_id, path|
+            filename = File.basename(path)
+            picture_files[filename] = path
+          end
+          result = client.render_with_pictures(yaml_config: yaml_config, picture_files: picture_files)
+        end
+
         job_id = result.dig("data", "jobId") || result.dig("data", "id")
         UI.message("Render job dispatched: #{job_id}")
 
@@ -38,18 +58,42 @@ module Fastlane
         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))
+            next if entry.directory?
+            filename = File.basename(entry.name)
+            dest = File.join(output_dir, filename)
             entry.extract(dest) { true }
           end
         end
 
         File.delete(zip_path)
 
-        UI.success("Screenshots rendered and extracted to #{output_dir}")
+        file_count = Dir.glob(File.join(output_dir, "*.png")).length
+        UI.success("#{file_count} screenshots rendered and saved to #{output_dir}")
         output_dir
       end
 
+      def self.apply_overrides(yaml_string, overrides, screenshots)
+        data = YAML.safe_load(yaml_string)
+
+        items = data["items"] || []
+        items.each do |item|
+          item_id = item["itemId"]
+
+          if overrides.key?(item_id)
+            overrides[item_id].each do |field, value|
+              item[field.to_s] = value
+            end
+          end
+
+          if screenshots.key?(item_id)
+            filename = File.basename(screenshots[item_id])
+            item["screenshotUrl"] = "#{PICTURE_REF_PREFIX}#{filename}"
+          end
+        end
+
+        data.to_yaml
+      end
+
       def self.description
         "Generate app store screenshots via the Screenshots.live REST API"
       end
@@ -59,14 +103,14 @@ module Fastlane
       end
 
       def self.return_value
-        "Path to the output directory containing rendered screenshots in Fastlane-compatible folder structure"
+        "Path to the output directory containing rendered screenshot files"
       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."
+        "downloads the rendered ZIP, and extracts flat screenshot PNGs into the output directory. " \
+        "Supports overriding YAML values (text, colors) and injecting local screenshot files " \
+        "via the render-with-pictures endpoint."
       end
 
       def self.available_options
@@ -88,10 +132,24 @@ module Fastlane
           ),
           FastlaneCore::ConfigItem.new(
             key: :output_directory,
-            description: "Directory to extract rendered screenshots into",
+            description: "Directory to save rendered screenshot PNGs (flat, no subdirectories)",
             default_value: "./screenshots",
             type: String
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :overrides,
+            description: "Hash of itemId => { field => value } overrides to apply to the YAML before rendering",
+            optional: true,
+            default_value: {},
+            type: Hash
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :screenshots,
+            description: "Hash of itemId => local_file_path to inject screenshots via render-with-pictures",
+            optional: true,
+            default_value: {},
+            type: Hash
+          ),
           FastlaneCore::ConfigItem.new(
             key: :base_url,
             env_name: "SCREENSHOTSLIVE_BASE_URL",
@@ -112,11 +170,24 @@ module Fastlane
 
       def self.example_code
         [
-          'screenshotslive(
-            api_key: ENV["SCREENSHOTSLIVE_API_KEY"],
-            yaml_config: "./screenshots.yml",
-            output_directory: "./fastlane/screenshots"
-          )',
+          '# Basic render from YAML
+screenshotslive(
+  api_key: ENV["SCREENSHOTSLIVE_API_KEY"],
+  yaml_config: "./screenshots.yml",
+  output_directory: "./fastlane/screenshots/en-US"
+)',
+          '# Override text and inject local screenshots
+screenshotslive(
+  api_key: ENV["SCREENSHOTSLIVE_API_KEY"],
+  yaml_config: "./screenshots.yml",
+  output_directory: "./fastlane/screenshots/de-DE",
+  overrides: {
+    "abc-item-id" => { "content" => "Neue Funktion" },
+  },
+  screenshots: {
+    "def-device-frame-id" => "./screens/de/home.png",
+  }
+)',
         ]
       end
     end

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

@@ -1,4 +1,5 @@
 require "faraday"
+require "faraday/multipart"
 require "json"
 
 module Fastlane
@@ -6,13 +7,15 @@ module Fastlane
     class ApiClient
       BASE_URL = "https://api.screenshots.live"
       RENDER_PATH = "/render/api"
+      RENDER_WITH_PICTURES_PATH = "/render/render-with-pictures"
       POLL_PATH_PREFIX = "/render/get-render/"
       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|
+        @base_url = base_url || BASE_URL
+        @conn = Faraday.new(url: @base_url) do |f|
           f.adapter Faraday.default_adapter
         end
       end
@@ -32,6 +35,32 @@ module Fastlane
         JSON.parse(response.body)
       end
 
+      def render_with_pictures(yaml_config:, picture_files:)
+        multipart_conn = Faraday.new(url: @base_url) do |f|
+          f.request :multipart
+          f.adapter Faraday.default_adapter
+        end
+
+        payload = { "yaml" => yaml_config }
+        picture_files.each do |filename, path|
+          mime = "image/png"
+          mime = "image/jpeg" if path.end_with?(".jpg", ".jpeg")
+          payload[filename] = Faraday::Multipart::FilePart.new(path, mime, filename)
+        end
+
+        response = multipart_conn.post(RENDER_WITH_PICTURES_PATH) do |req|
+          req.headers["Authorization"] = "Bearer #{@api_key}"
+          req.body = payload
+        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

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Screenshotslive
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-screenshotslive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eric Isensee
@@ -13,60 +13,65 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !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'
+        version: '2.4'
   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'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: fastlane
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.200'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.200.0
@@ -74,6 +79,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.200'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.200.0
@@ -81,16 +89,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 email: contact@screenshots.live
 executables: []
 extensions: []