Merge pull request #3 from AnderGoig/develop

Develop

Author: AnderGoig

.assets/Getting-Started.png

@@ -0,0 +1 @@
+docs/**

.codebeatignore

@@ -1,4 +1,4 @@
-## Checklist
+## Checklist
 
 - [ ] I've the [latest update](https://github.com/AnderGoig/SwiftInstagram/releases) of Swiftinstagram.
 - [ ] I've searched for [existing GitHub issues](https://github.com/AnderGoig/SwiftInstagram/issues).

.github/ISSUE_TEMPLATE.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.0.4] - 2017-10-10
+### Added
+- 100% documented code.
+### Changed
+- Now, the redirection URI must be defined in the Info.plist file. See [wiki](https://github.com/AnderGoig/SwiftInstagram/wiki/Authentication).
+- The `createdTime` attribute of the classes `InstagramComment` and `InstagramMedia` has been renamed to `createdDate` and returns an object of type `Date`.
+- Improves [Codebeat](https://codebeat.co/projects/github-com-andergoig-swiftinstagram-master) GBA.
+### Fixed
+- Fixed the type of the returned errors.
+
 ## [1.0.3] - 2017-10-08
 ### Changed
 - Improved documentation.
@@ -34,7 +44,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Initial release.
 
-[Unreleased]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.3...develop
+[Unreleased]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.4...develop
+[1.0.4]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.3...v1.0.4
 [1.0.3]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.2...v1.0.3
 [1.0.2]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.0...v1.0.1

CHANGELOG.md

@@ -9,16 +9,19 @@
         <img src="https://img.shields.io/cocoapods/p/SwiftInstagram.svg"
              alt="Platforms">
     </a>
-    <a href="https://developer.apple.com/swift" target="_blank">
+    <a href="https://developer.apple.com/swift">
         <img src="https://img.shields.io/badge/Swift-4.0-orange.svg?style=flat"
              alt="Swift 4.0">
     </a>
     <a href="https://travis-ci.org/AnderGoig/SwiftInstagram/branches">
         <img src="https://img.shields.io/travis/AnderGoig/SwiftInstagram/master.svg"
              alt="Travis">
     </a>
-    <a href="https://andergoig.github.io/SwiftInstagram/Classes/Instagram.html" target="_blank">
-        <img src="https://img.shields.io/badge/Documentation-available-blue.svg"
+    <a href="https://codebeat.co/projects/github-com-andergoig-swiftinstagram-master">
+        <img src="https://codebeat.co/badges/e5274943-8feb-4e51-a937-43552205f62e" alt="Codebeat">
+    </a>
+    <a href="https://andergoig.github.io/SwiftInstagram/Classes/Instagram.html">
+        <img src="docs/badge.svg"
              alt="Documentation">
     </a>
     <a href="https://raw.githubusercontent.com/AnderGoig/SwiftInstagram/master/LICENSE">
@@ -46,12 +49,19 @@
 
 **SwiftInstagram** is a **wrapper** for the **Instagram API** written in **Swift**. It allows you to authenticate users and request data from Instagram effortlessly.
 
-- [Requirements](#requirements)
-- [Usage](#usage)
-- [Contributing](#contributing)
-- [Credits](#credits)
-- [License](#license)
-- [Author](#author)
+## Features
+
+- [x] Effortless and straightforward use of Instagram API.
+- [x] Up-to-date with the latest of [Instagram API](https://www.instagram.com/developer/).
+- [x] Client-Side authentication.
+- [x] Secure access token storing, thanks to [keychain-swift](https://github.com/evgenyneu/keychain-swift).
+- [x] Up-to-date with the latest Apple technologies (Swift 4, Xcode 9, etc).
+
+### Coming features - [SwiftInstagram 2.0.0](https://github.com/AnderGoig/SwiftInstagram/projects/1)
+
+- [ ] Multiple users login
+- [ ] [Instagram Business API](https://developers.facebook.com/docs/instagram-api/v2.10) support
+- [ ] And more ...
 
 ## Requirements
 

README.md

@@ -18,26 +18,26 @@ public class Instagram {
 
     public typealias EmptySuccessHandler = () -> Void
     public typealias SuccessHandler<T> = (_ data: T) -> Void
-    public typealias FailureHandler = (_ error: Error) -> Void
+    public typealias FailureHandler = (_ error: InstagramError) -> Void
 
     // MARK: - Properties
 
     private let urlSession = URLSession(configuration: .default)
     private let keychain = KeychainSwift()
     private let decoder = JSONDecoder()
 
-    private var clientId: String?
+    private var client: InstagramClient?
 
     // MARK: - Initializers
 
-    /// Shared instance of Instagram (singleton)
+    /// Returns a shared instance of Instagram.
     public static let shared = Instagram()
 
     private init() {
-        let bundlePath = Bundle.main.path(forResource: "Info", ofType: "plist")
-
-        if let path = bundlePath, let dict = NSDictionary(contentsOfFile: path) as? [String: AnyObject] {
-            self.clientId = dict["InstagramClientId"] as? String
+        if client == nil, let path = Bundle.main.path(forResource: "Info", ofType: "plist"), let dict = NSDictionary(contentsOfFile: path) as? [String: AnyObject] {
+            let clientId = dict["InstagramClientId"] as? String
+            let redirectURI = dict["InstagramRedirectURI"] as? String
+            client = InstagramClient(clientId: clientId, redirectURI: redirectURI)
         }
     }
 
@@ -49,13 +49,14 @@ public class Instagram {
     ///
     /// - Parameter navController: Your current `UINavigationController`.
     /// - Parameter scopes: The scope of the access you are requesting from the user. Basic access by default.
-    /// - Parameter redirectURI: Your Instagram API client redirection URI.
     /// - Parameter success: The callback called after a correct login.
     /// - Parameter failure: The callback called after an incorrect login.
 
-    public func login(navController: UINavigationController, scopes: [InstagramScope] = [.basic], redirectURI: String, success: EmptySuccessHandler? = nil, failure: FailureHandler? = nil) {
-        if let clientId = self.clientId {
-            let vc = InstagramLoginViewController(clientId: clientId, scopes: scopes, redirectURI: redirectURI, success: { accessToken in
+    public func login(navController: UINavigationController, scopes: [InstagramScope] = [.basic], success: EmptySuccessHandler? = nil, failure: FailureHandler? = nil) {
+        client?.scopes = scopes
+
+        if let client = client {
+            let vc = InstagramLoginViewController(client: client, success: { accessToken in
                 if !self.keychain.set(accessToken, forKey: "accessToken") {
                     failure?(InstagramError(kind: .keychainError(code: self.keychain.lastResultCode), message: "Error storing access token into keychain."))
                 } else {
@@ -66,7 +67,7 @@ public class Instagram {
 
             navController.show(vc, sender: nil)
         } else {
-            failure?(InstagramError(kind: .missingClientId, message: "Instagram Client ID not provided."))
+            failure?(InstagramError(kind: .missingClient, message: "Instagram Client not provided."))
         }
     }
 
@@ -75,7 +76,7 @@ public class Instagram {
     /// - Returns: True if a session is currently available, false otherwise.
 
     public func isSessionValid() -> Bool {
-        return self.keychain.get("accessToken") != nil
+        return keychain.get("accessToken") != nil
     }
 
     /// Ends the current session.
@@ -84,7 +85,7 @@ public class Instagram {
 
     @discardableResult
     public func logout() -> Bool {
-        return self.keychain.delete("accessToken")
+        return keychain.delete("accessToken")
     }
 
     // MARK: -
@@ -99,7 +100,7 @@ public class Instagram {
         var urlRequest = URLRequest(url: buildURL(for: endpoint, withParameters: parameters))
         urlRequest.httpMethod = method.rawValue
 
-        self.urlSession.dataTask(with: urlRequest) { (data, _, error) in
+        urlSession.dataTask(with: urlRequest) { (data, _, error) in
             if let data = data {
                 DispatchQueue.global(qos: .utility).async {
                     do {
@@ -128,7 +129,7 @@ public class Instagram {
 
         var items = [URLQueryItem]()
 
-        let accessToken = self.keychain.get("accessToken")
+        let accessToken = keychain.get("accessToken")
         items.append(URLQueryItem(name: "access_token", value: accessToken ?? ""))
 
         parameters?.forEach({ parameter in
@@ -453,8 +454,7 @@ public class Instagram {
     ///   to your own user.
 
     public func like(media mediaId: String, failure: FailureHandler? = nil) {
-        request("/media/\(mediaId)/likes", method: .post, success: { (_: InstagramResponse<Any?>) in return },
-                failure: failure)
+        request("/media/\(mediaId)/likes", method: .post, success: { (_: InstagramResponse<Any?>) in return }, failure: failure)
     }
 
     /// Remove a like on this media by the currently authenticated user.

Sources/Instagram.swift

@@ -0,0 +1,20 @@
+//
+//  InstagramClient.swift
+//  SwiftInstagram
+//
+//  Created by Ander Goig on 8/10/17.
+//  Copyright © 2017 Ander Goig. All rights reserved.
+//
+
+struct InstagramClient {
+
+    let clientId: String?
+    let redirectURI: String?
+    var scopes: [InstagramScope] = [.basic]
+
+    init(clientId: String?, redirectURI: String?) {
+        self.clientId = clientId
+        self.redirectURI = redirectURI
+    }
+
+}

Sources/Models/InstagramClient.swift

@@ -10,11 +10,22 @@
 
 public struct InstagramComment: Decodable {
 
+    /// The comment identifier.
     public let id: String
+
+    /// The comment text.
     public let text: String
-    public let createdTime: String
+
+    /// The user who created the comment.
     public let from: InstagramUser
 
+    /// The date and time when the comment was created.
+    public var createdDate: Date {
+        return Date(timeIntervalSince1970: Double(createdTime)!)
+    }
+
+    private let createdTime: String
+
     private enum CodingKeys: String, CodingKey {
         case id, text, from
         case createdTime = "created_time"

Sources/Models/InstagramComment.swift

@@ -6,33 +6,34 @@
 //  Copyright © 2017 Ander Goig. All rights reserved.
 //
 
-/// The struct containing an Instagram error.
+/// A type representing an error value that can be thrown.
 
 public struct InstagramError: Error {
 
-    public enum ErrorKind: CustomStringConvertible {
+    enum ErrorKind: CustomStringConvertible {
         case invalidRequest
         case jsonParseError
         case keychainError(code: OSStatus)
-        case missingClientId
+        case missingClient
 
-        public var description: String {
+        var description: String {
             switch self {
             case .invalidRequest:
                 return "invalidRequest"
             case .jsonParseError:
                 return "jsonParseError"
             case .keychainError(let code):
                 return "keychainError(code: \(code)"
-            case .missingClientId:
-                return "missingClientId"
+            case .missingClient:
+                return "missingClient"
             }
         }
     }
 
-    public let kind: ErrorKind
-    public let message: String
+    let kind: ErrorKind
+    let message: String
 
+    /// Retrieve the localized description for this error.
     public var localizedDescription: String {
         return "[\(kind.description)] - \(message)"
     }

Sources/Models/InstagramError.swift

@@ -12,18 +12,25 @@ import CoreLocation
 
 public struct InstagramLocation: Codable {
 
-    let latitude: Double
-    let longitude: Double
+    /// The location identifier.
     public let id: String
+
+    /// The location name.
     public let name: String
+
+    /// The location address.
     public let streetAddress: String?
 
+    /// The location coordinates (latitude and logitude).
     public var coordinates: CLLocationCoordinate2D {
-        return CLLocationCoordinate2D(latitude: self.latitude, longitude: self.longitude)
+        return CLLocationCoordinate2D(latitude: latitude, longitude: longitude)
     }
 
+    private let latitude: Double
+    private let longitude: Double
+
     private enum CodingKeys: String, CodingKey {
-        case latitude, longitude, id, name
+        case id, name, latitude, longitude
         case streetAddress = "street_address"
     }