neo4j-core 5.0.1 → 5.1.0

data/lib/neo4j-server/cypher_session.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 module Neo4j
   module Server
     Neo4j::Session.register_db(:server_db) do |endpoint_url, url_opts|
@@ -6,7 +8,6 @@ module Neo4j
 
     class CypherSession < Neo4j::Session
       include Resource
-      include Neo4j::Core::CypherTranslator
 
       alias_method :super_query, :query
       attr_reader :connection
@@ -100,9 +101,14 @@ module Neo4j
       end
 
       def create_node(props = nil, labels = [])
-        id = _query_or_fail(cypher_string(labels, props), true, cypher_prop_list!(props))
-        value = props.nil? ? id : {id: id, metadata: {labels: labels}, data: props}
-        CypherNode.new(self, value)
+        label_string = labels.empty? ? '' : (':' + labels.map { |k| "`#{k}`" }.join(':'))
+        if !props.nil?
+          prop = '{props}'
+          props.each_key { |k| props.delete(k) if props[k].nil? }
+        end
+
+        id = _query_or_fail("CREATE (n#{label_string} #{prop}) RETURN ID(n)", true, props: props)
+        CypherNode.new(self, props.nil? ? id : {id: id, metadata: {labels: labels}, data: props})
       end
 
       def load_node(neo_id)
@@ -112,11 +118,9 @@ module Neo4j
       def load_relationship(neo_id)
         query.unwrapped.optional_match('(n)-[r]-()').where(r: {neo_id: neo_id}).pluck(:r).first
       rescue Neo4j::Session::CypherError => cypher_error
-        if cypher_error.message.match(/not found$/)
-          nil
-        else
-          raise cypher_error
-        end
+        return nil if cypher_error.message.match(/not found$/)
+
+        raise cypher_error
       end
 
       def create_label(name)
@@ -195,26 +199,24 @@ module Neo4j
       end
 
       def _query_entity_data(query, id = nil, params = {})
-        _query_response(query, params).entity_data(id)
-      end
-
-      def _query_response(query, params = {})
         _query(query, params).tap do |response|
           response.raise_error if response.error?
-        end
+        end.entity_data(id)
       end
 
-      def _query(query, params = {})
+      def _query(query, params = {}, options = {})
         query, params = query_and_params(query, params)
 
         curr_tx = Neo4j::Transaction.current
-        if curr_tx
-          curr_tx._query(query, params)
-        else
-          url = resource_url(:cypher)
-          query = params.nil? ? {'query' => query} : {'query' => query, 'params' => params}
-          response = @connection.post(url, query)
-          CypherResponse.create_with_no_tx(response)
+        ActiveSupport::Notifications.instrument('neo4j.cypher_query', params: params, context: options[:context],
+                                                                      cypher: query, pretty_cypher: options[:pretty_cypher]) do
+          if curr_tx
+            curr_tx._query(query, params)
+          else
+            query = params.nil? ? {'query' => query} : {'query' => query, 'params' => params}
+            response = @connection.post(resource_url(:cypher), query)
+            CypherResponse.create_with_no_tx(response)
+          end
         end
       end
 
@@ -235,12 +237,14 @@ module Neo4j
       end
 
       EMPTY = ''
+      NEWLINE_W_SPACES = "\n  "
       def self.log_with
-        clear, yellow, cyan = %W(\e[0m \e[33m \e[36m)
         ActiveSupport::Notifications.subscribe('neo4j.cypher_query') do |_, start, finish, _id, payload|
           ms = (finish - start) * 1000
-          params_string = (payload[:params].size > 0 ? "| #{payload[:params].inspect}" : EMPTY)
-          yield(" #{cyan}#{payload[:context]}#{clear} #{yellow}#{ms.round}ms#{clear} #{payload[:cypher]} #{params_string}")
+          params_string = (payload[:params] && payload[:params].size > 0 ? "| #{payload[:params].inspect}" : EMPTY)
+          cypher = payload[:pretty_cypher] ? NEWLINE_W_SPACES + payload[:pretty_cypher].gsub(/\n/, NEWLINE_W_SPACES) : payload[:cypher]
+
+          yield(" #{ANSI::CYAN}#{payload[:context] || 'CYPHER'}#{ANSI::CLEAR} #{ANSI::YELLOW}#{ms.round}ms#{ANSI::CLEAR} #{cypher} #{params_string}")
         end
       end
     end

data/lib/neo4j-server/cypher_transaction.rb

@@ -9,7 +9,6 @@ module Neo4j
     # If a transaction is created and then closed without performing any queries, an OpenStruct is returned that behaves like a successfully closed query.
     class CypherTransaction
       include Neo4j::Transaction::Instance
-      include Neo4j::Core::CypherTranslator
       include Resource
 
       attr_reader :commit_url, :query_url, :base_url, :connection

data/lib/neo4j-server.rb

@@ -7,7 +7,6 @@ require 'neo4j-server/cypher_node'
 require 'neo4j-server/cypher_label'
 require 'neo4j-server/label'
 require 'neo4j-server/cypher_session'
-require 'neo4j-server/cypher_node_uncommited'
 require 'neo4j-server/cypher_relationship'
 require 'neo4j-server/cypher_response'
 require 'neo4j-server/cypher_transaction'

data/neo4j-core.gemspec

@@ -30,11 +30,10 @@ Neo4j-core provides classes and methods to work with the graph database Neo4j.
   s.add_dependency('httpclient')
   s.add_dependency('faraday_middleware', '~> 0.9.1')
   s.add_dependency('json')
-  s.add_dependency('os')  # for Rake task
-  s.add_dependency('zip') # for Rake task
   s.add_dependency('activesupport') # For ActiveSupport::Notifications
   s.add_dependency('multi_json')
   s.add_dependency('faraday_middleware-multi_json')
+  s.add_dependency('neo4j-rake_tasks')
 
   s.add_development_dependency('pry')
   s.add_development_dependency('yard')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j-core
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Andreas Ronge, Chris Grigg, Brian Underwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -95,21 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: os
-  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: zip
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday_middleware-multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware-multi_json
+  name: neo4j-rake_tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -261,8 +247,6 @@ files:
 - lib/ext/kernel.rb
 - lib/neo4j-core.rb
 - lib/neo4j-core/active_entity.rb
-- lib/neo4j-core/cypher_translator.rb
-- lib/neo4j-core/hash_with_indifferent_access.rb
 - lib/neo4j-core/helpers.rb
 - lib/neo4j-core/label.rb
 - lib/neo4j-core/query.rb
@@ -285,13 +269,13 @@ files:
 - lib/neo4j-server.rb
 - lib/neo4j-server/cypher_label.rb
 - lib/neo4j-server/cypher_node.rb
-- lib/neo4j-server/cypher_node_uncommited.rb
 - lib/neo4j-server/cypher_relationship.rb
 - lib/neo4j-server/cypher_response.rb
 - lib/neo4j-server/cypher_session.rb
 - lib/neo4j-server/cypher_transaction.rb
 - lib/neo4j-server/label.rb
 - lib/neo4j-server/resource.rb
+- lib/neo4j/ansi.rb
 - lib/neo4j/entity_equality.rb
 - lib/neo4j/label.rb
 - lib/neo4j/node.rb
@@ -299,8 +283,6 @@ files:
 - lib/neo4j/property_validator.rb
 - lib/neo4j/relationship.rb
 - lib/neo4j/session.rb
-- lib/neo4j/tasks/config_server.rb
-- lib/neo4j/tasks/neo4j_server.rake
 - lib/neo4j/transaction.rb
 - neo4j-core.gemspec
 homepage: https://github.com/neo4jrb/neo4j-core

data/lib/neo4j/tasks/config_server.rb

@@ -1,36 +0,0 @@
-module Neo4j
-  module Tasks
-    module ConfigServer
-      def config(source_text, port)
-        s = set_property(source_text, 'org.neo4j.server.webserver.https.enabled', 'false')
-        set_property(s, 'org.neo4j.server.webserver.port', port)
-      end
-
-      def set_property(source_text, property, value)
-        source_text.gsub(/#{property}\s*=\s*(\w+)/, "#{property}=#{value}")
-      end
-
-      # Toggles the status of Neo4j 2.2's basic auth
-      def toggle_auth(status, source_text)
-        status_string = status == :enable ? 'true' : 'false'
-        %w(dbms.security.authorization_enabled dbms.security.auth_enabled).each do |key|
-          source_text = set_property(source_text, key, status_string)
-        end
-        source_text
-      end
-
-      # POSTs to an endpoint with the form required to change a Neo4j password
-      # @param [String] target_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 change_password(target_address, old_password, new_password)
-        uri = URI.parse("#{target_address}/user/neo4j/password")
-        response = Net::HTTP.post_form(uri,  'password' => old_password, 'new_password' => new_password)
-        JSON.parse(response.body)
-      end
-
-      extend self
-    end
-  end
-end

data/lib/neo4j/tasks/neo4j_server.rake

@@ -1,245 +0,0 @@
-# :nocov:
-# borrowed from architect4r
-require 'os'
-require 'httparty'
-require 'zip'
-require 'httparty'
-require File.expand_path('../config_server', __FILE__)
-
-namespace :neo4j do
-  def file_name
-    OS::Underlying.windows? ? 'neo4j.zip' : 'neo4j-unix.tar.gz'
-  end
-
-  def download_url(edition)
-    "http://dist.neo4j.org/neo4j-#{edition}-#{OS::Underlying.windows? ? 'windows.zip' : 'unix.tar.gz'}"
-  end
-
-  def download_neo4j_unless_exists(edition)
-    download_neo4j(edition) unless File.exist?(file_name)
-  end
-
-  def download_neo4j(edition)
-    success = false
-
-    File.open(file_name, 'wb') do |file|
-      file << request_url(download_url(edition))
-      success = true
-    end
-
-    file_name
-  ensure
-    File.delete(file_name) unless success
-  end
-
-  def request_url(url)
-    status = HTTParty.head(url).code
-    fail "#{edition} is not available to download, try a different version" if status < 200 || status >= 300
-
-    HTTParty.get(url)
-  end
-
-  def get_environment(args)
-    args[:environment] || 'development'
-  end
-
-  def install_location(args)
-    FileUtils.mkdir_p('db/neo4j')
-    "db/neo4j/#{get_environment(args)}"
-  end
-
-  def config_location(args)
-    "#{install_location(args)}/conf/neo4j-server.properties"
-  end
-
-  def start_server(command, args)
-    puts "Starting Neo4j #{get_environment(args)}..."
-    if OS::Underlying.windows?
-      start_windows_server(command, args)
-    else
-      start_starnix_server(command, args)
-    end
-  end
-
-  def system_or_fail(command)
-    system(command) or fail "Unable to run: #{command}" # rubocop:disable Style/AndOr
-  end
-
-  def start_windows_server(command, args)
-    if system_or_fail!('reg query "HKU\\S-1-5-19"').size > 0
-      system_or_fail("#{install_location(args)}/bin/Neo4j.bat #{command}")  # start service
-    else
-      puts 'Starting Neo4j directly, not as a service.'
-      system_or_fail("#{install_location(args)}/bin/Neo4j.bat")
-    end
-  end
-
-  def start_starnix_server(command, args)
-    system_or_fail("#{install_location(args)}/bin/neo4j #{command}")
-  end
-
-  desc 'Install Neo4j with auth disabled in v2.2+, example neo4j:install[community-2.1.3,development]'
-  task :install, :edition, :environment do |_, args|
-    edition = args[:edition]
-    environment = get_environment(args)
-    puts "Installing Neo4j-#{edition} environment: #{environment}"
-
-    downloaded_file = download_neo4j_unless_exists edition
-
-    if OS::Underlying.windows?
-      # Extract and move to neo4j directory
-      unless File.exist?(install_location(args))
-        Zip::ZipFile.open(downloaded_file) do |zip_file|
-          zip_file.each do |f|
-            f_path = File.join('.', f.name)
-            FileUtils.mkdir_p(File.dirname(f_path))
-            begin
-              zip_file.extract(f, f_path) unless File.exist?(f_path)
-            rescue
-              puts "#{f.name} failed to extract."
-            end
-          end
-        end
-        FileUtils.mv "neo4j-#{edition}", install_location(args)
-        FileUtils.rm downloaded_file
-      end
-
-      # Install if running with Admin Privileges
-      if system_or_fail('reg query "HKU\\S-1-5-19"').size > 0
-        system_or_fail("\"#{install_location(args)}/bin/neo4j install\"")
-        puts 'Neo4j Installed as a service.'
-      end
-
-    else
-      system_or_fail("tar -xvf #{downloaded_file}")
-      system_or_fail("mv neo4j-#{edition} #{install_location(args)}")
-      system_or_fail("rm #{downloaded_file}")
-      puts 'Neo4j Installed in to neo4j directory.'
-    end
-    rake_auth_toggle(args, :disable) unless /-2\.0|1\.[0-9]/.match(args[:edition])
-    puts "Type 'rake neo4j:start' or 'rake neo4j:start[ENVIRONMENT]' to start it\nType 'neo4j:config[ENVIRONMENT,PORT]' for changing server port, (default 7474)"
-  end
-
-  desc 'Start the Neo4j Server'
-  task :start, :environment do |_, args|
-    start_server('start', args)
-  end
-
-  desc 'Start the Neo4j Server asynchronously'
-  task :start_no_wait, :environment do |_, args|
-    start_server('start-no-wait', args)
-  end
-
-  desc 'Configure Server, e.g. rake neo4j:config[development,8888]'
-  task :config, :environment, :port do |_, args|
-    port = args[:port]
-    fail 'no port given' unless port
-    puts "Config Neo4j #{get_environment(args)} for port #{port}"
-    location = config_location(args)
-    text = File.read(location)
-    replace = Neo4j::Tasks::ConfigServer.config(text, port)
-    File.open(location, 'w') { |file| file.puts replace }
-  end
-
-  def validate_is_system_admin!
-    return unless OS::Underlying.windows?
-    return if system_or_fail("reg query \"HKU\\S-1-5-19\"").size > 0
-
-    fail 'You do not have administrative rights to stop the Neo4j Service'
-  end
-
-  def run_neo4j_command_or_fail!(args, command)
-    binary = OS::Underlying.windows? ? 'Neo4j.bat' : 'neo4j'
-
-    system_or_fail("#{install_location(args)}/bin/#{binary} #{command}")
-  end
-
-  desc 'Stop the Neo4j Server'
-  task :stop, :environment do |_, args|
-    puts "Stopping Neo4j #{get_environment(args)}..."
-    validate_is_system_admin!
-
-    run_neo4j_command_or_fail!(args, :stop)
-  end
-
-  desc 'Get info the Neo4j Server'
-  task :info, :environment do |_, args|
-    puts "Info from Neo4j #{get_environment(args)}..."
-    validate_is_system_admin!
-
-    run_neo4j_command_or_fail!(args, :info)
-  end
-
-  desc 'Restart the Neo4j Server'
-  task :restart, :environment do |_, args|
-    puts "Restarting Neo4j #{get_environment(args)}..."
-    validate_is_system_admin!
-
-    run_neo4j_command_or_fail!(args, :restart)
-  end
-
-  desc 'Reset the Neo4j Server'
-  task :reset_yes_i_am_sure, :environment do |_, args|
-    validate_is_system_admin!
-
-    run_neo4j_command_or_fail!(args, :stop)
-
-    # Reset the database
-    FileUtils.rm_rf("#{install_location(args)}/data/graph.db")
-    FileUtils.mkdir("#{install_location(args)}/data/graph.db")
-
-    # Remove log files
-    FileUtils.rm_rf("#{install_location(args)}/data/log")
-    FileUtils.mkdir("#{install_location(args)}/data/log")
-
-    run_neo4j_command_or_fail!(args, :start)
-  end
-
-  desc 'Neo4j 2.2: Change connection password'
-  task :change_password do
-    puts 'This will change the password for a Neo4j server'
-    puts 'Enter target IP address or host name without protocal and port, press enter for http://localhost:7474'
-    address = STDIN.gets.chomp
-    target_address = address.empty? ? 'http://localhost:7474' : address
-
-    puts 'Input current password. Leave blank if this is a fresh installation of Neo4j.'
-    password = STDIN.gets.chomp
-    old_password = password.empty? ? 'neo4j' : password
-
-    puts 'Input new password.'
-    new_password = STDIN.gets.chomp
-    fail 'A new password is required' if new_password.empty?
-
-    body = Neo4j::Tasks::ConfigServer.change_password(target_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 rake_auth_toggle(args, status)
-    location = config_location(args)
-    text = File.read(location)
-    replace = Neo4j::Tasks::ConfigServer.toggle_auth(status, text)
-    File.open(location, 'w') { |file| file.puts replace }
-  end
-
-  def auth_toggle_complete(status)
-    puts "Neo4j basic authentication #{status}. Restart server to apply."
-  end
-
-  desc 'Neo4j 2.2: Enable Auth'
-  task :enable_auth, :environment do |_, args|
-    rake_auth_toggle(args, :enable)
-    auth_toggle_complete('enabled')
-  end
-
-  desc 'Neo4j 2.2: Disable Auth'
-  task :disable_auth, :environment do |_, args|
-    rake_auth_toggle(args, :disable)
-    auth_toggle_complete('disabled')
-  end
-end

data/lib/neo4j-core/cypher_translator.rb

@@ -1,76 +0,0 @@
-module Neo4j
-  module Core
-    module CypherTranslator
-      # Cypher Helper
-      def escape_value(value)
-        if value.is_a?(String) || value.is_a?(Symbol)
-          "'#{escape_quotes(sanitize_escape_sequences(value.to_s))}'"
-        else
-          value
-        end
-      end
-
-      # Like escape_value but it does not wrap the value in quotes
-      def create_escape_value(value)
-        if value.is_a?(String) || value.is_a?(Symbol)
-          "#{sanitize_escape_sequences(value.to_s)}"
-        else
-          value
-        end
-      end
-
-      # Only following escape sequence characters are allowed in Cypher:
-      #
-      # \t Tab
-      # \b Backspace
-      # \n Newline
-      # \r Carriage return
-      # \f Form feed
-      # \' Single quote
-      # \" Double quote
-      # \\ Backslash
-      #
-      # From:
-      # http://docs.neo4j.org/chunked/stable/cypher-expressions.html#_note_on_string_literals
-      SANITIZE_ESCAPED_REGEXP = /(?<!\\)\\(\\\\)*(?![futbnr'"\\])/
-      EMPTY_PROPS = ''
-
-      def sanitize_escape_sequences(s)
-        s.gsub SANITIZE_ESCAPED_REGEXP, EMPTY_PROPS
-      end
-
-      def escape_quotes(s)
-        s.gsub("'", %q(\\\'))
-      end
-
-      # Cypher Helper
-      def cypher_prop_list!(props)
-        return nil unless props
-        props.reject! { |_, v| v.nil? }
-        {props: props.each { |k, v|  props[k] = create_escape_value(v) }}
-      end
-
-      # Stolen from keymaker
-      # https://github.com/therubymug/keymaker/blob/master/lib/keymaker/parsers/cypher_response_parser.rb
-      def self.translate_response(response_body, result)
-        Hashie::Mash.new(Hash[sanitized_column_names(response_body).zip(result)])
-      end
-
-      def self.sanitized_column_names(response_body)
-        response_body.columns.map { |column| column[/[^\.]+$/] }
-      end
-
-      def cypher_string(labels, props)
-        "CREATE (n#{label_string(labels)} #{prop_identifier(props)}) RETURN ID(n)"
-      end
-
-      def label_string(labels)
-        labels.empty? ? '' : ":#{labels.map { |k| "`#{k}`" }.join(':')}"
-      end
-
-      def prop_identifier(props)
-        '{props}' unless props.nil?
-      end
-    end
-  end
-end