ashikawa-core 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0188e3f9d7f519dd6219ecf2cf7f54d57e2318b6
-  data.tar.gz: a8b0deb872c8771186b23861d7aacf264b16facf
+  metadata.gz: 1415f79ce912907851e91f4f1810668fb0a83024
+  data.tar.gz: 4076c3f55aecd6f194057cfbc6a7f0e0c671b774
 SHA512:
-  metadata.gz: dd134061b8cfad2f9aee15e9f9fed43b77c8f2bbebf9c19e4932ad53786e66b9a8ce1e42a7c1b593aee4be1086b4a7b90c412cc7ec310869891ee26892c24a58
-  data.tar.gz: 094089ba8bcfdc3776722d3c8aff6a4e21f7c8fe72b353cdfa97a03baf0c79f4742c30740092efa67e1db5f698cb4ac5697a7b8f7609bb2b12fb7907236d6a16
+  metadata.gz: cbca0fdac8f1f59c2597d684b58bd1c3f6cfdf28fa5df3cf7aecda655cb9430e1117ab72bd56b7bcaa88751fa23915ac48e86157e5f06f1adfebb71f6f8325f9
+  data.tar.gz: 98687992409d83cb2c894156019e0c4ebb539ad2eb94e2d036815c5d935b07320abf6ce24d69829726d3244e45ec0d4c9d66a5a6b25eabf9dafb1f9dd58baa65

data/.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+tags
 /.yardoc
 /doc
 /*.gem

data/.hound.yml

@@ -28,7 +28,7 @@ HashSyntax:
   Enabled: true
 
 StringLiterals:
-  Enabled: true
+  EnforcedStyle: single_quotes
 
 Void:
   Enabled: true

data/.travis.yml

@@ -6,12 +6,8 @@ rvm:
   - 2.0.0
   - 2.1.2
   - jruby-1.7.12
-  - rbx-2.2.6
 env:
-  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.1
-matrix:
-  allow_failures:
-    - rvm: 2.1.0
+  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.2
 script: "bundle exec rake ci"
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# Version 0.13.0
+
+**Codename: Galadriel**
+
+* Support for the [new Graph module](http://docs.arangodb.org/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)
+* Development only:
+  * Removed Rubinius from Travis
+  * You will need ArangoDB 2.2 for development
+  * Automatically removed auto-generated databases for acceptance specs
+
 # Version 0.12.0
 
 **Codename: V for Verifying**

data/README.md

@@ -6,16 +6,15 @@
 | Documentation   | [RubyDoc](http://www.rubydoc.info/gems/ashikawa-core)
 | CI              | [![Build Status](http://img.shields.io/travis/triAGENS/ashikawa-core.svg)](http://travis-ci.org/triAGENS/ashikawa-core)
 | Code Metrics    | [![Code Climate](http://img.shields.io/codeclimate/github/triAGENS/ashikawa-core.svg)](https://codeclimate.com/github/triAGENS/ashikawa-core) [![Code Climate Coverage](http://img.shields.io/codeclimate/coverage/github/triAGENS/ashikawa-core.svg)](https://codeclimate.com/github/triAGENS/ashikawa-core)
-| Inline docs     | [![Inline docs](http://inch-pages.github.io/github/triAGENS/ashikawa-core.svg)](http://inch-pages.github.io/github/triAGENS/ashikawa-core)
+| Inline docs     | [![Inline docs](http://inch-ci.org/github/triAGENS/ashikawa-core.svg)](http://inch-ci.org/github/triAGENS/ashikawa-core)
 | 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.1**.
+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**.
 
 All tests run on Travis CI for the following versions of Ruby:
 
 * MRI 1.9.3, 2.0.0 and 2.1.2
-* Rubinius 2.2.6
 * JRuby 1.7.12
 
 ## How to install it?

data/config/reek.yml

@@ -63,6 +63,7 @@ TooManyMethods:
 TooManyStatements:
   enabled: true
   exclude:
+  - Ashikawa::Core::Database#translate_params
   - Ashikawa::Core::FaradayFactory#self.create_connection
   - Ashikawa::Core::FaradayFactory#faraday_for
   - Ashikawa::Core::ErrorResponse#on_complete

data/lib/ashikawa-core/collection.rb

@@ -354,7 +354,7 @@ module Ashikawa
       #   document = collection.fetch(12345)
       def fetch(document_key)
         response = send_request_for_content_key(document_key)
-        @content_class.new(@database, response)
+        build_content_class(response)
       end
 
       # Fetch a certain document by its key, return nil if the document does not exist
@@ -397,6 +397,9 @@ module Ashikawa
 
       # Create a new edge between two documents with certain attributes
       #
+      # @deprecated Since we introduced the dedicated Graph module ('gharial') all operations regarding edges
+      #             and vertices should be done through that module. Due to this please use EdgeCollection#add
+      #             instead.
       # @param [Document] from
       # @param [Document] to
       # @param [Hash] attributes
@@ -405,6 +408,7 @@ module Ashikawa
       # @example Create a new document from raw data
       #   collection.create_edge(node_a, node_b, {'name' => 'incredible edge'})
       def create_edge(from, to, attributes)
+        warn '[DEPRECATION] `create_edge` is deprecated.  Please use `EdgeCollection#add` instead.'
         raise "Can't create an edge in a document collection" if @content_type == :document
         response = send_request("edge?collection=#{@id}&from=#{from.id}&to=#{to.id}", post: attributes)
         Edge.new(@database, response, attributes)
@@ -485,6 +489,15 @@ module Ashikawa
         get_information_from_server(:properties, :isVolatile)
       end
 
+      # Builds an instance for the content class
+      #
+      # @param [Hash] data The raw data to be used to instatiate the class
+      # @return [Document] The instatiated document
+      # @api private
+      def build_content_class(data)
+        @content_class.new(@database, data)
+      end
+
       private
 
       # Send a put request with a given key and value to the server

data/lib/ashikawa-core/connection.rb

@@ -3,6 +3,7 @@ require 'forwardable'
 require 'faraday'
 require 'equalizer'
 require 'ashikawa-core/error_response'
+require 'ashikawa-core/x_arango_version'
 require 'ashikawa-core/faraday_factory'
 
 module Ashikawa

data/lib/ashikawa-core/database.rb

@@ -1,6 +1,8 @@
 # -*- encoding : utf-8 -*-
 require 'ashikawa-core/exceptions/client_error/resource_not_found/collection_not_found'
+require 'ashikawa-core/exceptions/client_error/resource_not_found/graph_not_found'
 require 'ashikawa-core/collection'
+require 'ashikawa-core/graph'
 require 'ashikawa-core/connection'
 require 'ashikawa-core/cursor'
 require 'ashikawa-core/configuration'
@@ -205,6 +207,45 @@ module Ashikawa
         Transaction.new(self, action, collections)
       end
 
+      # Fetch a single graph from this database or creates it if does not exist yet.
+      #
+      # @param [String] graph_name The name of the Graph
+      # @return [Graph] The requested graph
+      # @api public
+      def graph(graph_name)
+        response = send_request("gharial/#{graph_name}")
+        Graph.new(self, response['graph'])
+      rescue Ashikawa::Core::GraphNotFoundException
+        return create_graph(graph_name)
+      end
+
+      # Create a new Graph for this database.
+      #
+      # @param [String] graph_name The name of the Graph
+      # @option options [Array<Hash>] :edge_definitions A list of edge definitions
+      # @option options [Array<String>] :orphan_collections A list of orphan collections
+      # @return [Graph] The graph that was created
+      # @api public
+      # @example Create a graph without additional options
+      #   database = Ashikawa::Core::Database.new('http://localhost:8529')
+      #   database.create_graph('a') # => #<Graph name="a">
+      # @example Create a graph with edge definitions and orphan collections
+      #   database = Ashikawa::Core::Database.new('http://localhost:8529')
+      #   database.create_graph('g', {
+      #       edge_definitions: [{ collection: 'c', from: 'a', to: 'b'}],
+      #       orphan_collections: ['d']
+      #     })
+      def create_graph(graph_name, options = {})
+        response = send_request('gharial', post: translate_params(graph_name, options))
+        Graph.new(self, response['graph'])
+      end
+
+      # Fetch all graphs for this database
+      def graphs
+        response = send_request('gharial')
+        response['graphs'].map { |raw_graph| Graph.new(self, raw_graph) }
+      end
+
       private
 
       # Parse a raw collection
@@ -232,12 +273,14 @@ module Ashikawa
 
       # Translate the params into the required format
       #
-      # @param [String] collection_identifier
+      # @param [String] identifier
       # @param [Hash] opts
       # @return [Hash]
       # @api private
-      def translate_params(collection_identifier, opts)
-        params = { name: collection_identifier }
+      def translate_params(identifier, opts)
+        params = { name: identifier }
+        params[:edgeDefinitions] = opts[:edge_definitions] if opts.key?(:edge_definitions)
+        params[:orphanCollections] = opts[:orphan_collections] if opts.key?(:orphan_collections)
         params[:isVolatile] = true if opts[:is_volatile]
         params[:type] = COLLECTION_TYPES[opts[:content_type]] if opts.key?(:content_type)
         params[:keyOptions] = translate_key_options(opts[:key_options]) if opts.key?(:key_options)

data/lib/ashikawa-core/document.rb

@@ -35,16 +35,25 @@ module Ashikawa
       #   document.revision # => 3456789
       attr_reader :revision
 
+      # The optional graph this document belongs to
+      #
+      # @return [Graph] The Graph instance the document was fetched from
+      # @api public
+      attr_reader :graph
+
       # Initialize a Document with the database and raw data
       #
       # @param [Database] database
       # @param [Hash] raw_document
       # @param [Hash] additional_data
+      # @option _additional_data [Graph] graph The graph this document is associated with
       # @api public
       # @example Create a document
       #   document = Ashikawa::Core::Document.new(database, raw_document)
       def initialize(database, raw_document, additional_data = {})
         @database = database
+        @graph    = additional_data.delete(:graph)
+
         raw_document.merge!(clean_up_additional_data(additional_data))
         parse_raw_document(raw_document)
       end
@@ -154,7 +163,11 @@ module Ashikawa
       # @return [Hash] The parsed response from the server
       # @api private
       def send_request_for_document(opts = {})
-        @database.send_request("document/#{@id}", opts)
+        if graph
+          @database.send_request("gharial/#{graph.name}/vertex/#{@id}", opts)
+        else
+          @database.send_request("document/#{@id}", opts)
+        end
       end
 
       # Clean up the raw data hash to have string keys

data/lib/ashikawa-core/edge.rb

@@ -31,6 +31,7 @@ module Ashikawa
       # @param [Database] _database
       # @param [Hash] raw_edge
       # @param [Hash] _additional_data
+      # @option _additional_data [Graph] graph The graph this edge is associated with
       # @api public
       # @example Create an Edge
       #   document = Ashikawa::Core::Edge.new(database, raw_edge)
@@ -48,7 +49,11 @@ module Ashikawa
       # @return [Hash] The parsed response from the server
       # @api private
       def send_request_for_document(opts)
-        @database.send_request("edge/#{@id}", opts)
+        if graph
+          @database.send_request("gharial/#{graph.name}/edge/#{@id}", opts)
+        else
+          @database.send_request("edge/#{@id}", opts)
+        end
       end
     end
   end

data/lib/ashikawa-core/edge_collection.rb

@@ -0,0 +1,92 @@
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/collection'
+require 'ashikawa-core/edge'
+
+module Ashikawa
+  module Core
+    # An edge collection as it is returned from a graph
+    #
+    # @note This is basically just a regular collection with some additional attributes and methods to ease
+    #       working with collections in the graph module.
+    class EdgeCollection < Collection
+      # The prepared AQL statement to remove edges
+      REMOVE_EDGES_AQL_STATEMENT = <<-AQL.gsub(/^[ \t]*/, '')
+      FOR e IN @@edge_collection
+        FILTER e._from == @from && e._to == @to
+        REMOVE e._key IN @@edge_collection
+      AQL
+
+      # The Graph instance this EdgeCollection was originally fetched from
+      #
+      # @return [Graph] The Graph instance the collection was fetched from
+      # @api public
+      attr_reader :graph
+
+      # Create a new EdgeCollection object
+      #
+      # @param [Database] database The database the connection belongs to
+      # @param [Hash] raw_collection The raw collection returned from the server
+      # @param [Graph] graph The graph from which this collection was fetched
+      # @note You should not create instance manually but rather use Graph#add_edge_definition
+      # @api public
+      def initialize(database, raw_collection, graph)
+        super(database, raw_collection)
+        @graph = graph
+      end
+
+      # Create one or more edges between documents with certain attributes
+      #
+      # @param [Document] from The outbound vertex
+      # @param [Document] to The inbound vertex
+      # @param [Hash] attributes Additional attributes to add to all created edges
+      # @return [Edge] The created Edge
+      # @api public
+      # @example Create an edge between two vertices
+      #   edges = edge_collection.add(from: vertex_a, to: vertex_b)
+      def add(directions)
+        from_vertex, to_vertex = directions.values_at(:from, :to)
+        response = send_request_for_this_collection('', post: { _from: from_vertex.id, _to: to_vertex.id })
+        fetch(response['edge']['_key'])
+      end
+
+      # Remove edges by example
+      #
+      # @note This will remove ALL edges between the given vertices. For more fine grained control delete
+      #       the desired edges through Edge#remove.
+      # @param [Hash] from_to Specifies the edge by its vertices to be removed
+      # @option from_to [Document] from The from part of the edge
+      # @option from_to [Document] to The to part of the edge
+      # @api public
+      def remove(from_to)
+        bind_vars = {
+          :@edge_collection => name,
+          :from             => from_to[:from].id,
+          :to               => from_to[:to].id
+        }
+
+        database.query.execute(REMOVE_EDGES_AQL_STATEMENT, bind_vars: bind_vars)
+      end
+
+      # Builds a new edge object and passes the current graph to it
+      #
+      # @param [Hash] data The raw data to be used to instatiate the class
+      # @return [Edge] The instatiated edge
+      # @api private
+      def build_content_class(data)
+        Edge.new(@database, data, graph: graph)
+      end
+
+      private
+
+      # Send a request to the server through the Graph module
+      #
+      # @param [String] path The requested path
+      # @param [Hash] method The desired HTTP Verb (defaults to GET) and its parameters
+      # @return [Hash] Response from the server
+      # @api private
+      def send_request_for_this_collection(path, method = {})
+        send_request("gharial/#{graph.name}/edge/#@name/#{path}", method)
+      end
+    end
+  end
+end

data/lib/ashikawa-core/error_response.rb

@@ -4,6 +4,7 @@ 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/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/server_error'
@@ -100,10 +101,25 @@ module Ashikawa
               when %r{\A(/_db/[^/]+)?/_api/document} then DocumentNotFoundException
               when %r{\A(/_db/[^/]+)?/_api/collection} then CollectionNotFoundException
               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
 
+      # Raise fitting ResourceNotFoundException within the Graph module
+      #
+      # @raise [DocumentNotFoundException, CollectionNotFoundException, GraphNotFoundException, ResourceNotFound]
+      # @return nil
+      # @api private
+      def resource_not_found_in_graph_scope
+        raise case @body['errorMessage']
+              when 'graph not found' then GraphNotFoundException
+              when 'collection not found' then CollectionNotFoundException
+              when 'document not found' then DocumentNotFoundException
+              else ResourceNotFound
+              end
+      end
+
       # Read the error message for the request
       #
       # @param [String] The raw body of the request

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

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error/resource_not_found'
+
+module Ashikawa
+  module Core
+    # This Exception is thrown when the collection was found in the database but was not
+    # yet associated to the Graph.
+    class CollectionNotInGraphException < ResourceNotFound
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        'The requested collection has not been added to the graph yet.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error/resource_not_found'
+
+module Ashikawa
+  module Core
+    # This Exception is thrown when a graph was requested from
+    # the server that does not exist.
+    class GraphNotFoundException < ResourceNotFound
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        'You requested a graph from the server that does not exist'
+      end
+    end
+  end
+end

data/lib/ashikawa-core/faraday_factory.rb

@@ -15,7 +15,7 @@ module Ashikawa
       }
 
       # Request middlewares that will be prepended
-      DEFAULT_REQUEST_MIDDLEWARES = [:json]
+      DEFAULT_REQUEST_MIDDLEWARES = [:json, :x_arango_version]
 
       # Response middlewares that will be prepended
       DEFAULT_RESPONSE_MIDDLEWARES = [:error_response, :json]