fastlane-plugin-aws_sns_topic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f74c299b3728b972eacba1b6df1678b1469904c214dc1b3fef42e4e1295b574b
+  data.tar.gz: f2a94eaeb97c6e785d6320ae9c33f2f6d57180451b370648a139e7bafe3a868c
+SHA512:
+  metadata.gz: 3140d2a04681d44a03881926a7d4399713fb9892644dd02dd5030121f8774a987e10961f4afc9d1f917538330a54dcf1b5493f1abda1a62edd1759b14639b94b
+  data.tar.gz: 6a14acdaffb849e8b3e80690b6374182a541bdd78edad96510e37e235a6e5bff28258b93800db9f715f54d86f0a2ab3f0714d2caaae427f4fac597050a0e1938

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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 @@
+# aws_sns_topic plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-aws_sns_topic)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-aws_sns_topic`, add it to your project by running:
+
+```bash
+fastlane add_plugin aws_sns_topic
+```
+
+## About aws_sns_topic
+
+Fastlane plugin to public message to SNS topic.
+
+This plugin can be very handy to notify a group of people about a new app release. Create a AWS SNS topic, add recipient email addresses to the topic, then send a message to that topic with this plugin. Done! 
+
+## 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"
+
+aws_sns_topic(
+    access_key: ENV['S3_ACCESS_KEY'],
+    secret_access_key: ENV['S3_SECRET_ACCESS_KEY'],
+    region: 'us-east-1',
+    topic_arn: 'arn:aws:sns:us-east-1:167512897889:topic-name-here',
+    subject: "App v#{versionOfApp} ready for download",
+    message: notification_message_body
+)
+```
+
+*Note: It is recommended to not store the AWS access keys in the `Fastfile`.*
+
+*Note: The only permissions you need to add to your AWS IAM user is `SNS:Publish` to the SNS topic you created.*
+
+## 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
+```
+
+## 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/aws_sns_topic.rb

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

data/lib/fastlane/plugin/aws_sns_topic/actions/aws_sns_topic_action.rb

@@ -0,0 +1,87 @@
+require 'fastlane/action'
+require_relative '../helper/aws_sns_topic_helper'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Actions
+    class AwsSnsTopicAction < Action
+      def self.run(params)
+        access_key = params[:access_key]
+        secret_access_key = params[:secret_access_key]
+        region = params[:region]
+
+        topic_arn = params[:topic_arn]
+        message = params[:message]
+        subject = params[:subject]
+
+        Helper::AwsSnsTopicHelper.verify_params(params, [:access_key, :secret_access_key, :region, :topic_arn, :message, :subject])
+
+        topic_sender = Helper::AwsSns.new(access_key, secret_access_key, region, topic_arn)
+
+        UI.message("Sending message to SNS topic...")
+        topic_sender.publish_message(message, subject)
+        UI.success("AWS SNS Topic message sent!")
+      end
+
+      def self.description
+        "Public a message to a AWS SNS topic."
+      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
+        "Public a new message to an AWS SNS topic. Created with the original intent of notifying a SNS topic about a new app release."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :access_key,
+                                       env_name: "AWS_SNS_ACCESS_KEY",
+                                       description: "AWS Access Key ID",
+                                       optional: false,
+                                       default_value: ENV['AWS_ACCESS_KEY_ID']),
+          FastlaneCore::ConfigItem.new(key: :secret_access_key,
+                                       env_name: "AWS_SNS_SECRET_ACCESS_KEY",
+                                       description: "AWS Secret Access Key",
+                                       optional: false,
+                                       default_value: ENV['AWS_SECRET_ACCESS_KEY']),
+          FastlaneCore::ConfigItem.new(key: :region,
+                                       env_name: "AWS_SNS_REGION",
+                                       description: "AWS Region",
+                                       optional: false,
+                                       default_value: ENV['AWS_REGION']),
+          FastlaneCore::ConfigItem.new(key: :topic_arn,
+                                       env_name: "AWS_SNS_TOPIC_ARN",
+                                       description: "AWS SNS topic ARN for the topic to send message to",
+                                       optional: false,
+                                       default_value: ENV['AWS_SNS_TOPIC_ARN']),
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "AWS_SNS_TOPIC_MESSAGE",
+                                       description: "The message you want to send to the AWS SNS topic",
+                                       optional: false,
+                                       default_value: ENV['AWS_SNS_TOPIC_MESSAGE']),
+          FastlaneCore::ConfigItem.new(key: :subject,
+                                       env_name: "AWS_SNS_TOPIC_SUBJECT",
+                                       description: "The subject you want to send to the AWS SNS topic",
+                                       optional: false,
+                                       default_value: ENV['AWS_SNS_TOPIC_SUBJECT'])
+        ]
+      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/aws_sns_topic/helper/aws_sns_topic_helper.rb

@@ -0,0 +1,42 @@
+require 'fastlane_core/ui/ui'
+require 'aws-sdk'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class AwsSnsTopicHelper
+      # class methods that you define here become available in your action
+      # as `Helper::AwsSnsTopicHelper.your_method`
+      #
+      def self.verify_params(params, required_params)
+        required_params.each do |required_param|
+          UI.user_error!("You forgot to pass in the parameter: #{required_param}, pass using `#{required_param}: 'value-here'`") unless params[required_param].to_s.length > 0
+        end
+      end
+    end
+
+    class AwsSns
+      def initialize(access_key, secret_access_key, region, topic_arn)
+        @client = Aws::SNS::Client.new(
+          access_key_id: access_key,
+          secret_access_key: secret_access_key,
+          region: region
+        )
+        @topic = Aws::SNS::Topic.new(
+          arn: topic_arn,
+          client: @client
+        )
+      end
+
+      def publish_message(message, subject)
+        @topic.publish({
+          message: message,
+          subject: subject
+        })
+      rescue => error
+        UI.crash!("Send SNS topic message error: #{error.inspect}")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-aws_sns_topic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Levi Bostian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !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.135.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.135.2
+description: 
+email: levi.bostian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/aws_sns_topic.rb
+- lib/fastlane/plugin/aws_sns_topic/actions/aws_sns_topic_action.rb
+- lib/fastlane/plugin/aws_sns_topic/helper/aws_sns_topic_helper.rb
+- lib/fastlane/plugin/aws_sns_topic/version.rb
+homepage: https://github.com/levibostian/fastlane-plugin-aws_sns_topic
+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: []