hulaki 0.1 → 1.0.2

data/lib/hulaki/contact_parser.rb

@@ -1,22 +1,18 @@
 class Hulaki::ContactParser
-
-  DefaultFilePath = '~/hulaki/contact.csv'
+  DEFAULT =  File.expand_path('~/hulaki/contact.csv')
+  @@default_file_path = DEFAULT
 
   def perform
-    parse
-  end
-
-  private
-  def parse
     options = {:strings_as_keys => true, :downcase_header => true}
-    SmarterCSV.process(contact_file, options)
+    SmarterCSV.process(@@default_file_path, options)
   rescue Errno::ENOENT
-    puts 'Contact file not found. Make sure there is file'
-    puts @file_path
-    nil
+    raise Hulaki::InvalidFilePath
   end
 
-  def contact_file
-    @file_path = File.expand_path(DefaultFilePath)
+  private
+  class << self
+    def default_file_path=(path)
+      @@default_file_path = File.expand_path(path)
+    end
   end
 end

data/lib/hulaki/core.rb

@@ -0,0 +1,90 @@
+require 'clipboard'
+
+class Hulaki::Core
+  def initialize(config)
+    @config = config
+  end
+
+  def perform
+    if @config.search_keyword
+      handle_search_and_clipboard
+    else
+      handle_messaging
+    end
+  rescue CSV::MalformedCSVError
+    puts 'Your contact.csv file is invalid or has invalid/malformed UTF characters.'.red
+    puts 'Please use a valid CSV file.'.red
+  end
+
+  private
+  def handle_messaging
+    puts '~' * 100
+    puts 'Welcome to Hulaki : Your best companion! to make your day great.'
+    puts '~' * 100
+
+    # It supports multiple recipients like two phonenumbers separated by commas `,`
+    @config.to.each do |recipient|
+      if is_phone?(recipient)
+        handle_sms(recipient)
+      elsif is_email?(recipient)
+        handle_email(recipient)
+      end
+    end
+
+    puts '~' * 100
+    puts @config.message
+    puts '~' * 100
+  end
+
+  def is_phone?(number)
+    Hulaki::SmsValidator.is_phone_number?(number)
+  end
+
+  def is_email?(email)
+    Hulaki::EmailValidator.is_email?(email)
+  end
+
+  def handle_email(recipient)
+    puts "Sending email to #{recipient}"
+    email_handler = Hulaki::Mailer.new(
+        {
+            :to      => recipient,
+            :message => @config.message,
+            :subject => @config.subject,
+            :from    => @config.from
+        }).deliver
+    puts "Email sent to `#{recipient}`. from `#{get_sender}`"
+  end
+
+  def handle_sms(recipient)
+    puts "Sending SMS to #{recipient}"
+    sms_handler = Hulaki::SmsHandler.new(
+        {
+            :to      => recipient,
+            :message => @config.message,
+            :gateway => @config.gateway,
+            :from    => @config.from
+        })
+    if sms_handler.send
+      puts "SMS sent successfully to #{recipient} using `#{sms_handler.gateway.class}` gateway"
+    end
+  end
+
+  def get_sender
+    @config[:from] || Hulaki::Config['email']['from']
+  end
+
+  def handle_search_and_clipboard
+    puts
+    response = Hulaki::SearchEngine.new.perform(@config.search_keyword)
+    Hulaki::Presenter.new(response).display if response
+
+    if @config.copy_phone_number
+      number = response[0][0]['phone_1___value'].gsub(' ', '')
+      Clipboard.copy number
+      puts "Number '#{number.underline}' is copied to your clipboard"
+      puts
+    end
+  end
+
+end

data/lib/hulaki/{email_validator.rb → email_handler/email_validator.rb}

@@ -2,10 +2,10 @@ class Hulaki::EmailValidator
   EmailRegex = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i
 
   def initialize(options = {})
-    @sender_email = options[:from]
+    @sender_email     = options[:from]
     @reciepient_email = options[:to]
-    @message = options[:message]
-    @errors = {}
+    @message          = options[:message]
+    @errors           = {}
   end
 
   def validates_presence

data/lib/hulaki/email_handler/mailer.rb

@@ -0,0 +1,73 @@
+require 'mail'
+
+class Hulaki::Mailer
+  attr_reader :params, :config
+
+  TEMPLATE_PATH =  ENV['template_path'] || '~/hulaki/template.html.erb'
+
+  def initialize(params={})
+    @params     = params
+    @config     = Hulaki::Config["email"]
+  end
+
+  def deliver
+    # Fixme: validation has no purpose for the time being
+    validate(@reciever, config["from"], params[:message])
+    configure_defaults
+    prepare_email
+    @mail.deliver
+    "sent"
+  end
+
+  private
+  def prepare_email
+    email_body = params[:message]
+
+    # sender set from command-line will take precedence over that in `config.yml`
+    from       = params[:from] || config["from"]
+    to         = params[:to]
+    subject    = params[:subject]
+
+    if config['use_template'] == true
+      content = ERB.new(File.read(File.expand_path(TEMPLATE_PATH))).result(binding)
+    else
+      content = email_body
+    end
+
+    @mail = Mail.new do
+      to        to
+      from      from
+      subject   subject
+
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body          content
+      end
+    end
+  end
+
+  def configure_defaults
+    # instance variables are not available inside the block below; so
+    # localizing the variable
+    env = @config
+    delivery_mode = ENV['mode'] == 'test' ? 'test' : :smtp
+    Mail.defaults do
+      delivery_method delivery_mode,
+                      {
+                          :address              => env["address"],
+                          :port                 => env["port"],
+                          :domain               => env["domain"],
+                          :user_name            => env["user_name"],
+                          :password             => env["password"],
+                          :authentication       => env["authentication"],
+                          :enable_starttls_auto => true
+                      }
+    end
+  end
+
+  # returns [Hash] Error
+  def validate(reciever, sender, message)
+    validator = Hulaki::EmailValidator.new(from: reciever, to: sender, message: message)
+    validator.validates_format && validator.validates_presence
+  end
+end

data/lib/hulaki/option_parser.rb

@@ -1,16 +1,18 @@
 require_relative 'recursive_ostruct'
 require 'fileutils'
 require 'optparse'
+# require File.expand_path('../string_modifier', __FILE__)
 require_relative 'presenter'
 class Hulaki::OptionParser
   def initialize
     @config = RecursiveOstruct.ostruct(
         {
             to:      [],
-            from:    [],
+            from:    nil,
             subject: 'Mic testing',
             message: 'sample message',
-            command: 'help'
+            command: 'help',
+            gateway: nil
         })
   end
 
@@ -21,96 +23,104 @@ class Hulaki::OptionParser
 
   def options
     OptionParser.new do |opts|
-      opts.banner = [
-          'Usage: ',
-          '------- Search --------',
-          '$ hulaki -s search-string',
-          '# Example: Hulaki features fuzzy search',
-          '# $ hulaki -s smithjohn',
-          '# $ hulaki -s johsmith',
-          '# $ hulaki -s smijohnth',
-          '',
-          '------- SMS --------',
-          '$ hulaki -t +977xxxxxxxxxx -m "Message to be sent"',
-          '------- EMAIL --------',
-      ].join("\n")
+      opts.banner =
+          "Usage: \n"\
+          "------- Search --------\n"\
+          "$ hulaki -s search-string\n"\
+          "# Example: Hulaki features fuzzy search\n"\
+          "$ hulaki -s smithjohn\n"\
+          "$ hulaki -s johsmith\n"\
+          "$ hulaki -s smijohnth\n"\
+          "\n"\
+          "------- Copy PhoneNumber to ClipBoard -----------\n"\
+          "$ hulaki -s smithjohn -c \n"\
+          "# You will see phone_number of the top result copied to ClipBoard \n"\
+          "# Number '+97798xxx66455' is copied to your clipboard\n"\
+          "\n"\
+          "------- SMS --------\n"\
+          "$ hulaki -t +977xxxxxxxxxx -m \"Message to be sent\"\n"\
+          "\n"\
+          "# You can even select a specific SMS Gateway\n"\
+          "$ hulaki -t +977xxxxxxxxxx -m \"Message to be sent\" -g nexmo\n"\
+          "$ hulaki -t +61xxxxxxxxxx  -m \"Message to be sent\" -g twilio\n"\
+          "$ hulaki -t +1xxxxxxxxxx   -m \"Message to be sent\" -g sparrow\n"\
+          "\n"\
+          "# You can even broadcast SMSes selecting a specific SMS Gateway\n"\
+          "#   However, keep in mind that multiple SMS request will go to the server\n"\
+          "$ hulaki -t +977xxxxxxxxxx,+9779832xxxxxx -m \"Message to be sent\" -g nexmo\n"\
+          "\n"\
+          "# You can also change the name that appears on recipient's Phone using `-f` switch. This only works with Nexmo\n"\
+          "$ hulaki -t +977xxxxxxxxxx,+9779832xxxxxx -m \"Message to be sent\" -g nexmo -f \"Hero Dai!\"\n"\
+          "\n"\
+          "------- EMAIL --------\n"\
+          "$ hulaki -t someone@example.com -S \"Subject of the email\" -m \"Message to be sent\"\n"\
+          "$ hulaki -t someone@example.com --subject \"Subject of the email\" -m \"Message to be sent\"\n"\
+          "\n"\
+          "# You can even broadcast emails, i.e. mutiple recipients\n"\
+          "#   However, keep in mind that multiple SMTP request will go to the server. No `CC`, `BCC` will be used\n"\
+          "$ hulaki -t someone@example.com,nextperson@email.com --subject \"Subject of the email\" -m \"Message to be sent\"\n"\
+          "\n"\
+          "# You can also change your sender id using `-f` switch\n"\
+          "$ hulaki -t someone@example.com -S \"Subject of the email\" -m \"Message to be sent\" -f \"My Name<anonymous@example.com>\" \n"\
+          "\n"\
+          "------- EMAIL TEMPLATES --------\n"\
+          "# You are allowed to have an Email template in HTML format at `~/hulaki/template.html.erb` which\n"\
+          "#   will be copied when you use `-i` switch. If you have `use_template` setting set to `true` then only\n"\
+          "#   you will be able to use the template\n"\
+          "$ hulaki -t someone@example.com -S \"Subject of the email\" -m \"Messagopts.to_se to be sent\"\n"
+
+
 
       opts.separator ''
       opts.separator 'Specific options:'
 
-      opts.on('-t x,y,z', '--to x,y,z', Array, 'list of recipient, can be') do |list|
-        @config.to = list
+      # This can be list of emails or phonenumbers separated by commas `,`
+      opts.on('-t x,y,z', '--to x,y,z', Array, 'list of recipient, can be') do |recipient_list|
+        @config.to = recipient_list
       end
 
-      opts.on('-m [Message]', '--message [Message]', String, 'Message to be sent to recipient') do |msg|
-        @config.message = msg
+      opts.on('-m [Message]', '--message [Message]', String, 'Message to be sent to recipient') do |message|
+        @config.message = message
       end
+      "\n"\
 
-      opts.on('-S [Subject]', '--subject [Subject]', String, 'Subject to email') do |sub|
-        @config.subject = sub
+      opts.on('-S [Subject]', '--subject [Subject]', String, 'Subject to email') do |subject|
+        @config.subject = subject
       end
 
-      opts.on('-f x,y,z', '--from x,y,z', Array, 'Help / Examples') do |sender_list|
-        @config.to = sender_list
+      opts.on('-c', '--copy', nil, 'Copy phone-number at top to ClipBoard; Linux users need to install `xclip`.') do
+        @config.copy_phone_number = true
       end
 
-      opts.on('-s [name/contact]', '--search [name/contact]', String, 'Search keyword') do |word|
-        response = Hulaki::SearchEngine.new.perform(word)
-        Hulaki::Presenter.new(response).display if response
-        exit
+      opts.on('-g [Gateway Name]', '--gateway [Gateway Name]', String, 'Name of the gateway, `nexmo`, `twilio`, `sparrow` are currently supported') do |gateway|
+        @config.gateway = gateway
+      end
+
+      opts.on('-f [Sender]', '--from [Sender]', String, "name <email> | PhoneNumber; this will take precedence over `from` in `config.yml`.") do |sender|
+        @config.from = sender
+      end
+
+      opts.on('-s [name/contact]', '--search [name/contact]', String, 'Search keyword') do |search_keyword|
+        @config.search_keyword = search_keyword
       end
 
       # ----------------------------------------------------------------------
       opts.on('-h', '--help', 'Help / Examples') do
-        Hulaki::Logger.log opts.banner
+        puts Utils.present(opts)
         exit
       end
 
       opts.on('-l', '--list', 'list all the options available') do
-        puts opts
+        puts Utils.present(opts)
         exit
       end
 
-      opts.on('-i', '--install', 'Creates ~/hulaki/config.yml') do
-        create_dir
-        start_copying_file
+      opts.on('-i', '--install', 'Creates ~/hulaki/config.yml, `template.html.erb`. Will ask you if have to replace them') do
+        Utils.install_dependencies
+        Utils.create_dir
+        Utils.start_copying_file
         exit
       end
     end
   end
-
-  def create_dir
-    FileUtils.mkdir(File.expand_path('~/hulaki'))
-  rescue Errno::EEXIST
-    puts 'Directory already exists.'
-  end
-
-  def start_copying_file
-    this_file = __FILE__
-    file_path = File.expand_path('../../lib/hulaki/config/config_sample.yml',
-                                 File.dirname(this_file))
-    desc_file = File.expand_path('~/hulaki/config.yml')
-    if File.exist?(desc_file)
-      puts "Looks like the file '#{desc_file}' already exists."
-      puts 'shall we forcefully override the file?(yes/no)'
-      handle_conflict(file_path, desc_file)
-    else
-      copy_file(file_path, desc_file)
-    end
-  end
-
-  def handle_conflict(file_path, desc_file)
-    input = gets().chomp()
-    if %w{yes y}.include?(input.downcase)
-      copy_file(file_path, desc_file)
-    else
-      puts 'You choose to leave it as it is.'
-    end
-  end
-
-  def copy_file(file_path, desc_file)
-    puts "Creating file '~/hulaki/config.yml' ..."
-    FileUtils.cp(file_path, desc_file)
-    puts "Created file '~/hulaki/config.yml' ..."
-  end
 end

data/lib/hulaki/presenter.rb

@@ -1,17 +1,23 @@
+require 'terminal-table'
 class Hulaki::Presenter
   def initialize(data)
-    @data = [data].flatten
+    no_of_results = Hulaki::Config['search'] && Hulaki::Config['search']['no_of_results'] || 10
+    @data = data[0..(no_of_results - 1)]
   end
 
   def display
-    puts '~' * 100
-    puts 'Search Results'
-    puts '~' * 100
-    @data[0..5].each do |row|
-      email = row.fetch('e_mail_1___value', 'N/A') rescue 'N/A'
-      phone_number = row.fetch('phone_1___value', 'N/A') rescue 'N/A'
-      puts "name: #{row['name']}, phone: #{phone_number}, email: #{email}" rescue nil
+    data = @data.map(&:first).map.with_index do |row, index|
+      [index+1, row['name'].bold, row['phone_1___value'].to_s.green, row['phone_2___value'], row['email']]
     end
-    puts '~' * 100
+
+    table = Terminal::Table.new :title    => "Hulaki #{Hulaki::VERSION}",
+                                :headings => ['S.N', 'Name', 'Phone 1', 'Phone 2', 'Email'],
+                                :rows     => data
+
+    table.align_column(2, :right)
+    table.align_column(3, :right)
+    table.align_column(4, :right)
+
+    puts table
   end
 end

data/lib/hulaki/recursive_ostruct.rb

@@ -1,4 +1,16 @@
 require 'ostruct'
+# = RecursiveOstruct, a tool to convert every hash inside a Hash/Array to OpenStruct object
+#   One of the benifit is, it will respond to very sort of messages like
+#   Example:
+# 
+#       newHash = {'a' => 12}
+#       wrappedHash = RecursiveOstruct.new(newHash)
+#       wrappedHash.a     # => 12 : a valid call
+#       wrappedHash['a']  # => 12 : a valid call
+#       wrappedHash[:a]   # => 12 : a valid call
+#
+#   It is a option for those who do not want to use Rails::ActiveSupport's `HashWithIndifferentAccess`
+#
 class RecursiveOstruct
   def self.ostruct(object)
     if object.is_a?(Hash)