fastlane-plugin-screenshotbot 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da978407e398047e61c4e5ce53eadf15c2131f21194710a072b2d5a1cd355878
+  data.tar.gz: 20e5586e5bba7632e72eadf28510a8f35e8b364ba32c8fae50aa0b2c128e5690
+SHA512:
+  metadata.gz: 46ef3b12dfd83f84f7b14901b1204f8a411c05c9a6d1d4a67527beba9118004c9f915184e2796a4824f8eac6a896c5b953feb4e0a6596aaff641967cd03e29c9
+  data.tar.gz: c33b898221b3b2061c9c32a4a26744a1c51312f086d4ff500c4a13e64662921ee9ed7928f696c2a8028affa7f02483fb914a33c619102248359b7a99d6f6b906

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Apadmi Limited
+
+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,50 @@
+# Screenshotbot plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-screenshotbot)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-screenshotbot`, add it to your project by running:
+
+```bash
+fastlane add_plugin screenshotbot
+```
+
+## About screenshotbot
+
+Fastlane plugin to install the Screenshotbot CLI and publish your screenshots to it
+
+## 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`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## 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/screenshotbot/actions/screenshotbot_action.rb

@@ -0,0 +1,103 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class ScreenshotbotAction < Action
+      def self.run(params)
+        cli_mapping = {
+          main_branch: "main-branch",
+          directory: "directory",
+          channel: "channel",
+          api_key: "api-key",
+          api_secret: "api-secret",
+          repo_url: "repo-url"
+        }
+
+        command_params = {}
+
+        raise "Must supply pr destination if PR==true" if params[:is_pr] && params[:pr_destination].empty?
+
+        command_params[:main_branch] = params[:is_pr] ? params[:pr_destination] : params[:git_branch]
+
+        command_params[:directory] = params[:screenshots_directory]
+        command_params[:channel] = params[:channel]
+        command_params[:api_key] = params[:api_key]
+        command_params[:api_secret] = params[:api_secret]
+        command_params[:repo_url] = params[:repo_url]
+
+        command_params = command_params.compact
+        command_params = command_params.map do |k, v|
+          "--#{cli_mapping[k]} #{v}"
+        end
+
+        command = "#{File.expand_path(params[:recorder_path])} #{command_params.join(' ')}"
+        Actions.sh(command)
+      rescue StandardError => e
+        UI.crash!("Error running Screenshotbot: #{e.message}")
+      end
+
+      def self.description
+        "Uploads screenshots to Screenshotbot"
+      end
+
+      def self.authors
+        %w[samdc@apadmi.com mattm@apadmi.com]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :recorder_path,
+                                       description: "The path to the Screenshotbot recorder executable",
+                                       env_name: "SCREENSHOTBOT_RECORDER_PATH",
+                                       type: String,
+                                       default_value: "~/screenshotbot/recorder",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :screenshots_directory,
+                                       description: "The local directory containing screenshots for upload",
+                                       env_name: "SCREENSHOTBOT_SCREENSHOTS_DIRECTORY",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :channel,
+                                       description: "Screenshotbot channel",
+                                       env_name: "SCREENSHOTBOT_CHANNEL",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       description: "Screenshotbot api key",
+                                       env_name: "SCREENSHOTBOT_API_KEY",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :api_secret,
+                                       description: "Screenshotbot api secret",
+                                       env_name: "SCREENSHOTBOT_API_SECRET",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :repo_url,
+                                       description: "URL of the repository",
+                                       env_name: "SCREENSHOTBOT_REPO_URL",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :is_pr,
+                                       description: "Whether this is a PR run or not",
+                                       env_name: "SCREENSHOTBOT_IS_PR",
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :pr_destination,
+                                       description: "Pull request destination branch",
+                                       env_name: "SCREENSHOTBOT_PR_DESTINATION_BRANCH",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :git_branch,
+                                       description: "The current git branch",
+                                       env_name: "SCREENSHOTBOT_CURRENT_BRANCH",
+                                       type: String,
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/screenshotbot/actions/screenshotbot_installer_action.rb

@@ -0,0 +1,30 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class ScreenshotbotInstallerAction < Action
+      def self.run(params)
+        command = "curl https://screenshotbot.io/recorder.sh | sh"
+        Actions.sh(command)
+      rescue StandardError => e
+        UI.crash!("Error running Screenshotbot Installer: #{e.message}")
+      end
+
+      def self.description
+        "Installs the screenshotbot runner"
+      end
+
+      def self.authors
+        ["mattm@apadmi.com"]
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Screenshotbot
+    VERSION = "0.1.1"
+  end
+end

data/lib/fastlane/plugin/screenshotbot.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/screenshotbot/version'
+
+module Fastlane
+  module Screenshotbot
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/actions/*.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::Screenshotbot.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-screenshotbot
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Apadmi Limited
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-03 00:00:00.000000000 Z
+dependencies:
+- !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.211.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.211.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: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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'
+description: 
+email: opensource@apadmi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/screenshotbot.rb
+- lib/fastlane/plugin/screenshotbot/actions/screenshotbot_action.rb
+- lib/fastlane/plugin/screenshotbot/actions/screenshotbot_installer_action.rb
+- lib/fastlane/plugin/screenshotbot/version.rb
+homepage: https://github.com/Apadmi-Engineering/fastlane-plugin-screenshotbot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Fastlane pluging to install the Screenshotbot recorder tool and upload your
+  screenshots
+test_files: []