devise-neo4j 1.0.3 → 2.0.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93c410a790b9472c524bc9e292719010f617ea86
+  data.tar.gz: 1172ed3e86426dccd08f27152c596eb743d0edf4
+SHA512:
+  metadata.gz: 202423db6a77e66e4b0d3d551e992feed871ffa2a5ab0cbd2ca26edbb470949e0599b5f6807293be199faa03c0fae6a19ded07f82d6a4de210f2e14484985306
+  data.tar.gz: df1ee93d673ecf0bc46b47edb1c6e522e728430eb94df9f48689cd686c315b4bd49e9b87cfa368ede5d6fcf3aeb77a88e0ab8106e388c3e2507c0018f480a263

data/.gitignore

@@ -29,3 +29,5 @@ test/rails_app/log
 
 ## NETBEANS
 nbproject
+
+.vagrant

data/.travis.yml

@@ -0,0 +1,5 @@
+script: "bundle exec rake neo4j:install['community-2.1.2'] neo4j:start default --trace"
+language: ruby
+rvm:
+  - 2.1.1
+  - jruby-19mode

data/Gemfile

@@ -1,3 +1,36 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem "rails", "~> 4.1.1"
+gem "omniauth"
+gem "omniauth-oauth2"
+gem "rdoc"
+gem 'neo4j', "~> 3.0.0.alpha.7"
+gem "devise", git: 'https://github.com/plataformatec/devise.git'
+
+group :test do
+  gem "omniauth-facebook"
+  gem "omniauth-openid", "~> 1.0.1"
+  gem "webrat", "0.7.2", :require => false
+  gem "mocha", :require => false
+
+  platforms :mri_18 do
+    gem "ruby-debug", ">= 0.10.3"
+  end
+end
+
+platforms :jruby do
+  gem "jruby-openssl"
+  gem "neo4j-community"
+end
+
+platforms :ruby do
+  gem "sqlite3"
+
+  group :mongoid do
+    gem "mongo"
+    gem "mongoid"
+    gem "bson_ext", "~> 1.3.0"
+  end
+end

data/README.md

@@ -0,0 +1,108 @@
+# Devise-Neo4j [![Build Status](https://secure.travis-ci.org/andreasronge/devise-neo4j.png?branch=master)](http://travis-ci.org/andreasronge/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", "~> 3.0.0.alpha.7"
+    gem "devise-neo4j", "~> 2.0.0.alpha.1"
+
+Run the bundle install command:
+
+    bundle install
+
+Then run the devise install generator and optionally update or create a
+devise-neo4j model:
+
+    rails g devise:install --orm=neo4j
+    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:
+
+    gem install rails
+    rails new myapp -m http://andreasronge.github.com/neo4j/neo4j.rb -O
+    cd myapp
+    add to your Gem File :
+    gem 'devise'
+    gem 'devise-neo4j', :git => 'git@github.com:cheerfulstoic/devise-neo4j.git'
+    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.1.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/sercrets_controller.rb delete line get 'secrets/show' and add:
+      before_filter :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  %>
+
+    rails s
+
+    # go to http://localhost:3000/users/sign_up
+
+## Developing
+
+### For JRuby
+
+JRUby neo4j has an embedded server as part of the gem, so nothing else is
+needed to get set up and running.
+
+### For Ruby
+
+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](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.
+
+Example: ``` rake DEVISE_TEST_PATH=integration/confirmable_test.rb ```
+
+## 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.

data/Rakefile

@@ -1,22 +1,34 @@
-require "rake/testtask"
+# encoding: UTF-8
 require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rdoc/task'
+require 'neo4j/tasks/neo4j_server'
 
+
+task :default => [:test, :"neo4j:db:remove"]
+
+ENV['DEVISE_ORM'] = 'neo4j'
+devise_checked_out = File.join(File.dirname(__FILE__), '../devise')
+ENV['DEVISE_PATH'] =  File.exist?(devise_checked_out) ? devise_checked_out : `bundle show devise`.chomp
 desc 'Run tests for devise-neo4j.'
 Rake::TestTask.new(:test) do |test|
-  ENV['DEVISE_ORM'] = 'neo4j'
-  ENV['DEVISE_PATH'] = `bundle show devise`.chomp
   unless File.exist?(ENV['DEVISE_PATH'])
-    puts "Devise not found in gem bundle"
+    puts "Specify the path to devise (e.g. rake DEVISE_PATH=/path/to/devise) or include it in your gem bundle. Not found at #{ENV['DEVISE_PATH']}"
     exit
   end
-  test.libs << ENV['GEM_HOME'] << "test"
+  test.libs << 'lib' 
+  test.libs << 'test'
   test.libs << "#{ENV['DEVISE_PATH']}/lib"
   test.libs << "#{ENV['DEVISE_PATH']}/test"
-  test.test_files = FileList["#{ENV['DEVISE_PATH']}/test/**/*_test.rb"] + FileList['test/**/*_test.rb']
+
+  if devise_test_path = ENV['DEVISE_TEST_PATH']
+    test.test_files = FileList["#{ENV['DEVISE_PATH']}/test/#{devise_test_path}"]
+  else
+    test.test_files = FileList["#{ENV['DEVISE_PATH']}/test/**/*_test.rb"]  +  FileList['test/**/*_test.rb'] 
+  end
   test.verbose = true
 end
 
-task :default => [:test, :"neo4j:db:remove"]
 
 namespace :neo4j do
   namespace :db do
@@ -25,4 +37,4 @@ namespace :neo4j do
       system "rm -fr #{File.join(File.dirname(__FILE__), "db", "*")}"
     end
   end
-end
+end

data/Vagrantfile

@@ -0,0 +1,22 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  # Every Vagrant virtual environment requires a box to build off of.
+  config.vm.box = "precise64"
+
+  # The url from where the 'config.vm.box' box will be fetched if it
+  # doesn't already exist on the user's system.
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+
+  config.vm.network :forwarded_port, host: 7474, guest: 80    # neo4j
+  config.vm.hostname = "devise-neo4j.develop"
+
+  config.vm.provision "ansible" do |ansible|
+    ansible.playbook = "provisioning/vagrant.yml"
+    # ansible.verbose = "vvvv"
+  end
+end

data/devise-neo4j.gemspec

@@ -5,6 +5,7 @@ require "devise-neo4j/version"
 Gem::Specification.new do |s|
   s.name        = "devise-neo4j"
   s.version     = Devise::Neo4j::VERSION
+  
   s.authors     = ["Ben Jackson", "Bobby Calderwood"]
   s.email       = ["ben@lissomsolutions.com"]
   s.homepage    = "http://github.com/benjackson/devise-neo4j"
@@ -14,18 +15,14 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "devise-neo4j"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_runtime_dependency "oa-oauth", "~> 0.2.0"
-  s.add_runtime_dependency "oa-openid", "~> 0.2.0"
-  s.add_runtime_dependency "neo4j", "~> 1.1"
-  s.add_runtime_dependency "devise", "~> 1.3"
-  
-  s.add_development_dependency "rails", "~> 3.0"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "webrat", "0.7.2"
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "ruby-debug", ">= 0.10.3" if RUBY_VERSION < '1.9'
+  s.add_dependency("warden", "~> 1.2.1")
+  s.add_dependency("orm_adapter", "~> 0.5.0")
+  s.add_dependency("bcrypt-ruby", "~> 3.0")
+  s.add_dependency("railties", ">= 3.1")
+  s.add_dependency("neo4j", ">= 3.0.0.alpha.6")
+  s.add_dependency("devise", "~> 3.0")
 end

data/lib/devise-neo4j.rb

@@ -1,3 +1,2 @@
 require 'devise'
 require 'devise/orm/neo4j/hook'
-require 'devise/orm/neo4j/schema'

data/lib/devise-neo4j/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Neo4j
-    VERSION = "1.0.3"
+    VERSION = "2.0.0.alpha.1"
   end
 end

data/lib/devise/orm/neo4j.rb

@@ -1,10 +1,6 @@
 require 'devise-neo4j'
+require 'devise/orm/neo4j/date_time'
+require 'devise/orm/neo4j/nil_class_converter'
+
+Neo4j::ActiveNode::ClassMethods.send :include, Devise::Models
 
-module Neo4j
-  module Rails
-    class Model
-      extend ::Devise::Models
-      extend ::Devise::Orm::Neo4j::Hook
-    end
-  end
-end

data/lib/devise/orm/neo4j/date_time.rb

@@ -0,0 +1,8 @@
+# Add DateTime#gmtime method if needed.
+class DateTime
+  unless method_defined?(:gmtime)
+    def gmtime
+      self.new_offset(0)
+    end
+  end
+end

data/lib/devise/orm/neo4j/hook.rb

@@ -1,23 +1,18 @@
+require 'devise'
+require 'devise/orm/neo4j/nil_class_converter'
+
 module Devise
   module Orm
     module Neo4j
       module Hook
+        
         def devise_modules_hook!
-          extend Schema
+          include Compatibility
           yield
-          devise_modules.each { |m| send(m) if respond_to?(m, true) }
-          
-          # ensure we have the created_at property
-          property :created_at, :type => Time
-        end
-      
-        # Overwrite the devise method to control indexation dependent on the specified modules
-        def devise(*modules)
-          # hack to get around Neo4j's requirement to index before uniqueness validation
-          index :email, :type => :exact if modules.include?(:validatable)
-          super
         end
+        
       end
     end
   end
 end
+

data/lib/devise/orm/neo4j/nil_class_converter.rb

@@ -0,0 +1,24 @@
+require 'neo4j'
+class Neo4j::TypeConverters::NilClassConverter
+  class << self
+    def convert?(type)
+      type == NilClass || type == :nilclass
+    end
+
+    def to_java(val)
+      return nil if val.nil?
+      return nil if val.empty?
+      val
+    end
+
+    def to_ruby(val)
+      return nil if val.nil?
+      return nil if val.empty?
+      val
+    end
+
+    def index_as
+      String
+    end
+  end
+end

data/lib/generators/neo4j/devise_generator.rb

@@ -4,17 +4,80 @@ module Neo4j
   module Generators
     class DeviseGenerator < ::Rails::Generators::NamedBase
       include ::Devise::Generators::OrmHelpers
-      
+  
       def generate_model
         invoke "neo4j:model", [name] unless model_exists? && behavior == :invoke
       end
+    
+
+      def inject_field_types
+        inject_into_file model_path, model_contents , :after => /Neo4j::ActiveNode\n/ if model_exists?
+      end
 
       def inject_devise_content
-        inject_into_file(model_path, model_contents + <<CONTENT, :after => /Neo4j(::Rails)?::Model\n/) if model_exists?
-  # Setup accessible (or protected) attributes for your model
-  attr_accessible :email, :password, :password_confirmation, :remember_me
-CONTENT
+        inject_into_file model_path,  migration_data , :after => /Neo4j::ActiveNode\n/ if model_exists?
+      end
+      
+    
+    def migration_data
+<<RUBY
+    #
+    # Neo4j.rb needs to have property definitions before any validations. So, the property block needs to come before
+    # loading your devise modules.
+    #
+    # If you add another devise module (such as :lockable, :confirmable, or :token_authenticatable), be sure to
+    # uncomment the property definitions for those modules. Otherwise, the unused property definitions can be deleted.
+    #
+
+     property :username, :type =>   String
+     property :facebook_token, :type => String
+     index :facebook_token
+
+     property :created_at, :type => DateTime
+     property :updated_at, :type => DateTime
+
+     ## Database authenticatable
+     property :email, :type => String, :null => false, :default => ""
+     index :email
+
+     property :encrypted_password
+
+     ## If you include devise modules, uncomment the properties below.
+
+     ## Rememberable
+     property :remember_created_at, :type => DateTime
+     index :remember_token
+
+
+     ## Recoverable
+     property :reset_password_token
+     index :reset_password_token
+     property :reset_password_sent_at, :type =>   DateTime
+
+     ## Trackable
+     property :sign_in_count, :type => Integer, :default => 0
+     property :current_sign_in_at, :type => DateTime
+     property :last_sign_in_at, :type => DateTime
+     property :current_sign_in_ip, :type =>  String
+     property :last_sign_in_ip, :type => String
+
+     ## Confirmable
+     # property :confirmation_token
+     # index :confirmation_token
+     # property :confirmed_at, :type => DateTime
+     # property :confirmation_sent_at, :type => DateTime
+
+     ## Lockable
+     #  property :failed_attempts, :type => Integer, :default => 0
+     # property :locked_at, :type => DateTime
+     #  property :unlock_token, :type => String,
+     # index :unlock_token
+
+      ## Token authenticatable
+      # property :authentication_token, :type => String, :null => true, :index => :exact
+
+RUBY
       end
     end
   end
-end
+end