crm_formatter 1.0.2.pre.rc.1 → 1.0.3.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55c0492c70468ec89ff37f86a327588798fe2571fae14ab79d7a1dce6ce5e931
-  data.tar.gz: 55afae0d73b89304f0d3fbdec2a91e7d4f77c9d5d8f40a06195d9754095a1ee3
+  metadata.gz: 84e611755e48ace0e3749f41cd7a593d01de04cbaeac00223e0b1f6b7a3479d8
+  data.tar.gz: 7168462838bcd31e7390e6c4563236916a9b68210218934fb5d554fbdbbcf001
 SHA512:
-  metadata.gz: bc389bc3248c9b32b464378ed71258325a2c27b43b933101dec41cf1aa8b450b3f7ce3d5fe47405c77f41bff32ade3a107668ac528500d28a797bc0fba2ae481
-  data.tar.gz: 8c0046fc1da44ccdc9812242c023e232b55e0ad11ca0da804c044f358e5eb65afc0d25ab95161f1a7347f41efb9fa3759b6cfe12bc04e16d9145df494bf8da19
+  metadata.gz: 2dc917206f92120f86a88e0842c95e6b5e276e8f19ff964f3f0722234719745c2cab67e2f5e47f11c75e120e75fdd298897d5f15808969f412a07f798f545a6c
+  data.tar.gz: '09dc46e716020aaa772c50febc0908823920721aacb252b5a5ef779f681293ecb54812ae2bdb9910e01b8d66528026395a7272bca067d6de9ab676309eda0093'

data/crm_formatter.gemspec

@@ -17,17 +17,11 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # spec.add_development_dependency "activerecord", "~> 4.0"
-  # spec.add_development_dependency "sqlite3", "~> 1.3", ">= 1.3.13"
-  # spec.add_development_dependency "railties", ">= 4.2.0", "< 5.1"
-  # spec.add_development_dependency "bundler", "~> 1.13"
-  # spec.add_development_dependency "rake", "~> 10.0"
-  # spec.add_development_dependency "rspec", "~> 3.0"
-  # spec.add_development_dependency "pry", "~> 0.10.4"
-
-  # spec.add_runtime_dependency "logging"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  
 end

data/lib/crm_formatter.rb

@@ -1,8 +1,9 @@
-class CRMFormatter
-  def self.hi(language)
-    translator = Translator.new(language)
-    translator.hi
-  end
-end
+require 'crm_formatter/address'
+require 'crm_formatter/web'
+require 'crm_formatter/phone'
+require 'crm_formatter/helpers'
+require 'crm_formatter/version'
+
+module CRMFormatter
 
-require 'crm_formatter/translator'
+end

data/lib/crm_formatter/address.rb

@@ -0,0 +1,174 @@
+module CRMFormatter
+  class Address
+
+    def format_full_address(adr = {})
+      formatted = {
+        street: format_street(adr[:street]),
+        city: format_city(adr[:city]),
+        state: format_state(adr[:state]),
+        zip: format_zip(adr[:zip])
+      }
+
+      formatted[:full_address] = get_full_address(formatted)
+      formatted[:changed] = compare_versions(adr, formatted)
+      formatted
+    end
+
+
+    ####### COMPARE ORIGINAL AND FORMATTED ADR ######
+    def compare_versions(original, formatted)
+      original = get_full_address(original)
+      formatted = formatted[:full_address]
+      original != formatted
+    end
+
+
+    ######### FORMAT FULL ADDRESS ##########
+
+    def get_full_address(hsh)
+      full_address = [hsh[:street], hsh[:city], hsh[:state], hsh[:zip]].compact.join(', ')
+    end
+
+    ######### FORMAT STREET ##########
+
+    # CALL: Formatter.new.format_street(street)
+    def format_street(street)
+      street = street&.gsub(/\s/, ' ')&.strip
+      if street.present?
+
+        if street.present?
+          # street = Formatter.new.letter_case_check(street)
+          street = CRMFormatter::Helpers.letter_case_check(street)
+          street = " #{street} " # Adds white space, to match below, then strip.
+          street&.gsub!(".", " ")
+          street&.gsub!(",", " ")
+
+          street&.gsub!(" North ", " N ")
+          street&.gsub!(" South ", " S ")
+          street&.gsub!(" East ", " E ")
+          street&.gsub!(" West ", " W ")
+          street&.gsub!(" Ne ", " NE ")
+          street&.gsub!(" Nw ", " NW ")
+          street&.gsub!(" Se ", " SE ")
+          street&.gsub!(" Sw ", " SW ")
+
+          street&.gsub!("Avenue", "Ave")
+          street&.gsub!("Boulevard", "Blvd")
+          street&.gsub!("Drive", "Dr")
+          street&.gsub!("Expressway", "Expy")
+          street&.gsub!("Freeway", "Fwy")
+          street&.gsub!("Highway", "Hwy")
+          street&.gsub!("Lane", "Ln")
+          street&.gsub!("Parkway", "Pkwy")
+          street&.gsub!("Road", "Rd")
+          street&.gsub!("Route", "Rte")
+          street&.gsub!("Street", "St")
+          street&.gsub!("Terrace", "Ter")
+          street&.gsub!("Trail", "Trl")
+          street&.gsub!("Turnpike", "Tpke")
+          street&.gsub!("|", " ")
+          street&.gsub!("•", " ")
+          street&.gsub!("Welcome to", " ")
+          street&.gsub!("var address = \"", " ")
+
+          street&.strip!
+          street&.squeeze!(" ")
+        end
+      end
+      return street
+    end
+
+    ########## FORMAT CITY ###########
+
+    def format_city(city)
+      city = city&.gsub(/\s/, ' ')&.strip
+      city = nil if city&.scan(/[0-9]/)&.any?
+      city = nil if city&.downcase&.include?('category')
+      city = nil if city&.downcase&.include?('model')
+      city = nil if city&.downcase&.include?('make')
+      city = nil if city&.downcase&.include?('inventory')
+      city = nil if city&.downcase&.include?('tracker')
+      city = nil if city&.downcase&.include?('push')
+      city = nil if city&.downcase&.include?("(")
+      city = nil if city&.downcase&.include?(")")
+      city = nil if city&.downcase&.include?("[")
+      city = nil if city&.downcase&.include?("]")
+      city&.gsub!("|", " ")
+      city&.gsub!("•", " ")
+
+      if city.present?
+        street_types = %w(avenue boulevard drive expressway freeway highway lane parkway road route street terrace trail turnpike)
+        invalid_city = street_types.find { |street_type| city.downcase.include?(street_type) }
+        city = nil if invalid_city.present?
+
+        if city.present?
+          st_types = %w(ave blvd dr expy fwy hwy ln pkwy rd rte st ter trl tpke)
+          city_parts = city.split(' ')
+
+          invalid_city = city_parts.select do |city_part|
+            st_types.find { |st_type| city_part.downcase == st_type }
+          end
+
+          city = nil if invalid_city.present?
+          city = nil if city&.downcase&.include?("/")
+          city = nil if city&.downcase&.include?("www")
+          city = nil if city&.downcase&.include?("*")
+          city = nil if city&.downcase&.include?("number")
+          city = nil if city&.downcase&.include?("stock")
+          city = nil if city&.downcase&.include?(":")
+          city = nil if city&.downcase&.include?("ID")
+
+          city&.strip!
+          city&.squeeze!(" ")
+          city = nil if city.present? && city.length > 50
+          city = nil if city.present? && city.length < 4
+        end
+      end
+      city = city&.split(' ')&.map(&:capitalize).join(' ')
+      return city
+    end
+
+    ########## FORMAT STATE ##########
+
+    def format_state(state)
+      state = state&.gsub(/\s/, ' ')&.strip
+
+      if state.present?
+        states_hsh = { 'Alabama'=>'AL', 'Alaska'=>'AK', 'Arizona'=>'AZ', 'Arkansas'=>'AR', 'California'=>'CA', 'Colorado'=>'CO', 'Connecticut'=>'CT', 'Delaware'=>'DE', 'Florida'=>'FL', 'Georgia'=>'GA', 'Hawaii'=>'HI', 'Idaho'=>'ID', 'Illinois'=>'IL', 'Indiana'=>'IN', 'Iowa'=>'IA', 'Kansas'=>'KS', 'Kentucky'=>'KY', 'Louisiana'=>'LA', 'Maine'=>'ME', 'Maryland'=>'MD', 'Massachusetts'=>'MA', 'Michigan'=>'MI', 'Minnesota'=>'MN', 'Mississippi'=>'MS', 'Missouri'=>'MO', 'Montana'=>'MT', 'Nebraska'=>'NE', 'Nevada'=>'NV', 'New Hampshire'=>'NH', 'New Jersey'=>'NJ', 'New Mexico'=>'NM', 'New York'=>'NY', 'North Carolina'=>'NC', 'North Dakota'=>'ND', 'Ohio'=>'OH', 'Oklahoma'=>'OK', 'Oregon'=>'OR', 'Pennsylvania'=>'PA', 'Rhode Island'=>'RI', 'South Carolina'=>'SC', 'South Dakota'=>'SD', 'Tennessee'=>'TN', 'Texas'=>'TX', 'Utah'=>'UT', 'Vermont'=>'VT', 'Virginia'=>'VA', 'Washington'=>'WA', 'West Virginia'=>'WV', 'Wisconsin'=>'WI', 'Wyoming'=>'WY' }
+
+        state = state.tr('^A-Za-z', '')
+        if state.present? && state.length < 2
+          state = nil
+        elsif state.present? && state.length > 2
+          state = state.capitalize
+          states_hsh.map { |k,v| state = v if state == k }
+        end
+
+        if state.present?
+          state.upcase!
+          valid_state = states_hsh.find { |k,v| state == v }
+          state_code = valid_state&.last
+          return state_code
+        end
+      end
+    end
+
+
+    ########### FORMAT ZIP ###########
+
+    #CALL: Formatter.new.format_zip(zip)
+    def format_zip(zip)
+      zip = nil if !zip.scan(/[0-9]/).length.in?([4,5,8,9])
+      zip = zip&.gsub(/\s/, ' ')&.strip
+      zip = zip&.split('-')&.first
+      zip = nil if zip&.scan(/[A-Za-z]/)&.any?
+      (zip = "0#{zip}" if zip.length == 4) if zip.present?
+      (zip = nil if zip.length != 5) if zip.present?
+      zip&.strip!
+      zip&.squeeze!(" ")
+      return zip
+    end
+
+
+  end
+end

data/lib/crm_formatter/helpers.rb

@@ -0,0 +1,23 @@
+module CRMFormatter
+  module Helpers
+
+    #CALL: Formatter.new.letter_case_check(street)
+    def self.letter_case_check(str)
+      if str.present?
+        flashes = str&.gsub(/[^ A-Za-z]/, '')&.strip&.split(' ')
+        flash = flashes&.reject {|e| e.length < 3 }.join(' ')
+
+        if flash.present?
+          has_caps = flash.scan(/[A-Z]/).any?
+          has_lows = flash.scan(/[a-z]/).any?
+          if !has_caps || !has_lows
+            str = str.split(' ')&.each { |el| el.capitalize! if el.gsub(/[^ A-Za-z]/, '')&.strip&.length > 2 }&.join(' ')
+          end
+        end
+        return str
+      end
+    end
+
+
+  end
+end

data/lib/crm_formatter/phone.rb

@@ -0,0 +1,38 @@
+module CRMFormatter
+  class Phone
+
+    ## Checks every phone number in table to verify that it meets phone criteria, then calls format_phone method to format Valid results.  Otherwise destroys Invalid phone fields and associations.
+
+    # Call: Formatter.new.validate_phone(phone)
+    def validate_phone(phone)
+      phone_hsh = { phone: phone, valid_phone: nil, change: nil }
+      if phone.present?
+        phone = phone&.gsub(/\s/, ' ')&.strip
+        reg = Regexp.new("[(]?[0-9]{3}[ ]?[)-.]?[ ]?[0-9]{3}[ ]?[-. ][ ]?[0-9]{4}")
+        return phone_hsh if phone.first == "0" || phone.include?("(0") || !reg.match(phone)
+        phone_hsh[:valid_phone] = format_phone(phone)
+        phone_hsh[:change] = phone_hsh[:phone] != phone_hsh[:valid_phone]
+      end
+      phone_hsh
+    end
+
+    #################################
+    ## FORMATS PHONE AS: (000) 000-0000
+    ## Assumes phone is legitimate, then formats.  Not designed to detect Valid phone number.
+
+    # Call: Formatter.new.format_phone(phone)
+    def format_phone(phone)
+      regex = Regexp.new("[A-Z]+[a-z]+")
+      if !phone.blank? && (phone != "N/A" || phone != "0") && !regex.match(phone)
+        phone_stripped = phone.gsub(/[^0-9]/, "")
+        (phone_stripped && phone_stripped[0] == "1") ? phone_step2 = phone_stripped[1..-1] : phone_step2 = phone_stripped
+
+        final_phone = !(phone_step2 && phone_step2.length < 10) ? "(#{phone_step2[0..2]}) #{(phone_step2[3..5])}-#{(phone_step2[6..9])}" : phone
+      else
+        final_phone = nil
+      end
+      return final_phone
+    end
+
+  end
+end

data/lib/crm_formatter/version.rb

@@ -1,3 +1,3 @@
 module CRMFormatter
-  VERSION = "1.0.2-rc.1"
+  VERSION = "1.0.3-rc.1"
 end

data/lib/crm_formatter/web.rb

@@ -0,0 +1,168 @@
+module CRMFormatter
+  class Web
+
+      def initialize(args={})
+        @url_red_flags = args.fetch(:url_red_flags, [])
+        @link_red_flags = args.fetch(:link_red_flags, [])
+        @href_red_flags = args.fetch(:href_red_flags, [])
+        @ext_red_flags = args.fetch(:ext_red_flags, [])
+        @length_min = args.fetch(:length_min, 2)
+        @length_max = args.fetch(:length_max, 100)
+      end
+
+      def format_url(url)
+        url_hsh = {full_url: url, valid_url: nil, change: nil }
+        if url.present?
+          begin
+            url = url&.split('|')&.first
+            url = url&.split('\\')&.first
+            url&.gsub!(/\P{ASCII}/, '')
+            url = url&.downcase&.strip
+            return url_hsh if url&.length < @length_min
+
+            2.times { remove_ww3(url) } if url.present?
+            url = remove_slashes(url) if url.present?
+            url&.strip!
+
+            return url_hsh if !url.present? || url&.include?(' ')
+            url = url[0..-2] if url[-1] == '/'
+
+            symbs = ['(', ')', '[', ']', '{', '}', '*', '@', '^', '$', '+', '!', '<', '>', '~', ',', "'"]
+            return url_hsh if symbs.any? {|symb| url&.include?(symb) }
+
+            uri = URI(url)
+            if uri.present?
+              host_parts = uri.host&.split(".")
+
+              if @ext_red_flags.any?
+                bad_host_sts = host_parts&.map { |part| TRUE if @ext_red_flags.any? {|ext| part == ext } }&.compact&.first
+                return url_hsh if bad_host_sts
+              end
+
+              host = uri.host
+              scheme = uri.scheme
+              url = "#{scheme}://#{host}" if host.present? && scheme.present?
+              url = "http://#{url}" if url[0..3] != "http"
+              url = url.gsub("//", "//www.") if !url.include?("www.")
+              return url_hsh if @url_red_flags.any? { |bad_text| url&.include?(bad_text) }
+              url_hsh[:valid_url] = convert_to_scheme_host(url) if url.present?
+              url_hsh[:change] = url_hsh[:valid_url] != url_hsh[:full_url]
+            end
+          rescue
+            return url_hsh
+          end
+        end
+        url_hsh
+      end
+
+
+      ###### Supporting Methods Below #######
+
+      #CALL: Formatter.new.remove_ww3(url)
+      def remove_ww3(url)
+        if url.present?
+          url.split('.').map { |part| url.gsub!(part,'www') if part.scan(/ww[0-9]/).any? }
+          url&.gsub!("www.www", "www")
+        end
+      end
+
+
+      # For rare cases w/ urls with mistaken double slash twice.
+      def remove_slashes(url)
+        if url.present? && url.include?('//')
+          parts = url.split('//')
+          return parts[0..1].join if parts.length > 2
+        end
+        return url
+      end
+
+
+      def extract_link(full_url)
+        url_hsh = format_url(full_url)
+        url = url_hsh[:valid_url]
+        link = full_url
+        link_hsh = {full_url: full_url, url: url, link: nil }
+        if url.present? && link.present? && link.length > @length_min
+          url = strip_down_url(url)
+          link = strip_down_url(link)
+          link&.gsub!(url, '')
+          link = link&.split('.net')&.last
+          link = link&.split('.com')&.last
+          link = link&.split('.org')&.last
+          link = "/#{link.split("/").reject(&:empty?).join("/")}" if link.present?
+          link_hsh[:link] = link if link.present? && link.length > @length_min
+        end
+        link_hsh
+      end
+
+
+      def strip_down_url(url)
+        if url.present?
+          url = url.downcase.strip
+          url = url.gsub('www.', '')
+          url = url.split('://')
+          url = url[-1]
+          return url
+        end
+      end
+
+
+      def remove_invalid_links(link)
+        link_hsh = {link: link, valid_link: nil, flags: nil }
+        if link.present?
+          invalid_chars = ['(', ')', '[', ']', '{', '}', '*', '@', '^', '$', '%', '+', '!', '<', '>', '~', ',', "'"]
+          @link_red_flags += invalid_chars
+          flags = @link_red_flags.select { |red| link&.include?(red) }
+          flags << "below #{@length_min}" if link.length < @length_min
+          flags << "over #{@length_max}" if link.length > @length_max
+          flags = flags.flatten.compact
+          flags.any? ? valid_link = nil : valid_link = link
+          link_hsh[:valid_link] = valid_link
+          link_hsh[:flags] = flags.join(', ')
+        end
+        link_hsh
+      end
+
+
+      def remove_invalid_hrefs(href)
+        href_hsh = {href: href, valid_href: nil, flags: nil }
+        if href.present?
+          symbs = ['{', '}', '*', '@', '^', '$', '%', '+', '!', '<', '>', '~']
+          @href_red_flags += symbs
+          href = href.split('|').join(' ')
+          href = href.split('/').join(' ')
+          href&.gsub!("(", ' ')
+          href&.gsub!(")", ' ')
+          href&.gsub!("[", ' ')
+          href&.gsub!("]", ' ')
+          href&.gsub!(",", ' ')
+          href&.gsub!("'", ' ')
+
+          flags = []
+          flags << "over #{@length_max}" if href.length > @length_max
+          invalid_text = Regexp.new(/[0-9]/)
+          flags << invalid_text&.match(href)
+          href = href&.downcase
+          href = href&.strip
+
+          flags << @href_red_flags.select { |red| href&.include?(red) }
+          flags = flags.flatten.compact.uniq
+          href_hsh[:valid_href] = href unless flags.any?
+          href_hsh[:flags] = flags.join(', ')
+        end
+        href_hsh
+      end
+
+
+      def convert_to_scheme_host(url)
+        if url.present?
+          uri = URI(url)
+          scheme = uri&.scheme
+          host = uri&.host
+          url = "#{scheme}://#{host}" if (scheme.present? && host.present?)
+          return url
+        end
+      end
+
+  end
+end

data/menu.rb

@@ -0,0 +1,8 @@
+require_relative "lib/crm_formatter/address.rb"
+
+address = CRMFormatter::Address.new
+
+system "clear"
+puts "Welcome!"
+
+puts address.state

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: crm_formatter
 version: !ruby/object:Gem::Version
-  version: 1.0.2.pre.rc.1
+  version: 1.0.3.pre.rc.1
 platform: ruby
 authors:
 - Adam Booth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
-dependencies: []
+date: 2018-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 description: Formats addresses, phones, emails, urls
 email:
 - 4rlm@protonmail.ch
@@ -21,9 +35,12 @@ files:
 - bin/crm_formatter
 - crm_formatter.gemspec
 - lib/crm_formatter.rb
-- lib/crm_formatter/translator.rb
+- lib/crm_formatter/address.rb
+- lib/crm_formatter/helpers.rb
+- lib/crm_formatter/phone.rb
 - lib/crm_formatter/version.rb
-- x_crm_formatter.gemspec
+- lib/crm_formatter/web.rb
+- menu.rb
 homepage: https://github.com/4rlm/crm_formatter
 licenses:
 - MIT

data/lib/crm_formatter/translator.rb

@@ -1,16 +0,0 @@
-class CRMFormatter::Translator
-  def initialize(language = "english")
-    @language = language
-  end
-
-  def hi
-    case @language
-    when "spanish"
-      "crm_formatter mundo"
-    when "korean"
-      "anyoung ha se yo"
-    else
-      "hello world"
-    end
-  end
-end

data/x_crm_formatter.gemspec

@@ -1,26 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name               = "crm_formatter"
-  spec.version            = "0.0.1"
-  spec.default_executable = "crm_formatter"
-  spec.license       = "MIT"
-  spec.required_rubygems_version = Gem::Requirement.new(">= 0") if spec.respond_to? :required_rubygems_version=
-  spec.authors = ["Adam Booth"]
-  spec.date = %q{2018-05-12}
-  spec.description = %q{Formats addresses, phones, emails, urls}
-  spec.email = %q{4rlm@protonmail.ch}
-  spec.files = ["Rakefile", "lib/crm_formatter.rb", "lib/crm_formatter/translator.rb", "bin/crm_formatter"]
-  spec.test_files = ["test/test_crm_formatter.rb"]
-  spec.homepage = %q{http://rubygems.org/gems/crm_formatter}
-  spec.require_paths = ["lib"]
-  spec.rubygems_version = %q{1.6.2}
-  spec.summary = %q{crm_formatter!}
-
-  if spec.respond_to? :specification_version then
-    spec.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end