fastlane-plugin-firebase_app_distribution 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3316c560bc4c691d569deea229397668e8e3a00ca4201d332602acd112379639
+  data.tar.gz: 6fe95425b0f4a85d3492ec51ae8353979f3534b635655ee55349f12191c721ae
+SHA512:
+  metadata.gz: fc0f5ac7cd9081eb02e539cb6bc2f2116dcc51e04ac8b5685ca611469fd76f37470d35c4c5085bf267fa7d296a76d95ddbdc5714ab8fe2388cf249d51101740d
+  data.tar.gz: 5e8cc15580a5f98491f1d9318728600c751a807a8f5108df4844fe6f371e2725b5dcffb38af560b58de202dc20bb3ba3d77ec2155d065c4452f0b287f15728ec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stefan Natchev <snatchev@google.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,52 @@
+# firebase_app_distribution plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-firebase_app_distribution)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-firebase_app_distribution`, add it to your project by running:
+
+```bash
+fastlane add_plugin firebase_app_distribution
+```
+
+## About firebase_app_distribution
+
+Release your beta builds to Firebase App Distro
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## 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/firebase_app_distribution.rb

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

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb

@@ -0,0 +1,180 @@
+require 'tempfile'
+require 'fastlane/action'
+require 'open3'
+require 'shellwords'
+require_relative '../helper/firebase_app_distribution_helper'
+
+## TODO: should always use a file underneath? I think so.
+## How should we document the usage of release notes?
+module Fastlane
+  module Actions
+    class FirebaseAppDistributionAction < Action
+
+      DEFAULT_FIREBASE_CLI_PATH = %x(which firebase).chomp
+      FIREBASECMD_ACTION = "appdistribution:distribute".freeze
+      
+      extend Helper::FirebaseAppDistributionHelper
+
+      def self.run(params)
+        params.values # to validate all inputs before looking for the ipa/apk
+        
+        release_file = params[:release_notes_file]
+        if params[:release_notes].to_s != ""
+          release_file = file_for_contents(:release_notes, from: params)
+        end
+
+        groups_file = file_for_contents(:groups, from: params)
+        testers_file = file_for_contents(:testers, from: params)
+
+        cmd = [params[:firebase_cli_path], FIREBASECMD_ACTION]
+        cmd << Shellwords.escape(params[:ipa_path] || params[:apk_path])
+        cmd << "--app #{params[:app]}"
+        cmd << "--groups-file #{groups_file}" if groups_file
+        cmd << "--testers-file #{testers_file}" if testers_file
+        cmd << "--release-notes-file #{release_file}" if release_file
+
+        result = Actions.sh_control_output(
+          cmd.join(" "),
+          print_command: false,
+          print_command_output: true
+        )
+
+        cleanup_tempfiles
+      end
+
+      def self.description
+        "Release your beta builds to Firebase App Distro"
+      end
+
+      def self.authors
+        ["Stefan Natchev"]
+      end
+
+      # supports markdown.
+      def self.details
+        "Release your beta builds to Firebase App Distro"
+      end
+
+      def self.available_options
+        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+
+        if platform == :ios || platform.nil?
+          ipa_path_default = Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last
+        end
+
+        if platform == :android
+          apk_path_default = Dir["*.apk"].last || Dir[File.join("app", "build", "outputs", "apk", "app-release.apk")].last
+        end
+
+        [
+          # iOS Specific
+          FastlaneCore::ConfigItem.new(key: :ipa_path,
+                                       env_name: "FIREBASEAPPDISTRO_IPA_PATH",
+                                       description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action",
+                                       default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] || ipa_path_default,
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("firebase_app_distribution: Couldn't find ipa file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          # Android Specific
+          FastlaneCore::ConfigItem.new(key: :apk_path,
+                                       env_name: "FIREBASEAPPDISTRO_APK_PATH",
+                                       description: "Path to your APK file",
+                                       default_value: Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] || apk_path_default,
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("firebase_app_distribution: Couldn't find apk file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: "FIREBASEAPPDISTRO_APP",
+                                       description: "Your app's Firebase App ID. You can find the App ID in the Firebase console, on the General Settings page",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :firebase_cli_path,
+                                       env_name: "FIREBASEAPPDISTRO_FIREBASE_CLI_PATH",
+                                       description: "The absolute path of the firebase cli command",
+                                       default_value: DEFAULT_FIREBASE_CLI_PATH,
+                                       default_value_dynamic: true,
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         if value.to_s == "" || !File.exist?(value)
+                                           UI.user_error!("firebase_cli_path: missing path to firebase cli tool. Please install firebase in $PATH or specify path")
+                                         end
+
+                                         unless is_firebasecmd_supported?(value)
+                                          UI.user_error!("firebase_cli_path: `#{value}` does not support the `#{FIREBASECMD_ACTION}` command. Please download (https://appdistro.page.link/firebase-cli-download) or specify the path to the correct version of firebse")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :groups,
+                                       env_name: "FIREBASEAPPDISTRO_GROUPS",
+                                       description: "The groups used for distribution, separated by commas",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :groups_file,
+                                       env_name: "FIREBASEAPPDISTRO_GROUPS_FILE",
+                                       description: "The groups used for distribution, separated by commas",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :testers,
+                                       env_name: "FIREBASEAPPDISTRO_TESTERS",
+                                       description: "Pass email addresses of testers, separated by commas",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :testers_file,
+                                       env_name: "FIREBASEAPPDISTRO_TESTERS_FILE",
+                                       description: "Pass email addresses of testers, separated by commas",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :release_notes,
+                                       env_name: "FIREBASEAPPDISTRO_RELEASE_NOTES",
+                                       description: "Release notes for this build",
+                                       default_value: Actions.lane_context[SharedValues::FL_CHANGELOG],
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :release_notes_file,
+                                       env_name: "FIREBASEAPPDISTRO_RELEASE_NOTES_FILE",
+                                       description: "Release notes file for this build",
+                                       optional: true,
+                                       type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          <<-CODE
+            firebase_app_distribution(
+              app: "1:1234567890:ios:0a1b2c3d4e5f67890",
+              testers: "snatchev@google.com, rebeccahe@google.com"
+            )
+          CODE
+        ]
+      end
+
+      private
+
+      ## TODO: figure out if we can surpress color output.
+      def self.is_firebasecmd_supported?(cmd)
+        outerr, status = Open3.capture2e(cmd, "--non-interactive", FIREBASECMD_ACTION, "--help")
+        return false unless status.success?
+
+        if outerr =~ /is not a Firebase command/
+          return false
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_helper.rb

@@ -0,0 +1,39 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    module FirebaseAppDistributionHelper
+      ##
+      # always return a file for a given content
+      # TODO: explain this more.
+      def file_for_contents(parameter_name, from: nil, contents: nil)
+        if parameter_name.to_s.end_with?("_file")
+          return parameter_name
+        end
+
+        if @tempfiles == nil
+          @tempfiles = []
+        end
+
+        contents ||= from[parameter_name]
+        return nil if contents.nil?
+
+        file = Tempfile.new(parameter_name.to_s)
+        file.write(contents)
+        file.close
+        @tempfiles << file
+        
+        file.path
+      end
+
+      def cleanup_tempfiles
+        @tempfiles.each do |f|
+          f.unlink
+        end
+      end
+
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-firebase_app_distribution
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Natchev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-27 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.127.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.127.1
+description: 
+email: snatchev@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/firebase_app_distribution.rb
+- lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb
+- lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_helper.rb
+- lib/fastlane/plugin/firebase_app_distribution/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Release your beta builds to Firebase App Distro
+test_files: []