neo4j-rake_tasks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a36e3c667d7f1b40f9526dd076b09dfa1aa6a6a2
+  data.tar.gz: da8d4c5c79274aebda5815c50bb939ad87c736c1
+SHA512:
+  metadata.gz: a0ab371f9a010d47ac0605762e9a51213d537c3ee3753889e46b6e1aebcf1107ef148bfa0f207e18f8724e349ca7e51fce4604cf0a79ba135ed63d95065a5b18
+  data.tar.gz: 471d988bd3e75502292633428c7f517619b31a4f43d1f596c1e0f1cbc463d2cdba7066a8417005da023e1e1aece862305af39c4698cd36b5f9d4428f5cafc798

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group 'test' do
+  gem 'coveralls', require: false
+  gem 'simplecov-html', require: false
+  gem 'rake'
+  gem 'rspec'
+  gem 'rspec-its'
+  gem 'guard-rspec', require: false
+end

data/README.md

@@ -0,0 +1,86 @@
+
+Rake tasks for managing a Neo4j database with your Ruby project
+
+
+Rake Tasks
+==========
+
+The ``neo4j-rake_tasks`` gem (automatically included with the ``neo4j`` gem) includes some rake tasks which make it easy to install and manage a Neo4j server in the same directory as your Ruby project.
+
+## neo4j:install
+
+### Arguments
+
+``version`` and ``environment`` (environment default is `development`)
+
+### Example
+
+``rake neo4j:install[community-latest,development]``
+
+... or to get a specific version
+
+``rake neo4j:install[community-2.2.3,development]``
+
+### Description
+
+  Downloads and installs Neo4j into ``$PROJECT_DIR/db/neo4j/<environment>/``
+
+## neo4j:config
+
+### Arguments
+
+``environment`` and ``port``
+
+### Example
+
+``rake neo4j:config[development,7000]``
+
+### Description
+
+  Configure the port which Neo4j runs on.  This affects the HTTP REST interface and the web console address.
+
+
+## neo4j:start
+
+### Arguments
+
+``environment``
+
+### Example
+
+``rake neo4j:start[development]``
+
+### Description
+
+  Start the Neo4j server
+
+
+## neo4j:start_no_wait
+
+### Arguments
+
+``environment``
+
+### Example
+
+``rake neo4j:start_no_wait[development]``
+
+### Description
+
+  Start the Neo4j server with the ``start-no-wait`` command
+
+## neo4j:stop
+
+### Arguments
+
+``environment``
+
+### Example
+
+``rake neo4j:stop[development]``
+
+### Description
+
+  Stop the Neo4j server
+
+

data/lib/neo4j/rake_tasks.rb

@@ -0,0 +1,5 @@
+
+require 'neo4j/rake_tasks/starnix_server_manager'
+require 'neo4j/rake_tasks/windows_server_manager'
+
+require 'neo4j/rake_tasks/railtie' if defined?(Rails)

data/lib/neo4j/rake_tasks/neo4j_server.rake

@@ -0,0 +1,120 @@
+# :nocov:
+# borrowed from architect4r
+require 'os'
+require 'httparty'
+require 'zip'
+require 'httparty'
+require 'pathname'
+require File.expand_path('../config_server', __FILE__)
+require File.expand_path('../windows_server_manager', __FILE__)
+require File.expand_path('../starnix_server_manager', __FILE__)
+
+namespace :neo4j do
+  BASE_INSTALL_DIR = Pathname.new('db/neo4j')
+
+  def server_path(environment)
+    BASE_INSTALL_DIR.join((environment || :development).to_s)
+  end
+
+  def server_manager_class
+    ::Neo4j::Tasks::ServerManager.class_for_os
+  end
+
+  def server_manager(environment, path)
+    ::Neo4j::Tasks::ServerManager.new_for_os(environment, path)
+  end
+
+  def edition_supports_auth?(edition_string)
+    !/-2\.0|1\.[0-9]/.match(edition_string)
+  end
+
+  desc 'Install Neo4j with auth disabled in v2.2+'
+  task :install, :edition, :environment do |_, args|
+    puts "Install Neo4j (#{args[:environment]} environment)..."
+
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.install(args[:edition])
+    if edition_supports_auth?(args[:edition])
+      server_manage.config_auth_enabeled!(false)
+    end
+
+    puts 'To start it type one of the following:'
+    puts '  rake neo4j:start'.blue
+    puts '  rake neo4j:start[ENVIRONMENT]'.blue
+    puts 'To change the server port (default is 7474) type:'
+    puts '  neo4j:config[ENVIRONMENT,PORT]'.blue
+  end
+
+  desc 'Start the Neo4j Server'
+  task :start, :environment do |_, args|
+    puts "Starting Neo4j in #{args[:environment]}..."
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.start
+  end
+
+  desc 'Start the Neo4j Server asynchronously'
+  task :start_no_wait, :environment do |_, args|
+    puts "Starting Neo4j (no wait) in #{args[:environment]}..."
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.start(false)
+  end
+
+  desc 'Configure Server, e.g. rake neo4j:config[development,8888]'
+  task :config, :environment, :port do |_, args|
+    puts "Config Neo4j in #{args[:environment]}"
+
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.config_port!(args[:port].to_i)
+  end
+
+  desc 'Stop the Neo4j Server'
+  task :stop, :environment do |_, args|
+    puts "Stopping Neo4j in #{args[:environment]}..."
+
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.stop
+  end
+
+  desc 'Get info the Neo4j Server'
+  task :info, :environment do |_, args|
+    puts "Getting Neo4j info for #{args[:environment]}..."
+
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.info
+  end
+
+  desc 'Restart the Neo4j Server'
+  task :restart, :environment do |_, args|
+    puts "Restarting Neo4j in #{args[:environment]}..."
+
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.restart
+  end
+
+  desc 'Reset the Neo4j Server'
+  task :reset_yes_i_am_sure, :environment do |_, args|
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.reset
+  end
+
+  desc 'Neo4j 2.2: Change connection password'
+  task :change_password do |_, _args|
+    server_manager_class.change_password!
+  end
+
+  desc 'Neo4j 2.2: Enable Auth'
+  task :enable_auth, :environment do |_, args|
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.config_auth_enabeled!(true)
+
+    puts 'Neo4j basic authentication enabled. Restart server to apply.'
+  end
+
+  desc 'Neo4j 2.2: Disable Auth'
+  task :disable_auth, :environment do |_, args|
+    server_manager = server_manager(server_path(args[:environment]))
+    server_manager.config_auth_enabeled!(false)
+
+    puts 'Neo4j basic authentication disabled. Restart server to apply.'
+  end
+end

data/lib/neo4j/rake_tasks/railtie.rb

@@ -0,0 +1,10 @@
+require 'active_support/notifications'
+require 'rails/railtie'
+
+module Neo4j
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'neo4j/rake_tasks/neo4j_server.rake'
+    end
+  end
+end

data/lib/neo4j/rake_tasks/server_manager.rb

@@ -0,0 +1,215 @@
+require 'pathname'
+
+module Neo4j
+  module RakeTasks
+    # Represents and manages a server installation at a specific path
+    class ServerManager
+      BASE_INSTALL_DIR = Pathname.new('db/neo4j')
+
+      def initialize(path)
+        @path = Pathname.new(path)
+        FileUtils.mkdir_p(@path)
+      end
+
+      # MAIN COMMANDS
+
+      def install(edition_string)
+        version = version_from_edition(edition_string)
+        puts "Installing neo4j-#{version}"
+
+        return false if neo4j_binary_path.exist?
+
+        archive_path = download_neo4j(version) unless File.exist?(file_name)
+        extract!(archive_path)
+
+        FileUtils.rm archive_path
+
+        puts "Neo4j installed to: #{@path}"
+      end
+
+      def start(wait = true)
+        system_or_fail(neo4j_command_path(start_argument(wait)))
+      end
+
+      def stop
+        validate_is_system_admin!
+
+        system_or_fail(neo4j_command_path(:stop))
+      end
+
+      def info
+        validate_is_system_admin!
+
+        system_or_fail(neo4j_command_path(:info))
+      end
+
+      def restart
+        validate_is_system_admin!
+
+        system_or_fail(neo4j_command_path(:restart))
+      end
+
+      def reset
+        validate_is_system_admin!
+
+        stop
+
+        FileUtils.rm_rf(@path.join('data/graph.db/*'))
+        FileUtils.rm_rf(@path.join('data/log/*'))
+
+        start
+      end
+
+      def self.change_password!
+        puts 'This will change the password for a Neo4j server'
+
+        address, old_password, new_password = prompt_for_address_and_passwords!
+
+        body = change_password_request(address, old_password, new_password)
+        if body['errors']
+          puts "An error was returned: #{body['errors'][0]['message']}"
+        else
+          puts 'Password changed successfully! Please update your app to use:'
+          puts 'username: neo4j'
+          puts "password: #{new_password}"
+        end
+      end
+
+      def config_auth_enabeled!(enabled)
+        value = enabled ? 'true' : 'false'
+        modify_config_file(
+          'dbms.security.authorization_enabled' => value,
+          'dbms.security.auth_enabled' => value)
+      end
+
+      def config_port!(port)
+        puts "Config ports #{port} / #{port - 1}"
+
+        modify_config_file('org.neo4j.server.webserver.https.enabled' => false,
+                           'org.neo4j.server.webserver.port' => port,
+                           'org.neo4j.server.webserver.https.port' => port - 1)
+      end
+
+      # END MAIN COMMANDS
+
+      def modify_config_file(properties)
+        contents = File.read(property_configuration_path)
+
+        File.open(property_configuration_path, 'w') do |file|
+          result = properties.inject(contents) do |r, (property, value)|
+            r.gsub(/#{property}\s*=\s*(\w+)/, "#{property}=#{value}")
+          end
+          file << result
+        end
+      end
+
+      def self.class_for_os
+        OS::Underlying.windows? ? WindowsServerManager : StarnixServerManager
+      end
+
+      def self.new_for_os(path)
+        class_for_os.new(path)
+      end
+
+      protected
+
+      def start_argument(wait)
+        wait ? 'start' : 'start-no-wait'
+      end
+
+      def binary_command_path(binary_file)
+        @path.join('bin', binary_file)
+      end
+
+      def neo4j_binary_path
+        binary_command_path(neo4j_binary_filename)
+      end
+
+      def neo4j_command_path(command)
+        neo4j_binary_path.to_s + " #{command}"
+      end
+
+      def property_configuration_path
+        @path.join('conf', 'neo4j-server.properties')
+      end
+
+      def validate_is_system_admin!
+        nil
+      end
+
+      def system_or_fail(command)
+        system(command.to_s) ||
+          fail("Unable to run: #{command}")
+      end
+
+      NEO4J_LATEST_URL = 'https://api.github.com/repos/neo4j/neo4j/releases/latest'
+      def version_from_edition(edition_string)
+        edition_string.gsub(/-latest$/) do
+          require 'open-uri'
+          puts 'Retrieving latest version...'
+          latest_version = JSON.parse(open(NEO4J_LATEST_URL).read)['tag_name']
+          puts "Latest version is: #{latest_version}"
+          "-#{latest_version}"
+        end
+      end
+
+      private
+
+      def download_neo4j(version)
+        tempfile = Tempfile.open('neo4j-download', encoding: 'ASCII-8BIT')
+
+        url = download_url(version)
+
+        status = HTTParty.head(url).code
+        unless (200...300).include?(status)
+          fail "#{version} is not available to download"
+        end
+
+        tempfile << HTTParty.get(url)
+        tempfile.flush
+
+        tempfile.path
+      end
+
+      # POSTs to an endpoint with the form required to change a Neo4j password
+      # @param [String] address
+      #                 The server address, with protocol and port,
+      #                 against which the form should be POSTed
+      # @param [String] old_password
+      #                 The existing password for the "neo4j" user account
+      # @param [String] new_password
+      #                 The new password you want to use. Shocking, isn't it?
+      # @return [Hash]  The response from the server indicating success/failure.
+      def self.change_password_request(address, old_password, new_password)
+        uri = URI.parse("#{address}/user/neo4j/password")
+        response = Net::HTTP.post_form(uri,
+                                       'password' => old_password,
+                                       'new_password' => new_password)
+        JSON.parse(response.body)
+      end
+
+      def self.prompt_for(prompt, default = false)
+        puts prompt
+        print "#{default ? '[' + default.to_s + ']' : ''} > "
+        result = STDIN.gets.chomp
+        result = result.blank? ? default : result
+        result
+      end
+
+      def prompt_for_address_and_passwords!
+        address = prompt_for(
+          'Enter IP address / host name without protocal and port',
+          'http://localhost:7474')
+
+        old_password = prompt_for(
+          'Input current password. Leave blank for a fresh installation',
+          'neo4j')
+
+        new_password = prompt_for 'Input new password.'
+        fail 'A new password is required' if new_password == false
+
+        [address, old_password, new_password]
+      end
+    end
+  end
+end

data/lib/neo4j/rake_tasks/starnix_server_manager.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../server_manager', __FILE__)
+
+module Neo4j
+  module RakeTasks
+    # Represents and manages a server on *NIX systems
+    class StarnixServerManager < ServerManager
+      def neo4j_binary_filename
+        'neo4j'
+      end
+
+      protected
+
+      def extract!(zip_path)
+        Dir.mktmpdir do |temp_dir_path|
+          system_or_fail("cd #{temp_dir_path} && tar -xvf #{zip_path}")
+          subdir = Dir.glob(File.join(temp_dir_path, '*'))[0]
+          system_or_fail("mv #{File.join(subdir, '*')} #{@path}/")
+        end
+      end
+
+      def download_url(version)
+        "http://dist.neo4j.org/neo4j-#{version}-unix.tar.gz"
+      end
+    end
+  end
+end

data/lib/neo4j/rake_tasks/version.rb

@@ -0,0 +1,5 @@
+module Neo4j
+  module RakeTasks
+    VERSION = '0.0.1'
+  end
+end

data/lib/neo4j/rake_tasks/windows_server_manager.rb

@@ -0,0 +1,63 @@
+require File.expand_path('../server_manager', __FILE__)
+
+module Neo4j
+  module RakeTasks
+    # Represents and manages a server on Windows
+    class WindowsServerManager < ServerManager
+      def neo4j_binary_filename
+        'Neo4j.bat'
+      end
+
+      def install
+        super
+
+        return unless nt_admin?
+
+        system_or_fail(neo4j_command_path(:install))
+        puts 'Neo4j Installed as a service.'
+      end
+
+      def validate_is_system_admin!
+        return if nt_admin?
+
+        fail 'You do not have administrative rights to stop the Neo4j Service'
+      end
+
+      protected
+
+      def download_url(version)
+        "http://dist.neo4j.org/neo4j-#{version}-windows.zip"
+      end
+
+      def extract!(zip_path)
+        each_file_in_zip(zip_path) do |file|
+          f_path = @path.join(file.name)
+          FileUtils.mkdir_p(File.dirname(f_path))
+          begin
+            zip_file.extract(file, f_path) unless File.exist?(f_path)
+          rescue
+            puts "#{file.name} failed to extract."
+          end
+        end
+      end
+
+      def start_argument(wait)
+        nt_admin? ? super : ''
+      end
+
+      private
+
+      def each_file_in_zip(zip_path)
+        Zip::ZipFile.open(zip_path) do |zip_file|
+          zip_file.each do |file|
+            yield file
+          end
+        end
+      end
+
+      def nt_admin?
+        system_or_fail('reg query "HKU\\S-1-5-19"').size > 0
+      end
+    end
+  end
+end

data/neo4j-rake_tasks.gemspec

@@ -0,0 +1,47 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'neo4j/rake_tasks/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'neo4j-rake_tasks'
+  s.version  = Neo4j::RakeTasks::VERSION
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.authors  = 'Brian Underwood'
+  s.email    = 'public@brian-underwood.codes'
+  s.homepage = 'https://github.com/neo4jrb/neo4j-rake_tasks'
+  s.summary = <<SUMMARY
+Rake tasks for managing Neo4j
+SUMMARY
+
+  s.license = 'MIT'
+
+  s.description = <<DESCRIPTION
+Rake tasks for managing Neo4j
+
+Tasks allow for starting, stopping, and configuring
+DESCRIPTION
+
+  s.require_path = 'lib'
+  s.files = Dir.glob('{bin,lib,config}/**/*') +
+    %w(README.md Gemfile neo4j-rake_tasks.gemspec)
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w( README.md )
+  s.rdoc_options = [
+    '--quiet',
+    '--title',
+    '--line-numbers',
+    '--main',
+    'README.rdoc',
+    '--inline-source']
+
+  s.add_dependency('colored')
+
+  s.add_development_dependency('vcr')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('guard')
+  s.add_development_dependency('guard-rubocop')
+  s.add_development_dependency('rubocop')
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: neo4j-rake_tasks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Underwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Rake tasks for managing Neo4j
+
+  Tasks allow for starting, stopping, and configuring
+email: public@brian-underwood.codes
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- lib/neo4j/rake_tasks.rb
+- lib/neo4j/rake_tasks/neo4j_server.rake
+- lib/neo4j/rake_tasks/railtie.rb
+- lib/neo4j/rake_tasks/server_manager.rb
+- lib/neo4j/rake_tasks/starnix_server_manager.rb
+- lib/neo4j/rake_tasks/version.rb
+- lib/neo4j/rake_tasks/windows_server_manager.rb
+- neo4j-rake_tasks.gemspec
+homepage: https://github.com/neo4jrb/neo4j-rake_tasks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--title"
+- "--line-numbers"
+- "--main"
+- README.rdoc
+- "--inline-source"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rake tasks for managing Neo4j
+test_files: []