https://github.com/telefonicaid/bluevia_engine

Rails 3 Engine to handle BlueVia OAuth mechanism
https://github.com/telefonicaid/bluevia_engine

Last synced: 9 days ago
JSON representation

Rails 3 Engine to handle BlueVia OAuth mechanism

• Host: GitHub
• URL: https://github.com/telefonicaid/bluevia_engine
• Owner: telefonicaid
• License: agpl-3.0
• Created: 2011-09-18T06:15:24.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2012-02-19T21:26:19.000Z (about 13 years ago)
• Last Synced: 2025-01-02T21:48:23.662Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 110 KB
• Stars: 6
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
= Description

This Rails Engine provides the easiest way to handle OAuth authentication mechanism with BlueVia API in a Rails application.

If you want to use any other BlueVia API, please go to {Bluevia portal SDKs sections}[https://bluevia.com/en/knowledge/sdks.Ruby] and check for the latest available gem.

= Installation

After creating a Rails 3 application...

* Use Gemfile as usual to define the bluevia_engine dependency

    gem 'bluevia_engine'

* Run the generator to copy the configuration file template into your rails application initializers folder

    rails generate bluevia_engine:install

* Get information about the new routes created using the specific rails command:

    rake routes

= How to use

== Configuration

* Define your BlueVia application credentials in the file config/initializers/bluevia\_engine\_initializer.rb

    # Application unique identifier. Actually its not needed at all

    Rails.application.config.bluevia.application_id = "your-bluevia-application-id"

    # Application key. This is the first element to authenticate an application    

    Rails.application.config.bluevia.key = "your-bluevia-application-key"

    # Application secret. This is the second element to authenticate an application    

    Rails.application.config.bluevia.secret = "your-bluevia-application-secret"

* Define the controller#action where you would like to receive the OAuth response data. You'll get two parameters: **token** and **token_secret** that you should handle accordingly.

    # Where to forward the OAuth response data

    

    # By default is configured an action include in the Engine that prints the token and secret got from BlueVia

    Rails.application.config.bluevia.forward_action = "bluevia#show"

== Launch OAuth process

* Create a link in one of your views to the path that launches the BlueVia OAuth process:

    <%=link_to t("launch_bluevia_oauth"), bluevia_index_path%>

= License

Check the {License}[http://github.com/telefonicaid/bluevia_engine/blob/master/LICENSE.txt] file.

= Author

* Juan de Bravo (jdbd at tid dot es)