active_ldap-dynamic_finders 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8523fa2d033ac9941a40baf787196ae487c62434
+  data.tar.gz: 11e71511d89147c8f302625afdee5cacc26a762a
+SHA512:
+  metadata.gz: b8589264cf061cb05831ded0ef7b88c3348195940848a49b24f39682e6b301e9b3995d8f521552338ab6311f390a9d1e70c3490e95468f29d8b477cf7372c56e
+  data.tar.gz: 470686f40baa0e67fd471fec087dd9dd0601c90c34d364de351c8f54e25a17a9d6d7281c1437348bdc22c41aed0f77a76419778f7ff7071fa1376ff565768dd2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_ldap-dynamic_finders.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christian Nennemann
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+
+# ActiveLdap::DynamicFinders
+
+Dynamic finders for [ActiveLdap](https://github.com/activeldap/activeldap)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_ldap-dynamic_finders'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_ldap-dynamic_finders
+
+## Usage
+
+Add it to your ActiveLdap model:
+
+```ruby
+class User < ActiveLdap::Base
+
+  include ActiveLdap::DynamicFinders # <- Add this line
+  
+  ...
+end
+```
+
+Then you have `.find_by_*` and `.find_by_*_and_*` methods. _Replace * with any attribute available in your ActiveDirectory_
+
+```ruby
+User.find_by_cn('jim')
+```
+```ruby
+User.find_by_cn_and_mail('jim', 'jim@example.com')
+```
+
+## Code Status
+* [![Build Status](https://travis-ci.org/XORwell/activeldap-dynamic_finders.png)](https://travis-ci.org/XORwell/activeldap-dynamic_finders)
+* [![Code Climate](https://codeclimate.com/repos/52840661c7f3a31afb022567/badges/ef5745b61ee31ef9a4dc/gpa.png)](https://codeclimate.com/repos/52840661c7f3a31afb022567/feed)
+* [![Dependency Status](https://gemnasium.com/XORwell/activeldap-dynamic_finders.png)](https://gemnasium.com/XORwell/activeldap-dynamic_finders)
+
+## License
+ActiveLdap::DynamicFinders is released under the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright © 2013 Christian Nennemann _(christian.nennemann@gmail.com)_
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+## Thanks
+
+This list may not be correct. If you notice mistakes of this list,
+please point out.
+
+* Kouhei Sutou for maintaining [ActiveLdap](https://github.com/activeldap/activeldap)
+* ...

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/active_ldap-dynamic_finders.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_ldap/dynamic_finders/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_ldap-dynamic_finders"
+  spec.version       = ActiveLdap::DynamicFinders::VERSION
+  spec.authors       = ["Christian Nennemann"]
+  spec.email         = ["christian.nennemann@gmail.com"]
+  spec.description   = %q{ActiveLdap dynamic finders}
+  spec.summary       = %q{Adds dynamic finder methods to ActiveLdap}
+  spec.homepage      = "https://github.com/XORwell/activeldap-dynamic_finders"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport" #, ">= 4.0.0"
+  spec.add_dependency "activeldap" #, ">= 4.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "github-ldap", "~> 1.0.13" 
+  spec.add_development_dependency "ladle"
+end

data/lib/active_ldap/dynamic_finders.rb

@@ -0,0 +1,47 @@
+require "active_ldap/dynamic_finders/version"
+require 'active_support/concern'
+
+module ActiveLdap
+  module DynamicFinders
+
+    extend ActiveSupport::Concern
+
+    included do
+      if self.superclass.eql?(ActiveLdap::Base)
+        class << self
+
+          # Respond to dynamic finders
+          def respond_to?(meth)
+            if meth.to_s =~ /^find_by_.*$/
+              true
+            else
+              super
+            end
+          end
+     
+          private
+     
+          # Override method_missing to run dynamic finder
+          def method_missing(meth, *args, &block)
+            if meth.to_s =~ /^find_by_(.+)$/
+              run_find_by_method(Regexp.last_match[1], *args)
+            else
+              super               
+            end
+          end
+     
+          # Run dynamic finder
+          def run_find_by_method(attrs, *args)
+            attrs = attrs.split('_and_')
+
+            raise(ArgumentError, "wrong number of arguments (#{args.size} for #{attrs.size})") if attrs.size != args.size
+
+            attrs_with_args = [attrs, args].transpose
+            conditions = Hash[attrs_with_args]
+            self.find(:all, filter: [:and, conditions])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_ldap/dynamic_finders/version.rb

@@ -0,0 +1,5 @@
+module ActiveLdap
+  module DynamicFinders
+    VERSION = "0.1.0"
+  end
+end

data/spec/config/ldap.yml

@@ -0,0 +1,6 @@
+test:
+  host: 127.0.0.1
+  port: 3897
+  base: DC=activeldap,DC=com
+  bind_dn: cn=admin,dc=activeldap,dc=com
+  password: secret

data/spec/dynamic_finders_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe ActiveLdap::DynamicFinders do
+
+  include_context "ldap"
+
+  let!(:al_class){ User.new }
+  let!(:not_al_class){ class Other; include ActiveLdap::DynamicFinders end }
+ 
+  describe 'test data attributes' do
+    it { expect(User.first.attribute_names).to include('cn') }
+    it { expect(User.first.attribute_names).to include('displayName') }
+    it { expect(User.first.attribute_names).to include('givenName') }
+  end
+
+
+  describe 'find_by_*' do
+    
+    context 'with matching attributes' do
+      describe 'single attr finder' do
+        it "does return searched entry" do
+          expect(User.find_by_sn('jim-sn')).to have(1).items
+        end
+      end
+      describe 'multiple attr finder' do
+        it "does return searched entry" do
+          expect(User.find_by_cn_and_sn('jim', 'jim-sn')).to have(1).items
+        end
+      end
+    end
+    
+    context 'with mismatching attributes' do      
+      describe 'single attr finder' do
+        it "does NOT return searched entry" do
+          expect(User.find_by_sn('wrong_name')).to have(0).items
+        end
+      end
+      describe 'multiple attr finder' do
+        it "does NOT return searched entry" do
+          expect(User.find_by_cn_and_sn('jim', 'wrong_name')).to have(0).items
+        end
+      end
+    end
+  end
+  
+  describe 'respond_to?' do
+
+    context "dynamic finders" do
+      [:find_by_mail, :find_by_givenName, :find_by_cn_and_sn].each{ |finder|
+        context 'ActiveLdap::Base inherited class' do
+          it "Class DOES respond to find_by prefixed methods: #{finder}" do
+            expect(User.respond_to?(finder)).to be_true
+          end
+          it "Instance does NOT respond to find_by prefixed methods: #{finder}" do
+            expect(User.new.respond_to?(finder)).to be_false
+          end
+        end
+        context 'Not ActiveLdap::Base inherited class' do
+          it "Class does NOT respond to find_by prefixed methods: #{finder}" do
+            expect(not_al_class.respond_to?(finder)).to be_false
+          end
+          it "Instance does NOT respond to find_by prefixed methods: #{finder}" do
+            expect(not_al_class.respond_to?(finder)).to be_false
+          end
+        end
+      }
+      
+      it "does NOT respond to find_by_* without attr" do
+        expect(al_class.respond_to?('find_by_')).to be_false
+      end
+      it "does NOT respond to find_by" do
+        expect(al_class.respond_to?('find_by')).to be_false
+      end      
+    end
+  end
+
+  describe 'run_find_by_method' do
+    context 'on missing arguments' do
+      it { expect{ User.find_by_cn_and_sn() }.to raise_error(ArgumentError, 'wrong number of arguments (0 for 2)') }
+      it { expect{ User.find_by_cn_and_sn('jim') }.to raise_error(ArgumentError, 'wrong number of arguments (1 for 2)') }
+      it { expect{ User.find_by_cn_and_sn('jim', '') }.to_not raise_error }
+    end    
+  end
+
+  describe 'method_missing' do
+    it "does NOT bubble errors for find_by.." do
+      expect{ User.find_by_cn_and_sn('jim', '') }.to_not raise_error
+    end
+    it "DOES bubble errors for other missing methods" do
+      expect{ User.any_other_method }.to raise_error
+    end
+  end
+
+end

data/spec/fixtures/ldap.ldif

@@ -0,0 +1,76 @@
+version: 1
+
+#######################
+# Organizations
+#######################
+dn: dc=activeldap,dc=com
+objectClass: dcObject
+objectClass: organization
+dc: activeldap
+o: Activeldap Community
+
+dn: ou=Group,dc=activeldap,dc=com
+objectclass: organizationalUnit
+ou: Group
+
+dn: ou=Users,dc=activeldap,dc=com
+objectclass: organizationalUnit
+ou: Users
+
+#######################
+# Groups
+#######################
+dn: cn=People,ou=Group,dc=activeldap,dc=com
+cn: People
+objectClass: groupOfNames
+member: cn=jim,ou=Users,dc=activeldap,dc=com
+
+dn: cn=Enterprise,ou=Group,dc=activeldap,dc=com
+cn: Enterprise
+objectClass: groupOfNames
+member: cn=firstBob,ou=Users,dc=activeldap,dc=com
+
+
+#######################
+# Users
+#######################
+dn: cn=admin,dc=activeldap,dc=com
+cn: admin
+objectClass: top
+objectClass: person
+objectClass: organizationalPerson
+objectClass: inetOrgPerson
+sn: administrator
+displayName: Directory Superuser
+userPassword: secret
+
+dn: cn=firstBob,ou=Users,dc=activeldap,dc=com
+cn: firstBob
+sn: firstBob-sn
+userPassword: secret
+mail: firstBob@activeldap.com
+objectClass: inetOrgPerson
+displayName: firstBob_displayname
+userPassword: secret
+givenName: Bob
+
+dn: cn=otherBob,ou=Users,dc=activeldap,dc=com
+cn: otherBob
+sn: otherBob-sn
+userPassword: secret
+mail: otherBob@activeldap.com
+objectClass: inetOrgPerson
+displayName: otherBob_displayname
+userPassword: secret
+givenName: Bob
+
+dn: cn=jim,ou=Users,dc=activeldap,dc=com
+cn: jim
+sn: jim-sn
+userPassword: secret
+mail: jim@activeldap.com
+objectClass: inetOrgPerson
+displayName: jim_displayname
+userPassword: secret
+givenName: Jim
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'active_ldap'
+require 'active_ldap/dynamic_finders'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir.glob(File.expand_path("spec/support/**/*.rb")).each{ |f| require f }
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  # Include macros
+  config.include LdapMacros
+end
+

data/spec/support/ldap_macros.rb

@@ -0,0 +1,36 @@
+module LdapMacros
+  require 'github/ldap'
+  require 'github/ldap/server'
+
+  def ldap_setup
+    ldap_server_start
+    setup_connection
+  end
+
+  def ldap_teardown
+    ldap_server_stop
+  end
+
+  def setup_connection
+    ActiveLdap::Base.setup_connection YAML.load_file('spec/config/ldap.yml')['test'] 
+  end
+
+  def ldap_server_start
+    GitHub::Ldap.start_server \
+      user_fixtures: 'spec/fixtures/ldap.ldif',
+      user_domain: 'dc=activeldap,dc=com',
+      admin_user: 'cn=admin,dc=activeldap,dc=com',
+      admin_password: 'secret',      
+      uid: 'cn'
+  end
+
+  def ldap_server_stop
+    GitHub::Ldap.stop_server
+  end
+
+  def ldap_server_restart
+    ldap_server_stop
+    ldap_server_start
+  end
+
+end

data/spec/support/shared_contexts/ldap_context.rb

@@ -0,0 +1,11 @@
+shared_context "ldap" do
+  
+	before(:all) do
+		ldap_setup
+	end
+
+	after(:all) do
+		ldap_teardown
+	end
+	
+end

data/spec/support/user.rb

@@ -0,0 +1,8 @@
+class User < ActiveLdap::Base
+  include ActiveLdap::DynamicFinders
+
+  ldap_mapping :dn_attribute => 'cn',
+               :prefix => 'ou=Users',
+               :classes => ['top', 'person'],
+               :scope => :one
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: active_ldap-dynamic_finders
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Nennemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.13
+- !ruby/object:Gem::Dependency
+  name: ladle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveLdap dynamic finders
+email:
+- christian.nennemann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_ldap-dynamic_finders.gemspec
+- lib/active_ldap/dynamic_finders.rb
+- lib/active_ldap/dynamic_finders/version.rb
+- spec/config/ldap.yml
+- spec/dynamic_finders_spec.rb
+- spec/fixtures/ldap.ldif
+- spec/spec_helper.rb
+- spec/support/ldap_macros.rb
+- spec/support/shared_contexts/ldap_context.rb
+- spec/support/user.rb
+homepage: https://github.com/XORwell/activeldap-dynamic_finders
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Adds dynamic finder methods to ActiveLdap
+test_files:
+- spec/config/ldap.yml
+- spec/dynamic_finders_spec.rb
+- spec/fixtures/ldap.ldif
+- spec/spec_helper.rb
+- spec/support/ldap_macros.rb
+- spec/support/shared_contexts/ldap_context.rb
+- spec/support/user.rb