ashikawa-core 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 243fdb95bc1ad7691bc5129b1dce1f85ad929792
-  data.tar.gz: e5bc4fda8b7d97e6bf90cf8570227afaff1b9128
+  metadata.gz: 0188e3f9d7f519dd6219ecf2cf7f54d57e2318b6
+  data.tar.gz: a8b0deb872c8771186b23861d7aacf264b16facf
 SHA512:
-  metadata.gz: 31d2dcb8dc2b0ad4c431181cac8cc22daf224215791406dca9d81e4f78f472187e156a4b9e7f36a38a1bc4f9d9f5dfc7bfc806a2c24def3265eefb1d455e6362
-  data.tar.gz: d0bc42d3059d787ea3747c279c0c522d4bcb4558cae5978529e33945726ba3f8f7260c90a447f6a97700f7d19b449d9bd1da03a805426b87ac0223c90cd2ce0d
+  metadata.gz: dd134061b8cfad2f9aee15e9f9fed43b77c8f2bbebf9c19e4932ad53786e66b9a8ce1e42a7c1b593aee4be1086b4a7b90c412cc7ec310869891ee26892c24a58
+  data.tar.gz: 094089ba8bcfdc3776722d3c8aff6a4e21f7c8fe72b353cdfa97a03baf0c79f4742c30740092efa67e1db5f698cb4ac5697a7b8f7609bb2b12fb7907236d6a16

data/.gitignore

@@ -6,6 +6,7 @@
 /Gemfile.lock
 /pkg/*
 /report/*
+/log/*.log
 /measurements/*
 /coverage
 /.rbx

data/.travis.yml

@@ -8,7 +8,7 @@ rvm:
   - jruby-1.7.12
   - rbx-2.2.6
 env:
-  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.0
+  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.1
 matrix:
   allow_failures:
     - rvm: 2.1.0

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# Version 0.12.0
+
+**Codename: V for Verifying**
+
+* Support for ArangoDB 2.1
+* Accept single attributes in add_index (#120)
+* JSON is no longer a runtime dependency but a development dependency (#118)
+* Make database name explicit (#117)
+* **Breaking Change:** Removed 'prima donna methods' 
+* Using a less verbose logging middleware (#124)
+* Refactored the internal connection creation to support better external configuration (#126)
+* Development only:
+  * Using Rspec 3.0
+  * Switched to verifying doubles
+* New Contributors
+  * Ujjwal Thaakar (@ujjwalt)
+  * René Föhring (@rrrene)
+
 # Version 0.11
 
 **Codename: R3C0NF1GUR3D**

data/Gemfile

@@ -3,6 +3,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-%w( core mocks expectations support its ).each do |name|
-  gem "rspec-#{name}", github: "rspec/rspec-#{name}"
-end
+gem 'rspec-its', git: 'https://github.com/rspec/rspec-its.git'

data/README.md

@@ -6,10 +6,11 @@
 | 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)
 | 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.0**.
+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**.
 
 All tests run on Travis CI for the following versions of Ruby:
 
@@ -26,7 +27,7 @@ gem install ashikawa-core
 or, when using bundler:
 
 ```ruby
-gem "ashikawa-core", "~> 0.11"
+gem "ashikawa-core"
 ```
 
 ## How to Setup a Connection?
@@ -43,7 +44,8 @@ If you want to access the `my_db` database of your ArangoDB instance (and not th
 
 ```ruby
 database = Ashikawa::Core::Database.new do |config|
-  config.url = "http://localhost:8529/_db/my_db"
+  config.url = "http://localhost:8529"
+  configl.database_name = 'my_db'
   config.username = "lebowski"
   config.password = "i<3bowling"
 end
@@ -88,3 +90,5 @@ If you want to contribute to the project, see CONTRIBUTING.md for details. It co
 * Nikita Vasiliev ([@sharpyfox](https://github.com/sharpyfox)): Contributor
 * Dirk Breuer ([@railsbros-dirk](https://github.com/railsbros-dirk)): Contributor
 * Mike Williamson ([@sleepycat](https://github.com/sleepycat)): Contributor
+* Ujjwal Thaakar ([@ujjwalt](https://github.com/ujjwalt)): Contributor
+* René Föhring ([@rrrene](https://github.com/rrrene)): Contributor

data/Rakefile

@@ -34,6 +34,7 @@ namespace :metrics do
 
   desc 'Run mutant to check for mutation coverage'
   task :mutant do
+    raise 'mutant-rspec is not compatible with RSpec 3.0.0 right now'
     require 'mutant'
     require 'mutant-rspec'
 

data/ashikawa-core.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.license = 'Apache License 2.0'
 
   gem.required_ruby_version = '>= 1.9.3'
-  gem.requirements << 'ArangoDB, v2.0'
+  gem.requirements << 'ArangoDB, v2.1'
 
   gem.rubyforge_project = 'ashikawa-core'
 
@@ -25,23 +25,23 @@ Gem::Specification.new do |gem|
   # Runtime Dependencies
   gem.add_dependency 'faraday', '~> 0.9.0'
   gem.add_dependency 'faraday_middleware', '~> 0.9.1'
-  gem.add_dependency 'json', '~> 1.8.1'
-  gem.add_dependency 'null_logger', '~> 0.0.1'
   gem.add_dependency 'equalizer', '~> 0.0.8'
 
   # Development Dependencies
-  gem.add_development_dependency 'rake', '~> 10.3.1'
-  gem.add_development_dependency 'rspec', '~> 3.0.0.beta2'
+  gem.add_development_dependency 'rake', '~> 10.3.2'
+  gem.add_development_dependency 'json', '~> 1.8.1'
+  gem.add_development_dependency 'rspec', '~> 3.0.0'
   gem.add_development_dependency 'rspec-its', '~> 1.0.1'
   gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.3.0'
+  gem.add_development_dependency 'logging', '~> 1.8.1'
   gem.add_development_dependency 'yard', '~> 0.8.7.4'
-  gem.add_development_dependency 'inch', '~> 0.4.5'
+  gem.add_development_dependency 'inch', '~> 0.4.6'
   gem.add_development_dependency 'reek', '~> 1.3.7'
-  gem.add_development_dependency 'mutant', '~> 0.5.12'
-  gem.add_development_dependency 'mutant-rspec', '~> 0.5.3'
+  # gem.add_development_dependency 'mutant', '~> 0.5.18'
+  # gem.add_development_dependency 'mutant-rspec', '~> 0.5.17'
   gem.add_development_dependency 'pry', '~> 0.9.12.6'
   gem.add_development_dependency 'guard', '~> 2.6.1'
-  # gem.add_development_dependency 'guard-rspec', '~> 4.2.8'
+  gem.add_development_dependency 'guard-rspec', '~> 4.2.9'
   gem.add_development_dependency 'guard-bundler', '~> 2.0.0'
 
   # Rubinius specific dependencies
@@ -49,6 +49,4 @@ Gem::Specification.new do |gem|
     gem.add_dependency 'rubysl-base64'
     gem.add_dependency 'rubysl-singleton'
   end
-
-  # JRuby specific dependencies
 end

data/config/reek.yml

@@ -30,7 +30,7 @@ IrresponsibleModule:
 LongParameterList:
   enabled: true
   exclude: []
-  max_params: 3
+  max_params: 4
   overrides: {}
 LongYieldList:
   enabled: true
@@ -45,7 +45,6 @@ NilCheck:
   enabled: true
   exclude:
   - Ashikawa::Core::Configuration#setup_new_connection
-  - Ashikawa::Core::Connection#database_name
 RepeatedConditional:
   enabled: true
   exclude:
@@ -54,7 +53,7 @@ RepeatedConditional:
 TooManyInstanceVariables:
   enabled: true
   exclude: []
-  max_instance_variables: 12
+  max_instance_variables: 6
 TooManyMethods:
   enabled: true
   exclude:
@@ -64,7 +63,8 @@ TooManyMethods:
 TooManyStatements:
   enabled: true
   exclude:
-  - Ashikawa::Core::Connection#initialize
+  - Ashikawa::Core::FaradayFactory#self.create_connection
+  - Ashikawa::Core::FaradayFactory#faraday_for
   - Ashikawa::Core::ErrorResponse#on_complete
   - Ashikawa::Core::Figure#initialize
   max_statements: 6
@@ -107,5 +107,5 @@ UtilityFunction:
   exclude: []
   max_helper_calls: 0
 PrimaDonnaMethod:
-  enabled: false
+  enabled: true
   exclude: []

data/lib/ashikawa-core/collection.rb

@@ -420,7 +420,11 @@ module Ashikawa
       # @example Add a hash-index to the fields :name and :profession of a collection
       #   people = database['people']
       #   people.add_index(:hash, :on => [:name, :profession])
+      # @example Add a hash-index to the field :email of a collection
+      #   user = database['user']
+      #   user.add_index(:hash, :on => :email)
       def add_index(type, options)
+        options[:on] = [options[:on]].flatten
         unique = options.fetch(:unique, false)
         response = send_request("index?collection=#{@id}", post: {
           'type' => type.to_s,

data/lib/ashikawa-core/configuration.rb

@@ -35,6 +35,11 @@ module Ashikawa
       # @return String
       attr_accessor :password
 
+      # The name of the database you want to talk with
+      # @api private
+      # @return String
+      attr_writer :database_name
+
       # The Connection object
       # @api private
       # @return Connection
@@ -44,6 +49,13 @@ module Ashikawa
         @connection
       end
 
+      # The name of the database you want to talk with
+      # @api private
+      # @return String
+      def database_name
+        @database_name ||= '_system'
+      end
+
       private
 
       # Setup the connection object
@@ -56,7 +68,7 @@ module Ashikawa
       def setup_new_connection
         raise(ArgumentError, 'Please provide either an url or a connection to setup the database') if url.nil?
 
-        Connection.new(url, connection_options)
+        Connection.new(url, database_name, connection_options)
       end
 
       def connection_options

data/lib/ashikawa-core/connection.rb

@@ -1,11 +1,9 @@
 # -*- encoding : utf-8 -*-
 require 'forwardable'
 require 'faraday'
-require 'null_logger'
-require 'uri'
 require 'equalizer'
-require 'faraday_middleware'
 require 'ashikawa-core/error_response'
+require 'ashikawa-core/faraday_factory'
 
 module Ashikawa
   module Core
@@ -21,7 +19,7 @@ module Ashikawa
       # @return [String]
       # @api public
       # @example Get the host part of the connection
-      #   connection = Connection.new('http://localhost:8529')
+      #   connection = Connection.new('http://localhost:8529', '_system')
       #   connection.host # => 'localhost'
       def_delegator :@connection, :host
 
@@ -31,7 +29,7 @@ module Ashikawa
       # @return [String]
       # @api public
       # @example Get the scheme of the connection
-      #   connection = Connection.new('http://localhost:8529')
+      #   connection = Connection.new('http://localhost:8529', '_system')
       #   connection.scheme # => 'http'
       def_delegator :@connection, :scheme
 
@@ -41,7 +39,7 @@ module Ashikawa
       # @return [Fixnum]
       # @api public
       # @example Get the port of the connection
-      #   connection = Connection.new('http://localhost:8529')
+      #   connection = Connection.new('http://localhost:8529', '_system')
       #   connection.port # => 8529
       def_delegator :@connection, :port
 
@@ -50,47 +48,42 @@ module Ashikawa
       # @return [Faraday]
       # @api public
       # @example Set additional response middleware
-      #   connection = Connection.new('http://localhost:8529')
+      #   connection = Connection.new('http://localhost:8529', '_system')
       #   connection.connection.response :caching
       attr_reader :connection
 
+      # The name of the database you want to talk with
+      # @return [String]
+      # @api public
+      # @example Get the name of the database
+      #   connection = Connection.new('http://localhost:8529', 'ashikawa')
+      #   connection.database_name # => 'ashikawa'
+      attr_reader :database_name
+
       # Initialize a Connection with a given API String
       #
       # @param [String] api_string scheme, hostname and port as a String
+      # @param [String] database_name The name of the database you want to communicate with
       # @option options [Object] adapter The Faraday adapter you want to use. Defaults to Default Adapter
-      # @option options [Object] logger The logger you want to use. Defaults to Null Logger.
-      # @api public
-      # @example Create a new Connection
-      #  connection = Connection.new('http://localhost:8529')
-      def initialize(api_string, options = {})
-        logger  = options.fetch(:logger) { NullLogger.instance }
-        adapter = options.fetch(:adapter) { Faraday.default_adapter }
-
-        @connection = Faraday.new("#{api_string}/_api") do |connection|
-          connection.request :json
-
-          connection.response :logger, logger
-          connection.response :error_response
-          connection.response :json
-
-          connection.adapter(*adapter)
-        end
-      end
-
-      # Get the name of the current database
-      #
+      # @option options [Object] debug_headers Should HTTP header be logged or not
+      # @option options [Object] logger The logger you want to use. Defaults to no logger.
+      # @option options [Array] additional_request_middlewares Additional request middlewares
+      # @option options [Array] additional_response_middlewares Additional response middlewares
+      # @option options [Array] additional_middlewares Additional middlewares
       # @api public
-      # @example Get the name of the database
-      #   connection = Connection.new('http://localhost:8529/_db/ashikawa')
-      #   connection.database_name # => 'ashikawa'
-      def database_name
-        database_regexp = %r{_db/(?<db_name>\w+)/_api}
-        result = @connection.url_prefix.to_s.match(database_regexp)
-        if result.nil?
-          '_system'
-        else
-          result['db_name']
-        end
+      # @example Create a new Connection with no additional options
+      #  connection = Connection.new('http://localhost:8529', '_system')
+      # @example Create a new Connection with additional options
+      #  connection = Connection.new('http://localhost:8529', '_system', {
+      #    adapter: :typhoeus,
+      #    logger: Yell.new(STDOUT),
+      #    additional_request_middleware: [:my_request_middleware]
+      #    additional_response_middleware: [:my_response_middleware]
+      #  })
+      def initialize(api_string, database_name, options = {})
+        @api_string = api_string
+        @database_name = database_name
+        @connection = FaradayFactory.create_connection("#{api_string}/_db/#{database_name}/_api", options)
       end
 
       # Sends a request to a given path returning the parsed result
@@ -124,7 +117,7 @@ module Ashikawa
       # @example post request
       #   connection.send_request('/collection/new_collection', :post => { :name => 'new_collection' })
       def send_request_without_database_suffix(path, params = {})
-        send_request(uri_without_database_suffix(path), params)
+        send_request("#{@api_string}/_api/#{path}", params)
       end
 
       # Checks if authentication for this Connection is active or not
@@ -132,7 +125,7 @@ module Ashikawa
       # @return [Boolean]
       # @api public
       # @example Is authentication activated for this connection?
-      #   connection = Connection.new('http://localhost:8529')
+      #   connection = Connection.new('http://localhost:8529', '_system')
       #   connection.authentication? #=> false
       #   connection.authenticate_with(:username => 'james', :password => 'bond')
       #   connection.authentication? #=> true
@@ -152,17 +145,6 @@ module Ashikawa
 
       private
 
-      # Build an URI without the database suffix
-      #
-      # @param [String] additional_path The path you want to access
-      # @return [URI] The resulting URI
-      # @api private
-      def uri_without_database_suffix(additional_path = '')
-        uri = @connection.url_prefix
-        base_uri = [uri.scheme, '://', uri.host, ':', uri.port].join
-        [base_uri, '_api', additional_path].join('/')
-      end
-
       # Return the HTTP Verb for the given parameters
       #
       # @param [Hash] params The params given to the method

data/lib/ashikawa-core/database.rb

@@ -36,7 +36,7 @@ module Ashikawa
       #     config.url = 'http://localhost:8529'
       #   end
       # @example Access a Database by providing a Connection and authentication
-      #   connection = Connection.new('http://localhost:8529')
+      #   connection = Connection.new('http://localhost:8529', '_system')
       #   database = Ashikawa::Core::Database.new do |config|
       #     config.connection = connection
       #     config.username = 'lebowski'
@@ -44,8 +44,9 @@ module Ashikawa
       #   end
       # @example Access a certain database from ArangoDB
       #   database = Ashikawa::Core::Database.new do |config|
-      #     config.url = 'http://localhost:8529/_db/my_db'
+      #     config.url = 'http://localhost:8529'
       #     config.connection = connection
+      #     config.database_name = 'my_db'
       #   end
       # @example Access a Database with a logger and custom HTTP adapter
       #   database = Ashikawa::Core::Database.new do |config|
@@ -63,7 +64,8 @@ module Ashikawa
       #
       # @example Create a new database with the name 'ashikawa'
       #   database = Ashikawa::Core::Database.new do |config|
-      #     config.url = 'http://localhost:8529/_db/ashikawa'
+      #     config.url = 'http://localhost:8529'
+      #     config.database_name = 'ashikawa'
       #   end
       #   database.create
       def create
@@ -74,7 +76,8 @@ module Ashikawa
       #
       # @example Drop a new database with the name 'ashikawa'
       #   database = Ashikawa::Core::Database.new do |config|
-      #     config.url = 'http://localhost:8529/_db/ashikawa'
+      #     config.url = 'http://localhost:8529'
+      #     config.database_name = 'ashikawa'
       #   end
       #   database.drop
       def drop
@@ -98,7 +101,8 @@ module Ashikawa
       # @api public
       # @example Get the name of the databasse
       #   database = Ashikawa::Core::Database.new do |config|
-      #     config.url = 'http://localhost:8529/_api/ashikawa'
+      #     config.url = 'http://localhost:8529'
+      #     config.database_name = 'ashikawa'
       #   end
       #   database.name # => 'ashikawa'
       def name

data/lib/ashikawa-core/document.rb

@@ -56,8 +56,8 @@ module Ashikawa
       # @api semipublic
       # @example Check if the document is persisted
       #   document = Ashikawa::Core::Document.new(database, raw_document)
-      #   document.check_if_persisted!
-      def check_if_persisted!
+      #   document.check_if_persisted
+      def check_if_persisted
         raise DocumentNotFoundException if @id == :not_persisted
       end
 
@@ -81,7 +81,7 @@ module Ashikawa
       #   document = Ashikawa::Core::Document.new(database, raw_document)
       #   document.delete
       def delete
-        check_if_persisted!
+        check_if_persisted
         send_request_for_document(delete: {})
       end
 
@@ -118,7 +118,7 @@ module Ashikawa
       #   document['occupation'] = 'Not occupied'
       #   document.save
       def save
-        check_if_persisted!
+        check_if_persisted
         send_request_for_document(put: @content)
       end
 
@@ -128,8 +128,8 @@ module Ashikawa
       # @api public
       # @example Refresh the document
       #   document = Ashikawa::Core::Document.new(database, raw_document)
-      #   document.refresh!
-      def refresh!
+      #   document.refresh
+      def refresh
         parse_raw_document(send_request_for_document)
       end