fastlane-plugin-branch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8305f250691fbd01e191ca2133151dc6ffa22d55
-  data.tar.gz: 953577ba927bb98740c1b41ed282487b5c23c584
+  metadata.gz: 119cbed9a2311d39484ec89b57f62f6553b2f2aa
+  data.tar.gz: 701c3ffb36e2150970c24a5b0dc4783400dc4b98
 SHA512:
-  metadata.gz: ec225b08a24f31de602203c00c85c6f744d59df021c03f0243b977956f613890b0e69b03a8cd2d9a5fd76d8d06faa46b5e29d540f43ddd33c5e09560b494ee22
-  data.tar.gz: 3403679f0c139b346dcc2482c1d8b6db7de412ba15be91a5e8febfd4fbe2eae2007bef7cdd3e3b0a87f5f168861ad2e86e34ca17fe99599254b75ba71e54ccbd
+  metadata.gz: 79161c0e1e407b9a22f28f9e2bef83ec9b2657db32773b33cb9251d6124c951c79954ca9eb80a3d675cb110085c13fcbca454533379c826eb3c5d0eb31c5e303
+  data.tar.gz: 10f2ee0fc9814a9bb97ef51149a21b6df2c02eab09627ce10de3817e81719beab1c1a37cb2fb0f10f9443fc0688cd9a50b0a53abe2ef024efaa2369f8cd6b150

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Jimmy Dee <jgvdthree@gmail.com>
+Copyright (c) 2017 Branch Metrics, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -56,22 +56,23 @@ setup_branch(
 
 Available options:
 
-|Fastfile key|Environment variable|description|type|default value|
+|Fastfile key|description|Environment variable|type|default value|
 |---|---|---|---|---|
-|:live_key|BRANCH_LIVE_KEY|The Branch live key to use (:live_key or :test_key is required)|string||
-|:test_key|BRANCH_TEST_KEY|The Branch test key to use (:live_key or :test_key is required)|string||
-|:app_link_subdomain|BRANCH_APP_LINK_SUBDOMAIN|An app.link subdomain to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|string||
-|:domains|BRANCH_DOMAINS|A list of domains (custom domains or Branch domains) to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|string array or comma-separated string||
-|:uri_scheme|BRANCH_URI_SCHEME|A URI scheme to add to the manifest (Android only)|string||
-|:android_project_path|BRANCH_ANDROID_PROJECT_PATH|Path to an Android project to use. Equivalent to 'android_manifest_path: "app/src/main/AndroidManifest.xml"`. Overridden by :android_manifest_path (:xcodeproj, :android_project_path or :android_manifest_path is required.)|string||
-|:android_manifest_path|BRANCH_ANDROID_MANIFEST_PATH|Path to an Android manifest to modify. Overrides :android_project_path. (:xcodeproj, :android_project_path or :android_manifest_path is required.)|string||
-|:xcodeproj|BRANCH_XCODEPROJ|Path to a .xcodeproj directory to use. (:xcodeproj, :android_project_path or :android_manifest_path is required.)|string||
-|:activity_name|BRANCH_ACTIVITY_NAME|Name of the Activity to use (Android only; optional)|string||
-|:target|BRANCH_TARGET|Name of the target to use in the Xcode project (iOS only; optional)|string||
-|:update_bundle_and_team_ids|BRANCH_UPDATE_BUNDLE_AND_TEAM_IDS|If true, changes the bundle and team identifiers in the Xcode project to match the AASA file. Mainly useful for sample apps. (iOS only)|boolean|false|
-|:remove_existing_domains|BRANCH_REMOVE_EXISTING_DOMAINS|If true, any domains currently configured in the Xcode project or Android manifest will be removed before adding the domains specified by the arguments. Mainly useful for sample apps.|boolean|false|
-|:force|BRANCH_FORCE_UPDATE|Update project(s) even if Universal Link validation fails|boolean|false|
-|:commit|BRANCH_COMMIT_CHANGES|Set to true to commit changes to Git; set to a string to commit with a custom message|boolean or string|false|
+|:live_key|The Branch live key to use (:live_key or :test_key is required)|BRANCH_LIVE_KEY|string||
+|:test_key|The Branch test key to use (:live_key or :test_key is required)|BRANCH_TEST_KEY|string||
+|:app_link_subdomain|An app.link subdomain to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|BRANCH_APP_LINK_SUBDOMAIN|string||
+|:domains|A list of domains (custom domains or Branch domains) to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|BRANCH_DOMAINS|array of strings or comma-separated string||
+|:uri_scheme|A URI scheme to add to the manifest (Android only)|BRANCH_URI_SCHEME|string||
+|:android_project_path|Path to an Android project to use. Equivalent to 'android_manifest_path: "app/src/main/AndroidManifest.xml"`. Overridden by :android_manifest_path (:xcodeproj, :android_project_path or :android_manifest_path is required.)|BRANCH_ANDROID_PROJECT_PATH|string||
+|:android_manifest_path|Path to an Android manifest to modify. Overrides :android_project_path. (:xcodeproj, :android_project_path or :android_manifest_path is required.)|BRANCH_ANDROID_MANIFEST_PATH|string||
+|:xcodeproj|Path to a .xcodeproj directory to use. (:xcodeproj, :android_project_path or :android_manifest_path is required.)|BRANCH_XCODEPROJ|string||
+|:activity_name|Name of the Activity to use (Android only; optional)|BRANCH_ACTIVITY_NAME|string||
+|:target|Name of the target to use in the Xcode project (iOS only; optional)|BRANCH_TARGET|string||
+|:update_bundle_and_team_ids|If true, changes the bundle and team identifiers in the Xcode project to match the AASA file. Mainly useful for sample apps. (iOS only)|BRANCH_UPDATE_BUNDLE_AND_TEAM_IDS|boolean|false|
+|:remove_existing_domains|If true, any domains currently configured in the Xcode project or Android manifest will be removed before adding the domains specified by the arguments. Mainly useful for sample apps.|BRANCH_REMOVE_EXISTING_DOMAINS|boolean|false|
+|:validate|Determines whether to validate the resulting Universal Link configuration before modifying the project|BRANCH_VALIDATE|boolean|true|
+|:force|Update project(s) even if Universal Link validation fails|BRANCH_FORCE_UPDATE|boolean|false|
+|:commit|Set to true to commit changes to Git; set to a string to commit with a custom message|boolean or string|BRANCH_COMMIT_CHANGES|false|
 
 Individually, all parameters are optional, but the following conditions apply:
 
@@ -106,11 +107,11 @@ validate_universal_links(domains: %w{example.com www.example.com})
 
 Available options:
 
-|Fastfile key|Environment variable|description|type|default value|
+|Fastfile key|description|Environment variable|type|default value|
 |---|---|---|---|---|
-|:xcodeproj|BRANCH_XCODEPROJ|Path to a .xcodeproj directory to use|string||
-|:target|BRANCH_TARGET|Name of the target to use in the Xcode project|string||
-|:domains|BRANCH_DOMAINS|A list of domains (custom domains or Branch domains) that must be present in the project.|string array or comma-separated string||
+|:xcodeproj|Path to a .xcodeproj directory to use|BRANCH_XCODEPROJ|string||
+|:target|Name of the target to use in the Xcode project|BRANCH_TARGET|string||
+|:domains|A list of domains (custom domains or Branch domains) that must be present in the project.|BRANCH_DOMAINS|array of strings or comma-separated string||
 
 All parameters are optional. Without any parameters, the action looks for a single .xcodeproj
 folder (with the exception of a Pods project) and reports an error if none or more than one is found.
@@ -128,11 +129,10 @@ This action does not use the Branchfile.
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. To try it:
 
 ```bash
-bundle install
-bundle exec fastlane validate          # The example project needs to be set up. This will fail.
-bundle exec fastlane update            # Also validates the UL configuration.
-bundle exec fastlane update_and_commit # Also commit changes to Git. (git reset --hard HEAD^ to erase the last commit)
-bundle exec fastlane validate          # Now validation will pass.
+fastlane validate          # The example project needs to be set up. This will fail.
+fastlane update            # Also validates the UL configuration.
+fastlane update_and_commit # Also commit changes to Git. (git reset --hard HEAD^ to erase the last commit)
+fastlane validate          # Now validation will pass.
 ```
 
 ## Run tests for this plugin

data/lib/fastlane/plugin/branch/actions/setup_branch_action.rb

@@ -33,9 +33,10 @@ module Fastlane
 
           if params[:update_bundle_and_team_ids]
             helper.update_team_and_bundle_ids_from_aasa_file xcodeproj, target, domains.first
-          elsif helper.validate_team_and_bundle_ids_from_aasa_files xcodeproj, target, domains, params[:remove_existing_domains]
+          elsif params[:validate] &&
+                helper.validate_team_and_bundle_ids_from_aasa_files(xcodeproj, target, domains, params[:remove_existing_domains])
             UI.message "Universal Link configuration passed validation. ✅"
-          else
+          elsif params[:validate]
             UI.error "Universal Link configuration failed validation."
             helper.errors.each { |error| UI.error " #{error}" }
             return unless params[:force]
@@ -99,12 +100,14 @@ module Fastlane
       def self.example_code
         [
           <<-EOF
-            setup_branch live_key: "key_live_xxxx",
-                         test_key: "key_test_yyyy",
-               app_link_subdomain: "myapp",
-                       uri_scheme: "myscheme", # Android only
-             android_project_path: "MyAndroidApp", # MyAndroidApp/src/main/AndroidManifest.xml
-                        xcodeproj: "MyIOSApp.xcodeproj"
+            setup_branch(
+              live_key: "key_live_xxxx",
+              test_key: "key_test_yyyy",
+              app_link_subdomain: "myapp",
+              uri_scheme: "myscheme", # Android only
+              android_project_path: "MyAndroidApp", # MyAndroidApp/src/main/AndroidManifest.xml
+              xcodeproj: "MyIOSApp.xcodeproj"
+            )
           EOF
         ]
       end
@@ -173,6 +176,11 @@ module Fastlane
                                   optional: true,
                              default_value: false,
                                  is_string: false),
+          FastlaneCore::ConfigItem.new(key: :validate,
+                                  env_name: "BRANCH_VALIDATE",
+                               description: "Determines whether to validate the resulting Universal Link configuration before modifying the project",
+                             default_value: true,
+                                 is_string: false),
           FastlaneCore::ConfigItem.new(key: :force,
                                   env_name: "BRANCH_FORCE_UPDATE",
                                description: "Update project(s) even if Universal Link validation fails",

data/lib/fastlane/plugin/branch/actions/validate_universal_links_action.rb

@@ -74,13 +74,13 @@ module Fastlane
             validate_universal_links
           EOF,
           <<-EOF
-            validate_universal_links xcodeproj: "MyProject.xcodeproj"
+            validate_universal_links(xcodeproj: "MyProject.xcodeproj")
           EOF,
           <<-EOF
-            validate_universal_links xcodeproj: "MyProject.xcodeproj", target: "MyProject"
+            validate_universal_links(xcodeproj: "MyProject.xcodeproj", target: "MyProject")
           EOF,
           <<-EOF
-            validate_universal_links domains: %w{example.com www.example.com}
+            validate_universal_links(domains: %w{example.com www.example.com})
           EOF
         ]
       end
@@ -89,12 +89,12 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :xcodeproj,
                                   env_name: "BRANCH_XCODEPROJ",
-                               description: "Path to an Xcode project to modify",
+                               description: "Path to an Xcode project to validate",
                                   optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :target,
                                   env_name: "BRANCH_TARGET",
-                               description: "Name of the target in the Xcode project to modify (iOS only)",
+                               description: "Name of the target in the Xcode project to validate",
                                   optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :domains,

data/lib/fastlane/plugin/branch/helper/ios_helper.rb

@@ -173,7 +173,9 @@ module Fastlane
       def contents_of_aasa_file(domain)
         uris = [
           URI("https://#{domain}/.well-known/apple-app-site-association"),
-          URI("https://#{domain}/apple-app-site-association")
+          URI("https://#{domain}/apple-app-site-association"),
+          URI("http://#{domain}/.well-known/apple-app-site-association"),
+          URI("http://#{domain}/apple-app-site-association")
         ]
 
         data = nil
@@ -197,7 +199,7 @@ module Fastlane
             end
 
             content_type = response["Content-type"]
-            @errors << "[#{domain}] AASA Response does not contain a Content-type header" and return nil if content_type.nil?
+            @errors << "[#{domain}] AASA Response does not contain a Content-type header" and next if content_type.nil?
 
             case content_type
             when %r{application/pkcs7-mime}
@@ -208,6 +210,7 @@ module Fastlane
               signature.verify [http.peer_cert], cert_store, nil, OpenSSL::PKCS7::NOVERIFY
               data = signature.data
             else
+              @error << "[#{domain}] Unsigned AASA files must be served via HTTPS" and next if uri.scheme == "http"
               data = response.body
             end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Branch
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-branch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
+- Branch
 - Jimmy Dee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -123,7 +124,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.26.1
 description: 
-email: jgvdthree@gmail.com
+email:
+- integrations@branch.io
+- jgvdthree@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -162,5 +165,6 @@ rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Adds Branch keys, custom URI schemes and domains to iOS and Android projects.
+  Validates the Universal Link configuration for any Xcode project.
 test_files: []
 has_rdoc: