fastlane-plugin-postmark 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc1bd1c0c2327b378bc829fc944c6c8ec12740c746c7008f3eec25c758e7285c
+  data.tar.gz: db3d431948318453b27775eb0e652351cf6fa629c4e39cfab0e0e20981301cb3
+SHA512:
+  metadata.gz: dccf478bf11111d2297b2298e777f1abbb2a81ee9dd58281b43cce5b3243a995ec51ca5fb2bb49833fb4f6d1c36a59c5b27b9214e4303a569833fb9627ff2670
+  data.tar.gz: 77f06d051343d694bdefb53e86e5ba3a719d429b985615379ff19c982e41cf83f9870b8c882b778c98f1afbba35efd00d18dc40c659114a19214fcaf9e201d1e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Levi Bostian <levi.bostian@gmail.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,74 @@
+# postmark plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-postmark)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-postmark`, add it to your project by running:
+
+```bash
+fastlane add_plugin postmark
+```
+
+## About 
+
+Fastlane plugin to send emails via [Postmark](https://postmarkapp.com/).
+
+This plugin can be very handy to notify a group of people about a new app release.
+
+## Example
+
+```ruby
+notification_message_body = [
+    "App v#{versionOfApp}, build: #{buildVersion} ready for download.",
+    "\n",
+    "What has changed in this latest release?",
+    changelog
+].join("\n") + "\n"
+
+postmark(
+    api_key: "server-token", # Or, set `POSTMARK_API_KEY` environment variable 
+    from: "First Last <you@you.com>", # Or, set `POSTMARK_FROM_EMAIL_ADDRESS` environment variable 
+    to: "dana@gmail.com, other-person@example.com", # comma separated list of people to send to. Or, set `POSTMARK_TO_EMAIL_ADDRESS` environment variable 
+    subject: "App v#{versionOfApp} ready for download", # Or, set `POSTMARK_EMAIL_SUBJECT` environment variable 
+    message_text: notification_message_body, # text only email body. If you want to use HTML instead, leave this blank. 
+    message_html: "<h1>...</h1>", # HTML email body. If you want to use text instead, leave this blank. 
+)
+```
+
+*Note: It is recommended to not store the API key in the `Fastfile`.*
+
+## Development
+
+```
+bundle install 
+```
+
+To run both the tests, and code style validation, run
+
+```
+bundle exec rake
+```
+
+To automatically fix many of the styling issues, use
+```
+bundle exec rubocop -a
+```
+
+You can test out the plugin using the instructions in the example Fastfile. Check out `./fastlane/Fastfile`.
+
+## 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/postmark.rb

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

data/lib/fastlane/plugin/postmark/actions/postmark_action.rb

@@ -0,0 +1,87 @@
+require 'fastlane/action'
+require_relative '../helper/postmark_helper'
+require 'postmark'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Actions
+    class PostmarkAction < Action
+      def self.run(params)
+        @client = ::Postmark::ApiClient.new(params[:api_key])
+
+        UI.message("Sending email via Postmark...")
+        begin
+          @client.deliver(
+            from: params[:from],
+            to: params[:to].split(",").map(&:strip),
+            subject: params[:subject],
+            html_body: params[:message_html],
+            text_body: params[:message_text]
+          )
+        rescue => error
+          UI.crash!("Send email via Postmark error: #{error.inspect}")
+        end
+
+        UI.success("Email sent successfully!")
+      end
+
+      def self.description
+        "Send emails via Postmark in fastlane!"
+      end
+
+      def self.authors
+        ["Levi Bostian"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "Already using Postmark to send emails in your project? Send emails to 1 or more people with ease. Created with the original intent of notifying a group of people of an app release."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "POSTMARK_API_KEY",
+                                       description: "Postmark server API ID",
+                                       optional: false,
+                                       default_value: ENV['POSTMARK_API_KEY']),
+          FastlaneCore::ConfigItem.new(key: :from,
+                                       env_name: "POSTMARK_FROM_EMAIL_ADDRESS",
+                                       description: "Email address to send emails as. This should be an email address from the domain in your Postmark account",
+                                       optional: false,
+                                       default_value: ENV['POSTMARK_FROM_EMAIL_ADDRESS']),
+          FastlaneCore::ConfigItem.new(key: :to,
+                                       env_name: "POSTMARK_TO_EMAIL_ADDRESS",
+                                       description: "List of email addresses you want to send the email to. Comma separated string is accepted",
+                                       optional: false,
+                                       default_value: ENV['POSTMARK_TO_EMAIL_ADDRESS']),
+          FastlaneCore::ConfigItem.new(key: :subject,
+                                       env_name: "POSTMARK_EMAIL_SUBJECT",
+                                       description: "The subject you want your email to have",
+                                       optional: false,
+                                       default_value: ENV['POSTMARK_EMAIL_SUBJECT']),
+          FastlaneCore::ConfigItem.new(key: :message_text,
+                                       env_name: "POSTMARK_EMAIL_MESSAGE_TEXT",
+                                       description: "The body you want your email to have. Text only. If you want to use html instead, leave this option blank",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :message_html,
+                                       env_name: "POSTMARK_EMAIL_MESSAGE_HTML",
+                                       description: "The body you want your email to have. HTML only. If you want to use text instead, leave this option blank",
+                                       optional: true)
+        ]
+      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/postmark/helper/postmark_helper.rb

@@ -0,0 +1,10 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class PostmarkHelper
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-postmark
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Levi Bostian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: postmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !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.144'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.144'
+description: 
+email: levi.bostian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/postmark.rb
+- lib/fastlane/plugin/postmark/actions/postmark_action.rb
+- lib/fastlane/plugin/postmark/helper/postmark_helper.rb
+- lib/fastlane/plugin/postmark/version.rb
+homepage: https://github.com/levibostian/fastlane-plugin-postmark
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Fastlane plugin to public message to SNS topic.
+test_files: []