phl-opa 0.0.2 → 0.0.5

data/README.md

@@ -2,7 +2,7 @@
 
 # PHL-opa
 
-A thin wrapper for the Philadelphia Office of Property Assessment API
+A thin wrapper for the Philadelphia [Office of Property Assessment API](http://phlapi.com/opaapi.html)
 
 ## Installation
 
@@ -20,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-Search by account number
+**#get_by_account**
+
+Returns the property details for the provided OPA account number. This method returns the most amount of data about a given property. If you have an address, but not an OPA account number. Use the `#search_by_address` method to find the OPA account number, then this method to get all the details about the property.
 
     require 'phl_opa'
     phl_opa = PHLopa::API.new
@@ -48,11 +50,13 @@ Response:
           }
       ...
 
-Search by address
+**#search_by_address**
+
+Searches for properties that match the provided address. In the response, the `data.properties` key is always an array, even if there is only one result
 
     require 'phl_opa'
     phl_opa = PHLopa::API.new
-    phl_opa.get_by_address('1234 Market St')
+    phl_opa.search_by_address('1234 Market St')
 
 Response
 
@@ -76,6 +80,96 @@ Response
           geometry: {
     ...
 
+**#search_by_block**
+
+Searches for properties that are located on the provided block. In the response, the `data.properties` key is always an array, even if there is only one result.
+
+    require 'phl_opa'
+    phl_opa = PHLopa::API.new
+    phl_opa.search_by_block('1234 Market St')
+
+Response
+
+    {
+      status: "success",
+      total: 3,
+      data: {
+        properties: [{
+          property_id: "5356001200",
+          account_number: "883705320",
+          full_address: "1200 MARKET ST",
+          unit: "",
+          zip: "191073615",
+          address_match: {
+            original: "1200-1298 market st",
+            standardized: "1200 MARKET ST",
+            similarity: 100,
+            match_code: "",
+            match_type: "MA"
+          },
+          geometry: {
+    ...
+
+**#search_by_intersection**
+
+Searches for properties that are near the provided the intersection. In the response, the `data.properties` key is always an array, even if there is only one result.
+
+    require 'phl_opa'
+    phl_opa = PHLopa::API.new
+    phl_opa.search_by_intersection('Market St', '12th')
+
+Response
+
+    {
+      status: "success",
+      total: 5,
+      data: {
+        properties: [{
+          property_id: "53560011130000001",
+          account_number: "883705100",
+          full_address: "1113 MARKET ST",
+          unit: "0000001",
+          zip: "19107-2901",
+          address_match: {
+            original: null,
+            standardized: null,
+            similarity: null,
+            match_code: null,
+            match_type: null
+          },
+          geometry: {
+    ...
+
+**#search_nearby**
+
+Searches for properties that are near the provide latitude/longitude coordinate, and within the provided radius. The default distance for `radius` is 200 feet, and is not required. In the response, the `data.properties` key is always an array, even if there is only one result.
+
+    require 'phl_opa'
+    phl_opa = PHLopa::API.new
+    phl_opa.search_nearby(-75.16097, 39.95166, 400)
+
+Response
+
+    {
+      status: "success",
+      total: 25,
+      data: {
+        properties: [{
+        property_id: "5356001200",
+        account_number: "883705320",
+        full_address: "1200 MARKET ST",
+        unit: "",
+        zip: "191073615",
+        address_match: {
+          original: null,
+          standardized: null,
+          similarity: null,
+          match_code: null,
+          match_type: null
+        },
+        geometry: {
+    ...
+
 ## Contributing
 
 1. Fork it

data/lib/phl_opa/api.rb

@@ -24,7 +24,7 @@ module PHLopa
       data
     end
 
-    def get_by_address(address=nil)
+    def search_by_address(address=nil)
       raise ArgumentError("Address must be a string") unless address.is_a? String
 
       response = invoke_api('address/', address + '/')
@@ -33,6 +33,39 @@ module PHLopa
       data
     end
 
+    def search_by_block(block=nil)
+      raise ArgumentError("Block must be a string") unless block.is_a? String
+
+      response = invoke_api('block/', block + '/')
+      data = parse_response(response)
+
+      data
+    end
+
+    def search_by_intersection(street_a=nil, street_b=nil)
+      raise ArgumentError("Street_a must be a string") unless street_a.is_a? String
+      raise ArgumentError("Street_b must be a string") unless street_b.is_a? String
+      if (street_a.nil? || street_b.nil?); raise ArgumentError("Both parameters are required") end
+
+      response = invoke_api('intersection/', street_a + '/' + street_b)
+      data = parse_response(response)
+
+      data
+    end
+
+    def search_nearby(lat=nil, lng=nil, radius=200)
+      raise ArgumentError("Latitude must be a number") unless lat.is_a? Float
+      raise ArgumentError("Longitude must be a number") unless lng.is_a? Float
+      raise ArgumentError("Radius must be a number") unless radius.is_a? Fixnum
+      raise ArgumentError("Radius must be a positive number") unless radius > 0
+      if (lat.nil? || lng.nil?); raise ArgumentError("Both latitude and longitude are required") end
+
+      response = invoke_api('nearby/', "#{lng}/#{lat}/#{radius}")
+      data = parse_response(response)
+
+      data
+    end
+
     def parse_response(response)
       json = JSON.parse(response.body)
 

data/lib/phl_opa/version.rb

@@ -1,3 +1,3 @@
 module PHLopa
-  VERSION = '0.0.2'
+  VERSION = '0.0.5'
 end

data/spec/lib/phl_opa_spec.rb

@@ -33,18 +33,84 @@ describe PHLopa do
     end
   end
 
-  describe "#get_by_address" do
+  describe "#search_by_address" do
     before :each do
       @phl_opa = PHLopa::API.new
     end
 
     it "returns the property details for the adress that is passed" do
-      @phl_opa.get_by_address('1234 Market St')['data']['properties'][0]['account_number'] = '883309000'
+      @phl_opa.search_by_address('1234 Market St')['data']['properties'][0]['account_number'] = '883309000'
     end
 
     it "raises an error if the address argument is not a string" do
-      lambda { @phl_opa.get_by_address(123456780) }.should raise_error
-      lambda { @phl_opa.get_by_address(['1234 Market St']) }.should raise_error
+      lambda { @phl_opa.search_by_address(123456780) }.should raise_error
+      lambda { @phl_opa.search_by_address(['1234 Market St']) }.should raise_error
     end
   end
+
+  describe "#search_by_block" do
+    before :each do
+      @phl_opa = PHLopa::API.new
+    end
+
+    it "returns the property details for all the properties on the searched block" do
+      @phl_opa.search_by_block('1200 Market St')['total'] = 3
+    end
+
+    it "raises an error if the address argument is not a string" do
+      lambda { @phl_opa.search_by_block(123456780) }.should raise_error
+      lambda { @phl_opa.search_by_block(['1234 Market St']) }.should raise_error
+    end
+  end
+
+  describe "#search_by_intersection" do
+    before :each do
+      @phl_opa = PHLopa::API.new
+    end
+
+    it "returns the property details for all the properties near the provided intersection" do
+      @phl_opa.search_by_intersection('12th', 'Market')['total'] = 5
+    end
+
+    it "raises an error if the address argument is not a string" do
+      lambda { @phl_opa.search_by_intersection(12, 'Market') }.should raise_error
+      lambda { @phl_opa.search_by_intersection('Market', 12) }.should raise_error
+    end
+
+    it "raises an error if either of the street arguments are nil" do
+      lambda { @phl_opa.search_by_intersection('Market') }.should raise_error
+      lambda { @phl_opa.search_by_intersection(nil, 'Market') }.should raise_error
+    end
+  end
+
+  describe "#search_nearby" do
+    before :each do
+      @phl_opa = PHLopa::API.new
+    end
+
+    it "returns the property details for all the properties near the provided point and within the provided radius" do
+      @phl_opa.search_nearby(39.95166, -75.16097, 400)['total'] = 25
+    end
+
+    it "does not require that the user sets the radius argument" do
+      @phl_opa.search_nearby(39.95166, -75.16097)['total'] = 4
+    end
+
+    it "raises an error if the radius argument is not a positive number" do
+      lambda { @phl_opa.search_nearby(39.95166, -75.16097, -100) }.should raise_error
+      lambda { @phl_opa.search_nearby(39.95166, -75.16097, '1000') }.should raise_error
+    end
+
+    it "raises an error if either the latitude or longitude arguments are nil" do
+      lambda { @phl_opa.search_nearby(nil, -75.16097, 100) }.should raise_error
+      lambda { @phl_opa.search_nearby(39.95166, nil, 100) }.should raise_error
+      lambda { @phl_opa.search_nearby(nil, nil, 100) }.should raise_error
+    end
+
+    it "raises an error if either the latitude or longitude arguments are not numbers" do
+      lambda { @phl_opa.search_nearby(39.95166, '-75.16097', 100) }.should raise_error
+      lambda { @phl_opa.search_nearby('39.95166', -75.16097, 100) }.should raise_error
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phl-opa
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors: