csv-ldap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6070e00a0b098fd0ee8b688433e71f459e64568
+  data.tar.gz: 6b24b39be04709b41a7c7aa2a5331eeac9b7302a
+SHA512:
+  metadata.gz: 7122abb77d7e1ebeca7c127410730e690b27f62e97e66baa75b6b7cc8ed52192a0fce83bf90c1e23f8092610bbf6b27a1958beefe6f1f18f7b9b871d53d9230b
+  data.tar.gz: 73716e7289474115f4110b03ff3cb2e4377651e8e026496b9652816df5770b347f745cdbe2ad19f3acc7801ac23908d20d458fb378d18e825ffb0780ae3239d4

data/.circleci/config.yml

@@ -0,0 +1,63 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # Database setup
+      - run: bundle exec rake db:create
+      - run: bundle exec rake db:schema:load
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/.rvmrc

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aashish.kiran@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in csv-ldap.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    csv-ldap (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    net-ldap (0.16.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  csv-ldap!
+  net-ldap (~> 0.16.1)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  rubocop (~> 0.49.0)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Aashish Kiran
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aashish Kiran
+
+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,88 @@
+# Csv::Ldap
+
+Csv::Ldap for Ruby is a gem for reading/writing entries in an LDAP directory to/from CSV files. The tool should be able to create entries in a directory under `ou=people,dc=example,dc=org` from a CSV file with the following attributes: `cn,sn,mail,uid,homeDirectory,uidNumber,gidNumber`.
+
+Note: This documentation is based on Ubuntu 14.04 LTS
+
+## Pre-Requisites
+
+Install OpenLDAP server.
+
+```
+sudo apt install slapd ldap-utils
+```
+
+Configure with following
+
+```
+sudo dpkg-reconfigure slapd
+```
+
+After configuring the slapd. Create a node called 'people'.
+
+Create the following LDIF file and call it add_content.ldif:
+
+```
+dn: ou=people,dc=example,dc=org
+objectClass: organizationalUnit
+ou: people
+```
+
+Add the content by run the following command from terminal
+
+```
+ldapadd -x -D cn=admin,dc=example,dc=com -W -f add_content.ldif
+
+Enter LDAP Password: ********
+adding new entry "ou=people,dc=example,dc=org"
+```
+
+Entries will be created in a directory under `ou=people,dc=example,dc=org`
+
+Refer to following for more details
+
+https://help.ubuntu.com/lts/serverguide/openldap-server.html.en#openldap-server-installation
+
+https://www.unixmen.com/install-openldap-in-ubuntu-15-10-and-debian-8/
+
+## Installation
+
+Add this line to your application"s Gemfile:
+
+```ruby
+gem 'csv-ldap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv-ldap
+
+## Features
+- Create entries in an LDAP directory from a CSV file.
+- Export entries returned from an LDAP search to a CSV file. The search filter should come from a command line argument.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/csv-ldap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Csv::Ldap project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/csv-ldap/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'csv/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(__FILE__)

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/csv-ldap.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "csv/ldap/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv-ldap"
+  spec.version       = Csv::Ldap::VERSION
+  spec.authors       = ["Aashish Kiran"]
+  spec.email         = ["aashish.kiran@gmail.com"]
+
+  spec.summary       = %q{Csv::Ldap for Ruby is reading/writing entries in an LDAP directory to/from CSV files }
+  spec.description   = %q{Csv::Ldap for Ruby is command-line interface tool for reading/writing entries in an LDAP
+    directory to/from CSV files. The tool should be able to create entries in a directory under
+    `ou=people,dc=example,dc=org` from a CSV file with the following
+    attributes: `cn,sn,mail,uid,homeDirectory,uidNumber,gidNumber`.}
+  spec.homepage      = "https://github.com/aashish/csv-ldap"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rubocop", "~> 0.49.0"
+  spec.add_development_dependency "net-ldap", "~> 0.16.1"
+end

data/lib/csv/ldap/version.rb

@@ -0,0 +1,5 @@
+module Csv
+  class Ldap
+    VERSION = '0.1.0'
+  end
+end

data/lib/csv/ldap.rb

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'net/ldap'
+require 'csv'
+
+# Csv::Ldap class
+module Csv
+  class Ldap
+    attr_accessor :ldap, :errors
+    DEFAULT_HEADERS = %w{cn sn mail uid homeDirectory uidNumber gidNumber}.freeze
+    DEFAULT_TREE_BASE = 'ou=people, dc=example, dc=org'.freeze
+    DEFAULT_OUTPUT_FILE_PATH = "#{Dir.home}/ldap_data_output.csv"
+
+    def initialize(args)
+      @ldap = Net::LDAP.new args
+    end
+
+    def bind
+      @ldap.bind
+    end
+
+    def delete(args)
+      @ldap.delete(args)
+    end
+
+    def valid_headers(headers = [])
+      unless headers.all? { |header| @headers.include?(header) }
+        raise 'Require headers to process the file.'
+      end
+    end
+
+    def import(input_file_path = nil, headers = [])
+      @headers ||= headers.empty? ? DEFAULT_HEADERS : headers
+      @errors = []
+
+      CSV.foreach(input_file_path, headers: true, skip_blanks: true) do |row|
+        valid_headers row.headers
+
+        dn = "cn=#{row['cn']}, ou=people, dc=example, dc=org"
+        attr = row.to_h
+        attr['objectclass'] = ['inetOrgPerson', 'posixAccount', 'shadowAccount']
+
+        @ldap.add(dn: dn, attributes: attr)
+        if @ldap.get_operation_result['message'] == 'Success'
+          puts 'Adding cn:' + row['cn'] + ' ' +
+          @ldap.get_operation_result['message']
+        else
+          puts 'Error cn:' + row['cn'] + ' ' +
+          @ldap.get_operation_result['message']
+          @errors << row['cn'] + ' ' + @ldap.get_operation_result['message']
+        end
+      end
+    end
+
+    def export(args = {})
+      @headers = args[:headers] || DEFAULT_HEADERS
+      @treebase = args[:treebase] || DEFAULT_TREE_BASE
+      @output_file_path = args[:output_file_path] || DEFAULT_OUTPUT_FILE_PATH
+      @filter ||= args[:filter]
+
+      add_header
+
+      CSV.open(@output_file_path, 'a+', { force_quotes: false }) do |csv|
+        ldap.search(base: @treebase, filter: @filter) do |entry|
+          csv << @headers.map { |x| entry.send(x).first } rescue nil
+        end
+      end
+    end
+
+    def add_header
+      CSV.open(@output_file_path, 'w+', { force_quotes: false }) do |csv|
+        csv << @headers
+      end
+    end
+
+  end
+end

data/lib/csv_ldap.rb

@@ -0,0 +1 @@
+require 'csv/ldap'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: csv-ldap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aashish Kiran
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: |-
+  Csv::Ldap for Ruby is command-line interface tool for reading/writing entries in an LDAP
+      directory to/from CSV files. The tool should be able to create entries in a directory under
+      `ou=people,dc=example,dc=org` from a CSV file with the following
+      attributes: `cn,sn,mail,uid,homeDirectory,uidNumber,gidNumber`.
+email:
+- aashish.kiran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csv-ldap.gemspec
+- lib/csv/ldap.rb
+- lib/csv/ldap/version.rb
+- lib/csv_ldap.rb
+homepage: https://github.com/aashish/csv-ldap
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Csv::Ldap for Ruby is reading/writing entries in an LDAP directory to/from
+  CSV files
+test_files: []