Merge pull request #13 from AnderGoig/develop

Version 1.0.6

Author: AnderGoig

.jazzy.yaml

@@ -1,16 +1,36 @@
 # Run jazzy from the current directory to generate documentation
 
 module: SwiftInstagram
-module_version: 1.0.5
+module_version: 1.0.6
 author: Ander Goig
+author_url: https://github.com/AnderGoig
 github_url: https://github.com/AnderGoig/SwiftInstagram
 exclude:
-    - "Sources/Helpers/KeychainSwiftDistrib.swift"
-
-swift_version: 4.0
+    - "**/KeychainSwiftDistrib.swift"
 
 clean: true
 skip_undocumented: true
 
 theme: fullwidth
-output: docs
+
+custom_categories:
+    - name: API
+      children:
+      - Instagram
+
+    - name: Authentication
+      children:
+      - InstagramScope
+
+    - name: Models
+      children:
+      - InstagramUser
+      - InstagramRelationship
+      - InstagramMedia
+      - InstagramComment
+      - InstagramTag
+      - InstagramLocation
+
+    - name: Errors
+      children:
+      - InstagramError

.swiftlint.yml

@@ -1,5 +1,4 @@
 disabled_rules:
-  - line_length
   - file_length
   - nesting
 opt_in_rules:
@@ -34,6 +33,8 @@ excluded:
   - Carthage
   - Sources/Helpers/KeychainSwiftDistrib.swift
 
+line_length: 160
+
 file_header:
   required_pattern: |
                     \/\/

.travis.yml

@@ -1,71 +1,70 @@
 language: objective-c
 osx_image: xcode9
-
 git:
   submodules: false
-
 env:
   global:
-    - LC_CTYPE=en_US.UTF-8
-    - LANG=en_US.UTF-8
-    - WORKSPACE=SwiftInstagram.xcworkspace
-    - IOS_FRAMEWORK_SCHEME="SwiftInstagram-iOS"
-    - IOS_SDK=iphonesimulator11.0
+  - LC_CTYPE=en_US.UTF-8
+  - LANG=en_US.UTF-8
+  - WORKSPACE=SwiftInstagram.xcworkspace
+  - SCHEME="SwiftInstagram-iOS"
+  - SDK=iphonesimulator11.0
   matrix:
-    - DESTINATION="OS=11.0,name=iPhone 7 Plus"  SCHEME="$IOS_FRAMEWORK_SCHEME"      SDK="$IOS_SDK"      RUN_TESTS="YES"     RELEASE_READY="NO"      POD_LINT="NO"
-    - DESTINATION="OS=10.3.1,name=iPhone 7"     SCHEME="$IOS_FRAMEWORK_SCHEME"      SDK="$IOS_SDK"      RUN_TESTS="YES"     RELEASE_READY="NO"      POD_LINT="NO"
-    - DESTINATION="OS=9.0,name=iPhone 6s"       SCHEME="$IOS_FRAMEWORK_SCHEME"      SDK="$IOS_SDK"      RUN_TESTS="YES"     RELEASE_READY="NO"      POD_LINT="NO"
-
+  - TEST_TYPE=iOS
+  - TEST_TYPE=Lint
+  - TEST_TYPE=Carthage
+  - TEST_TYPE=CocoaPods
 before_install:
-  - gem install cocoapods --pre --no-rdoc --no-ri --no-document --quiet
-  - brew update
-  - brew outdated carthage || brew upgrade carthage
-
+- |
+  if [ "$TEST_TYPE" = CocoaPods ]; then
+    gem install cocoapods --pre --no-rdoc --no-ri --no-document --quiet
+  fi
+  if [ "$TEST_TYPE" = Lint ] || [ "$TEST_TYPE" = Carthage ]; then
+    brew update
+  fi
+  if [ "$TEST_TYPE" = Carthage ]; then
+    brew outdated carthage || brew upgrade carthage
+  fi
+install:
+- |
+  gem update --system --no-document
+  bundle install
+  if [ "$TEST_TYPE" = Lint ]; then
+    brew install swiftlint || brew upgrade swiftlint
+  elif [ "$TEST_TYPE" = CocoaPods ]; then
+    pod repo update --silent
+  fi
 before_script:
-  - sh scripts/bootstrap
-
+- |
+  if [ "$TEST_TYPE" = Carthage ]; then
+    carthage update --no-use-binaries --use-submodules
+  fi
 script:
-  - set -o pipefail
-  - xcodebuild -version
-  - xcodebuild -showsdks
-
-  # Build Framework in Debug and Run Tests if specified
-  - if [ $RUN_TESTS == "YES" ]; then
-      xcodebuild -workspace "$WORKSPACE" -scheme "$SCHEME" -sdk "$SDK" -destination "$DESTINATION" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO -configuration Debug ONLY_ACTIVE_ARCH=NO ENABLE_TESTABILITY=YES test | xcpretty -c;
-    else
-      xcodebuild -workspace "$WORKSPACE" -scheme "$SCHEME" -sdk "$SDK" -destination "$DESTINATION" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO -configuration Debug ONLY_ACTIVE_ARCH=NO build | xcpretty -c;
-    fi
-
-  # Build Framework in Release and Run Tests if specified
-  - if [ $RUN_TESTS == "YES" ]; then
-      xcodebuild -workspace "$WORKSPACE" -scheme "$SCHEME" -sdk "$SDK" -destination "$DESTINATION" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO -configuration Release ONLY_ACTIVE_ARCH=NO ENABLE_TESTABILITY=YES test | xcpretty -c;
-    else
-      xcodebuild -workspace "$WORKSPACE" -scheme "$SCHEME" -sdk "$SDK" -destination "$DESTINATION" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO -configuration Release ONLY_ACTIVE_ARCH=NO build | xcpretty -c;
-    fi
-
-  # Run `pod lib lint` if specified
-  - if [ $POD_LINT == "YES" ]; then
-      pod lib lint;
-    fi
-
+- |
+  if [ "$TEST_TYPE" = iOS ]; then
+    set -o pipefail
+    xcodebuild -version
+    xcodebuild -showsdks
+    xcodebuild build -workspace "$WORKSPACE" -scheme "$SCHEME" -sdk "$SDK" -configuration Debug -destination "platform=iOS Simulator,name=iPhone 5" -destination "platform=iOS Simulator,name=iPhone 7 Plus" | xcpretty -c
+  elif [ "$TEST_TYPE" = Lint ]; then
+    swiftlint lint
+  elif [ "$TEST_TYPE" = CocoaPods ]; then
+    pod lib lint
+  fi
 before_deploy:
-  - carthage build --no-skip-current
-  - carthage archive SwiftInstagram
-
+- carthage build --no-skip-current
+- carthage archive SwiftInstagram
 deploy:
-  - provider: releases
-    api_key:
-      secure:
-    file:
-      - SwiftInstagram.framework.zip
-    skip_cleanup: true
-    overwrite: true
-    on:
-      repo: AnderGoig/SwiftInstagram
-      tags: true
-      condition: $RELEASE_READY = YES
-  - provider: script
-    script: pod trunk push
-    on:
-      tags: true
-      condition: $RELEASE_READY = YES
+- provider: releases
+  api_key:
+    secure: jYpv6cXD6AIuTONSVvjQHGUeYDs/J/mID0pIMaFLIh3cBo3EPeM29zmYKVeBjePr9BlUUmMJqcif8oddADYyeXQkDjWr2pBLARQmryMMi1dVNMvuBq4Tb/PV7BEwkDigIb9Qcpcm4HFdYigMRFp20bntBlnGb/tjwdq3XEe5766QuM7H22g41V8S9e7Na8K5gpRmew25mMASDkwSvZHuMA5+P6Q4nam5R0kA53uBIySWYW340EZ3B23oQdtdob2vk35Eu3bR+FFAsE1idw+sddua7eFGi5DVgTlXcwb3f7hG0JKKA9IUXcCSyd5AgLYGv5h+nFBmlRIeA84sQI9xcK+f0kBnHpakm/Xp8+a9NYodxfpyr8k/ZlVal16B6/p+BC6x3TAp6SgDeymuFMNxc6/Eyz/IGrCiJ+4tMmy+385jf8/+Gv6dVGg5fos329QWUzOxcKvCk/w9d5Nz5GCQlMvgH4N/YvTmSnPaRUIBeaN7VV+Kkr4ovUb9SeOlrrG+36GU60aBriv6ZqQ6BhndEraIXKsCItfSHqxcJspliAWzTqPOpg8SqBTBIWAcrVOtcpmo9TI5ndiS8R8EwuOcAJtrl7yaNJ70iUv2IewSdNbl1ZZV9CMnu83vAEwELszssmbJ1SbTLi4GfoECEw4CHpOKyk6Fh4WXBFcSLGgvce8=
+  file: SwiftInstagram.framework.zip
+  skip_cleanup: true
+  overwrite: true
+  on:
+    repo: AnderGoig/SwiftInstagram
+    tags: true
+- provider: script
+  script: pod trunk push
+  on:
+    tags: true

CHANGELOG.md

@@ -1,18 +1,27 @@
 # Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
-## [1.0.5] - 2017-10-18
+## [1.0.6] (2017-11-03)
+[Full Changelog](https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.5...v1.0.6)
+### Added
+- JSON parser improvements.
+- General source code improvements.
+### Changed
+- `searchLocation()` method attributes `lat` and `lng` have been replaced by `coordinates`.
+- `isSessionValid()` method has been renamed to `isAuthenticated` (property).
+- Change key for keychain (#11).
+- Better handling of #7 bug.
+
+## [1.0.5] (2017-10-18)
+[Full Changelog](https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.4...v1.0.5)
 ### Changed
 - The `Success` and `Failure` handlers, for all the API endpoints, are no longer nullable.
 ### Fixed
 - Fixed the bug parsing `InstagramMedia` objects with a `location` property (#7).
 
-## [1.0.4] - 2017-10-10
+## [1.0.4] (2017-10-10)
+[Full Changelog](https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.3...v1.0.4)
 ### Added
 - 100% documented code.
 ### Changed
@@ -22,12 +31,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixed
 - Fixed the type of the returned errors.
 
-## [1.0.3] - 2017-10-08
+## [1.0.3] (2017-10-08)
+[Full Changelog](https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.2...v1.0.3)
 ### Changed
 - Improved documentation.
 - `InstagramAuthScope` renamed to `InstagramScope`.
 
-## [1.0.2] - 2017-10-07
+## [1.0.2] (2017-10-07)
+[Full Changelog](https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.1...v1.0.2)
 ### Added
 - `InstagramLoginViewController` hides automatically when concludes.
 - `@discardableResult` to `logout()` method.
@@ -37,7 +48,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Authorization process errors are now correctly captured.
 - Travis CI build error.
 
-## [1.0.1] - 2017-10-03
+## [1.0.1] (2017-10-03)
+[Full Changelog](https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.0...v1.0.1)
 ### Added
 - Use of `DispatchQueue` for parsing JSON and calling callback functions.
 ### Changed
@@ -46,13 +58,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixed
 - Login page `WKWebView` now fits correctly when rotating device.
 
-## 1.0.0 - 2017-09-30
+## [1.0.0] (2017-09-30)
 ### Added
 - Initial release.
 
-[Unreleased]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.5...develop
-[1.0.5]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.4...v1.0.5
-[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
+[Unreleased]: https://github.com/AnderGoig/SwiftInstagram/compare/v1.0.6...develop
+[1.0.6]: https://github.com/AnderGoig/SwiftInstagram/tree/v1.0.6
+[1.0.5]: https://github.com/AnderGoig/SwiftInstagram/tree/v1.0.5
+[1.0.4]: https://github.com/AnderGoig/SwiftInstagram/tree/v1.0.4
+[1.0.3]: https://github.com/AnderGoig/SwiftInstagram/tree/v1.0.3
+[1.0.2]: https://github.com/AnderGoig/SwiftInstagram/tree/v1.0.2
+[1.0.1]: https://github.com/AnderGoig/SwiftInstagram/tree/v1.0.1
+[1.0.0]: https://github.com/AnderGoig/SwiftInstagram/tree/v1.0.0

README.md

@@ -1,6 +1,6 @@
 <p align="center">
     <a href="https://andergoig.github.io/SwiftInstagram">
-        <img src="https://rawgit.com/AnderGoig/SwiftInstagram/develop/.assets/SwiftInstagram-Logo.png" alt="SwiftInstagram Logo" width="700" height="200">
+        <img src="https://rawgit.com/AnderGoig/SwiftInstagram/master/.assets/SwiftInstagram-Logo.png" alt="SwiftInstagram Logo" width="700" height="200">
     </a>
 </p>
 
@@ -21,8 +21,8 @@
         <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"
+    <a href="https://andergoig.github.io/SwiftInstagram">
+        <img src="https://rawgit.com/AnderGoig/SwiftInstagram/master/docs/badge.svg"
              alt="Documentation">
     </a>
     <a href="https://raw.githubusercontent.com/AnderGoig/SwiftInstagram/master/LICENSE">
@@ -52,10 +52,11 @@
 
 ## 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] Effortless and straightforward use.
+- [x] Up-to-date with the latest [Instagram API](https://www.instagram.com/developer/) features.
 - [x] Secure access token storing, thanks to [keychain-swift](https://github.com/evgenyneu/keychain-swift).
+- [x] Client-Side authentication.
+- [x] 100% documented code.
 - [x] Up-to-date with the latest Apple technologies (Swift 4, Xcode 9, etc).
 
 ### [Upcoming features](https://github.com/AnderGoig/SwiftInstagram/projects/1)

Sources/Endpoints/Comments.swift

@@ -0,0 +1,59 @@
+//
+//  Comments.swift
+//  SwiftInstagram
+//
+//  Created by Ander Goig on 29/10/17.
+//  Copyright © 2017 Ander Goig. All rights reserved.
+//
+
+extension Instagram {
+
+    /// Get a list of recent comments on a media object.
+    ///
+    /// - parameter Parameter mediaId: The ID of the media object to reference.
+    /// - parameter success: The callback called after a correct retrieval.
+    /// - parameter failure: The callback called after an incorrect retrieval.
+    ///
+    /// - important: It requires *public_content* scope for media that does not belong to your own user.
+
+    public func comments(fromMedia mediaId: String, success: SuccessHandler<[InstagramComment]>?, failure: FailureHandler?) {
+        request("/media/\(mediaId)/comments", success: success, failure: failure)
+    }
+
+    /// Create a comment on a media object.
+    ///
+    /// - parameter mediaId: The ID of the media object to reference.
+    /// - parameter text: Text to post as a comment on the media object as specified in `mediaId`.
+    /// - parameter failure: The callback called after an incorrect creation.
+    ///
+    /// - important: It requires *comments* scope. Also, *public_content* scope is required for media that does not
+    ///   belong to your own user.
+    ///
+    /// - note:
+    ///     - The total length of the comment cannot exceed 300 characters.
+    ///     - The comment cannot contain more than 4 hashtags.
+    ///     - The comment cannot contain more than 1 URL.
+    ///     - The comment cannot consist of all capital letters.
+
+    public func createComment(onMedia mediaId: String, text: String, failure: FailureHandler?) {
+        var parameters = Parameters()
+
+        parameters["text"] = text
+
+        request("/media/\(mediaId)/comments", method: .post, parameters: parameters, success: { (_: InstagramResponse<Any?>) in return }, failure: failure)
+    }
+
+    /// Remove a comment either on the authenticated user's media object or authored by the authenticated user.
+    ///
+    /// - parameter commentId: The ID of the comment to delete.
+    /// - parameter mediaId: The ID of the media object to reference.
+    /// - parameter failure: The callback called after an incorrect deletion.
+    ///
+    /// - important: It requires *comments* scope. Also, *public_content* scope is required for media that does not
+    ///   belong to your own user.
+
+    public func deleteComment(_ commentId: String, onMedia mediaId: String, failure: FailureHandler?) {
+        request("/media/\(mediaId)/comments/\(commentId)", method: .delete, success: { (_: InstagramResponse<Any?>) in return }, failure: failure)
+    }
+
+}