fastlane-plugin-push_cert_alert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b314ae55ef7470ee477d2d7b46f23f4ece80e477632575809330e94bb2f5cb7c
+  data.tar.gz: 4cd8dd84c0656ae00a04a8b6bf9bb89353204bb6782387e0b13170e949fc5198
+SHA512:
+  metadata.gz: 83e3299951c1e85e36dc018e838f7da6d29a52a9e52fdd7e2109c3cee3c542a992a5c8a474e2e2a9447d03a45f9243d2a8bb1af83b514efef3da8e3c72b49312
+  data.tar.gz: 5fd618d89f6f2ebdf60a8bda7415af363b6a3d54d0c555fc28e659fa99816b9b1a65f8f185a052e9b0d668c8a8b0c97d9d3c7636c952d713ee52e2ed49f11f03

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nico Richard <nicorichard@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,99 @@
+# Push Cert Alert - Fastlane Plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-push_cert_alert)
+
+Fastlane's [PEM](https://docs.fastlane.tools/actions/pem/) tool provides amazing capabilities for generating new push certificates when the old one will expire.
+
+But what if you just want to just check the expiration date without making modifications? Or alert your team on Slack when the date is approaching?
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-push_cert_alert`, add it to your project by running:
+
+```bash
+fastlane add_plugin push_cert_alert
+```
+
+## About push_cert_alert
+
+Generate alerts for when a push certificate will expire soon, or has expired already.
+
+## Usage
+
+> If you already use get_push_certificate (pem) and slack actions somewhere in your lanes then you are already configured.\
+> Run `bundle exec fastlane action push_cert_alert` for more information.
+
+Simply add `check_push_certificate` to some lane:
+
+```ruby
+lane :test do
+    check_push_certificate
+end
+```
+
+And you will receive a Slack alert when your cert has expired (or expires soon):
+
+> An APNS push certificate expires in 30 days
+>
+> **Lane:** test\
+> **Result:** Error\
+> **App Identifier:** com.company.name\
+> **Type:**  production\
+> **Expires at:** 1955-11-05 11:11:11 UTC\
+> **Name:** Apple Push Services
+
+You can also add custom callbacks for the events if desired:
+
+```ruby
+check_push_certificate(
+    active_days_limit: 60, # Default is 30
+    skip_slack: true, # Defaults to true
+    expires_soon: proc do |cert, days|
+        puts "#{days} days until #{cert.name} expires. Perhaps you should run `get_push_certificate` soon to upgrade your push services."
+    end,
+    expired: proc do
+        puts "🚨 DANGER - Our push cert is expired (or missing)!"
+    end
+)
+```
+
+## Integration
+
+Integrate this lane with your other lanes and/or CI to be made aware early of any upcoming push certificate expiration.
+
+### Circle CI
+
+Example Circle CI job which could be run with your daily builds
+
+```yaml
+
+jobs:
+  push_cert_alert:
+    executor: my_executor
+    steps:
+      - checkout
+      - restore_cache
+      - install_bundles
+      - run: bundle exec fastlane YOUR LANE
+
+```
+
+## 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`.
+
+## 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/push_cert_alert/actions/check_push_certificate_action.rb

@@ -0,0 +1,159 @@
+require 'fastlane/action'
+require_relative '../helper/login_helper'
+require_relative '../helper/certificate_helper'
+require_relative '../helper/slack_helper'
+
+module Fastlane
+  module Actions
+    class CheckPushCertificateAction < Action
+      def self.run(params)
+        Helper::Login.login(params)
+
+        UI.message("Attempting to fetch existing an existing push certificate.")
+
+        existing_certificate = Helper::Certificate.existing_certificate(params)
+        remaining_days = existing_certificate ? Helper::Certificate.remaining_days(existing_certificate) : 0
+
+        if existing_certificate and remaining_days > 0
+          UI.message("The push notification profile for '#{existing_certificate.owner_name}' is valid for #{remaining_days.round} days")
+
+          if remaining_days < params[:active_days_limit]
+            UI.message("The push notification profile is valid for less than the limit of #{params[:active_days_limit]} days")
+
+            params[:expires_soon].call(existing_certificate, remaining_days) if params[:expires_soon]
+
+            Helper::Slack.slack(
+              message: "An APNS push certificate expires in #{remaining_days} days",
+              certificate: existing_certificate,
+              params: params
+            ) if not params[:skip_slack]
+          end
+        else
+          if existing_certificate
+            UI.message("The push notification profile has expired")
+          else
+            UI.message("A push notification profile cannot be found")
+          end
+
+          params[:expired].call() if params[:expired]
+
+          Helper::PushCertAlertSlackHelper.slack(
+            message: "An APNS push certificate has expired or cannot be found",
+            params: params
+          ) if not params[:skip_slack]
+        end
+      end
+
+      def self.description
+        "Easily create alerts for your APNS push certificate expiration"
+      end
+
+      def self.authors
+        ["Nico Richard"]
+      end
+
+      def self.available_options
+        user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
+        user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+        [
+          FastlaneCore::ConfigItem.new(key: :expires_soon,
+                                       description: "Block that is called if the profile expires in less than the `active_days_limit`. Called with `certificate, days_remaining`",
+                                       optional: true,
+                                       type: Proc),
+          FastlaneCore::ConfigItem.new(key: :expired,
+                                       description: "Block that is called if the profile is expired. Called with empty params",
+                                       optional: true,
+                                       type: Proc),
+          FastlaneCore::ConfigItem.new(key: :active_days_limit,
+                                       env_name: "PEM_ACTIVE_DAYS_LIMIT",
+                                       description: "If the current certificate is active for less than this number of days, generate a new one",
+                                       default_value: 30,
+                                       is_string: false,
+                                       type: Integer,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Value of active_days_limit must be a positive integer or left blank") unless value.kind_of?(Integer) && value > 0
+                                       end),          
+          # Spaceship Certificate Fetching
+          FastlaneCore::ConfigItem.new(key: :development,
+                                       env_name: "PEM_DEVELOPMENT",
+                                       description: "Renew the development push certificate instead of the production one",
+                                       is_string: false,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :website_push,
+                                       env_name: "PEM_WEBSITE_PUSH",
+                                       description: "Create a Website Push certificate",
+                                       is_string: false,
+                                       conflicting_options: [:development],
+                                       default_value: false),          
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                       short_option: "-a",
+                                       env_name: "PEM_APP_IDENTIFIER",
+                                       description: "The bundle identifier of your app",
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier),
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       short_option: "-u",
+                                       env_name: "PEM_USERNAME",
+                                       description: "Your Apple ID Username",
+                                       default_value: user,
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :team_id,
+                                       short_option: "-b",
+                                       env_name: "PEM_TEAM_ID",
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
+                                       default_value_dynamic: true,
+                                       description: "The ID of your Developer Portal team if you're in multiple teams",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         ENV["FASTLANE_TEAM_ID"] = value.to_s
+                                       end),
+          # Slack
+          FastlaneCore::ConfigItem.new(key: :skip_slack,
+                                       description: "Skip sending an alert to Slack",
+                                       optional: true,
+                                       type: Boolean,
+                                       default_value: false),          
+          FastlaneCore::ConfigItem.new(key: :slack_url,
+                                       short_option: "-i",
+                                       env_name: "SLACK_URL",
+                                       sensitive: true,
+                                       description: "Create an Incoming WebHook for your Slack group to post results there",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         if !value.to_s.empty? && !value.start_with?("https://")
+                                           UI.user_error!("Invalid URL, must start with https://")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :slack_channel,
+                                       short_option: "-e",
+                                       env_name: "SCAN_SLACK_CHANNEL",
+                                       description: "#channel or @username",
+                                       optional: true)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.example_code
+        [
+          <<-CODE
+            check_push_certificate(
+              active_days_limit: 60,
+              expires_soon: proc do |cert, days|
+                puts "#{days} days to live!"
+              end,
+              expired: proc do
+                puts "UH OH!!! Our push cert may be expired!"
+              end
+            )
+          CODE
+        ]
+      end      
+    end
+  end
+end

data/lib/fastlane/plugin/push_cert_alert/helper/certificate_helper.rb

@@ -0,0 +1,41 @@
+require 'spaceship'
+
+module Fastlane
+    module Helper
+        class Certificate
+            def self.certificate(params)
+              if params[:development]
+                Spaceship.certificate.development_push
+              elsif params[:website_push]
+                Spaceship.certificate.website_push
+              else
+                Spaceship.certificate.production_push
+              end
+            end
+      
+            def self.certificate_type(params)
+              if params[:development]
+                'development'
+              elsif params[:website_push]
+                'website'
+              else
+                'production'
+              end
+            end      
+      
+            def self.certificate_sorted(params)
+              certificate(params).all.sort { |x, y| y.expires <=> x.expires }
+            end
+      
+            def self.existing_certificate(params)
+              certificate_sorted(params).detect do |c|
+                c.owner_name == params[:app_identifier]
+              end
+            end
+      
+            def self.remaining_days(certificate)
+              ((certificate.expires - Time.now) / 60 / 60 / 24).round(2)
+            end
+        end
+    end
+end

data/lib/fastlane/plugin/push_cert_alert/helper/login_helper.rb

@@ -0,0 +1,14 @@
+require 'spaceship'
+
+module Fastlane
+    module Helper
+      class Login
+        def self.login(params)
+          UI.message("Starting login with user '#{params[:username]}'")
+          Spaceship.login(params[:username], nil)
+          Spaceship.client.select_team
+          UI.message("Successfully logged in")
+        end
+      end
+    end
+end

data/lib/fastlane/plugin/push_cert_alert/helper/slack_helper.rb

@@ -0,0 +1,51 @@
+require 'fastlane/action'
+require 'fastlane/actions/slack'
+require 'fastlane_core/configuration/configuration'
+
+module Fastlane
+  module Helper
+    class Slack
+      def self.slack(message: "APNS Push Cert Alert", certificate: nil, params: {})
+        fields = [
+          {
+            title: "App Identifier",
+            value: params[:app_identifier],
+            short: true
+          },
+          {
+            title: "Type",
+            value: Helper::Certificate.certificate_type(params),
+            short: true
+          }
+        ]
+
+        if certificate
+          fields << {
+            title: "Expires at",
+            value: certificate.expires,
+            short: true
+          }
+
+          fields << {
+            title: "Name",
+            value: certificate.name,
+            short: true
+          }
+        end
+
+        options = FastlaneCore::Configuration.create(Fastlane::Actions::SlackAction.available_options, {
+          message: message,
+          channel: params[:slack_channel],
+          slack_url: params[:slack_url],
+          success: false,
+          payload: {},
+          attachment_properties: {
+            fields: fields
+          }
+        })
+
+        Fastlane::Actions::SlackAction.run(options)
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/push_cert_alert.rb

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

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-push_cert_alert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nico Richard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.197.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.197.0
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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'
+description: 
+email: nicorichard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/push_cert_alert.rb
+- lib/fastlane/plugin/push_cert_alert/actions/check_push_certificate_action.rb
+- lib/fastlane/plugin/push_cert_alert/helper/certificate_helper.rb
+- lib/fastlane/plugin/push_cert_alert/helper/login_helper.rb
+- lib/fastlane/plugin/push_cert_alert/helper/slack_helper.rb
+- lib/fastlane/plugin/push_cert_alert/version.rb
+homepage: https://github.com/CityTransit/fastlane-plugin-push_cert_alert
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate alerts for when your APNS push certificate expires or will expire
+  soon
+test_files: []