Merge pull request #1142 from NYPL-Simplified/release/3.4.0

Merge 3.4.0 release into master

.gitignore

@@ -12,4 +12,4 @@ Simplified/APIKeys.swift
 AudioEngine.json
 Carthage
 GoogleService-Info.plist
-
+Simplified/NYPLSecrets.swift

Cartfile.resolved

@@ -1,9 +1,9 @@
 binary "Crashlytics.json" "3.14.0"
-binary "https://dl.google.com/dl/firebase/ios/carthage/FirebaseAnalyticsBinary.json" "6.18.0"
+binary "https://dl.google.com/dl/firebase/ios/carthage/FirebaseAnalyticsBinary.json" "6.24.0"
 github "NYPL-Simplified/CardCreator-iOS" "v1.1.2"
-github "NYPL-Simplified/NYPLAEToolkit" "27c08e76cb46985f7861cce50782972b8e05e6fa"
-github "NYPL-Simplified/NYPLAudiobookToolkit" "010c2b066c51672fc0bbb4abac485b0cdde1025e"
+github "NYPL-Simplified/NYPLAEToolkit" "038b7de4fcc777542eedffdb6427087c3f5799a7"
+github "NYPL-Simplified/NYPLAudiobookToolkit" "d43d64389810a519ba3cdf8fbc63bd59e2635d3d"
 github "NYPL-Simplified/PDFRendererProvider-iOS" "b0ee13aa74e0d88193a401c29624dda8120a340d"
-github "PureLayout/PureLayout" "v3.1.5"
+github "PureLayout/PureLayout" "v3.1.6"
 github "TheLevelUp/ZXingObjC" "3.6.4"
 github "stephencelis/SQLite.swift" "0.11.6"

GoogleService-Info.plist.example

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CLIENT_ID</key>
+	<string>{CLIENT_ID}.apps.googleusercontent.com</string>
+	<key>REVERSED_CLIENT_ID</key>
+	<string>com.googleusercontent.apps.{CLIENT_ID}</string>
+	<key>API_KEY</key>
+	<string>{API_KEY}</string>
+	<key>GCM_SENDER_ID</key>
+	<string>{GCM_SENDER_ID}</string>
+	<key>PLIST_VERSION</key>
+	<string>1</string>
+	<key>BUNDLE_ID</key>
+	<string>{BUNDLE_ID}</string>
+	<key>PROJECT_ID</key>
+	<string>{PROJECT_ID}</string>
+	<key>STORAGE_BUCKET</key>
+	<string>{STORAGE_BUCKET}</string>
+	<key>IS_ADS_ENABLED</key>
+	<false></false>
+	<key>IS_ANALYTICS_ENABLED</key>
+	<false></false>
+	<key>IS_APPINVITE_ENABLED</key>
+	<true></true>
+	<key>IS_GCM_ENABLED</key>
+	<true></true>
+	<key>IS_SIGNIN_ENABLED</key>
+	<true></true>
+	<key>GOOGLE_APP_ID</key>
+	<string>{GOOGLE_APP_ID}</string>
+	<key>DATABASE_URL</key>
+	<string>{DATABASE_URL}</string>
+</dict>
+</plist>

README.md

@@ -1,6 +1,6 @@
 # System Requirements
 
-- Install the latest Xcode in `/Applications`, open it and make sure to install additional components if it asks you.
+- Install the latest Xcode (11.4 or higher) in `/Applications`, open it and make sure to install additional components if it asks you.
 - Install [Carthage](https://github.com/Carthage/Carthage) if you haven't already. Using `brew` is recommended.
 
 # Building With Adobe DRM
@@ -21,6 +21,7 @@ git submodule update --init --recursive
 ```bash
 ./build-3rd-parties-dependencies.sh <Debug | Release>
 ```
+
 04. Open Simplified.xcodeproj and Build!
 
 
@@ -50,16 +51,20 @@ Both scripts must be run from the Simplified-iOS repo root.
 04. `git submodule deinit adobe-content-filter && git rm -rf adobe-content-filter`
 05. `git submodule update --init --recursive`
 06. Install [Carthage](https://github.com/Carthage/Carthage) if you haven't already.
-07. Remove "NYPL-Simplified/NYPLAEToolkit" and "AudioEngine.json" in `Cartfile` and `Cartfile.resolved`.
+07. Remove "NYPL-Simplified/NYPLAEToolkit" from `Cartfile` and `Cartfile.resolved`.
 08. `carthage bootstrap --platform ios --use-ssh`
 09. `cp APIKeys.swift.example Simplified/APIKeys.swift` and edit accordingly.
 10. `cp Accounts.json.example Simplified/Accounts.json`.
-11. `(cd readium-sdk; sh MakeHeaders.sh Apple)` (parentheses included) to generate the headers for Readium.
-12. `open Simplified.xcodeproj`
-13. Remove import of "Simplified+RMSDK.xcconfig" from "Simplified.xcconfig".
-14. Delete `NYPLAEToolkit.framework` and `AudioEngine.framework` from "Link Binary with Libraries", and remove input and output filepaths for `AudioEngine.framework` and `NYPLAEToolkit.framework` from `Copy Frameworks (Carthage)`.
-15. Note: For now, we recommend keeping any unstaged changes as a single git stash until better dynamic build support is added.
-16. Build.
+11. `cp GoogleService-Info.plist.example GoogleService-Info.plist` and edit with you firebase project config.
+12. `cp ReaderClientCert.sig.example Simplified/ReaderClientCert.sig` **Note:** This is skeleton only, contact project admins to obtain a copy of a real file. 
+13. `(cd readium-sdk; sh MakeHeaders.sh Apple)` (parentheses included) to generate the headers for Readium.
+14. `open Simplified.xcodeproj`
+15. Comment out/remove line with include of "Simplified+RMSDK.xcconfig" in "Simplified.xcconfig".
+16. Remove `FEATURE_DRM_CONNECTOR` entries in _Build Settings_ -> _Swift Compiler - Custom Flags_ -> _Active Compilation Conditions_ in project settings
+17. Delete `NYPLAEToolkit.framework`, `AudioEngine.framework`, `libADEPT.a` and `libAdobe Content Filter.a` from _General_ -> _Frameworks, Libraries, and Embedded Content_ section in project settings.
+18. Remove input and output filepaths for `AudioEngine.framework` and `NYPLAEToolkit.framework` from `Copy Frameworks (Carthage)` _Build Phase_ in project settings.
+19. Note: For now, we recommend keeping any unstaged changes as a single git stash until better dynamic build support is added.
+20. Build.
 
 # Contributing
 

ReaderClientCert.sig.example

@@ -0,0 +1 @@
+{"userid":"","appid":"","companyname":"","productname":"","productmodel":"ios","productversion":"1.0","name":"","email":"","tel":"","rmsdkversion":"","signeddata":""}