nyc_geo_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00aa43b9e742e2fd169a884a4acbc6d79f749d27
+  data.tar.gz: 38a637417667ae915ec8bc510bcfd1d30d551956
+SHA512:
+  metadata.gz: 97a2bf6058b91ff52f9ffbb33b520a20aedd375ebb3dbd6612a41fa055b8b0130ae1f8ccabe3587cc0651e44ec59ea7e716492f193bb0312d3771c1ee67a834a
+  data.tar.gz: 620488b63ee0dc625f267124be32347e407e4f516296c544a48c6a815b3634cf6ca48185d5efb687657598ed2d30893c87ceba8c31b4cd8272b96a50420804c4

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+.DS_Store
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Edgar Gonzalez
+
+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,81 @@
+# NYCGeoClient [![Build Status](https://travis-ci.org/edgar/NYCGeoClient.png?branch=master)](https://travis-ci.org/edgar/NYCGeoClient)
+A ruby gem for the NYC GeoClient API - https://developer.cityofnewyork.us/api/geoclient-api-beta
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nyc_geo_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nyc_geo_client
+
+
+*NOTE:* You will need to register an application with the [NYC Developer Portal](https://developer.cityofnewyork.us/), and make sure that you check off access to the Geoclient API for the application. Take note of the Application's ID and key.
+
+## API Usage Examples
+
+    require "rubygems"
+    require "nyc_geo_client"
+
+    client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY')
+
+    # get block and property level information about an address
+    client.address('13', 'crosby', 'manhattan')
+
+    # property level information about a tax lot
+    client.bbl('manhattan', '00233', '0004')
+
+    # get property level information about a building
+    client.bin('1003041')
+
+    # get information about a segment defined by an on street between two cross-streets
+    client.blockface('34 st', 'fifth ave', 'sixth ave', 'manhattan')
+
+    # get information about a point defined by two cross streets
+    client.intersection('34 st', 'fifth ave', 'manhattan')
+
+    # get address information using a well-known place name
+    client.place('empire state building', 'manhattan')
+
+
+For more information about the data returned by every method please check the specs folder
+
+## Configuration
+
+Because NYCGeoClient gem is based on [Faraday](https://github.com/lostisland/faraday), it supports the following adapters:
+
+* Net::HTTP (default)
+* [Excon](https://github.com/geemus/excon)
+* [Typhoeus](https://github.com/typhoeus/typhoeus)
+* [Patron](http://toland.github.com/patron/)
+* [EventMachine](https://github.com/igrigorik/em-http-request)
+
+Beside the adapter, you can change the following properties:
+
+* endpoint
+* format
+* user_agent
+* proxy
+* debug
+
+For instance:
+
+    require 'typhoeus/adapters/faraday' # You will need the typhoeus gem
+
+    client = NYCGeoClient.client(adapter: :typhoeus, user_agent: "foobar v1", debug: true, app_id: 'foo', app_key: 'bar')
+    client.address('13','crosby','manhattan')
+
+
+## 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,30 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+task :test => :spec
+
+namespace :doc do
+  begin
+    require 'yard'
+  rescue LoadError
+    # ignore
+  else
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['lib/**/*.rb']
+      task.options = [
+        '--protected',
+        '--output-dir', 'doc/yard',
+        '--tag', 'format:Supported formats',
+        '--markup', 'markdown',
+      ]
+    end
+  end
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r nyc_geo_client.rb"
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        if [403, 500, 503].include? response[:status].to_i
+          raise NYCGeoClient::Error.new(error_message(response), response[:status].to_i)
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s, response[:body]].compact.join(': ')}"
+    end
+  end
+end

data/lib/nyc_geo_client.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../nyc_geo_client/error', __FILE__)
+require File.expand_path('../nyc_geo_client/configuration', __FILE__)
+require File.expand_path('../nyc_geo_client/api', __FILE__)
+require File.expand_path('../nyc_geo_client/client', __FILE__)
+
+module NYCGeoClient
+  extend Configuration
+
+  # Alias for NYCGeoClient::Client.new
+  #
+  # @return [NYCGeoClient::Client]
+  def self.client(options={})
+    NYCGeoClient::Client.new(options)
+  end
+
+  # Delegate to NYCGeoClient::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to NYCGeoClient::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/nyc_geo_client/api.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+
+module NYCGeoClient
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = NYCGeoClient.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/nyc_geo_client/client.rb

@@ -0,0 +1,13 @@
+module NYCGeoClient
+  class Client < API
+
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include NYCGeoClient::Client::Address
+    include NYCGeoClient::Client::BBL
+    include NYCGeoClient::Client::BIN
+    include NYCGeoClient::Client::Blockface
+    include NYCGeoClient::Client::Intersection
+    include NYCGeoClient::Client::Place
+  end
+end

data/lib/nyc_geo_client/client/address.rb

@@ -0,0 +1,34 @@
+module NYCGeoClient
+  class Client
+    # Defines methods related to branches
+    module Address
+
+      # Returns block and property level information about an address.
+      #
+      # Results will include X/Y coordinates, political, city service
+      # and property information as well as normalized street names and codes.
+      #
+      # @param house_number [String] The house number portion of the address
+      # @param street [String] The street portion of the address
+      # @param borough [String] The borough in which the address is located
+      # @return [Hashie::Mash]
+      # @example block and property level information about an address
+      #   NYCGeoClient.address('13', 'crosby', 'manhattan')
+      # @format :json, :xml
+      def address(house_number, street, borough)
+        options = {
+          houseNumber: house_number,
+          street: street,
+          borough: borough
+        }
+        get(address_path, options)
+      end
+
+      protected
+
+      def address_path
+        "address"
+      end
+    end
+  end
+end

data/lib/nyc_geo_client/client/bbl.rb

@@ -0,0 +1,31 @@
+module NYCGeoClient
+  class Client
+    # Defines methods related to branches
+    module BBL
+
+      # Returns property level information about a tax lot.
+      #
+      # @param borough [String] The borough in which the address is located
+      # @param block [String] Tax block number
+      # @param lot [String] Tax lot number
+      # @return [Hashie::Mash]
+      # @example property level information about a tax lot
+      #   NYCGeoClient.bbl('manhattan','00233', '0004')
+      # @format :json, :xml
+      def bbl(borough, block, lot)
+        options = {
+          block:   block,
+          lot:     lot,
+          borough: borough
+        }
+        get(bbl_path, options)
+      end
+
+      protected
+
+      def bbl_path
+        "bbl"
+      end
+    end
+  end
+end

data/lib/nyc_geo_client/client/bin.rb

@@ -0,0 +1,27 @@
+module NYCGeoClient
+  class Client
+    # Defines methods related to branches
+    module BIN
+
+      # Returns property level information about a building.
+      #
+      # @param bin [String] The bin in which the address is located
+      # @return [Hashie::Mash]
+      # @example property level information about a building
+      #   NYCGeoClient.bin('1003041')
+      # @format :json, :xml
+      def bin(bin)
+        options = {
+          bin: bin
+        }
+        get(bin_path, options)
+      end
+
+      protected
+
+      def bin_path
+        "bin"
+      end
+    end
+  end
+end

data/lib/nyc_geo_client/client/blockface.rb

@@ -0,0 +1,37 @@
+module NYCGeoClient
+  class Client
+    # Defines methods related to branches
+    module Blockface
+
+      # Returns information about a segment defined by an on street between two cross-streets.
+      #
+      # @param on_street [String] The street on which the segment is found
+      # @param cross_street_one [String] The first cross street
+      # @param cross_street_two [String] The second cross street
+      # @param borough [String] The borough in which the on_street is located
+      # @param extra [Hash] optional params:
+      #   - boroughCrossStreetOne: The borough in which the cross_street_one is located if it differs from the borough parameter
+      #   - boroughCrossStreetTwo: The borough in which the cross_street_two is located if it differs from the borough parameter
+      #   - compassDirection: Used when requesting information about only one side of the street (north, south, west, east, n, s, w, e)
+      # @return [Hashie::Mash]
+      # @example information about a segment defined by an on street between two cross-streets
+      #   NYCGeoClient.blockface('34 st', 'fifht ave', 'sixth ave', 'manhattan')
+      # @format :json, :xml
+      def blockface(on_street, cross_street_one, cross_street_two, borough, extra = {})
+        options = {
+          onStreet:    on_street,
+          crossStreetOne: cross_street_one,
+          crossStreetTwo: cross_street_two,
+          borough: borough
+        }.merge(extra)
+        get(blockface_path, options)
+      end
+
+      protected
+
+      def blockface_path
+        "blockface"
+      end
+    end
+  end
+end

data/lib/nyc_geo_client/client/intersection.rb

@@ -0,0 +1,34 @@
+module NYCGeoClient
+  class Client
+    # Defines methods related to branches
+    module Intersection
+
+      # Returns information about a point defined by two cross streets.
+      #
+      # @param cross_street_one [String] The first cross street
+      # @param cross_street_two [String] The second cross street
+      # @param borough [String] The borough in which the on_street is located
+      # @param extra [Hash] optional params:
+      #   - boroughCrossStreetTwo: The borough in which the cross_street_two is located if it differs from the borough parameter
+      #   - compassDirection: Used when requesting information about only one side of the street (north, south, west, east, n, s, w, e)
+      # @return [Hashie::Mash]
+      # @example information about a segment defined by an on street between two cross-streets
+      #   NYCGeoClient.blockface('34 st', 'fifht ave', 'manhattan')
+      # @format :json, :xml
+      def intersection(cross_street_one, cross_street_two, borough, extra = {})
+        options = {
+          crossStreetOne: cross_street_one,
+          crossStreetTwo: cross_street_two,
+          borough: borough
+        }.merge(extra)
+        get(intersection_path, options)
+      end
+
+      protected
+
+      def intersection_path
+        "intersection"
+      end
+    end
+  end
+end

data/lib/nyc_geo_client/client/place.rb

@@ -0,0 +1,29 @@
+module NYCGeoClient
+  class Client
+    # Defines methods related to branches
+    module Place
+
+      # Returns address information using a well-known place name as input.
+      #
+      # @param name [String] A well-known New York City place name
+      # @param borough [String] The borough in which the place is located
+      # @return [Hashie::Mash]
+      # @example address information using a well-known place name
+      #   NYCGeoClient.place('empire state building')
+      # @format :json, :xml
+      def place(name, borough)
+        options = {
+          name:    name,
+          borough: borough
+        }
+        get(place_path, options)
+      end
+
+      protected
+
+      def place_path
+        "place"
+      end
+    end
+  end
+end