ppl 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a9d02380f3d44f146c22dd0e466d98ae56ac97d
-  data.tar.gz: e85bf61f41a01927c72450f761563ad9669c5fdd
+  metadata.gz: 1e392faaea1882705856f5dbe483e493ca0c427a
+  data.tar.gz: 2334459a46cc72d92aa8c3c2f0a500a15de3fb5c
 SHA512:
-  metadata.gz: 0f325d2c01e00c070edac9f3c6066185bf13bb20c7c25f1c659534485a833e28b7b5b6c7a25b42fe016f33b417800df2567a7ae591b8736a49027cc1cdada069
-  data.tar.gz: a388cc2f1f2af9c50afa01da54ac54994c9d2b25f290a75e07bc041b8f9c4051c27697fc997bdaec46d2739c920d7d610eeb814261610c90525ac1e30b1c9cca
+  metadata.gz: 6227509847307b130c84049c0ce92063ea9079320e76e9530021a0fe7b3cd75425e1276abc2fbc35dcb2e6c0bb85f0c44181cd5235362e9fca4764f167cab584
+  data.tar.gz: 0e737fbd7ec0817918693c406587efab38d7f8f3dc8eb1f11577669665cf2a0750e5fdf70c6c445716848e94e6d45aeb7d47f6d316eb2625937c120e1cff60bc

data/completions/bash

@@ -6,7 +6,7 @@ _ppl()
   prev="${COMP_WORDS[COMP_CWORD-1]}"
 
   # Complete options
-  opts="add age bday email init ls mutt mv name nick org phone post pull push remote rm shell show url version"
+  opts="add age bday completion email init ls mutt mv name nick org phone post pull push remote rm scrape shell show url version"
   if [[ ${prev} == "ppl" ]]; then
     COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
     return 0

data/completions/zsh

@@ -10,6 +10,7 @@ _1st_arguments=(
   "add:Add a new contact"
   "age:List or show contacts's ages"
   "bday:List, show or change birthdays"
+  "completion:Output shell completion function"
   "email:Show or change a contact's email address"
   "init:Create an empty address book"
   "ls:List all contacts"
@@ -24,6 +25,7 @@ _1st_arguments=(
   "push:Execute 'git push' in the address book directory"
   "remote:Execute 'git remote' in the address book directory"
   "rm:Delete a contact"
+  "scrape:Scrape contact details from stdin"
   "shell:Interactive mode"
   "show:Display the full details of a contact"
   "url:List, show or change URLs"

data/lib/ppl.rb

@@ -1,7 +1,7 @@
 
 module Ppl
 
-  Version = "1.18.0"
+  Version = "1.19.0"
 
   module Adapter
   end
@@ -26,6 +26,8 @@ end
 
 require "ppl/adapter/color"
 require "ppl/adapter/color/colored"
+require "ppl/adapter/email_scraper"
+require "ppl/adapter/email_scraper/mail"
 require "ppl/adapter/storage"
 require "ppl/adapter/storage/disk"
 require "ppl/adapter/storage/factory"
@@ -64,6 +66,7 @@ require "ppl/command/url"
 require "ppl/command/version"
 require "ppl/command/external"
 require "ppl/command/completion"
+require "ppl/command/scrape"
 
 require "ppl/entity/address_book"
 require "ppl/entity/contact"

data/lib/ppl/adapter/email_scraper.rb

@@ -0,0 +1,9 @@
+
+class Ppl::Adapter::EmailScraper
+
+  def scrape_contacts(email)
+    raise NotImplementedError
+  end
+
+end
+

data/lib/ppl/adapter/email_scraper/mail.rb

@@ -0,0 +1,40 @@
+
+require "mail"
+
+class Ppl::Adapter::EmailScraper::Mail
+
+  def scrape_contacts(email)
+    email = Mail.new(email)
+    contacts = []
+
+    sender = scrape_sender(email)
+    unless sender.nil?
+      contacts << sender
+    end
+
+    contacts
+  end
+
+  private
+
+  def scrape_sender(email)
+    from = email[:from]
+    unless from.nil?
+      sender = Ppl::Entity::Contact.new
+      sender.name = from.tree.addresses.first.display_name
+      sender.email_addresses << from.tree.addresses.first.address
+      sender.id = generate_contact_id(sender)
+      sender
+    end
+  end
+
+  def generate_contact_id(contact)
+    if !contact.name.nil?
+      contact.name.downcase.tr(" ", "_")
+    elsif !contact.email_addresses.empty?
+      contact.email_addresses.first
+    end
+  end
+
+end
+

data/lib/ppl/application/bootstrap.rb

@@ -139,6 +139,13 @@ class Ppl::Application::Bootstrap
     rm
   end
 
+  register :command_scrape do
+    scrape = Ppl::Command::Scrape.new
+    scrape.storage = storage_adapter
+    scrape.email_scraper = email_scraper
+    scrape
+  end
+
   register :command_shell do
     shell = Ppl::Command::Shell.new
     shell.storage = storage_adapter
@@ -186,6 +193,7 @@ class Ppl::Application::Bootstrap
     suite.add_command command_push
     suite.add_command command_remote
     suite.add_command command_rm
+    suite.add_command command_scrape
     suite.add_command command_shell
     suite.add_command command_show
     suite.add_command command_url
@@ -337,5 +345,9 @@ class Ppl::Application::Bootstrap
     Ppl::Adapter::Vcard::GreenCard.new
   end
 
+  register :email_scraper do
+    Ppl::Adapter::EmailScraper::Mail.new
+  end
+
 end
 

data/lib/ppl/application/input.rb

@@ -4,11 +4,13 @@ class Ppl::Application::Input
   attr_accessor :arguments
   attr_accessor :options
   attr_accessor :stdin
+  attr_accessor :argf
 
   def initialize(arguments=[])
     @arguments = arguments
     @options   = {}
     @stdin     = $stdin
+    @argf      = ARGF
   end
 
 end

data/lib/ppl/command/scrape.rb

@@ -0,0 +1,65 @@
+
+require "readline"
+
+class Ppl::Command::Scrape < Ppl::Application::Command
+
+  name        "scrape"
+  description "Scrape contact details from stdin"
+
+  attr_writer :email_scraper
+
+  def options(parser, options)
+    parser.banner = "usage: ppl scrape [<options>]"
+    parser.on("-q", "--quiet", "Add contacts to the address book without prompting") do |i|
+      options[:quiet] = i
+    end
+    parser.on("-s", "--sender", "Scrape the sender's contact details") do |i|
+      options[:sender] = i
+    end
+  end
+
+  def execute(input, output)
+    contacts = scrape_email(input)
+    contacts.each do |contact|
+      if store_contact?(contact, input)
+        @storage.save_contact(contact)
+      end
+    end
+    return true
+  end
+
+  private
+
+  def scrape_email(input)
+    ARGV.shift
+    email = input.stdin.read
+    contacts = []
+    if input.options[:sender]
+      contacts |= scrape_sender(email)
+    end
+    contacts
+  end
+
+  def scrape_sender(email)
+    @email_scraper.scrape_contacts(email)
+  end
+
+  def store_contact?(contact, input)
+    if input.options[:quiet]
+      true
+    else
+      input.stdin.reopen("/dev/tty", "r") if input.stdin.eof?
+      message = generate_prompt_string(contact)
+      Readline.readline(message).downcase != "n"
+    end
+  end
+
+  def generate_prompt_string(contact)
+    sprintf('Add "%s <%s>" to your address book [Y/n]? ',
+      contact.name,
+      contact.email_addresses.first
+    )
+  end
+
+end
+

data/ppl.gemspec

@@ -2,8 +2,8 @@
 Gem::Specification.new do |spec|
 
   spec.name        = "ppl"
-  spec.version     = "1.18.0"
-  spec.date        = "2013-04-16"
+  spec.version     = "1.19.0"
+  spec.date        = "2013-04-19"
 
   spec.required_ruby_version = ">= 1.9.3"
 
@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency("colored", "1.2")
   spec.add_dependency("inifile", "2.0.2")
+  spec.add_dependency("mail", "2.5.3")
   spec.add_dependency("morphine", "0.1.1")
   spec.add_dependency("rugged", "0.17.0.b6")
   spec.add_dependency("greencard", "0.0.5")

data/spec/ppl/adapter/email_scraper/mail_spec.rb

@@ -0,0 +1,81 @@
+
+describe Ppl::Adapter::EmailScraper::Mail do
+
+  before(:each) do
+    @adapter = Ppl::Adapter::EmailScraper::Mail.new
+  end
+
+  describe "#scrape_contacts" do
+
+    it "should return an array" do
+      @adapter.scrape_contacts("").should eq []
+    end
+
+    it "should scrape the sender's name" do
+      email = [
+        "Date: Fri, 30 Nov 2012 17:09:33 +0000",
+        "From: Test User <test@example.org>",
+        "Message-ID: <qwertyuioasdfghjk@mail.example.org>",
+        "Subject: Test Email",
+        "To: henry@henrysmith.org",
+        "",
+        "Hey,",
+        "This is a test email.",
+        "Bye!",
+      ].join("\n")
+      contacts = @adapter.scrape_contacts(email)
+      contacts.first.name.should eq "Test User"
+    end
+
+    it "should scrape the sender's email address" do
+      email = [
+        "Date: Fri, 30 Nov 2012 17:09:33 +0000",
+        "From: Test User <test@example.org>",
+        "Message-ID: <qwertyuioasdfghjk@mail.example.org>",
+        "Subject: Test Email",
+        "To: henry@henrysmith.org",
+        "",
+        "Hey,",
+        "This is a test email.",
+        "Bye!",
+      ].join("\n")
+      contacts = @adapter.scrape_contacts(email)
+      contacts.first.email_addresses.first.should eq "test@example.org"
+    end
+
+    it "should generate an ID for the sender based on their name" do
+      email = [
+        "Date: Fri, 30 Nov 2012 17:09:33 +0000",
+        "From: Test User <test@example.org>",
+        "Message-ID: <qwertyuioasdfghjk@mail.example.org>",
+        "Subject: Test Email",
+        "To: henry@henrysmith.org",
+        "",
+        "Hey,",
+        "This is a test email.",
+        "Bye!",
+      ].join("\n")
+      contacts = @adapter.scrape_contacts(email)
+      contacts.first.id.should eq "test_user"
+    end
+
+    it "should generate a sender ID based on email address if there's no name" do
+      email = [
+        "Date: Fri, 30 Nov 2012 17:09:33 +0000",
+        "From: test@example.org",
+        "Message-ID: <qwertyuioasdfghjk@mail.example.org>",
+        "Subject: Test Email",
+        "To: henry@henrysmith.org",
+        "",
+        "Hey,",
+        "This is a test email.",
+        "Bye!",
+      ].join("\n")
+      contacts = @adapter.scrape_contacts(email)
+      contacts.first.id.should eq "test@example.org"
+    end
+
+  end
+
+end
+

data/spec/ppl/adapter/email_scraper_spec.rb

@@ -0,0 +1,15 @@
+
+describe Ppl::Adapter::EmailScraper do
+
+  before(:each) do
+    @adapter = Ppl::Adapter::EmailScraper.new
+  end
+
+  describe "#scrape_contacts" do
+    it "should raise not implemented error" do
+      expect{@adapter.scrape_contacts("")}.to raise_error(NotImplementedError)
+    end
+  end
+
+end
+

data/spec/ppl/application/bootstrap_spec.rb

@@ -127,6 +127,12 @@ describe Ppl::Application::Bootstrap do
     end
   end
 
+  describe "#command_scrape" do
+    it "should return a Ppl::Command::Scrape" do
+      @bootstrap.command_scrape.should be_a(Ppl::Command::Scrape)
+    end
+  end
+
   describe "#command_shell" do
     it "should return a Ppl::Command::Shell" do
       @bootstrap.command_shell.should be_a(Ppl::Command::Shell)
@@ -464,6 +470,9 @@ describe Ppl::Application::Bootstrap do
     it "should contain the 'rm' command" do
       @bootstrap.command_suite.find_command("rm").should_not be nil
     end
+    it "should contain the 'scrape' command" do
+      @bootstrap.command_suite.find_command("scrape").should_not be nil
+    end
     it "should contain the 'show' command" do
       @bootstrap.command_suite.find_command("show").should_not be nil
     end

data/spec/ppl/command/scrape_spec.rb

@@ -0,0 +1,97 @@
+
+describe Ppl::Command::Scrape do
+
+  before(:each) do
+    @command = Ppl::Command::Scrape.new
+    @input   = Ppl::Application::Input.new
+    @input.stdin = double(IO)
+    @contact = Ppl::Entity::Contact.new
+    @output  = double(Ppl::Application::Output)
+    @email_scraper = double(Ppl::Adapter::EmailScraper)
+    @storage = double(Ppl::Adapter::Storage)
+    @address_book = double(Ppl::Entity::AddressBook)
+    @command.storage = @storage
+    @command.email_scraper = @email_scraper
+  end
+
+  describe "#name" do
+    it "should be 'scrape'" do
+      @command.name.should eq "scrape"
+    end
+  end
+
+  describe "#execute" do
+
+    before(:each) do
+      @input.stdin.stub(:read)
+      @input.stdin.stub(:reopen)
+      @input.stdin.stub(:eof?)
+      @email_scraper.stub(:scrape_contacts).and_return([])
+      Readline.stub(:readline).and_return("")
+      @storage.stub(:save_contact)
+    end
+
+    it "should read input from stdin" do
+      @input.options[:sender] = true
+      @input.stdin.should_receive(:read)
+      @command.execute(@input, @output)
+    end
+
+    it "should pass input to the email scraper" do
+      @input.options[:sender] = true
+      @email_scraper.should_receive(:scrape_contacts)
+      @command.execute(@input, @output)
+    end
+
+    it "shouldn't do any scraping unless told which fields to scrape" do
+      @email_scraper.should_not_receive(:scrape_contacts)
+      @command.execute(@input, @output)
+    end
+
+    it "should always save contacts if in quiet mode" do
+      @input.options[:sender] = true
+      @input.options[:quiet] = true
+      @email_scraper.stub(:scrape_contacts).and_return([@contact])
+      Readline.should_not_receive(:readline)
+      @storage.should_receive(:save_contact)
+      @command.execute(@input, @output)
+    end
+
+    it "should reopen stdin to prompt the user" do
+      @input.options[:sender] = true
+      @input.stdin.should_receive(:eof?).and_return(true)
+      @input.stdin.should_receive(:reopen)
+      @email_scraper.stub(:scrape_contacts).and_return([@contact])
+      @command.execute(@input, @output)
+    end
+
+    it "should save the contact if the user approves" do
+      @input.options[:sender] = true
+      @email_scraper.stub(:scrape_contacts).and_return([@contact])
+      Readline.should_receive(:readline).and_return("y")
+      @storage.should_receive(:save_contact)
+      @command.execute(@input, @output)
+    end
+
+    it "should not save the contact if the user disapproves" do
+      @input.options[:sender] = true
+      @email_scraper.stub(:scrape_contacts).and_return([@contact])
+      Readline.should_receive(:readline).and_return("n")
+      @storage.should_not_receive(:save_contact)
+      @command.execute(@input, @output)
+    end
+
+    it "should prompt the user with the contact's name and email address" do
+      @input.options[:sender] = true
+      contact = Ppl::Entity::Contact.new
+      contact.name = "Test Person"
+      contact.email_addresses << "test@example.org"
+      @email_scraper.stub(:scrape_contacts).and_return([contact])
+      Readline.should_receive(:readline).with("Add \"Test Person <test@example.org>\" to your address book [Y/n]? ")
+      @command.execute(@input, @output)
+    end
+
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ppl
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Henry Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.3
 - !ruby/object:Gem::Dependency
   name: morphine
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +173,8 @@ files:
 - lib/ppl.rb
 - lib/ppl/adapter/color.rb
 - lib/ppl/adapter/color/colored.rb
+- lib/ppl/adapter/email_scraper.rb
+- lib/ppl/adapter/email_scraper/mail.rb
 - lib/ppl/adapter/storage.rb
 - lib/ppl/adapter/storage/disk.rb
 - lib/ppl/adapter/storage/factory.rb
@@ -191,6 +207,7 @@ files:
 - lib/ppl/command/phone.rb
 - lib/ppl/command/post.rb
 - lib/ppl/command/rm.rb
+- lib/ppl/command/scrape.rb
 - lib/ppl/command/shell.rb
 - lib/ppl/command/show.rb
 - lib/ppl/command/url.rb
@@ -230,6 +247,8 @@ files:
 - ppl.gemspec
 - spec/ppl/adapter/color/colored_spec.rb
 - spec/ppl/adapter/color_spec.rb
+- spec/ppl/adapter/email_scraper/mail_spec.rb
+- spec/ppl/adapter/email_scraper_spec.rb
 - spec/ppl/adapter/output_spec.rb
 - spec/ppl/adapter/storage/disk_spec.rb
 - spec/ppl/adapter/storage/factory_spec.rb
@@ -262,6 +281,7 @@ files:
 - spec/ppl/command/phone_spec.rb
 - spec/ppl/command/post_spec.rb
 - spec/ppl/command/rm_spec.rb
+- spec/ppl/command/scrape_spec.rb
 - spec/ppl/command/shell_spec.rb
 - spec/ppl/command/show_spec.rb
 - spec/ppl/command/url_spec.rb