ashikawa-core 0.7.2 → 0.8.0

data/spec/unit/document_spec.rb

@@ -2,7 +2,7 @@ require 'unit/spec_helper'
 require 'ashikawa-core/document'
 
 describe Ashikawa::Core::Document do
-  let(:database) { double() }
+  let(:database) { double }
   let(:raw_data) {
     {
       "_id" => "1234567/2345678",
@@ -29,8 +29,8 @@ describe Ashikawa::Core::Document do
 
   it "should initialize data without ID" do
     document = subject.new database, raw_data_without_id
-    document.id.should == nil
-    document.revision.should == nil
+    document.id.should == :not_persisted
+    document.revision.should == :not_persisted
   end
 
   describe "initialized document with ID" do
@@ -62,10 +62,20 @@ describe Ashikawa::Core::Document do
     end
 
     it "should be convertable to a hash" do
-      hash = subject.to_hash
+      hash = subject.hash
       hash.should be_instance_of Hash
       hash["first_name"].should == subject["first_name"]
     end
+
+    it "should be refreshable" do
+      database.should_receive(:send_request).with("document/#{raw_data['_id']}", {}).and_return {
+        { "name" => "Jeff" }
+      }
+
+      refreshed_subject = subject.refresh!
+      refreshed_subject.should == subject
+      subject["name"].should == "Jeff"
+    end
   end
 
   describe "initialized document without ID" do
@@ -89,4 +99,14 @@ describe Ashikawa::Core::Document do
       expect { subject.save }.to raise_error Ashikawa::Core::DocumentNotFoundException
     end
   end
+
+  describe "Deprecated methods" do
+    subject { Ashikawa::Core::Document.new database, raw_data_without_id }
+
+    it "should mark `to_hash` as deprecated" do
+      subject.should_receive(:hash)
+      subject.should_receive(:warn).with("`to_hash` is deprecated, please use `hash`")
+      subject.to_hash
+    end
+  end
 end

data/spec/unit/edge_spec.rb

@@ -2,7 +2,7 @@ require 'unit/spec_helper'
 require 'ashikawa-core/edge'
 
 describe Ashikawa::Core::Edge do
-  let(:database) { double() }
+  let(:database) { double }
   let(:raw_data) {
     {
       "_id" => "1234567/2345678",

data/spec/unit/exception_spec.rb

@@ -15,8 +15,9 @@ describe Ashikawa::Core::NoCollectionProvidedException do
 end
 
 describe Ashikawa::Core::ClientError do
+  let(:error_message) { "error message" }
   it "should have a good explanation" do
-    Ashikawa::Core::ClientError.new(411).to_s.should include "client"
+    Ashikawa::Core::ClientError.new(error_message).to_s.should == error_message
   end
 end
 
@@ -51,8 +52,9 @@ describe Ashikawa::Core::IndexNotFoundException do
 end
 
 describe Ashikawa::Core::ServerError do
+  let(:error_message) { "error message" }
   it "should have a good explanation" do
-    Ashikawa::Core::ServerError.new(511).to_s.should include "server"
+    Ashikawa::Core::ServerError.new(error_message).to_s.should == error_message
   end
 end
 

data/spec/unit/figure_spec.rb

@@ -22,33 +22,40 @@ describe Ashikawa::Core::Figure do
       },
       "shapes" => {
         "count" => 2
+      },
+      "attributes" => {
+        "count" => 12
       }
     }
   }
   subject { Ashikawa::Core::Figure.new(raw_figures) }
 
   it "should check for the alive figures" do
-      subject.alive_size.should == 0
-      subject.alive_count.should == 0
+    subject.alive_size.should == 0
+    subject.alive_count.should == 0
   end
 
   it "should check for the dead figures" do
-      subject.dead_size.should == 2384
-      subject.dead_count.should == 149
-      subject.dead_deletion.should == 0
+    subject.dead_size.should == 2384
+    subject.dead_count.should == 149
+    subject.dead_deletion.should == 0
   end
 
   it "should check for the datafiles figures" do
-      subject.datafiles_count.should == 1
-      subject.datafiles_file_size.should == 124
+    subject.datafiles_count.should == 1
+    subject.datafiles_file_size.should == 124
   end
 
   it "should check for the journal figures" do
-      subject.journals_count.should == 1
-      subject.journals_file_size.should == 124
+    subject.journals_count.should == 1
+    subject.journals_file_size.should == 124
   end
 
   it "should check for the shapes figure" do
-      subject.shapes_count.should == 2
+    subject.shapes_count.should == 2
+  end
+
+  it "should check for the attributes_count figure" do
+    subject.attributes_count.should == 12
   end
 end

data/spec/unit/index_spec.rb

@@ -2,7 +2,7 @@ require 'unit/spec_helper'
 require 'ashikawa-core/index'
 
 describe Ashikawa::Core::Index do
-  let(:collection) { double() }
+  let(:collection) { double }
   let(:raw_data) {
     {
       "code" => 201,

data/spec/unit/key_options_spec.rb

@@ -0,0 +1,25 @@
+require 'unit/spec_helper'
+require 'ashikawa-core/key_options'
+
+describe Ashikawa::Core::KeyOptions do
+  subject { Ashikawa::Core::KeyOptions }
+
+  it "should parse the key options" do
+    type = double
+    offset = double
+    increment = double
+    allow_user_keys = double
+
+    key_options = subject.new({
+      "type" => type,
+      "offset" => offset,
+      "increment" => increment,
+      "allowUserKeys" => allow_user_keys
+    })
+
+    key_options.type.should == type
+    key_options.offset.should == offset
+    key_options.increment.should == increment
+    key_options.allow_user_keys.should == allow_user_keys
+  end
+end

data/spec/unit/query_spec.rb

@@ -52,7 +52,7 @@ describe Ashikawa::Core::Query do
         collection.should_receive(:send_request).with("simple/first-example", :put =>
           {"collection" => "example_1", "example" => { :hello => "world"}})
 
-        Ashikawa::Core::Cursor.should_receive(:new)
+        Ashikawa::Core::Document.should_receive(:new)
 
         subject.first_example example
       end

data/spec/unit/spec_helper.rb

@@ -1,10 +1,28 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
+# Do not run SimpleCov in Guard
+unless defined?(Guard)
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name     'spec:unit'
+    add_filter       'config'
+    add_filter       'spec'
+    minimum_coverage 99
+  end
+end
+
 # Helper to simulate Server Responses. Parses the fixtures in the spec folder
-require 'multi_json'
+require "json"
 def server_response(path)
-  return MultiJson.load(File.readlines("spec/fixtures/#{path}.json").join)
+  JSON.parse(File.readlines("spec/fixtures/#{path}.json").join)
 end
 
 ARANGO_HOST = "http://localhost:8529"

data/spec/unit/transaction_spec.rb

@@ -0,0 +1,153 @@
+require 'unit/spec_helper'
+require 'ashikawa-core/transaction'
+
+describe Ashikawa::Core::Transaction do
+  let(:db) { double }
+  let(:action) { double }
+
+  describe "creating a transaction" do
+    subject { Ashikawa::Core::Transaction }
+
+    it "should be initialized with only write collections" do
+      transaction = subject.new(db, action, :write => [
+        "collection_1"
+      ])
+
+      transaction.write_collections.should == ["collection_1"]
+    end
+
+    it "should be initialized with only read collections" do
+      transaction = subject.new(db, action, :read => [
+        "collection_1"
+      ])
+
+      transaction.read_collections.should == ["collection_1"]
+    end
+  end
+
+  describe "using a transaction" do
+    let(:read_and_write_collections) do
+      { :read => ["collection_1"], :write => ["collection_2"] }
+    end
+
+    let(:only_read_collection) do
+      { :read => ["collection_1"] }
+    end
+
+    let(:only_write_collection) do
+      { :write => ["collection_1"] }
+    end
+
+    subject { Ashikawa::Core::Transaction.new(db, action, read_and_write_collections) }
+
+    it "should be possible to activate waiting for sync" do
+      subject.wait_for_sync.should == false
+      subject.wait_for_sync = true
+      subject.wait_for_sync.should == true
+    end
+
+    it "should be possible to set the lock timeout" do
+      subject.lock_timeout.should == nil
+      subject.lock_timeout = 30
+      subject.lock_timeout.should == 30
+    end
+
+    describe "execute" do
+      let(:response) { double }
+      let(:result) { double }
+      let(:wait_for_sync) { double }
+      let(:lock_timeout) { double }
+      let(:action_params) { double }
+
+      before {
+        response.stub(:[])
+        db.stub(:send_request).and_return { response }
+      }
+
+      it "should return the result from the database" do
+        response.should_receive(:[]).with("result").and_return { result }
+        db.should_receive(:send_request).and_return { response }
+        subject.execute.should == result
+      end
+
+      it "should post to `transaction` endpoint" do
+        db.should_receive(:send_request).with("transaction", :post => an_instance_of(Hash))
+        subject.execute
+      end
+
+      it "should only send the read collection if no write collection was provided" do
+        transaction = Ashikawa::Core::Transaction.new(db, action, only_read_collection)
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:collections => only_read_collection)
+        })
+        transaction.execute
+      end
+
+      it "should send the information about the read and write collections" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:collections => read_and_write_collections)
+        })
+        subject.execute
+      end
+
+      it "should only send the write collection if no read collection was provided" do
+        transaction = Ashikawa::Core::Transaction.new(db, action, only_write_collection)
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:collections => only_write_collection)
+        })
+        transaction.execute
+      end
+
+      it "should send the information about the action" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:action => action)
+        })
+        subject.execute
+      end
+
+      it "should send with wait for sync set to false by default" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:waitForSync => false)
+        })
+        subject.execute
+      end
+
+      it "should send with wait for sync set to the value provided by the user" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:waitForSync => wait_for_sync)
+        })
+        subject.wait_for_sync = wait_for_sync
+        subject.execute
+      end
+
+      it "should not send lock timeout by default" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_not_including(:lockTimeout => anything)
+        })
+        subject.execute
+      end
+
+      it "should send the configured lock timeout" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:lockTimeout => lock_timeout)
+        })
+        subject.lock_timeout = lock_timeout
+        subject.execute
+      end
+
+      it "should send the arguments object if it was provided" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_including(:params => action_params)
+        })
+        subject.execute(action_params)
+      end
+
+      it "should not send params by default" do
+        db.should_receive(:send_request).with(anything, {
+          :post => hash_not_including(:params => anything)
+        })
+        subject.execute
+      end
+    end
+  end
+end

data/tasks/adjustments.rake

@@ -1,32 +1,28 @@
-# Remove some tasks defined by devtools to redefine them
-
-Rake::Task["spec"].clear
-Rake::Task["spec:integration"].clear
-Rake::Task["ci:metrics"].clear
-Rake::Task["ci"].clear
-
 ## Specs
 # Difference to Devtools:
 # * Acceptance, no integration tests
 # * Special Case: ArangoDB needed for Acceptance Tests
 
+Rake::Task["spec"].clear
+Rake::Task["spec:integration"].clear
+
 desc 'Run all specs'
 task :spec => %w[ spec:unit spec:acceptance ]
 
 namespace :spec do
   desc "Run the acceptance tests. Requires ArangoDB to be running."
-  RSpec::Core::RakeTask.new(:acceptance_with_running_arangodb) do |spec|
+  RSpec::Core::RakeTask.new(:acceptance) do |spec|
     spec.pattern = "spec/acceptance/*_spec.rb"
   end
 
   desc "Run the acceptance tests. Requires ArangoDB."
-  RSpec::Core::RakeTask.new(:acceptance) do |spec|
+  RSpec::Core::RakeTask.new(:start_arango_and_run_acceptance) do |spec|
     spec.rspec_opts = "--require acceptance/arango_helper.rb"
     spec.pattern = "spec/acceptance/*_spec.rb"
   end
 
   desc "Run the authentication acceptance tests. Requires ArangoDB."
-  RSpec::Core::RakeTask.new(:acceptance_auth) do |spec|
+  RSpec::Core::RakeTask.new(:start_arango_and_run_acceptance_auth) do |spec|
     spec.rspec_opts = "--require acceptance_auth/arango_helper.rb"
     spec.pattern = "spec/acceptance_auth/*_spec.rb"
   end
@@ -34,13 +30,26 @@ end
 
 ## Metrics
 # Differences to Devtools:
-# * Do not run mutant and reek, they do not pass yet
-# * On the CI, ArangoDB is already running so use the special acceptance task
+# * Do not run mutant yet
+# * metrics task only runs metrics (and not specs)
+
+Rake::Task["ci"].clear
+Rake::Task["ci:metrics"].clear
 
 namespace :ci do
   desc 'Run all metrics except mutant and reek'
-  task :metrics => %w[ metrics:coverage spec:integration metrics:yardstick:verify metrics:flog metrics:flay ]
+  task :metrics => %w[
+    metrics:coverage
+    metrics:yardstick:verify
+    metrics:rubocop
+    metrics:flog
+    metrics:flay
+    metrics:reek
+  ]
 end
 
 desc 'Run all metrics and specs'
-task :ci => %w[ spec:unit spec:acceptance_with_running_arangodb ci:metrics ]
+task :ci => %w[
+  spec
+  ci:metrics
+]

metadata

@@ -1,21 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: ashikawa-core
 version: !ruby/object:Gem::Version
-  version: 0.7.2
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - moonglum
-- EinLama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,31 +20,27 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.6
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: null_logger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,45 +48,36 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.1
 - !ruby/object:Gem::Dependency
-  name: backports
+  name: equalizer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: 0.0.5
 description: Ashikawa Core is a wrapper around the ArangoDB REST API. It provides
   low level access and will be used in different ArangoDB ODMs and other tools.
 email:
 - me@moonglum.net
-- tobias.eilert@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-version
 - .travis.yml
 - CONTRIBUTING.md
 - Gemfile
@@ -107,10 +91,11 @@ files:
 - config/flog.yml
 - config/mutant.yml
 - config/reek.yml
-- config/roodi.yml
+- config/rubocop.yml
 - config/yardstick.yml
 - lib/ashikawa-core.rb
 - lib/ashikawa-core/collection.rb
+- lib/ashikawa-core/configuration.rb
 - lib/ashikawa-core/connection.rb
 - lib/ashikawa-core/cursor.rb
 - lib/ashikawa-core/database.rb
@@ -127,16 +112,19 @@ files:
 - lib/ashikawa-core/exceptions/server_error/json_error.rb
 - lib/ashikawa-core/figure.rb
 - lib/ashikawa-core/index.rb
+- lib/ashikawa-core/key_options.rb
 - lib/ashikawa-core/query.rb
 - lib/ashikawa-core/request_preprocessor.rb
 - lib/ashikawa-core/response_preprocessor.rb
 - lib/ashikawa-core/status.rb
+- lib/ashikawa-core/transaction.rb
 - lib/ashikawa-core/version.rb
 - spec/acceptance/arango_helper.rb
 - spec/acceptance/basic_spec.rb
 - spec/acceptance/index_spec.rb
 - spec/acceptance/query_spec.rb
 - spec/acceptance/spec_helper.rb
+- spec/acceptance/transactions_spec.rb
 - spec/acceptance_auth/arango_helper.rb
 - spec/acceptance_auth/auth_spec.rb
 - spec/acceptance_auth/spec_helper.rb
@@ -150,6 +138,7 @@ files:
 - spec/fixtures/cursor/26011191-2.json
 - spec/fixtures/cursor/26011191-3.json
 - spec/fixtures/cursor/26011191.json
+- spec/fixtures/cursor/edges.json
 - spec/fixtures/cursor/query.json
 - spec/fixtures/documents/example_1-137249191.json
 - spec/fixtures/documents/new-example_1-137249191.json
@@ -165,7 +154,6 @@ files:
 - spec/fixtures/simple-queries/range.json
 - spec/fixtures/simple-queries/within.json
 - spec/setup/arangodb.sh
-- spec/spec_helper.rb
 - spec/unit/collection_spec.rb
 - spec/unit/connection_spec.rb
 - spec/unit/cursor_spec.rb
@@ -175,37 +163,36 @@ files:
 - spec/unit/exception_spec.rb
 - spec/unit/figure_spec.rb
 - spec/unit/index_spec.rb
+- spec/unit/key_options_spec.rb
 - spec/unit/query_spec.rb
 - spec/unit/spec_helper.rb
 - spec/unit/status_spec.rb
+- spec/unit/transaction_spec.rb
 - tasks/adjustments.rake
 homepage: http://triagens.github.com/ashikawa-core
-licenses: []
+licenses:
+- Apache License 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1495105476276020209
 requirements:
-- ArangoDB, v1.2
+- ArangoDB, v1.3
 rubyforge_project: ashikawa-core
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ashikawa Core is a wrapper around the ArangoDB REST API
 test_files:
 - spec/acceptance/arango_helper.rb
@@ -213,6 +200,7 @@ test_files:
 - spec/acceptance/index_spec.rb
 - spec/acceptance/query_spec.rb
 - spec/acceptance/spec_helper.rb
+- spec/acceptance/transactions_spec.rb
 - spec/acceptance_auth/arango_helper.rb
 - spec/acceptance_auth/auth_spec.rb
 - spec/acceptance_auth/spec_helper.rb
@@ -226,6 +214,7 @@ test_files:
 - spec/fixtures/cursor/26011191-2.json
 - spec/fixtures/cursor/26011191-3.json
 - spec/fixtures/cursor/26011191.json
+- spec/fixtures/cursor/edges.json
 - spec/fixtures/cursor/query.json
 - spec/fixtures/documents/example_1-137249191.json
 - spec/fixtures/documents/new-example_1-137249191.json
@@ -241,7 +230,6 @@ test_files:
 - spec/fixtures/simple-queries/range.json
 - spec/fixtures/simple-queries/within.json
 - spec/setup/arangodb.sh
-- spec/spec_helper.rb
 - spec/unit/collection_spec.rb
 - spec/unit/connection_spec.rb
 - spec/unit/cursor_spec.rb
@@ -251,7 +239,9 @@ test_files:
 - spec/unit/exception_spec.rb
 - spec/unit/figure_spec.rb
 - spec/unit/index_spec.rb
+- spec/unit/key_options_spec.rb
 - spec/unit/query_spec.rb
 - spec/unit/spec_helper.rb
 - spec/unit/status_spec.rb
+- spec/unit/transaction_spec.rb
 has_rdoc: