{"id":4057,"date":"2016-12-30T12:23:32","date_gmt":"2016-12-30T12:23:32","guid":{"rendered":"https:\/\/www.botreetechnologies.com\/blog\/?p=4057"},"modified":"2021-09-13T17:58:56","modified_gmt":"2021-09-13T12:28:56","slug":"authenticate-using-stormpath-in-a-ruby-on-rails-application","status":"publish","type":"post","link":"https:\/\/www.botreetechnologies.com\/blog\/authenticate-using-stormpath-in-a-ruby-on-rails-application\/","title":{"rendered":"Authenticate using Stormpath in a Ruby on Rails App"},"content":{"rendered":"\n

Do you want to focus on your core applications and get to market faster without worrying about authentication, authorization and security?<\/p>\n\n\n\n

Stormpath can help you easily integrate highly secure user management, authentication and authorization to your applications.<\/p>\n\n\n\n

Stormpath provides REST API for integration and wrappers for all popular languages\/platforms. In this tutorial, we will see how to setup Stormpath application and integrate it in a Ruby on Rails application<\/a>.<\/p>\n\n\n\n

Setup Rails Application<\/h2>\n\n\n\n

Create rails new application<\/b><\/p>\n\n\n\n

$ rails new StormpathApp<\/code><\/p>\n\n\n\n

$ cd StormpathApp<\/p><\/blockquote>\n\n\n\n

Add stormpath-rails<\/a> gem in Gemfile<\/i><\/b><\/p>\n\n\n\n

gem 'stormpath-rails'<\/code><\/p>\n\n\n\n

and run bundle from command line from the application home directory<\/p>\n\n\n\n

$ bundle<\/code><\/p>\n\n\n\n

Generate Stormpath supported files<\/b><\/p>\n\n\n\n

$ rails generate strompath:install<\/code><\/p>\n\n\n\n

This will insert the config yaml file and the neccessary controller and view modules.<\/p>\n\n\n\n

If you want to override views which in most case would be, use generator to create copy of views in your application<\/p>\n\n\n\n

$ rails generate stormpath:views<\/code><\/p>\n\n\n\n

Setup Stormpath account<\/h3>\n\n\n\n

Lets us first sign up on Stormpath and sign in to create an application there.<\/p>\n\n\n\n

Application<\/b><\/p>\n\n\n\n

Click on Applications Tab to see all the applications.<\/p>\n\n\n\n

\"Click<\/figure><\/div>\n\n\n\n

By default it give two applications pretreated. But let us create our own application.<\/p>\n\n\n\n

Click on the Create Application button and add details required.<\/p>\n\n\n\n

\"Click<\/figure><\/div>\n\n\n\n

Click on the Accounts menu to see all accounts(users) created. For now you will be the one only.<\/p>\n\n\n\n

\"Click<\/figure><\/div>\n\n\n\n

Click on your name to view your account details and find API keys section at bottom of the page.<\/p>\n\n\n\n

\"account<\/figure><\/div>\n\n\n\n

Click on Create API Key<\/i> button to get API key with secret which we need to authenticate from Rails application. It will prompt you to download a file to having API Key id and secret.<\/p>\n\n\n\n

Create configuration<\/b><\/p>\n\n\n\n

Create local_env.yml file in config and add this code<\/p>\n\n\n\n

STORMPATH_CLIENT_APIKEY_ID: XXXXXXXXXXXXXXXXXXXXX<\/code><\/p>\n\n\n\n

STORMPATH_CLIENT_APIKEY_SECRET: XXXXXXXXXXXXXXXXXXXX<\/code><\/p>\n\n\n\n

STORMPATH_APPLICATION_HREF: https:\/\/api.stormpath.com\/v1\/XXXX<\/code><\/p>\n\n\n\n

Also add this code in application.rb<\/i> to load above environment variable while rails environment is loading<\/p>\n\n\n\n

config.before_configuration do<\/code><\/p>\n\n\n\n

env_file = File.join(Rails.root, 'config', 'local_env.yml')<\/code><\/p>\n\n\n\n

YAML.load(File.open(env_file)).each do |key, value|<\/code><\/p>\n\n\n\n

ENV[key.to_s] = value<\/code>
end if File.exists?(env_file)<\/code><\/p>\n\n\n\n

end<\/code><\/p>\n\n\n\n

Configure config\/stormpath.yml<\/b><\/p>\n\n\n\n

stormpath:<\/code><\/p>\n\n\n\n

application:<\/p>

href: <%= ENV[‘STORMPATH_APPLICATION_HREF’] %><\/p>

name: null<\/p><\/blockquote>\n\n\n\n

Add routes<\/b><\/p>\n\n\n\n

Rails.application.routes.draw do<\/code><\/p>

stormpath_rails_routes()<\/p>

end<\/p><\/blockquote>\n\n\n\n

If you want to override the controller then you have to write routes as actions in params of stormpath_rails_routes() method.<\/p>\n\n\n\n

Useful helper methods<\/p>\n\n\n\n

Using the stormpath rails gem, we get following helpers to be used in controller as well as views<\/p>\n\n\n\n