fastlane-community / fastlane-plugin-aws_sns Goto Github PK

View Code? Open in Web Editor NEW

12.0 2.0 8.0 30 KB

fastlane plugin for creating AWS SNS platform applications for iOS and Android apps by @joshdholtz

License: MIT License

Ruby 100.00%

fastlane-plugin-aws_sns's Introduction

aws_sns `fastlane` plugin

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-aws_sns, add it to your project by running:

fastlane add_plugin aws_sns

About aws_sns

AWS SNS is fully manage push notification service. This plugin creates an AWS SNS platform application for iOS and Android apps.

iOS app are created by uploading a private key (p12) to AWS SNS - which can easily be created with PEM

Android apps are created by sending up a GCM Api Key to AWS SNS - obtained through your Google Cloud Platform dashboard

The call to aws_sns will return the AWS SNS plattform application's ARN (if you need it). The platform application's ARN is what is used to actually send notifications to your app(s) later on.

Example

iOS

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'
  # Optional: updating certificate if platform_name already exists
  # update_if_exist: true
)

Android

aws_sns(
  platform: 'GCM',
  platform_name: 'your_awesome_android_app',
  platform_gcm_api_key: 'your_gcm_api_key'
  # Optional: updating key if platform_name already exists
  # update_if_exist: true
)

iOS (using the ARN)

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

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 doc in the main fastlane repo.

Using `fastlane` Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

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.

Author

Josh Holtz, [email protected], @joshdholtz

I'm available for freelance work (Fastlane, iOS, and Android development) 💪 Feel free to contact me 🚀

fastlane-plugin-aws_sns's People

Stargazers

Watchers

Forkers

waltermvp visibacare gkosciolek david-spaeth courtneywill seeclickfix qoqa bfansports

fastlane-plugin-aws_sns's Issues

Possible to add support for VoIP?

First of all, great plugin! 👍

I wonder if it's possible to add support for VoIP certificates (aka PushKit) also since SNS has support for this?
I can send a pull request if you want. Would help me a lot if support for this was added!

conflicting dependency with fastlane 2.149.1

Unable to install plugin because of 'aws-sdk-core' dependency conflict.

bundle exec fastlane add_plugin aws_sns
[✔] 🚀

[15:22:35]: Plugin 'fastlane-plugin-aws_sns' was added to './Pluginfile'
[15:22:35]: Make sure to commit your Gemfile, Gemfile.lock and Pluginfile to version control
Installing plugin dependencies...
Bundler could not find compatible versions for gem "aws-sdk-core":
  In Gemfile:
    fastlane-plugin-aws_sns was resolved to 0.1.1, which depends on
      aws-sdk (~> 2.0.0) was resolved to 2.0.1.pre, which depends on
        aws-sdk-resources (= 2.0.1.pre) was resolved to 2.0.1.pre, which depends on
          aws-sdk-core (= 2.0.1)

    fastlane was resolved to 2.149.1, which depends on
      aws-sdk-s3 (~> 1.0) was resolved to 1.68.1, which depends on
        aws-sdk-core (~> 3, >= 3.99.0)

Can you consider updating the version of 'aws-sdk-core'?

Unable to add plugin when aws_s3 is installed

@joshdholtz First of all thank you for these amazing plugins.

I am unable to add sns plugin due to a aws dependency conflict with aws_s3.
Any workarounds?

waltervargas-pena@Walters-MacBook-Pro ios (development) $ bundle exec fastlane add_plugin aws_sns
+----------------------------+---------+-------------------------------------+
|                                Used plugins                                |
+----------------------------+---------+-------------------------------------+
| Plugin                     | Version | Action                              |
+----------------------------+---------+-------------------------------------+

| fastlane-plugin-aws_s3     | 1.1.0   | aws_s3                              |
| fastlane-plugin-badge      | 1.0.0   | add_badge                           |
| fastlane-plugin-s3_actions | 0.1.3   | s3_check_file s3_download s3_upload |
+----------------------------+---------+-------------------------------------+

[14:39:16]: Plugin 'fastlane-plugin-aws_sns' was added to './fastlane/Pluginfile'
[14:39:16]: Make sure to commit your Gemfile, Gemfile.lock and Pluginfile to version control
Installing plugin dependencies...
The latest bundler is 1.16.0.pre.3, but you are currently running 1.15.4.
To update, run `gem install bundler --pre`
Bundler could not find compatible versions for gem "aws-sdk":
  In snapshot (Gemfile.lock):
    aws-sdk (= 2.10.62)

  In Gemfile:
    fastlane-plugin-aws_s3 was resolved to 1.1.0, which depends on
      aws-sdk (~> 2.3)

    fastlane-plugin-aws_sns was resolved to 0.1.1, which depends on
      aws-sdk (~> 2.0.0)

Running `bundle update` will rebuild your snapshot from scratch, using only
the gems in your Gemfile, which may resolve the conflict.
waltervargas-pena@Walters-MacBook-Pro ios (development) $ bundle exec fastlane add_plugin aws_sns