cul-ldap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3aec72c508a6c195d0ee5912c1bad2c4623d528
+  data.tar.gz: dbd019c07e1582a28879d0e97fb1e2e4dc5bef86
+SHA512:
+  metadata.gz: 077ae779ae3cc4fe2495bd20df9aee09812fee27e856902a218e975bc4c45517c48ad43da8a51b6bf7d4aed3d4e33374777dbed9f71b7275f5ad900699170bb6
+  data.tar.gz: 41ee7ddaecbcb9b90007a5161fd2baa5852fc06b8eb3d9760c71c5f93525bb072d2939faa7ee0c34527cd1be654a1ac90b8f6d8d4e1e406f7232ec2e249633f2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carla Galarza
+
+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,43 @@
+# Cul::LDAP
+
+Gem for CUL's common queries to CU's LDAP server. This is just a starting point with one query that is commonly needed. Needs some work to build out new functionality. Uses net-ldap to make queries. Cul::LDAP could be delegated to Net::LDAP if more functionality like the one already implemented there is required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cul-ldap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cul-ldap
+
+## Usage
+
+```
+require 'cul/ldap'
+ldap = Cul::LDAP.new
+entry = ldap.find_by_uni("abc123")
+entry = ldap.find_by_name("Doe, Jane")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cul/cul-ldap.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cul/ldap"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cul-ldap.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cul-ldap"
+  spec.version       = IO.read("VERSION").strip
+  spec.authors       = ["Carla Galarza"]
+  spec.email         = ["cmg2228@columbia.edu"]
+
+  spec.summary       = "Common queries of CU's LDAP server"
+  spec.homepage      = "https://github.com/cul/cul-ldap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "net-ldap", '~> 0.16'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+end

data/lib/cul/ldap.rb

@@ -0,0 +1,92 @@
+require "net/ldap"
+require "yaml"
+
+require "cul/ldap/version"
+require "cul/ldap/entry"
+
+module Cul
+  class LDAP < Net::LDAP
+    CONFIG_FILENAME = 'cul_ldap.yml'
+    CONFIG_DEFAULTS = {
+      host: 'ldap.columbia.edu',
+      port: '636',
+      encryption: {
+        method: :simple_tls,
+        tls_options: OpenSSL::SSL::SSLContext::DEFAULT_PARAMS
+      }
+    }.freeze
+
+    def initialize(options = {})
+      super(build_config(options)) # All keys have to be symbols.
+    end
+
+    # LDAP lookup based on UNI. If record could not be found returns nil.
+    #
+    # @param [String] uni
+    # @return [Cul::LDAP::Entry] containing all the ldap information available for the uni given
+    # @return [nil] if record for uni could not be found, or more than one record was found
+    def find_by_uni(uni)
+      entries = search(base: "ou=People,o=Columbia University, c=US", filter: Net::LDAP::Filter.eq("uid", uni))
+      (entries.count == 1) ? entries.first : nil
+    end
+
+    # LDAP lookup based on name.
+    #
+    # @param [String] name
+    # @return [Cul::LDAP::Entry] containing the entry matching this name, if it is unique
+    # @return [nil] if record could not be found or if there is more than one match
+    def find_by_name(name)
+      if name.include?(',')
+        name = name.split(',').map(&:strip).reverse.join(" ")
+      end
+      entries = search(base: "ou=People,o=Columbia University, c=US", filter: Net::LDAP::Filter.eq("cn", name))
+      (entries.count == 1) ? entries.first : nil
+    end
+
+    # Wrapper around Net::LDAP#search, converts Net::LDAP::Entry objects to
+    # Cul::LDAP::Entry objects.
+    def search(args = {})
+      super(args).tap do |result|
+        if result.is_a?(Array)
+          result.map!{ |e| Cul::LDAP::Entry.new(e) }
+        end
+      end
+    end
+
+    private
+
+    def build_config(options)
+      config = CONFIG_DEFAULTS.merge(options)
+      credentials = config.fetch(:auth, nil)
+      credentials = nil if !credentials.nil? && credentials.empty?
+
+      # If rails app fetch credentials using rails code, otherwise read from
+      # cul_ldap.yml if credentials are nil.
+      if credentials.nil?
+        credentials = rails_credentials || credentials_from_file
+        credentials = nil if !credentials.nil? && credentials.empty?
+      end
+
+      unless credentials.nil?
+        credentials = credentials.map { |k, v| [k.to_sym, v] }.to_h
+        credentials[:method] = :simple unless credentials.key?(:method)
+      end
+
+      config[:auth] = credentials
+      config
+    end
+
+    def credentials_from_file
+      (File.exist?(CONFIG_FILENAME)) ? YAML.load_file(CONFIG_FILENAME) : nil
+    end
+
+    def rails_credentials
+      if defined?(Rails.application.config_for) && File.exist?(File.join(Rails.root, 'config', CONFIG_FILENAME))
+        raise "Missing cul-ldap credentials in config/#{CONFIG_FILENAME}" if Rails.application.config_for(:cul_ldap).empty?
+        Rails.application.config_for(:cul_ldap)
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/cul/ldap/entry.rb

@@ -0,0 +1,33 @@
+require 'delegate'
+
+module Cul
+  class LDAP::Entry < SimpleDelegator
+    def name
+      self[:cn].first
+    end
+
+    def email
+      (self[:mail].empty?) ? "#{uni}@columbia.edu" : mail.first
+    end
+
+    def first_name
+      self[:givenname].first
+    end
+
+    def last_name
+      self[:sn].first
+    end
+
+    def organizational_unit
+      self[:ou].first
+    end
+
+    def uni
+      self[:uni].first
+    end
+
+    def title
+      self[:title].first
+    end
+  end
+end

data/lib/cul/ldap/version.rb

@@ -0,0 +1,9 @@
+require "net/ldap"
+
+module Cul
+  class LDAP < Net::LDAP
+    def self.version
+      IO.read("VERSION").strip
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: cul-ldap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carla Galarza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- cmg2228@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- cul-ldap.gemspec
+- lib/cul/ldap.rb
+- lib/cul/ldap/entry.rb
+- lib/cul/ldap/version.rb
+homepage: https://github.com/cul/cul-ldap
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Common queries of CU's LDAP server
+test_files: []