visor-auth 0.0.1

data/lib/auth/server.rb

@@ -0,0 +1,215 @@
+require 'sinatra/base'
+require 'json'
+require 'uri'
+
+module Visor
+  module Auth
+
+    # The VISoR Auth Server class. This class supports all users and groups management
+    # operations through the REST API implemented along the following routes.
+    #
+    class Server < Sinatra::Base
+      include Visor::Common::Exception
+      include Visor::Common::Config
+
+      # Configuration
+      #
+      configure do
+        backend_map = {'mongodb' => Visor::Auth::Backends::MongoDB,
+                       'mysql'   => Visor::Auth::Backends::MySQL}
+
+        #TODO: catch error when Config does not found a key (like :visor_auth) in config file:
+        # /Users/joaodrp/workspace/visor/common/lib/common/config.rb:65:in `load_config': undefined method `merge' for nil:NilClass (NoMethodError)
+        conf = Visor::Common::Config.load_config(:visor_auth)
+        log  = Visor::Common::Config.build_logger(:visor_auth)
+
+        DB = backend_map[conf[:backend].split(':').first].connect uri: conf[:backend]
+
+        disable :show_exceptions, :logging #, :protection
+        use Rack::CommonLogger, log
+      end
+
+      #configure :development do
+        #require 'sinatra/reloader'
+        #register Sinatra::Reloader
+      #end
+
+      # Helpers
+      #
+      helpers do
+        def json_error(code, message)
+          error code, {code: code, message: message}.to_json
+        end
+      end
+
+      # Filters
+      #
+      before do
+        @parse_opts = {symbolize_names: true}
+        content_type :json
+      end
+
+      # Routes
+      #
+
+      # @method get_users
+      # @overload get '/users'
+      #
+      # Get information about all registered users.
+      #
+      #   { "users": [{
+      #       "_id":<_id>,
+      #       "access_key":<access_key>,
+      #       "secret_key":<secret_key>,
+      #       "email":<email>,
+      #       "created_at":<creation timestamp>,
+      #       "updated_at":<update timestamp>,
+      #       }, ...]}
+      #
+      # The following options can be passed as query parameters.
+      #
+      # @param [String] access_key The user access_key.
+      # @param [String] email The user email address.
+      # @param [Date] created_at The image creation timestamp.
+      # @param [Date] updated_at The image update timestamp.
+      #
+      # @return [JSON] The registered users information.
+      #
+      # @raise [HTTP Error 404] If there is no registered users.
+      #
+      get '/users' do
+        begin
+          users = DB.get_users(params)
+          {users: users}.to_json
+        rescue NotFound => e
+          json_error 404, e.message
+        end
+      end
+
+      # @method get_user
+      # @overload get '/users/:access_key'
+      #
+      # Get information about a specific user.
+      #
+      #   {"image": {
+      #       "_id":<_id>,
+      #       "access_key":<access_key>,
+      #       "secret_key":<secret_key>,
+      #       "email":<email>,
+      #       "created_at":<creation timestamp>,
+      #       "updated_at":<update timestamp>
+      #   }}
+      #
+      # @param [String] access_key The wanted user access_key.
+      #
+      # @return [JSON] The user detailed information.
+      #
+      # @raise [HTTP Error 404] If user not found.
+      #
+      get '/users/:access_key' do |access_key|
+        begin
+          user = DB.get_user(access_key)
+          {user: user}.to_json
+        rescue NotFound => e
+          json_error 404, e.message
+        end
+      end
+
+      # @method post
+      # @overload post '/users'
+      #
+      # Registers a new user and returns its data.
+      #
+      # @param [JSON] http-body The user information.
+      #
+      # @return [JSON] The already created user detailed information.
+      #
+      # @raise [HTTP Error 400] User information validation errors.
+      # @raise [HTTP Error 404] User not found after registered.
+      # @raise [HTTP Error 409] access_key was already taken.
+      #
+      post '/users' do
+        begin
+          info = JSON.parse(request.body.read, @parse_opts)
+          user = DB.post_user(info[:user])
+          {user: user}.to_json
+        rescue NotFound => e
+          json_error 404, e.message
+        rescue ArgumentError => e
+          json_error 400, e.message
+        rescue ConflictError => e
+          json_error 409, e.message
+        end
+      end
+
+      # @method put
+      # @overload put '/users/:access_key'
+      #
+      # Update an existing user information and return it.
+      #
+      # @param [String] access_key The wanted user access_key.
+      # @param [JSON] http-body The user information.
+      #
+      # @return [JSON] The already updated user detailed information.
+      #
+      # @raise [HTTP Error 400] User information validation errors.
+      # @raise [HTTP Error 404] User not found.
+      #
+      put '/users/:access_key' do |access_key|
+        begin
+          info = JSON.parse(request.body.read, @parse_opts)
+          user = DB.put_user(access_key, info[:user])
+          {user: user}.to_json
+        rescue NotFound => e
+          json_error 404, e.message
+        rescue ArgumentError => e
+          json_error 400, e.message
+        end
+      end
+
+      # @method delete
+      # @overload delete '/users/:access_key'
+      #
+      # Delete an user and returns its information.
+      #
+      # @param [String] access_key The wanted user access_key.
+      #
+      # @return [JSON] The already deleted user detailed information.
+      #
+      # @raise [HTTP Error 404] User not found.
+      #
+      delete '/users/:access_key' do |access_key|
+        begin
+          user = DB.delete_user(access_key)
+          {user: user}.to_json
+        rescue NotFound => e
+          json_error 404, e.message
+        end
+      end
+
+      # misc handlers: error, not_found, etc.
+      get "*" do
+        json_error 404, 'Invalid operation or path.'
+      end
+
+      put "*" do
+        json_error 404, 'Invalid operation or path.'
+      end
+
+      post "*" do
+        json_error 404, 'Invalid operation or path.'
+      end
+
+      delete "*" do
+        json_error 404, 'Invalid operation or path.'
+      end
+
+      error do
+        json_error 500, env['sinatra.error'].message
+      end
+
+    end
+  end
+end
+
+

data/lib/auth/version.rb

@@ -0,0 +1,5 @@
+module Visor
+  module Auth
+    VERSION = "0.0.1"
+  end
+end

data/lib/visor-auth.rb

@@ -0,0 +1,12 @@
+require 'visor-common'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'auth/version'
+require 'auth/backends/base'
+require 'auth/backends/mongo_db'
+require 'auth/backends/mysql_db'
+require 'auth/server'
+require 'auth/client'
+require 'auth/cli'
+
+

data/spec/lib/server_spec.rb

@@ -0,0 +1,189 @@
+require "spec_helper"
+require "securerandom"
+
+include Visor::Auth::Backends
+
+describe Visor::Auth::Server do
+  let(:parse_opts) { {symbolize_names: true} }
+
+  let(:valid_post) { {user: {access_key: 'foo', email: 'foo@bar.com'}} }
+  let(:invalid_post) { {user: {access_key: 'foo'}} }
+
+  let(:valid_update) { {user: {email: 'foobar@bar.com'}} }
+  let(:invalid_update) { {user: {secret_key: 'this is not valid'}} }
+
+  inserted = []
+
+  def users_from(last_response)
+    response = JSON.parse(last_response.body, parse_opts)
+    response[:user] || response[:users]
+  end
+
+  def message_from(last_response)
+    JSON.parse(last_response.body, parse_opts)[:message]
+  end
+
+  def delete_all
+    get '/users'
+    users = users_from(last_response)
+    users.each { |user| delete "/users/#{user[:access_key]}" }
+  end
+
+  def generate_user
+    {user: {access_key: SecureRandom.hex(10), email: 'foo@bar.com'}}
+  end
+
+  before(:each) do
+    post '/users', generate_user.to_json
+    @valid_access_key = users_from(last_response)[:access_key]
+    inserted << @valid_access_key
+  end
+
+  after(:all) do
+    inserted.each { |access_key| delete "/users/#{access_key}" }
+  end
+
+  describe "GET on /users" do
+    before(:each) do
+      get '/users'
+      last_response.should be_ok
+    end
+
+    it "should return an array" do
+      get '/users'
+      users = users_from(last_response)
+      users.should be_a Array
+    end
+
+    it "should filter results" do
+      get '/users'
+      users = users_from(last_response)
+      get "/users?email=#{users.sample[:email]}"
+      users = users_from(last_response)
+      users.each { |u| u[:email].should == users.sample[:email] }
+    end
+
+    it "should raise an 404 error if no users were found" do
+      #delete_all
+      #get '/images'
+      #last_response.status.should == 404
+      #message_from(last_response).should match /no image found/
+    end
+  end
+
+  describe "GET on /users/:access_key" do
+    before(:each) do
+      get "/users/#{@valid_access_key}"
+      last_response.should be_ok
+    end
+
+    it "should return a hash with the user data" do
+      user = users_from(last_response)
+      user.should be_a Hash
+      user[:email].should be_a String
+    end
+
+    it "should raise a 404 error if user not found" do
+      get "/users/fake_id"
+      last_response.status.should == 404
+      message_from(last_response).should match /No user found/
+    end
+  end
+
+  describe "POST on /users" do
+    it "should create a new user and return its data" do
+      post '/users', generate_user.to_json
+      last_response.should be_ok
+      user = users_from(last_response)
+      user[:access_key].should be_a String
+      inserted << user[:access_key]
+    end
+
+    it "should raise a 409 error if access_key was already taken" do
+      exists = { user: { access_key: @valid_access_key, email:'foo@bar.com' }}
+      post '/users', exists.to_json
+      last_response.status.should == 409
+    end
+
+    it "should raise a 400 error if data validation fails" do
+      post '/users', invalid_post.to_json
+      last_response.status.should == 400
+      message_from(last_response).should match /email/
+    end
+
+    it "should raise a 404 error if referenced an invalid kernel/ramdisk image" do
+      #post '/images', valid_post.merge(kernel: "fake_id").to_json
+      #message_from(last_response).should match /no image found/
+    end
+  end
+
+  describe "PUT on /users/:access_key" do
+    it "should update an existing user data and return it" do
+      put "/users/#{@valid_access_key}", valid_update.to_json
+      last_response.should be_ok
+      user = users_from(last_response)
+      user[:email].should == valid_update[:user][:email]
+    end
+
+    it "should raise a 409 error if access_key was already taken" do
+      exists = { user: { access_key: @valid_access_key, email:'foo@bar.com' }}
+      post '/users', exists.to_json
+      last_response.status.should == 409
+    end
+
+    it "should raise a 400 error if user data validation fails" do
+      put "/users/#{@valid_access_key}", invalid_update.to_json
+      last_response.status.should == 400
+    end
+
+    it "should raise a 404 error if referenced an invalid kernel/ramdisk image" do
+      #put "/images/#{@valid_access_key}", valid_update.merge(kernel: "fake_id").to_json
+      #message_from(last_response).should match /No image found/
+    end
+  end
+
+  describe "DELETE on /users/:access_key" do
+    it "should delete an user data" do
+      delete "/users/#{@valid_access_key}"
+      last_response.should be_ok
+
+      user = users_from(last_response)
+      user.should be_a Hash
+      user[:access_key].should == @valid_access_key
+
+      get "/users/#{@valid_access_key}"
+      last_response.status.should == 404
+    end
+
+    it "should raise a 404 error if user not found" do
+      delete "/users/fake_id"
+      last_response.status.should == 404
+      message_from(last_response).should match /No user found/
+    end
+  end
+
+  describe "Operation on a not implemented path" do
+    after(:each) do
+      last_response.status.should == 404
+      message_from(last_response).should match /Invalid operation or path/
+    end
+
+    it "should raise a 404 error for a GET request" do
+      get "/fake"
+    end
+
+    it "should raise a 404 error for a POST request" do
+      post "/fake"
+    end
+
+    it "should raise a 404 error for a PUT request" do
+      put "/fake"
+    end
+
+    it "should raise a 404 error for a POST request" do
+      delete "/fake"
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: visor-auth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- João Pereira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The VISOR Auth System, responsible for maintaining VISOR users accounts.
+email: joaodrp@gmail.com
+executables:
+- visor-auth
+- visor-admin
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/auth/backends/base.rb
+- lib/auth/backends/mongo_db.rb
+- lib/auth/backends/mysql_db.rb
+- lib/auth/cli.rb
+- lib/auth/client.rb
+- lib/auth/server.rb
+- lib/auth/version.rb
+- lib/visor-auth.rb
+- spec/lib/server_spec.rb
+- bin/visor-auth
+- bin/visor-admin
+homepage: http://cvisor.org
+licenses: []
+post_install_message: ! '
+
+
+  ****************************** VISOR ******************************
+
+
+  visor-auth was successfully installed!
+
+
+  Generate the VISOR configuration file for this machine (if not already done) by
+  running the ''visor-config'' command.
+
+
+  *******************************************************************
+
+
+'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'VISOR: Virtual Images Management Service for Cloud Infrastructures'
+test_files:
+- spec/lib/server_spec.rb
+has_rdoc: