Swiftpack.co - AlTavares/Nappa as Swift Package

Nappa

Adaptable HTTP client

• Requirements
• Installation
• Usage
• License

Requirements

• iOS 8.0+ / Mac OS X 10.10+ / tvOS 9.0+ / watchOS 2.0+
• Xcode 9.0+

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Nappa into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'Nappa', '~> 4.0.0'

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Nappa into your Xcode project using Carthage, specify it in your Cartfile:

github "AlTavares/Nappa" ~> 4.0.0

Swift Package Manager

To use Nappa as a Swift Package Manager package just add the following in your Package.swift file.

dependencies: [
    .package(url: "https://github.com/AlTavares/Nappa.git", from: "4.0.0")
]

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate Nappa into your project manually.

Git Submodules

• Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

$ git init

• Add Nappa as a git submodule by running the following command:

$ git submodule add https://github.com/AlTavares/Nappa.git
$ git submodule update --init --recursive

• Open the new Nappa folder, and drag the Nappa.xcodeproj into the Project Navigator of your application's Xcode project.

  It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

• Select the Nappa.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

• In the tab bar at the top of that window, open the "General" panel.

• Click on the + button under the "Embedded Binaries" section.

• You will see two different Nappa.xcodeproj folders each with two different versions of the Nappa.framework nested inside a Products folder.

  It does not matter which Products folder you choose from.

• Select the Nappa.framework.

• And that's it!

The Nappa.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Embeded Binaries

• Download the latest release from https://github.com/AlTavares/Nappa/releases
• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
• In the tab bar at the top of that window, open the "General" panel.
• Click on the + button under the "Embedded Binaries" section.
• Add the downloaded Nappa.framework.
• And that's it!

Usage

Basic usage

        let service = HTTPService()
        service.request(method: .get, url: "https://httpbin.org/get")
            .responseJSON { (jsonResponse) in
                switch jsonResponse.result {
                case .success(let response):
                    // do something with the result
                    print(response)
                case .failure(let error):
                    // do something in case of error
                    print(error)
                }
        }

You can make requests passing those parameters

        request(method: HTTPMethod, url: String, payload: Encodable, headers: Headers? = nil, parameterEncoding: ParameterEncoding? = nil)

        request(method: HTTPMethod, url: String, data: Data, headers: Headers? = nil, parameterEncoding: ParameterEncoding? = nil)

        request(method: HTTPMethod, url: String, headers: Headers? = nil)

The ParameterEncoding changes how your payload will be encoded, the options are:

.json -> JSON Encoding
.form -> Form Data Encoding
.url  -> URL Encoding, a query string is added to the URL
.none -> no data

If there's data present and there's no set ParameterEncoding, it will be automatically set based on the HTTPMethod

If not set on the Headers, the content type is automatically set using the current ParameterEncoding

License

Nappa is released under the MIT license. See LICENSE for details.