Merge pull request #4 from wshihadeh/parse_ldap_configs_with_erb

Parse ldap configs with erb

.gitignore

@@ -1,5 +1,6 @@
 *.sw?
 .DS_Store
+Gemfile.lock
 coverage
 rdoc
 pkg

.ruby-gemset

@@ -0,0 +1 @@
+rack-auth-ldap

.ruby-version

@@ -0,0 +1 @@
+2.6.4

.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+branches:
+  only:
+  - master
+
+rvm:
+- 2.6.4
+
+cache: bundler
+bundler_args: "--jobs=3 --retry=3 --without production"
+
+matrix:
+  fast_finish: true
+
+script:
+- bundle exec rspec

lib/rack/auth/ldap.rb

@@ -10,7 +10,6 @@ module Rack
   # the auth module from Rack Sources
   module Auth
 
-
     # class Config provide Yaml config mapping for Rack::Auth::Module
     # the class map ldap configurations values
     # @note this class is not provide to be used standalone
@@ -23,7 +22,7 @@ class Config
       def initialize(options = { :file => './ldap.yml'})
         @values = defaults
         target  = (ENV['RACK_ENV'])? ENV['RACK_ENV'] : 'test'
-        config_values = ::YAML.load_file(::File.expand_path(options[:file], Dir.pwd))[target]
+        config_values = load_yaml(::File.expand_path(options[:file], Dir.pwd))[target]
         debug = ::File.open("/tmp/test.txt",'a+')
         debug.puts ENV['RACK_ENV']
         debug.close
@@ -38,6 +37,19 @@ def initialize(options = { :file => './ldap.yml'})
       end
 
       private
+
+      def load_yaml(file)
+        if ::File.exist?(file)
+          ::YAML.load ::ERB.new(IO.read(file)).result
+        else
+          raise "Could not load ldap configuration. No such file - #{file}"
+        end
+      rescue ::Psych::SyntaxError => e
+        raise "YAML syntax error occurred while parsing #{file}. " \
+              "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+              "Error: #{e.message}"
+      end
+
       # private method with default configuration values for LDAP
       # @return [Hash<Symbol>] the default values of LDAP configuration
       def defaults
@@ -56,8 +68,6 @@ def defaults
           :debug => false
         }
       end
-
-
     end
 
     # class Ldap, the main authentication component for Rack

rack-auth-ldap.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |s|
   s.date = "2014-04-29"
   s.rubyforge_project = 'nowarning'
   s.description = %q{rack-auth-ldap : provide LDAP authentication for Rack middelware}
-  s.has_rdoc = true
   s.add_development_dependency('rspec')
   s.add_development_dependency('yard')
   s.add_development_dependency('rdoc')
   s.add_development_dependency('roodi')
   s.add_development_dependency('code_statistics')
   s.add_development_dependency('yard-rspec')
+  s.add_development_dependency('ladle')
   s.add_dependency('net-ldap')
   s.add_dependency('rack')
   s.required_ruby_version = '>= 1.9.0'

spec/config/ldap.yml

@@ -1,8 +1,8 @@
 production: &ldap_defaults
-  hostname: localhost
+  hostname: <%= ENV['HOSTNAME'] || 'localhost' %>
   basedn: ou=users,dc=test
   auth: false
-  port: 3897
+  port: <%= ENV['PORT'] || '3897' %>
   username_ldap_attribut: uid
 
 

spec/rack-auth-ldap_spec.rb

@@ -6,11 +6,11 @@
 describe Rack::Auth::Ldap do
 
    before :all do
-     @ldap_server = Ladle::Server.new({ 
+     @ldap_server = Ladle::Server.new({
      :quiet => true, :port   => 3897,
      :ldif   => "./spec/config/users.ldif",
      :domain => "dc=test",
-     :tmpdir => '/tmp'                                       
+     :tmpdir => '/tmp'
      }).start
    end
 
@@ -55,6 +55,16 @@ def assert_basic_auth_challenge(response)
     response.body.should be_empty
   end
 
+  it 'should render ldap.yaml with erb and use env vars' do
+     allow(ENV).to receive(:[]).with('RACK_ENV')
+     allow(ENV).to receive(:[]).with('HOSTNAME').and_return('localhost.local')
+     allow(ENV).to receive(:[]).with('PORT').and_return('9090')
+
+     app = Rack::Auth::Ldap.new(unprotected_app,{:file => './spec/config/ldap.yml'})
+     expect(app.config.hostname).to eq('localhost.local')
+     expect(app.config.port).to eq(9090)
+  end
+
   it 'should challenge correctly when no credentials are specified' do
     request do |response|
       assert_basic_auth_challenge response