Giter VIP home page Giter VIP logo

spitcastswift's Introduction

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.

spitcastswift's People

Contributors

daniel-legler avatar

Stargazers

 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.