UnsplashFramework 0.1

You want to add pod 'UnsplashFramework', '~> 0.1' similar to the following to your Podfile:

target 'MyApp' do
  pod 'UnsplashFramework', '~> 0.1'
end

Then run a pod install inside your terminal, or from CocoaPods.app.

Alternatively to give it a test run, run the command:

pod try UnsplashFramework

UnsplashFramework 0.1

By
Pablo Camiletti
camiletti_p

📷 Introduction

The idea behind this project is to make an easy-to-use, well tested and well documented client framework for Unsplash.

Currently in early development stage 🍼

🛠 Plan

Requirement

iOS 10.3+
XCode 9.1+

⬇️ Installation

CocoaPods

Add the following to your Podfile:

pod 'UnsplashFramework', '~> 0.1'

Carthage

Add the following to your Cartfile:

github "camiletti/UnsplashFramework" ~> 0.1

🎛 Use

import UnsplashFramework

Credentials

Before doing any request, Unsplash client credentials should be set. If you haven't registed yet, you can do so here.

UNClient.shared.setAppID("Your_AppID", secret: "Your_Secret")

Listing photos

UNClient.shared.listPhotos(page: 1, photosPerPage: 10, sortingBy: .popular) { (photos, error) in

    if let error = error {
        print("Error: \(error.reason)")
        return
    }
    
    photos.forEach({ (photo) in
        print("Photo with ID: \(photo.id) from user: \(photo.user.username) main color: \(photo.hexColor)")
    })
}

Fetching the image of a photo and setting it to an UIImageView

For better performance and network utilization, a UNPhoto holds all the information of a photo except the image. The image of the photo can be requested independently in 5 size (raw, full, regular, small and thumb). Using the following UIImageView function will take care of the network request and setting the image as soon as it is downloaded. The main color of the photo can be set as the background while the request is in progress.

let imageView = UIImageView()
imageView.backgroundColor = photo.color

imageView.setImage(from: photo, inSize: .small)

Fetching the image of a photo

let imageView = UIImageView()

self.client.fetchImage(from: samplePhoto,
                       inSize: .full) { (requestedPhoto, requestedSize, image, error) in

    if let error = error {
        print("Error: \(error.reason)")
        return
    }
    
    imageView.image = image
}

📖 Documentation

Full documentation here

🐦 Contact

@camiletti_p

📄 License

UnsplashFramework is under MIT license.

Copyright 2017 Pablo Camiletti

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.