vagas-orientdb4r 0.5.2

data/lib/orientdb4r/rest/excon_node.rb

@@ -0,0 +1,115 @@
+require 'excon'
+
+module Orientdb4r
+
+  ###
+  # This class represents a single sever/node in the Distributed Multi-Master Architecture
+  # accessible view REST API and 'excon' library on the client side.
+  class ExconNode < RestNode
+
+    attr_accessor :proxy
+
+    def request(options) #:nodoc:
+      verify_options(options, {:user => :mandatory, :password => :mandatory, \
+          :uri => :mandatory, :method => :mandatory, :content_type => :optional, :data => :optional,
+          :no_session => :optional})
+
+      opts = options.clone # if not cloned we change original hash map that cannot be used more with load balancing
+
+      # Auth + Cookie + Content-Type
+      opts[:headers] = headers(opts)
+      opts.delete :user
+      opts.delete :password
+      use_session = !opts.delete(:no_session)
+
+      opts[:body] = opts[:data] if opts.include? :data # just other naming convention
+      opts.delete :data
+      opts[:path] = opts[:uri] if opts.include? :uri   # just other naming convention
+      opts.delete :uri
+
+      was_ok = false
+      begin
+        response = connection.request opts
+        was_ok = (2 == (response.status / 100))
+
+        # store session ID if received to reuse in next request
+        cookies = CGI::Cookie::parse(response.headers['Set-Cookie'])
+        sessid = cookies[SESSION_COOKIE_NAME][0]
+        if session_id != sessid and use_session
+          @session_id = sessid
+          Orientdb4r::logger.debug "new session id: #{session_id}"
+        end
+
+        def response.code
+          status
+        end
+
+      rescue Excon::Errors::SocketError
+        raise NodeError
+      end
+
+      # this is workaround for a strange behavior:
+      # excon delivered magic response status '1' when previous request was not 20x
+      unless was_ok
+        connection.reset
+        Orientdb4r::logger.debug 'response code not 20x -> connection reset'
+      end
+
+      response
+    end
+
+
+    def post_connect(user, password, http_response) #:nodoc:
+
+      cookies = CGI::Cookie::parse(http_response.headers['Set-Cookie'])
+      @session_id = cookies[SESSION_COOKIE_NAME][0]
+
+    end
+
+
+    def cleanup #:nodoc:
+      super
+      connection.reset
+      @connection = nil
+    end
+
+
+    # ---------------------------------------------------------- Assistant Stuff
+
+    private
+
+      ###
+      # Gets Excon connection.
+      def connection
+        return @connection unless @connection.nil?
+
+        options = {}
+        options[:proxy] = proxy unless proxy.nil?
+        options[:scheme], options[:host], options[:port]=url.scan(/(.*):\/\/(.*):([0-9]*)/).first
+
+        @connection ||= Excon::Connection.new(options)
+        #:read_timeout => self.class.read_timeout,
+        #:write_timeout => self.class.write_timeout,
+        #:connect_timeout => self.class.connect_timeout
+      end
+
+      ###
+      # Get request headers prepared with session ID and Basic Auth.
+      def headers(options)
+        rslt = {'Authorization' => basic_auth_header(options[:user], options[:password])}
+        rslt['Cookie'] = "#{SESSION_COOKIE_NAME}=#{session_id}" if !session_id.nil? and !options[:no_session]
+        rslt['Content-Type'] = options[:content_type] if options.include? :content_type
+        rslt['User-Agent'] = user_agent unless user_agent.nil?
+        rslt
+      end
+
+      ###
+      # Gets value of the Basic Auth header.
+      def basic_auth_header(user, password)
+        b64 = Base64.encode64("#{user}:#{password}").delete("\r\n")
+        "Basic #{b64}"
+      end
+
+  end
+
+end

data/lib/orientdb4r/rest/model.rb

@@ -0,0 +1,159 @@
+module Orientdb4r
+
+
+  ###
+  # Extends a Hash produced by JSON.parse.
+  module HashExtension
+
+    ###
+    # Gets an attribute value that has to be presented.
+    def get_mandatory_attribute(name)
+      key = name.to_s
+      raise ::ArgumentError, "unknown attribute, name=#{key}" unless self.include? key
+      self[key]
+    end
+
+  end
+
+
+  ###
+  # This module represents API to OrientDB's class.
+  module OClass
+
+    ###
+    # Gets name of the class.
+    def name
+      get_mandatory_attribute :name
+    end
+
+    ###
+    # Gets properties of the class.
+    # Returns nil for a class without properties.
+    def properties
+      self['properties']
+    end
+
+    ###
+    # Gets a property with the given name.
+    def property(name)
+      raise ArgumentError, 'no properties defined on class' if properties.nil?
+      props = properties.select { |i| i['name'] == name.to_s }
+      raise ::ArgumentError, "unknown property, name=#{name}" if props.empty?
+      raise ::ArgumentError, "too many properties found, name=#{name}" if props.size > 1 # just to be sure
+      props[0]
+    end
+
+    ###
+    # Gets the super-class.
+    def super_class
+      get_mandatory_attribute :superClass
+    end
+
+    ###
+    # Gets clusters of the class.
+    def clusters
+      get_mandatory_attribute :clusters
+    end
+
+    ###
+    # Gets the default cluster.
+    def default_cluster
+      get_mandatory_attribute :defaultCluster
+    end
+
+    ###
+    # Get flag whether the class is abstract.
+    def abstract?
+      get_mandatory_attribute :abstract
+    end
+
+  end
+
+
+  ###
+  # This module represents API to OrientDB's property.
+  module Property
+
+    ###
+    # Gets name of the property.
+    def name
+      get_mandatory_attribute :name
+    end
+
+    ###
+    # Gets type of the property.
+    def type
+      get_mandatory_attribute :type
+    end
+
+    ###
+    # Gets the 'mandatory' flag.
+    def mandatory
+      get_mandatory_attribute :mandatory
+    end
+
+    ###
+    # Gets the 'notNull' flag.
+    def not_null
+      get_mandatory_attribute :notNull
+    end
+
+    ###
+    # Gets the 'read-only' flag.
+    def read_only
+      get_mandatory_attribute :readonly
+    end
+
+    ###
+    # Gets linked class if the property is a link.
+    def linked_class
+      self['linkedClass']
+    end
+
+    ###
+    # Gets the minimal allowed value.
+    def min
+      self['min']
+    end
+
+    ###
+    # Gets the maximal allowed value.
+    def max
+      self['max']
+    end
+
+  end
+
+
+  ###
+  # This module represents API to document metadata.
+  module DocumentMetadata
+
+    ###
+    # Gets the document class.
+    def doc_class
+      self['@class']
+    end
+
+    ###
+    # Gets the document ID.
+    def doc_rid
+      @mixedin_rid = Rid.new(self['@rid']) if @mixedin_rid.nil?
+      @mixedin_rid
+    end
+
+    ###
+    # Gets the document version.
+    def doc_version
+      self['@version']
+    end
+
+    ###
+    # Gets the document type.
+    def doc_type
+      self['@type']
+    end
+
+  end
+
+end

data/lib/orientdb4r/rest/node.rb

@@ -0,0 +1,43 @@
+module Orientdb4r
+
+  ###
+  # This class represents a single sever/node in the Distributed Multi-Master Architecture
+  # accessible view REST API.
+  class RestNode < Node
+
+    # Name of cookie that represents a session.
+    SESSION_COOKIE_NAME = 'OSESSIONID'
+
+    attr_reader :ssl
+    # HTTP header 'User-Agent'
+    attr_accessor :user_agent
+
+    ###
+    # Constructor.
+    def initialize(host, port, ssl)
+      super(host, port)
+      raise ArgumentError, 'ssl flag cannot be blank' if blank?(ssl)
+      @ssl = ssl
+    end
+
+
+    def url #:nodoc:
+      "http#{'s' if ssl}://#{host}:#{port}"
+    end
+
+
+    # ----------------------------------------------------------- RestNode Stuff
+
+
+    ###
+    # Sends a HTTP request to the remote server.
+    # Use following if possible:
+    # * session_id
+    # * Keep-Alive (if possible)
+    def request(options)
+      raise NotImplementedError, 'this should be overridden by subclass'
+    end
+
+  end
+
+end

data/lib/orientdb4r/rest/restclient_node.rb

@@ -0,0 +1,77 @@
+require 'rest_client'
+
+module Orientdb4r
+
+  ###
+  # This class represents a single sever/node in the Distributed Multi-Master Architecture
+  # accessible via REST API and 'rest-client' library on the client side.
+  class RestClientNode < RestNode
+
+    def request(options) #:nodoc:
+      verify_options(options, {:user => :mandatory, :password => :mandatory, \
+          :uri => :mandatory, :method => :mandatory, :content_type => :optional, :data => :optional,
+          :no_session => :optional})
+
+      opts = options.clone # if not cloned we change original hash map that cannot be used more with load balancing
+
+      # URL
+      opts[:url] = "#{url}/#{opts[:uri]}"
+      opts.delete :uri
+
+      if content_type = opts.delete(:content_type)
+        opts[:headers] ||= {}
+        opts[:headers][:content_type] = content_type
+      end
+
+      # data
+      data = opts.delete :data
+      data = '' if data.nil? and :post == opts[:method] # POST has to have data
+      opts[:payload] = data unless data.nil?
+
+      # cookies
+      use_session = !opts.delete(:no_session)
+      opts[:cookies] = { SESSION_COOKIE_NAME => session_id} if use_session and !session_id.nil?
+      # headers
+      opts[:headers] = { 'User-Agent' => user_agent } unless user_agent.nil?
+
+      begin
+        response = ::RestClient::Request.new(opts).execute
+
+        # store session ID if received to reuse in next request
+        sessid = response.cookies[SESSION_COOKIE_NAME]
+        if sessid and session_id != sessid and use_session
+          @session_id = sessid
+          Orientdb4r::logger.debug "new session id: #{session_id}"
+        end
+
+      rescue Errno::ECONNREFUSED
+        raise NodeError
+      rescue ::RestClient::ServerBrokeConnection
+        raise NodeError
+      rescue ::RestClient::Exception => e
+        response = transform_error2_response(e)
+      end
+
+      response
+    end
+
+
+    private
+
+      ###
+      # Fakes an error thrown by the library into a response object with methods
+      # 'code' and 'body'.
+      def transform_error2_response(error)
+        response = ["#{error.message}: #{error.http_body}", error.http_code]
+        def response.body
+          self[0]
+        end
+        def response.code
+          self[1]
+        end
+        response
+      end
+
+  end
+
+end

data/lib/orientdb4r/rid.rb

@@ -0,0 +1,54 @@
+module Orientdb4r
+
+  ###
+  # This class represents encapsulation of RecordID.
+  class Rid
+    include Utils
+
+    # Format validation regexp.
+    RID_REGEXP_PATTERN = /^#?\d+:\d+$/
+
+    attr_reader :cluster_id, :document_id
+
+    ###
+    # Constructor.
+    def initialize(rid)
+      raise ArgumentError, 'RID cannot be blank' if blank? rid
+      raise ArgumentError, 'RID is not String' unless rid.is_a? String
+      raise ArgumentError, "bad RID format, rid=#{rid}" unless rid =~ RID_REGEXP_PATTERN
+
+      rid = rid[1..-1] if rid.start_with? '#'
+      ids = rid.split ':'
+      self.cluster_id = ids[0].to_i
+      self.document_id = ids[1].to_i
+    end
+
+    ###
+    # Setter fo cluster ID.
+    def cluster_id=(cid)
+      @cluster_id = cid.to_i
+    end
+
+    ###
+    # Setter fo document ID.
+    def document_id=(did)
+      @document_id = did.to_i
+    end
+
+    def to_s #:nodoc:
+      "##{cluster_id}:#{document_id}"
+    end
+
+    ###
+    # Gets RID's string representation with no prefix.
+    def unprefixed
+      "#{cluster_id}:#{document_id}"
+    end
+
+    def ==(another_rid) #:nodoc:
+      self.cluster_id == another_rid.cluster_id and self.document_id == another_rid.document_id
+    end
+
+  end
+
+end