melissa_data 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7df9036e13bad6f7ad7be72f4e193d4291f56515
-  data.tar.gz: bf141f17f01d0db9892c68cd4f348e7556e43a06
+  metadata.gz: ac91c5646b2bec4d4c6c267d8285e32131cf5109
+  data.tar.gz: 6d83ffef11d3f0bc8c94eecb4b78043787a10265
 SHA512:
-  metadata.gz: fbc7ef193d5d1498bf69bd97fb02e9096dcd83c1ad1fc0ad487b018dc3bed3b5edd6fe53f892b8f60ed2e39207c86b7763bcc1048f0e6f34a72210ad441b3768
-  data.tar.gz: f69ffcd5a483310bbb8a03027b71bf064fa5dfa4c3d4922b16c7a799f15d8efb77bef853b6c79e5c0bea86c3d3469567aa52bd98c06e5cf41871df9ff5e4e835
+  metadata.gz: df18e37db9072c6ddf9644e96222b31247615af5609ecd0a0198fddb0f9dcd19feb9bb110b35592efe7700fbc5799cbd26b0d797f0ee06daa29669aa99c4271f
+  data.tar.gz: 118eb045520fe3c3362384c6fdb6f9daf66f6e2964e6fbbde7643cdd84ed7b499ff25bdcc1a8e6e933d731f4e14b0c8aabd5999b346ee3284b12d9bb7e04c0e0

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.swp

data/README.md

@@ -1,6 +1,7 @@
 # Melissa Data
 
 [![Build Status](https://travis-ci.org/cometaworks/melissa_data.svg)](https://travis-ci.org/cometaworks/melissa_data)
+[![Code Climate](https://codeclimate.com/github/cometaworks/melissa_data/badges/gpa.svg)](https://codeclimate.com/github/cometaworks/melissa_data)
 
 ## Installation
 

data/config/address_error_codes.yml

@@ -0,0 +1,16 @@
+"address_error_codes":
+    "AE01": "Zip/Postal code does not exist or is improperly formatted."
+    "AE02": "Unknown Street. Either no match or too many."
+    "AE03": "Component mismatch. Combination of directions + suffix incorrect."
+    "AE04": "Undeliverable address. Plot exists but is not deliverable."
+    "AE05": "Multiple match. This adderss matched too many records to return a result"
+    "AE06": "Early Warning System. This address vant be verified but may be on a new road"
+    "AE07": "Missing minimum address. Must have atleast a1, postal code, and locality"
+    "AE08": "Subpremise number invalid. Suite missing"
+    "AE09": "Subpremise number missing."
+    "AE10": "Premise number invalid"
+    "AE11": "Premise number missing"
+    "AE12": "PO Box number invalid"
+    "AE13": "PO Box number missing"
+    "AE14": "Private mailbox number missing"
+    "AE17": "Sub premise number entered but premise has none"

data/config/address_success_codes.yml

@@ -0,0 +1,13 @@
+"address_success_codes":
+   "AS01": "Address is valid and deliverable per postal agency guidelines."
+   "AS02": "Street address verified but suite number not valid or missing."
+   "AS03": "Non-USPS match, exists but may not receive mail."
+   "AS09": "Address is in foreign country."
+   "AS10": "Address is commercial mail receiving agency (PO box, mailbox)."
+   "AS13": "Rural address converted to city-style address."
+   "AS14": "Suite appended. A suite was appended using the address."
+   "AS15": "Apartment appended. An apartment was appended."
+   "AS16": "Vacant. Address unoccupied > 90 days."
+   "AS17": "No mail delivery to address."
+   "AS20": "Deliverable to only via USPS."
+   "AS23": "Unnecessary extraneous information received and discarded."

data/config/error_codes.yml

@@ -0,0 +1,22 @@
+"property_error_codes":
+    "YS04": "Detailed information returned"
+    "YE01": "No FIPS/APN or AddressKey provided"
+    "YE02": "No match found"
+    "YE03": "Invalid FIPS/APN or AddressKey provided"
+
+"address_error_codes":
+    "AE01": "Zip/Postal code does not exist or is improperly formatted."
+    "AE02": "Unknown Street. Either no match or too many."
+    "AE03": "Component mismatch. Combination of directions + suffix incorrect."
+    "AE04": "Undeliverable address. Plot exists but is not deliverable."
+    "AE05": "Multiple match. This adderss matched too many records to return a result"
+    "AE06": "Early Warning System. This address vant be verified but may be on a new road"
+    "AE07": "Missing minimum address. Must have atleast a1, postal code, and locality"
+    "AE08": "Subpremise number invalid. Suite missing"
+    "AE09": "Subpremise number missing."
+    "AE10": "Premise number invalid"
+    "AE11": "Premise number missing"
+    "AE12": "PO Box number invalid"
+    "AE13": "PO Box number missing"
+    "AE14": "Private mailbox number missing"
+    "AE17": "Sub premise number entered but premise has none"

data/config/property_error_codes.yml

@@ -0,0 +1,5 @@
+"property_error_codes":
+    "YS04": "Detailed information returned"
+    "YE01": "No FIPS/APN or AddressKey provided"
+    "YE02": "No match found"
+    "YE03": "Invalid FIPS/APN or AddressKey provided"

data/config/property_success_codes.yml

@@ -0,0 +1,4 @@
+"property_success_codes":
+    "YS01": "FIPS/APN Match found"
+    "YS02": "AddressKey Match found"
+    "YS03": "Basic information returned"

data/lib/melissa_data/version.rb

@@ -1,3 +1,3 @@
 module MelissaData
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/melissa_data/web_smart/client.rb

@@ -2,22 +2,27 @@ module MelissaData
   module WebSmart
     class Client
       include MelissaData::WebSmart::ResponseProcessor
+      include MelissaData::WebSmart::Formatters
 
       def initialize
         @client = MelissaData::WebSmart::PropertyAPI.new
       end
 
       def property_by_apn(fips:, apn:)
-        process_property(@client.property_by_apn(fips: fips, apn: apn))
+        process(@client.property_by_apn(fips: fips, apn: apn), 'property')
       end
 
       def property_by_address_key(address_key:)
-        process_property(@client.property_by_address_key(address_key: address_key))
+        process(@client.property_by_address_key(address_key: address_key), 'property')
       end
 
       def address(address:, city:, state:, zip:, country: "USA")
-        @client.address(address: address, city: city, state: state,
-                        zip: zip, country: country)
+        resp = viperize_hash(@client.address(address: address,
+                                             city: city,
+                                             state: state,
+                                             zip: zip,
+                                             country: country))
+        process(resp, 'address')
       end
     end
   end

data/lib/melissa_data/web_smart/property_api.rb

@@ -1,5 +1,6 @@
 require 'rest-client'
 require 'nokogiri'
+require 'json'
 
 module MelissaData
   module WebSmart
@@ -8,26 +9,32 @@ module MelissaData
         resp = RestClient.get('https://property.melissadata.net/v3/REST/Service.svc/doLookup',
                              { params: { id: MelissaData.web_smart_id,
                                          fips: fips,
-                                         apn: apn } })
+                                         apn: apn,
+                                         OptPropertyDetail: "1" } })
         PropertyXMLParser.new(Nokogiri::XML(resp)).parse
       end
 
       def property_by_address_key(address_key:)
         resp = RestClient.get('https://property.melissadata.net/v3/REST/Service.svc/doLookup',
                              { params: { id: MelissaData.web_smart_id,
-                                         AddressKey: address_key } })
+                                         AddressKey: address_key,
+                                         OptPropertyDetail: "1" } })
         PropertyXMLParser.new(Nokogiri::XML(resp)).parse
       end
 
       def address(address:, city:, state:, zip:, country:)
-        resp = RestClient.get('https://address.melissadata.net/v3/WEB/GlobalAddress/doGlobalAddress',
-                             { params: { id: MelissaData.web_smart_id,
-                                         a1: address,
-                                         loc: city,
-                                         admarea: state,
-                                         postal: zip,
-                                         ctry: country} })
-        AddressXMLParser.new(Nokogiri::XML(resp)).parse
+        resp = JSON.parse(RestClient.get("https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify",
+                                         { params: { id: MelissaData.web_smart_id,
+                                                     Actions: "Check",
+                                                     a1: address,
+                                                     city: city,
+                                                     state: state,
+                                                     postal: zip,
+                                                     ctry: country,
+                                                     AdvancedAddressCorrection: "on",},
+                                           accept: :json,
+                                           content_type: :json }))
+        resp["Records"].first
       end
     end
   end

data/lib/melissa_data/web_smart/response_processor.rb

@@ -1,39 +1,40 @@
 module MelissaData
   module WebSmart
     module ResponseProcessor
-      def process_property(response)
-        codes = codes(response)
+      require 'yaml'
+      CODE_TYPES = [:property, :address]
 
+      def process(response, resp_type)
+        codes = codes(response, resp_type)
         if has_error_codes?(codes)
-          { errors: codes_for(codes, 'error') }
+          { errors: codes_for(codes, resp_type, 'error') }
         else
-          response.merge!(success: codes_for(codes, 'success'))
+          response.merge!(success: codes_for(codes, resp_type, 'success'))
         end
       end
 
-      def codes_for(codes, type)
-        codes.map { |c| method("property_#{type}_codes").call[c.to_sym] }.compact
+      def codes_for(codes, resp_type, code_type)
+        codes.map do |code|
+          YAML.load(File.read("config/#{resp_type}_#{code_type}_codes.yml")).values.first[code.to_s]
+        end.compact
       end
 
-      def codes(response)
-        response[:result][:code].split(",")
+      def codes(response, resp_type)
+        case resp_type
+        when 'property'
+          response[:result][:code].split(",")
+        when 'address'
+          response[:results].split(",")
+        end
       end
 
       def has_error_codes?(codes)
-        !codes.select { |c| c if property_error_codes.keys.include? c.to_sym }.empty?
-      end
-
-      def property_success_codes
-        { YS01: "FIPS/APN Match found",
-          YS02: "AddressKey Match found",
-          YS03: "Basic information returned",
-          YS04: "Detailed information returned" }
+        !codes.select { |code| error_codes.include? code.to_sym }.empty?
       end
 
-       def property_error_codes
-         { YE01: "No FIPS/APN or AddressKey provided",
-           YE02: "No match found",
-           YE03: "Invalid FIPS/APN or AddressKey provided" }
+      def error_codes
+        error_code_strings = CODE_TYPES.map { |t| File.read("config/#{t}_error_codes.yml") }
+        error_code_strings.map { |c| YAML.load(c) }.flat_map { |code| code.values.first.keys.map(&:to_sym) }
       end
     end
   end

data/lib/melissa_data/web_smart/xml.rb

@@ -1,16 +1,6 @@
 module MelissaData
   module WebSmart
-    class XMLParser
-      attr_accessor :xml_document
-
-      def initialize(xml)
-        @xml_document = xml
-      end
-
-      def children?(xml_node)
-        xml_node.children.empty?
-      end
-
+    module Formatters
       def viperize_hash hash
         hash.map { |key, value| { viperize(key.to_s) => value } }.reduce(:merge)
       end
@@ -26,27 +16,22 @@ module MelissaData
       end
     end
 
-    class AddressXMLParser < XMLParser
-      def parse
-        viperize_hash(Hash[retrieved_fields.zip(field_details)])
-      end
+    class XMLParser
+      include MelissaData::WebSmart::Formatters
+      attr_accessor :xml_document
 
-      def field_details
-        xml_children.first.children.last.children.first.children
-        .map(&:children)
-        .map(&:text)
+      def initialize(xml)
+        @xml_document = xml
       end
 
-      def retrieved_fields
-        xml_children.first.children.last.children.first.children.map(&:name)
+      def children?(xml_node)
+        xml_node.children.empty?
       end
 
-      def xml_children
-        xml_document.children
-      end
     end
 
     class PropertyXMLParser < XMLParser
+      include MelissaData::WebSmart::Formatters
       def parse
         parsed_hash = {}
         if expected_retrieved?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: melissa_data
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Robert Grayson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -128,6 +128,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/address_error_codes.yml
+- config/address_success_codes.yml
+- config/error_codes.yml
+- config/property_error_codes.yml
+- config/property_success_codes.yml
 - lib/melissa_data.rb
 - lib/melissa_data/config.rb
 - lib/melissa_data/version.rb