Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 2.9 KB

README.md

File metadata and controls

89 lines (59 loc) · 2.9 KB
Raw

fsq

FoursquareAuthenticate Grails plugin

Introduction

The Foursquare Platform is a set of APIs that make your application more social. Read more about integrating Foursquare with your web site on the Foursquare developer site.

This project contains the open source Grails Foursquare Authenticate Plugin that allows you to integrate the Foursquare Authenticate on a website/app powered by Grails.

I created this plugin because there are several plugins that handles the Foursquare API already, but none of them are taking care of the OAuth token acquisition.

Grails Foursquare Plugin provides the following Grails artefacts:

  • FsqTagLib - A collection of tags to easily integrate Foursquare Authenticate in your GSPs.
  • FoursquareAuthenticationService - Service used to obtain the OAuth token by exchanging the code obtained using the JS library.

Installation

Declare the plugin dependency in the BuildConfig.groovvy file, as shown here:

grails.project.dependency.resolution = {
    inherits("global") { }
		log "info"
		repositories {
				//your repositories
		}
		dependencies {
				//your regular dependencies
		}
		plugins {
				//here go your plugin dependencies
				runtime ':foursquare-authenticate:0.5'
		}
}

Config

Create a Foursquare app on Foursquare Developers, in order to get your own app ID and app secret.

Add your Foursquare app parameters to your grails-app/conf/Config.groovy:

[REQUIRED]
grails.plugin.foursquareauth.appId = {Client ID}
grails.plugin.foursquareauth.secret = {Client Secret}
grails.plugin.foursquareauth.callback = {Callback url}
[OPTIONAL]
grails.plugin.foursquareauth.proxyHost = {Proxy host}
grails.plugin.foursquareauth.proxyPort = {Proxy Port}

Getting started with a demo app

If you want to quickly run the plugin on a demo app, you can download FoursquareAuthenticationSampleApp.

Documentation

Project documentation is located here :

Latest releases

  • 2012-11-23 V0.5 : Updated documentation
  • 2012-11-23 V0.4 : First public release
  • 2012-11-20 V0.3 : Non public release
  • 2012-11-3 V0.2 : Non public release
  • 2012-10-30 V0.1 : Non public release

Bugs

To report any bug, please use the project Issues section on GitHub.

Beta status

This is a beta release. The underlying APIs are generally stable, however we may make changes to the library in response to developer feedback.

Feedback

The Grails Foursquare Authenticate is licensed under the Apache Licence, Version 2.0.