ashikawa-core 0.1 → 0.2

data/lib/ashikawa-core/connection.rb

@@ -6,25 +6,25 @@ module Ashikawa
     # Represents a Connection via HTTP to a certain host
     class Connection
       # The IP of the connection
-      # 
+      #
       # @return [String]
       # @api public
       # @example Get the IP of the connection
       #   connection = Connection.new "http://localhost:8529"
       #   connection.ip # => "http://localhost"
       attr_reader :ip
-      
+
       # The port of the connection
-      # 
+      #
       # @return [Fixnum]
       # @api public
       # @example Get the port of the connection
       #   connection = Connection.new "http://localhost:8529"
       #   connection.port # => 8529
       attr_reader :port
-      
+
       # Initialize a Connection with a given API String
-      # 
+      #
       # @param [String] api_string IP and Port as a String
       # @api public
       # @example Create a new Connection
@@ -34,10 +34,10 @@ module Ashikawa
         @ip, @port = @api_string.scan(/(\S+):(\d+)/).first
         @port = @port.to_i
       end
-      
+
       # Sends a request to a given path (Prepends the api_string automatically)
-      # 
-      # @example get request 
+      #
+      # @example get request
       #   connection.send_request('/collection/new_collection')
       # @example post request
       #   connection.send_request('/collection/new_collection', :post => { :name => 'new_collection' })
@@ -47,22 +47,20 @@ module Ashikawa
       # @return [Hash] parsed JSON response from the server
       # @api semipublic
       def send_request(path, method_params = {})
-        path.gsub! /^\//, ''
-        
-        if method_params.has_key? :post
-          JSON.parse RestClient.post("#{@api_string}/_api/#{path}", method_params[:post].to_json )
+        path = "#{@api_string}/_api/#{path.gsub(/^\//, '')}"
+
+        answer = if method_params.has_key? :post
+          RestClient.post path, method_params[:post].to_json
         elsif method_params.has_key? :put
-          JSON.parse RestClient.put("#{@api_string}/_api/#{path}", method_params[:put].to_json )
+          RestClient.put path, method_params[:put].to_json
         elsif method_params.has_key? :delete
-          if method_params[:delete] = {}
-            JSON.parse RestClient.delete("#{@api_string}/_api/#{path}" )
-          else
-            JSON.parse RestClient.delete("#{@api_string}/_api/#{path}", method_params[:delete].to_json )
-          end
+          RestClient.delete path
         else
-          JSON.parse RestClient.get("#{@api_string}/_api/#{path}")
+          RestClient.get path
         end
+
+        JSON.parse answer
       end
     end
   end
-end
+end

data/lib/ashikawa-core/cursor.rb

@@ -0,0 +1,65 @@
+require 'ashikawa-core/document'
+
+module Ashikawa
+  module Core
+    # Represents a Cursor on a certain Database.
+    # It is an enumerable.
+    class Cursor
+      include Enumerable
+
+      # The ID of the cursor
+      # @return [Int]
+      # @api public
+      attr_reader :id
+
+      # The number of documents
+      # @return [Int]
+      # @api public
+      attr_reader :length
+
+      # Initialize a Cursor with the database and raw data
+      #
+      # @param [Database] database
+      # @param [Hash] raw_cursor
+      # @api public
+      def initialize(database, raw_cursor)
+        @database = database
+        @id       = raw_cursor['id'].to_i if raw_cursor.has_key? 'id'
+        @has_more = raw_cursor['hasMore']
+        @length   = raw_cursor['count'].to_i if raw_cursor.has_key? 'count'
+        @current  = raw_cursor['result']
+      end
+
+      # Iterate over the documents found by the cursor
+      #
+      # @yield [document]
+      # @api public
+      def each(&block)
+        begin
+          @current.each do |raw_document|
+            block.call Document.new(@database, raw_document)
+          end
+        end while next_batch
+      end
+
+      # Delete the cursor
+      def delete
+        @database.send_request "/cursor/#{@id}", delete: {}
+      end
+
+      private
+
+      # Get a new batch from the server
+      #
+      # @return [Boolean] Is there a next batch?
+      def next_batch
+        return @false unless @has_more
+        raw_cursor = @database.send_request "/cursor/#{@id}", put: {}
+        @id       = raw_cursor['id']
+        @has_more = raw_cursor['hasMore']
+        @length   = raw_cursor['count']
+        @current  = raw_cursor['result']
+      end
+    end
+  end
+end

data/lib/ashikawa-core/database.rb

@@ -1,12 +1,21 @@
 require "ashikawa-core/collection"
 require "ashikawa-core/connection"
+require "ashikawa-core/cursor"
+require "forwardable"
 
 module Ashikawa
   module Core
     # Represents an ArangoDB database in Ruby
     class Database
+      extend Forwardable
+
+      # Delegate sending requests and managing IP and port  to the connection
+      delegate send_request: :@connection
+      delegate ip:           :@connection
+      delegate port:         :@connection
+
       # Initializes the connection to the database
-      # 
+      #
       # @param [Connection, String] connection A Connection object or a String to create a Connection object.
       # @api public
       # @example Access a Database by providing the URL
@@ -21,31 +30,9 @@ module Ashikawa
           @connection = connection
         end
       end
-      
-      # The IP of the database
-      # 
-      # @return [String]
-      # @api public
-      # @example Get the IP of the connection
-      #   database = Ashikawa::Core::Database.new "http://localhost:8529"
-      #   database.ip # => http://localhost
-      def ip
-        @connection.ip
-      end
-      
-      # The Port of the database
-      # 
-      # @return [Fixnum]
-      # @api public
-      # @example Get the port for the connection
-      #   database = Ashikawa::Core::Database.new "http://localhost:8529"
-      #   database.port # => 8529
-      def port
-        @connection.port
-      end
-      
+
       # Returns a list of all collections defined in the database
-      # 
+      #
       # @return [Array<Collection>]
       # @api public
       # @example Get an Array containing the Collections in the database
@@ -54,12 +41,12 @@ module Ashikawa
       #   database["b"]
       #   database.collections # => [ #<Collection name="a">, #<Collection name="b">]
       def collections
-        server_response = @connection.send_request "/collection"
+        server_response = send_request "/collection"
         server_response["collections"].map { |collection| Ashikawa::Core::Collection.new self, collection }
       end
-      
+
       # Get or create a Collection based on name or ID
-      # 
+      #
       # @param [String, Fixnum] collection_identifier The name or ID of the collection
       # @return [Collection]
       # @api public
@@ -71,28 +58,28 @@ module Ashikawa
       #   database["7254820"] # => #<Collection id=7254820>
       def [](collection_identifier)
         begin
-          server_response = @connection.send_request "/collection/#{collection_identifier}"
+          server_response = send_request "/collection/#{collection_identifier}"
         rescue RestClient::ResourceNotFound
-          server_response = @connection.send_request "/collection", post: { name: collection_identifier }
+          server_response = send_request "/collection", post: { name: collection_identifier }
         end
-        
+
         Ashikawa::Core::Collection.new self, server_response
       end
-      
-      # Sends a request to a given path (Prepends the api_string automatically)
-      # 
-      # @example Send a get request to the database
-      #   connection.send_request('/collection/new_collection')
-      # @example Send a post request to the database
-      #   connection.send_request('/collection/new_collection', :post => { :name => 'new_collection' })
-      # @param [String] path the path you wish to send a request to.
-      # @param [Hash] method_params additional parameters for your request. Only needed if you want to send something other than a GET request.
-      # @option method_params [Hash] :post POST data in case you want to send a POST request.
-      # @return [Hash] parsed JSON response from the server
-      # @api semipublic
-      def send_request(path, method_params = {})
-        @connection.send_request path, method_params
+
+      # Send a query to the database
+      #
+      # @param [String] query
+      # @option opts [Integer] :count Should the number of results be counted?
+      # @option opts [Integer] :batch_size Set the number of results returned at once
+      def query(query, opts = {})
+        parameter = { query: query }
+
+        parameter[:count] = opts[:count] if opts.has_key? :count
+        parameter[:batchSize] = opts[:batch_size] if opts.has_key? :batch_size
+
+        server_response = send_request "/cursor", post: parameter
+        Cursor.new self, server_response
       end
     end
   end
-end
+end

data/lib/ashikawa-core/document.rb

@@ -1,37 +1,78 @@
+require 'ashikawa-core/exceptions/document_not_found'
+
 module Ashikawa
   module Core
     # Represents a certain Document within a certain Collection
     class Document
-      # The ID of the document including the Collection prefix
-      # 
-      # @return [String]
+      # The ID of the document without the Collection prefix
+      #
+      # @return [Int]
       # @api public
       # @example Get the ID for a Document
-      #   document = Ashikawa::Core::Document.new "1234567/2345678", "3456789"
-      #   document.id # => "1234567/2345678"
+      #   document = Ashikawa::Core::Document.new database, raw_document
+      #   document.id # => 2345678
       attr_reader :id
-      
+
       # The current revision of the document
-      # 
-      # @return [String]
+      #
+      # @return [Int]
       # @api public
       # @example Get the Revision for a Document
-      #   document = Ashikawa::Core::Document.new "1234567/2345678", "3456789"
-      #   document.revision # => "3456789"
+      #   document = Ashikawa::Core::Document.new database, raw_document
+      #   document.revision # => 3456789
       attr_reader :revision
-      
-      # Initialize a Document with an ID and revision
-      # 
-      # @param [String] id The complete ID including the Collection prefix
-      # @param [String] revision
+
+      # Initialize a Document with the database and raw data
+      #
+      # @param [Database] database
+      # @param [Hash] raw_document
       # @api public
-      # @example The Document 2345678 in the Collection 1234567 in revision 3456789
-      #   document = Ashikawa::Core::Document.new "1234567/2345678", "3456789"
-      def initialize(id, revision)
-        @id = id
-        @revision = revision
+      def initialize(database, raw_document)
+        @database = database
+        @is_persistent = raw_document.has_key?('_id') and raw_document.has_key?('rev')
+
+        if @is_persistent
+          @collection_id, @id = raw_document['_id'].split('/').map { |id| id.to_i }
+          @revision = raw_document['_rev'].to_i
+        end
+
+        @content = raw_document.delete_if { |key, value| key[0] == "_" }
+      end
+
+      # Get the value of an attribute of the document
+      #
+      # @param [String] attribute_name
+      # @api public
+      # @return [Object] The value of the attribute
+      def [](attribute_name)
+        @content[attribute_name]
+      end
+
+      # Remove the document from the database
+      #
+      # @api public
+      def delete
+        raise DocumentNotFoundException unless @is_persistent
+        @database.send_request "document/#{@collection_id}/#{@id}", delete: {}
+      end
+
+      # Update the value of an attribute (Does not write to database)
+      #
+      # @param [String] attribute_name
+      # @param [Object] value
+      # @api public
+      def []=(attribute_name, value)
+        raise DocumentNotFoundException unless @is_persistent
+        @content[attribute_name] = value
+      end
+
+      # Save the changes to the database
+      #
+      # @api public
+      def save()
+        raise DocumentNotFoundException unless @is_persistent
+        @database.send_request "document/#{@collection_id}/#{@id}", put: @content
       end
-      
     end
   end
-end
+end

data/lib/ashikawa-core/exceptions/document_not_found.rb

@@ -0,0 +1,8 @@
+module Ashikawa
+  module Core
+    # This Exception is thrown, when a document was requested from
+    # the server that does not exist.
+    class DocumentNotFoundException < RuntimeError
+    end
+  end
+end

data/lib/ashikawa-core/index.rb

@@ -0,0 +1,47 @@
+module Ashikawa
+  module Core
+    # Represents an index on a certain collection
+    class Index
+      # The fields the index is defined on as symbols
+      # @return [Array<Symbol>]
+      # @api public
+      attr_reader :on
+
+      # The type of index as a symbol
+      # @return [Symbol]
+      # @api public
+      attr_reader :type
+
+      # Is the unique constraint set?
+      # @return [Boolean]
+      # @api public
+      attr_reader :unique
+
+      # The id of the index
+      # @return [Int]
+      # @api public
+      attr_reader :id
+
+      # Create a new Index
+      #
+      # @param [Collection] collection The collection the index is defined on
+      # @param [Hash] raw_data The JSON representation of the index
+      # @return [Index]
+      # @api
+      def initialize(collection, raw_data)
+        @collection = collection
+        @id = raw_data["id"].split("/")[1].to_i if raw_data["id"]
+        @on = raw_data["fields"].map { |field| field.to_sym } if raw_data.has_key? "fields"
+        @type = raw_data["type"].to_sym if raw_data.has_key? "type"
+        @unique = raw_data["unique"] if raw_data.has_key? "unique"
+      end
+
+      # Remove the index from the collection
+      #
+      # @api public
+      def delete
+        @collection.send_request("index/#{@collection.id}/#{@id}", delete: {})
+      end
+    end
+  end
+end

data/lib/ashikawa-core/version.rb

@@ -1,6 +1,6 @@
 module Ashikawa
   module Core
     # Current version of Ashikawa::Core
-    VERSION = "0.1"
+    VERSION = "0.2"
   end
 end

data/spec/fixtures/cursor/26011191-2.json

@@ -0,0 +1,19 @@
+{
+  "hasMore": true,
+  "error": false,
+  "id": 26011191,
+  "result": [
+    {
+      "n": 2,
+      "_rev": 25880119,
+      "_id": "23914039/25880119"
+    },
+    {
+      "n": 3,
+      "_rev": 25880119,
+      "_id": "23914039/25880119"
+    }
+  ],
+  "code": 200,
+  "count": 5
+}