gimme_poc 0.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5863cfeab7d822a42e8a69f6bc304a7f93feb475
+  data.tar.gz: be4262c816f306de6fc53fd088317d552dd3ce70
+SHA512:
+  metadata.gz: ca6993932877a4b6c1a8f02c6dfa11cee7848cd232d0083ba4b9ef1c5e39439fd785eb3bfc17fee52c641021ab2d144c210134fc4ec46ab6be2cf3b0147d2a9d
+  data.tar.gz: 702e680dc3f8f44a67bec6d08258b8ebe9a3c6b9dcfed58872a8ac56d53a8298ce8b40b0f1230970cc2f85e093c5957013c13ce67bc2d07f89fa65533632bbd8

data/LICENSE.txt

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+Copyright (c) 2015 John Mason
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+## gimme_poc
+
+MTF

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_gimme_poc*.rb'
+  test.verbose = true
+end
+
+desc 'Open console with gimme_poc loaded'
+task :console do
+  exec 'pry -r ./lib/gimme_poc.rb'
+end

data/lib/gimme_poc/version.rb

@@ -0,0 +1,3 @@
+module Gimme
+  VERSION = "0.0.0.beta"
+end

data/lib/gimme_poc.rb

@@ -0,0 +1,202 @@
+require 'mechanize'
+require 'colored'
+require_relative './gimme_poc/version'
+
+# Find the contact
+module Gimme
+  class << self
+    attr_accessor :page, :contact, :contact_links, :url
+    
+    # Simple regex that looks for ###.#### or ###-####
+    PHONE_REGEX = /\d{3}[-]\d{4}|\d{3}[.]\d{4}/
+    
+    ## ----------------------------------------------------------------
+    # Questions 
+    #
+    #
+    #
+    
+    # Boolean, returns true if contact link is present.
+    def contact_link?
+      @url = link_with_href('contact')
+      !!(@url != nil)
+    end
+    
+    # Check if contact page '../contact' gets a 404 error.
+    def contact_page?
+      @url = page.uri.merge('../contact').to_s
+      begin
+        true if Mechanize.new.get(@url)
+      rescue Mechanize::ResponseCodeError
+        false
+      end
+    end
+    
+
+    # Boolean, returns true if link to English version is present.
+    def english_link?
+      return false if page.link_with(href: /english/).nil?
+      @url = page.uri.merge(page.link_with(href: /english/).uri.to_s).to_s
+      !!(@url != nil)
+    end
+    
+    # Check if english page '../en' gets a 404 error.
+    def en_page?
+      @url = page.uri.merge('../en').to_s
+      begin
+        true if Mechanize.new.get(@url)
+      rescue Mechanize::ResponseCodeError
+        false
+      end
+    end
+
+
+    # Check if english page '../english' gets a 404 error.
+    def english_page?
+      @url = page.uri.merge('../english').to_s
+      begin
+        true if Mechanize.new.get(@url)
+      rescue Mechanize::ResponseCodeError
+        false
+      end
+    end
+
+    # Boolean, returns true if anything is present
+    # after running scan_for_contacts.
+    def something_to_save?
+      scan_for_contacts.any?
+    end
+    
+    # Boolean, returns true if email is present.
+    def email_available?
+      !!(link_with_href('mailto') != nil)
+    end
+    
+    
+    # Boolean, returns true if phone number is present.
+    def phone_available?
+      !!(page.body =~ PHONE_REGEX)
+    end
+    
+    # TODO: build better conditional to prevent false positives.
+    # There could be other forms like newsletter signup, etc.
+    #
+    # If there is a form with more than one field, this returns true.
+    # Forms with one field are typically search boxes.
+    #
+    # Boolean, returns true if form is present on page.
+    def contactform_available?
+      !!(page.forms.select {|x| x.fields.length > 1}.empty? != true)
+    end
+    
+    ## ----------------------------------------------------------------
+    # Actions 
+    #
+    #
+    #
+
+    # The main method!
+    # Takes array of urls and gets contact info for each if possible.
+    def poc(arr)
+      arr = arr.split unless arr.is_a?(Array)
+      arr.each do |url|
+        get(url)
+        start_contact_links
+        go_to_contact_page
+        save_available_contacts
+      end
+      puts "\nexited each url iteration and about to return final result"
+      puts 'press RETURN'
+      gets
+      p @contacts_links # need to add to an overall array at some point.
+    end
+    
+    # Go to a page using Mechanize.  Doing this reinitializes the hash.
+    def get(url)
+      puts "getting: #{url}"
+      @page = Mechanize.new.get(url)
+    end
+    
+    # Starts/Restarts @contacts_links hash
+    def start_contact_links
+      puts "starting contact links hash."
+      @contact_links = {}
+    end
+    
+    # Scans for contact page.  If it doesn't work on the first try, 
+    # It will look for english versions and try again.
+    #
+    # If contact page is found, go directly there and don't try again.
+    def go_to_contact_page
+      1.times do
+        if contact_link?
+          puts "found contact link!".green
+          get(@url)
+        elsif contact_page?
+          puts "found contact page!".green
+          get(@url)
+        elsif english_link? # look for link first
+          puts "found english link!"
+          get(@url); redo
+        elsif en_page?
+          puts "found en page!"
+          get(@url); redo
+        elsif english_page?
+          puts "found english page!"
+          get(@url); redo
+        end
+      end
+    end
+
+    # Expects relative paths and merges everything. 
+    # Returns a string.  If there's nothing, return nil.
+    def link_with_href(str)
+      page.uri.merge(page.link_with(href: /#{str}/).uri.to_s).to_s rescue nil
+    end    
+
+    # Returns anything that is possible to save, otherwise returns nil.
+    # Booleans for phone, email, or contact form will display True or False.
+    def scan_for_contacts
+      {
+        contactpage: link_with_href('contact'),
+        email_present?: "#{email_available?}",
+        phone_present?: "#{phone_available?}",
+        contact_form?: "#{contactform_available?}",
+        facebook: link_with_href('facebook'),
+        twitter: link_with_href('twitter'),
+        youtube: link_with_href('youtube'),
+        googleplus: link_with_href('plus.google'),
+        linkedin: link_with_href('linkedin')
+      }
+    end
+
+    # Used in save_available_contacts to save each valid link.
+    def save_link(key, url)
+      return if key.nil? || url.nil?
+      @contact_links[key] = url
+    end
+    
+    # Remove negatives from the contacts hash.
+    # Deletes a key value pair with a value of either nil or false.
+    # Remember that false is a string.
+    def delete_failures(hsh)
+      hsh.delete_if {|k, v| v == nil || v == 'false'}
+    end
+
+    # Saves any available contact info to @contact_links.
+    def save_available_contacts(hsh = scan_for_contacts)
+      puts 'starting save of available contact information...'
+      return unless something_to_save?
+      if hsh.is_a?(Hash)
+        hsh.each do |k, v|
+          save_link(k, v)
+        end
+        delete_failures(hsh)
+        puts "this is hsh after nil strip:"
+        puts "#{hsh}".cyan
+      else  
+        raise ArgumentError, "expected hash but got #{hsh.class}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: gimme_poc
+version: !ruby/object:Gem::Version
+  version: 0.0.0.beta
+platform: ruby
+authors:
+- John Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: Gimme POC (Point of Contact) simplifies the process of extracting the
+  common 'contact us' information from a website.
+email: mace2345@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/gimme_poc.rb
+- lib/gimme_poc/version.rb
+homepage: http://github.com/m8ss/gimme_poc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Get a point of contact.  Given a url or array of urls, extracts social media
+  contact information.
+test_files: []