ashikawa-core 0.6.0 → 0.7.0

data/.rspec

@@ -1,4 +1,3 @@
 --color
 --format progress
---profile
 --order random

data/.travis.yml

@@ -18,3 +18,5 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
 script: "bundle exec rake ci"
+notifications:
+  webhooks: https://www.buildheroes.com/api/projects/0f136ecd2207606cfacf9a968fe9fd0819398b63/builds

data/CONTRIBUTING.md

@@ -2,40 +2,25 @@
 
 When you want to write code for the project, please follow these guidelines:
 
-1. Claim the ticket: Tell us that you want to work on a certain ticket, we will assign it to you (We don't want two people to work on the same thing ;) )
-2. Fork your feature branch from the `development` branch (not the `master` branch)
-3. Write an acceptance test: Describe what you want to do (our integration tests touch the database)
-4. Implement it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
-5. Write documentation for it.
-6. Check with `bundle exec rake` that everything is fine and send the pull request to the `development` branch :)
+1. **Claim** the ticket: Tell us that you want to work on a certain ticket, we will assign it to you (We don't want two people to work on the same thing ;) )
+2. **Fork** your feature branch from the `development` branch (not the `master` branch)
+3. Write an **acceptance test**: Describe what you want to do (our acceptance tests touch the database)
+4. **Implement** it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
+5. Write **documentation** for it.
+6. Check with `bundle exec rake ci` (you need to have ArangoDB running for that) that everything is fine and send the pull request to the `development` branch :)
 
-## How to get started developing
+## Setup
 
-Getting started is easy, just follow these steps.
+Nothing special:
 
-### In a nutshell
-
-* Clone the project.
+* Clone the project
 * `cd` into the folder and run `bundle` 
-* `bundle exec rake` and see all tests passing (you need to have ArangoDB installed for that)
-* Happy coding!
-
-### Detailed description
-
-Make sure you are running Ruby 1.9.x (or JRuby/Rubinius in 1.9 mode) and clone the latest snapshot into a directory of your choice. Also make sure ArangoDB is installed and accessible via `arangod` (for example by installing it via `brew install arangodb`).
-
-We encourage you to use [rvm](https://rvm.io/). If you do so, a gemset for the project is created upon changing into the directory. If you do not use `rvm` nothing special will happen in this case. Don't worry about it.
-
-Change into the project directory. Run `bundle` to get all dependencies (do a `gem install bundler` before if you don't have bundler installed).
-
-Now you can run `bundle exec rake` to see all tests passing (hopefully). Happy coding!
-
-You can also start up yard for documentation: `bundle exec rake yard:server`
+* `bundle exec rake ci` and see all tests passing (you need to have ArangoDB running for that)
+* Happy hacking!
 
-### Guard
+## Guard
 
-Guard is a tool for comfortable development. If you want to use it for development, you have to first start an instance of ArangoDB and then start guard with `bundle exec guard`. This will:
+Guard is a tool for comfortable development. If you want to use it, you have to first start an instance of ArangoDB and then start guard with `bundle exec guard`. This will:
 
-* Run a documentation server on `http://localhost:8808`
 * Run `bundle` whenever you change the dependencies
-* Run the integration and unit tests whenever you change a file in the lib or spec directory
+* Run the **unit tests** whenever you change a file in the lib or spec directory

data/Gemfile.devtools

@@ -2,7 +2,7 @@
 
 group :development do
   gem 'rake',  '~> 10.0.3'
-  gem 'rspec', '~> 2.12.0'
+  gem 'rspec', '~> 2.13.0'
   gem 'yard',  '~> 0.8.4.1'
 end
 
@@ -13,15 +13,14 @@ end
 group :guard do
   gem 'guard',         '~> 1.6.2'
   gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 2.3.3'
+  gem 'guard-rspec',   '~> 2.4.1'
 
   # file system change event handling
   gem 'rb-fchange', '~> 0.0.6', :require => false
   gem 'rb-fsevent', '~> 0.9.3', :require => false
   gem 'rb-inotify', '~> 0.9.0', :require => false
 
-  # Remove this one https://github.com/guard/listen/pull/78 is released
-  gem 'listen', '~> 0.7.2', :git => 'https://github.com/guard/listen.git'
+  gem 'listen', '~> 0.7.3'
 
   # notification handling
   gem 'libnotify',               '~> 0.8.0', :require => false
@@ -30,11 +29,11 @@ group :guard do
 end
 
 group :metrics do
-  gem 'flay',      '~> 1.4.3'
-  gem 'flog',      '~> 2.5.3'
-  gem 'reek',      '~> 1.2.13', :git => 'https://github.com/troessner/reek.git', :ref => 'ef77fcecaa21c9ebcbe4d9a79d41b0e70196bf18'
-  gem 'roodi',     '~> 2.2.0'
-  gem 'yardstick', '~> 0.9.2'
+  gem 'flay',            '~> 2.1.0'
+  gem 'flog',            '~> 3.2.2'
+  gem 'reek',            '~> 1.3.1'
+  gem 'metric_fu-roodi', '~> 2.2.1'
+  gem 'yardstick',       '~> 0.9.2'
 
   platforms :ruby_18, :ruby_19 do
     # this indirectly depends on ffi which does not build on ruby-head
@@ -42,7 +41,7 @@ group :metrics do
   end
 
   platforms :mri_19, :rbx do
-#    gem 'mutant', '~> 0.2.16'
+    gem 'mutant', '~> 0.2.17'
   end
 
   platforms :mri_19 do

data/README.md

@@ -5,26 +5,47 @@
 [![Dependency Status](https://gemnasium.com/triAGENS/ashikawa-core.png)](https://gemnasium.com/triAGENS/ashikawa-core)
 [![Code Climate](https://codeclimate.com/github/triAGENS/ashikawa-core.png)](https://codeclimate.com/github/triAGENS/ashikawa-core)
 
-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 projects related to the database. It is always working with the stable version of ArangoDB, this is currently version **1.1.2**.
+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 projects related to the database. It is always working with the stable version of ArangoDB, this is currently version **1.2**. If you want to access an ArangoDB instance running version **1.1.2** refer to version [0.6](https://github.com/triAGENS/ashikawa-core/tree/0.6.0) of this gem (or just update ;) ).
 
 All tests run on Travis CI for the following versions of Ruby:
 
-* MRI 1.8.7, 1.9.2 and 1.9.3
+* MRI 1.8.7, 1.9.2, 1.9.3 and 2.0.0
 * Rubinius 1.8 and 1.9 mode
 * JRuby 1.8 and 1.9 mode
 * REE
 
 We also run on JRuby and MRI Head, but they are allowed failures (Please see [Travis](http://travis-ci.org/triAGENS/ashikawa-core) for their build status).
 
-Please note that the `master` branch is always the stable version released on Ruby Gems and documented on RDoc. If you want the most recent version, please refer to the `development` branch.
+Please note that the [`master`](https://github.com/triAGENS/ashikawa-core) branch is always the stable version released on Ruby Gems and documented on RDoc. If you want the most recent version, please refer to the [`development`](https://github.com/triAGENS/ashikawa-core/tree/development) branch.
 
-## How to use it
+## How to Setup a Connection
 
-For a detailed description of Ashikawa::Core please refer to the [documentation](http://rdoc.info/github/triAGENS/ashikawa-core/master/frames). An example:
+We want to provide you with as much flexibility as possible. So you can choose which adapter to use for HTTP (choose from the adapters available for [Faraday](https://github.com/lostisland/faraday)) and what you want to use for logging (basically anything that has an `info` method that takes a String). It defaults to Net::HTTP and no logging:
 
 ```ruby
-database = Ashikawa::Core::Database.new "http://localhost:8529"
+database = Ashikawa::Core::Database.new do |config|
+  config.url = "http://localhost:8529"
+end
+```
+
+But you could for example use Typhoeus for HTTP and yell for logging:
+
+```ruby
+require "typhoeus"
+require "yell"
+
+logger = Yell.new(STDOUT)
 
+database = Ashikawa::Core::Database.new do |config|
+  config.url = "http://localhost:8529"
+  config.adapter = :typhoeus
+  config.logger = logger
+end
+```
+
+For a detailed description on how to use Ashikawa::Core please refer to the [documentation](http://rdoc.info/github/triAGENS/ashikawa-core/master/frames). An example:
+
+```ruby
 database["my_collection"] # => Returns the collection my_collection – creates it, if it doesn't exist
 database["my_collection"].name = "new_name"
 database["new_name"].delete
@@ -38,6 +59,6 @@ If you find a bug in this gem, please report it on [our tracker](https://github.
 
 If you want to contribute to the project, see CONTRIBUTING.md for details. It contains information on our process and how to set up everything. The following people have contributed to this project:
 
-* Lucas Dohmen (@moonglum): Developer
-* Tobias Eilert (@EinLama): Contributor
-* Markus Schirp (@mbj): Contributor
+* Lucas Dohmen ([@moonglum](https://github.com/moonglum)): Developer
+* Tobias Eilert ([@EinLama](https://github.com/EinLama)): Contributor
+* Markus Schirp ([@mbj](https://github.com/mbj)): Contributor

data/Rakefile

@@ -3,6 +3,6 @@ require 'devtools'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-Devtools.init
+Devtools.init_rake_tasks
 
 import("./tasks/adjustments.rake")

data/ashikawa-core.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |gem|
   gem.email       = ["me@moonglum.net", "tobias.eilert@me.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 will be used in different ArangoDB ODMs."
+  gem.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."
 
-  gem.required_ruby_version = '>= 1.9.2'
-  gem.requirements << "ArangoDB, v1.1.2"
+  gem.required_ruby_version = '>= 1.8.7'
+  gem.requirements << "ArangoDB, v1.2"
 
   gem.rubyforge_project = "ashikawa-core"
 
@@ -21,10 +21,11 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  # Runtime Dependencies
-  gem.add_dependency "rest-client", "~> 1.6.7"
-  gem.add_dependency "json", "~> 1.7.7"
+  gem.add_dependency "faraday", "~> 0.8.6"
+  gem.add_dependency "multi_json", "~> 1.6.1"
+  gem.add_dependency "null_logger", "~> 0.0.1"
 
-  # Development Dependencies
-  gem.add_development_dependency "webmock", "~> 1.9.3"
+  # Set to 2.8.2 because of Devtools
+  # Needs an upgrade, because of an error in this version
+  gem.add_dependency "backports", "~> 2.8.2"
 end

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 18
-total_score: 250
+threshold: 14
+total_score: 265

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 23.0
+threshold: 11.3

data/config/roodi.yml

@@ -1,15 +1,14 @@
-AbcMetricMethodCheck:            { score: 15.0 }
+AbcMetricMethodCheck:            { score: 10.0 }
 AssignmentInConditionalCheck:    { }
-CaseMissingElseCheck:            { }
-ClassLineCountCheck:             { line_count: 500 }
+ClassLineCountCheck:             { line_count: 1000 }
 ClassNameCheck:
   pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
 ClassVariableCheck:              { }
 CyclomaticComplexityBlockCheck:  { complexity: 1 }
-CyclomaticComplexityMethodCheck: { complexity: 5 }
+CyclomaticComplexityMethodCheck: { complexity: 6 }
 EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
-MethodLineCountCheck:            { line_count: 10 }
+MethodLineCountCheck:            { line_count: 9 }
 MethodNameCheck:
   pattern: !ruby/regexp /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
 ModuleLineCountCheck:            { line_count: 500 }

data/config/site.reek

@@ -2,7 +2,7 @@
 UncommunicativeParameterName:
   accept: []
   exclude: []
-  enabled: false
+  enabled: true
   reject:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
@@ -10,6 +10,7 @@ UncommunicativeParameterName:
 LargeClass:
   max_methods: 10
   exclude:
+  - Ashikawa::Core::Figure
   - Ashikawa::Core::Query
   - Ashikawa::Core::Collection
   enabled: true
@@ -29,8 +30,17 @@ LongParameterList:
   enabled: true
   overrides: {}
 FeatureEnvy:
-  exclude: []
-  enabled: false
+  exclude:
+  - Ashikawa::Core::RequestPreprocessor
+  - Ashikawa::Core::ResponsePreprocessor
+  - Ashikawa::Core::Database#initialize
+  - Ashikawa::Core::Database#create_collection
+  - Ashikawa::Core::Connection#http_verb
+  - Ashikawa::Core::Connection#initialize
+  - Ashikawa::Core::Index#parse_raw_index
+  - Ashikawa::Core::Query#allowed_options
+  - Ashikawa::Core::Query#prepare_request_data
+  enabled: true
 ClassVariable:
   exclude: []
   enabled: true
@@ -47,26 +57,26 @@ UncommunicativeModuleName:
   reject: []
 NestedIterators:
   ignore_iterators: []
-  exclude: []
+  exclude:
+  - Ashikawa::Core::Query#prepare_request_data
   enabled: true
-  max_allowed_nesting: 2
+  max_allowed_nesting: 1
 LongMethod:
-  max_statements: 8
-  exclude: []
+  max_statements: 4
+  exclude:
+  - Ashikawa::Core::ResponsePreprocessor#handle_status
+  - Ashikawa::Core::Database#create_collection
+  - Ashikawa::Core::Cursor#parse_raw_cursor
+  - Ashikawa::Core::Document#parse_raw_document
+  - Ashikawa::Core::Index#parse_raw_index
+  - Ashikawa::Core::Collection#parse_raw_collection
+  - Ashikawa::Core::Connection#authenticate_with
   enabled: true
 Duplication:
   allow_calls: []
-  exclude:
-  - Ashikawa::Core::Document#initialize
+  exclude: []
   enabled: true
   max_calls: 1
-UtilityFunction:
-  max_helper_calls: 0
-  exclude: []
-  enabled: false
-Attribute:
-  exclude: []
-  enabled: false
 UncommunicativeVariableName:
   accept: []
   exclude: []
@@ -93,3 +103,17 @@ LongYieldList:
   max_params: 1
   exclude: []
   enabled: true
+UtilityFunction:
+  max_helper_calls: 0
+  exclude: []
+  enabled: false
+NilCheck:
+  enabled: true
+  exclude:
+  - Ashikawa::Core::Database#setup_new_connection
+  - Ashikawa::Core::Document#check_if_persisted!
+  - Ashikawa::Core::Query#prepare_request_data
+  - Ashikawa::Core::Query#wrapped_request
+Attribute:
+  exclude: []
+  enabled: false

data/config/yardstick.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 100
+threshold: 98.1

data/lib/ashikawa-core/collection.rb

@@ -1,4 +1,5 @@
 require "ashikawa-core/document"
+require "ashikawa-core/edge"
 require "ashikawa-core/index"
 require "ashikawa-core/cursor"
 require "ashikawa-core/query"
@@ -12,6 +13,16 @@ module Ashikawa
     class Collection
       extend Forwardable
 
+      CONTENT_TYPES = {
+        2 => :document,
+        3 => :edge
+      }
+
+      CONTENT_CLASS = {
+        :document => Document,
+        :edge => Edge
+      }
+
       # The name of the collection, must be unique
       #
       # @return [String]
@@ -87,6 +98,24 @@ module Ashikawa
       #   collection.database #=> #<Database: ...>
       attr_reader :database
 
+      # The kind of content in the collection: Documents or Edges
+      #
+      # @return [:document, :edge]
+      # @api public
+      # @example
+      #   database = Ashikawa::Core::Database.new("http://localhost:8529")
+      #   raw_collection = {
+      #     "name" => "example_1",
+      #     "waitForSync" => true,
+      #     "id" => 4588,
+      #     "status" => 3,
+      #     "error" => false,
+      #     "code" => 200
+      #   }
+      #   collection = Ashikawa::Core::Collection.new(database, raw_collection)
+      #   collection.content_type #=> :document
+      attr_reader :content_type
+
       # Sending requests is delegated to the database
       def_delegator :@database, :send_request
 
@@ -108,9 +137,8 @@ module Ashikawa
       #   collection = Ashikawa::Core::Collection.new(database, raw_collection)
       def initialize(database, raw_collection)
         @database = database
-        @name     = raw_collection['name']                   if raw_collection.has_key?('name')
-        @id       = raw_collection['id'].to_i                if raw_collection.has_key?('id')
-        @status   = Status.new raw_collection['status'].to_i if raw_collection.has_key?('status')
+        parse_raw_collection(raw_collection)
+        @content_class = CONTENT_CLASS[@content_type]
       end
 
       # Change the name of the collection
@@ -307,8 +335,8 @@ module Ashikawa
       # @example Fetch the document with the ID 12345
       #   document = collection[12345]
       def [](document_id)
-        server_response = send_request("/document/#{@id}/#{document_id}")
-        Document.new(@database, server_response)
+        response = send_request_for_content_id(document_id)
+        @content_class.new(@database, response)
       end
 
       # Replace a document by its ID
@@ -320,22 +348,38 @@ module Ashikawa
       # @example Replace the document with the ID 12345
       #   collection[12345] = document
       def []=(document_id, raw_document)
-        send_request("/document/#{@id}/#{document_id}", :put => raw_document)
+        send_request_for_content_id(document_id, :put => raw_document)
       end
 
-      # Create a new document from raw data
+      # Create a new document with given attributes
       #
-      # @param [Hash] raw_document
+      # @param [Hash] attributes
       # @return [Document] The created document
       # @api public
       # @example Create a new document from raw data
-      #   collection.create(raw_document)
-      def create(raw_document)
-        server_response = send_request("/document?collection=#{@id}", :post => raw_document)
-        Document.new(@database, server_response)
+      #   collection.create_document(attributes)
+      def create_document(attributes)
+        raise "Can't create a document in an edge collection" if @content_type == :edge
+        response = send_request_for_content(:post => attributes)
+        Document.new(@database, response)
       end
 
-      alias :<< :create
+      alias :<< :create_document
+
+      # Create a new edge between two documents with certain attributes
+      #
+      # @param [Document] from
+      # @param [Document] to
+      # @param [Hash] attributes
+      # @return [Edge] The created edge
+      # @api public
+      # @example Create a new document from raw data
+      #   collection.create_edge(node_a, node_b, {"name" => "incredible edge"})
+      def create_edge(from, to, attributes)
+        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)
+      end
 
       # Add an index to the collection
       #
@@ -347,7 +391,7 @@ module Ashikawa
       #   people = database['people']
       #   people.add_index(:hash, :on => [:name, :profession])
       def add_index(type, opts)
-        response = send_request("/index?collection=#{@id}", :post => {
+        response = send_request("index?collection=#{@id}", :post => {
           "type" => type.to_s,
           "fields" => opts[:on].map { |field| field.to_s }
         })
@@ -364,7 +408,7 @@ module Ashikawa
       #   people = database['people']
       #   people.index(1244) #=> #<Index: id=1244...>
       def index(id)
-        server_response = send_request("/index/#{@id}/#{id}")
+        server_response = send_request("index/#{@name}/#{id}")
         Index.new(self, server_response)
       end
 
@@ -376,9 +420,9 @@ module Ashikawa
       #   people = database['people']
       #   people.indices #=> [#<Index: id=1244...>, ...]
       def indices
-        server_response = send_request("/index?collection=#{@id}")
+        response = send_request("index?collection=#{@id}")
 
-        server_response["indexes"].map do |raw_index|
+        response["indexes"].map do |raw_index|
           Index.new(self, raw_index)
         end
       end
@@ -394,6 +438,17 @@ module Ashikawa
         Query.new(self)
       end
 
+      # Check if the collection is volatile
+      #
+      # @return [Boolean]
+      # @api public
+      # @example Is the people collection volatile?
+      #   people = database['people']
+      #   people.volatile? #=> false
+      def volatile?
+        get_information_from_server(:properties, :isVolatile)
+      end
+
       private
 
       # Send a put request with a given key and value to the server
@@ -404,7 +459,7 @@ module Ashikawa
       # @return [Object] The result
       # @api private
       def send_information_to_server(path, key, value)
-        send_request_for_this_collection("/#{path}", :put => { key.to_s => value })
+        send_request_for_this_collection("#{path}", :put => { key.to_s => value })
       end
 
       # Send a put request with the given command
@@ -413,7 +468,7 @@ module Ashikawa
       # @return [Object] The result
       # @api private
       def send_command_to_server(command)
-        send_request_for_this_collection("/#{command}", :put => {})
+        send_request_for_this_collection("#{command}", :put => {})
       end
 
       # Send a get request to the server and return a certain attribute
@@ -423,8 +478,8 @@ module Ashikawa
       # @return [Object] The result
       # @api private
       def get_information_from_server(path, attribute)
-        server_response = send_request_for_this_collection("/#{path}")
-        server_response[attribute.to_s]
+        response = send_request_for_this_collection("#{path}")
+        response[attribute.to_s]
       end
 
       # Send a request to the server with the name of the collection prepended
@@ -432,7 +487,39 @@ module Ashikawa
       # @return [String] Response from the server
       # @api private
       def send_request_for_this_collection(path, method={})
-        send_request("/collection/#{id}#{path}", method)
+        send_request("collection/#{id}/#{path}", method)
+      end
+
+      # Parse information returned from the server
+      #
+      # @param [Hash] raw_collection
+      # @return self
+      # @api private
+      def parse_raw_collection(raw_collection)
+        @name         = raw_collection['name']
+        @id           = raw_collection['id']
+        @content_type = CONTENT_TYPES[raw_collection['type']] || :document
+        @status       = Status.new(raw_collection['status'].to_i) if raw_collection.has_key?('status')
+        self
+      end
+
+      # Send a request for the content with the given id
+      #
+      # @param [Integer] document_id The id of the document
+      # @param [Hash] opts The options for the request
+      # @return [Hash] parsed JSON response from the server
+      # @api private
+      def send_request_for_content_id(document_id, opts = {})
+        send_request("#{@content_type}/#{@id}/#{document_id}", opts)
+      end
+
+      # Send a request for the content of this collection
+      #
+      # @param [Hash] opts The options for the request
+      # @return [Hash] parsed JSON response from the server
+      # @api private
+      def send_request_for_content(opts = {})
+        send_request("#{@content_type}?collection=#{@id}", opts)
       end
     end
   end