neo4j-core 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f4890cd93db0d6c36f8208fc1e9389c587edaf2
-  data.tar.gz: dea68555caf4904ac68214b6cea915cb1c8462e9
+  metadata.gz: bb8493440e6f8164e499189ebc58e95998b5bad1
+  data.tar.gz: 02678788be0642f10aa6781bdcb82fd11ab5fe97
 SHA512:
-  metadata.gz: 3e34f33523134c71bb13aa7858a3f2444bcfb252f39d2dc54c41417d8c291347e47a8730c200639e1cb0ef7094b1c84941312b1210877c46f4471c4bcaca84ce
-  data.tar.gz: 2a0cb02bb6ea67c92e9964643c5743a2bca5b35385cc7079b02433c283014eb929c6d403f1ef148b66b8d3eda9a2d214be9f5d6c23e3db621d120764c6dee40d
+  metadata.gz: 82882d368b6ff790c061653f0cb68a2af37e328ef2ea948c507671108976d0a7ee60fac78653b6e254ca4a5d00c6cedf1bcda3bce15e038b446665042363fe5d
+  data.tar.gz: 76be0d527c6d6710eb3753fd370b747341efd3f099654447d9297a18d29bb01c330764183d206ef48fa59aab78ecdfa600cdb55879e0ad106a177e0188970035

data/lib/neo4j-core/version.rb

@@ -1,5 +1,5 @@
 module Neo4j
   module Core
-    VERSION = "3.1.0"
+    VERSION = "3.1.1"
   end
 end

data/lib/neo4j-server/cypher_authentication.rb

@@ -35,11 +35,16 @@ module Neo4j::Server
     # Uses the given username and password to obtain a token, then adds the token to the connection's parameters.
     # @return [String] An access token provided by the server.
     def authenticate
-      auth_response = connection.get("#{url}/authentication")
-      return nil if auth_response.body.empty?
-      auth_body = JSON.parse(auth_response.body)
-      token = auth_body['errors'][0]['code'] == 'Neo.ClientError.Security.AuthorizationFailed' ? obtain_token : nil
-      add_auth_headers(token) unless token.nil?
+      auth_response = auth_connection("#{url}/authentication")
+      auth_hash = if auth_response.body.empty?
+                    nil
+                  elsif auth_response.body.is_a?(String)
+                    JSON.parse(auth_response.body)['errors'][0]['code'] == 'Neo.ClientError.Security.AuthorizationFailed' ? auth_attempt : nil
+                  else
+                    auth_response
+                  end
+      return nil if auth_hash.nil?
+      add_auth_headers(token_or_error(auth_hash))
     end
 
     # Invalidates the existing token, which will invalidate all conncetions using this token, applies for a new token, adds this into
@@ -47,21 +52,32 @@ module Neo4j::Server
     # @param [String] password The current server password.
     def reauthenticate(password)
       invalidate_token(password)
-      add_auth_headers(obtain_token)
+      add_auth_headers(token_or_error(auth_attempt))
     end
 
     # Requests a token from the authentication endpoint using the given username and password.
-    # @return [String] A plain-text token.
-    def obtain_token
+    # @return [Faraday::Response] The server's response, to be interpreted.
+    def auth_attempt
       begin
         user = params[:basic_auth][:username]
         pass = params[:basic_auth][:password]
       rescue NoMethodError
         raise MissingCredentialsError, 'Neo4j authentication is enabled, username/password are required but missing'
       end
-      auth_response = connection.post("#{url}/authentication", { 'username' => user, 'password' => pass })
-      raise PasswordChangeRequiredError, "Server requires a password change, please visit #{url}" if auth_response.body['password_change_required']
-      raise InvalidPasswordError, "Neo4j server responded with: #{auth_response.body['errors'][0]['message']}" if auth_response.status.to_i == 422
+      connection.post("#{url}/authentication", { 'username' => user, 'password' => pass })
+    end
+
+    # Takes a response object from the server and returns a token or fails with an error.
+    # Todo: more error states!
+    # @param [Farday::Response] auth_response The response after attempting authentication
+    # @return [String] An authentication token.
+    def token_or_error(auth_response)
+      begin
+        raise PasswordChangeRequiredError, "Server requires a password change, please visit #{url}" if auth_response.body['password_change_required']
+        raise InvalidPasswordError, "Neo4j server responded with: #{auth_response.body['errors'][0]['message']}" if auth_response.status.to_i == 422
+      rescue NoMethodError
+        raise 'Unexpected auth response, please open an issue at https://github.com/neo4jrb/neo4j-core/issues'
+      end
       auth_response.body['authorization_token']
     end
 
@@ -72,6 +88,7 @@ module Neo4j::Server
     end
 
     # Stores an authentication token in the properly-formatted header.
+    # This does not do any checking that what it has been given is a token. Whatever param is given will be base64 encoded and used as the header.
     # @param [String] token The authentication token provided by the database.
     def add_auth_headers(token)
       @token = token
@@ -80,6 +97,11 @@ module Neo4j::Server
 
     private
 
+    # Makes testing easier, we can stub this method to simulate different responses
+    def auth_connection(url)
+      connection.get(url)
+    end
+
     def self.new_connection
       conn = Faraday.new do |b|
         b.request :json
@@ -95,7 +117,7 @@ module Neo4j::Server
     end
 
     def token_hash(token)
-      Base64.strict_encode64(":#{token}")
+      ::Base64.strict_encode64(":#{token}")
     end
   end
 end

data/lib/neo4j-server/cypher_node.rb

@@ -46,7 +46,7 @@ module Neo4j::Server
       if @props
         @props
       else
-        hash = @session._query_entity_data("#{match_start} RETURN n")
+        hash = @session._query_entity_data("#{match_start} RETURN n", nil, neo_id: neo_id)
         @props = Hash[hash['data'].map{ |k, v| [k.to_sym, v] }]
       end
     end
@@ -58,20 +58,20 @@ module Neo4j::Server
     # (see Neo4j::Node#remove_property)
     def remove_property(key)
       refresh
-      @session._query_or_fail("#{match_start} REMOVE n.`#{key}`")
+      @session._query_or_fail("#{match_start} REMOVE n.`#{key}`", false, { neo_id: neo_id })
     end
 
     # (see Neo4j::Node#set_property)
     def set_property(key,value)
       refresh
-      @session._query_or_fail("#{match_start} SET n.`#{key}` = { value }", false, value: value)
+      @session._query_or_fail("#{match_start} SET n.`#{key}` = { value }", false, { value: value, neo_id: neo_id })
       value
     end
 
     # (see Neo4j::Node#props=)
     def props=(properties)
       refresh
-      @session._query_or_fail("#{match_start} SET n = { props }", false, {props: properties})
+      @session._query_or_fail("#{match_start} SET n = { props }", false, { props: properties, neo_id: neo_id })
       properties
     end
 
@@ -80,7 +80,7 @@ module Neo4j::Server
       q = "#{match_start} REMOVE " + properties.map do |k|
         "n.`#{k}`"
       end.join(', ')
-      @session._query_or_fail(q)
+      @session._query_or_fail(q, false, neo_id: neo_id)
     end
 
     # (see Neo4j::Node#update_props)
@@ -92,25 +92,19 @@ module Neo4j::Server
       remove_properties(removed_keys) unless removed_keys.empty?
       properties_to_set = properties.keys - removed_keys
       return if properties_to_set.empty?
-      q = "#{match_start} SET " + properties_to_set.map do |k|
-        "n.`#{k}`= #{escape_value(properties[k])}"
-      end.join(',')
-      @session._query_or_fail(q)
+      props_list = cypher_prop_list(properties)[:props].merge({ neo_id: neo_id })
+      @session._query_or_fail("#{match_start} SET #{cypher_properties(properties_to_set)}", false, props_list)
       properties
     end
 
     # (see Neo4j::Node#get_property)
     def get_property(key)
-      if @props
-        @props[key.to_sym]
-      else
-        @session._query_or_fail("#{match_start} RETURN n.`#{key}`", true)
-      end
+      @props ? @props[key.to_sym] : @session._query_or_fail("#{match_start} RETURN n.`#{key}`", true, neo_id: neo_id)
     end
 
     # (see Neo4j::Node#labels)
     def labels
-      @labels ||= @session._query_or_fail("#{match_start} RETURN labels(n) as labels", true)
+      @labels ||= @session._query_or_fail("#{match_start} RETURN labels(n) as labels", true, neo_id: neo_id)
       @labels.map(&:to_sym)
     end
 
@@ -119,22 +113,21 @@ module Neo4j::Server
     end
 
     def add_label(*labels)
-      @session._query_or_fail("#{match_start} SET n #{_cypher_label_list(labels)}")
+      @session._query_or_fail("#{match_start} SET n #{_cypher_label_list(labels)}", false, neo_id: neo_id)
     end
 
     def remove_label(*labels)
-      @session._query_or_fail("#{match_start} REMOVE n #{_cypher_label_list(labels)}")
+      @session._query_or_fail("#{match_start} REMOVE n #{_cypher_label_list(labels)}", false, neo_id: neo_id)
     end
 
     def set_label(*label_names)
-      q = "#{match_start} #{remove_labels_if_needed} #{set_labels_if_needed(label_names)}" 
-      @session._query_or_fail(q)
+      q = "#{match_start} #{remove_labels_if_needed} #{set_labels_if_needed(label_names)}"
+      @session._query_or_fail(q, false, neo_id: neo_id)
     end
 
     # (see Neo4j::Node#del)
     def del
-      @session._query_or_fail("#{match_start} MATCH n-[r]-() DELETE r")
-      @session._query_or_fail("#{match_start} DELETE n")
+      @session._query_or_fail("#{match_start} OPTIONAL MATCH n-[r]-() DELETE n, r", false, neo_id: neo_id)
     end
 
     alias_method :delete, :del
@@ -142,7 +135,7 @@ module Neo4j::Server
 
     # (see Neo4j::Node#exist?)
     def exist?
-      @session._query("#{match_start} RETURN ID(n)").data.empty? ? false : true
+      @session._query("#{match_start} RETURN ID(n)", neo_id: neo_id).data.empty? ? false : true
     end
 
     # (see Neo4j::Node#node)
@@ -181,7 +174,7 @@ module Neo4j::Server
       between_id = match[:between] ? "MATCH (p) WHERE ID(p) = #{match[:between].neo_id}" : ""
       dir_func = to_dir[match[:dir] || :both]
       cypher = "#{match_start} #{between_id} MATCH (n)#{dir_func.call(cypher_rel)}(p) RETURN #{returns}"
-      r = @session._query(cypher)
+      r = @session._query(cypher, neo_id: neo_id)
       r.raise_error if r.error?
       _map_result(r)
     end
@@ -192,6 +185,10 @@ module Neo4j::Server
 
     private
 
+    def cypher_properties(properties_to_set)
+      properties_to_set.map! { |k| "n.`#{k}` = {`#{k}`}"}.join(',')
+    end
+
     def remove_labels_if_needed
       if labels.empty?
         ""
@@ -215,7 +212,7 @@ module Neo4j::Server
     end
 
     def match_start(identifier = 'n')
-      "MATCH (#{identifier}) WHERE ID(#{identifier}) = #{neo_id}"
+      "MATCH (#{identifier}) WHERE ID(#{identifier}) = {neo_id}"
     end
   end
 end

data/lib/neo4j-server/cypher_relationship.rb

@@ -34,7 +34,7 @@ module Neo4j::Server
 
     def load_resource
       if resource_data.nil? || resource_data.empty?
-        @resource_data = @session._query_or_fail("#{match_start} RETURN n", true) # r.first_data
+        @resource_data = @session._query_or_fail("#{match_start} RETURN n", true, neo_id: neo_id) # r.first_data
       end
     end
 
@@ -69,15 +69,15 @@ module Neo4j::Server
     end
 
     def get_property(key)
-      @session._query_or_fail("#{match_start} RETURN n.`#{key}`", true)
+      @session._query_or_fail("#{match_start} RETURN n.`#{key}`", true, neo_id: neo_id )
     end
 
     def set_property(key,value)
-      @session._query_or_fail("#{match_start} SET n.`#{key}` = {value}", false, {value: value})
+      @session._query_or_fail("#{match_start} SET n.`#{key}` = {value}", false, { value: value, neo_id: neo_id })
     end
 
     def remove_property(key)
-      @session._query_or_fail("#{match_start} REMOVE n.`#{key}`")
+      @session._query_or_fail("#{match_start} REMOVE n.`#{key}`", false, neo_id: neo_id)
     end
 
     # (see Neo4j::Relationship#props)
@@ -85,14 +85,14 @@ module Neo4j::Server
       if @props
         @props
       else
-        hash = @session._query_entity_data("#{match_start} RETURN n")
+        hash = @session._query_entity_data("#{match_start} RETURN n", nil, neo_id: neo_id)
         @props = Hash[hash['data'].map{ |k, v| [k.to_sym, v] }]
       end
     end
 
     # (see Neo4j::Relationship#props=)
     def props=(properties)
-      @session._query_or_fail("#{match_start} SET n = { props }", false, {props: properties})
+      @session._query_or_fail("#{match_start} SET n = { props }", false, { props: properties, neo_id: neo_id })
       properties
     end
 
@@ -102,7 +102,7 @@ module Neo4j::Server
       q = "#{match_start} SET " + properties.keys.map do |k|
         "n.`#{k}`= #{escape_value(properties[k])}"
       end.join(',')
-      @session._query_or_fail(q)
+      @session._query_or_fail(q, false, neo_id: neo_id)
       properties
     end
 
@@ -111,13 +111,13 @@ module Neo4j::Server
     end
 
     def del
-      @session._query("#{match_start} DELETE n").raise_unless_response_code(200)
+      @session._query("#{match_start} DELETE n", neo_id: neo_id).raise_unless_response_code(200)
     end
     alias_method :delete, :del
     alias_method :destroy, :del
 
     def exist?
-      response = @session._query("#{match_start} RETURN n")
+      response = @session._query("#{match_start} RETURN n", neo_id: neo_id)
       # binding.pry
       (response.data.nil? || response.data.empty?) ? false : true
     end
@@ -125,7 +125,7 @@ module Neo4j::Server
     private
 
     def match_start(identifier = 'n')
-      "MATCH (node)-[#{identifier}]-() WHERE ID(#{identifier}) = #{neo_id}"
+      "MATCH (node)-[#{identifier}]-() WHERE ID(#{identifier}) = {neo_id}"
     end
   end
 end

data/lib/neo4j-server/cypher_session.rb

@@ -56,7 +56,7 @@ module Neo4j::Server
 
     def self.establish_session(root_data, connection, auth_obj)
       data_url = root_data['data']
-      data_url << '/' unless data_url.end_with?('/')
+      data_url << '/' unless data_url.nil? || data_url.end_with?('/')
       CypherSession.new(data_url, connection, auth_obj)
     end
 
@@ -196,13 +196,13 @@ module Neo4j::Server
       single_row ? response.first_data : response
     end
 
-    def _query_entity_data(q, id=nil)
-      response = _query(q)
+    def _query_entity_data(q, id = nil, params = nil)
+      response = _query(q, params)
       response.raise_error if response.error?
       response.entity_data(id)
     end
 
-    def _query(q, params=nil)
+    def _query(q, params = nil)
       curr_tx = Neo4j::Transaction.current
       if (curr_tx)
         curr_tx._query(q, params)

data/neo4j-core.gemspec

@@ -6,13 +6,12 @@ require 'neo4j-core/version'
 Gem::Specification.new do |s|
   s.name     = "neo4j-core"
   s.version  = Neo4j::Core::VERSION
-  s.required_ruby_version = ">= 1.8.7"
+  s.required_ruby_version = ">= 1.9.3"
 
-  s.authors  = "Andreas Ronge"
-  s.email    = 'andreas.ronge@gmail.com'
+  s.authors  = "Andreas Ronge, Chris Grigg, Brian Underwood"
+  s.email    = 'andreas.ronge@gmail.com, chris@subvertallmedia.com, brian@brian-underwood.codes'
   s.homepage = "https://github.com/neo4jrb/neo4j-core"
-  s.rubyforge_project = 'neo4j-core'
-  s.summary = "A graph database for Ruby"
+  s.summary = "A basic library to work with the graph database Neo4j."
   s.license = 'MIT'
 
   s.description = <<-EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j-core
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
-- Andreas Ronge
+- Andreas Ronge, Chris Grigg, Brian Underwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2014-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -138,7 +138,7 @@ dependencies:
         version: '0'
 description: |
   Neo4j-core provides classes and methods to work with the graph database Neo4j.
-email: andreas.ronge@gmail.com
+email: andreas.ronge@gmail.com, chris@subvertallmedia.com, brian@brian-underwood.codes
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -208,17 +208,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: neo4j-core
-rubygems_version: 2.4.3
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: A graph database for Ruby
+summary: A basic library to work with the graph database Neo4j.
 test_files: []
 has_rdoc: true