smartystreets_ruby_sdk 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535dcd015e5d60cfb19fceef8fcaaf21571bc32a1273e59f8b21b3fcb71e7361
-  data.tar.gz: f994e9282f74263c7fbdc411c7a90cc5a41f04cdfe58fd7d5a41668e8ce90090
+  metadata.gz: 52fd48c6c51199f3dcd357a5acc5f6bc16a6ea53ed8d5467be6a00bfe5abb864
+  data.tar.gz: faebc7c05c2e636c6c7b0cc687d24970abf7b1a695c8d4d68a03d5a62e8e46c1
 SHA512:
-  metadata.gz: 503dd289bba672c6068784ca929a14b265a57f80f30e5faa9840a3962b67937c0a200e8ad450783077723d0eff1ff8e7681dafc6a4d98d4fe6ac68171ac17cf8
-  data.tar.gz: ea7e7babd854b053bdda4ddfc43ad88f47c6b12ed26a53f2681b72635a191b46b3e70e46c5cd15d292d146d8ba546251acf129e4dcb81260bb499d1b499c36dc
+  metadata.gz: b0d0d14bd4b4e8846f588b3743f7fc1fe026d3cb5270935885cde1d371d85bc01342b2a1b8cb62a4220392d064e5a76fb375fe497ee5400b2ccb1d59832a8a45
+  data.tar.gz: 8270d077871bf469999c5a864f58374f78000276ad4cbdcc85cc395d43c40f3d7152a71e4aa7c4ed7e8cd1d0731b24c5031557d417cb30891aedc2033a9d71cc

data/examples/us_reverse_geo_example.rb

@@ -0,0 +1,42 @@
+require 'smartystreets_ruby_sdk/static_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_reverse_geo/lookup'
+
+class USReverseGeoExample
+  Lookup = SmartyStreets::USReverseGeo::Lookup
+
+  def run
+    auth_id = 'Your SmartyStreets Auth ID here'
+    auth_token = 'Your SmartyStreets Auth Token here'
+
+    # We recommend storing your secret keys in environment variables instead---it's safer!
+    # auth_id = ENV['SMARTY_AUTH_ID']
+    # auth_token = ENV['SMARTY_AUTH_TOKEN']
+
+    credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
+    client = SmartyStreets::ClientBuilder.new(credentials)
+                 .build_us_reverse_geo_api_client
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-reverse-geo-api#http-request-input-fields
+
+    lookup = Lookup.new(40.111111, -111.111111)
+
+    response = client.send(lookup)
+    result = response.results[0]
+
+    coordinate = result.coordinate
+    puts "Latitude: #{coordinate.latitude}"
+    puts "Longitude: #{coordinate.longitude}\n"
+
+    puts "Distance: #{result.distance}\n"
+
+    address = result.address
+    puts "Street: #{address.street}"
+    puts "City: #{address.city}"
+    puts "State Abbreviation: #{address.state_abbreviation}"
+    puts "ZIP Code: #{address.zipcode}"
+  end
+end
+
+USReverseGeoExample.new.run

data/lib/smartystreets_ruby_sdk.rb

@@ -26,6 +26,7 @@ require 'smartystreets_ruby_sdk/us_street'
 require 'smartystreets_ruby_sdk/us_zipcode'
 require 'smartystreets_ruby_sdk/us_autocomplete'
 require 'smartystreets_ruby_sdk/international_street'
+require 'smartystreets_ruby_sdk/us_reverse_geo'
 
 module SmartyStreets
 end

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -14,6 +14,7 @@ require_relative 'us_zipcode/client'
 require_relative 'us_extract/client'
 require_relative 'us_autocomplete/client'
 require_relative 'international_street/client'
+require_relative 'us_reverse_geo/client'
 
 module SmartyStreets
   # The ClientBuilder class helps you build a client object for one of the supported SmartyStreets APIs.
@@ -25,6 +26,7 @@ module SmartyStreets
     US_EXTRACT_API_URL = 'https://us-extract.api.smartystreets.com/'.freeze
     US_STREET_API_URL = 'https://us-street.api.smartystreets.com/street-address'.freeze
     US_ZIP_CODE_API_URL = 'https://us-zipcode.api.smartystreets.com/lookup'.freeze
+    US_REVERSE_GEO_API_URL = 'https://us-reverse-geo.api.smartystreets.com/lookup'.freeze
 
     def initialize(signer)
       @signer = signer
@@ -141,6 +143,11 @@ module SmartyStreets
       USZipcode::Client.new(build_sender, @serializer)
     end
 
+    def build_us_reverse_geo_api_client
+      ensure_url_prefix_not_null(US_REVERSE_GEO_API_URL)
+      USReverseGeo::Client.new(build_sender, @serializer)
+    end
+
     # </editor-fold>
 
     def build_sender

data/lib/smartystreets_ruby_sdk/us_reverse_geo.rb

@@ -0,0 +1,12 @@
+require_relative './us_reverse_geo/address'
+require_relative './us_reverse_geo/client'
+require_relative './us_reverse_geo/coordinate'
+require_relative './us_reverse_geo/lookup'
+require_relative './us_reverse_geo/result'
+require_relative './us_reverse_geo/us_reverse_geo_response'
+
+module SmartyStreets
+  module USReverseGeo
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_reverse_geo/address.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USReverseGeo
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#address"
+    class Address
+      attr_reader :street, :city, :state_abbreviation, :zipcode
+
+      def initialize(obj)
+        @street = obj['street']
+        @city = obj['city']
+        @state_abbreviation = obj['state_abbreviation']
+        @zipcode = obj['zipcode']
+      end
+    end
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_reverse_geo/client.rb

@@ -0,0 +1,38 @@
+require_relative '../request'
+require_relative 'us_reverse_geo_response'
+
+module SmartyStreets
+  module USReverseGeo
+    # It is recommended to instantiate this class using ClientBuilder.build_us_reverse_geo_api_client()
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the US Reverse Geo API and stores the result in the Lookup's response field.
+      def send(lookup)
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        lookup.response = Response.new(@serializer.deserialize(response.payload))
+      end
+
+      def build_request(lookup)
+        request = SmartyStreets::Request.new
+
+        add_parameter(request, 'latitude', lookup.latitude)
+        add_parameter(request, 'longitude', lookup.longitude)
+
+        request
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_reverse_geo/coordinate.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USReverseGeo
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#coordinate"
+    class Coordinate
+      attr_reader :latitude, :longitude, :accuracy, :license
+
+      def initialize(obj)
+        @latitude = obj.fetch('latitude', nil)
+        @longitude = obj.fetch('longitude', nil)
+        @accuracy = obj.fetch('accuracy', nil)
+        @license = obj.fetch('license', nil)
+      end
+    end
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_reverse_geo/lookup.rb

@@ -0,0 +1,21 @@
+module SmartyStreets
+  module USReverseGeo
+    # In addition to holding all of the input data for this lookup, this class also will contain the
+    # result of the lookup after it comes back from the API.
+    #
+    # Note: Lookups must have certain required fields set with non-blank values.
+    # These can be found at the URL below.
+    #
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#http-request-input-fields"
+
+    class Lookup
+
+      attr_accessor :latitude, :longitude, :response
+
+      def initialize(latitude, longitude)
+        @latitude = sprintf('%.8f', latitude)
+        @longitude = sprintf('%.8f', longitude)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_reverse_geo/result.rb

@@ -0,0 +1,20 @@
+require_relative 'coordinate'
+require_relative 'address'
+
+module SmartyStreets
+  module USReverseGeo
+    # A result is a possible match for an geocode that was submitted. A lookup can have multiple results.
+    #
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#result"
+    class Result
+      attr_reader :address, :coordinate, :distance
+
+      def initialize(obj)
+        @address = Address.new(obj.fetch('address', {}))
+        @coordinate = Coordinate.new(obj.fetch('coordinate', {}))
+        @distance = obj['distance']
+      end
+    end
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_reverse_geo/us_reverse_geo_response.rb

@@ -0,0 +1,17 @@
+require_relative 'result'
+
+module SmartyStreets
+  module USReverseGeo
+    class Response
+      attr_reader :results
+
+      def initialize(obj)
+        @results = []
+
+        obj['results'].each do |result|
+          @results.push(Result.new(result))
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.8.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.9.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 5.8.0
+  version: 5.9.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,6 +93,7 @@ files:
 - examples/international_example.rb
 - examples/us_autocomplete_example.rb
 - examples/us_extract_example.rb
+- examples/us_reverse_geo_example.rb
 - examples/us_street_multiple_address_example.rb
 - examples/us_street_single_address_example.rb
 - examples/us_zipcode_multiple_lookup_example.rb
@@ -139,6 +140,13 @@ files:
 - lib/smartystreets_ruby_sdk/us_extract/lookup.rb
 - lib/smartystreets_ruby_sdk/us_extract/metadata.rb
 - lib/smartystreets_ruby_sdk/us_extract/result.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo/address.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo/client.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo/coordinate.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo/lookup.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo/result.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo/us_reverse_geo_response.rb
 - lib/smartystreets_ruby_sdk/us_street.rb
 - lib/smartystreets_ruby_sdk/us_street/analysis.rb
 - lib/smartystreets_ruby_sdk/us_street/candidate.rb