fastlane-plugin-wp_sparkling_appcast 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2ea0991c5b1753e0e556684a1b5a5dc556a072b7312d56aed5260b925a29b88
+  data.tar.gz: a5dcfa56b1a282e149854a031da102d1323e2682ff768a29d45c6414179b96ee
+SHA512:
+  metadata.gz: 3ece727a2d06c7373c22528b2e631e3040eba8a1886bf2f5b98a807ff32b198ed0a241fd8bf36ac60018793383db17356459eb13d54c88e3f89efccf664408b6
+  data.tar.gz: f0c346e6133e39462c01844e0822863142f398e02ad38d9fa8bf3542cded3a2f740308487c7366831f8f271f0d682c5c22cc08bd2fdc31915db0f2f39b00ad95

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Usiel Riedl <usiel.riedl@automattic.com>
+
+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,70 @@
+# wp_sparkling_appcast plugin
+
+This fastlane plugin helps you distribute your macOS app updates using [WordPress's Sparkling Appcast plugin](https://github.com/Usiel/sparkling-appcast). It automates the process of uploading your app's zip file and creating the necessary entries for Sparkle's appcast.xml feed.
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-wp_sparkling_appcast`, add it to your project by running:
+
+```bash
+fastlane add_plugin wp_sparkling_appcast
+```
+
+### Requirements
+
+- WordPress installation with the [Sparkling Appcast plugin](https://github.com/Usiel/sparkling-appcast)
+- WordPress Application Password for authentication
+- macOS app packaged as a zip file
+- Sparkle framework integration in your app
+
+## Example
+
+Here's how to use this plugin in your Fastfile:
+
+```ruby
+lane :release do
+  # First, create your app archive and zip it
+  gym(
+    scheme: "YourApp",
+    export_method: "developer-id",
+    output_directory: "build",
+    output_name: "YourApp.zip"
+  )
+
+  # Upload to WordPress and create appcast entry
+  wp_sparkling_appcast_upload(
+    base_url: "https://your-wordpress-site.com",
+    wp_user: "your-username",
+    wp_application_pw: ENV["WP_APP_PASSWORD"],
+    changelog: "## Changes\n- Fixed some bugs\n- Added new features",
+    zip_file: "build/YourApp.zip",
+    track: 123
+  )
+end
+```
+
+### Parameters
+
+| Key                | Description                                       | Type    | Required | Default                             |
+| ------------------ | ------------------------------------------------- | ------- | -------- | ----------------------------------- |
+| base_url           | Base URL of your WordPress installation           | String  | Yes      | -                                   |
+| wp_user            | WordPress username for authentication             | String  | Yes      | -                                   |
+| wp_application_pw  | WordPress application password for authentication | String  | Yes      | -                                   |
+| build_version      | Version number of the build (e.g. 1.2.3)          | String  | No       | App bundle's build version          |
+| build_number       | Build number                                      | Integer | No       | App bundle's build number           |
+| min_system_version | Minimum system version required                   | String  | No       | App bundle's minimum system version |
+| changelog          | Changelog for this version                        | String  | No       | ""                                  |
+| zip_file           | Path to the zip file to upload                    | String  | Yes      | -                                   |
+| track              | Track ID for this build                           | Integer | Yes      | -                                   |
+
+## Issues and Feedback
+
+You are welcome to submit issues with feedback, feature requests, and bugs to this repository.
+
+## 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/wp_sparkling_appcast/actions/wp_sparkling_appcast_upload_action.rb

@@ -0,0 +1,152 @@
+require 'fastlane/action'
+require_relative '../helper/wp_sparkling_appcast_helper'
+
+module Fastlane
+  module Actions
+    class WpSparklingAppcastUploadAction < Action
+
+      def self.run(params)
+        UI.message("Starting upload to WordPress Sparkling Appcast...")
+        
+        # Extract info from zip if parameters not provided
+        if !params[:build_version] || !params[:build_number] || !params[:min_system_version]
+          app_info = Helper::WpSparklingAppcastHelper.extract_app_info(params[:zip_file])
+          
+          if app_info
+            params[:build_version] ||= app_info[:build_version]
+            params[:build_number] ||= app_info[:build_number]
+            params[:min_system_version] ||= app_info[:min_system_version]
+            
+            UI.success("Extracted from app bundle: v#{params[:build_version]} (#{params[:build_number]}) - min macOS #{params[:min_system_version]}")
+          end
+        end
+
+        attachment_id = Helper::WpSparklingAppcastHelper.upload_zip(params)
+        build_id = Helper::WpSparklingAppcastHelper.create_build_entry(params, attachment_id)
+        
+        return {
+          attachment_id: attachment_id,
+          build_id: build_id
+        }
+      end
+
+      def self.description
+        "This plugin helps you distribute your builds using WordPress's Sparkling Appcast plugin (Sparkle appcast.xml)"
+      end
+
+      def self.authors
+        ["Usiel Riedl"]
+      end
+
+      def self.return_value
+        "Returns a hash containing the attachment_id and build_id of the created resources"
+      end
+
+      def self.details
+        "This plugin integrates with WordPress's Sparkling Appcast plugin to create Sparkle appcast.xml feeds for macOS app updates. " \
+        "It handles uploading your app's zip file and creating the necessary build entries in WordPress. " \
+        "Requirements:\n" \
+        "- A WordPress installation with the Sparkling Appcast plugin\n" \
+        "- WordPress Application Passwords for authentication\n" \
+        "- A zip file containing your app update"
+      end
+
+      def self.example_code
+        [
+          'wp_sparkling_appcast_upload(
+            base_url: "https://your-wordpress-site.com",
+            wp_user: "your-username",
+            wp_application_pw: ENV["WP_APP_PASSWORD"],
+            changelog: "## Changes\n- Fixed some bugs\n- Added new features",
+            zip_file: "path/to/YourApp.zip",
+            track: 1
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :base_url,
+            env_name: "WP_SPARKLING_APPCAST_BASE_URL",
+            description: "Base URL of your WordPress installation",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Invalid URL format for base_url") unless Helper::WpSparklingAppcastHelper.verify_url(value)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :wp_user,
+            env_name: "WP_SPARKLING_APPCAST_USER",
+            description: "WordPress username for authentication",
+            type: String,
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :wp_application_pw,
+            env_name: "WP_SPARKLING_APPCAST_APPLICATION_PW",
+            description: "WordPress application password for authentication",
+            type: String,
+            optional: false,
+            sensitive: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_version,
+            env_name: "WP_SPARKLING_APPCAST_BUILD_VERSION",
+            description: "Version number of the build (e.g. 1.2.3). Will be extracted from app bundle if not provided",
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_number,
+            env_name: "WP_SPARKLING_APPCAST_BUILD_NUMBER",
+            description: "Build number. Will be extracted from app bundle if not provided",
+            type: Integer,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :min_system_version,
+            env_name: "WP_SPARKLING_APPCAST_MIN_SYSTEM_VERSION",
+            description: "Minimum system version required. Will be extracted from app bundle if not provided",
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :changelog,
+            env_name: "WP_SPARKLING_APPCAST_CHANGELOG",
+            description: "Changelog for this version",
+            type: String,
+            optional: true,
+            default_value: ""
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :zip_file,
+            env_name: "WP_SPARKLING_APPCAST_ZIP_FILE",
+            description: "Path to the zip file to upload",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Zip file not found at path '#{value}'") unless File.exist?(value)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :track,
+            env_name: "WP_SPARKLING_APPCAST_TRACK",
+            description: "Track ID for this build",
+            type: Integer,
+            optional: false
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :mac
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wp_sparkling_appcast/helper/wp_sparkling_appcast_helper.rb

@@ -0,0 +1,132 @@
+require 'fastlane_core/ui/ui'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'zip'
+require 'plist'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class WpSparklingAppcastHelper
+      # class methods that you define here become available in your action
+      # as `Helper::WpSparklingAppcastHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the wp_sparkling_appcast plugin helper!")
+      end
+
+      def self.upload_zip(params)
+        zip_uri = URI.parse("#{params[:base_url]}/wp-json/wp/v2/media")
+        zip_uri.query = URI.encode_www_form({
+          'status' => 'publish',
+          'title' => "#{File.basename(params[:zip_file], '.*')} #{params[:build_version]} (#{params[:build_number]})"
+        })
+
+        UI.message("Uploading zip file...")
+        
+        zip_request = Net::HTTP::Post.new(zip_uri)
+        zip_request.basic_auth(params[:wp_user], params[:wp_application_pw])
+        zip_request['Content-Type'] = 'application/zip'
+        zip_request['Content-Disposition'] = "attachment; filename=\"#{File.basename(params[:zip_file], '.zip')}-#{params[:build_version]}-#{params[:build_number]}.zip\""
+        
+        zip_data = File.read(params[:zip_file])
+        zip_request.body = zip_data
+
+        response = make_request(zip_uri, zip_request, read_timeout: 300)
+        attachment_data = JSON.parse(response.body)
+        
+        UI.success("Successfully uploaded zip file with ID: #{attachment_data['id']}")
+        attachment_data['id']
+      end
+
+      def self.create_build_entry(params, attachment_id)
+        build_uri = URI.parse("#{params[:base_url]}/wp-json/wp/v2/sappcast_app_build")
+        
+        UI.message("Creating app build entry...")
+
+        build_request = Net::HTTP::Post.new(build_uri)
+        build_request.basic_auth(params[:wp_user], params[:wp_application_pw])
+        build_request['Content-Type'] = 'application/json'
+        
+        build_data = {
+          meta: {
+            sappcast_app_build_version: params[:build_version],
+            sappcast_app_build_number: params[:build_number],
+            sappcast_app_build_min_system_version: params[:min_system_version],
+            sappcast_app_build_attachment_id: attachment_id,
+            sappcast_app_build_changelog: params[:changelog]
+          },
+          sappcast_track: params[:track],
+          status: 'draft'
+        }
+
+        build_request.body = build_data.to_json
+
+        response = make_request(build_uri, build_request)
+        build_result = JSON.parse(response.body)
+        
+        UI.success("Successfully created app build entry with ID: #{build_result['id']}")
+        build_result['id']
+      end
+
+      def self.verify_url(url)
+        uri = URI.parse(url)
+        return uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+      rescue URI::InvalidURIError
+        return false
+      end
+
+      def self.extract_app_info(zip_file_path)
+        UI.message("Extracting app info from zip file...")
+        
+        Zip::File.open(zip_file_path) do |zip_file|
+          # Find the .app directory in the zip
+          app_entry = zip_file.glob('*.app/Contents/Info.plist').first
+          
+          unless app_entry
+            UI.user_error!("No .app bundle found in zip file")
+            return nil
+          end
+          
+          # Read the plist content
+          plist_content = app_entry.get_input_stream.read
+          info_plist = Plist.parse_xml(plist_content)
+          
+          {
+            build_version: info_plist['CFBundleShortVersionString'],
+            build_number: info_plist['CFBundleVersion'].to_i,
+            min_system_version: info_plist['LSMinimumSystemVersion']
+          }
+        end
+      rescue => e
+        UI.error("Failed to extract app info: #{e.message}")
+        nil
+      end
+
+      private
+
+      def self.make_request(uri, request, read_timeout: 30)
+        response = Net::HTTP.start(uri.hostname, uri.port, 
+          use_ssl: uri.scheme == 'https',
+          read_timeout: read_timeout,
+          open_timeout: 10
+        ) do |http|
+          http.request(request)
+        end
+
+        unless response.is_a?(Net::HTTPSuccess)
+          error_message = begin
+            JSON.parse(response.body)['message']
+          rescue
+            response.body
+          end
+          UI.user_error!("Request failed: #{response.code} - #{error_message}")
+        end
+
+        response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module WpSparklingAppcast
+    VERSION = "0.3.0"
+  end
+end

data/lib/fastlane/plugin/wp_sparkling_appcast.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/wp_sparkling_appcast/version'
+
+module Fastlane
+  module WpSparklingAppcast
+    # 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::WpSparklingAppcast.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-wp_sparkling_appcast
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Usiel Riedl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 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: '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: rubocop
+  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: webmock
+  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'
+description:
+email: usiel.riedl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/wp_sparkling_appcast.rb
+- lib/fastlane/plugin/wp_sparkling_appcast/actions/wp_sparkling_appcast_upload_action.rb
+- lib/fastlane/plugin/wp_sparkling_appcast/helper/wp_sparkling_appcast_helper.rb
+- lib/fastlane/plugin/wp_sparkling_appcast/version.rb
+homepage: https://github.com/Usiel/fastlane-plugin-wp_sparkling_appcast
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+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.4.10
+signing_key:
+specification_version: 4
+summary: This plugin helps you distribute your builds using WordPress's Sparkling
+  Appcast plugin (Sparkle appcast.xml)
+test_files: []