Gimme POC

Build Status Code Climate Gem Version

Gimme POC (Point of Contact) simplifies the process of extracting the common 'contact us' information from a website.

Usage

Gimme POC simply looks for a contact page and extracts social media contact information, if present. Due to CAN-SPAM Act of 2003, emails are not harvested. Instead Gimme POC will return True or False if an email or contact form is available.

Installation

gem install gimme_poc

Set Up

require 'gimme_poc' # => that's it!

How it works

Gimme POC is easy to use! Simply run this command.


Gimme.poc 'http://example.com'

# => returns this:
#
# {
#   :contactpage=>"http://example.com/contact/", 
#   :phone_present?=>"true", 
#   :contact_form?=>"true",
#   :facebook=>"http://www.facebook.com/example",
#   :twitter=>"http://twitter.com/@example",
#   :googleplus=>"http://plus.google.com/+example",
#   :linkedin=>"http://www.linkedin.com/in/example"
#  }
#
#


Searching more than one site

You also have the ability to pass multiple urls in the form of array. For example, you could run the command below and get contact information from each site all at once.


Gimme.poc(['http://example.com', 'http://foo.com', 'http://bar.com'])

Referencing the search results

To use your search results, simply run:


Gimme.memory

Clearing the search results

To clear search results and start afresh, run:


Gimme.reset!

To do:

  • Convenience methods for returning specific information from all sites, (ie. just facebook or just twitter)
  • Work on false positives of bad urls. (Bad urls should be skipped + DNS redirects don't give 404 errors)

More to follow...