ashikawa-core 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5174468b7c49a72458d5d91bf9939caf77023f2c
-  data.tar.gz: dc22ceaaacccfd9133638c4707eac3581b71e56d
+  metadata.gz: d94a6bf23847adaa62e95260d2c57e45fb8a0c8a
+  data.tar.gz: 3d033e741693a5a82b9c6aef68a9a26367a9d75e
 SHA512:
-  metadata.gz: 690e9a24ebd4757b14992231d2601b314a9c27c3e7dcb85ceee47b571252cfdb9dcdc30f3b001b17b8ec81a94c25f807bf0acafc86418072bf4644753ecab9bf
-  data.tar.gz: 458b6482db0c04a39b3616901765991f398801ea0db65978b921d439be91603c70f728b566ccaf81c5902394bbd2c75c7a6f8aee880f7b78a26b510209e4c61c
+  metadata.gz: 0eba07aba13e31a52f30b111481a3bcd6de186888f59553211bfd074112c3aca60a893674fb9aaa0759f36aca859671044898b4eacb1f78deecdffd672c05ab3
+  data.tar.gz: 087bd78cf960a174b4d892f6dfb4b6f03b81b483fb45622537758faed347f9006d6007fcbec27fc349bde9ef8dcdc65e2077847833a1322225e6d2c76193fc59

data/.pullreview.yml

@@ -0,0 +1,8 @@
+---
+rules:
+  copy_paste:
+    except:
+      - spec/**
+  documentation:
+    except:
+      - spec/**

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.2
+ruby-2.2.0

data/.travis.yml

@@ -3,11 +3,11 @@ before_script:
 - "./spec/setup/arangodb.sh"
 rvm:
 - 1.9.3
-- 2.0.0
-- 2.1.2
+- 2.1.5
+- 2.2.0
 - jruby-1.7.12
 env:
-- ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.2
+- ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.4
 script: bundle exec rake ci
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# Version 0.14.0
+
+**Codename: Armstrong**
+
+* Making `add_vertex_collection` and `add_edge_definition` idempotent (#144, #139)
+* Introduced `add_vertex_collection!` and `add_edge_definition!` which will raise errors
+* Making error messages and error numbers from ArangoDB more visible in exceptions (#136)
+* Small improvements to the docuemtation
+* Running against Ruby 2.2.0 now
+
 # Version 0.13.1
 
 * **Important Bugfix: Please update immediately**
@@ -7,7 +17,7 @@
 
 **Codename: Galadriel**
 
-* Support for the [new Graph module](http://docs.arangodb.org/HttpGharial/README.html)  in Arango 2.2 (#55)
+* Support for the [new Graph module](http://docs.arangodb.com/HttpGharial/README.html)  in Arango 2.2 (#55)
 * Fixed badge URL for Inch (#130)
 * **Deprecated** `Collection#create_edge` in favor of `EdgeCollection#add`
 * Sending the `X-Arango-Version` HTTP header with each request (#82)

data/README.md

@@ -10,11 +10,11 @@
 | Gem Version     | [![Gem Version](http://img.shields.io/gem/v/ashikawa-core.svg)](http://rubygems.org/gems/ashikawa-core)
 | Dependencies    | [![Dependency Status](http://img.shields.io/gemnasium/triAGENS/ashikawa-core.svg)](https://gemnasium.com/triAGENS/ashikawa-core)
 
-Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and is intended to be used in ArangoDB ODMs and other projects related to the database. It is always working with the stable version of ArangoDB, this is currently version **2.2**.
+Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and is intended to be used in ArangoDB ODMs and other projects related to the database. It is always working with the stable version of ArangoDB, this is currently version **2.4**.
 
 All tests run on Travis CI for the following versions of Ruby:
 
-* MRI 1.9.3, 2.0.0 and 2.1.2
+* MRI 1.9.3, 2.1.5 and 2.2.0
 * JRuby 1.7.12
 
 ## How to install it?

data/ashikawa-core.gemspec

@@ -5,8 +5,8 @@ require 'ashikawa-core/version'
 Gem::Specification.new do |gem|
   gem.name        = 'ashikawa-core'
   gem.version     = Ashikawa::Core::VERSION
-  gem.authors     = ['moonglum']
-  gem.email       = ['me@moonglum.net']
+  gem.authors     = ['Lucas Dohmen', 'Dirk Breuer']
+  gem.email       = ['lucas@arangodb.com', 'dirk@arangodb.com']
   gem.homepage    = 'http://triagens.github.com/ashikawa-core'
   gem.summary     = 'Ashikawa Core is a wrapper around the ArangoDB REST API'
   gem.description = 'Ashikawa Core is a wrapper around the ArangoDB REST API. It provides low level access and is intended to be used in ArangoDB ODMs and other tools.'

data/config/reek.yml

@@ -10,7 +10,8 @@ ClassVariable:
   exclude: []
 ControlParameter:
   enabled: true
-  exclude: []
+  exclude:
+  - Ashikawa::Core::ClientError#initialize
 DataClump:
   enabled: true
   exclude: []
@@ -68,6 +69,7 @@ TooManyStatements:
   - Ashikawa::Core::FaradayFactory#faraday_for
   - Ashikawa::Core::ErrorResponse#on_complete
   - Ashikawa::Core::Figure#initialize
+  - Ashikawa::Core::ErrorResponse#resource_not_found_in_graph_scope
   max_statements: 6
 UncommunicativeMethodName:
   enabled: true

data/lib/ashikawa-core/error_response.rb

@@ -7,6 +7,8 @@ require 'ashikawa-core/exceptions/client_error/resource_not_found/collection_not
 require 'ashikawa-core/exceptions/client_error/resource_not_found/graph_not_found'
 require 'ashikawa-core/exceptions/client_error/bad_syntax'
 require 'ashikawa-core/exceptions/client_error/authentication_failed'
+require 'ashikawa-core/exceptions/client_error/vertex_collection_already_present'
+require 'ashikawa-core/exceptions/client_error/edge_collection_already_present'
 require 'ashikawa-core/exceptions/server_error'
 require 'ashikawa-core/exceptions/server_error/json_error'
 
@@ -41,7 +43,7 @@ module Ashikawa
       # @raise [ServerError] If the status code is any of the 5XX codes
       # @return nil
       def on_complete(env)
-        @body = env[:body]
+        @body = env[:body] || {}
         @url = env[:url]
 
         case env[:status]
@@ -103,7 +105,7 @@ module Ashikawa
               when %r{\A(/_db/[^/]+)?/_api/index} then IndexNotFoundException
               when %r{\A(/_db/[^/]+)?/_api/gharial} then resource_not_found_in_graph_scope
               else ResourceNotFound
-        end
+              end, error
       end
 
       # Raise fitting ResourceNotFoundException within the Graph module
@@ -116,8 +118,12 @@ module Ashikawa
               when 'graph not found' then GraphNotFoundException
               when 'collection not found' then CollectionNotFoundException
               when 'document not found' then DocumentNotFoundException
+              when 'collection used in orphans' then VertexCollectionAlreadyPresent
+              when 'collection used in edge def' then VertexCollectionAlreadyPresent
+              when 'multi use of edge collection in edge def' then EdgeCollectionAlreadyPresent
+              when 'edge collection already used in edge def' then EdgeCollectionAlreadyPresent
               else ResourceNotFound
-              end
+              end, error
       end
 
       # Read the error message for the request
@@ -126,7 +132,7 @@ module Ashikawa
       # @return [String] The formatted error message
       # @api private
       def error
-        "#{@body['errorNum']}: #{@body['errorMessage']}"
+        @body.empty? ? nil : "#{@body['errorNum']}: #{@body['errorMessage']}"
       end
     end
 

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

@@ -5,19 +5,19 @@ module Ashikawa
     class ClientError < RuntimeError
       # Create a new instance
       #
-      # @param [Fixnum] status_code
+      # @param [String] message The error message
       # @return RuntimeError
       # @api private
-      def initialize(status_code)
-        @status_code = status_code
+      def initialize(message = nil)
+        super(message || default_error_message)
       end
 
-      # String representation of the exception
+      # The default error message to be used. Can be overridden by sub classed
       #
-      # @return String
+      # @return String the default error message
       # @api private
-      def to_s
-        @status_code
+      def default_error_message
+        '400 Bad Request'
       end
     end
   end

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

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+
+require 'ashikawa-core/exceptions/client_error.rb'
+
+module Ashikawa
+  module Core
+    # This collection may occur when adding edge definitions
+    # to the graph. While creating edge definitions ArangoDB
+    # will create an edge collection. It has be unique for the
+    # current database. ArangoDB differentiates between two errors:
+    #
+    #  1. The edge collection is already used in the same graph (1920)
+    #  2. The edge collection is already used in another graph (1921)
+    class EdgeCollectionAlreadyPresent < ClientError
+    end
+  end
+end

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

@@ -6,20 +6,12 @@ module Ashikawa
     # 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
+      # The default message for this error.
       #
       # @return String
       # @api private
-      def to_s
-        'Status 404: The Resource you requested was not found on the server'
+      def default_error_message
+        'The Resource you requested was not found on the server'
       end
     end
   end

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

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+
+require 'ashikawa-core/exceptions/client_error.rb'
+
+module Ashikawa
+  module Core
+    # This exception is thrown when the vertex collection
+    # to be added is already member of the graph. There are
+    # two different error messages that can occur:
+    #
+    #  1. The vertex collection is already member of the orphans (1938)
+    #  2. The vertex collection is already member of an edge definition (1929)
+    class VertexCollectionAlreadyPresent < ClientError
+    end
+  end
+end

data/lib/ashikawa-core/graph.rb

@@ -10,7 +10,7 @@ module Ashikawa
     # @note All CRUD operations on related collections (edges and vertices) must be performed
     #       through their corresponding graph class. Not doing so will eventually lead to inconsistency
     #       and data corruption.
-    # @see http://docs.arangodb.org/HttpGharial/README.html
+    # @see http://docs.arangodb.com/HttpGharial/README.html
     class Graph
       extend Forwardable
 
@@ -112,8 +112,25 @@ module Ashikawa
       # to the list of vertex collections.
       #
       # @param [String] collection_name The name of the vertex collection
+      # @see Graph#add_vertex_collection! if you need to know if the collection is already present
       # @return [VertexCollection] The newly created collection
       def add_vertex_collection(collection_name)
+        add_vertex_collection!(collection_name)
+      rescue Ashikawa::Core::VertexCollectionAlreadyPresent
+        vertex_collection(collection_name)
+      end
+
+      # Adds a vertex collection to this graph
+      #
+      # If the collection does not exist yet it will be created. Initially it will add it as an orphaned
+      # collection to the graph. If the collection is already present in the graph definition, either as
+      # an orphan or as part of an edge definition an error is raised.
+      #
+      # @param [String] collection_name The name of the vertex collection
+      # @raise [Ashikawa::Core::VertexCollectionAlreadyPresent] if the collection is already part of the graph
+      # @see Graph#add_vertex_collection if you want to silently ignore the exception
+      # @return [VertexCollection] The newly created collection
+      def add_vertex_collection!(collection_name)
         response = send_request("gharial/#@name/vertex", post: { collection: collection_name })
         parse_raw_graph(response['graph'])
         vertex_collection(collection_name)
@@ -159,11 +176,33 @@ module Ashikawa
 
       # Adds an edge definition to this Graph
       #
+      # If the edge definition doesn't exist it will be created, else it will just return the edge
+      # collection.
+      #
       # @param [Symbol] collection_name The name of the resulting edge collection
       # @param [Hash] directions The specification between which vertices the edges should be created
       # @option [Array<Symbol>] :from A list of collections names from which the edge directs
       # @option [Array<Symbol>] :to A list of collections names to which the edge directs
+      # @see Graph@add_edge_definition! if you need to know the edge definition was already present
+      # @return [EdgeCollection] The edge collection used be the definition
       def add_edge_definition(collection_name, directions)
+        add_edge_definition!(collection_name, directions)
+      rescue Ashikawa::Core::EdgeCollectionAlreadyPresent
+        edge_collection(collection_name)
+      end
+
+      # Adds an edge definition to this Graph
+      #
+      # If the edge definition doesn't exist it will be created, else it will raise an error.
+      #
+      # @param [Symbol] collection_name The name of the resulting edge collection
+      # @param [Hash] directions The specification between which vertices the edges should be created
+      # @option [Array<Symbol>] :from A list of collections names from which the edge directs
+      # @option [Array<Symbol>] :to A list of collections names to which the edge directs
+      # @raise Ashikawa::Core::EdgeCollectionAlreadyPresent if the edge definition is already defined
+      # @see Graph#add_edge_definition if you need an idempotent version of this
+      # @return [EdgeCollection] The edge collection used be the definition
+      def add_edge_definition!(collection_name, directions)
         create_options = {
           collection: collection_name,
           from:       directions[:from],

data/lib/ashikawa-core/version.rb

@@ -2,7 +2,7 @@
 module Ashikawa
   module Core
     # Current version of Ashikawa::Core
-    VERSION = '0.13.1'
+    VERSION = '0.14.0'
 
     # The lowest supported ArangoDB major version
     ARANGODB_MAJOR_VERSION = 2

data/spec/acceptance/graph_spec.rb

@@ -58,6 +58,14 @@ describe 'Graphs' do
     expect(subject.edge_collections).to include visited
   end
 
+  it 'adding the same vertex collection should be idempotent' do
+    expect { subject.add_vertex_collection(:ponies) }.not_to raise_error
+  end
+
+  it 'adding the same edge definition should be idempotent' do
+    expect { subject.add_edge_definition(:friends_with, from: [:you], to: [:me]) }.not_to raise_error
+  end
+
   context 'connected vertices' do
     before :each do
       # There are only directed graphs

data/spec/acceptance/spec_helper.rb

@@ -34,7 +34,7 @@ end
 
 def database_with_random_name
   # This results in a database that has a valid name according to:
-  # https://www.arangodb.org/manuals/2/NamingConventions.html#DatabaseNames
+  # https://docs.arangodb.com/NamingConventions/DatabaseNames.html
   database_with_name("#{RANDOM_DB_PREFIX}#{rand.to_s[2, 10]}")
 end
 

data/spec/setup/arangodb.sh

@@ -7,8 +7,8 @@ NAME=ArangoDB-$VERSION
 
 if [ ! -d "$DIR/$NAME" ]; then
   # download ArangoDB
-  echo "wget http://www.arangodb.org/repositories/travisCI/$NAME.tar.gz"
-  wget http://www.arangodb.org/repositories/travisCI/$NAME.tar.gz
+  echo "wget http://www.arangodb.com/repositories/travisCI/$NAME.tar.gz"
+  wget http://www.arangodb.com/repositories/travisCI/$NAME.tar.gz
   echo "tar zxf $NAME.tar.gz"
   tar zvxf $NAME.tar.gz
   mv `find . -type d -name "ArangoDB-*"` $NAME

data/spec/unit/exception_spec.rb

@@ -19,9 +19,14 @@ describe Ashikawa::Core::NoCollectionProvidedException do
 end
 
 describe Ashikawa::Core::ClientError do
-  let(:error_message) { 'The client did not do what it should do' }
-  subject { Ashikawa::Core::ClientError.new(error_message) }
-  its(:to_s) { should be(error_message) }
+  subject { Ashikawa::Core::ClientError.new }
+  its(:to_s) { should eq('400 Bad Request') }
+
+  context 'with custom message' do
+    let(:error_message) { 'The client did not do what it should do' }
+    subject { Ashikawa::Core::ClientError.new(error_message) }
+    its(:to_s) { should eq(error_message) }
+  end
 end
 
 describe Ashikawa::Core::BadSyntax do

data/spec/unit/graph_spec.rb

@@ -3,6 +3,8 @@ require 'unit/spec_helper'
 require 'ashikawa-core/graph'
 require 'ashikawa-core/document'
 require 'ashikawa-core/database'
+require 'ashikawa-core/exceptions/client_error/vertex_collection_already_present'
+require 'ashikawa-core/exceptions/client_error/edge_collection_already_present'
 
 describe Ashikawa::Core::Graph do
   let(:database) { instance_double('Ashikawa::Core::Database') }
@@ -184,6 +186,22 @@ describe Ashikawa::Core::Graph do
         it 'should return the newly created collection' do
           expect(subject.add_vertex_collection('books')).to eq new_vertex_collection
         end
+
+        context 'with an already present collection' do
+          before do
+            allow(database).to receive(:send_request)
+                                .with('gharial/my_graph/vertex', post: { collection: 'books' })
+                                .and_raise(Ashikawa::Core::VertexCollectionAlreadyPresent)
+          end
+
+          it 'should just return the vertex collection' do
+            expect(subject.add_vertex_collection('books')).to eq new_vertex_collection
+          end
+
+          it 'should re-raise the exception when called with a bang!' do
+            expect { subject.add_vertex_collection!('books') }.to raise_error(Ashikawa::Core::VertexCollectionAlreadyPresent)
+          end
+        end
       end
     end
 
@@ -264,6 +282,22 @@ describe Ashikawa::Core::Graph do
         it 'should return the edge collection' do
           expect(subject.add_edge_definition(:authorship, from: [:author], to: [:books])).to eq new_edge_collection
         end
+
+        context 'with an edge collection of the same name' do
+          before do
+            allow(database).to receive(:send_request)
+                                .with('gharial/my_graph/edge', post: { collection: :authorship, from: [:author], to: [:books] })
+                                .and_raise(Ashikawa::Core::EdgeCollectionAlreadyPresent)
+          end
+
+          it 'should just return the edge collection' do
+            expect(subject.add_edge_definition(:authorship, from: [:author], to: [:books])).to eq new_edge_collection
+          end
+
+          it 'should re-raise the exception when called with a bang!' do
+            expect { subject.add_edge_definition!(:authorship, from: [:author], to: [:books]) }.to raise_error(Ashikawa::Core::EdgeCollectionAlreadyPresent)
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ashikawa-core
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
-- moonglum
+- Lucas Dohmen
+- Dirk Breuer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -237,13 +238,15 @@ dependencies:
 description: Ashikawa Core is a wrapper around the ArangoDB REST API. It provides
   low level access and is intended to be used in ArangoDB ODMs and other tools.
 email:
-- me@moonglum.net
+- lucas@arangodb.com
+- dirk@arangodb.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".hound.yml"
+- ".pullreview.yml"
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
@@ -271,12 +274,14 @@ files:
 - lib/ashikawa-core/exceptions/client_error.rb
 - lib/ashikawa-core/exceptions/client_error/authentication_failed.rb
 - lib/ashikawa-core/exceptions/client_error/bad_syntax.rb
+- lib/ashikawa-core/exceptions/client_error/edge_collection_already_present.rb
 - lib/ashikawa-core/exceptions/client_error/resource_not_found.rb
 - lib/ashikawa-core/exceptions/client_error/resource_not_found/collection_not_found.rb
 - lib/ashikawa-core/exceptions/client_error/resource_not_found/collection_not_in_graph.rb
 - lib/ashikawa-core/exceptions/client_error/resource_not_found/document_not_found.rb
 - lib/ashikawa-core/exceptions/client_error/resource_not_found/graph_not_found.rb
 - lib/ashikawa-core/exceptions/client_error/resource_not_found/index_not_found.rb
+- lib/ashikawa-core/exceptions/client_error/vertex_collection_already_present.rb
 - lib/ashikawa-core/exceptions/no_collection_provided.rb
 - lib/ashikawa-core/exceptions/server_error.rb
 - lib/ashikawa-core/exceptions/server_error/json_error.rb
@@ -365,7 +370,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - ArangoDB, v2.1
 rubyforge_project: ashikawa-core
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ashikawa Core is a wrapper around the ArangoDB REST API