phl-opa 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phl-opa.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end
+
+group :development do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Casey Thomas
+
+MIT License
+
+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,85 @@
+[![Build Status](https://secure.travis-ci.org/caseypt/phl-opa.png?branch=master)](https://travis-ci.org/caseypt/phl-opa)
+
+# PHL-opa
+
+A thin wrapper for the Philadelphia Office of Property Assessment API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'phl_opa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phl_opa
+
+## Usage
+
+Search by account number
+
+    require 'phl_opa'
+    phl_opa = PHLopa::API.new
+    phl_opa.get_by_account(883309000)
+
+Response:
+
+    {
+      status: "success",
+      data: {
+        property: {
+          property_id: "5356001234",
+          account_number: "883309000",
+          full_address: "1234 MARKET ST",
+          unit: "",
+          zip: "19107-3615",
+          geometry: {
+            x: -75.16097581817294,
+            y: 39.95166185436387
+          },
+          ownership: {
+            owners: [
+              "SEPTA"
+            ],
+          }
+      ...
+
+Search by address
+
+    require 'phl_opa'
+    phl_opa = PHLopa::API.new
+    phl_opa.get_by_address('1234 Market St')
+
+Response
+
+    {
+      status: "success",
+      total: 1,
+      data: {
+        properties: [{
+          property_id: "5356001234",
+          account_number: "883309000",
+          full_address: "1234 MARKET ST",
+          unit: "",
+          zip: "19107-3615",
+          address_match: {
+            original: "1234 market st",
+            standardized: "1234 MARKET ST",
+            similarity: 100,
+            match_code: "",
+            match_type: "MA"
+          },
+          geometry: {
+    ...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/phl_opa.rb

@@ -0,0 +1,2 @@
+require "phl_opa/version"
+require "phl_opa/api"

data/lib/phl_opa/api.rb

@@ -0,0 +1,49 @@
+require "json"
+require "open-uri"
+require "net/http"
+
+module PHLopa
+  class API
+    attr_accessor :settings
+
+    def initialize(options={})
+      @settings = {
+        :api_base => "http://api.phila.gov/opa/v1.0/",
+        :default_query_string => "?format=json"
+      }.merge(options)
+    end
+
+    def get_by_account(account=nil)
+      raise ArgumentError("Account Number must be 9 digits long") unless account.length == 9
+      raise ArgumentError("Account Number must be a string") unless account.is_a? String
+      raise ArgumentError("Account Number must be made up only of numbers") unless account !~ /\D/
+
+      response = invoke_api('account/', account)
+      data = parse_response(response)
+
+      data
+    end
+
+    def get_by_address(address=nil)
+      raise ArgumentError("Address must be a string") unless address.is_a? String
+
+      response = invoke_api('address/', address + '/')
+      data = parse_response(response)
+
+      data
+    end
+
+    def parse_response(response)
+      json = JSON.parse(response.body)
+
+      json
+    end
+
+    def invoke_api(path, parameter)
+      encoded = URI::encode(parameter)
+      url = URI.parse("#{@settings[:api_base]}#{path}#{encoded}#{@settings[:default_query_string]}")
+
+      Net::HTTP.get_response(url)
+    end
+  end
+end

data/lib/phl_opa/version.rb

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

data/phl-opa.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phl_opa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phl-opa"
+  spec.version       = PHLopa::VERSION
+  spec.authors       = ["Casey Thomas"]
+  spec.email         = ["cpthomas@gmail.com"]
+  spec.description   = %q{A thin wrapper for the Philadelphia Office of Property Assessment API}
+  spec.summary       = %q{Get information about properties in Philadelphia}
+  spec.homepage      = "https://www.github.com/caseypt/phl-opa"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/lib/phl_opa_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe PHLopa do
+
+  describe "#new" do
+    before :each do
+      @phl_opa = PHLopa::API.new
+    end
+  end
+
+  describe "#get_by_account" do
+    before :each do
+      @phl_opa = PHLopa::API.new
+    end
+
+    it "returns the property details for the OPA account that is passed" do
+      @phl_opa.get_by_account('883309000')['data']['property']['full_address'] = '1234 MARKET ST'
+    end
+
+    it "raises an error if the account argument is not a string" do
+      lambda { @phl_opa.get_by_account(123456780) }.should raise_error
+      lambda { @phl_opa.get_by_account([123456780]) }.should raise_error
+    end
+
+    it "raises an error if the length of the account argument is not exactly 9" do
+      lambda { @phl_opa.get_by_account('12345678') }.should raise_error
+      lambda { @phl_opa.get_by_account('12345678910') }.should raise_error
+    end
+
+    it "raises an error if the account argument contains anything but numbers" do
+      lambda { @phl_opa.get_by_account('123456780z') }.should raise_error
+      lambda { @phl_opa.get_by_account('12345ddfdf6780') }.should raise_error
+    end
+  end
+
+  describe "#get_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'
+    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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'phl_opa'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: phl-opa
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Casey Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A thin wrapper for the Philadelphia Office of Property Assessment API
+email:
+- cpthomas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/phl_opa.rb
+- lib/phl_opa/api.rb
+- lib/phl_opa/version.rb
+- phl-opa.gemspec
+- spec/lib/phl_opa_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/caseypt/phl-opa
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Get information about properties in Philadelphia
+test_files:
+- spec/lib/phl_opa_spec.rb
+- spec/spec_helper.rb