# devise-neo4j

**Repository Path**: mirrors_KieranLafferty/devise-neo4j

## Basic Information

- **Project Name**: devise-neo4j
- **Description**: Devise for Neo4j.rb ORM
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-12
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

= Important Note

This is a fork of the devise-neo4j project, updated  to work with newer version of Neo4j.rb and Devise.

Most of the devise tests pass. You can see the few that do not in test/overrides . All but one of the failures seem to be very minor issues. The one oddity can be seen in RegistrationTest, which is testing validates_confirmation_of :password. It's unclear if this is a real bug (cannot replicate in a unit test or in an application ). 

Note on development: 
the devise test suite runs out of permgen quick on jruby. To fix this, I set JRUBY_OPTS to: 
-X+O -J-Xms1024m -J-Xmx2048m -J-XX:PermSize=256m -J-XX:MaxPermSize=512m

= devise-neo4j

A gem for Neo4j integration with the Devise authentication framework.

Neo4j: https://github.com/andreasronge/neo4j
Devise: https://github.com/plataformatec/devise

== Usage

=== Installation

Add the neo4j and devise-neo4j gems to your Gemfile:

  gem "neo4j", "~> 2.3.0"
  gem 'devise-neo4j', :github => 'KieranLafferty/devise-neo4j'
  
Run the bundle install command:

  bundle install
  
Then run the devise install generator and optionally update or create a devise-neo4j model:

  bundle exec rails g devise:install --orm=neo4j
  bundle exec rails g neo4j:devise MODEL
  
Now the model is setup like a default devise model, meaning you can do things like adding a before_filter in a controller to restrict access to logged-in users only:

  before_filter :authenticate_<your model name>!

== Example App

You can see a very simple app that demonstrates Neo4j and devise here:

https://github.com/benjackson/devise-neo4j-example


Or build your own using:
  gem install rails
  rails new myapp -m http://andreasronge.github.com/neo4j/rails.rb -O
  cd myapp
  add to your Gem File : 
  gem 'devise-neo4j', :git => 'git://github.com/cfitz/devise-neo4j.git', :branch => 'devise2'
  bundle
  rails generate devise:install --orm=neo4j
  bundle exec rails g neo4j:devise User
  add devise_for :users to config/routes.rb (not sure why generator is not adding this...)
  rails s
  go to http://localhost:3000/users/sign_up

== 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

Copyright (c) 2011 Ben Jackson. See LICENSE for details.