nyc_geo_client 0.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00aa43b9e742e2fd169a884a4acbc6d79f749d27
-  data.tar.gz: 38a637417667ae915ec8bc510bcfd1d30d551956
+SHA256:
+  metadata.gz: d67887dee4749084a26e14d54c176afaf9c69048715eaf920ec99cee21661e53
+  data.tar.gz: a122a47fc1b18f062d73f7801fa5f9cd1c4a4db9d809e8e14ef6707a090a530e
 SHA512:
-  metadata.gz: 97a2bf6058b91ff52f9ffbb33b520a20aedd375ebb3dbd6612a41fa055b8b0130ae1f8ccabe3587cc0651e44ec59ea7e716492f193bb0312d3771c1ee67a834a
-  data.tar.gz: 620488b63ee0dc625f267124be32347e407e4f516296c544a48c6a815b3634cf6ca48185d5efb687657598ed2d30893c87ceba8c31b4cd8272b96a50420804c4
+  metadata.gz: c517c118646ba63a84440422a4ca7157f6dfb90c870aed3f9a84928215334973c2f78a5f7ffda14bb63b699ba3d56b8c4c82fa29e6f0dae8567b6723f2889db7
+  data.tar.gz: f452f09c95b766e1e524af83075b472a4237b05d98896d7979d99985ed33e7ca9f587532673f1c1ed4ed1f792aac375b49541d92ff374c51bb689379c12ed05f

data/.travis.yml

@@ -3,7 +3,12 @@ matrix:
   allow_failures:
     - rvm: ruby-head
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - ruby-head
+before_install:
+  # need this for ruby 1.9.3 and rspec
+  - gem update --system
+  - gem update bundler --force

data/README.md

@@ -1,5 +1,5 @@
-# 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
+# NYCGeoClient [![Build Status](https://app.travis-ci.com/edgar/NYCGeoClient.svg?branch=master)](https://app.travis-ci.com/edgar/NYCGeoClient) [![Gem Version](https://badge.fury.io/rb/nyc_geo_client.svg)](http://badge.fury.io/rb/nyc_geo_client)
+A ruby gem for the NYC GeoClient API - https://api-portal.nyc.gov/docs/services/geoclient/operations/geoclient
 
 ## Installation
 
@@ -16,32 +16,41 @@ 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.
+*NOTE:* You will need to register an application with the [NYC API Portal](https://api-portal.nyc.gov/), and make sure that you check off access to the Geoclient API for the application. Take note of the Application's subscription key.
 
 ## API Usage Examples
 
     require "rubygems"
     require "nyc_geo_client"
 
-    client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY')
+    client = NYCGeoClient::Client.new(subscription_key: 'KEY')
 
     # get block and property level information about an address
-    client.address('13', 'crosby', 'manhattan')
+    client.address(house_number: '13', street: 'crosby', borough: 'manhattan')
 
     # property level information about a tax lot
-    client.bbl('manhattan', '00233', '0004')
+    client.bbl(borough: 'manhattan', block: '00233', lot: '0004')
 
     # get property level information about a building
-    client.bin('1003041')
+    client.bin(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')
+    client.blockface(
+        on_street: '34 st',
+        cross_street_one: 'fifth ave',
+        cross_street_two: 'sixth ave',
+        borough: 'manhattan'
+    )
 
     # get information about a point defined by two cross streets
-    client.intersection('34 st', 'fifth ave', 'manhattan')
+    client.intersection(
+        cross_street_one: '34 st',
+        cross_street_two: 'fifth ave',
+        borough: 'manhattan'
+    )
 
     # get address information using a well-known place name
-    client.place('empire state building', 'manhattan')
+    client.place(name: 'empire state building', borough: 'manhattan')
 
 
 For more information about the data returned by every method please check the specs folder
@@ -69,8 +78,16 @@ 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')
+    client.address(house_number: '13', street: 'crosby', borough: 'manhattan')
 
+## Ruby versions supported
+
+* 2.4
+* 2.5
+* 2.6
+* 2.7
+
+Check the [.travis.yml](.travis.yml) to see the current supported ruby versions.
 
 ## Contributing
 

data/Rakefile

@@ -26,5 +26,5 @@ end
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -I lib -r nyc_geo_client.rb"
-end
+  sh "irb -r rubygems -I lib -r nyc_geo_client.rb"
+end

data/lib/nyc_geo_client/client/address.rb

@@ -15,12 +15,13 @@ module NYCGeoClient
       # @example block and property level information about an address
       #   NYCGeoClient.address('13', 'crosby', 'manhattan')
       # @format :json, :xml
-      def address(house_number, street, borough)
+      def address(house_number:, street:, borough: nil, zip: nil)
         options = {
           houseNumber: house_number,
           street: street,
-          borough: borough
-        }
+          borough: borough,
+          zip: zip
+        }.reject { |k, v| v.nil? }
         get(address_path, options)
       end
 

data/lib/nyc_geo_client/client/bbl.rb

@@ -12,7 +12,7 @@ module NYCGeoClient
       # @example property level information about a tax lot
       #   NYCGeoClient.bbl('manhattan','00233', '0004')
       # @format :json, :xml
-      def bbl(borough, block, lot)
+      def bbl(borough:, block:, lot:)
         options = {
           block:   block,
           lot:     lot,

data/lib/nyc_geo_client/client/bin.rb

@@ -10,7 +10,7 @@ module NYCGeoClient
       # @example property level information about a building
       #   NYCGeoClient.bin('1003041')
       # @format :json, :xml
-      def bin(bin)
+      def bin(bin:)
         options = {
           bin: bin
         }

data/lib/nyc_geo_client/client/blockface.rb

@@ -17,13 +17,16 @@ module NYCGeoClient
       # @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 = {})
+      def blockface(on_street:, cross_street_one:, cross_street_two:, borough:, borough_cross_street_one: nil, borough_cross_street_two: nil, compass_direction: nil)
         options = {
           onStreet:    on_street,
           crossStreetOne: cross_street_one,
           crossStreetTwo: cross_street_two,
-          borough: borough
-        }.merge(extra)
+          borough: borough,
+          boroughCrossStreetOne: borough_cross_street_one,
+          boroughCrossStreetTwo: borough_cross_street_two,
+          compassDirection: compass_direction
+        }.reject { |k, v| v.nil? }
         get(blockface_path, options)
       end
 

data/lib/nyc_geo_client/client/intersection.rb

@@ -15,12 +15,14 @@ module NYCGeoClient
       # @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 = {})
+      def intersection(cross_street_one:, cross_street_two:, borough:, borough_cross_street_two: nil, compass_direction: nil)
         options = {
           crossStreetOne: cross_street_one,
           crossStreetTwo: cross_street_two,
-          borough: borough
-        }.merge(extra)
+          borough: borough,
+          boroughCrossStreetTwo: borough_cross_street_two,
+          compassDirection: compass_direction
+        }.reject { |k, v| v.nil? }
         get(intersection_path, options)
       end
 

data/lib/nyc_geo_client/client/place.rb

@@ -11,11 +11,12 @@ module NYCGeoClient
       # @example address information using a well-known place name
       #   NYCGeoClient.place('empire state building')
       # @format :json, :xml
-      def place(name, borough)
+      def place(name:, borough: nil, zip: nil)
         options = {
           name:    name,
-          borough: borough
-        }
+          borough: borough,
+          zip: zip
+        }.reject { |k, v| v.nil? }
         get(place_path, options)
       end
 

data/lib/nyc_geo_client/configuration.rb

@@ -7,8 +7,7 @@ module NYCGeoClient
     # An array of valid keys in the options hash when configuring a {NYCGeoClient::API}
     VALID_OPTIONS_KEYS = [
       :adapter,
-      :app_id,
-      :app_key,
+      :subscription_key,
       :endpoint,
       :format,
       :user_agent,
@@ -24,16 +23,13 @@ module NYCGeoClient
     # @note The default faraday adapter is Net::HTTP.
     DEFAULT_ADAPTER = Faraday.default_adapter
 
-    # By default, don't set an application ID
-    DEFAULT_APP_ID = nil
-
     # By default, don't set an application KEY
-    DEFAULT_APP_KEY = nil
+    DEFAULT_SUBSCRIPTION_KEY = nil
 
     # The endpoint that will be used to connect if none is set
     #
     # @note There is no reason to use any other endpoint at this time
-    DEFAULT_ENDPOINT = 'https://api.cityofnewyork.us/geoclient/v1/'.freeze
+    DEFAULT_ENDPOINT = 'https://api.nyc.gov/geo/geoclient/v1/'.freeze
 
     # The response format appended to the path and sent in the 'Accept' header if none is set
     #
@@ -71,14 +67,13 @@ module NYCGeoClient
 
     # Reset all configuration options to defaults
     def reset
-      self.adapter        = DEFAULT_ADAPTER
-      self.app_id         = DEFAULT_APP_ID
-      self.app_key        = DEFAULT_APP_KEY
-      self.endpoint       = DEFAULT_ENDPOINT
-      self.format         = DEFAULT_FORMAT
-      self.user_agent     = DEFAULT_USER_AGENT
-      self.proxy          = DEFAULT_PROXY
-      self.debug          = DEFAULT_DEBUG
+      self.adapter          = DEFAULT_ADAPTER
+      self.subscription_key = DEFAULT_SUBSCRIPTION_KEY
+      self.endpoint         = DEFAULT_ENDPOINT
+      self.format           = DEFAULT_FORMAT
+      self.user_agent       = DEFAULT_USER_AGENT
+      self.proxy            = DEFAULT_PROXY
+      self.debug            = DEFAULT_DEBUG
     end
   end
-end
+end

data/lib/nyc_geo_client/connection.rb

@@ -8,10 +8,14 @@ module NYCGeoClient
 
     def connection(raw=false)
       options = {
-        :headers => {'Accept' => "application/json; charset=utf-8", 'User-Agent' => user_agent},
-        :proxy => proxy,
-        :ssl => {:verify => false},
-        :url => endpoint,
+        headers: {
+          'Accept' => "application/json; charset=utf-8",
+          'User-Agent' => user_agent,
+          'Ocp-Apim-Subscription-Key' => subscription_key
+        },
+        proxy: proxy,
+        ssl: {verify: false},
+        url: endpoint
       }
 
       Faraday::Connection.new(options) do |connection|
@@ -27,4 +31,4 @@ module NYCGeoClient
       end
     end
   end
-end
+end

data/lib/nyc_geo_client/request.rb

@@ -25,15 +25,14 @@ module NYCGeoClient
 
     # Perform an HTTP request
     def request(method, path, options, raw=false)
-      new_options = access_params.merge(options)
       response = connection(raw).send(method) do |request|
         path = formatted_path(path)
         case method
         when :get, :delete
-          request.url(path, new_options)
+          request.url(path, options)
         when :post, :put
           request.path = path
-          request.body = new_options unless new_options.empty?
+          request.body = options unless options.empty?
         end
       end
       if raw
@@ -48,12 +47,5 @@ module NYCGeoClient
     def formatted_path(path)
       [path, format].compact.join('.')
     end
-
-    def access_params
-      hash = {}
-      hash[:app_id] = app_id if app_id
-      hash[:app_key] = app_key if app_key
-      hash
-    end
   end
-end
+end

data/lib/nyc_geo_client/version.rb

@@ -1,3 +1,3 @@
 module NYCGeoClient
-  VERSION = "0.0.1".freeze unless defined?(::NYCGeoClient::VERSION)
+  VERSION = "2.0.0".freeze unless defined?(::NYCGeoClient::VERSION)
 end

data/lib/nyc_geo_client.rb

@@ -14,13 +14,13 @@ module NYCGeoClient
   end
 
   # Delegate to NYCGeoClient::Client
-  def self.method_missing(method, *args, &block)
+  def self.method_missing(method, **kwargs, &block)
     return super unless client.respond_to?(method)
-    client.send(method, *args, &block)
+    client.public_send(method, **kwargs, &block)
   end
 
   # Delegate to NYCGeoClient::Client
-  def self.respond_to?(method)
+  def self.respond_to?(method, include_all=false)
     return client.respond_to?(method) || super
   end
 end

data/nyc_geo_client.gemspec

@@ -3,16 +3,15 @@ require File.expand_path('../lib/nyc_geo_client/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency('rspec', '~> 2.14.1')
-  gem.add_development_dependency('webmock', '~> 1.17.1')
-  gem.add_development_dependency('yard', '~> 0.8.7.3')
-  gem.add_development_dependency('bluecloth', '~> 2.2.0')
+  gem.add_development_dependency('rspec', '~> 3.10.0')
+  gem.add_development_dependency('webmock', '~> 3.14.0')
+  gem.add_development_dependency('yard', '~> 0.9.26')
 
-  gem.add_runtime_dependency('faraday', '~> 0.8.8')
-  gem.add_runtime_dependency('faraday_middleware', '~> 0.9.0')
-  gem.add_runtime_dependency('multi_json', '~> 1.8.4')
-  gem.add_runtime_dependency('multi_xml', '~> 0.5.5')
-  gem.add_runtime_dependency('hashie',  '~> 2.0.5')
+  gem.add_runtime_dependency('faraday', '~> 1.7.2')
+  gem.add_runtime_dependency('faraday_middleware', '~> 1.1.0')
+  gem.add_runtime_dependency('multi_json', '~> 1.15.0')
+  gem.add_runtime_dependency('multi_xml', '~> 0.6.0')
+  gem.add_runtime_dependency('hashie',  '~> 4.1.0')
   gem.authors       = ["Edgar Gonzalez"]
   gem.email         = ["edgargonzalez@gmail.com"]
   gem.description   = %q{A ruby wrapper for NYCGeoClient API}

data/spec/faraday/response_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path('../../spec_helper', __FILE__)
 
 describe Faraday::Response do
   before do
-    @client = NYCGeoClient::Client.new(app_id: 'foo', app_key: 'bar')
+    @client = NYCGeoClient::Client.new(subscription_key: 'foo')
   end
 
   [403, 500, 503].each do |status|
@@ -11,8 +11,6 @@ describe Faraday::Response do
         stub_get("address.json").
           with(
             query: {
-              app_id: @client.app_id,
-              app_key: @client.app_key,
               houseNumber: '13',
               street: 'crosby',
               borough: 'manhattan'
@@ -21,21 +19,20 @@ describe Faraday::Response do
       end
 
       it "should raise a NYCGeoClient error" do
-        lambda do
-          @client.address('13','crosby','manhattan')
-        end.should raise_error(NYCGeoClient::Error)
+        expect(lambda do
+          @client.address(house_number: '13', street: 'crosby', borough: 'manhattan')
+        end).to raise_error(NYCGeoClient::Error)
       end
 
       it "should return the status and body" do
         begin
-          @client.address('13','crosby','manhattan')
+          @client.address(house_number: '13', street: 'crosby', borough: 'manhattan')
         rescue NYCGeoClient::Error => ex
-          ex.status.should be == status
-          ex.message.split(": ").should be == [
-            "GET https://api.cityofnewyork.us/geoclient/v1/address.json?app_id=foo&app_key=bar&houseNumber=13&street=crosby&borough=manhattan",
-            "#{status}",
-            "some message"
-          ]
+          expect(ex.status).to eq status
+          parts = ex.message.split(": ")
+          expect(parts[0]).to match /GET https:\/\/api.nyc.gov\/geo\/geoclient\/v1\/address.json/
+          expect(parts[1]).to eq "#{status}"
+          expect(parts[2]).to eq "some message"
         end
       end
     end

data/spec/nyc_geo_client/api_spec.rb

@@ -22,7 +22,7 @@ describe NYCGeoClient::API do
     it "should inherit module configuration" do
       api = NYCGeoClient::API.new
       @keys.each do |key|
-        api.send(key).should == key
+        expect(api.send(key)).to eq key
       end
     end
 
@@ -30,8 +30,7 @@ describe NYCGeoClient::API do
 
       before do
         @configuration = {
-          :app_id => 'ID',
-          :app_key => 'KEY',
+          :subscription_key => 'KEY',
           :adapter => :typhoeus,
           :endpoint => 'http://tumblr.com/',
           :format => :xml,
@@ -46,7 +45,7 @@ describe NYCGeoClient::API do
         it "should override module configuration" do
           api = NYCGeoClient::API.new(@configuration)
           @keys.each do |key|
-            api.send(key).should == @configuration[key]
+            expect(api.send(key)).to eq @configuration[key]
           end
         end
 
@@ -58,10 +57,10 @@ describe NYCGeoClient::API do
             api.send("#{key}=", value)
           end
           @keys.each do |key|
-            api.send(key).should == @configuration[key]
+            expect(api.send(key)).to eq @configuration[key]
           end
         end
       end
     end
   end
-end
+end

data/spec/nyc_geo_client/client/address_spec.rb

@@ -6,38 +6,64 @@ describe NYCGeoClient::Client do
     context ".new(:format => '#{format}')" do
 
       before do
-        @client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY', format: format)
+        @client = NYCGeoClient::Client.new(subscription_key: 'KEY', format: format)
       end
 
       describe ".address" do
-        before do
-          stub_get("address.#{format}").
-            with(
-              query: {
-                app_id: @client.app_id,
-                app_key: @client.app_key,
+        context 'given a borough' do
+          before do
+            stub_get("address.#{format}").
+              with(
+                query: {
+                  houseNumber: '13',
+                  street: 'crosby',
+                  borough: 'manhattan'
+                }).
+              to_return(body: fixture("address.#{format}"), headers: {content_type: "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.address(house_number: '13', street: 'crosby', borough: 'manhattan')
+            expect(a_get("address.#{format}").
+              with(query: {
                 houseNumber: '13',
                 street: 'crosby',
                 borough: 'manhattan'
-              }).
-            to_return(body: fixture("address.#{format}"), headers: {content_type: "application/#{format}; charset=utf-8"})
-        end
+              })).to have_been_made
+          end
 
-        it "should get the correct resource" do
-          @client.address('13', 'crosby', 'manhattan')
-          a_get("address.#{format}").
-            with(query: {
-              app_id: @client.app_id,
-              app_key: @client.app_key,
-              houseNumber: '13',
-              street: 'crosby',
-              borough: 'manhattan'
-            }).should have_been_made
+          it "should return the address info" do
+            data = @client.address(house_number: '13', street: 'crosby', borough: 'manhattan')
+            expect(data.keys).to eq ["address"]
+          end
         end
 
-        it "should return the address info" do
-          data = @client.address('13', 'crosby', 'manhattan')
-          data.keys.should be == ["address"]
+        context 'given a ZIP' do
+          before do
+            stub_get("address.#{format}").
+              with(
+                query: {
+                  houseNumber: '13',
+                  street: 'crosby',
+                  zip: '10013'
+                }).
+              to_return(body: fixture("address.#{format}"), headers: {content_type: "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.address(house_number: '13', street: 'crosby', zip: '10013')
+            expect(a_get("address.#{format}").
+              with(query: {
+                houseNumber: '13',
+                street: 'crosby',
+                zip: '10013'
+              })).to have_been_made
+          end
+
+          it "should return the address info" do
+            data = @client.address(house_number: '13', street: 'crosby', zip: '10013')
+            expect(data.keys).to eq ["address"]
+          end
         end
       end
     end

data/spec/nyc_geo_client/client/bbl_spec.rb

@@ -6,7 +6,7 @@ describe NYCGeoClient::Client do
     context ".new(:format => '#{format}')" do
 
       before do
-        @client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY', format: format)
+        @client = NYCGeoClient::Client.new(subscription_key: 'KEY', format: format)
       end
 
       describe ".bbl" do
@@ -14,8 +14,6 @@ describe NYCGeoClient::Client do
           stub_get("bbl.#{format}").
             with(
               query: {
-                app_id:  @client.app_id,
-                app_key: @client.app_key,
                 borough: 'manhattan',
                 block:   '00233',
                 lot:     '0004',
@@ -24,20 +22,18 @@ describe NYCGeoClient::Client do
         end
 
         it "should get the correct resource" do
-          @client.bbl('manhattan', '00233', '0004')
-          a_get("bbl.#{format}").
+          @client.bbl(borough: 'manhattan', block: '00233', lot: '0004')
+          expect(a_get("bbl.#{format}").
             with(query: {
-              app_id:  @client.app_id,
-              app_key: @client.app_key,
               borough: 'manhattan',
               block:   '00233',
               lot:     '0004',
-            }).should have_been_made
+            })).to have_been_made
         end
 
         it "should return the bbl info" do
-          data = @client.bbl('manhattan', '00233', '0004')
-          data.keys.should be == ["bbl"]
+          data = @client.bbl(borough: 'manhattan', block: '00233', lot: '0004')
+          expect(data.keys).to eq ["bbl"]
         end
       end
     end

data/spec/nyc_geo_client/client/bin_spec.rb

@@ -6,7 +6,7 @@ describe NYCGeoClient::Client do
     context ".new(:format => '#{format}')" do
 
       before do
-        @client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY', format: format)
+        @client = NYCGeoClient::Client.new(subscription_key: 'KEY', format: format)
       end
 
       describe ".bin" do
@@ -14,26 +14,22 @@ describe NYCGeoClient::Client do
           stub_get("bin.#{format}").
             with(
               query: {
-                app_id:  @client.app_id,
-                app_key: @client.app_key,
                 bin:     '1003041',
               }).
             to_return(body: fixture("bin.#{format}"), headers: {content_type: "application/#{format}; charset=utf-8"})
         end
 
         it "should get the correct resource" do
-          @client.bin('1003041')
-          a_get("bin.#{format}").
+          @client.bin(bin: '1003041')
+          expect(a_get("bin.#{format}").
             with(query: {
-              app_id:  @client.app_id,
-              app_key: @client.app_key,
               bin:     '1003041',
-            }).should have_been_made
+            })).to have_been_made
         end
 
         it "should return the bin info" do
-          data = @client.bin('1003041')
-          data.keys.should be == ["bin"]
+          data = @client.bin(bin: '1003041')
+          expect(data.keys).to eq ["bin"]
         end
       end
     end

data/spec/nyc_geo_client/client/blockface_spec.rb

@@ -6,7 +6,7 @@ describe NYCGeoClient::Client do
     context ".new(:format => '#{format}')" do
 
       before do
-        @client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY', format: format)
+        @client = NYCGeoClient::Client.new(subscription_key: 'KEY', format: format)
       end
 
       describe ".blockface" do
@@ -14,8 +14,6 @@ describe NYCGeoClient::Client do
           stub_get("blockface.#{format}").
             with(
               query: {
-                app_id:  @client.app_id,
-                app_key: @client.app_key,
                 onStreet: '34 st',
                 crossStreetOne: 'fifth ave',
                 crossStreetTwo: 'sixth ave',
@@ -26,22 +24,34 @@ describe NYCGeoClient::Client do
         end
 
         it "should get the correct resource" do
-          @client.blockface('34 st', 'fifth ave', 'sixth ave', 'manhattan', {compassDirection: 'north'})
-          a_get("blockface.#{format}").
+          @client.blockface(
+            on_street: '34 st',
+            cross_street_one: 'fifth ave',
+            cross_street_two: 'sixth ave',
+            borough: 'manhattan',
+            compass_direction: 'north'
+          )
+
+          expect(a_get("blockface.#{format}").
             with(query: {
-              app_id:  @client.app_id,
-              app_key: @client.app_key,
               onStreet: '34 st',
               crossStreetOne: 'fifth ave',
               crossStreetTwo: 'sixth ave',
               borough: 'manhattan',
               compassDirection: 'north'
-            }).should have_been_made
+            })).to have_been_made
         end
 
         it "should return the blockface info" do
-          data = @client.blockface('34 st', 'fifth ave', 'sixth ave', 'manhattan', {compassDirection: 'north'})
-          data.keys.should be == ["blockface"]
+          data = @client.blockface(
+            on_street: '34 st',
+            cross_street_one: 'fifth ave',
+            cross_street_two: 'sixth ave',
+            borough: 'manhattan',
+            compass_direction: 'north'
+          )
+
+          expect(data.keys).to eq ["blockface"]
         end
       end
     end

data/spec/nyc_geo_client/client/intersection_spec.rb

@@ -6,7 +6,7 @@ describe NYCGeoClient::Client do
     context ".new(:format => '#{format}')" do
 
       before do
-        @client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY', format: format)
+        @client = NYCGeoClient::Client.new(subscription_key: 'KEY', format: format)
       end
 
       describe ".intersection" do
@@ -14,8 +14,6 @@ describe NYCGeoClient::Client do
           stub_get("intersection.#{format}").
             with(
               query: {
-                app_id:  @client.app_id,
-                app_key: @client.app_key,
                 crossStreetOne: '34 st',
                 crossStreetTwo: 'fifth ave',
                 borough: 'manhattan',
@@ -25,21 +23,31 @@ describe NYCGeoClient::Client do
         end
 
         it "should get the correct resource" do
-          @client.intersection('34 st', 'fifth ave', 'manhattan', {compassDirection: 'north'})
-          a_get("intersection.#{format}").
+          @client.intersection(
+            cross_street_one: '34 st',
+            cross_street_two: 'fifth ave',
+            borough: 'manhattan',
+            compass_direction: 'north'
+          )
+
+          expect(a_get("intersection.#{format}").
             with(query: {
-              app_id:  @client.app_id,
-              app_key: @client.app_key,
               crossStreetOne: '34 st',
               crossStreetTwo: 'fifth ave',
               borough: 'manhattan',
               compassDirection: 'north'
-            }).should have_been_made
+            })).to have_been_made
         end
 
         it "should return the intersection info" do
-          data = @client.intersection('34 st', 'fifth ave', 'manhattan', {compassDirection: 'north'})
-          data.keys.should be == ["intersection"]
+          data = @client.intersection(
+            cross_street_one: '34 st',
+            cross_street_two: 'fifth ave',
+            borough: 'manhattan',
+            compass_direction: 'north'
+          )
+
+          expect(data.keys).to eq ["intersection"]
         end
       end
     end

data/spec/nyc_geo_client/client/place_spec.rb

@@ -6,36 +6,60 @@ describe NYCGeoClient::Client do
     context ".new(:format => '#{format}')" do
 
       before do
-        @client = NYCGeoClient::Client.new(app_id: 'ID', app_key: 'KEY', format: format)
+        @client = NYCGeoClient::Client.new(subscription_key: 'KEY', format: format)
       end
 
       describe ".place" do
-        before do
-          stub_get("place.#{format}").
-            with(
-              query: {
-                app_id:  @client.app_id,
-                app_key: @client.app_key,
+        context 'given a borough' do
+          before do
+            stub_get("place.#{format}").
+              with(
+                query: {
+                  name:    'empire state building',
+                  borough: 'manhattan'
+                }).
+              to_return(body: fixture("place.#{format}"), headers: {content_type: "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.place(name: 'empire state building', borough: 'manhattan')
+            expect(a_get("place.#{format}").
+              with(query: {
                 name:    'empire state building',
                 borough: 'manhattan'
-              }).
-            to_return(body: fixture("place.#{format}"), headers: {content_type: "application/#{format}; charset=utf-8"})
-        end
+              })).to have_been_made
+          end
 
-        it "should get the correct resource" do
-          @client.place('empire state building', 'manhattan')
-          a_get("place.#{format}").
-            with(query: {
-              app_id:  @client.app_id,
-              app_key: @client.app_key,
-              name:    'empire state building',
-              borough: 'manhattan'
-            }).should have_been_made
+          it "should return the place info" do
+            data = @client.place(name: 'empire state building', borough: 'manhattan')
+            expect(data.keys).to eq ["place"]
+          end
         end
 
-        it "should return the place info" do
-          data = @client.place('empire state building', 'manhattan')
-          data.keys.should be == ["place"]
+        context 'given a zip' do
+          before do
+            stub_get("place.#{format}").
+              with(
+                query: {
+                  name: 'empire state building',
+                  zip: '10118'
+                }).
+              to_return(body: fixture("place.#{format}"), headers: {content_type: "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.place(name: 'empire state building', zip: '10118')
+            expect(a_get("place.#{format}").
+              with(query: {
+                name: 'empire state building',
+                zip: '10118'
+              })).to have_been_made
+          end
+
+          it "should return the place info" do
+            data = @client.place(name: 'empire state building', zip: '10118')
+            expect(data.keys).to eq ["place"]
+          end
         end
       end
     end

data/spec/nyc_geo_client/client_spec.rb

@@ -5,7 +5,7 @@ describe NYCGeoClient::Client do
     client = NYCGeoClient::Client.new
     endpoint = URI.parse(client.endpoint)
     connection = client.send(:connection).build_url(nil).to_s
-    (connection + '/').should == endpoint.to_s
+    expect(connection).to eq endpoint.to_s
   end
 
 end

data/spec/nyc_geo_client_spec.rb

@@ -19,76 +19,86 @@ describe NYCGeoClient do
       end
 
     it "should get the correct resource" do
-      NYCGeoClient.address('13', 'crosby', 'manhattan')
-      a_get("address.json").
+      NYCGeoClient.address(house_number: '13', street: 'crosby', borough: 'manhattan')
+      expect(a_get("address.json").
         with(query: {
           houseNumber: '13',
           street: 'crosby',
           borough: 'manhattan'
-        }).should have_been_made
+        })).to have_been_made
     end
 
      it "should return the same results as a client" do
-       NYCGeoClient.address('13', 'crosby', 'manhattan').should == NYCGeoClient::Client.new.address('13', 'crosby', 'manhattan')
+      expect(
+        NYCGeoClient.address(
+          house_number: '13',
+          street: 'crosby',
+          borough: 'manhattan'
+        )
+      ).to eq NYCGeoClient::Client.new.address(
+        house_number: '13',
+        street: 'crosby',
+        borough: 'manhattan'
+      )
      end
 
    end
 
   describe ".client" do
     it "should be a NYCGeoClient::Client" do
-      NYCGeoClient.client.should be_a NYCGeoClient::Client
+      expect(NYCGeoClient.client).to be_a NYCGeoClient::Client
     end
   end
 
   describe ".adapter" do
     it "should return the default adapter" do
-      NYCGeoClient.adapter.should == NYCGeoClient::Configuration::DEFAULT_ADAPTER
+      expect(NYCGeoClient.adapter).to eq NYCGeoClient::Configuration::DEFAULT_ADAPTER
     end
   end
 
   describe ".adapter=" do
     it "should set the adapter" do
       NYCGeoClient.adapter = :typhoeus
-      NYCGeoClient.adapter.should == :typhoeus
+      expect(NYCGeoClient.adapter).to eq :typhoeus
     end
   end
 
   describe ".endpoint" do
     it "should return the default endpoint" do
-      NYCGeoClient.endpoint.should == NYCGeoClient::Configuration::DEFAULT_ENDPOINT
+      expect(NYCGeoClient.endpoint).to eq NYCGeoClient::Configuration::DEFAULT_ENDPOINT
     end
   end
 
   describe ".endpoint=" do
     it "should set the endpoint" do
       NYCGeoClient.endpoint = 'http://tumblr.com'
-      NYCGeoClient.endpoint.should == 'http://tumblr.com'
+      expect(NYCGeoClient.endpoint).to eq 'http://tumblr.com'
     end
   end
 
   describe ".format" do
     it "should return the default format" do
-      NYCGeoClient.format.should == NYCGeoClient::Configuration::DEFAULT_FORMAT
+      expect(NYCGeoClient.format).to eq NYCGeoClient::Configuration::DEFAULT_FORMAT
     end
   end
 
   describe ".format=" do
     it "should set the format" do
       NYCGeoClient.format = 'xml'
-      NYCGeoClient.format.should == 'xml'
+      expect(NYCGeoClient.format).to eq 'xml'
     end
   end
 
   describe ".user_agent" do
     it "should return the default user agent" do
-      NYCGeoClient.user_agent.should == NYCGeoClient::Configuration::DEFAULT_USER_AGENT
+      expect(NYCGeoClient.user_agent).to eq NYCGeoClient::Configuration::DEFAULT_USER_AGENT
     end
   end
 
   describe ".user_agent=" do
     it "should set the user_agent" do
       NYCGeoClient.user_agent = 'Custom User Agent'
-      NYCGeoClient.user_agent.should == 'Custom User Agent'
+      expect(NYCGeoClient.user_agent).to eq 'Custom User Agent'
     end
   end
 
@@ -99,10 +109,9 @@ describe NYCGeoClient do
       it "should set the #{key}" do
         NYCGeoClient.configure do |config|
           config.send("#{key}=", key)
-          NYCGeoClient.send(key).should == key
+          expect(NYCGeoClient.send(key)).to eq key
         end
       end
     end
   end
-
-end
+end

data/spec/spec_helper.rb

@@ -4,9 +4,6 @@ require 'rspec'
 require 'webmock/rspec'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
   config.include WebMock::API
 end
 

metadata

@@ -1,155 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: nyc_geo_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Edgar Gonzalez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.3
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.3
-- !ruby/object:Gem::Dependency
-  name: bluecloth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.9.26
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 1.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 4.1.0
 description: A ruby wrapper for NYCGeoClient API
 email:
 - edgargonzalez@gmail.com
@@ -157,8 +143,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -212,17 +198,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for NYCGeoClient API
@@ -251,4 +236,3 @@ test_files:
 - spec/nyc_geo_client/client_spec.rb
 - spec/nyc_geo_client_spec.rb
 - spec/spec_helper.rb
-has_rdoc: