Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fjcaetano/ReCaptcha

[In]visible ReCaptcha v2 for iOS
https://github.com/fjcaetano/ReCaptcha

google reactive recaptcha rxswift swift webview

Last synced: about 1 month ago
JSON representation

[In]visible ReCaptcha v2 for iOS

Host: GitHub
URL: https://github.com/fjcaetano/ReCaptcha
Owner: fjcaetano
License: mit
Created: 2017-03-22T20:00:10.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-09-18T20:22:27.000Z (12 months ago)
Last Synced: 2024-07-19T03:22:27.724Z (about 2 months ago)
Topics: google, reactive, recaptcha, rxswift, swift, webview
Language: Swift
Homepage: http://blog.flaviocaetano.com/post/recaptcha-reaches-1-dot-0/
Size: 1.25 MB
Stars: 266
Watchers: 12
Forks: 133
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-ios - ReCaptcha - (In)visible ReCaptcha for iOS. (Authentication)
awesome-swift - ReCaptcha - [In]visible ReCaptcha for iOS. (Libs / Authentication)
awesome-swift - ReCaptcha - [In]visible ReCaptcha for iOS. (Libs / Authentication)
fucking-awesome-swift - ReCaptcha - [In]visible ReCaptcha for iOS. (Libs / Authentication)
awesome-ios-star - ReCaptcha - (In)visible ReCaptcha for iOS. (Authentication)
awesome-swift - ReCaptcha - [In]visible ReCaptcha v2 for iOS ` 📝 6 months ago ` (Authentication [🔝](#readme))

README

        # ReCaptcha

[![Build Status](https://travis-ci.org/fjcaetano/ReCaptcha.svg?branch=master)](https://travis-ci.org/fjcaetano/ReCaptcha)

[![codecov](https://codecov.io/gh/fjcaetano/ReCaptcha/branch/master/graph/badge.svg)](https://codecov.io/gh/fjcaetano/ReCaptcha)

[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/fjcaetano/ReCaptcha/pulls)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-orange.svg)](https://github.com/Carthage/Carthage)

[![Version](https://img.shields.io/cocoapods/v/ReCaptcha.svg?style=flat)](http://cocoapods.org/pods/ReCaptcha)

[![License](https://img.shields.io/cocoapods/l/ReCaptcha.svg?style=flat)](http://cocoapods.org/pods/ReCaptcha)

[![Platform](https://img.shields.io/cocoapods/p/ReCaptcha.svg?style=flat)](http://cocoapods.org/pods/ReCaptcha)

-----

Add Google's [Invisible ReCaptcha v2](https://developers.google.com/recaptcha/docs/invisible) to your project. This library

automatically handles ReCaptcha's events and retrieves the validation token or notifies you to present the challenge if

invisibility is not possible.

![Example Gif 2](https://raw.githubusercontent.com/fjcaetano/ReCaptcha/master/example2.gif)  ![Example Gif](https://raw.githubusercontent.com/fjcaetano/ReCaptcha/master/example.gif)

#### _Warning_ ⚠️

Beware that this library only works for ReCaptcha v2 Invisible keys! Make sure to check the reCAPTCHA

v2 Invisible badge option when creating your [API Key](https://www.google.com/recaptcha/admin/create).

![ReCaptcha v2 invisible key example](https://raw.githubusercontent.com/fjcaetano/ReCaptcha/master/example-v2-key.png)

You won't be able to use a ReCaptcha v3 key because it requires server-side validation. On v3, all

challenges succeed into a token which is then validated in the server for a score. For this reason,

a frontend app can't know on its own wether or not a user is valid since the challenge will always

result in a valid token.

## Installation

ReCaptcha is available through [CocoaPods](http://cocoapods.org) and [Carthage](https://github.com/Carthage/Carthage).

To install it, simply add the following line to your dependencies file:

#### Cocoapods

``` ruby

pod "ReCaptcha"

# or

pod "ReCaptcha/RxSwift"

```

#### Carthage

``` ruby

github "fjcaetano/ReCaptcha"

```

Carthage will create two different frameworks named `ReCaptcha` and `ReCaptcha_RxSwift`, the latter containing the RxSwift

extension for the ReCaptcha framework.

## Usage

The reCAPTCHA keys can be specified as Info.plist keys or can be passed as parameters when instantiating ReCaptcha().

For the Info.plist configuration, add `ReCaptchaKey` and `ReCaptchaDomain` (with a protocol ex. http:// or https://) to your Info.plist and run:

``` swift

let recaptcha = try? ReCaptcha()

override func viewDidLoad() {

    super.viewDidLoad()

    recaptcha?.configureWebView { [weak self] webview in

        webview.frame = self?.view.bounds ?? CGRect.zero

    }

}

func validate() {

    recaptcha?.validate(on: view) { [weak self] (result: ReCaptchaResult) in

        print(try? result.dematerialize())

    }

}

```

If instead you prefer to keep the information out of the Info.plist, you can use:

``` swift

let recaptcha = try? ReCaptcha(

    apiKey: "YOUR_RECAPTCHA_KEY", 

    baseURL: URL(string: "YOUR_RECAPTCHA_DOMAIN")!

)

...

```

You can also install the reactive subpod and use it with RxSwift:

``` swift

recaptcha.rx.validate(on: view)

    .subscribe(onNext: { (token: String) in

        // Do something

    })

```

#### Alternte endpoint

If your app has firewall limitations that may be blocking Google's API, the JS endpoint may be changed on initialization.

It'll then point to `https://www.recaptcha.net/recaptcha/api.js`:

``` swift

public enum Endpoint {

    case default, alternate

}

let recaptcha = try? ReCaptcha(endpoint: .alternate) // Defaults to `default` when unset

```

## Help Wanted

Do you love ReCaptcha and work actively on apps that use it? We'd love if you could help us keep improving it!

Feel free to message us or to start contributing right away!

## [Full Documentation](http://fjcaetano.github.io/ReCaptcha)

## License

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