Merge pull request #10 from PSPDFKit/izacus/pspdfkit_android_300

Update React Native bindings for PSPDFKit Android 3.0.0

Author: izacus

README.md

@@ -111,64 +111,42 @@ PSPDFKit.present('document.pdf', {
 - Android SDK
 - Android Build Tools 23.0.1 (React Native)
 - Android Build Tools 25.0.2 (PSPDFKit module)
-- PSPDFKit >= 2.9.3
+- PSPDFKit >= 3.0.0
 - react-native >= 0.41.2
 
 #### Getting Started
 
-Let's create a simple app that integrates `pspdfkit-*.aar` and uses the react-native-pspdfkit module.
+Let's create a simple app that integrates PSPDFKit and uses the react-native-pspdfkit module.
 
 1. Make sure `react-native-cli` is installed: `yarn global add react-native-cli`
 2. Create the app with `react-native init YourApp`.
 3. Step into your newly created app folder: `cd YourApp`.
 4. Install `react-native-pspdfkit` from GitHub: `yarn add github:PSPDFKit/react-native`.
-5. Link module `react-native-pspdfkit`: `react-native link react-native-pspdfkit`. 
-6. Add dependencies to `YourApp/node_modules/react-native-pspdfkit/android/build.gradle`.
-   
-    A complete list of the dependencies needed can be found in the [documentation](https://pspdfkit.com/guides/android/current/getting-started/integrating-pspdfkit/#toc_manual-library-file-integration) step 6, under `Manual library file integration`.
-For PSPDFKit 2.9.3 :
-
-  ```                                     
-dependencies {
-    ...
-    //compile 'com.pspdfkit:pspdfkit:2.9.3@aar' <-- DO NOT ADD THE LIBRARY ITSELF
-    compile 'com.android.support:support-v4:25.1.+'
-    compile 'com.android.support:appcompat-v7:25.1.+'
-    compile "com.android.support:recyclerview-v7:25.1.+"
-    compile "com.android.support:cardview-v7:25.1.+"
-    compile "com.android.support:design:25.1.+"
-    compile 'io.reactivex:rxjava:1.2.6'
-    compile 'io.reactivex:rxandroid:1.2.1'
-    compile 'com.getkeepsafe.relinker:relinker:1.2.2'
-	}
+5. Link module `react-native-pspdfkit`: `react-native link react-native-pspdfkit`.
+6. Add PSPDFKit repository to `YourApp/android/build.gradle` so PSPDFKit library can be downloaded:
+
+  ```diff
+    allprojects {
+        repositories {
+            mavenLocal()
+            jcenter()
+  +         maven {
+  +             url 'https://customers.pspdfkit.com/maven/'
+
+  +             credentials {
+  +                 username 'pspdfkit'
+  +                 password 'YOUR_MAVEN_KEY_GOES_HERE'
+  +             }
+  +         }
+            maven {
+                // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+                url "$rootDir/../node_modules/react-native/android"
+            }
+        }
+    }
   ```
 
-7. Add the following lines to `YourApp/android/settings.gradle` file:
-
-  ```   
-include ':pspdfkit-lib'
-  ```
-        
-8. Create new `pspdfkit-lib` folder in `YourApp/android`.
-9. Create new `build.gradle` file in `YourApp/android/pspdfkit-lib` and add the following lines:
-     
-  ```  
-configurations.maybeCreate("default")
-def library =  fileTree(".").filter { it.isFile() }.filter { it.name.endsWith('.aar') }.files.name.first()
-artifacts.add("default", file(library))
-  ```
-        
-10. Copy `pspdfkit-*.aar` library in `YourApp/android/pspdfkit-lib`.
-11. Add the following dependencies to `YourApp/android/app/build.gradle` file:
-     
-   ```
-   dependencies {
-       ...
-       compile project(':pspdfkit-lib')
-   }
-   ```  
-        
-   And modify the following lines (note **three** places to edit):
+7. PSPDFKit targets modern platforms, so you'll have to update `compileSdkVersion` and `targetSdkVersion` to at least API 25 (note **three** places to edit):
 
    ```diff
    ...
@@ -192,15 +170,28 @@ artifacts.add("default", file(library))
    ...
    ```
      
-12. Set primary color. In `YourApp/android/app/src/main/res/values/styles.xml` replace
+8. Enter your PSPDFKit license key into `YourApp/android/app/src/main/AndroidManifest.xml` file: 
+
+  ```diff
+     <application>
+        ...
+
+  +      <meta-data
+  +          android:name="pspdfkit_license_key"
+  +          android:value="YOUR_LICENSE_KEY_GOES_HERE"/>
+
+     </application> 
+  ```
+
+9. Set primary color. In `YourApp/android/app/src/main/res/values/styles.xml` replace
   ```xml    
 <!-- Customize your theme here. -->
   ```
 with
   ```xml    
 <item name="colorPrimary">#3C97C9</item>
   ```     
-13. Replace the default component from `YourApp/index.android.js` with a simple touch area to present a PDF document from the local device filesystem:
+10. Replace the default component from `YourApp/index.android.js` with a simple touch area to present a PDF document from the local device filesystem:
 
    ```javascript
    import React, { Component } from 'react';
@@ -224,7 +215,6 @@ with
      pageScrollDirection : "vertical"
    };
 
-   PSPDFKit.setLicenseKey(LICENSE);
    // Change 'YourApp' to your app's name.
    class YourApp extends Component {
      _onPressButton() {
@@ -276,13 +266,13 @@ with
    // Change both 'YourApp's to your app's name.
    AppRegistry.registerComponent('YourApp', () => YourApp);
    ```  
-14. Before launching the app you need to copy a PDF document onto your development device or emulator.
+11. Before launching the app you need to copy a PDF document onto your development device or emulator.
 
 	```bash
 	adb push /path/to/your/document.pdf /sdcard/document.pdf
 	```
 
-15. Your app is now ready to launch.  From `YourApp` directory run `react-native run-android`.
+12. Your app is now ready to launch.  From `YourApp` directory run `react-native run-android`.
 
 	```bash
 	react-native run-android
@@ -291,28 +281,33 @@ with
 #### Running Catalog Project
 
 1. Clone the repository. `git clone https://github.com/PSPDFKit/react-native.git`.
-2. Add dependencies to `android/build.gradle` (not `samples/Catalog/android/build.gradle`).
-
-    A complete list of the dependencies needed can be found in the [documentation](https://pspdfkit.com/guides/android/current/getting-started/integrating-pspdfkit/#toc_manual-library-file-integration) step 6, under `Manual library file integration`.
-For PSPDFKit 2.9.3 :
-
-  ```                                     
-dependencies {
-    ...
-    //compile 'com.pspdfkit:pspdfkit:2.9.3@aar' <-- DO NOT ADD THE LIBRARY ITSELF
-    compile 'com.android.support:support-v4:25.1.+'
-    compile 'com.android.support:appcompat-v7:25.1.+'
-    compile "com.android.support:recyclerview-v7:25.1.+"
-    compile "com.android.support:cardview-v7:25.1.+"
-    compile "com.android.support:design:25.1.+"
-    compile 'io.reactivex:rxjava:1.2.6'
-    compile 'io.reactivex:rxandroid:1.2.1'
-    compile 'com.getkeepsafe.relinker:relinker:1.2.2'
-	}
+2. Install dependencies: run `yarn install` from `samples/Catalog` directory. (Because of a [bug](https://github.com/yarnpkg/yarn/issues/2165) you may need to clean `yarn`'s cache with `yarn cache clean` before.)
+3. Add your customer portal password to `samples/Catalog/build.gradle`:
+
+  ```groovy
+        maven {
+            url 'https://customers.pspdfkit.com/maven/'
+
+            credentials {
+                username 'pspdfkit'
+                password 'YOUR_MAVEN_PASSWORD_GOES_HERE'
+            }
+        }
+  ```
+    
+4. Update license key in `samples/Catalog/android/app/src/main/AndroidManifest.xml`:
+
+  ```xml
+     <application>
+        ...
+
+        <meta-data
+            android:name="pspdfkit_license_key"
+            android:value="YOUR_LICENSE_KEY_GOES_HERE"/>
+
+     </application> 
   ```
 
-3. Copy `pspdfkit-*.aar` library in `samples/Catalog/android/pspdfkit-lib`.
-4. Install dependencies: run `yarn install` from `samples/Catalog` directory. (Because of a [bug](https://github.com/yarnpkg/yarn/issues/2165) you may need to clean `yarn`'s cache with `yarn cache clean` before.)
 5. Catalog app is now ready to launch. From `samples/Catalog` directory run `react-native run-android`.
 
 #### Configuration

android/build.gradle

@@ -4,7 +4,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:2.2.3'
+        classpath 'com.android.tools.build:gradle:2.3.0'
     }
 }
 
@@ -26,6 +26,6 @@ android {
 }
 
 dependencies {
+    compile 'com.pspdfkit:pspdfkit:3.0.0'
     compile 'com.facebook.react:react-native:+'
-    compile project(':pspdfkit-lib')
 }

android/src/main/java/com/pspdfkit/react/ConfigurationAdapter.java

@@ -18,8 +18,8 @@
 
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.ReadableMapKeySetIterator;
-import com.pspdfkit.configuration.activity.HUDViewMode;
-import com.pspdfkit.configuration.activity.PSPDFActivityConfiguration;
+import com.pspdfkit.configuration.activity.HudViewMode;
+import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
 import com.pspdfkit.configuration.annotations.AnnotationEditingConfiguration;
 import com.pspdfkit.configuration.page.PageFitMode;
 import com.pspdfkit.configuration.page.PageScrollDirection;
@@ -32,7 +32,7 @@ public class ConfigurationAdapter {
     private static final String PAGE_SCROLL_CONTINUOUS = "scrollContinuously";
     private static final String FIT_PAGE_TO_WIDTH = "fitPageToWidth";
     private static final String IMMERSIVE_MODE = "immersiveMode";
-    private static final String SYSTEM_HUD_MODE = "hudViewMode";
+    private static final String SYSTEM_HUD_MODE = "HudViewMode";
     private static final String HUD_VIEW_MODE_AUTOMATIC = "automatic";
     private static final String HUD_VIEW_MODE_AUTOMATIC_BORDER_PAGES = "automaticBorderPages";
     private static final String HUD_VIEW_MODE_ALWAYS_VISIBLE = "alwaysVisible";
@@ -53,19 +53,19 @@ public class ConfigurationAdapter {
     private static final String SHOW_SHARE_ACTION = "showShareAction";
     private static final String SHOW_PRINT_ACTION = "showPrintAction";
 
-    private final PSPDFActivityConfiguration.Builder configuration;
+    private final PdfActivityConfiguration.Builder configuration;
     private final Activity activity;
 
 
-    public ConfigurationAdapter(@NonNull Activity activity, @NonNull String licenseKey, ReadableMap configuration) {
+    public ConfigurationAdapter(@NonNull Activity activity, ReadableMap configuration) {
 
         this.activity = activity;
         ReadableMapKeySetIterator iterator = configuration.keySetIterator();
         boolean emptyConfiguration = iterator.hasNextKey() ? false : true;
         if (emptyConfiguration) {
-            this.configuration = getDefaultConfiguration(activity, licenseKey);
+            this.configuration = getDefaultConfiguration(activity);
         } else {
-            this.configuration = new PSPDFActivityConfiguration.Builder(activity, licenseKey);
+            this.configuration = new PdfActivityConfiguration.Builder(activity);
 
             if (configuration.hasKey(PAGE_SCROLL_DIRECTION)) {
                 configurePageScrollDirection(configuration.getString(PAGE_SCROLL_DIRECTION));
@@ -157,7 +157,7 @@ private void configureFitPageToWidth(boolean fitPageToWidth) {
     }
 
     private void configureInlineSearch(boolean inlineSearch) {
-        final int searchType = inlineSearch ? PSPDFActivityConfiguration.SEARCH_INLINE : PSPDFActivityConfiguration.SEARCH_MODULAR;
+        final int searchType = inlineSearch ? PdfActivityConfiguration.SEARCH_INLINE : PdfActivityConfiguration.SEARCH_MODULAR;
         configuration.setSearchType(searchType);
     }
 
@@ -166,15 +166,15 @@ private void configureStartPage(int startPage) {
     }
 
     private void configureSystemHudMode(String systemHudMode) {
-        HUDViewMode hudMode = HUDViewMode.HUD_VIEW_MODE_AUTOMATIC;
+        HudViewMode hudMode = HudViewMode.HUD_VIEW_MODE_AUTOMATIC;
         if (systemHudMode.equals(HUD_VIEW_MODE_AUTOMATIC)) {
-            hudMode = HUDViewMode.HUD_VIEW_MODE_AUTOMATIC;
+            hudMode = HudViewMode.HUD_VIEW_MODE_AUTOMATIC;
         } else if (systemHudMode.equals(HUD_VIEW_MODE_AUTOMATIC_BORDER_PAGES)) {
-            hudMode = HUDViewMode.HUD_VIEW_MODE_AUTOMATIC_BORDER_PAGES;
+            hudMode = HudViewMode.HUD_VIEW_MODE_AUTOMATIC_BORDER_PAGES;
         } else if (systemHudMode.equals(HUD_VIEW_MODE_ALWAYS_VISIBLE)) {
-            hudMode = HUDViewMode.HUD_VIEW_MODE_VISIBLE;
+            hudMode = HudViewMode.HUD_VIEW_MODE_VISIBLE;
         } else if (systemHudMode.equals(HUD_VIEW_MODE_ALWAYS_HIDDEN)) {
-            hudMode = HUDViewMode.HUD_VIEW_MODE_HIDDEN;
+            hudMode = HudViewMode.HUD_VIEW_MODE_HIDDEN;
         }
         configuration.setHudViewMode(hudMode);
     }
@@ -269,20 +269,20 @@ private void configureEnableTextSelection(boolean enableTextSelection) {
         configuration.textSelectionEnabled(enableTextSelection);
     }
 
-    public PSPDFActivityConfiguration build() {
+    public PdfActivityConfiguration build() {
         return configuration.build();
     }
 
-    public static PSPDFActivityConfiguration.Builder getDefaultConfiguration(Context context, String license) {
+    public static PdfActivityConfiguration.Builder getDefaultConfiguration(Context context) {
 
         final PageScrollDirection pageScrollDirection = PageScrollDirection.HORIZONTAL;
         final PageScrollMode pageScrollMode = PageScrollMode.PER_PAGE;
         final PageFitMode pageFitMode = PageFitMode.FIT_TO_WIDTH;
-        final int searchType = PSPDFActivityConfiguration.SEARCH_INLINE;
-        final HUDViewMode hudViewMode = HUDViewMode.HUD_VIEW_MODE_AUTOMATIC;
+        final int searchType = PdfActivityConfiguration.SEARCH_INLINE;
+        final HudViewMode hudViewMode = HudViewMode.HUD_VIEW_MODE_AUTOMATIC;
         int startPage = 0;
 
-        PSPDFActivityConfiguration.Builder configuration = new PSPDFActivityConfiguration.Builder(context, license)
+        PdfActivityConfiguration.Builder configuration = new PdfActivityConfiguration.Builder(context)
                 .scrollDirection(pageScrollDirection)
                 .scrollMode(pageScrollMode)
                 .fitMode(pageFitMode)

android/src/main/java/com/pspdfkit/react/PSPDFKitModule.java

@@ -20,7 +20,7 @@
 import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.ReadableMap;
 import com.pspdfkit.PSPDFKit;
-import com.pspdfkit.ui.PSPDFActivity;
+import com.pspdfkit.ui.PdfActivity;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -40,20 +40,16 @@ public String getName() {
         return "PSPDFKit";
     }
 
-    @ReactMethod
-    public void setLicenseKey(@NonNull String licenseKey) {
-        this.licenseKey = licenseKey;
-    }
-
     @ReactMethod
     public void present(@NonNull String document, @NonNull ReadableMap configuration) {
         if (getCurrentActivity() != null) {
-            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getCurrentActivity(), licenseKey, configuration);
+            ConfigurationAdapter configurationAdapter = new ConfigurationAdapter(getCurrentActivity(), configuration);
             // This is an edge case where file scheme is missing.
             if (Uri.parse(document).getScheme() == null) {
                 document = FILE_SCHEME + document;
             }
-            PSPDFActivity.showDocument(getCurrentActivity(), Uri.parse(document), configurationAdapter.build());
+
+            PdfActivity.showDocument(getCurrentActivity(), Uri.parse(document), configurationAdapter.build());
         }
     }
 

samples/Catalog/android/app/src/main/AndroidManifest.xml

@@ -26,6 +26,10 @@
             </intent-filter>
         </activity>
         <activity android:name="com.facebook.react.devsupport.DevSettingsActivity" />
+
+        <meta-data
+            android:name="pspdfkit_license_key"
+            android:value="YOUR_LICENSE_KEY_GOES_HERE"/>
     </application>
 
 </manifest>

samples/Catalog/android/build.gradle

@@ -5,7 +5,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:2.2.3'
+        classpath 'com.android.tools.build:gradle:2.3.0'
 
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
@@ -16,6 +16,14 @@ allprojects {
     repositories {
         mavenLocal()
         jcenter()
+        maven {
+            url 'https://customers.pspdfkit.com/maven/'
+
+            credentials {
+                username 'pspdfkit'
+                password 'YOUR_MAVEN_KEY_GOES_HERE'
+            }
+        }
         maven {
             // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
             url "$rootDir/../node_modules/react-native/android"