A gem for Neo4j integration with the Devise authentication framework.
Add the neo4j and devise-neo4j gems to your Gemfile:
gem "neo4j", "~> 4.2.1" gem "devise-neo4j"
Run the bundle install command:
Then run the Devise install generator and optionally update or create a devise-neo4j model:
rails g devise:install --orm=neo4j # Make sure the model file is created ahead of time! rails g neo4j:devise MODEL
Add the Devise route to your config/routes.rb:
Now the model is set up like a default Devise model, meaning you can do things
like adding a
before_action in a controller to restrict access to logged-in
before_action :authenticate_<your model name>!
You can see a very simple app that demonstrates Neo4j and devise here:
gem install rails rails new myapp -m http://neo4jrb.io/neo4j/rails.rb -O cd myapp # Add the gem to your Gemfile, then run bundle: gem 'devise-neo4j' bundle rails generate devise:install --orm=neo4j # Install the database unless you already have a Neo4j database, or use JRuby Embedded Neo4j db rake neo4j:install[community-2.2.2] # check which one is the latest rake neo4j:start rails g neo4j:devise User # Add to your config/routes.rb: devise_for :users root :to => "secrets#show" # Generate a controller for the protected content rails g controller secrets show # In app/controllers/secrets_controller.rb add: before_action :authenticate_user! # In app/views/secrets/show.html.erb add: <p>Shhhh... this page is only visible to logged-in users!</p> <%= link_to "Log out", destroy_user_session_path, method: :delete %> # Start the application and visit http://localhost:3000/users/sign_up rails s
JRUby neo4j has an embedded server as part of the gem, so nothing else is needed to get set up and running.
There is a Vagrant setup that installs neo4j so that you can easily get started:
$ vagrant up
The neo4j web interface is forward to port 7474 on your local machine: http://localhost:7474.
Note on testing
To run all test, simply type
rake If you want to run a specific Devise test
(see the devise github repository) set the DEVISE_TEST_PATH.
Note on Patches/Pull Requests
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a future version unintentionally.
- Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
- Send me a pull request. Bonus points for topic branches.
Copyright (c) 2011 Ben Jackson. See LICENSE for details.