fastlane-plugin-gmail_notify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77e3ddcf0622cd912e25c11e52279f57e8a0d3ae65fd12fa1a4901b6db29c40d
+  data.tar.gz: 89998b8ea6018a9a85bab741f4b5347f88ecf188595e8bc9af1a2afbbb3691c1
+SHA512:
+  metadata.gz: cfd29dcc45e16812151d7ed423ae2ebe767b408b19ddf171ae21fe1417a93230eaad099ec17f9a42d76ff1cf1260c5debb5701fe5610b3207534776a2142b7ff
+  data.tar.gz: db4d9479c5a2065d0306c30bb505e94bea27e9af9da91298cf5c323680639f68c9d0ad25395c09c49485bb3aeb5593e55134b669d228ffb199f41b5b8275abc5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Antony Leons <antonyleons@qburst.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 @@
+# gmail_notify plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-gmail_notify)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-gmail_notify`, add it to your project by running:
+
+```bash
+fastlane add_plugin gmail_notify
+```
+
+## About gmail_notify
+
+Sends a mail using SMTP
+
+**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/gmail_notify/actions/gmail_notify_action.rb

@@ -0,0 +1,108 @@
+require "fastlane/action"
+require_relative "../helper/gmail_notify_helper"
+
+module Fastlane
+  module Actions
+    class GmailNotifyAction < Action
+      def self.run(params)
+
+        require 'pony'
+
+        release_notes = File.read(params[:release_notes_file]).gsub("*", "<li>").gsub("\n", "</li>")
+
+        eth = Fastlane::ErbTemplateHelper
+        html_template = eth.load_from_path(params[:template_file])
+
+        body = eth.render(html_template, params[:placeholders])
+
+        Pony.mail({
+          :to => params[:recipients],
+          :cc => params[:cc],
+          :subject => params[:subject],
+          :html_body => body,
+          :body_part_header => { content_disposition: "inline" },
+          :via => :smtp,
+          :via_options => {
+            :address => "smtp.gmail.com",
+            :port => "587",
+            :enable_starttls_auto => true,
+            :user_name => params[:sender_email],
+            :password => params[:sender_password],
+            :authentication => :plain, # :plain, :login, :cram_md5, no auth by default
+            :domain => "localhost.localdomain", # the HELO domain provided by the client to the server
+          },
+        })
+      end
+
+      def self.description
+        "Sends a mail using SMTP"
+      end
+
+      def self.authors
+        ["Antony Leons"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "This plugin sends a mail using SMTP"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :sender_email,
+                                       env_name: "GMAIL_NOTIFY_SENDER_EMAIL",
+                                       description: "Gmail account to login with",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :sender_password,
+                                       env_name: "GMAIL_NOTIFY_SENDER_PASSWORD",
+                                       description: "Password of Gmail account to login with",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :recipients,
+                                       env_name: "GMAIL_NOTIFY_RECIPIENTS",
+                                       description: "Recipients of email",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :cc,
+                                       env_name: "GMAIL_NOTIFY_CC",
+                                       description: "CC of email",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :subject,
+                                       env_name: "GMAIL_NOTIFY_SUBJECT",
+                                       description: "Subject of email",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :template_file,
+                                       env_name: "GMAIL_NOTIFY_TEMPLATE_FILE",
+                                       description: "Path of template file",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :release_notes_file,
+                                       env_name: "GMAIL_NOTIFY_RELEASE_NOTES_FILE",
+                                       description: "Path of release notes file",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :placeholders,
+                                       env_name: "GMAIL_NOTIFY_TEMPLATE_PLACEHOLDERS",
+                                       description: "Placeholders for email template",
+                                       optional: false,
+                                       type: Hash),
+        ]
+      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
+    end
+  end
+end

data/lib/fastlane/plugin/gmail_notify/helper/gmail_notify_helper.rb

@@ -0,0 +1,52 @@
+require "fastlane_core/ui/ui"
+require "erb"
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class GmailNotifyHelper
+      # class methods that you define here become available in your action
+      # as `Helper::GmailNotifyHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the gmail_notify plugin helper!")
+      end
+    end
+
+    class ErbTemplateHelper
+      def self.load(template_name)
+        path = "#{Fastlane::ROOT}/lib/assets/#{template_name}.erb"
+        load_from_path(path)
+      end
+
+      def self.load_from_path(template_filepath)
+        unless File.exist?(template_filepath)
+          UI.user_error!("Could not find template at path '#{template_filepath}'")
+        end
+        File.read(template_filepath)
+      end
+
+      def self.render(template, template_vars_hash, trim_mode = nil)
+        Fastlane::Helper::ErbalT.new(template_vars_hash, trim_mode).render(template)
+      end
+    end
+
+    class ErbalT < OpenStruct
+      def initialize(hash, trim_mode = nil)
+        super(hash)
+        @trim_mode = trim_mode
+      end
+
+      def render(template)
+        # From Ruby 2.6, ERB.new takes keyword arguments and positional ones are deprecated
+        # https://bugs.ruby-lang.org/issues/14256
+        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
+          ERB.new(template, trim_mode: @trim_mode).result(binding)
+        else
+          # ERB.new(template, nil, @trim_mode).result(binding)
+        end
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/gmail_notify.rb

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

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-gmail_notify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Antony Leons
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.214.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.214.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: antonyleons@qburst.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/gmail_notify.rb
+- lib/fastlane/plugin/gmail_notify/actions/gmail_notify_action.rb
+- lib/fastlane/plugin/gmail_notify/helper/gmail_notify_helper.rb
+- lib/fastlane/plugin/gmail_notify/version.rb
+homepage: https://github.com/antonio2904/fastlane-plugin-gmail_notify
+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.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.18
+signing_key:
+specification_version: 4
+summary: Sends a mail using SMTP
+test_files: []