ashikawa-core 0.6.0 → 0.7.0

data/lib/ashikawa-core/request_preprocessor.rb

@@ -0,0 +1,49 @@
+require "faraday"
+require "multi_json"
+
+module Ashikawa
+  module Core
+    # Preprocessor for Faraday Requests
+    class RequestPreprocessor < Faraday::Middleware
+      # Create a new Request Preprocessor
+      #
+      # @param [Object] app Faraday internal
+      # @param [Object] logger The object you want to log to
+      # @return [RequestPreprocessor]
+      # @api private
+      def initialize(app, logger)
+        @app = app
+        @logger = logger
+      end
+
+      # Process a Request
+      #
+      # @param [Hash] env Environment info
+      # @return [Object]
+      # @api private
+      def call(env)
+        body = env[:body]
+        env[:body] = MultiJson.dump(body) if body
+        log(env[:method], env[:url], body)
+        @app.call(env)
+      end
+
+      private
+
+      # Log a Request
+      #
+      # @param [Symbol] method
+      # @param [String] url
+      # @param [String] body
+      # @return [nil]
+      # @api private
+      def log(method, url, body)
+        @logger.info("#{method.upcase} #{url} #{body}")
+        nil
+      end
+    end
+
+    Faraday.register_middleware :request,
+      :ashikawa_request => lambda { RequestPreprocessor}
+  end
+end

data/lib/ashikawa-core/response_preprocessor.rb

@@ -0,0 +1,111 @@
+require "faraday"
+require "multi_json"
+require "ashikawa-core/exceptions/client_error"
+require "ashikawa-core/exceptions/client_error/resource_not_found"
+require "ashikawa-core/exceptions/client_error/resource_not_found/index_not_found"
+require "ashikawa-core/exceptions/client_error/resource_not_found/document_not_found"
+require "ashikawa-core/exceptions/client_error/resource_not_found/collection_not_found"
+require "ashikawa-core/exceptions/client_error/bad_syntax"
+require "ashikawa-core/exceptions/server_error"
+require "ashikawa-core/exceptions/server_error/json_error"
+
+module Ashikawa
+  module Core
+    # Preprocessor for Faraday Requests
+    class ResponsePreprocessor < Faraday::Middleware
+      ClientErrorStatuses = 400...499
+      ServerErrorStatuses = 500...599
+      BadSyntaxStatus = 400
+      ResourceNotFoundErrorError = 404
+
+      # Create a new Response Preprocessor
+      #
+      # @param [Object] app Faraday internal
+      # @param [Object] logger The object you want to log to
+      # @return [ResponsePreprocessor]
+      # @api private
+      def initialize(app, logger)
+        @app = app
+        @logger = logger
+      end
+
+      # Process a Response
+      #
+      # @param [Hash] env Environment info
+      # @return [Object]
+      # @api private
+      def call(env)
+        @app.call(env).on_complete do
+          log(env)
+          handle_status(env)
+          env[:body] = parse_json(env)
+        end
+      end
+
+      private
+
+      # Raise the fitting ResourceNotFoundException
+      #
+      # @raise [DocumentNotFoundException, CollectionNotFoundException, IndexNotFoundException]
+      # @return nil
+      # @api private
+      def resource_not_found_for(env)
+        raise case env[:url].path
+          when /\A\/_api\/document/ then Ashikawa::Core::DocumentNotFoundException
+          when /\A\/_api\/collection/ then Ashikawa::Core::CollectionNotFoundException
+          when /\A\/_api\/index/ then Ashikawa::Core::IndexNotFoundException
+          else Ashikawa::Core::ResourceNotFound
+        end
+      end
+
+      # Parse the JSON
+      #
+      # @param [Hash] env Environment info
+      # @return [Hash] The parsed body
+      # @api private
+      def parse_json(env)
+        raise MultiJson::LoadError unless json_content_type?(env[:response_headers]["content-type"])
+        MultiJson.load(env[:body])
+      rescue MultiJson::LoadError
+        raise Ashikawa::Core::JsonError
+      end
+
+      # Check if the Content Type is JSON
+      #
+      # @param [String] content_type
+      # @return [Boolean]
+      # @api private
+      def json_content_type?(content_type)
+        content_type == "application/json; charset=utf-8"
+      end
+
+      # Handle the status code
+      #
+      # @param [Hash] env Environment info
+      # @return [nil]
+      # @api private
+      def handle_status(env)
+        status = env[:status]
+        case status
+        when BadSyntaxStatus then raise Ashikawa::Core::BadSyntax
+        when ResourceNotFoundErrorError then raise resource_not_found_for(env)
+        when ClientErrorStatuses then raise Ashikawa::Core::ClientError, status
+        when ServerErrorStatuses then raise Ashikawa::Core::ServerError, status
+        end
+      end
+
+      # Log a Request
+      #
+      # @param [Hash] env Environment info
+      # @return [nil]
+      # @api private
+      def log(env)
+        @logger.info("#{env[:status]} #{env[:body]}")
+        nil
+      end
+    end
+
+    Faraday.register_middleware :response,
+      :ashikawa_response => lambda { ResponsePreprocessor}
+  end
+end

data/lib/ashikawa-core/version.rb

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

data/lib/ashikawa-core.rb

@@ -3,7 +3,6 @@ require "ashikawa-core/connection"
 require "ashikawa-core/database"
 require "ashikawa-core/document"
 require "ashikawa-core/version"
-require "ashikawa-core/exceptions/document_not_found"
 
 # Ashikawa is a project dedicated to connect Ruby and ArangoDB
 module Ashikawa

data/spec/acceptance/basic_spec.rb

@@ -1,10 +1,12 @@
 require 'acceptance/spec_helper'
 
 describe "Basics" do
-  subject { ARANGO_HOST }
-
-  describe "initialized database" do
-    subject { Ashikawa::Core::Database.new ARANGO_HOST }
+  describe "for an initialized database" do
+    subject {
+      Ashikawa::Core::Database.new do |config|
+        config.url = ARANGO_HOST
+      end
+    }
 
     after :each do
       subject.collections.each { |collection| collection.delete }
@@ -17,7 +19,7 @@ describe "Basics" do
     end
 
     it "should create and delete collections" do
-      subject.collections.should == []
+      subject.collections.each { |collection| collection.delete }
       subject["collection_1"]
       subject["collection_2"]
       subject["collection_3"]
@@ -26,6 +28,21 @@ describe "Basics" do
       subject.collections.length.should == 2
     end
 
+    it "should create a non-volatile collection by default" do
+      subject.create_collection("nonvolatile_collection")
+      subject["nonvolatile_collection"].volatile?.should be_false
+    end
+
+    it "should create a volatile collection" do
+      subject.create_collection("volatile_collection", :is_volatile => true)
+      subject["volatile_collection"].volatile?.should be_true
+    end
+
+    it "should be possible to create an edge collection" do
+      subject.create_collection("edge_collection", :content_type => :edge)
+      subject["edge_collection"].content_type.should == :edge
+    end
+
     it "should be possible to change the name of a collection" do
       my_collection = subject["test_collection"]
       my_collection.name.should == "test_collection"
@@ -49,11 +66,16 @@ describe "Basics" do
 
     it "should be possible to get figures" do
       my_collection = subject["test_collection"]
-      my_collection.figure.datafiles_count.class.should == Fixnum
       my_collection.figure.alive_size.class.should == Fixnum
       my_collection.figure.alive_count.class.should == Fixnum
       my_collection.figure.dead_size.class.should == Fixnum
       my_collection.figure.dead_count.class.should == Fixnum
+      my_collection.figure.dead_deletion.class.should == Fixnum
+      my_collection.figure.datafiles_count.class.should == Fixnum
+      my_collection.figure.datafiles_file_size.class.should == Fixnum
+      my_collection.figure.journals_count.class.should == Fixnum
+      my_collection.figure.journals_file_size.class.should == Fixnum
+      my_collection.figure.shapes_count.class.should == Fixnum
     end
 
     it "should change and receive information about waiting for sync" do
@@ -77,44 +99,61 @@ describe "Basics" do
     it "should be possible to update the attributes of a document" do
       collection = subject["documenttests"]
 
-      document = collection.create :name => "The Dude", :bowling => true
-      document_id = document.id
+      document = collection.create_document(:name => "The Dude", :bowling => true)
+      document_key = document.key
       document["name"] = "Other Dude"
       document.save
 
-      collection[document_id]["name"].should == "Other Dude"
+      collection[document_key]["name"].should == "Other Dude"
     end
 
     it "should be possible to access and create documents from a collection" do
       collection = subject["documenttests"]
 
-      document = collection.create :name => "The Dude", :bowling => true
-      document_id = document.id
-      collection[document_id]["name"].should == "The Dude"
+      document = collection.create_document(:name => "The Dude", :bowling => true)
+      document_key = document.key
+      collection[document_key]["name"].should == "The Dude"
+
+      collection[document_key] = { :name => "Other Dude", :bowling => true }
+      collection[document_key]["name"].should == "Other Dude"
+    end
+
+    it "should be possible to create an edge between two documents" do
+      nodes = subject.create_collection("nodecollection")
+      edges = subject.create_collection("edgecollection", :content_type => :edge)
+
+      a = nodes.create_document({:name => "a"})
+      b = nodes.create_document({:name => "b"})
+      e = edges.create_edge(a, b, {:name => "fance_edge"})
 
-      collection[document_id] = { :name => "Other Dude", :bowling => true }
-      collection[document_id]["name"].should == "Other Dude"
+      e = edges[e.key]
+      e.from_id.should == a.id
+      e.to_id.should == b.id
     end
   end
 
-  describe "created document" do
-    let(:database) { Ashikawa::Core::Database.new ARANGO_HOST }
+  describe "for a created document" do
+    let(:database) {
+      Ashikawa::Core::Database.new do |config|
+        config.url = ARANGO_HOST
+      end
+    }
     let(:collection) { database["documenttests"] }
-    subject { collection.create :name => "The Dude" }
-    let(:document_id) { subject.id }
+    subject { collection.create_document(:name => "The Dude") }
+    let(:document_key) { subject.key }
 
     it "should be possible to manipulate documents and save them" do
       subject["name"] = "Jeffrey Lebowski"
       subject["name"].should == "Jeffrey Lebowski"
-      collection[document_id]["name"].should == "The Dude"
+      collection[document_key]["name"].should == "The Dude"
       subject.save
-      collection[document_id]["name"].should == "Jeffrey Lebowski"
+      collection[document_key]["name"].should == "Jeffrey Lebowski"
     end
 
     it "should be possible to delete a document" do
-      collection[document_id].delete
+      collection[document_key].delete
       expect {
-        collection[document_id]
+        collection[document_key]
       }.to raise_exception Ashikawa::Core::DocumentNotFoundException
     end
 

data/spec/acceptance/index_spec.rb

@@ -1,9 +1,12 @@
 require 'acceptance/spec_helper'
 
 describe "Indices" do
-  let(:database) { Ashikawa::Core::Database.new ARANGO_HOST }
+  let(:database) { Ashikawa::Core::Database.new do |config|
+      config.url = ARANGO_HOST
+    end
+  }
   subject { database["documenttest"] }
-  let(:index) { subject.add_index :skiplist, :on => [:identifier] }
+  let(:index) { subject.add_index(:skiplist, :on => [:identifier]) }
 
   it "should be possible to set indices" do
     index.delete
@@ -14,15 +17,19 @@ describe "Indices" do
   end
 
   it "should be possible to get an index by ID" do
-    subject.index(index.id).id.should == index.id
+    # This is temporary until Index has a key
+    index_key = index.id.split('/')[1]
+
+    subject.index(index_key).id.should == index.id
     subject.indices[0].class.should == Ashikawa::Core::Index
   end
 
   it "should be possible to remove indices" do
-    pending "Delete doesn't work at random"
+    pending "See Bug #34"
 
     expect {
       index.delete
+      sleep(1) # from time to time it may fail because of threading
     }.to change { subject.indices.length }.by(-1)
   end
 end

data/spec/acceptance/query_spec.rb

@@ -1,7 +1,10 @@
 require 'acceptance/spec_helper'
 
 describe "Queries" do
-  let(:database) { Ashikawa::Core::Database.new ARANGO_HOST }
+  let(:database) { Ashikawa::Core::Database.new do |config|
+      config.url = ARANGO_HOST
+    end
+  }
   let(:collection) { database["my_collection"] }
 
   describe "AQL query via the database" do

data/spec/acceptance/spec_helper.rb

@@ -1,8 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
-require "rest-client"
-require "json"
 require "ashikawa-core"
 
 ARANGO_HOST = "http://localhost:8529"

data/spec/acceptance_auth/spec_helper.rb

@@ -1,8 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
-require "rest-client"
-require "json"
 require "ashikawa-core"
 
 ARANGO_HOST = "http://localhost:8529"

data/spec/fixtures/collections/60768679-count.json

@@ -0,0 +1,13 @@
+{
+  "id": "6076879",
+  "name": "example_1",
+  "waitForSync": false,
+  "journalSize": 33554432,
+  "isVolatile": false,
+  "isSystem": false,
+  "count": 54,
+  "status": 3,
+  "type": 2,
+  "error": false,
+  "code": 200
+}

data/spec/fixtures/collections/60768679-figures.json

@@ -0,0 +1,35 @@
+{
+  "id": "60768679",
+  "name": "example_1",
+  "waitForSync": true,
+  "journalSize": 134217728,
+  "isVolatile": false,
+  "isSystem": false,
+  "count": 0,
+  "figures": {
+    "alive": {
+      "count": 0,
+      "size": 0
+    },
+    "dead": {
+      "count": 149,
+      "size": 2384,
+      "deletion": 0
+    },
+    "datafiles": {
+      "count": 1,
+      "fileSize": 0
+    },
+    "journals": {
+      "count": 1,
+      "fileSize": 33554432
+    },
+    "shapes": {
+      "count": 6
+    }
+  },
+  "status": 3,
+  "type": 2,
+  "error": false,
+  "code": 200
+}

data/spec/fixtures/collections/60768679-properties-volatile.json

@@ -0,0 +1,12 @@
+{
+  "id": "60768679",
+  "name": "example_1",
+  "waitForSync": true,
+  "journalSize": 134217728,
+  "isVolatile": true,
+  "isSystem": false,
+  "status": 3,
+  "type": 2,
+  "error": false,
+  "code": 200
+}