hulaki 0.1 → 1.0.2

data/lib/hulaki/search_engine.rb

@@ -1,3 +1,5 @@
+require 'amatch'
+
 class Hulaki::SearchEngine
   include Amatch
 
@@ -15,27 +17,34 @@ class Hulaki::SearchEngine
   private
 
   def search(data)
-    result = search_result(data).select { |x| x[1] > 0.3 }
+    result = search_result(data).select { |x| x[1] > 0.4 } # setting threshold
+    # Sort data keeping data with higer degree of similarity at the top
+    # i.e. having lowest value of percentage at the bottom
     result.sort { |x, y| y[1] <=> x[1] }
   end
 
   def search_result(data)
+    downcased_data = data.downcase.gsub(' ', '')
     @csv_data.map do |row|
-      pt = 0.0
-      row.each do |k, v|
-        keys_to_search.each do |key|
-          if k.to_s.match(key.to_s)
-            pt += PairDistance.new(v.to_s).match(data.to_s)
+      max_point = 0.0
+      row.each do |col_head, v|
+        keys_to_search.each do |key, weight|
+          if col_head.to_s.downcase == key
+            point = PairDistance.new(v.to_s.downcase).match(downcased_data)*weight
+            max_point = point if max_point < point
+            # puts "#{key} #{col_head} #{point} #{v} #{downcased_data}"
           end
         end
       end
-      weight = pt / keys_to_search.count
-      percentage = weight *100
-      [row, percentage]
+
+      [row, max_point]
     end
   end
 
   def keys_to_search
-    ['name', 'email', 'phone']
+    {
+      'name'        => 2, 'first_name'  => 3, 'last_name'        => 3, 'given_name' => 3,
+      'family_name' => 3, 'email'     => 0.6, 'phone_1___value'=> 0.5, 'phone_2___value' => 0.5
+    }
   end
 end

data/lib/hulaki/sms_handler/gateway_adapters/nexmo.rb

@@ -0,0 +1,21 @@
+require 'nexmo'
+
+class Hulaki::Nexmo
+  attr_reader :to, :from, :message, :client
+
+  def initialize(params = {})
+    @to      = params[:to]
+    @message = params[:message]
+
+    @config  = params[:config]
+    @from    = params.fetch(:from, @config['from'])
+    return true if ENV['mode'] == 'test'
+    @client  = Nexmo::Client.new(key: @config['API_KEY'], secret: @config['API_SECRET'])
+
+  end
+
+  def send
+    return true if ENV['mode'] == 'test'
+    client.send_message(from: from, to: to, text: message)
+  end
+end

data/lib/hulaki/sms_handler/gateway_adapters/twilio.rb

@@ -1,35 +1,24 @@
+require 'twilio-ruby'
+
 class Hulaki::Twilio
   attr_reader :to, :from, :message
 
   def initialize(params = {})
-    @to = params[:to]
+    @to      = params[:to]
     @message = params[:message]
 
-    @config = params[:config]['keys']
-    @from = params.fetch(:from, @config['TWILIO_PHONE_NUMBER'])
-    @client = Twilio::REST::Client.new @config['TWILIO_ACCOUNT_SID'],
-                                       @config['TWILIO_AUTH_TOKEN']
+    @config  = params[:config]
+    @from    = @config['ACCOUNT_PHONE_NUMBER']
+    @client  = Twilio::REST::Client.new @config['API_KEY'],
+                                       @config['API_SECRET']
   end
 
   def send
-    return true if @@mode == 'test'
+    return true if ENV['mode'] == 'test'
     @client.messages.create(
         from: from,
         to: to,
         body: message
     )
   end
-
-  class << self
-    @@mode = 'live'
-
-    def mode=(mode)
-      @@mode = mode
-    end
-
-    def mode
-      @@mode
-    end
-  end
-
 end

data/lib/hulaki/sms_handler/sms_handler.rb

@@ -1,13 +1,16 @@
 class Hulaki::SmsHandler
+  VALID_GATEWAY = ['twilio', 'nexmo', 'sparrow']
   attr_reader :gateway, :to, :from, :message
 
   def initialize(params = {})
-    @to = params.fetch(:to, params[:recipient])
-    @from = params.fetch(:from, params[:sender])
+    @to      = params.fetch(:to, params[:recipient])
+    @from    = params.fetch(:from, params[:sender])
     @message = params.fetch(:message, params[:msg])
 
-    @gateway = get_gateway(params.fetch(:gateway, 'twilio'))
+    explicit_gateway = params[:gateway] && VALID_GATEWAY.include?(params[:gateway].downcase) && params[:gateway].downcase
 
+    @gateway_name = explicit_gateway || get_default_gateway_name
+    @gateway      = get_gateway
   end
 
   def send
@@ -17,19 +20,16 @@ class Hulaki::SmsHandler
 
   private
 
-  def get_gateway(gateway_name = nil)
+  def get_gateway
     config = gateway_config
-
-    gateway_name ||= config['name']
-
-    klass = gateway_name.to_s.capitalize
+    klass  = @gateway_name.to_s.capitalize
 
     eval("Hulaki::#{klass}").new(
         {
-            config: config,
-            to: to,
-            from: from || gateway_config['keys']['TWILIO_PHONE_NUMBER'],
-            message: message
+            :config  => gateway_config,
+            :to      => to,
+            :from    => from || gateway_config['from'],
+            :message => message
         })
 
   rescue SyntaxError => e
@@ -38,11 +38,20 @@ class Hulaki::SmsHandler
 
   def verify_details
     Hulaki::SmsValidator.new(to: to,
-                             from: from || gateway_config['keys']['TWILIO_PHONE_NUMBER'],
+                             from: from || gateway_config['ACCOUNT_PHONE_NUMBER'],
                              message: message).validate
   end
 
+  def get_default_gateway_name
+      Hulaki::Config['sms'].each do|key, value|
+        return key if value['default'] == true
+      end
+
+      # If no default defined in the config; pick the last one
+      Hulaki::Config['sms'].keys.last
+  end
+
   def gateway_config
-    Hulaki::Config.new.parse['sms']['gateway']
+    @gateway_config ||= Hulaki::Config['sms'][@gateway_name]
   end
 end

data/lib/hulaki/sms_handler/sms_validator.rb

@@ -3,15 +3,13 @@ class Hulaki::SmsValidator
   RegexPhoneNumber = /(?:\+?|\b)[0-9]{10}\b/
 
   def initialize(params = {})
-    @errors = {}
-    @to = params.fetch(:to, params[:recipient])
-    @from = params.fetch(:from, params[:sender])
+    @errors  = {}
+    @to      = params.fetch(:to, params[:recipient])
     @message = params.fetch(:message, params[:msg])
   end
 
   def validate
-    to || (raise Hulaki::InvalidPhoneNumber, 'Recipient phone number should be present.')
-    from || (raise Hulaki::InvalidPhoneNumber, 'Sender phone number should be present.')
+    to      || (raise Hulaki::InvalidPhoneNumber, 'Recipient phone number should be present.')
     message || (raise Hulaki::InvalidMessageBody, 'Message body should be present.')
 
     check_if_number_invalid
@@ -29,9 +27,6 @@ class Hulaki::SmsValidator
   def check_if_number_invalid
     RegexPhoneNumber.match(to) || (raise Hulaki::InvalidPhoneNumber,
                                          "Phone number '#{to}' is invalid.")
-
-    RegexPhoneNumber.match(from) || (raise Hulaki::InvalidPhoneNumber,
-                                           "Phone number '#{from}' is invalid.")
   end
 
 end

data/lib/hulaki/string_modifier.rb

@@ -2,7 +2,11 @@ class String
   def black; "\e[30m#{self}\e[0m" end
   def red; "\e[31m#{self}\e[0m" end
   def green; "\e[32m#{self}\e[0m" end
+  def brown; "\e[33m#{self}\e[0m" end
   def blue; "\e[34m#{self}\e[0m" end
+  def magenta; "\e[35m#{self}\e[0m" end
+  def cyan; "\e[36m#{self}\e[0m" end
+  def gray; "\e[37m#{self}\e[0m" end
 
   def bg_black; "\e[40m#{self}\e[0m" end
   def bg_red; "\e[41m#{self}\e[0m" end

data/lib/hulaki/utils.rb

@@ -0,0 +1,76 @@
+module Utils
+  def create_dir
+    FileUtils.mkdir(File.expand_path('~/hulaki'))
+  rescue Errno::EEXIST
+    puts 'Looks like directory `~/hulaki` already exists.'.brown
+  end
+
+  def install_dependencies
+    if `which xclip`.match('not found')
+      puts "Looks like you don't `xclip` installed in your system. It is required to copy phone numbers to ClipBoard"
+      puts 'We are installing it right now ... '
+      puts 'It will ask you password: Be ready'
+      puts `sudo apt-get install xclip`.red
+      puts '`xclip` successfully installed!'.green
+    else
+      puts '`xclip` is already installed!'
+    end
+  end
+
+  def start_copying_file
+    # this line is for debugging purposes
+    this_file = __FILE__
+    files_to_be_copied = {
+      'sample.contact.csv'        => 'contact.csv',
+      'sample.config.yml'         => 'config.yml',
+      'sample.template.html.erb'  => 'template.html.erb'
+    }
+
+    # Start copying the files
+    files_to_be_copied.each do|source, dest|
+      file_path = File.expand_path("../../lib/hulaki/config/#{source}", File.dirname(this_file))
+      desc_file = File.expand_path("~/hulaki/#{dest}")
+      if File.exist?(desc_file)
+        puts "Looks like the file '#{desc_file}' already exists.".brown
+        print 'Shall we forcefully override the file?(yes/no)'.brown
+        handle_conflict(file_path, desc_file)
+      else
+        copy_file(file_path, desc_file)
+      end
+    end
+    Hulaki::Logger.log '~'*100
+    Hulaki::Logger.log 'Please make sure you have modified the files at `~/hulaki` a/c to your need.'
+    Hulaki::Logger.log '~'*100
+  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
+      Hulaki::Logger.log 'You choose to leave it as it is.'
+    end
+  end
+
+  def copy_file(file_path, desc_file)
+    puts "Creating file '#{desc_file}' ...".brown
+    FileUtils.cp(file_path, desc_file)
+    Hulaki::Logger.log  "Created file '#{desc_file}' ..."
+  end
+
+  def present(object)
+    object.to_s.split("\n").map{|x|
+      if x[0] == '#'
+        x.gray
+      elsif x[0] == '$'
+        x.green
+      elsif x.match('---')
+        x.brown
+      else
+        x
+      end
+    }.join("\n")
+  end
+
+  module_function :create_dir, :start_copying_file, :handle_conflict, :copy_file, :install_dependencies, :present
+end

data/lib/hulaki/version.rb

@@ -1,3 +1,3 @@
 module Hulaki
-  VERSION = '0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,17 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hulaki
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 1.0.2
 platform: ruby
 authors:
 - Shiva Bhusal
-- Shishir Sapkota
-- Neha Suwal
-- Prativa Devkota
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-25 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,16 +70,16 @@ dependencies:
   name: amatch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: twilio-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -97,20 +94,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.11.1
+- !ruby/object:Gem::Dependency
+  name: nexmo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
 - !ruby/object:Gem::Dependency
   name: smarter_csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: We developers don't have time to grab mobile phones,                           slide
   the screen, press pin numbers, open contact list                           and search
   the person you are looking for. Instead it would                           me much
@@ -137,29 +190,36 @@ files:
 - bin/setup
 - exe/hulaki
 - hulaki.gemspec
+- images/hulaki.png
 - lib/hulaki.rb
 - lib/hulaki/config/config.rb
-- lib/hulaki/config/config_sample.yml
+- lib/hulaki/config/sample.config.yml
+- lib/hulaki/config/sample.contact.csv
+- lib/hulaki/config/sample.template.html.erb
 - lib/hulaki/contact_parser.rb
-- lib/hulaki/email_validator.rb
+- lib/hulaki/core.rb
+- lib/hulaki/email_handler/email_validator.rb
+- lib/hulaki/email_handler/mailer.rb
 - lib/hulaki/exceptions.rb
 - lib/hulaki/logger.rb
-- lib/hulaki/mailer.rb
 - lib/hulaki/option_parser.rb
 - lib/hulaki/presenter.rb
 - lib/hulaki/recursive_ostruct.rb
 - lib/hulaki/search_engine.rb
+- lib/hulaki/sms_handler/gateway_adapters/nexmo.rb
 - lib/hulaki/sms_handler/gateway_adapters/sparrow.rb
 - lib/hulaki/sms_handler/gateway_adapters/twilio.rb
 - lib/hulaki/sms_handler/sms_handler.rb
 - lib/hulaki/sms_handler/sms_validator.rb
 - lib/hulaki/string_modifier.rb
+- lib/hulaki/utils.rb
 - lib/hulaki/version.rb
 homepage: https://github.com/shivabhusal/hulaki
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Please run `$ hulaki -i` to install Configuration files so that
+  you can modify later
 rdoc_options: []
 require_paths:
 - lib
@@ -175,9 +235,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Hulaki is basically a CLI tool to search contact details \ exported already
-  in CSV format.
+  in CSV format, send SMS and Emails in a single command.
 test_files: []