ldap-relations 0.1.0

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,5 @@
+rvm:
+  - "1.9.3"
+  - "1.9.2"
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in ldap-filters.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Felix Clack
+
+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,42 @@
+# Ldap::Relations
+
+[![Build Status](https://travis-ci.org/felixclack/ldap-relations.png)](https://travis-ci.org/felixclack/ldap-relations)
+
+An Arel inspired library to provide a relational algebra for LDAP filters.
+I'm using it in conjunction with the jruby-ldap library because the 
+ruby ldap libraries just don't cut it in Ruby 1.9.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ldap-relations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ldap-relations
+
+## Usage
+
+Create a relation manager first...
+
+    manager = Ldap::Relations::RelationManager.new
+
+    manager.relations << Relation.new(sAMAccountName: 'test')
+    manager.relations << Relation.new(objectCategory: 'person')
+
+    manager.to_filter #=> "(&(sAMAccountName=test)(objectCategory=person)"
+
+Then pass that filter string into the search method on your LDAP connection. Simples.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ldap-relations.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ldap-relations/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ldap-relations"
+  gem.version       = Ldap::Relations::VERSION
+  gem.authors       = ["Felix Clack"]
+  gem.email         = ["felixclack@gmail.com"]
+  gem.description   = %q{}
+  gem.summary       = %q{Abstraction of filters to use with an LDAP library.}
+  gem.homepage      = "http://felixclack.github.com/ldap-relations"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/ldap-relations/relation.rb

@@ -0,0 +1,16 @@
+module Ldap::Relations
+  # This class describes an individual filter that can be combined with others
+  # to be passed to an LDAP server as part of a search.
+  class Relation
+    def initialize params={}
+      @operator = params.fetch :operator, :and
+      @params = params
+    end
+
+    attr_accessor :operator, :params
+
+    def to_filter
+      @params.map {|key, value| "#{key}=#{value}" }.join
+    end
+  end
+end

data/lib/ldap-relations/relation_manager.rb

@@ -0,0 +1,33 @@
+module Ldap
+  module Relations
+    # Store a list of relations and provide methods
+    # to output the list as an LDAP filter string.
+    class RelationManager
+      RELATION_OPERATOR_MAPPINGS = {
+        or: '|',
+        and: '&',
+        not: '!'
+      }
+
+      def initialize *args
+        @relations = []
+      end
+
+      attr_accessor :relations
+
+      # Public: convert the relations to a LDAP-style filter string.
+      #
+      # Returns String
+      def to_filter
+        relation = @relations.shift
+        case @relations.size
+        when 0
+          "(#{relation.to_filter})"
+        when 1
+          "(" << RELATION_OPERATOR_MAPPINGS[@relations.first.operator] <<
+            "(#{relation.to_filter})(#{@relations.first.to_filter}))"
+        end
+      end
+    end
+  end
+end

data/lib/ldap-relations/version.rb

@@ -0,0 +1,5 @@
+module Ldap
+  module Relations
+    VERSION = "0.1.0"
+  end
+end

data/lib/ldap-relations.rb

@@ -0,0 +1,10 @@
+require "ldap-relations/version"
+require 'ldap-relations/relation_manager'
+require 'ldap-relations/relation'
+
+module Ldap
+  module Relations
+  end
+end
+
+LRel = Ldap::Relations

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/ldap-relations/relation_manager_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'ldap-relations/relation_manager'
+
+module Ldap::Relations
+  describe RelationManager do
+    let(:relation_manager) { RelationManager.new }
+    let(:relation) { stub 'Relation', to_filter: 'objectCategory=person', operator: :and }
+    let(:or_relation) { stub 'Relation', to_filter: 'sAMAccountName=test', operator: :or }
+
+    describe '#relations' do
+      it 'stores a list of relations' do
+        relation_manager.relations << relation << relation
+        relation_manager.relations.should == [relation, relation]
+      end
+    end
+
+    describe '#to_filter' do
+      subject { relation_manager.to_filter }
+
+      context 'with one relation' do
+        before { relation_manager.relations << relation }
+
+        it { should == "(objectCategory=person)" }
+      end
+
+      context 'with 2 relations' do
+        before { relation_manager.relations << relation << relation }
+
+        it { should == "(&(objectCategory=person)(objectCategory=person))" }
+      end
+
+      context 'with an AND relation and an OR relation' do
+        before { relation_manager.relations << relation << or_relation }
+
+        it { should == "(|(objectCategory=person)(sAMAccountName=test))"}
+      end
+    end
+  end
+end

data/spec/ldap-relations/relation_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'ldap-relations/relation'
+
+module Ldap::Relations
+  describe Relation do
+    let(:relation) { Relation.new sAMAccountName: 'test' }
+
+    subject { relation }
+
+    its(:params) { should == { sAMAccountName: 'test'} }
+
+    describe '#to_filter' do
+      subject { relation.to_filter }
+
+      it { should == 'sAMAccountName=test' }
+    end
+
+    describe '#operator' do
+      context 'by default' do
+        subject { relation.operator }
+
+        it { should == :and }
+      end
+
+      context 'when set to :or' do
+        let(:or_relation) { Relation.new sAMAccountName: 'test', operator: :or }
+
+        subject { or_relation.operator }
+
+        it { should == :or }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: ldap-relations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Felix Clack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-07 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'
+description: ''
+email:
+- felixclack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ldap-relations.gemspec
+- lib/ldap-relations.rb
+- lib/ldap-relations/relation.rb
+- lib/ldap-relations/relation_manager.rb
+- lib/ldap-relations/version.rb
+- spec/.rspec
+- spec/ldap-relations/relation_manager_spec.rb
+- spec/ldap-relations/relation_spec.rb
+- spec/spec_helper.rb
+homepage: http://felixclack.github.com/ldap-relations
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Abstraction of filters to use with an LDAP library.
+test_files:
+- spec/.rspec
+- spec/ldap-relations/relation_manager_spec.rb
+- spec/ldap-relations/relation_spec.rb
+- spec/spec_helper.rb