ldap_cli 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b22ffdc1aec4e62904e47fff2be7625c99b02ac99938d588027e34738a59ead8
+  data.tar.gz: 89aaa80e800aca63a9be2197dc87375296abfdee1d47171585d5c2fb91d85daf
+SHA512:
+  metadata.gz: a4d82df7d1cee5ce642bd977a72fa4b13104c6942f46aa0fdd906dbc59d7ef58798d1d1efdc5afa6f38a9cfd9cd4a759e5fa1998583657131b274f41fb9cba45
+  data.tar.gz: a88af1c7136bca48ba23e59995f5449d55b54768cf3a09ba6367fb09fa3e9681b4d91eabc51f82ff830dbba654ce0317d87a2f9a5cb20d69634d34b9751295f5

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 reddynagagangadhar@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,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ldap-cli.gemspec
+gemspec
+
+gem 'net-ldap'
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    ldap_cli (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    net-ldap (0.16.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    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.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  ldap_cli!
+  net-ldap
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.49.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Naga Gangadhar
+
+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,16 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ldap-cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ldap-cli
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ldap/cli'
+require 'pry'
+
+# 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/ldap-cli.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ldap/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ldap_cli'
+  spec.version       = Ldap::Cli::VERSION
+  spec.authors       = ['Naga Gangadhar']
+  spec.email         = ['reddynagagangadhar@gmail.com']
+
+  spec.summary       = 'Ldap::Cli for Ruby is reading/writing entries in a
+    LDAP directory to/from CSV files'
+  spec.description   = 'Ldap::Cli for Ruby is command-line interface tool
+    for reading/writing entries in an LDAP directory to/from CSV files.'
+  spec.homepage      = 'https://github.com/rngangadhar/ldap-cli'
+  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.17'
+  spec.add_development_dependency 'net-ldap', '~> 0.16.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.0'
+end

data/lib/ldap/cli/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ldap
+  class Cli
+    VERSION = '0.2.0'.freeze
+  end
+end

data/lib/ldap/cli.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'ldap/cli/version'
+require 'rubygems'
+require 'net/ldap'
+require 'csv'
+require 'pry'
+
+module Ldap
+  class Error < StandardError; end
+  # Tool for reading/writing entries in an LDAP directory to/from CSV files
+  class Cli
+    attr_accessor :ldap, :headers, :table_dn, :errors
+
+    def initialize(config, headers, table_dn)
+      @ldap = Net::LDAP.new config
+      @headers = headers
+      @table_dn = table_dn
+    end
+
+    def bind
+      ldap.bind
+    end
+
+    def delete(args)
+      ldap.delete(args)
+    end
+
+    def valid_headers(input_headers = [])
+      no_header = 'Require headers to process the file.'
+      raise no_header unless (input_headers - headers).empty?
+    end
+
+    def import(input_file_path = nil)
+      @errors = []
+      CSV.foreach(input_file_path, headers: true, skip_blanks: true) do |row|
+        valid_headers row.headers
+        save_record(row)
+      end
+    end
+
+    def export(args = {})
+      @output_file_path = args[:output_file_path]
+      @filter = args[:filter]
+      add_header
+      export_data
+    end
+
+    private
+
+    def save_record(row)
+      dn = dn_value(row)
+      attr = row.to_h
+      attr['objectclass'] = ['inetOrgPerson']
+      if search(row['uid']).empty?
+        ldap.add(dn: dn, attributes: attr)
+      else
+        ldap.modify dn: dn, attributes: attr
+      end
+      save_record_log(ldap, row)
+    end
+
+    def dn_value(row)
+      "uid=#{row['uid']}, #{table_dn}"
+    end
+
+    def search(uid)
+      ldap.search(
+        base: table_dn,
+        filter: "uid=#{uid}",
+        scope: 1
+      )
+    end
+
+    def add_header
+      CSV.open(@output_file_path, 'w+', force_quotes: false) do |csv|
+        csv << headers
+      end
+    end
+
+    def export_data
+      CSV.open(@output_file_path, 'a+', force_quotes: false) do |csv|
+        ldap.search(base: table_dn, filter: @filter, scope: 1) do |entry|
+          csv << headers.map { |x| entry.send(x).first }
+        end
+      end
+    end
+
+    def save_record_log(ldap, row)
+      status = ldap.get_operation_result['message']
+      error_message = ldap.get_operation_result.error_message
+      if status == 'Success'
+        puts "Entry created successfully for uid #{row['uid']}"
+      elsif error_message.include?('did not contain any modifications')
+        puts error_message
+      else
+        @errors << error_message
+        puts error_message
+      end
+    end
+  end
+end

data/lib/ldap_cli.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'ldap/cli'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ldap_cli
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Naga Gangadhar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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
+- !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: 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
+description: |-
+  Ldap::Cli for Ruby is command-line interface tool
+      for reading/writing entries in an LDAP directory to/from CSV files.
+email:
+- reddynagagangadhar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ldap-cli.gemspec
+- lib/ldap/cli.rb
+- lib/ldap/cli/version.rb
+- lib/ldap_cli.rb
+homepage: https://github.com/rngangadhar/ldap-cli
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Ldap::Cli for Ruby is reading/writing entries in a LDAP directory to/from
+  CSV files
+test_files: []