ashikawa-core 0.6.0 → 0.7.0

data/lib/ashikawa-core/edge.rb

@@ -0,0 +1,50 @@
+require 'ashikawa-core/document'
+
+module Ashikawa
+  module Core
+    # A certain Edge within a certain Collection
+    class Edge < Document
+      # The ID of the 'from' document
+      #
+      # @return [String]
+      # @api public
+      # @example Get the ID for the 'from' Document
+      #   document = Ashikawa::Core::Edge.new(database, raw_document)
+      #   document.from_id # => "my_fancy_collection/2345678"
+      attr_reader :from_id
+
+      # The ID of the 'to' document
+      #
+      # @return [String]
+      # @api public
+      # @example Get the ID for the 'to' Document
+      #   document = Ashikawa::Core::Edge.new(database, raw_document)
+      #   document.to_id # => "my_fancy_collection/2345678"
+      attr_reader :to_id
+
+      # Initialize an Edge with the database and raw data
+      #
+      # @param [Database] database
+      # @param [Hash] raw_edge
+      # @api public
+      # @example Create an Edge
+      #   document = Ashikawa::Core::Edge.new(database, raw_edge)
+      def initialize(database, raw_edge)
+        @from_id = raw_edge["_from"]
+        @to_id = raw_edge["_to"]
+        super(database, raw_edge)
+      end
+
+      protected
+
+      # Send a request for this edge with the given opts
+      #
+      # @param [Hash] opts Options for this request
+      # @return [Hash] The parsed response from the server
+      # @api private
+      def send_request_for_document(opts = {})
+        @database.send_request("edge/#{@id}", opts)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require "ashikawa-core/exceptions/client_error.rb"
+
+module Ashikawa
+  module Core
+    # This exception is thrown when the client used bad syntax in a request
+    class BadSyntax < ClientError
+      # Create a new instance
+      #
+      # @return RuntimeError
+      # @api private
+      def initialize
+        super(400)
+      end
+
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        "Status 400: The syntax of the request was bad"
+      end
+    end
+  end
+end

data/lib/ashikawa-core/exceptions/{collection_not_found.rb → client_error/resource_not_found/collection_not_found.rb}

@@ -1,8 +1,10 @@
+require "ashikawa-core/exceptions/client_error/resource_not_found"
+
 module Ashikawa
   module Core
     # This Exception is thrown when a document was requested from
     # the server that does not exist.
-    class CollectionNotFoundException < RuntimeError
+    class CollectionNotFoundException < ResourceNotFound
       # String representation of the exception
       #
       # @return String

data/lib/ashikawa-core/exceptions/{document_not_found.rb → client_error/resource_not_found/document_not_found.rb}

@@ -1,8 +1,10 @@
+require "ashikawa-core/exceptions/client_error/resource_not_found"
+
 module Ashikawa
   module Core
     # This Exception is thrown when a document was requested from
     # the server that does not exist.
-    class DocumentNotFoundException < RuntimeError
+    class DocumentNotFoundException < ResourceNotFound
       # String representation of the exception
       #
       # @return String

data/lib/ashikawa-core/exceptions/{index_not_found.rb → client_error/resource_not_found/index_not_found.rb}

@@ -1,8 +1,10 @@
+require "ashikawa-core/exceptions/client_error/resource_not_found"
+
 module Ashikawa
   module Core
     # This Exception is thrown when an index was requested from
     # the server that does not exist.
-    class IndexNotFoundException < RuntimeError
+    class IndexNotFoundException < ResourceNotFound
       # String representation of the exception
       #
       # @return String

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

@@ -0,0 +1,25 @@
+require "ashikawa-core/exceptions/client_error.rb"
+
+module Ashikawa
+  module Core
+    # This Exception is thrown when you request
+    # a resource that does not exist on the server
+    class ResourceNotFound < ClientError
+      # Create a new instance
+      #
+      # @return RuntimeError
+      # @api private
+      def initialize
+        super(404)
+      end
+
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        "Status 404: The Resource you requested was not found on the server"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Ashikawa
+  module Core
+    # The client had an error in the request
+    class ClientError < RuntimeError
+      # Create a new instance
+      #
+      # @param [Integer] status
+      # @return RuntimeError
+      # @api private
+      def initialize(status)
+        @status = status
+      end
+
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        "Status #{@status}: An Error occured in the client"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require "ashikawa-core/exceptions/server_error"
+
+module Ashikawa
+  module Core
+    # This Exception is thrown when the Json
+    # from the server was malformed
+    class JsonError < ServerError
+      # Create a new instance
+      #
+      # @return RuntimeError
+      # @api private
+      def initialize
+        super(nil)
+      end
+
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        "Either the JSON from the server was malformed or the content type incorrect"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Ashikawa
+  module Core
+    # The server had an error during the request
+    class ServerError < RuntimeError
+      # Create a new instance
+      #
+      # @param [Integer] status
+      # @return RuntimeError
+      # @api private
+      def initialize(status)
+        @status = status
+      end
+
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        "Status #{@status}: An Error occured on the server"
+      end
+    end
+  end
+end

data/lib/ashikawa-core/figure.rb

@@ -10,8 +10,10 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       def initialize(raw_figure)
         @datafiles = raw_figure["datafiles"]
-        @alive = raw_figure["alive"]
-        @dead = raw_figure["dead"]
+        @alive     = raw_figure["alive"]
+        @dead      = raw_figure["dead"]
+        @shapes    = raw_figure["shapes"]
+        @journals  = raw_figure["journals"]
       end
 
       # The number of active datafiles
@@ -25,6 +27,17 @@ module Ashikawa
         @datafiles["count"]
       end
 
+      # The file size of datafiles
+      #
+      # @return Fixnum
+      # @api public
+      # @example Get the file size of datafiles
+      #   figure = Ashikawa::Core::Figure.new(raw_figure)
+      #   figure.datafile_size #=> 1337
+      def datafiles_file_size
+        @datafiles["fileSize"]
+      end
+
       # The total size in bytes used by all living documents
       #
       # @return Fixnum
@@ -68,6 +81,50 @@ module Ashikawa
       def dead_count
         @dead["count"]
       end
+
+      # The total number of shapes used in the collection
+      #
+      # @return Fixnum
+      # @api public
+      # @example Get the number of shapes
+      #   figure = Ashikawa::Core::Figure.new(raw_figure)
+      #   figure.shapes_count #=> 1337
+      def shapes_count
+        @shapes["count"]
+      end
+
+      # The number of deletion markers
+      #
+      # @return Fixnum
+      # @api public
+      # @example Get the number of deletion markers
+      #   figure = Ashikawa::Core::Figure.new(raw_figure)
+      #   figure.dead_deletion #=> 1337
+      def dead_deletion
+        @dead["deletion"]
+      end
+
+      # The number of journals
+      #
+      # @return Fixnum
+      # @api public
+      # @example Get the number of journals
+      #   figure = Ashikawa::Core::Figure.new(raw_figure)
+      #   figure.journal_count #=> 1337
+      def journals_count
+        @journals["count"]
+      end
+
+      # The file size of journals
+      #
+      # @return Fixnum
+      # @api public
+      # @example Get the file size of journals
+      #   figure = Ashikawa::Core::Figure.new(raw_figure)
+      #   figure.journal_size #=> 1337
+      def journals_file_size
+        @journals["fileSize"]
+      end
     end
   end
 end

data/lib/ashikawa-core/index.rb

@@ -3,6 +3,7 @@ module Ashikawa
     # An index on a certain collection
     class Index
       # The fields the index is defined on as symbols
+      #
       # @return [Array<Symbol>]
       # @api public
       # @example Get the fields the index is set on
@@ -11,6 +12,7 @@ module Ashikawa
       attr_reader :on
 
       # The type of index as a symbol
+      #
       # @return [Symbol]
       # @api public
       # @example Get the type of the index
@@ -19,6 +21,7 @@ module Ashikawa
       attr_reader :type
 
       # Is the unique constraint set?
+      #
       # @return [Boolean]
       # @api public
       # @example Get the fields the index is set on
@@ -26,8 +29,9 @@ module Ashikawa
       #   index.unique #=> false
       attr_reader :unique
 
-      # The id of the index
-      # @return [Int]
+      # The ID of the index (includes a Collection prefix)
+      #
+      # @return [String]
       # @api public
       # @example Get the id of this index
       #   index = Ashikawa::Core::Index.new(collection, raw_index)
@@ -44,10 +48,7 @@ module Ashikawa
       #   index = Ashikawa::Core::Index.new(collection, raw_index)
       def initialize(collection, raw_index)
         @collection = collection
-        @id = raw_index["id"].split("/")[1].to_i if raw_index.has_key?("id")
-        @on = raw_index["fields"].map { |field| field.to_sym } if raw_index.has_key?("fields")
-        @type = raw_index["type"].to_sym if raw_index.has_key?("type")
-        @unique = raw_index["unique"] if raw_index.has_key?("unique")
+        parse_raw_index(raw_index)
       end
 
       # Remove the index from the collection
@@ -58,7 +59,22 @@ module Ashikawa
       #   index = Ashikawa::Core::Index.new(collection, raw_index)
       #   index.delete
       def delete
-        @collection.send_request("index/#{@collection.id}/#{@id}", :delete => {})
+        @collection.send_request("index/#{@id}", :delete => {})
+      end
+
+      private
+
+      # Parse information returned from the server
+      #
+      # @param [Hash] raw_index
+      # @return self
+      # @api private
+      def parse_raw_index(raw_index)
+        @id = raw_index["id"]
+        @on = raw_index["fields"].map { |field| field.to_sym } if raw_index.has_key?("fields")
+        @type = raw_index["type"].to_sym if raw_index.has_key?("type")
+        @unique = raw_index["unique"]
+        self
       end
     end
   end

data/lib/ashikawa-core/query.rb

@@ -1,9 +1,9 @@
 require 'ashikawa-core/cursor'
 require 'ashikawa-core/document'
 require 'ashikawa-core/exceptions/no_collection_provided'
+require 'ashikawa-core/exceptions/client_error/bad_syntax'
 require 'forwardable'
 require 'backports'
-require 'rest-client'
 
 module Ashikawa
   module Core
@@ -38,7 +38,7 @@ module Ashikawa
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.all # => #<Cursor id=33>
       def all(options={})
-        simple_query_request("/simple/all",
+        simple_query_request("simple/all",
           options,
           [:limit, :skip])
       end
@@ -56,7 +56,7 @@ module Ashikawa
       #   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",
+        simple_query_request("simple/by-example",
           { :example => example }.merge(options),
           [:limit, :skip, :example])
       end
@@ -71,7 +71,7 @@ module Ashikawa
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.first_example({ "color" => "red"}) # => #<Document id=2444 color="red">
       def first_example(example = {})
-        response = simple_query_request("/simple/first-example",
+        response = simple_query_request("simple/first-example",
           { :example => example },
           [:example])
         response.first
@@ -92,7 +92,7 @@ module Ashikawa
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.near(:latitude => 37.331693, :longitude => -122.030468)
       def near(options={})
-        simple_query_request("/simple/near",
+        simple_query_request("simple/near",
           options,
           [:latitude, :longitude, :distance, :skip, :limit, :geo])
       end
@@ -113,7 +113,7 @@ module Ashikawa
       #   query = Ashikawa::Core::Query.new(collection)
       #   query.within(:latitude => 37.331693, :longitude => -122.030468, :radius => 100)
       def within(options={})
-        simple_query_request("/simple/within",
+        simple_query_request("simple/within",
           options,
           [:latitude, :longitude, :radius, :distance, :skip, :limit, :geo])
       end
@@ -133,7 +133,7 @@ module Ashikawa
       #   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",
+        simple_query_request("simple/range",
           options,
           [:attribute, :left, :right, :closed, :limit, :skip])
       end
@@ -149,7 +149,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",
+        post_request("cursor",
           options.merge({ :query => query }),
           [:query, :count, :batch_size])
       end
@@ -163,8 +163,8 @@ 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 })
-      rescue RestClient::BadRequest
+        !!post_request("query", { :query => query })
+      rescue Ashikawa::Core::BadSyntax
         false
       end