Merge pull request #47 from readium/develop

1.0.5

Author: aferditamuriqi

opds/.travis.yml

@@ -1,5 +1,5 @@
 language: swift
-osx_image: xcode9.3
+osx_image: xcode10.1
 
 branches:
   only:

opds/Cartfile

@@ -1,3 +1,2 @@
-github "Readium/r2-shared-swift" "master"
-github "mxcl/PromiseKit" == 4.5.2
-github "cezheng/Fuzi" == 2.0.2
+github "readium/r2-shared-swift" "develop"
+github "cezheng/Fuzi" == 2.2.1

opds/Cartfile.resolved

@@ -1,4 +1,2 @@
-github "Hearst-DD/ObjectMapper" "2.2.0"
-github "Readium/r2-shared-swift" "07f5fe26381e0980925f7a16e8c05a1c7455ea45"
-github "cezheng/Fuzi" "2.0.2"
-github "mxcl/PromiseKit" "4.5.2"
+github "cezheng/Fuzi" "2.2.1"
+github "readium/r2-shared-swift" "c01177ff01bf52b6722b2842a53485b4a9781790"

opds/README.md

@@ -18,15 +18,61 @@ and [Readium Web Publication Manifest](https://github.com/readium/webpub-manifes
 
 ## Getting started
 
-### Adding the library to your iOS project
+## Adding the library to your iOS project
 
-#### Carthage
+> _Note:_ requires Swift 4.2 (and Xcode 10.1).
 
-Add the following line to your Cartfile
+### Carthage
 
-`github "readium/readium-opds-swift"`
+[Carthage][] is a simple, decentralized dependency manager for Cocoa. To
+install ReadiumOPDS with Carthage:
+
+ 1. Make sure Carthage is [installed][Carthage Installation].
+
+ 2. Update your Cartfile to include the following:
+
+    ```ruby
+    github "readium/r2-opds-swift" ~> 1.0.4
+    ```
+
+ 3. Run `carthage update` and
+    [add the appropriate framework][Carthage Usage].
+
+
+[Carthage]: https://github.com/Carthage/Carthage
+[Carthage Installation]: https://github.com/Carthage/Carthage#installing-carthage
+[Carthage Usage]: https://github.com/Carthage/Carthage#adding-frameworks-to-an-application
+
+
+### CocoaPods
+
+[CocoaPods][] is a dependency manager for Cocoa projects. To install
+ReadiumOPDS with CocoaPods:
+
+ 1. Make sure CocoaPods is [installed][CocoaPods Installation]. (ReadiumOPDS
+    requires version 1.0.0 or greater.)
+
+    ```sh
+    # Using the default Ruby install will require you to use sudo when
+    # installing and updating gems.
+    [sudo] gem install cocoapods
+    ```
+
+ 2. Update your Podfile to include the following:
+
+    ```ruby
+    use_frameworks!
+
+    target 'YourAppTargetName' do
+        pod 'ReadiumOPDS', :git => 'https://github.com/readium/r2-opds-swift.git', '~> 1.0.4'
+    end
+    ```
+
+ 3. Run `pod install --repo-update`.
+
+[CocoaPods]: https://cocoapods.org
+[CocoaPods Installation]: https://guides.cocoapods.org/using/getting-started.html#getting-started
 
-Then run `carthage update --platform ios` to fetch and build the dependencies.
 
 #### Import
 
@@ -38,17 +84,12 @@ In your Swift files:
 import ReadiumOPDS
 ```
 
-#### Installing dependencies (for developers)
-
-The project dependencies are managed with [Carthage](https://github.com/Carthage/Carthage). 
+#### Dependencies in this module
 
-Run `carthage update --platform ios` to fetch and build the dependencies:
-
-  - [r2-shared-swift](https://github.com/readium/r2-shared-swift) : Custom types shared by several readium-2 Swift modules.
-  - [PromiseKit](https://github.com/mxcl/PromiseKit) : Promises for Swift & ObjC.
+  - [R2Shared](https://github.com/readium/r2-shared-swift) : Custom types shared by several readium-2 Swift modules.
   - [Fuzi](https://github.com/cezheng/Fuzi) : A fast & lightweight XML & HTML parser in Swift with XPath & CSS support.
 
-Then, in Xcode:
+Modifications needed in Xcode:
 
 In `Build Settings`, find `Search Paths`, add `$(SDKROOT)/usr/include/libxml2` to `Header Search Paths`.
 
@@ -58,23 +99,19 @@ Parsing an OPDS feed (v1.x or 2.x):
 
 ```Swift
 import ReadiumOPDS
-import PromiseKit
 
 let myURL = URL(string: "https://your/custom/url")
 var parseData: ParseData?
 
 override func viewDidLoad() {
     super.viewDidLoad()
     
-    firstly {
-      // Fetch and parse data from the specified URL
-      OPDSParser.parseURL(url: myURL)
-    }.then { newParseData -> Void in
-      // parseData property holds the OPDS related data
-      self.parseData = newParseData
-    }.always {
-      // Here, you can perform some checks on your own and refresh your UI
-      self.refreshUI()
+    // Fetch and parse data from the specified URL
+    OPDSParser.parseURL(url: myURL) { data, error in
+        if let data = data {
+            // parseData property holds the OPDS related data
+            self.parseData = data
+        }
     }
 }
 
@@ -101,7 +138,7 @@ public enum Version {
 
 ```Swift
 /// An intermediate structure return when the generic helper method public static
-/// func parseURL(url: URL) -> Promise<ParseData> from OPDSParser class is called.
+/// func parseURL(url: URL, completion: (ParseData?, Error?) -> Void) from OPDSParser class is called.
 public struct ParseData {
     /// The ressource URL
     public var url: URL
@@ -126,6 +163,5 @@ public struct ParseData {
 /// Parse an OPDS feed or publication.
 /// Feed can be v1 (XML) or v2 (JSON).
 /// - parameter url: The feed URL
-/// - Returns: A promise with the intermediate structure of type ParseData
-public static func parseURL(url: URL) -> Promise<ParseData>
-```
+public static func parseURL(url: URL, completion: (ParseData?, Error?) -> Void)
+```

opds/ReadiumOPDS.podspec

@@ -0,0 +1,21 @@
+Pod::Spec.new do |s|
+
+  s.name         = "ReadiumOPDS"
+  s.version      = "1.0.4"
+  s.summary      = "Readium OPDS"
+  s.homepage     = "http://readium.github.io"
+  s.license      = "BSD 3-Clause License"
+  s.author       = { "Aferdita Muriqi" => "aferdita.muriqi@gmail.com" }
+  s.platform     = :ios
+  s.ios.deployment_target = "9.0"
+  s.source       = { :git => "https://github.com/readium/r2-opds-swift.git", :branch => "develop" }
+  s.source_files  = "readium-opds/**/*.{m,h,swift}"
+  s.exclude_files = ["**/Info*.plist","**/Carthage/*"]
+  s.xcconfig            = { 'FRAMEWORK_SEARCH_PATHS' => '"$(PODS_ROOT)/ReadiumOPDS/**"' ,
+  'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2'}
+  s.swift_version  = "4.2"
+
+  s.dependency 'R2Shared'
+  s.dependency 'Fuzi'
+
+end

opds/readium-opds.xcodeproj/project.pbxproj

@@ -7,45 +7,41 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
-		03B873F120F660D300D96791 /* Fuzi.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = AE0AC4A520AB1F8B00B2FC36 /* Fuzi.framework */; };
-		111E54D5201FB0AD00A7FE9A /* PromiseKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 111E54D4201FB0AC00A7FE9A /* PromiseKit.framework */; };
+		03C3CC64222DBD2F00A01731 /* R2Shared.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 03C3CC63222DBD2F00A01731 /* R2Shared.framework */; };
 		111E54DC2021022700A7FE9A /* OPDS2Parser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 111E54DB2021022700A7FE9A /* OPDS2Parser.swift */; };
 		AE49834720D902710013B912 /* ParseData.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE49834620D902710013B912 /* ParseData.swift */; };
 		AE6B98E020CAB93200117197 /* OPDSParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE6B98DF20CAB93200117197 /* OPDSParser.swift */; };
 		AED681F020A316160090DBCD /* URLHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = AED681EF20A316160090DBCD /* URLHelper.swift */; };
+		CA415ECB221D5307003A0F7F /* Deprecated.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA415EC9221D5182003A0F7F /* Deprecated.swift */; };
 		F34B7E5E1FA35B7900534FD3 /* readium_opds.h in Headers */ = {isa = PBXBuildFile; fileRef = F34B7E501FA35B7900534FD3 /* readium_opds.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		F34B7E691FA35BB100534FD3 /* OPDS1Parser.swift in Sources */ = {isa = PBXBuildFile; fileRef = F34B7E681FA35BB100534FD3 /* OPDS1Parser.swift */; };
-		F34B7E701FA3771E00534FD3 /* R2Shared.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = F34B7E6B1FA35CEA00534FD3 /* R2Shared.framework */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
+		03C3CC63222DBD2F00A01731 /* R2Shared.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; path = R2Shared.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		111E54CC201BBD9700A7FE9A /* wiki_1_1.opds */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; name = wiki_1_1.opds; path = "readium-opdsTests/Samples/wiki_1_1.opds"; sourceTree = SOURCE_ROOT; };
-		111E54D4201FB0AC00A7FE9A /* PromiseKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = PromiseKit.framework; path = Carthage/Build/iOS/PromiseKit.framework; sourceTree = "<group>"; };
 		111E54D9201FC91600A7FE9A /* feedbooks_catalog.atom */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; name = feedbooks_catalog.atom; path = "readium-opdsTests/Samples/feedbooks_catalog.atom"; sourceTree = SOURCE_ROOT; };
 		111E54DB2021022700A7FE9A /* OPDS2Parser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OPDS2Parser.swift; sourceTree = "<group>"; };
 		111E54DE2022812B00A7FE9A /* opds_2_0.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; name = opds_2_0.json; path = "readium-opdsTests/Samples/opds_2_0.json"; sourceTree = SOURCE_ROOT; };
 		111E54E02022816000A7FE9A /* readium_opds2_0_test.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = readium_opds2_0_test.swift; sourceTree = "<group>"; };
-		AE0AC4A520AB1F8B00B2FC36 /* Fuzi.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Fuzi.framework; path = Carthage/Build/iOS/Fuzi.framework; sourceTree = "<group>"; };
 		AE49834620D902710013B912 /* ParseData.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ParseData.swift; sourceTree = "<group>"; };
 		AE6B98DF20CAB93200117197 /* OPDSParser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OPDSParser.swift; sourceTree = "<group>"; };
 		AED681EF20A316160090DBCD /* URLHelper.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = URLHelper.swift; sourceTree = "<group>"; };
+		CA415EC9221D5182003A0F7F /* Deprecated.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Deprecated.swift; sourceTree = "<group>"; };
 		F34B7E4D1FA35B7900534FD3 /* ReadiumOPDS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = ReadiumOPDS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		F34B7E501FA35B7900534FD3 /* readium_opds.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = readium_opds.h; sourceTree = "<group>"; };
 		F34B7E511FA35B7900534FD3 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		F34B7E5B1FA35B7900534FD3 /* readium_opds1_1_test.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = readium_opds1_1_test.swift; sourceTree = "<group>"; };
 		F34B7E5D1FA35B7900534FD3 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		F34B7E681FA35BB100534FD3 /* OPDS1Parser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OPDS1Parser.swift; sourceTree = "<group>"; };
-		F34B7E6B1FA35CEA00534FD3 /* R2Shared.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = R2Shared.framework; path = Carthage/Build/iOS/R2Shared.framework; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
 		F34B7E491FA35B7900534FD3 /* Frameworks */ = {
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				03B873F120F660D300D96791 /* Fuzi.framework in Frameworks */,
-				111E54D5201FB0AD00A7FE9A /* PromiseKit.framework in Frameworks */,
-				F34B7E701FA3771E00534FD3 /* R2Shared.framework in Frameworks */,
+				03C3CC64222DBD2F00A01731 /* R2Shared.framework in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -85,6 +81,7 @@
 			children = (
 				F34B7E501FA35B7900534FD3 /* readium_opds.h */,
 				F34B7E511FA35B7900534FD3 /* Info.plist */,
+				CA415EC9221D5182003A0F7F /* Deprecated.swift */,
 				AE6B98DF20CAB93200117197 /* OPDSParser.swift */,
 				F34B7E681FA35BB100534FD3 /* OPDS1Parser.swift */,
 				111E54DB2021022700A7FE9A /* OPDS2Parser.swift */,
@@ -108,9 +105,7 @@
 		F34B7E6A1FA35CEA00534FD3 /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
-				AE0AC4A520AB1F8B00B2FC36 /* Fuzi.framework */,
-				111E54D4201FB0AC00A7FE9A /* PromiseKit.framework */,
-				F34B7E6B1FA35CEA00534FD3 /* R2Shared.framework */,
+				03C3CC63222DBD2F00A01731 /* R2Shared.framework */,
 			);
 			name = Frameworks;
 			sourceTree = "<group>";
@@ -159,7 +154,7 @@
 				TargetAttributes = {
 					F34B7E4C1FA35B7900534FD3 = {
 						CreatedOnToolsVersion = 9.0.1;
-						LastSwiftMigration = 0900;
+						LastSwiftMigration = 1010;
 						ProvisioningStyle = Manual;
 					};
 				};
@@ -196,6 +191,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				CA415ECB221D5307003A0F7F /* Deprecated.swift in Sources */,
 				AED681F020A316160090DBCD /* URLHelper.swift in Sources */,
 				F34B7E691FA35BB100534FD3 /* OPDS1Parser.swift in Sources */,
 				AE6B98E020CAB93200117197 /* OPDSParser.swift in Sources */,
@@ -343,13 +339,13 @@
 				INFOPLIST_FILE = "readium-opds/Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
-				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
+				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = "com.readium.readium-opds";
 				PRODUCT_NAME = ReadiumOPDS;
 				PROVISIONING_PROFILE_SPECIFIER = "";
 				SKIP_INSTALL = YES;
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
-				SWIFT_VERSION = 4.0;
+				SWIFT_VERSION = 4.2;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
@@ -373,12 +369,12 @@
 				INFOPLIST_FILE = "readium-opds/Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
-				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
+				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = "com.readium.readium-opds";
 				PRODUCT_NAME = ReadiumOPDS;
 				PROVISIONING_PROFILE_SPECIFIER = "";
 				SKIP_INSTALL = YES;
-				SWIFT_VERSION = 4.0;
+				SWIFT_VERSION = 4.2;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;

opds/readium-opds.xcodeproj/xcshareddata/xcschemes/readium-opds.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0940"
+   LastUpgradeVersion = "1010"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

opds/readium-opds/Deprecated.swift

@@ -0,0 +1,39 @@
+//
+//  Deprecated.swift
+//  readium-opds
+//
+//  Created by Mickaël Menu on 20.02.19.
+//
+//  Copyright 2018 Readium Foundation. All rights reserved.
+//  Use of this source code is governed by a BSD-style license which is detailed
+//  in the LICENSE file present in the project repository where this source code is maintained.
+//
+
+import Foundation
+import R2Shared
+
+public typealias Promise<T> = Void
+
+extension OPDSParser {
+    
+    @available(*, unavailable, message: "Use `parseURL(url:completion:)` instead")
+    public static func parseURL(url: URL) -> Promise<ParseData> {}
+
+}
+
+extension OPDS1Parser {
+    
+    @available(*, unavailable, message: "Use `parseURL(url:completion:)` instead")
+    public static func parseURL(url: URL) -> Promise<ParseData> {}
+    
+    @available(*, unavailable, message: "Use `fetchOpenSearchTemplate(feed:completion:)` instead")
+    public static func fetchOpenSearchTemplate(feed: Feed) -> Promise<String> {}
+    
+}
+
+extension OPDS2Parser {
+    
+    @available(*, unavailable, message: "Use `parseURL(url:completion:)` instead")
+    public static func parseURL(url: URL) -> Promise<ParseData> {}
+    
+}