JBDScaleway

iOS Framework for Scaleway API

• Requirements
• Installation
• Usage
• License

Requirements

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

Installation

Dependency Managers

$ gem install cocoapods

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'JBDScaleway', '~> 1.0'

$ pod install

$ brew update
$ brew install carthage

github "jbdujardin/JBDScaleway" ~> 1.0

import PackageDescription

let package = Package(
    name: "HelloJBDScaleway",
    dependencies: [
        .Package(url: "https://github.com/jbdujardin/JBDScaleway.git", .upToNextMajor(from: "1.0"))
    ]
)

Manually

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

$ git init

$ git submodule add https://github.com/jbdujardin/JBDScaleway.git
$ git submodule update --init --recursive

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate JBDScaleway 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 JBDScaleway as a git submodule by running the following command:

$ git submodule add https://github.com/jbdujardin/JBDScaleway.git
$ git submodule update --init --recursive

• Open the new JBDScaleway folder, and drag the JBDScaleway.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 JBDScaleway.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 JBDScaleway.xcodeproj folders each with two different versions of the JBDScaleway.framework nested inside a Products folder.

  It does not matter which Products folder you choose from.

• Select the JBDScaleway.framework.

• And that's it!

The JBDScaleway.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/jbdujardin/JBDScaleway/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 JBDScaleway.framework.
• And that's it!

Usage

Import Framework

import JBDScaleway

Init Context

let region = ApiRegion.paris
let context = NonPersistentApiContext(region: region)
// If you have the Auth Token
context.authToken = "12345678-1234-1234-1234-1234567890ab"

Services

• AlamofireAuthService

  • createToken
  • getTokens
  • getToken
  • increaseTokenExpiration
  • deleteToken

• AlamofireUserService

  • getUser

• AlamofireOrganizationService

  • getOrganizations
  • getOrganization

• AlamofireServerService

  • getServers
  • getServer
  • createServer
  • updateServer
  • deleteServer
  • getServerActions
  • executeActionOnServer

• AlamofireImageService

  • getImages
  • getImage
  • createImage
  • updateImage
  • deleteImage

• AlamofireIPService

  • getIPs
  • getIP
  • createIP
  • attachIPToServer
  • deleteIP

• AlamofireSecurityGroupService

  • getSecurityGroups
  • getSecurityGroup
  • createSecurityGroup
  • updateSecurityGroup
  • deleteSecurityGroup
  • createRule
  • getRules
  • updateRule
  • getRule
  • deleteRule

• AlamofireSnapshotService

  • getSnapshots
  • getSnapshot
  • createSnapshot
  • updateSnapshot
  • deleteSnapshot

• AlamofireVolumeService

  • getVolumes
  • getVolume
  • createVolume
  • deleteVolume

Examples

Login

let authService = AlamofireAuthService(context: context)
authService.createToken(email: "[email protected]", password: "qwerty", completion: { (token, error) in
    ...
})

Organizations

let organizationService = AlamofireOrganizationService(context: context)
organizationService.getOrganizations(completion: { (organizations, error) in
    ...
})

Servers

let serverService = AlamofireServerService(context: context)
serverService.getServers(completion: { (servers, error) in
    ...
})

Contributing

Issues and pull requests are welcome!

Author

Jean-Baptiste Dujardin @jbdujardin

License

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