fastlane-plugin-aws_sns 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4256a27b632e0522c97c8b18d0c898a465372aab
-  data.tar.gz: 8f7f772d2c50ff9f565e74c2fe08f0276b00e8c4
+  metadata.gz: d51df83e65599d0b3776675c1b991c578c7ff795
+  data.tar.gz: 2625cf56ad866473f768187cd1c7b4ba9fb8a8db
 SHA512:
-  metadata.gz: d7dd0fddb60f1611412c673890001ab537609c944dee097530a686ae282e0fe4d8fae7e1a6b3002bd2d7c31080e4aee6b1581f6a18e5ce708f9d1d0bd6cdf770
-  data.tar.gz: 17ff6591e1360367e969e9831488880b48d99f609dde436ba8f102aaff8a4ac961a1ef72041d124d251545c812e0526175310da6015785551cf925b6585014c0
+  metadata.gz: b71387142dd5f00f3d9f387322cdfc671ebea39e06f1e56661881b85160eaee487383fd61bd2743a4c05b1392ff1062a8dd0dbc078af56ff19deee21bcd86cf5
+  data.tar.gz: a4e30adca8be9347457db0628e595961d7d0561e9e33576993902259772ff7aefd985db781b3b1e892546f624ef9347db996fe47ec28150c3b01b4fcd769ddd0

data/README.md

@@ -1,4 +1,4 @@
-# aws_sns plugin
+# aws_sns `fastlane` plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-aws_sns)
 
@@ -12,15 +12,48 @@ fastlane add_plugin aws_sns
 
 ## About aws_sns
 
-Creates AWS SNS platform applications
+[AWS SNS](https://aws.amazon.com/sns/) is fully manage push notification service. This plugin creates an AWS SNS platform application for iOS and Android apps.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+iOS app are created by uploading a private key (p12) to AWS SNS - which can easily be created with [PEM](https://github.com/fastlane/fastlane/tree/master/pem)
+
+Android apps are created by sending up a GCM Api Key to AWS SNS - obtained through your [Google Cloud Platform dashboard](https://console.cloud.google.com)
+
+The call to `aws_sns` will return the AWS SNS plattform application's [ARN](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) (if you need it). The platform application's ARN is what is used to actually send notifications to your app(s) later on.
 
 ## 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`.
+### iOS
+```ruby
+aws_sns(
+  platform: 'APNS',
+  platform_name: 'your_awesome_ios_app',
+  platform_apns_private_key_path: 'path/to/cert.p12',
+
+  # Optional private key password
+  # platform_apns_private_key_password: 'joshissupercool'
+)
+```
+
+### Android
+```ruby
+aws_sns(
+  platform: 'GCM',
+  platform_name: 'your_awesome_android_app',
+  platform_gcm_api_key: 'your_gcm_api_key'
+)
+```
 
-**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)
+### iOS (using the ARN)
+```ruby
+ios_arn = aws_sns(
+  platform: 'APNS',
+  platform_name: 'your_awesome_ios_app',
+  platform_apns_private_key_path: 'path/to/cert.p12',
+)
+
+# TODO: Possibly send this ARN to someone important who needs to configure stuff
+puts "ARN: #{ios_arn}"
+```
 
 ## Run tests for this plugin
 
@@ -50,3 +83,10 @@ For more information about how the `fastlane` plugin system works, check out the
 ## 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).
+
+## Author
+
+Josh Holtz, josh@rokkincat.com, [@joshdholtz](https://twitter.com/joshdholtz)
+
+I'm available for freelance work (Fastlane, iOS, and Android development) :muscle:
+Feel free to contact me :rocket:

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

@@ -1,5 +1,5 @@
 module Fastlane
   module AwsSns
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-aws_sns
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Josh Holtz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Creates AWS SNS platform applications