NGeen

NGeen is a great library for agile development built in swift. It's built based on factory design pattern, extending the powerful high-level networking and database abstractions built into Cocoa.

Choose NGeen for your next project, or migrate over your existing projects—you'll be happy you did!

How To Get Started

• Download NGeen and try out.

Communication

• If you found a bug, open an issue.
• If you have a feature request, open an issue.
• If you want to contribute, submit a pull request.

Features

• Capacity to use the same code to read api and database
• Configure only one time your app
• Caching regardless if the server return the cache content
• Capacity to define multiples servers
• URL / JSON Parameter Encoding
• Authentication with NSURLCredential

Architecture

Base

• Constants
  • Constants
• DataTypes
  • DataTypes
• Protocols
  • Protocols

Cache

• DiskCache
  • DiskCache
• Entity
  • Entity
• Cache

Model

• Model

Network

• Security
  • SecurityPolicy
• Serializer
  • Request
    • RequestSerializer
  • Response
    • ResponseSerializer
• Session
  • Task
    • Delegate
      • SessionTaskDelegate
  • SessionManager

Query

• Api
  • ApiQuery
• DataBase
  • DataBaseQuery

Store

• Api
  • Config
    • ApiStoreConfiguration
  • Endpoint
    • ApiEndpoint
  • ApiStore
• DataBase
  • DataBaseStore

Usage

Configuration

Configure only one time your app and thats it :) .

Basic configuration

let apiStoreConfiguration = ApiStoreConfiguration(headers: headers, host: "example.com", httpProtocol: "https")
ApiStore.defaultStore().setConfiguration(apiStoreConfiguration)

Setting basic authentication

 ApiStore.defaultStore().setAuthenticationCredentials("foo", password: "bar")

Supported Authentication Schemes

• HTTP Basic
• HTTP Digest
• Kerberos
• NTLM

Setting cache policy

The library allows to the user the hability of use the ngeen cache class to store the response from the requests based on sqlite and files, regardless if the server returns the cache content in the headers, to allow this capacity you have to implement the ApiQueryDelegate and add the following code to the configuration.

ApiStore.defaultStore().setOptions(NGeenOptions.useNGeenCacheReturnCacheDataContinueLoading)

Setting the endpoints

let taskEndpoint = ApiEndpoint(contentType: ContentType.urlEnconded, httpMethod: HttpMethod.post, path: "/1/classes/Task")
let exampleEndpoint = ApiEndpoint(contentType: ContentType.urlEnconded, httpMethod: HttpMethod.post, path: "/1/classes/Example")
ApiStore.defaultStore().setEndpoints([taskEndpoint, exampleEndpoint])

Setting models serialization from server response

apiQuery.responseSerializer = ModelsResponseSerializer(modelClass: Test.self, path: "models")

Setting response type

apiQuery.responseSerializer = JSONResponseSerializer(JSONReadingOptions: NSJSONReadingOptions.AllowFragments)

Supported responses:

• JSON
• models
• String (Default)

GET Request

let apiQuery = ApiStore.defaultStore().createQueryForPath("/1/classes/Task", httpMethod: HttpMethod.get)
apiQuery.execute(completionHandler: {(object, error) in
 })

With Parameters

apiQuery.execute(["foo": "bar"], completionHandler: {(object, error) in
})

HTTP Methods

enum HttpMethod: String {
    case delete = "DELETE"
    case head = "HEAD"
    case get = "GET"
    case options = "OPTIONS"
    case patch = "PATCH"
    case post = "POST"
    case put = "PUT"
}

POST Request

let parameters = ["foo": "bar", "baz1": "1", "baz2": "2", "baz3": "3"]  
apiQuery.setBodyItems(parameters)
apiQuery.execute(completionHandler: {(object, error) in
 })

With Parameters

let parameters = ["foo": "bar", "baz1": "1", "baz2": "2", "baz3": "3"]
apiQuery.execute(parameters, completionHandler: {(object, error) in
 })

Depends of the configuration setted in the api store config the body should be enconding in the supported formats:

• JSON
• URI form encoded
• MultiPart form

Downloading

Supported Upload Types

• Resume Data

Downloading a File

let dataTask: NSURLSessionDownloadTask = apiQuery.download(destination, progress: {(bytesRead, totalBytesRead, totalBytesExpectedToRead) in
    println("PROGRESS")
 }, completionHandler: {(data, response, error) in
   println("DONE")
})

Uploading

Supported Upload Types

• File
• Data
• Stream

Uploading a File

let dataTask: NSURLSessionUploadTask = apiQuery.upload(data, progress: {(bytesRead, totalBytesRead, totalBytesExpectedToRead) in
   println("PROGRESS")
 }, completionHandler: {(data, response, error) in
    println("DONE")
 })

Parameter Encoding

enum ContentType: String {
    case json = "application/json"
    case multiPartForm = "multipart/form-data"
    case urlEnconded = "application/x-www-form-urlencoded"
}

License

NGeen is available under the MIT license. See the LICENSE file for more info.