syc-ontact 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe93582cead2b2ccc48d60fcaa54a8d602baec10
+  data.tar.gz: 501cacb2bc96c5fb42e65226012da13859a0ce97
+SHA512:
+  metadata.gz: 4fb3c6fb9ed8d190de1a2f8e4525d99b5573b633abd5d4fe88c2ad44ebeda43036c587aa1c249fd7e964b14b021acd01cb9dec4ad42f15fd31b16f43ec21aa80
+  data.tar.gz: 1409a116127b05967202549f873093b370994d20d297b97d5041c5dfc4dd1a764a6e674f896619a5ab1488230c6f013a807da37005b691a5a4050f9ab6b95221

data/LICENSE.md

@@ -0,0 +1,23 @@
+*syc-ontact* is published under the [MIT-License](http://opensource.org/licenses/MIT)
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Sugar Your Coffee
+
+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,190 @@
+sycontact
+=========
+`syc-ontact` is a command line interface for looking up contacts from any source that is providing contact information.
+
+Installation
+============
+`gem install sycontact`
+
+Setup
+=====
+To use `sycontact` a source-file has to be provided. The source-file is Ruby script retrieving the data from the source. A source can be anything that can be read from the Ruby script, e.g. a web site, an LDAP server, a file with contact data.
+
+**Note:** Without a user defined Ruby script file (a Ruby module) `sycontact` will do nothing but 
+          creating a configuration file, a source directory and displaying the help page.
+
+To get `sycontact` to life you have to follow these setup steps:
+
+1. start  `sycontact` once. This will create the configuration file and the working directory
+2. provide a Ruby module describing how to retrieve the data from the source. The module name has
+   to be `some_name_source.rb`.
+
+The Ruby source code below describes a source-file that is retrieving contact data from a contact directory with the name *test-contacts* below the module's directory.
+
+
+```
+module AddressSource
+
+  # Where to find the contact files
+  URL = File.join(File.dirname(__FILE__), "test-contacts")
+
+  # Regex to extract contact data from the contact files
+  REGEX = { cn: /(?<=<common_name>)[\w -]*(?=<\common_name>)/,
+            sn: /(?<=<surname>)[\w -]*(?=<\/surname>)/,
+            gn: /(?<=<given_name>)[\w -]*(?=<\/given_name>)/,
+            c: /(?<=<country>)[\w]*(?=<\/country>)/,
+            l: /(?<=<location>)[\w]*(?=<\/location>)/,
+            st: /(?<=<state>)[\w]*(?=<\/state>)/,
+            street: /(?<=<street>)[\w .]*(?=<\/street>)/,
+            o: /(?<=<organization>)[\w -]*(?=<\/organization>)/,
+            ou: /(?<=<department>)[\w -]*(?=<\/department>)/,
+            title: /(?<=<title>)[\w .-]*(?=<\/title>)/,
+            description: /(?<=<description>)[\w -+]*(?=<\/description>)/,
+            telephone: /(?<=<telephone>)[\w +()-]*(?=<\/telephone>)/,
+            mobile: /(?<=<mobile>)[\w +()-]*(?=<\/mobile>)/,
+            mail: /(?<=<email>)[\w @.-]*(?=<\/email>)/
+          }
+
+  # Mandatory method! Will be invoked by `sycontact`.
+  # Will lookup the contact based on the pattern provided
+  def lookup(pattern = {})
+    contacts = []
+    create_source_files(pattern).each do |source_file|
+
+      next unless File.exist? source_file
+
+      source = File.read(source_file)
+
+      next if source.empty?
+
+      values = {}
+
+      REGEX.each do |key, regex|
+        value = source.scan(regex)[0]
+        values[key] = value if value
+      end
+
+      contacts << values
+    end
+
+    contacts.keep_if do |contact|
+      pattern.each.reduce(true) do |match, pattern| 
+        contact_does_not_have_key = contact[pattern[0]].nil?
+        regex = Regexp.new(pattern[1].strip.downcase)
+        pos = regex =~ contact[pattern[0]].strip.downcase unless contact_does_not_have_key
+        match and (not pos.nil? or contact_does_not_have_key)
+      end
+    end
+  end
+
+  private
+
+    # Creates the contact file name. In this case the contact files have to be in the form
+    # firstname_lastname.contact or lastname_firstname.contact. If neather is given all *_*.contact
+    # files are retrieved
+    def create_source_files(pattern)
+      source_files = []
+      if pattern[:cn]
+        names = pattern[:cn].scan(/(^[a-zA-Z]*)[^a-zA-Z]*([a-zA-Z]*)/).flatten
+        names[0] = '*' if names[0].empty?
+        names[1] = '*' if names[1].empty?
+        names.permutation do |names|
+          file = File.join(URL, "#{names.join('_').downcase}.contact")
+          Dir.glob(file).each { |file| source_files << file }
+        end
+      elsif pattern[:sn] or pattern[:gn]
+        sn = pattern[:sn] ? pattern[:sn].strip.downcase : '*'
+        gn = pattern[:gn] ? pattern[:gn].strip.downcase : '*'
+        Dir.glob(File.join(URL, "#{gn}_#{sn}.contact")).each do |file|
+          source_files << file
+        end
+      else
+        Dir.glob(File.join(URL, "*_*.contact")).each do |file|
+          source_files << file
+        end
+      end
+      source_files
+    end
+end
+```
+
+**Listing 1: Source-file to provide information about how to retrieve contact information**
+
+Below a contact file that can be read by the above source module.
+
+```
+<common_name>Sugar Pierre</common_name>
+<given_name>Pierre</given_name>
+<surname>Sugar</surname>
+<country>CA</country>
+<location>Vancouver</location>
+<state>BC</state>
+<street>Robson Street</street>
+<organization>SugarYourCoffee</organization>
+<department>DevOps</department>
+<telephone>+001 (123) 4567</telephone>
+<mobile>+001 (765) 4321</mobile>
+<email>pierre@sugaryourcoffee.de</email>
+```
+
+**Listing 2: Contact file that can be read by the `AddressSource` module**
+
+Usage
+=====
+
+Get help for sycontact
+
+    $ sycontact -h
+
+```
+Usage: sycontact [options]
+    -p, --print RAW|SUMMARY|ALL      Print contact attributes
+                                     SUMMARY (default)
+        --cn COMMON_NAME             Common name e.g. 'Jane Doe' or 'Doe, Jane'
+        --sn SURNAME                 Surname e.g. 'Doe'
+        --gn GIVEN_NAME              Given name e.g. 'Jane'
+        --uid USER_ID                User ID
+    -c COUNTRY                       Country in ISO 3166 e.g. 'CA' for Canada
+    -l LOCATION                      City e.g. 'Vancouver'
+        --st STATE                   State e.g. 'British Columbia'
+        --street STREET              Street e.g. 'Robson Street'
+    -o ORGANIZATION                  Organization e.g. 'Northstar'
+        --ou ORGANIZATIONAL_UNIT     Department e.g. 'R&D'
+        --title TITLE                Title e.g. 'Dr.'
+        --description DESCRIPTION    Description e.g. 'Head of R&D'
+        --telephone TELEPHONE        Telephone number e.g. '+001 (252) 4354'
+        --mobile MOBILE_PHONE        Mobile number e.g. '+001 (252) 4345'
+        --mail E-MAIL                E-Mail address e.g. 'jane@northstart.ca'
+    -h, --help                       Show his message
+```
+
+Lookup a contact with summary output
+
+    $ sycontact --cn sugar
+    $ sycontact --cn "sugar, pierre"
+    $ sycontact --cn "pierre sugar"
+
+Any of the above commands result in the following output
+
+```
+AddressSource
+
+CN..................Sugar Pierre
+C...................DE
+L...................Vancouver
+O...................SugarYourCoffee
+OU..................DevOps
+TELEPHONE...........+001 (123) 4567
+MOBILE..............+001 (765) 4321
+MAIL................pierre@sugaryourcoffee.de
+```
+Sources
+=======
+Home page: <http://syc.dyndns.org/drupal/wiki/sycontact-lookup-contacts-any-source>
+
+Source: <https://github.com/sugaryourcoffee/syc-ontact>
+
+Contact
+=======
+
+<pierre@sugaryourcoffee.de>

data/bin/sycontact

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+
+# Main program of sycontact
+
+require 'optparse'
+require 'yaml'
+require_relative '../lib/sycontact/address_book_library'
+
+# Directory holding the confifuration file and the sources
+sycontact_directory     = File.expand_path("~/.syc/sycontact")
+# sycontact configuration file
+sycontact_file          = File.join(sycontact_directory, "sycontact.rc")
+# Directory where address books are saved to, that is the modules holding the script to retrieve
+# contacts from the contact source file (e.g. Internet, LDAP server, file)
+address_books_directory = File.join(sycontact_directory, "address_books/")
+
+unless File.exist? sycontact_directory
+  Dir.mkdir sycontact_directory
+end
+
+unless File.exists? address_books_directory
+  Dir.mkdir address_books_directory
+end
+
+unless File.exists? sycontact_file
+  puts "\nsycontact"
+  puts "========="
+  puts "You have to add the address source file directory to #{sycontact_file}"
+  puts "Look at the README.md to see how to configure sycontact\n"
+  config = { address_books: [ ] }
+  File.open(sycontact_file, 'w') { |f| YAML.dump(config, f) }
+  ARGV << "-h"
+else
+  config = YAML.load_file(sycontact_file)
+  address_books = config[:address_books]
+  if address_books.empty?
+    puts "\nsycontact"
+    puts "========="
+    puts "You have to add the address source file directory to #{sycontact_file}\n\n"
+    ARGV << "-h"
+  end
+end
+
+options = { p: "summary" } 
+
+option_parser = OptionParser.new do |opts|
+
+  opts.on("-p", "--print RAW|SUMMARY|ALL", "Print contact attributes", 
+                                           "SUMMARY (default)") do |print|
+    options[:p] = print
+  end
+
+  opts.on("--cn COMMON_NAME", "Common name e.g. 'Jane Doe' or 'Doe, Jane'") do |common_name|
+    options[:cn] = common_name
+  end
+
+  opts.on("--sn SURNAME", "Surname e.g. 'Doe'") do |surname|
+    options[:sn] = surname
+  end
+
+  opts.on("--gn GIVEN_NAME", "Given name e.g. 'Jane'") do |given_name|
+    options[:gn] = given_name
+  end
+
+  opts.on("--uid USER_ID", "User ID") do |user_id|
+    options[:uid] = user_id
+  end
+
+  opts.on("-c COUNTRY", "Country in ISO 3166 e.g. 'CA' for Canada") do |country|
+    options[:c] = country
+  end
+
+  opts.on("-l LOCATION", "City e.g. 'Vancouver'") do |location|
+    options[:l] = location
+  end
+
+  opts.on("--st STATE", "State e.g. 'British Columbia'") do |state|
+    options[:st] = state
+  end
+
+  opts.on("--street STREET", "Street e.g. 'Robson Street'") do |street|
+    options[:street] = street
+  end
+
+  opts.on("-o ORGANIZATION", "Organization e.g. 'Northstar'") do |organization|
+    options[:o] = organization
+  end
+
+  opts.on("--ou ORGANIZATIONAL_UNIT", "Department e.g. 'R&D'") do |organizational_unit|
+    options[:ou] = organizational_unit
+  end
+
+  opts.on("--title TITLE", "Title e.g. 'Dr.'") do |title|
+    options[:title] = title
+  end
+
+  opts.on("--description DESCRIPTION", "Description e.g. 'Head of R&D'") do |description|
+    options[:descripton] = description
+  end
+
+  opts.on("--telephone TELEPHONE", "Telephone number e.g. '+001 (252) 4354'") do |telephone|
+    options[:telephone] = telephone
+  end
+
+  opts.on("--mobile MOBILE_PHONE", "Mobile number e.g. '+001 (252) 4345'") do |mobile_phone|
+    options[:mobile] = mobile_phone
+  end
+
+  opts.on("--mail E-MAIL", "E-Mail address e.g. 'jane@northstart.ca'") do |email|
+    options[:mail] = email
+  end
+
+  opts.on("-h", "--help", "Show his message") do
+    puts opts
+    exit(0)
+  end
+end
+
+begin
+  option_parser.parse!
+rescue OptionParser::ParseError => e
+  STDERR.puts e.message, "\n", options
+  exit(1)
+end
+
+library = Sycontact::AddressBookLibrary.new(address_books[0])
+
+case options[:p].downcase
+when "raw"
+  options.delete(:p)
+  library.lookup(options).each do |c|
+    puts c
+  end
+when "all"
+  options.delete(:p)
+  library.print_all(options)
+else
+  options.delete(:p)
+  library.print_summary(options)
+end

data/lib/sycontact/address_book.rb

@@ -0,0 +1,64 @@
+# sycontac module providing functions to lookup contacts
+module Sycontact
+
+  # AddressBook is a wrapper for source modules that contain a script for retrieving contact data
+  # from a source as Internet, LDAP server or a file
+  class AddressBook
+  
+    # Holds the values that are used when printing the summary of a contact
+    SUMMARY = [ :cn, :c, :l, :o, :ou, :telephone, :mobile, :mail ]
+
+    # Creates a new AddressBook. It requires the source module file and extends AddressBook with
+    # the source module
+    def initialize(source)
+      source = source.sub('.rb', '')
+      require source
+      @module_name = pascalize(File.basename(source))
+      extend self.class.module_eval(@module_name)
+    end
+
+    # The source module can override the address source title, print_summary and print_all methods.
+    # If the methods are not overridden the default methods are invoked. The source module has to
+    # provide a lookup method. If the lookup method is not available "method missing" will be
+    # thrown
+    def method_missing(method, *args, &block)
+      case method
+      when :title
+        @module_name
+      when :print_summary
+        args.each do |contact|
+          puts "\n"
+          contact.each do |k,v|
+            if block_given?
+              yield(k, v)
+            else
+              unless SUMMARY.index(k).nil?
+                puts "#{k.to_s.upcase.ljust(20, '.')}#{v}\n" unless v.nil? or v.empty?
+              end
+            end
+          end
+        end
+      when :print_all
+        args.each do |contact|
+          puts "\n"
+          contact.each do |k,v|
+            if block_given?
+              yield(k, v)
+            else
+              puts "#{k.to_s.upcase.ljust(20, '.')}#{v}\n" unless v.nil? or v.empty?
+            end
+          end
+        end
+      else
+        super
+      end 
+    end
+
+    private
+
+      # Pascalizes/camalizes a string as address_source to AddressSource
+      def pascalize(string)
+        (string.split('_').map { |word| word.capitalize }).join
+      end
+  end
+end

data/lib/sycontact/address_book_library.rb

@@ -0,0 +1,57 @@
+require_relative 'address_book'
+
+# sycontac module providing functions to lookup contacts
+module Sycontact
+
+  # AddressBookLibrary creates AddressBook objects and forwards all messages invoked on 
+  # AddressBookLibrary to all AddressBooks.
+  class AddressBookLibrary
+
+    # The contacts from the last lookup invocation
+    attr_reader :contacts
+
+    # Creates AddressBook objects based on the address book source files contained in the
+    # address_book_directory
+    def initialize(address_book_directory)
+      @address_books = []
+      Dir.glob(File.join(address_book_directory, "*_source.rb")).each do |address_book|
+        @address_books << AddressBook.new(address_book)
+      end
+    end
+
+    # Looks up a contact based on the pattern and returns the contact data as a hash. The contact
+    # data can subsequentially retrievied with :contacts
+    def lookup(pattern = {})
+      @contacts = {}
+      @address_books.each do |address_book|
+        puts "\n#{address_book.title}\n"
+        @contacts[address_book.title] = address_book.lookup(pattern)
+      end
+      @contacts
+    end
+
+    # Invokes a lookup on all AddressBook objects and prints the result to the console with all
+    # attributes found in the contact source
+    def print_all(pattern = {})
+      @address_books.each do |address_book|
+        puts "\n#{address_book.title}"
+        address_book.lookup(pattern).each do |contact|
+          address_book.print_all(contact)
+        end
+      end
+    end
+
+    # Invokes a lookup on all AddressBook objects and prints a subset of the result to the console.
+    # The attributes that are selected for print are defined in AddressBook::SUMMARY
+    def print_summary(pattern = {})
+      @address_books.each do |address_book|
+        puts "\n#{address_book.title}"
+        address_book.lookup(pattern).each do |contact|
+          address_book.print_summary(contact)
+        end
+      end
+    end
+
+  end
+
+end

data/spec/sycontact/address_book_library_spec.rb

@@ -0,0 +1,19 @@
+require 'sycontact/address_book_library'
+
+# sycontac module providing functions to lookup contacts
+module Sycontact
+
+  describe AddressBookLibrary do
+    
+    before do
+      address_book_directory = File.join(File.dirname(__FILE__), "files")
+      @library = AddressBookLibrary.new(address_book_directory)
+    end
+
+    it "should look up contact" do
+      @library.lookup(sn: "sugar").should_not be_empty
+    end
+
+  end
+
+end

data/spec/sycontact/address_book_spec.rb

@@ -0,0 +1,107 @@
+require 'sycontact/address_book'
+
+# sycontac module providing functions to lookup contacts
+module Sycontact
+  describe AddressBook do
+
+    before do
+      source_file = File.join(File.dirname(__FILE__), "files/address_source.rb")
+      @address_book = AddressBook.new(source_file)
+    end
+
+    it "finds contact with sn and gn set" do
+      @address_book.lookup(sn: "Sugar",
+                           gn: "Pierre").should_not be_empty
+    end
+
+    it "finds contact with leading and training white spaces in sn and gn" do
+      @address_book.lookup(sn: " Sugar ",
+                           gn: "   Pierre ").should_not be_empty
+    end
+
+    it "ignores capitalized values in sn and gn" do
+      @address_book.lookup(sn: " sugar",
+                           gn: " pierre \n").should_not be_empty
+    end
+
+    it "finds contact if only sn is set" do
+      @address_book.lookup(sn: "sugar").should_not be_empty
+    end
+
+    it "finds contact with cn = 'Pierre Sugar' set" do
+      @address_book.lookup(cn: "Pierre Sugar").should_not be_empty
+    end
+
+    it "finds contact with cn = 'Sugar, Pierre' set" do
+      @address_book.lookup(cn: "Sugar, Pierre").should_not be_empty
+    end
+
+    it "ignores capitalized values in find cn" do
+      @address_book.lookup(cn: "pierre Sugar").should_not be_empty
+      @address_book.lookup(cn: "sugar, pierre").should_not be_empty
+    end
+
+    it "finds contact with cn when only one part of the name is set" do
+      @address_book.lookup(cn: "Pierre").should_not be_empty
+      @address_book.lookup(cn: "Sugar").size.should eq 2
+    end
+
+    it "finds multiple contacts based on attributes other than cn, gn and sn" do
+      @address_book.lookup(mail: "amanda@sugar.com").should_not be_empty
+    end
+
+    it "find should return nil when no attribute matches" do
+      @address_book.lookup(mail: "user@example.com").should be_empty
+    end 
+
+    it "should return title" do
+      @address_book.title.should eq "AddressSource"
+    end
+
+    it "should return print summary of result" do
+      output = []
+      @address_book.lookup(cn: "Pierre Sugar").each do |contact|
+       @address_book.print_summary(contact) do |k, v|
+          output << "#{k} has the value of #{v}"
+        end
+      end
+      output.should eq [
+        "sn has the value of Sugar", 
+        "gn has the value of Pierre", 
+        "c has the value of DE", 
+        "l has the value of Vancouver", 
+        "st has the value of BC", 
+        "street has the value of Robson Street", 
+        "o has the value of SugarYourCoffee", 
+        "ou has the value of DevOps", 
+        "title has the value of No Title", 
+        "description has the value of Development and Operations", 
+        "telephone has the value of +001 (123) 4567", 
+        "mobile has the value of +001 (765) 4321", 
+        "mail has the value of pierre@sugaryourcoffee.de"
+      ]
+    end
+
+    it "should print all of result" do
+      output = []
+      @address_book.lookup(cn: "Pierre Sugar").each do |contact|
+        output << @address_book.print_all(contact)
+      end
+      output.should eq [
+        [{:sn=>"Sugar", 
+          :gn=>"Pierre", 
+          :c=>"DE", 
+          :l=>"Vancouver", 
+          :st=>"BC", 
+          :street=>"Robson Street", 
+          :o=>"SugarYourCoffee", 
+          :ou=>"DevOps", 
+          :title=>"No Title", 
+          :description=>"Development and Operations", 
+          :telephone=>"+001 (123) 4567", 
+          :mobile=>"+001 (765) 4321", 
+          :mail=>"pierre@sugaryourcoffee.de"}]
+      ]
+    end
+  end
+end

data/spec/sycontact/files/address_source.rb

@@ -0,0 +1,86 @@
+# Test module for rspec providing functions to lookup contacts in the test-contacts directory
+module AddressSource
+
+  # URL where the contact source files can be found
+  URL = File.join(File.dirname(__FILE__), "test-contacts")
+
+  # REGEX to extract contact data from the contact source file
+  REGEX = { cn: /(?<=<common_name>)[\w -]*(?=<\common_name>)/,
+            sn: /(?<=<surname>)[\w -]*(?=<\/surname>)/,
+            gn: /(?<=<given_name>)[\w -]*(?=<\/given_name>)/,
+            c: /(?<=<country>)[\w]*(?=<\/country>)/,
+            l: /(?<=<location>)[\w]*(?=<\/location>)/,
+            st: /(?<=<state>)[\w]*(?=<\/state>)/,
+            street: /(?<=<street>)[\w .]*(?=<\/street>)/,
+            o: /(?<=<organization>)[\w -]*(?=<\/organization>)/,
+            ou: /(?<=<department>)[\w -]*(?=<\/department>)/,
+            title: /(?<=<title>)[\w .-]*(?=<\/title>)/,
+            description: /(?<=<description>)[\w -+]*(?=<\/description>)/,
+            telephone: /(?<=<telephone>)[\w +()-]*(?=<\/telephone>)/,
+            mobile: /(?<=<mobile>)[\w +()-]*(?=<\/mobile>)/,
+            mail: /(?<=<email>)[\w @.-]*(?=<\/email>)/
+          }
+
+  # Looks up a contact based on the pattern
+  def lookup(pattern = {})
+    contacts = []
+    create_source_files(pattern).each do |source_file|
+
+      next unless File.exist? source_file
+
+      source = File.read(source_file)
+
+      next if source.empty?
+
+      values = {}
+
+      REGEX.each do |key, regex|
+        value = source.scan(regex)[0]
+        values[key] = value if value
+      end
+
+      contacts << values
+    end
+
+    contacts.keep_if do |contact|
+      pattern.each.reduce(true) do |match, pattern| 
+        contact_does_not_have_key = contact[pattern[0]].nil?
+        regex = Regexp.new(pattern[1].strip.downcase)
+        pos = regex =~ contact[pattern[0]].strip.downcase unless contact_does_not_have_key
+        match and (not pos.nil? or contact_does_not_have_key)
+      end
+    end
+  end
+
+  # Overrides the default title method in AddressBook
+  def title
+    "AddressSource"
+  end
+
+  private
+
+    # Creates a source file name based on the pattern
+    def create_source_files(pattern)
+      source_files = []
+      if pattern[:cn]
+        names = pattern[:cn].scan(/(^[a-zA-Z]*)[^a-zA-Z]*([a-zA-Z]*)/).flatten
+        names[0] = '*' if names[0].empty?
+        names[1] = '*' if names[1].empty?
+        names.permutation do |names|
+          file = File.join(URL, "#{names.join('_').downcase}.contact")
+          Dir.glob(file).each { |file| source_files << file }
+        end
+      elsif pattern[:sn] or pattern[:gn]
+        sn = pattern[:sn] ? pattern[:sn].strip.downcase : '*'
+        gn = pattern[:gn] ? pattern[:gn].strip.downcase : '*'
+        Dir.glob(File.join(URL, "#{gn}_#{sn}.contact")).each do |file|
+          source_files << file
+        end
+      else
+        Dir.glob(File.join(URL, "*_*.contact")).each do |file|
+          source_files << file
+        end
+      end
+      source_files
+    end
+end

data/spec/sycontact/files/test-contacts/amanda_sugar.contact

@@ -0,0 +1,14 @@
+# Test file for rspec
+<given_name>Amanda</given_name>
+<surname>Sugar</surname>
+<country>DE</country>
+<location>City</location>
+<state>State</state>
+<street>Street</street>
+<organization>Company</organization>
+<department>Department</department>
+<title>Dr.</title>
+<description>Description of Amanda Sugar</description>
+<telephone>+49 (123) 4567</telephone>
+<mobile>+49 (765) 4321</mobile>
+<email>amanda@sugar.com</email>

data/spec/sycontact/files/test-contacts/pierre_sugar.contact

@@ -0,0 +1,14 @@
+# Test file for rspec
+<given_name>Pierre</given_name>
+<surname>Sugar</surname>
+<country>DE</country>
+<location>Vancouver</location>
+<state>BC</state>
+<street>Robson Street</street>
+<organization>SugarYourCoffee</organization>
+<department>DevOps</department>
+<title>No Title</title>
+<description>Development and Operations</description>
+<telephone>+001 (123) 4567</telephone>
+<mobile>+001 (765) 4321</mobile>
+<email>pierre@sugaryourcoffee.de</email>

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: syc-ontact
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pierre Sugar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: "sycontact\n=========\n`syc-ontact` is a command line interface for looking
+  up contacts from any source that is providing contact information.\n\nInstallation\n============\n`gem
+  install sycontact`\n\nSetup\n=====\nTo use `sycontact` a source-file has to be provided.
+  The source-file is Ruby script retrieving the data from the source. A source can
+  be anything that can be read from the Ruby script, e.g. a web site, an LDAP server,
+  a file with contact data.\n\n**Note:** Without a user defined Ruby script file (a
+  Ruby module) `sycontact` will do nothing but \n          creating a configuration
+  file, a source directory and displaying the help page.\n\nTo get `sycontact` to
+  life you have to follow these setup steps:\n\n1. start  `sycontact` once. This will
+  create the configuration file and the working directory\n2. provide a Ruby module
+  describing how to retrieve the data from the source. The module name has\n   to
+  be `some_name_source.rb`.\n\nThe Ruby source code below describes a source-file
+  that is retrieving contact data from a contact directory with the name *test-contacts*
+  below the module's directory.\n\n\n```\nmodule AddressSource\n\n  # Where to find
+  the contact files\n  URL = File.join(File.dirname(__FILE__), \"test-contacts\")\n\n
+  \ # Regex to extract contact data from the contact files\n  REGEX = { cn: /(?<=<common_name>)[\\w
+  -]*(?=<\\common_name>)/,\n            sn: /(?<=<surname>)[\\w -]*(?=<\\/surname>)/,\n
+  \           gn: /(?<=<given_name>)[\\w -]*(?=<\\/given_name>)/,\n            c:
+  /(?<=<country>)[\\w]*(?=<\\/country>)/,\n            l: /(?<=<location>)[\\w]*(?=<\\/location>)/,\n
+  \           st: /(?<=<state>)[\\w]*(?=<\\/state>)/,\n            street: /(?<=<street>)[\\w
+  .]*(?=<\\/street>)/,\n            o: /(?<=<organization>)[\\w -]*(?=<\\/organization>)/,\n
+  \           ou: /(?<=<department>)[\\w -]*(?=<\\/department>)/,\n            title:
+  /(?<=<title>)[\\w .-]*(?=<\\/title>)/,\n            description: /(?<=<description>)[\\w
+  -+]*(?=<\\/description>)/,\n            telephone: /(?<=<telephone>)[\\w +()-]*(?=<\\/telephone>)/,\n
+  \           mobile: /(?<=<mobile>)[\\w +()-]*(?=<\\/mobile>)/,\n            mail:
+  /(?<=<email>)[\\w @.-]*(?=<\\/email>)/\n          }\n\n  # Mandatory method! Will
+  be invoked by `sycontact`.\n  # Will lookup the contact based on the pattern provided\n
+  \ def lookup(pattern = {})\n    contacts = []\n    create_source_files(pattern).each
+  do |source_file|\n\n      next unless File.exist? source_file\n\n      source =
+  File.read(source_file)\n\n      next if source.empty?\n\n      values = {}\n\n      REGEX.each
+  do |key, regex|\n        value = source.scan(regex)[0]\n        values[key] = value
+  if value\n      end\n\n      contacts << values\n    end\n\n    contacts.keep_if
+  do |contact|\n      pattern.each.reduce(true) do |match, pattern| \n        contact_does_not_have_key
+  = contact[pattern[0]].nil?\n        regex = Regexp.new(pattern[1].strip.downcase)\n
+  \       pos = regex =~ contact[pattern[0]].strip.downcase unless contact_does_not_have_key\n
+  \       match and (not pos.nil? or contact_does_not_have_key)\n      end\n    end\n
+  \ end\n\n  private\n\n    # Creates the contact file name. In this case the contact
+  files have to be in the form\n    # firstname_lastname.contact or lastname_firstname.contact.
+  If neather is given all *_*.contact\n    # files are retrieved\n    def create_source_files(pattern)\n
+  \     source_files = []\n      if pattern[:cn]\n        names = pattern[:cn].scan(/(^[a-zA-Z]*)[^a-zA-Z]*([a-zA-Z]*)/).flatten\n
+  \       names[0] = '*' if names[0].empty?\n        names[1] = '*' if names[1].empty?\n
+  \       names.permutation do |names|\n          file = File.join(URL, \"#{names.join('_').downcase}.contact\")\n
+  \         Dir.glob(file).each { |file| source_files << file }\n        end\n      elsif
+  pattern[:sn] or pattern[:gn]\n        sn = pattern[:sn] ? pattern[:sn].strip.downcase
+  : '*'\n        gn = pattern[:gn] ? pattern[:gn].strip.downcase : '*'\n        Dir.glob(File.join(URL,
+  \"#{gn}_#{sn}.contact\")).each do |file|\n          source_files << file\n        end\n
+  \     else\n        Dir.glob(File.join(URL, \"*_*.contact\")).each do |file|\n          source_files
+  << file\n        end\n      end\n      source_files\n    end\nend\n```\n\n**Listing
+  1: Source-file to provide information about how to retrieve contact information**\n\nBelow
+  a contact file that can be read by the above source module.\n\n```\n<common_name>Sugar
+  Pierre</common_name>\n<given_name>Pierre</given_name>\n<surname>Sugar</surname>\n<country>CA</country>\n<location>Vancouver</location>\n<state>BC</state>\n<street>Robson
+  Street</street>\n<organization>SugarYourCoffee</organization>\n<department>DevOps</department>\n<telephone>+001
+  (123) 4567</telephone>\n<mobile>+001 (765) 4321</mobile>\n<email>pierre@sugaryourcoffee.de</email>\n```\n\n**Listing
+  2: Contact file that can be read by the `AddressSource` module**\n\nUsage\n=====\n\nGet
+  help for sycontact\n\n    $ sycontact -h\n\n```\nUsage: sycontact [options]\n    -p,
+  --print RAW|SUMMARY|ALL      Print contact attributes\n                                     SUMMARY
+  (default)\n        --cn COMMON_NAME             Common name e.g. 'Jane Doe' or 'Doe,
+  Jane'\n        --sn SURNAME                 Surname e.g. 'Doe'\n        --gn GIVEN_NAME
+  \             Given name e.g. 'Jane'\n        --uid USER_ID                User
+  ID\n    -c COUNTRY                       Country in ISO 3166 e.g. 'CA' for Canada\n
+  \   -l LOCATION                      City e.g. 'Vancouver'\n        --st STATE                   State
+  e.g. 'British Columbia'\n        --street STREET              Street e.g. 'Robson
+  Street'\n    -o ORGANIZATION                  Organization e.g. 'Northstar'\n        --ou
+  ORGANIZATIONAL_UNIT     Department e.g. 'R&D'\n        --title TITLE                Title
+  e.g. 'Dr.'\n        --description DESCRIPTION    Description e.g. 'Head of R&D'\n
+  \       --telephone TELEPHONE        Telephone number e.g. '+001 (252) 4354'\n        --mobile
+  MOBILE_PHONE        Mobile number e.g. '+001 (252) 4345'\n        --mail E-MAIL
+  \               E-Mail address e.g. 'jane@northstart.ca'\n    -h, --help                       Show
+  his message\n```\n\nLookup a contact with summary output\n\n    $ sycontact --cn
+  sugar\n    $ sycontact --cn \"sugar, pierre\"\n    $ sycontact --cn \"pierre sugar\"\n\nAny
+  of the above commands result in the following output\n\n```\nAddressSource\n\nCN..................Sugar
+  Pierre\nC...................DE\nL...................Vancouver\nO...................SugarYourCoffee\nOU..................DevOps\nTELEPHONE...........+001
+  (123) 4567\nMOBILE..............+001 (765) 4321\nMAIL................pierre@sugaryourcoffee.de\n```\nSources\n=======\nHome
+  page: <http://syc.dyndns.org/drupal/wiki/sycontact-lookup-contacts-any-source>\n\nSource:
+  <https://github.com/sugaryourcoffee/syc-ontact>\n\nContact\n=======\n\n<pierre@sugaryourcoffee.de>\n"
+email: pierre@sugaryourcoffee.de
+executables:
+- sycontact
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- bin/sycontact
+- lib/sycontact/address_book.rb
+- lib/sycontact/address_book_library.rb
+- spec/sycontact/address_book_library_spec.rb
+- spec/sycontact/address_book_spec.rb
+- spec/sycontact/files/address_source.rb
+- spec/sycontact/files/test-contacts/amanda_sugar.contact
+- spec/sycontact/files/test-contacts/pierre_sugar.contact
+homepage: https://github.com/sugaryourcoffee/syc-ontact
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Lookup contacts from any source by providing customized source files
+test_files:
+- spec/sycontact/files/test-contacts/pierre_sugar.contact
+- spec/sycontact/files/test-contacts/amanda_sugar.contact
+- spec/sycontact/files/address_source.rb
+- spec/sycontact/address_book_library_spec.rb
+- spec/sycontact/address_book_spec.rb