hulaki 0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23ae4598e465d968a7d6b347336b2f64480d9203
-  data.tar.gz: bd861ed5e5495fa44acb6e7686e6a86268710f63
+  metadata.gz: 223e8463666e7cd5c69f339d512680d597e6f858
+  data.tar.gz: 9d816a3224a76434bcd38c55919f72f2c5156842
 SHA512:
-  metadata.gz: 7ef0fd5d590ee83caf83f5de5c4ea22d832648e6d8bf08c8497b7175670ac4a94386e5cc06b44b463d2a7a1612a9f3e4b2cf2d346dd3f641827495e7cf0bf2f9
-  data.tar.gz: 10ab76ee6143e4372b181d1b8684cc335e0e6e17e9639063c27aebdcb1482ff3556730c8811be1f28b057fa939bd68a6b1eea0c02014e2b60c17565ae126ebf1
+  metadata.gz: 5837855f6497d7122e460ebb9ed7a8ca13a8197d4ea771ab49a08c26bdfac7ad2d938d79495e1daf23670e4fff271de30518ff34c485ae757684e127033fca9a
+  data.tar.gz: 84e1f9ced65e653e8b6e5528fc3648f8fdc039488945e2bffdb18b00f4d796840fb652a29cb1067d91031b80b36ff9ac4c42f9db0933fe7bbc45fa275ad1a83e

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    hulaki (0.1)
-      amatch
-      smarter_csv
+    hulaki (1.1)
+      amatch (~> 0.3.1)
+      clipboard (= 1.1.0)
+      mail (~> 2.6.3)
+      nexmo (~> 4.6.0)
+      smarter_csv (= 1.1.0)
+      terminal-table (= 1.8.0)
       twilio-ruby (~> 4.11.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    amatch (0.3.0)
+    amatch (0.3.1)
       tins (~> 1.0)
-    builder (3.2.2)
+    builder (3.2.3)
+    clipboard (1.1.0)
     coderay (1.1.1)
     diff-lcs (1.2.5)
     jwt (1.5.6)
@@ -20,6 +25,8 @@ GEM
     method_source (0.8.2)
     mime-types (2.99)
     multi_json (1.12.1)
+    nexmo (4.6.0)
+      jwt
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -40,11 +47,14 @@ GEM
     rspec-support (3.5.0)
     slop (3.6.0)
     smarter_csv (1.1.0)
-    tins (1.12.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    tins (1.14.0)
     twilio-ruby (4.11.1)
       builder (>= 2.1.2)
       jwt (~> 1.0)
       multi_json (>= 1.3.0)
+    unicode-display_width (1.2.1)
 
 PLATFORMS
   ruby
@@ -58,4 +68,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.13.1
+   1.15.0

data/README.md

@@ -4,7 +4,8 @@
 [![Issue Count](https://codeclimate.com/github/shivabhusal/hulaki/badges/issue_count.svg)](https://codeclimate.com/github/shivabhusal/hulaki)
 [ ![Codeship Status for shivabhusal/hulaki](https://codeship.com/projects/49470f10-ba22-0133-af95-025ac38368ea/status?branch=master)](https://codeship.com/projects/135625)
 
-#### Hulaki is a CLI tool to search contact details from your CSV file.
+#### Hulaki is a CLI tool to search contact details from your CSV file and sending easy SMS and Emails with single command.
+![Hulaki Logo](images/hulaki.png)  
 
 Hulaki makes communication easier by providing ability to search through the contact list. The CLI tool also allows sending direct SMS and/or email to desired person in contact list
 
@@ -18,40 +19,94 @@ Install this in your system using command.
     - Make sure to install this in your default ruby-version gemset. Other wise you may not be able to use the command from anywhere in your terminal emulator.  
     - Or install in every ruby-version gemset; to make the command `$ hulaki` accessible from anywhere.
 
-## Usage
-Use the following command for help
-```bash
-$ hulaki -h
-$ hulaki --help
-```
-### Search phone number or other contact detail
+
+## Usage:
+### Search
 ```bash
 $ hulaki -s search-string
 # Example: Hulaki features fuzzy search
-# $ hulaki -s smithjohn
-# $ hulaki -s johsmith
-# $ hulaki -s smijohnth
-```
+#  $ hulaki -s smithjohn
+#  $ hulaki -s johsmith
+#  $ hulaki -s smijohnth
 
-### Sending SMS
-> First search for contact number, copy it
+```
+**Example Output**
+```
+$ hulaki -s 'jhn'
++-----+--------------------------------+------------+------------+--------------------+
+|                                       Hulaki 1.0                                    |  
++-----+--------------------------------+------------+------------+--------------------+
+| S.N | Name                           | Phone 1    | Phone 2    | Email              |
++-----+--------------------------------+------------+------------+--------------------+
+| 1   | John Bhusal                    | 984xxx8271 |            | hisemail@gmail.com |
+| 2   | Joe Dhakal                     | 984xxx8627 | 980xxx1820 |                    |
+| 3   | Jhalak Parajuli                | 985xxx3695 |            |                    |
+| 4   | Jonathan Dai  Subedi           | 984xxx4397 |            |                    |
++-----+--------------------------------+------------+------------+--------------------+
 
 ```
+### SMS
+```bash
 $ hulaki -t +977xxxxxxxxxx -m "Message to be sent"
+
+# You can even select a specific SMS Gateway
+$ hulaki -t +977xxxxxxxxxx -m "Message to be sent" -g nexmo
+$ hulaki -t +61xxxxxxxxxx  -m "Message to be sent" -g twilio
+$ hulaki -t +1xxxxxxxxxx   -m "Message to be sent" -g sparrow
+
+# You can even broadcast SMSes selecting a specific SMS Gateway
+#   However, keep in mind that multiple SMS request will go to the server
+$ hulaki -t +977xxxxxxxxxx,+9779832xxxxxx -m "Message to be sent" -g nexmo
+
+# You can also change the name that appears on recipient's Phone using `-f` switch. This only works with Nexmo
+$ hulaki -t +977xxxxxxxxxx,+9779832xxxxxx -m "Message to be sent" -g nexmo -f "Hero Dai!"
+
+```
+
+### EMail
+```bash
+$ hulaki -t someone@example.com -S "Subject of the email" -m "Message to be sent"
+$ hulaki -t someone@example.com --subject "Subject of the email" -m "Message to be sent"
+
+# You can even broadcast emails, i.e. mutiple recipients
+#   However, keep in mind that multiple SMTP request will go to the server. No `CC`, `BCC` will be used
+$ hulaki -t someone@example.com,nextperson@email.com --subject "Subject of the email" -m "Message to be sent"
+
+# You can also change your sender id using `-f` switch
+$ hulaki -t someone@example.com -S "Subject of the email" -m "Message to be sent" -f "My Name<anonymous@example.com>"
+```
+
+### Email Templates/Layouts
+You are allowed to have an Email template in HTML format at `~/hulaki/template.html.erb` which will be copied when you use `-i` switch. If you have `use_template` setting set to `true` then only you will be able to use the template. Templates are like `Layouts` in Rails.
+```bash
+$ hulaki -t someone@example.com -S "Subject of the email" -m "Message to be sent"
+```
+
+### Specific options:
+```bash
+    -t, --to x,y,z                   list of recipient, can be
+    -m, --message [Message]          Message to be sent to recipient
+    -S, --subject [Subject]          Subject to email
+    -g, --gateway [Gateway Name]     Name of the gateway, `nexmo`, `twilio`, `sparrow` are currently supported
+    -f, --from [Sender]              name <email> | PhoneNumber; this will take precedence over `from` in `config.yml`.
+    -s, --search [name/contact]      Search keyword
+    -h, --help                       Help / Examples
+    -l, --list                       list all the options available
+    -i, --install                    Creates ~/hulaki/config.yml, `template.html.erb`. Will ask you if have to replace them
 ```
 
 ## Configuration
-- `Hulaki` requires the file `~/hulaki/contact.csv` to be present. 
+- `Hulaki` requires the file `~/hulaki/contact.csv` to be present.
     -  The file must be a valid `CSV` file.
-- When you install the gem, a sample config file is copied to `~/hulaki/config.yml`
-    - You need to update your `Twilio` creds
-        - `Hulaki` only supports `Twilio` at the moment. 
+- When you install the gem, a sample config and template filea are copied to `~/hulaki/`
+    - You need to update the template per requirement.
+    - You need to update your SMS gateway(eg. `Twilio`, `nexmo`) creds
+        - `Hulaki` only supports `Twilio` and `nexmo` at the moment.
     - Also, update the SMTP settings accordingly
 
 ---
 
 ## Development
-
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
@@ -64,4 +119,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/shivab
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/hulaki.gemspec

@@ -4,13 +4,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hulaki/version'
 
 Gem::Specification.new do |spec|
-  spec.name = 'hulaki'
-  spec.version = Hulaki::VERSION
-  spec.authors = ['Shiva Bhusal', 'Shishir Sapkota', 'Neha Suwal', 'Prativa Devkota']
-  spec.email = ['hotline.shiva@gmail.com']
+  spec.name     = 'hulaki'
+  spec.version  = Hulaki::VERSION
+  spec.authors  = ['Shiva Bhusal']
+  spec.email    = ['hotline.shiva@gmail.com']
 
-  spec.summary = %q{Hulaki is basically a CLI tool to search contact details \
-                          exported already in CSV format.}
+  spec.summary  = %q{Hulaki is basically a CLI tool to search contact details \
+                          exported already in CSV format, send SMS and Emails in a single command.}
 
   spec.description = %Q{We developers don't have time to grab mobile phones, \
                           slide the screen, press pin numbers, open contact list \
@@ -20,18 +20,25 @@ Gem::Specification.new do |spec|
                           search the contact details and send message if we like.}
 
   spec.homepage = 'https://github.com/shivabhusal/hulaki'
-  spec.license = 'MIT'
+  spec.license  = 'MIT'
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.files          = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir         = 'exe'
+  spec.executables    = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths  = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler',  '~> 1.10'
+  spec.add_development_dependency 'rake',     '~> 10.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec'
-  spec.add_runtime_dependency 'amatch'
-  spec.add_runtime_dependency 'twilio-ruby', '~> 4.11.1'
-  spec.add_runtime_dependency 'smarter_csv'
+
+  spec.add_runtime_dependency 'amatch',         '~> 0.3.1'
+  spec.add_runtime_dependency 'twilio-ruby',    '~> 4.11.1'
+  spec.add_runtime_dependency 'nexmo',          '~> 4.6.0'
+  spec.add_runtime_dependency 'mail',           '~> 2.6.3'
+  spec.add_runtime_dependency 'smarter_csv',    '1.1.0'
+  spec.add_runtime_dependency 'terminal-table', '1.8.0'
+  spec.add_runtime_dependency 'clipboard',      '1.1.0'
+
+  spec.post_install_message = 'Please run `$ hulaki -i` to install Configuration files so that you can modify later'
 end

data/lib/hulaki.rb

@@ -1,78 +1,10 @@
-require 'hulaki/version'
-require 'hulaki/string_modifier'
-require 'amatch'
-require 'hulaki/search_engine'
-require 'hulaki/version'
-require 'hulaki/contact_parser'
-require 'smarter_csv'
-require 'twilio-ruby'
-require 'pry'
-require 'hulaki/option_parser'
-require 'hulaki/sms_handler/sms_handler'
-require 'hulaki/sms_handler/sms_validator'
-require 'hulaki/sms_handler/gateway_adapters/twilio'
-require 'hulaki/sms_handler/gateway_adapters/sparrow'
-require 'hulaki/config/config'
-require 'hulaki/exceptions'
-require 'hulaki/email_validator'
-require 'hulaki/mailer'
-require 'hulaki/logger'
-require 'mail'
-
-class Hulaki::Core
-  def initialize(config)
-    @config = config
-  end
-
-  def perform
-    puts '~' * 100
-    puts 'Welcome to Hulaki : Your best companion! to make your day great.'
-    puts '~' * 100
-
-    @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
-
-  private
-
-  def is_phone?(number)
-    Hulaki::SmsValidator.is_phone_number?(number)
-  end
-
-  def is_email?(email)
-    Hulaki::EmailValidator.is_email?(email)
-  end
+require 'hulaki/version.rb'
+begin
+  require 'pry'
+rescue LoadError
+  # No matter if its production
+end
 
-  def handle_email(recipient)
-    puts "Sending email to #{recipient}"
-    email_handler = Hulaki::Mailer.new(
-        {
-            to:   recipient,
-            body: @config.message,
-            sub:  @config.subject,
-        })
-    puts "Email sent to #{recipient}."
-  end
 
-  def handle_sms(recipient)
-    puts "Sending SMS to #{recipient}"
-    sms_handler = Hulaki::SmsHandler.new(
-        {
-            to:      recipient,
-            message: @config.message
-        })
-    if sms_handler.send
-      puts "SMS sent successfully to #{recipient}"
-    end
-  end
-end
+path = File.expand_path('../hulaki/', __FILE__)
+Dir["#{path}/**/*.rb"].each{ |f| require f }

data/lib/hulaki/config/config.rb

@@ -1,35 +1,35 @@
+require 'smarter_csv'
 require 'yaml'
 require 'erb'
+
 class Hulaki::Config
-  ConfigPath = '~/hulaki/config.yml'
-  SampleConfigPath = 'lib/hulaki/config/config_sample.yml'
-  @@config_file_path = ConfigPath
-  attr_accessor :file_path
+  ConfigPath          = '~/hulaki/config.yml'
+  SampleConfigPath    = File.expand_path('../sample.config.yml',        __FILE__)
+  SampleContactPath   = File.expand_path('../sample.contact.csv',       __FILE__)
+  SampleTemplatePath  = File.expand_path('../sample.template.html.erb', __FILE__)
 
-  def initialize(params = {})
-    @file_path = File.expand_path(params.fetch(:path, @@config_file_path))
-  end
+  @@config_file_path = File.expand_path(ConfigPath)
 
-  def parse
-    read_file
-  end
+  class << self
+    def [](key)
+      config[key]
+    end
 
-  private
+    def config_file_path=(config_file_path)
+      @@config_file_path = File.expand_path(config_file_path)
+    end
 
-  def read_file
-    read_file = File.open(@file_path).read
-    YAML.load(ERB.new(read_file).result)
-  rescue Errno::ENOENT => e
-    raise Hulaki::InvalidFilePath, 'Invalid file.'
-  end
+    private
 
-  class << self
-    def config_file_path=(config_file_path)
-      @@config_file_path = config_file_path
+    def config
+      @@config ||= parse
     end
 
-    def config_file_path
-      @@config_file_path
+    def parse
+      read_file = File.open(@@config_file_path ).read
+      YAML.load(ERB.new(read_file).result)
+    rescue Errno::ENOENT => e
+      raise Hulaki::InvalidFilePath, 'Invalid file.'
     end
   end
 end

data/lib/hulaki/config/sample.config.yml

@@ -0,0 +1,34 @@
+sms:
+  # The later config will override the former one
+  # To have multiple config and switch between them, comment the not used one
+  twilio:
+    default:                       true
+    API_KEY:                       ACf43b1e6876as8d7a6sd27515ea49e418
+    API_SECRET:                    75768435c30daeef519439kjhkjahsdk
+    ACCOUNT_PHONE_NUMBER:          +150447566666
+
+  nexmo:
+    API_KEY:                       ACf43b1e6167987123jhkhkhkjjj49e418
+    API_SECRET:                    75768435c30daeef519439c123123123f
+    ACCOUNT_PHONE_NUMBER:          +154444451701
+
+  sparrow:
+    API_KEY:                       ACf43b1e6167987123jhkhkhkjjj49e418
+    API_SECRET:                    75768435c30daeef519439c123123123f
+    ACCOUNT_PHONE_NUMBER:          +154444451701
+    from:                          Your Name
+
+email:
+  delivery_method:                 smtp
+  address:                         smtp.gmail.com
+  port:                            587
+  domain:                          gmail.com
+  user_name:                       youremail@gmail.com
+  password:                        p@ssword123
+  authentication:                  plain
+  from:                            your_name <your_email@example.com>
+  # This feature will let you use a template stored in `~/hulaki/template.`
+  use_template:                    true
+
+search:
+  no_of_results:                    10

data/lib/hulaki/config/sample.contact.csv

@@ -0,0 +1,4 @@
+Name,First Name,Last Name,Phone 1 - Type,Phone 1 - Value,Phone 2 - Type,Phone 2 - Value,Address 1 - Type,Address 1 - Formatted
+Shiva Bhusal,Shiva,Bhusal,Mobile,9843488889,Home,034567238,Home,Kathmandu-Dhobikhola
+Shiva Gaire,Shiva,Gaire,Mobile,9843488889,Home,034567238,Home,Kathmandu-Dhobikhola
+Yubraj Acharya,Yubraj,Acharya,Mobile,9843488867,Home,034563338,Home,Kathmandu-Dhobikhola

data/lib/hulaki/config/sample.template.html.erb

@@ -0,0 +1,10 @@
+<h1>Your heading might go here!</h1>
+<section>
+  You body will be inserted here, if you wish to use, modify this file accordingly.
+  <%= @email_body %>
+</section>
+<p>
+regards,<br>
+Your Name
+</p>
+<footer>This will be your footer</footer>