Git Product home page Git Product logo

swift-dropbox-client's Introduction

Swift Dropbox Client

Swift v5.8 platforms iOS, macOS

Basic Dropbox HTTP API client that does not depend on Dropbox's SDK. No external dependencies.

  • Authorize access
  • List folder
  • Get file metadata
  • Upload file
  • Download file
  • Delete file

๐Ÿ“– Usage

Use Swift Package Manager to add the DropboxClient library as a dependency to your project.

Register your application in Dropbox App Console.

Configure your app so that it can handle sign-in redirects. For an iOS app, you can do it by adding or modifying CFBundleURLTypes in Info.plist:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleTypeRole</key>
    <string>Editor</string>
    <key>CFBundleURLName</key>
    <string></string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>db-abcd1234</string>
    </array>
  </dict>
</array>

Create the client:

import DropboxClient

let client = DropboxClient.Client.live(
  config: .init(
    appKey: "abcd1234",
    redirectURI: "db-abcd1234://my-app"
  )
)

Make sure the redirectURI contains the scheme defined earlier.

The package provides a basic implementation for storing vulnerable data securely in the keychain. Optionally, you can provide your own, custom implementation of a keychain, instead of using the default one.

import DropboxClient

let keychain = DropboxClient.Keychain(
  loadCredentials: { () async -> DropboxClient.Credentials? in
    // load from secure storage and return
  },
  saveCredentials: { (DropboxClient.Credentials) async -> Void in
    // save in secure storage
  },
  deleteCredentials: { () async -> Void in
    // delete from secure storage
  }
)
let client = DropboxClient.Client.live(
  config: .init(...),
  keychain: keychain
)

โ–ถ๏ธ Example

This repository contains an example iOS application built with SwiftUI.

  • Open DropboxClient.xcworkspace in Xcode.
  • Example source code is contained in the Example Xcode project.
  • Run the app using the DropboxClientExampleApp build scheme.
  • The "Example" tab provides UI that uses DropboxClient library.
  • The "Console" tab provides UI for browsing application logs and HTTP requests.

The example app uses Dependencies to manage its own internal dependencies. For more information about the Dependencies library check out official documentation.

๐Ÿ› Project structure

DropboxClient (Xcode Workspace)
 โ”œโ”€ swift-dropbox-client (Swift Package)
 |   โ””โ”€ DropboxClient (Library)
 โ””โ”€ Example (Xcode Project)
     โ””โ”€ DropboxClientExampleApp (iOS Application)

๐Ÿ›  Develop

  • Use Xcode (version โ‰ฅ 14.3.1).
  • Clone the repository or create a fork & clone it.
  • Open DropboxClient.xcworkspace in Xcode.
  • Use the DropboxClient scheme for building the library and running unit tests.
  • If you want to contribute, create a pull request containing your changes or bug fixes. Make sure to include tests for new/updated code.

โ˜•๏ธ Do you like the project?

Buy Me A Coffee

๐Ÿ“„ License

Copyright ยฉ 2023 Dariusz Rybicki Darrarski

License: MIT

swift-dropbox-client's People

Contributors

darrarski avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.