ashikawa-core 0.3.0 → 0.4.1

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+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. Write an Integration Test: Describe what you want to do (our integration tests touch the database)
+3. Implement it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
+4. Write Documentation for it.
+5. Check with `rake` that everything is fine and send the Pull Request :)
+
+## How to get started developing
+
+Getting started is easy, just follow these steps.
+
+### In a nutshell
+
+* Clone the project.
+* `cd` into the folder and run `bundle` 
+* `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 `rake` to see all tests passing (hopefully). Happy coding!
+
+You can also start up yard for documentation: `rake yard:server`
+
+### 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 `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
+
+### Continuous Integration
+
+Our tests are run on Travis CI, the build status is displayed above. **Please note** that it only runs the unit tests and not the integration tests, because that would require ArangoDB to be installed on the Travis CI boxes. *Therefore green doesn't neccessarily mean green* (which is unfortunate). Therefore it is important that you run the integration tests on your local machine before sending the pull requests.

data/Guardfile

@@ -6,12 +6,12 @@ guard 'yard' do
   watch(%r{lib/.+\.rb})
 end
 
-guard 'rspec', :version => 2, :spec_paths => "spec/unit" do
+guard 'rspec', :spec_paths => "spec/unit" do
   watch(%r{lib/.+\.rb})
   watch(%r{spec/.+\.rb})
 end
 
-guard 'rspec', :version => 2, :spec_paths => "spec/integration" do
+guard 'rspec', :spec_paths => "spec/integration" do
   watch(%r{lib/.+\.rb})
   watch(%r{spec/.+\.rb})
 end

data/README.md

@@ -18,47 +18,6 @@ database["my_collection"].name = "new_name"
 database["new_name"].delete
 ```
 
-## How to get started developing
+# Contributing
 
-Getting started is easy, just follow these steps.
-
-### In a nutshell
-
-* Clone the project.
-* `cd` into the folder and run `bundle` 
-* `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 `rake` to see all tests passing (hopefully). Happy coding!
-
-You can also start up yard for documentation: `rake yard:server`
-
-### 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 `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
-
-### Continuous Integration
-
-Our tests are run on Travis CI, the build status is displayed above. **Please note** that it only runs the unit tests and not the integration tests, because that would require ArangoDB to be installed on the Travis CI boxes. *Therefore green doesn't neccessarily mean green* (which is unfortunate).
-
-## Contributing
-
-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. Write an Integration Test: Describe what you want to do (our integration tests touch the database)
-3. Implement it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
-4. Write Documentation for it.
-5. Check with `rake` that everything is fine and send the Pull Request :)
+If you want to contribute to the project, see CONTRIBUTING.md for details.

data/Rakefile

@@ -12,12 +12,18 @@ namespace :spec do
     spec.rspec_opts = "--require integration/arango_helper.rb"
     spec.pattern = "spec/integration/*_spec.rb"
   end
-  
+
+  desc "Run the authentication integration tests. Requires ArangoDB."
+  RSpec::Core::RakeTask.new(:integration_auth) do |spec|
+    spec.rspec_opts = "--require integration_auth/arango_helper.rb"
+    spec.pattern = "spec/integration_auth/*_spec.rb"
+  end
+
   desc "Run the unit tests"
   RSpec::Core::RakeTask.new(:unit) do |spec|
     spec.pattern = "spec/unit/*_spec.rb"
   end
-  
+
   desc "Run all tests. Requires ArangoDB"
   task :all => [:integration, :unit]
 end
@@ -37,7 +43,7 @@ namespace :yard do
   # Yardstick::Rake::Measurement.new(:report) do |measurement|
   #   measurement.output = 'report/measurement.txt'
   # end
-  
+
   # Yardstick::Rake::Verify.new(:verify) do |verify|
   #   verify.threshold = 100
   # end
@@ -46,12 +52,12 @@ namespace :yard do
   task :generate do
     `yard`
   end
-  
+
   desc "start the documentation server on port 8808"
   task :server do
     `yard server --reload`
   end
-  
+
   desc "get statistics on the yard documentation"
   task :stats do
     `yard stats`

data/ashikawa-core.gemspec

@@ -31,18 +31,19 @@ Gem::Specification.new do |gem|
   else
     # RedCarpet is not compatible with JRuby
     # It is only needed to generate the YARD Documentation
-    gem.add_development_dependency "redcarpet", "~> 2.1.1"
+    gem.add_development_dependency "redcarpet", "~> 2.2.1"
   end
 
   # Development Dependencies
   gem.add_development_dependency "rake", "~> 0.9.2.2"
   gem.add_development_dependency "rspec", "~> 2.11.0"
-  gem.add_development_dependency "yard", "~> 0.8.2.1"
+  gem.add_development_dependency "yard", "~> 0.8.3"
   gem.add_development_dependency "webmock", "~> 1.8.9"
   # gem.add_development_dependency "yardstick", "~> 0.6.0"
 
-  gem.add_development_dependency "guard", "~> 1.3.2"
-  gem.add_development_dependency "guard-rspec", "~> 1.2.1"
+  gem.add_development_dependency "guard", "~> 1.4.0"
+  gem.add_development_dependency "guard-rspec", "~> 2.1.0"
   gem.add_development_dependency "guard-bundler", "~> 1.0.0"
   gem.add_development_dependency "guard-yard", "~> 2.0.0"
+  gem.add_development_dependency "rb-fsevent", "~> 0.9.1"
 end

data/lib/ashikawa-core/connection.rb

@@ -5,14 +5,23 @@ module Ashikawa
   module Core
     # Represents a Connection via HTTP to a certain host
     class Connection
-      # The IP of the connection
+      # The host part of the connection
       #
       # @return [String]
       # @api public
-      # @example Get the IP of the connection
+      # @example Get the host part of the connection
       #   connection = Connection.new "http://localhost:8529"
-      #   connection.ip # => "http://localhost"
-      attr_reader :ip
+      #   connection.host # => "localhost"
+      attr_reader :host
+
+      # The scheme of the connection
+      #
+      # @return [String]
+      # @api public
+      # @example Get the scheme of the connection
+      #   connection = Connection.new "http://localhost:8529"
+      #   connection.scheme # => "http"
+      attr_reader :scheme
 
       # The port of the connection
       #
@@ -23,16 +32,42 @@ module Ashikawa
       #   connection.port # => 8529
       attr_reader :port
 
+      # Username and password of the connection
+      #
+      # Needed if the database is running with HTTP base authentication
+      # enabled. Username and password are sent with every request to
+      # authenticate against the database.
+      #
+      # You can set these properties with the `authenticate_with` method
+      #
+      # @api public
+      attr_reader :username, :password
+
       # Initialize a Connection with a given API String
       #
-      # @param [String] api_string IP and Port as a String
+      # @param [String] api_string scheme, hostname and port as a String
       # @api public
       # @example Create a new Connection
       #  connection = Connection.new "http://localhost:8529"
       def initialize(api_string="http://localhost:8529")
         @api_string = api_string
-        @ip, @port = @api_string.scan(/(\S+):(\d+)/).first
-        @port = @port.to_i
+
+        require 'uri'
+        uri = URI(@api_string)
+        @host = uri.host
+        @port = uri.port
+        @scheme = uri.scheme
+      end
+
+      def authenticate_with(options={})
+        if options.key? :username and options.key? :password
+          @username = options[:username]
+          @password = options[:password]
+        else
+          raise ArgumentError, 'missing username or password'
+        end
+
+        self
       end
 
       # Sends a request to a given path (Prepends the api_string automatically)
@@ -47,7 +82,7 @@ module Ashikawa
       # @return [Hash] parsed JSON response from the server
       # @api semipublic
       def send_request(path, method_params = {})
-        path = "#{@api_string}/_api/#{path.gsub(/^\//, '')}"
+        path = "#{url}/_api/#{path.gsub(/^\//, '')}"
 
         answer = if method_params.has_key? :post
           RestClient.post path, method_params[:post].to_json
@@ -61,6 +96,21 @@ module Ashikawa
 
         JSON.parse answer
       end
+
+      def authentication?
+        !!@username
+      end
+
+      private
+
+      def url
+        if authentication?
+          "#{@scheme}://#{@username}:#{@password}@#{@host}:#{@port}"
+        else
+          @api_string
+        end
+      end
+
     end
   end
 end

data/lib/ashikawa-core/database.rb

@@ -9,10 +9,12 @@ module Ashikawa
     class Database
       extend Forwardable
 
-      # Delegate sending requests and managing IP and port  to the connection
+      # Delegate sending requests to the connection
       delegate send_request: :@connection
-      delegate ip:           :@connection
-      delegate port:         :@connection
+      delegate host: :@connection
+      delegate port: :@connection
+      delegate scheme: :@connection
+      delegate authenticate_with: :@connection
 
       # Initializes the connection to the database
       #

data/lib/ashikawa-core/version.rb

@@ -1,6 +1,6 @@
 module Ashikawa
   module Core
     # Current version of Ashikawa::Core
-    VERSION = "0.3.0"
+    VERSION = "0.4.1"
   end
 end

data/spec/integration_auth/arango_helper.rb

@@ -0,0 +1,30 @@
+RSpec.configure do |config|
+  raise "Could not find arangod. Please install it or check if it is in your path." if `which arangod` == ""
+
+  database_directory = "/tmp/ashikawa-integration-auth"
+  arango_process = false
+
+  config.before(:suite) do
+    puts "Generating user with password"
+    `arango-password --database #{database_directory} testuser testpassword`
+
+    puts "Starting ArangoDB with authentication enabled"
+    process_id = $$
+
+    Dir.mkdir database_directory unless Dir.exists? database_directory
+    arango_process = IO.popen("arangod #{database_directory} --server.http-auth yes --watch-process #{process_id}")
+
+    sleep 2 # Wait for Arango to start up
+  end
+
+  config.after(:suite) do
+    puts
+    puts "Shutting down ArangoDB"
+
+    Process.kill "INT", arango_process.pid
+    sleep 2  # Wait for Arango to shut down
+    arango_process.close
+
+    `rm -r #{database_directory}/*`
+  end
+end

data/spec/integration_auth/auth_spec.rb

@@ -0,0 +1,40 @@
+require 'integration/spec_helper'
+
+describe "authenticated database" do
+  subject { ARANGO_HOST }
+
+  it "should have booted up an ArangoDB instance" do
+    expect { RestClient.get(subject) }.to raise_error RestClient::Unauthorized
+  end
+
+  context "authentication" do
+    subject { Ashikawa::Core::Database.new ARANGO_HOST }
+
+    context "without user and password" do
+      it "should not allow access to DB" do
+        expect do
+          subject["new_collection"]
+        end.to raise_error RestClient::Unauthorized
+      end
+    end
+
+    context "with user and password" do
+      it "should allow acces to DB" do
+        subject.authenticate_with username: 'testuser', password: 'testpassword'
+
+        expect do
+          subject["new_collection"]
+          subject["new_collection"].delete
+        end.to_not raise_error
+      end
+
+      it "should deny acces if username and password are wrong" do
+        subject.authenticate_with username: 'ruffy', password: 'three_headed_monkey'
+
+        expect do
+          subject["denied"]
+        end.to raise_error RestClient::Unauthorized
+      end
+    end
+  end
+end

data/spec/integration_auth/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "rest-client"
+require "json"
+require "ashikawa-core"
+
+ARANGO_HOST = "http://localhost:8529"

data/spec/unit/connection_spec.rb

@@ -4,16 +4,19 @@ require 'ashikawa-core/connection'
 describe Ashikawa::Core::Connection do
   subject { Ashikawa::Core::Connection }
 
-  it "should have an IP and port" do
+  it "should have a scheme, hostname and port" do
     connection = subject.new "http://localhost:8529"
 
-    connection.ip.should == "http://localhost"
+    connection.scheme.should == "http"
+    connection.host.should == "localhost"
     connection.port.should == 8529
   end
 
-  it "should default to localhost and ArangoDB port" do
+  it "should default to HTTP, localhost and ArangoDB port" do
     connection = subject.new
-    connection.ip.should == "http://localhost"
+
+    connection.scheme.should == "http"
+    connection.host.should == "localhost"
     connection.port.should == 8529
   end
 
@@ -58,4 +61,48 @@ describe Ashikawa::Core::Connection do
       subject.send_request("/my/path").should == {"name" => "dude"}
     end
   end
+
+  describe "authentication" do
+    subject { Ashikawa::Core::Connection.new }
+
+    it "should authenticate with username and password" do
+      subject.authenticate_with username: "testuser", password: "testpassword"
+
+      subject.username.should == "testuser"
+      subject.password.should == "testpassword"
+    end
+
+    it "should have authentication turned off by default" do
+      subject.authentication?.should be_false
+    end
+
+    it "should tell if authentication is enabled" do
+      subject.authenticate_with username: "testuser", password: "testpassword"
+      subject.authentication?.should be_true
+    end
+
+    it "should only accept a username & password pairs" do
+      expect {
+        subject.authenticate_with username: "kitty"
+      }.to raise_error(ArgumentError)
+
+      expect {
+        subject.authenticate_with password: "cheezburger?"
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should allow chaining" do
+      subject.authenticate_with(username: "a", password: "b").should == subject
+    end
+
+    it "should send the authentication data with every GET request" do
+      stub_request(:get, "http://user:pass@localhost:8529/_api/my/path").to_return body: '{ "name": "dude" }'
+
+      subject.authenticate_with username: "user", password: "pass"
+      subject.send_request "/my/path"
+
+      WebMock.should have_requested(:get, "http://user:pass@localhost:8529/_api/my/path")
+    end
+  end
+
 end

data/spec/unit/database_spec.rb

@@ -12,11 +12,11 @@ describe Ashikawa::Core::Database do
   end
 
   it "should initialize with a connection" do
-    @connection.stub(:ip) { "http://localhost" }
+    @connection.stub(:host) { "localhost" }
     @connection.stub(:port) { 8529 }
 
     database = subject.new @connection
-    database.ip.should == "http://localhost"
+    database.host.should == "localhost"
     database.port.should == 8529
   end
 
@@ -30,6 +30,12 @@ describe Ashikawa::Core::Database do
   describe "initialized database" do
     subject { Ashikawa::Core::Database.new @connection }
 
+    it "should delegate authentication to the connection" do
+      @connection.should_receive(:authenticate_with).with({ username: "user", password: "password" })
+
+      subject.authenticate_with username: "user", password: "password"
+    end
+
     it "should fetch all available collections" do
       @connection.stub(:send_request) {|path| server_response("collections/all") }
       @connection.should_receive(:send_request).with("/collection")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ashikawa-core
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +83,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.2.1
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +91,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.2.1
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +115,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +131,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 description: Ashikawa Core is a wrapper around the ArangoDB REST API. It provides
   low level access and will be used in different ArangoDB ODMs.
 email:
@@ -184,6 +200,7 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -226,6 +243,9 @@ files:
 - spec/integration/index_spec.rb
 - spec/integration/query_spec.rb
 - spec/integration/spec_helper.rb
+- spec/integration_auth/arango_helper.rb
+- spec/integration_auth/auth_spec.rb
+- spec/integration_auth/spec_helper.rb
 - spec/unit/collection_spec.rb
 - spec/unit/connection_spec.rb
 - spec/unit/cursor_spec.rb
@@ -286,6 +306,9 @@ test_files:
 - spec/integration/index_spec.rb
 - spec/integration/query_spec.rb
 - spec/integration/spec_helper.rb
+- spec/integration_auth/arango_helper.rb
+- spec/integration_auth/auth_spec.rb
+- spec/integration_auth/spec_helper.rb
 - spec/unit/collection_spec.rb
 - spec/unit/connection_spec.rb
 - spec/unit/cursor_spec.rb