Skip to content

Unofficial Swift library for accessing the Spitcast (Surf Forecasting) API

License

Notifications You must be signed in to change notification settings

daniel-legler/SpitcastSwift

Repository files navigation

SpitcastSwift

Version License Platform

Usage

All available endpoints are exposed via the SpitcastAPI class, with the following usage:

SpitcastAPI.allSpots() { (result) in
  // Handle result
}

There are convenience structs (Counties, Spots) which contain names and SpotId values used by Spitcast to identify particular surf spots:

SpitcastAPI.spotForecast(id: Spots.LosAngeles.ManhattanBeach.id) { (result) in
    result.withValue({ (reports) in
      // Handle surf report information
    })
    result.withError({ (error) in
      // Handle error
    })
}

Please see the included tests that have examples of each available API call.

Installation

SpitcastSwift is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'SpitcastSwift'

If being used in an iOS app, you will need to add this snippet to your Info.plist file to comply with App Transport Security:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSExceptionDomains</key>
        <dict>
            <key>spitcast.com</key>
            <dict>
            <key>NSIncludesSubdomains</key>
            <true/>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
        </dict>
    </dict>
</dict>

Note that NSExceptionAllowsInsecureHTTPLoads must be true because Spitcast does not support HTTPS.

Author

Daniel Legler

All content and surf reporting obtained by use of this library is owned by Spitcast.

License

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

About

Unofficial Swift library for accessing the Spitcast (Surf Forecasting) API

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published