fastlane-plugin-aws_sns_topic 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f74c299b3728b972eacba1b6df1678b1469904c214dc1b3fef42e4e1295b574b
4
+ data.tar.gz: f2a94eaeb97c6e785d6320ae9c33f2f6d57180451b370648a139e7bafe3a868c
5
+ SHA512:
6
+ metadata.gz: 3140d2a04681d44a03881926a7d4399713fb9892644dd02dd5030121f8774a987e10961f4afc9d1f917538330a54dcf1b5493f1abda1a62edd1759b14639b94b
7
+ data.tar.gz: 6a14acdaffb849e8b3e80690b6374182a541bdd78edad96510e37e235a6e5bff28258b93800db9f715f54d86f0a2ab3f0714d2caaae427f4fac597050a0e1938
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Levi Bostian <levi.bostian@gmail.com>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,74 @@
1
+ # aws_sns_topic plugin
2
+
3
+ [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-aws_sns_topic)
4
+
5
+ ## Getting Started
6
+
7
+ 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:
8
+
9
+ ```bash
10
+ fastlane add_plugin aws_sns_topic
11
+ ```
12
+
13
+ ## About aws_sns_topic
14
+
15
+ Fastlane plugin to public message to SNS topic.
16
+
17
+ 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!
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ notification_message_body = [
23
+ "App v#{versionOfApp}, build: #{buildVersion} ready for download.",
24
+ "\n",
25
+ "What has changed in this latest release?",
26
+ changelog
27
+ ].join("\n") + "\n"
28
+
29
+ aws_sns_topic(
30
+ access_key: ENV['S3_ACCESS_KEY'],
31
+ secret_access_key: ENV['S3_SECRET_ACCESS_KEY'],
32
+ region: 'us-east-1',
33
+ topic_arn: 'arn:aws:sns:us-east-1:167512897889:topic-name-here',
34
+ subject: "App v#{versionOfApp} ready for download",
35
+ message: notification_message_body
36
+ )
37
+ ```
38
+
39
+ *Note: It is recommended to not store the AWS access keys in the `Fastfile`.*
40
+
41
+ *Note: The only permissions you need to add to your AWS IAM user is `SNS:Publish` to the SNS topic you created.*
42
+
43
+ ## Development
44
+
45
+ ```
46
+ bundle install
47
+ ```
48
+
49
+ To run both the tests, and code style validation, run
50
+
51
+ ```
52
+ bundle exec rake
53
+ ```
54
+
55
+ To automatically fix many of the styling issues, use
56
+ ```
57
+ bundle exec rubocop -a
58
+ ```
59
+
60
+ ## Issues and Feedback
61
+
62
+ For any other issues and feedback about this plugin, please submit it to this repository.
63
+
64
+ ## Troubleshooting
65
+
66
+ If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
67
+
68
+ ## Using _fastlane_ Plugins
69
+
70
+ For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
71
+
72
+ ## About _fastlane_
73
+
74
+ _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).
@@ -0,0 +1,16 @@
1
+ require 'fastlane/plugin/aws_sns_topic/version'
2
+
3
+ module Fastlane
4
+ module AwsSnsTopic
5
+ # Return all .rb files inside the "actions" and "helper" directory
6
+ def self.all_classes
7
+ Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
8
+ end
9
+ end
10
+ end
11
+
12
+ # By default we want to import all available actions and helpers
13
+ # A plugin can contain any number of actions and plugins
14
+ Fastlane::AwsSnsTopic.all_classes.each do |current|
15
+ require current
16
+ end
@@ -0,0 +1,87 @@
1
+ require 'fastlane/action'
2
+ require_relative '../helper/aws_sns_topic_helper'
3
+
4
+ module Fastlane
5
+ UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
6
+
7
+ module Actions
8
+ class AwsSnsTopicAction < Action
9
+ def self.run(params)
10
+ access_key = params[:access_key]
11
+ secret_access_key = params[:secret_access_key]
12
+ region = params[:region]
13
+
14
+ topic_arn = params[:topic_arn]
15
+ message = params[:message]
16
+ subject = params[:subject]
17
+
18
+ Helper::AwsSnsTopicHelper.verify_params(params, [:access_key, :secret_access_key, :region, :topic_arn, :message, :subject])
19
+
20
+ topic_sender = Helper::AwsSns.new(access_key, secret_access_key, region, topic_arn)
21
+
22
+ UI.message("Sending message to SNS topic...")
23
+ topic_sender.publish_message(message, subject)
24
+ UI.success("AWS SNS Topic message sent!")
25
+ end
26
+
27
+ def self.description
28
+ "Public a message to a AWS SNS topic."
29
+ end
30
+
31
+ def self.authors
32
+ ["Levi Bostian"]
33
+ end
34
+
35
+ def self.return_value
36
+ # If your method provides a return value, you can describe here what it does
37
+ end
38
+
39
+ def self.details
40
+ "Public a new message to an AWS SNS topic. Created with the original intent of notifying a SNS topic about a new app release."
41
+ end
42
+
43
+ def self.available_options
44
+ [
45
+ FastlaneCore::ConfigItem.new(key: :access_key,
46
+ env_name: "AWS_SNS_ACCESS_KEY",
47
+ description: "AWS Access Key ID",
48
+ optional: false,
49
+ default_value: ENV['AWS_ACCESS_KEY_ID']),
50
+ FastlaneCore::ConfigItem.new(key: :secret_access_key,
51
+ env_name: "AWS_SNS_SECRET_ACCESS_KEY",
52
+ description: "AWS Secret Access Key",
53
+ optional: false,
54
+ default_value: ENV['AWS_SECRET_ACCESS_KEY']),
55
+ FastlaneCore::ConfigItem.new(key: :region,
56
+ env_name: "AWS_SNS_REGION",
57
+ description: "AWS Region",
58
+ optional: false,
59
+ default_value: ENV['AWS_REGION']),
60
+ FastlaneCore::ConfigItem.new(key: :topic_arn,
61
+ env_name: "AWS_SNS_TOPIC_ARN",
62
+ description: "AWS SNS topic ARN for the topic to send message to",
63
+ optional: false,
64
+ default_value: ENV['AWS_SNS_TOPIC_ARN']),
65
+ FastlaneCore::ConfigItem.new(key: :message,
66
+ env_name: "AWS_SNS_TOPIC_MESSAGE",
67
+ description: "The message you want to send to the AWS SNS topic",
68
+ optional: false,
69
+ default_value: ENV['AWS_SNS_TOPIC_MESSAGE']),
70
+ FastlaneCore::ConfigItem.new(key: :subject,
71
+ env_name: "AWS_SNS_TOPIC_SUBJECT",
72
+ description: "The subject you want to send to the AWS SNS topic",
73
+ optional: false,
74
+ default_value: ENV['AWS_SNS_TOPIC_SUBJECT'])
75
+ ]
76
+ end
77
+
78
+ def self.is_supported?(platform)
79
+ # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
80
+ # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
81
+ #
82
+ # [:ios, :mac, :android].include?(platform)
83
+ true
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,42 @@
1
+ require 'fastlane_core/ui/ui'
2
+ require 'aws-sdk'
3
+
4
+ module Fastlane
5
+ UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
6
+
7
+ module Helper
8
+ class AwsSnsTopicHelper
9
+ # class methods that you define here become available in your action
10
+ # as `Helper::AwsSnsTopicHelper.your_method`
11
+ #
12
+ def self.verify_params(params, required_params)
13
+ required_params.each do |required_param|
14
+ 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
15
+ end
16
+ end
17
+ end
18
+
19
+ class AwsSns
20
+ def initialize(access_key, secret_access_key, region, topic_arn)
21
+ @client = Aws::SNS::Client.new(
22
+ access_key_id: access_key,
23
+ secret_access_key: secret_access_key,
24
+ region: region
25
+ )
26
+ @topic = Aws::SNS::Topic.new(
27
+ arn: topic_arn,
28
+ client: @client
29
+ )
30
+ end
31
+
32
+ def publish_message(message, subject)
33
+ @topic.publish({
34
+ message: message,
35
+ subject: subject
36
+ })
37
+ rescue => error
38
+ UI.crash!("Send SNS topic message error: #{error.inspect}")
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,5 @@
1
+ module Fastlane
2
+ module AwsSnsTopic
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,189 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fastlane-plugin-aws_sns_topic
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Levi Bostian
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-12-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 3.0.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 3.0.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec_junit_formatter
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rake
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rubocop
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - '='
102
+ - !ruby/object:Gem::Version
103
+ version: 0.49.1
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - '='
109
+ - !ruby/object:Gem::Version
110
+ version: 0.49.1
111
+ - !ruby/object:Gem::Dependency
112
+ name: rubocop-require_tools
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: simplecov
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: fastlane
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: 2.135.2
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: 2.135.2
153
+ description:
154
+ email: levi.bostian@gmail.com
155
+ executables: []
156
+ extensions: []
157
+ extra_rdoc_files: []
158
+ files:
159
+ - LICENSE
160
+ - README.md
161
+ - lib/fastlane/plugin/aws_sns_topic.rb
162
+ - lib/fastlane/plugin/aws_sns_topic/actions/aws_sns_topic_action.rb
163
+ - lib/fastlane/plugin/aws_sns_topic/helper/aws_sns_topic_helper.rb
164
+ - lib/fastlane/plugin/aws_sns_topic/version.rb
165
+ homepage: https://github.com/levibostian/fastlane-plugin-aws_sns_topic
166
+ licenses:
167
+ - MIT
168
+ metadata: {}
169
+ post_install_message:
170
+ rdoc_options: []
171
+ require_paths:
172
+ - lib
173
+ required_ruby_version: !ruby/object:Gem::Requirement
174
+ requirements:
175
+ - - ">="
176
+ - !ruby/object:Gem::Version
177
+ version: '0'
178
+ required_rubygems_version: !ruby/object:Gem::Requirement
179
+ requirements:
180
+ - - ">="
181
+ - !ruby/object:Gem::Version
182
+ version: '0'
183
+ requirements: []
184
+ rubyforge_project:
185
+ rubygems_version: 2.7.7
186
+ signing_key:
187
+ specification_version: 4
188
+ summary: Fastlane plugin to public message to SNS topic.
189
+ test_files: []