ashikawa-core 0.7.2 → 0.8.0

data/lib/ashikawa-core/document.rb

@@ -1,9 +1,12 @@
 require 'ashikawa-core/exceptions/client_error/resource_not_found/document_not_found'
+require 'equalizer'
 
 module Ashikawa
   module Core
     # A certain Document within a certain Collection
     class Document
+      include Equalizer.new(:id, :revision)
+
       # The ID of the document (this includes the Collection prefix)
       #
       # @return [String]
@@ -52,7 +55,7 @@ module Ashikawa
       #   document = Ashikawa::Core::Document.new(database, raw_document)
       #   document.check_if_persisted!
       def check_if_persisted!
-        raise DocumentNotFoundException if @id.nil?
+        raise DocumentNotFoundException if @id == :not_persisted
       end
 
       # Get the value of an attribute of the document
@@ -99,9 +102,22 @@ module Ashikawa
       # @api public
       # @example Get the hash representation of a document
       #   document = Ashikawa::Core::Document.new(database, raw_document)
+      #   document.hash #=> { :name => "Lebowski", :occupation => "Not occupied" }
+      def hash
+        @content
+      end
+
+      # Convert the document into a hash
+      #
+      # @return [Hash]
+      # @api public
+      # @deprecated Use {#hash} instead.
+      # @example Get the hash representation of a document
+      #   document = Ashikawa::Core::Document.new(database, raw_document)
       #   document.to_hash #=> { :name => "Lebowski", :occupation => "Not occupied" }
       def to_hash
-        @content
+        warn "`to_hash` is deprecated, please use `hash`"
+        hash
       end
 
       # Save the changes to the database
@@ -112,11 +128,22 @@ module Ashikawa
       #   document = Ashikawa::Core::Document.new(database, raw_document)
       #   document['occupation'] = 'Not occupied'
       #   document.save
-      def save()
+      def save
         check_if_persisted!
         send_request_for_document(:put => @content)
       end
 
+      # Get a fresh version of this document from the database
+      #
+      # @return self
+      # @api public
+      # @example Refresh the document
+      #   document = Ashikawa::Core::Document.new(database, raw_document)
+      #   document.refresh!
+      def refresh!
+        parse_raw_document(send_request_for_document)
+      end
+
       protected
 
       # Parse information returned from the server
@@ -125,9 +152,9 @@ module Ashikawa
       # @return self
       # @api private
       def parse_raw_document(raw_document)
-        @id       = raw_document['_id']
+        @id       = raw_document['_id'] || :not_persisted
         @key      = raw_document['_key']
-        @revision = raw_document['_rev']
+        @revision = raw_document['_rev'] || :not_persisted
         @content  = raw_document.delete_if { |key, value| key.start_with?("_") }
         self
       end

data/lib/ashikawa-core/edge.rb

@@ -1,9 +1,12 @@
 require 'ashikawa-core/document'
+require 'equalizer'
 
 module Ashikawa
   module Core
     # A certain Edge within a certain Collection
     class Edge < Document
+      include Equalizer.new(:id, :revision, :from_id, :to_id)
+
       # The ID of the 'from' document
       #
       # @return [String]

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

@@ -7,8 +7,8 @@ module Ashikawa
       # @param [Integer] status
       # @return RuntimeError
       # @api private
-      def initialize(status)
-        @status = status
+      def initialize(description)
+        @description = description
       end
 
       # String representation of the exception
@@ -16,7 +16,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "Status #{@status}: An Error occured in the client"
+        @description
       end
     end
   end

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

@@ -7,8 +7,8 @@ module Ashikawa
       # @param [Integer] status
       # @return RuntimeError
       # @api private
-      def initialize(status)
-        @status = status
+      def initialize(description)
+        @description = description
       end
 
       # String representation of the exception
@@ -16,7 +16,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "Status #{@status}: An Error occured on the server"
+        @description
       end
     end
   end

data/lib/ashikawa-core/figure.rb

@@ -9,11 +9,12 @@ module Ashikawa
       # @example Create a new figure from a raw figure
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       def initialize(raw_figure)
-        @datafiles = raw_figure["datafiles"]
-        @alive     = raw_figure["alive"]
-        @dead      = raw_figure["dead"]
-        @shapes    = raw_figure["shapes"]
-        @journals  = raw_figure["journals"]
+        @datafiles  = raw_figure["datafiles"]
+        @alive      = raw_figure["alive"]
+        @dead       = raw_figure["dead"]
+        @shapes     = raw_figure["shapes"]
+        @journals   = raw_figure["journals"]
+        @attributes = raw_figure["attributes"]
       end
 
       # The number of active datafiles
@@ -125,6 +126,17 @@ module Ashikawa
       def journals_file_size
         @journals["fileSize"]
       end
+
+      # Number of different attributes that are or have been used in the collection
+      #
+      # @return Fixnum
+      # @api public
+      # @example Get the number of attributes
+      #   figure = Ashikawa::Core::Figure.new(raw_figure)
+      #   figure.attributes_count #=> 12
+      def attributes_count
+        @attributes["count"]
+      end
     end
   end
 end

data/lib/ashikawa-core/index.rb

@@ -1,7 +1,11 @@
+require 'equalizer'
+
 module Ashikawa
   module Core
     # An index on a certain collection
     class Index
+      include Equalizer.new(:id, :on, :type, :unique)
+
       # The fields the index is defined on as symbols
       #
       # @return [Array<Symbol>]

data/lib/ashikawa-core/key_options.rb

@@ -0,0 +1,54 @@
+module Ashikawa
+  module Core
+    # Options for controlling keys of a collection
+    class KeyOptions
+      # Either traditional or autoincrement
+      #
+      # @return Symbol
+      # @api public
+      # @example Get the type of the KeyOptions
+      #   keyOptions = KeyOptions.new({ :type => :autoincrement })
+      #   keyOptions.type # => :autoincrement
+      attr_reader :type
+
+      # A specific start value
+      #
+      # @return Integer
+      # @api public
+      # @example Get the type of the KeyOptions
+      #   keyOptions = KeyOptions.new({ :offset => 12 })
+      #   keyOptions.offset # => 12
+      attr_reader :offset
+
+      # Size of increment steps
+      #
+      # @return Integer
+      # @api public
+      # @example Get the type of the KeyOptions
+      #   keyOptions = KeyOptions.new({ :increment => 12 })
+      #   keyOptions.increment # => 12
+      attr_reader :increment
+
+      # Is the user allowed to set keys by him- or herself?
+      #
+      # @return Boolean
+      # @api public
+      # @example Get the type of the KeyOptions
+      #   keyOptions = KeyOptions.new({ :allowUserKeys => true })
+      #   keyOptions.allow_user_keys # => true
+      attr_reader :allow_user_keys
+
+      # Create a new KeyOptions object from the raw key options
+      #
+      # @api public
+      # @example Create a new KeyOptions object
+      #   KeyOptions.new({ :type => :autoincrement })
+      def initialize(raw_key_options)
+        @type = raw_key_options["type"]
+        @offset = raw_key_options["offset"]
+        @increment = raw_key_options["increment"]
+        @allow_user_keys = raw_key_options["allowUserKeys"]
+      end
+    end
+  end
+end

data/lib/ashikawa-core/query.rb

@@ -3,7 +3,6 @@ require 'ashikawa-core/document'
 require 'ashikawa-core/exceptions/no_collection_provided'
 require 'ashikawa-core/exceptions/client_error/bad_syntax'
 require 'forwardable'
-require 'backports'
 
 module Ashikawa
   module Core
@@ -11,6 +10,17 @@ module Ashikawa
     class Query
       extend Forwardable
 
+      ALLOWED_KEYS_FOR_PATH = {
+        "simple/all"           => [:limit, :skip, :collection],
+        "simple/by-example"    => [:limit, :skip, :example, :collection],
+        "simple/near"          => [:latitude, :longitude, :distance, :skip, :limit, :geo, :collection],
+        "simple/within"        => [:latitude, :longitude, :radius, :distance, :skip, :limit, :geo, :collection],
+        "simple/range"         => [:attribute, :left, :right, :closed, :limit, :skip, :collection],
+        "cursor"               => [:query, :count, :batch_size, :collection],
+        "query"                => [:query],
+        "simple/first-example" => [:example, :collection]
+      }
+
       # Delegate sending requests to the connection
       def_delegator :@connection, :send_request
 
@@ -37,10 +47,8 @@ module Ashikawa
       # @example Get an array with all documents
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.all # => #<Cursor id=33>
-      def all(options={})
-        simple_query_request("simple/all",
-          options,
-          [:limit, :skip])
+      def all(options = {})
+        simple_query_request("simple/all", options)
       end
 
       # Looks for documents in a collection which match the given criteria
@@ -55,10 +63,8 @@ module Ashikawa
       # @example Find all documents in a collection that are red
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.by_example({ "color" => "red" }, :options => { :limit => 1 }) #=> #<Cursor id=2444>
-      def by_example(example={}, options={})
-        simple_query_request("simple/by-example",
-          { :example => example }.merge(options),
-          [:limit, :skip, :example])
+      def by_example(example = {}, options = {})
+        simple_query_request("simple/by-example", { :example => example }.merge(options))
       end
 
       # Looks for one document in a collection which matches the given criteria
@@ -71,9 +77,9 @@ module Ashikawa
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.first_example({ "color" => "red"}) # => #<Document id=2444 color="red">
       def first_example(example = {})
-        simple_query_request("simple/first-example",
-          { :example => example },
-          [:example])
+        request = prepare_request("simple/first-example", { :example => example, :collection => collection.name })
+        response = send_request("simple/first-example", { :put => request })
+        Document.new(database, response["document"])
       end
 
       # Looks for documents in a collection based on location
@@ -90,10 +96,8 @@ module Ashikawa
       # @example Find all documents at Infinite Loop
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.near(:latitude => 37.331693, :longitude => -122.030468)
-      def near(options={})
-        simple_query_request("simple/near",
-          options,
-          [:latitude, :longitude, :distance, :skip, :limit, :geo])
+      def near(options = {})
+        simple_query_request("simple/near", options)
       end
 
       # Looks for documents in a collection within a radius
@@ -111,10 +115,8 @@ module Ashikawa
       # @example Find all documents within a radius of 100 to Infinite Loop
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.within(:latitude => 37.331693, :longitude => -122.030468, :radius => 100)
-      def within(options={})
-        simple_query_request("simple/within",
-          options,
-          [:latitude, :longitude, :radius, :distance, :skip, :limit, :geo])
+      def within(options = {})
+        simple_query_request("simple/within", options)
       end
 
       # Looks for documents in a collection with an attribute between two values
@@ -131,10 +133,8 @@ module Ashikawa
       # @example Find all documents within a radius of 100 to Infinite Loop
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.within(:latitude => 37.331693, :longitude => -122.030468, :radius => 100)
-      def in_range(options={})
-        simple_query_request("simple/range",
-          options,
-          [:attribute, :left, :right, :closed, :limit, :skip])
+      def in_range(options = {})
+        simple_query_request("simple/range", options)
       end
 
       # Send an AQL query to the database
@@ -148,9 +148,7 @@ module Ashikawa
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.execute("FOR u IN users LIMIT 2") # => #<Cursor id=33>
       def execute(query, options = {})
-        post_request("cursor",
-          options.merge({ :query => query }),
-          [:query, :count, :batch_size])
+        wrapped_request("cursor", :post, options.merge({ :query => query }))
       end
 
       # Test if an AQL query is valid
@@ -162,7 +160,7 @@ module Ashikawa
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.valid?("FOR u IN users LIMIT 2") # => true
       def valid?(query)
-        !!post_request("query", { :query => query })
+        !!wrapped_request("query", :post, { :query => query })
       rescue Ashikawa::Core::BadSyntax
         false
       end
@@ -192,71 +190,38 @@ module Ashikawa
       # @param [Array<Symbol>] allowed_keys
       # @return [Hash] The filtered Hash
       # @api private
-      def allowed_options(options, allowed_keys)
+      def prepare_request(path, options)
+        allowed_keys = ALLOWED_KEYS_FOR_PATH.fetch(path)
         options.keep_if { |key, _| allowed_keys.include?(key) }
-      end
-
-      # Transforms the keys into the required format
-      #
-      # @param [Hash] request_data
-      # @return [Hash] Cleaned request data
-      # @api private
-      def prepare_request_data(request_data)
-        Hash[request_data.map { |key, value|
+        Hash[options.map { |key, value|
           [key.to_s.gsub(/_(.)/) { $1.upcase }, value]
-        }].reject { |_, value| value.nil? }
+        }]
       end
 
       # Send a simple query to the server
       #
       # @param [String] path The path for the request
-      # @param [Hash] request_data The data send to the database
+      # @param [Hash] request The data send to the database
       # @param [Array<Symbol>] allowed_keys The keys allowed for this request
       # @return [String] Server response
       # @raise [NoCollectionProvidedException] If you provided a database, no collection
       # @api private
-      def simple_query_request(path, request_data, allowed_keys)
-        request_data = request_data.merge({ :collection => collection.name })
-        put_request(path,
-          request_data,
-          allowed_keys << :collection)
+      def simple_query_request(path, request)
+        wrapped_request(path, :put, request.merge({ :collection => collection.name }))
       end
 
       # Perform a wrapped request
       #
       # @param [String] path The path for the request
       # @param [Symbol] request_method The request method to perform
-      # @param [Hash] request_data The data send to the database
-      # @param [Array] allowed_keys Keys allowed in request_data, if nil: All keys are allowed
-      # @return [Cursor]
-      # @api private
-      def wrapped_request(path, request_method, request_data, allowed_keys)
-        request_data = allowed_options(request_data, allowed_keys) unless allowed_keys.nil?
-        request_data = prepare_request_data(request_data)
-        server_response = send_request(path, { request_method => request_data })
-        Cursor.new(database, server_response)
-      end
-
-      # Perform a wrapped put request
-      #
-      # @param [String] path The path for the request
-      # @param [Hash] request_data The data send to the database
-      # @param [Array] allowed_keys Keys allowed in request_data, if nil: All keys are allowed
-      # @return [Cursor]
-      # @api private
-      def put_request(path, request_data, allowed_keys = nil)
-        wrapped_request(path, :put, request_data, allowed_keys)
-      end
-
-      # Perform a wrapped post request
-      #
-      # @param [String] path The path for the request
-      # @param [Hash] request_data The data send to the database
-      # @param [Array] allowed_keys Keys allowed in request_data, if nil: All keys are allowed
+      # @param [Hash] request The data send to the database
+      # @param [Array] allowed_keys Keys allowed in request, if nil: All keys are allowed
       # @return [Cursor]
       # @api private
-      def post_request(path, request_data, allowed_keys = nil)
-        wrapped_request(path, :post, request_data, allowed_keys)
+      def wrapped_request(path, request_method, request)
+        request = prepare_request(path, request)
+        response = send_request(path, { request_method => request })
+        Cursor.new(database, response)
       end
     end
   end

data/lib/ashikawa-core/request_preprocessor.rb

@@ -1,5 +1,5 @@
 require "faraday"
-require "multi_json"
+require "json"
 
 module Ashikawa
   module Core
@@ -23,7 +23,7 @@ module Ashikawa
       # @api private
       def call(env)
         body = env[:body]
-        env[:body] = MultiJson.dump(body) if body
+        env[:body] = JSON.generate(body) if body
         log(env[:method], env[:url], body)
         @app.call(env)
       end