melissa_data 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8040dba4069d61c3b05133f053973d0a23b794a9
-  data.tar.gz: 2acf1ec4b535a7fd34c79c0682c3e97017e894f8
+  metadata.gz: 815c3aab597d59d45f0d2b5b6e1090240ca7906c
+  data.tar.gz: 7e250c2c21c8a04507da1572411cc39fceb450b5
 SHA512:
-  metadata.gz: 66df5eb47e0c23353abb4b6480fab7011da4b389e43af0f274ebc348b3169349efd9e482256d1894387b783447a00bbf13dec472469f7a28936192fc18271b22
-  data.tar.gz: 8cb3a6a4b1ce6e9002ed3cab0c02d9709b5ccbaf5f2efc1ebc9c1a8a35b5dc2c0666d49fd06ddf16d363fde88c72a75f59b7916955e07f4283a5816fa6d1c95b
+  metadata.gz: 597980ef52b375f86ba4fc63890a6bd27435485a325dde170fd4610d682d23c65870e21b9cbb9f791b736242dd199f3a4f8ab3faf19cabc4e4bf8c43acb09839
+  data.tar.gz: bd0b48b5c3b9750628466aa3e1391716ec7080781e3c1a4af0f1778727a9a0cf306fb9563ffe3983a916eee192a37d4841250b69a5d4cd0992ce2d0df31a4156

data/README.md

@@ -22,12 +22,13 @@ Or install it yourself as:
 
 #### Property
 There is a client included for the property API on Melissa. This requires very little.
-You will need two environment variables: `MELISSA_DATA_WEB_SMART_ID`, and `MELISSA_DATA_PROPERTY_API_URL`
+You will need a `MelissaData Web Smart ID`.
 Once you have these, you may use the following client. To instantiate a client:
 
 ```ruby
+irb> MelissaData.web_smart_id = ENV['MELISSA_DATA_WEB_SMART_ID']
 irb> client = MelissaData::WebSmart::Client.new
-irb> client.property(some_fips_code, some_apn) 
+irb> client.property(some_fips_code, some_apn)
 # => property data
 ```
 
@@ -226,6 +227,23 @@ Data comes in the following form:
 }
 ```
 
+## Configuration
+
+There are two ways to configure the gem.
+
+### Block configuration
+
+```ruby
+MelissaData.configure do |config|
+  config.web_smart_id = ENV['MELISSA_DATA_WEB_SMART_ID']
+end
+```
+
+### One-liner
+
+```ruby
+MelissaData.web_smart_id = ENV['MELISSA_DATA_WEB_SMART_ID']
+```
 
 ## Development
 
@@ -241,4 +259,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/melissa_data/config.rb

@@ -0,0 +1,25 @@
+module MelissaData
+  module Config
+    def self.included(base)
+      base.extend(self)
+    end
+
+    # @!attribute web_smart_id
+    # @return [String] web smart id to be used
+    attr_accessor :web_smart_id
+
+    # Configures web_smart_id and property_api_url
+    #   Usage example:
+    #     MelissaData.configure do |config|
+    #       config.web_smart_id = ENV['MELISSA_DATA_WEB_SMART_ID']
+    #     end
+    #
+    #   Alternate way:
+    #     MelissaData.web_smart_id = ENV['MELISSA_DATA_WEB_SMART_ID']
+    #
+    # @param <api_key> [String] web smart id to use
+    def configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/melissa_data/version.rb

@@ -1,3 +1,3 @@
 module MelissaData
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/melissa_data/web_smart/client.rb

@@ -0,0 +1,9 @@
+module MelissaData
+  module WebSmart
+    class Client
+      def property(fips, apn)
+        MelissaData::WebSmart::PropertyAPI.new.property(fips, apn)
+      end
+    end
+  end
+end

data/lib/melissa_data/web_smart/property_api.rb

@@ -0,0 +1,16 @@
+require 'rest-client'
+require 'nokogiri'
+
+module MelissaData
+  module WebSmart
+    class PropertyAPI
+      def property(fips, apn)
+        resp = RestClient.get('https://property.melissadata.net/v3/REST/Service.svc/doLookup',
+                             { params: { id: MelissaData.web_smart_id,
+                                         fips: fips,
+                                         apn: apn } })
+        PropertyXMLParser.new(Nokogiri::XML(resp)).parse
+      end
+    end
+  end
+end

data/lib/melissa_data/web_smart/xml.rb

@@ -0,0 +1,72 @@
+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
+
+      def viperize_hash hash
+        hash.map { |key, value| { viperize(key.to_s) => value } }.reduce(:merge)
+      end
+
+      def viperize(string)
+        word = string.to_s.dup
+        word.gsub!(/::/, '/')
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word.to_sym
+      end
+    end
+
+    class PropertyXMLParser < XMLParser
+      def parse
+        parsed_hash = {}
+        if expected_retrieved?
+          retrieved_fields.each_with_index { |f, i| parsed_hash[f] = { data: field_details[i] } }
+          parsed_hash.keys.each { |k| parsed_hash[k] = build_subdictionary(parsed_hash[k][:data]) }
+          viperize_hash(parsed_hash)
+        end
+      end
+
+      def field_details
+        record_node.children.map(&:children)
+      end
+
+      def build_subdictionary(xml_vals)
+        keys = xml_vals.map(&:name)
+        vals = xml_vals.map { |v| v.children.first.text unless children? v }
+        viperize_hash(keys.zip(vals).to_h)
+      end
+
+      def expected_fields
+        [ "Building", "CurrentDeed", "CurrentSale", "Lot", "Owner",
+          "OwnerAddress", "Parcel", "ParsedPropertyAddress", "PriorSale",
+          "PropertyAddress", "RecordID", "Result", "SquareFootage", "Values"]
+      end
+
+      def expected_fields?(fields)
+        expected_fields == fields.sort
+      end
+
+      def record_node
+        xml_document.children.first.children.last # its just how they structure it..
+      end
+
+      def retrieved_fields
+        record_node.children.map(&:name)
+      end
+
+      def expected_retrieved?
+        expected_fields?(retrieved_fields)
+      end
+    end
+  end
+end

data/lib/melissa_data.rb

@@ -1,96 +1,12 @@
 require "melissa_data/version"
-#require "mellissa_data/web_smart/xml"
-#require "mellissa_data/web_smart/property_api"
-#require "mellissa_data/web_smart/client"
+require "melissa_data/web_smart/xml"
+require "melissa_data/web_smart/client"
+require "melissa_data/web_smart/property_api"
+require "melissa_data/config"
+
 require 'rest-client'
 require 'nokogiri'
 
 module MelissaData
-  module WebSmart
-    class PropertyAPI
-      def property(fips, apn) 
-        url = 'https://property.melissadata.net/v3/REST/Service.svc/doLookup'
-        resp = RestClient.get(url,
-                             { params: { id: ENV['MELISSA_DATA_WEB_SMART_ID'],
-                                         fips: fips,
-                                         apn: apn } })
-        PropertyXMLParser.new(Nokogiri::XML(resp)).parse
-      end
-    end
-
-    class XMLParser
-      attr_accessor :xml_document
-
-      def initialize(xml)
-        @xml_document = xml
-      end
-
-      def children?(xml_node)
-        xml_node.children.empty? 
-      end
-
-      def viperize_hash hash
-        hash.map { |key, value| { viperize(key.to_s) => value } }.reduce(:merge)
-      end
-
-      def viperize(string)
-        word = string.to_s.dup
-        word.gsub!(/::/, '/')
-        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        word.tr!("-", "_")
-        word.downcase!
-        word.to_sym
-      end
-    end
-
-    class PropertyXMLParser < XMLParser
-      def parse
-        parsed_hash = {}
-        if expected_retrieved?
-          retrieved_fields.each_with_index { |f, i| parsed_hash[f] = { data: field_details[i] } }
-          parsed_hash.keys.each { |k| parsed_hash[k] = build_subdictionary(parsed_hash[k][:data]) }
-          viperize_hash(parsed_hash)
-        end
-      end
-
-      def field_details
-        record_node.children.map { |n| n.children }
-      end
-
-      def build_subdictionary(xml_vals)
-        keys = xml_vals.map(&:name)
-        vals = xml_vals.map { |v| v.children.first.text unless children? v }
-        viperize_hash(keys.zip(vals).to_h)
-      end
-
-      def expected_fields
-        [ "RecordID", "Result", "Parcel", "PropertyAddress", "ParsedPropertyAddress",
-          "Owner", "OwnerAddress", "Values", "CurrentSale", "CurrentDeed", "PriorSale",
-          "Lot", "SquareFootage", "Building" ].sort
-      end
-
-      def expected_fields?(fields)
-        expected_fields == fields.sort
-      end
-
-      def record_node
-        xml_document.children.first.children.last # its just how they structure it..
-      end
-
-      def retrieved_fields
-        record_node.children.map { |n| n.name }
-      end
-
-      def expected_retrieved?
-        expected_fields?(retrieved_fields)
-      end
-    end
-
-    class Client
-      def property(fips, apn)
-        MelissaData::WebSmart::PropertyAPI.new.property(fips, apn)
-      end
-    end
-  end
+  include MelissaData::Config
 end

data/melissa_data.gemspec

@@ -6,8 +6,8 @@ require 'melissa_data/version'
 Gem::Specification.new do |spec|
   spec.name          = "melissa_data"
   spec.version       = MelissaData::VERSION
-  spec.authors       = ["Robert Grayson"]
-  spec.email         = ["bobbygrayson@gmail.com"]
+  spec.authors       = ["Robert Grayson", "Jonah Ruiz"]
+  spec.email         = ["bobbygrayson@gmail.com", "jonah@pixelhipsters.com"]
 
   spec.summary       = %q{A simple interface to Melissa Data's Web Smart Property API}
   spec.description   = %q{A simple interface to Melissa Data's Web Smart Property API}
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  
+
   spec.add_runtime_dependency "nokogiri"
   spec.add_runtime_dependency "rest-client"
 

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: melissa_data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Grayson
+- Jonah Ruiz
 autorequire: 
 bindir: exe
 cert_chain: []
@@ -111,6 +112,7 @@ dependencies:
 description: A simple interface to Melissa Data's Web Smart Property API
 email:
 - bobbygrayson@gmail.com
+- jonah@pixelhipsters.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -126,7 +128,11 @@ files:
 - bin/console
 - bin/setup
 - lib/melissa_data.rb
+- lib/melissa_data/config.rb
 - lib/melissa_data/version.rb
+- lib/melissa_data/web_smart/client.rb
+- lib/melissa_data/web_smart/property_api.rb
+- lib/melissa_data/web_smart/xml.rb
 - melissa_data.gemspec
 homepage: http://github.com/cometaworks/melissa_data
 licenses:
@@ -148,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple interface to Melissa Data's Web Smart Property API