README.md in oauthio-0.1.0 vs README.md in oauthio-0.9.0
- old
+ new
@@ -2,10 +2,12 @@
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/oauthio`. To experiment with that code, run `bin/console` for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
+WORK IN PROGRESS
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,10 +22,44 @@
$ gem install oauthio
## Usage
-TODO: Write usage instructions here
+Example:
+
+
+```
+# routes.rb
+get 'oauth/:provider/signin', to: 'auth/oauth_callbacks#signin'
+get 'oauth/redirect', to: 'auth/oauth_callbacks#redirect'
+
+# controllers/auth/oauth_callbacks_controller.rb
+ def signin
+ # ..
+ # check params[:provider] is enabled
+ # ...
+
+ session[:oauthio_state_token] = form_authenticity_token
+ redirect_to Oauthio.auth_url('google', 'http://localhost:3000/oauth/redirect', session[:oauthio_state_token])
+end
+
+def redirect
+ oauthio_payload = JSON.parse(params['oauthio'])
+
+ if session[:oauthio_state_token].present? &&oauthio_payload['state'] == session[:oauthio_state_token]
+ if oauthio_payload['status'] == 'success'
+ oauth_client = Oauthio::Client.new 'google', oauthio_payload['data']['access_token']
+
+ render json: oauth_client.me
+ else
+ render json: { error: "Invalid oauth.io status: #{oauthio_payload['status']}" }
+ end
+ else
+ render json: { error: 'CSRF token does NOT match' }
+ end
+end
+
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.