smartystreets_ruby_sdk 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5a4cbefe11b18791ae311d7f78bf3c74a9ae0ff05857d36e775f1341128fb75
+  data.tar.gz: 0bd00361cee6dd7428cf8c0edd375cc7fa9a308c679340197c838827addd0413
+SHA512:
+  metadata.gz: bc4f3a3e49f8a8cf856857cbe08526c0f2ef3205b60669c83fa3f4fc486f5d50d01491a28adcc507aab11904fb139d4ca77bf608f80e7ce3ace743169462e5f3
+  data.tar.gz: 4277f3287956cd54754fd2a33c291b7615f8a6651100adfcb5c3bf47dbb693372bbcc75e41f03857a7483a8500d7ada2b18c875c0df45db554edd2869df9fe18

data/.github/workflows/gem-publish.yml

@@ -0,0 +1,58 @@
+name: Ruby Gem Publish
+
+on:
+  push:
+    tags: 
+      - '*'
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    env:
+      GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+    
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # need all the commits
+      
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          bundler-cache: false
+      
+      - uses: actions/setup-node@v2
+      
+      - name: Clean
+        run: |
+          rm -f *.gem
+          git checkout lib/smartystreets_ruby_sdk/version.rb
+      
+      - name: Dependencies
+        run: |
+          gem install minitest
+      
+      - name: Test
+        run: |
+          rake test
+      
+      - name: Set Environment Variable
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+      - name: Grab Version
+        run: |
+          echo "VERSION = \"${{ env.RELEASE_VERSION }}\"" >> version.rb \
+          && cat version.rb \
+#          && gem build *.gemspec \
+#          && git checkout version.rb
+     
+      - name: Push to rubygems.org
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+#          chmod 0600 /root/.gem/credentials
+        env:
+          GEM_HOST_API_KEY: "${{secrets.GEM_HOST_API_KEY}}"

data/.gitignore

@@ -0,0 +1,4 @@
+*.lock
+.idea
+coverage
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+See the changelog repository:
+
+github.com/smartystreets/changelog/blob/master/sdk/ruby.md

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:alpine
+
+COPY . /code
+WORKDIR /code
+
+RUN apk add -U make git && make dependencies \
+	&& wget -O - "https://github.com/smartystreets/version-tools/releases/download/0.0.6/release.tar.gz" | tar -xz -C /usr/local/bin/
+
+ARG RUBYGEMS_API_KEY
+RUN mkdir -p ~/.gem && umask 0277 && echo "${RUBYGEMS_API_KEY}" > ~/.gem/credentials

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smartystreets_ruby_sdk.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Smarty
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile

@@ -0,0 +1,33 @@
+#!/usr/bin/make -f
+
+VERSION       := $(shell tagit -p --dry-run)
+VERSION_FILE  := lib/smartystreets_ruby_sdk/version.rb
+
+clean:
+	rm -f *.gem
+	git checkout "$(VERSION_FILE)"
+
+test:
+	rake test
+
+dependencies:
+	gem install minitest
+
+package: clean dependencies test
+	sed -i "s/0\.0\.0/$(VERSION)/g" "$(VERSION_FILE)" \
+		&& gem build *.gemspec \
+		&& git checkout "$(VERSION_FILE)"
+
+publish: package
+	chmod 0600 /root/.gem/credentials
+	gem push *.gem
+
+#####################################################################
+
+workspace:
+	docker-compose run sdk /bin/sh
+
+release:
+	docker-compose run sdk make publish && tagit -p && git push origin --tags
+
+.PHONY: clean test dependencies package publish workspace release

data/README.md

@@ -0,0 +1,31 @@
+# SMARTY DISCLAIMER: Subject to the terms of the associated license agreement, this software is freely available for your use. This software is FREE, AS IN PUPPIES, and is a gift. Enjoy your new responsibility. This means that while we may consider enhancement requests, we may or may not choose to entertain requests at our sole and absolute discretion.
+
+# SmartyStreets Ruby SDK
+
+The official client libraries for accessing SmartyStreets APIs from Ruby
+
+You may have noticed this page is curiously sparse. Don't panic, there's [documentation](https://smartystreets.com/docs/sdk/ruby) and [examples](examples).
+
+[Apache 2.0 License](LICENSE.txt)
+
+---
+
+[![asciicast](https://asciinema.org/a/124457.png)](https://asciinema.org/a/124457)
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smartystreets_ruby_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smartystreets_ruby_sdk    

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.pattern = 'test/**/test_*.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smartystreets_ruby_sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3.7'
+services:
+  sdk:
+    build:
+      context: .
+      args:
+        - RUBYGEMS_API_KEY
+    volumes: 
+      - .:/code
+    environment:
+      - SMARTY_AUTH_ID
+      - SMARTY_AUTH_TOKEN

data/examples/international_autocomplete_example.rb

@@ -0,0 +1,47 @@
+require 'smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/international_autocomplete/lookup'
+require '../lib/smartystreets_ruby_sdk/international_autocomplete/client'
+
+class InternationalAutocompleteExample
+  Lookup = SmartyStreets::InternationalAutocomplete::Lookup
+
+  def run
+    # key = 'Your SmartyStreets Auth ID here'
+    # hostname = 'Your SmartyStreets Auth Token here'
+
+    # We recommend storing your secret keys in environment variables instead---it's safer!
+    key = ENV['SMARTY_AUTH_WEB']
+    referer = ENV['SMARTY_AUTH_REFERER']
+
+    credentials = SmartyStreets::SharedCredentials.new(key, referer)
+
+    # The appropriate license values to be used for your subscriptions
+    # can be found on the Subscriptions page of the account dashboard.
+    # https://www.smartystreets.com/docs/cloud/licensing
+    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['international-autocomplete-cloud'])
+                 .build_international_autocomplete_api_client
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-autocomplete-api
+
+    lookup = Lookup.new('Louis')
+    lookup.country = "FRA"
+    lookup.locality = "Paris"
+
+    suggestions = client.send(lookup) # The client will also return the suggestions directly
+
+    puts
+    puts '*** Result with some filters ***'
+    puts
+
+    suggestions.each do |suggestion|
+      puts "#{suggestion.street} #{suggestion.locality}, #{suggestion.country_iso3}"
+    end
+
+  end
+end
+
+InternationalAutocompleteExample.new.run
+
+

data/examples/international_example.rb

@@ -0,0 +1,53 @@
+require 'smartystreets_ruby_sdk/static_credentials'
+require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/international_street/lookup'
+
+class InternationalExample
+  Lookup = SmartyStreets::InternationalStreet::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)
+
+    # The appropriate license values to be used for your subscriptions
+    # can be found on the Subscriptions page of the account dashboard.
+    # https://www.smartystreets.com/docs/cloud/licensing
+    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['international-global-plus-cloud'])
+                 .build_international_street_api_client
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/international-street-api
+
+    lookup = Lookup.new()
+    lookup.inputId = 'ID-8675309' # Optional ID from your system
+    lookup.geocode = true # Must be expressly set to get latitude and longitude.
+    lookup.organization = 'John Doe'
+    lookup.address1 = "Rua Padre Antonio D'Angelo 121"
+    lookup.address2 = 'Casa Verde'
+    lookup.locality = 'Sao Paulo'
+    lookup.administrative_area = 'SP'
+    lookup.country = 'Brazil'
+    lookup.postal_code = '02516-050'
+
+    candidates = client.send(lookup) # The candidates are also stored in the lookup's 'result' field.
+
+    first_candidate = candidates[0]
+    puts "Input ID: #{first_candidate.input_id}"
+    puts "Address is #{first_candidate.analysis.verification_status}"
+    puts "Address precision: #{first_candidate.analysis.address_precision}\n\n"
+    puts "First Line: #{first_candidate.address1}"
+    puts "Second Line: #{first_candidate.address2}"
+    puts "Third Line: #{first_candidate.address3}"
+    puts "Fourth Line: #{first_candidate.address4}"
+    puts "Latitude: #{first_candidate.metadata.latitude}"
+    puts "Longitude: #{first_candidate.metadata.longitude}"
+  end
+end
+
+InternationalExample.new.run

data/examples/us_autocomplete_pro_example.rb

@@ -0,0 +1,56 @@
+require 'smartystreets_ruby_sdk/shared_credentials'
+require 'smartystreets_ruby_sdk/static_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup'
+
+class USAutocompleteProExample
+  Lookup = SmartyStreets::USAutocompletePro::Lookup
+
+  def run
+    # key = 'Your SmartyStreets Auth ID here'
+    # hostname = 'Your SmartyStreets Auth Token here'
+
+    # We recommend storing your secret keys in environment variables instead---it's safer!
+    key = ENV['SMARTY_AUTH_WEB']
+    referer = ENV['SMARTY_AUTH_REFERER']
+
+    credentials = SmartyStreets::SharedCredentials.new(key, referer)
+
+    # auth_id = ENV['SMARTY_AUTH_ID']
+    # auth_token = ENV['SMARTY_AUTH_TOKEN']
+    #
+    # credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
+
+    # The appropriate license values to be used for your subscriptions
+    # can be found on the Subscriptions page of the account dashboard.
+    # https://www.smartystreets.com/docs/cloud/licensing
+    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['us-autocomplete-pro-cloud'])
+                 .build_us_autocomplete_pro_api_client
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-autocomplete-api
+
+    lookup = Lookup.new('1042 W Center')
+    lookup.add_state_filter('CO')
+    lookup.add_state_filter('UT')
+    lookup.add_city_filter('Denver')
+    lookup.add_city_filter('Orem')
+    lookup.max_results = 5
+    lookup.prefer_ratio = 3
+    lookup.source = "all"
+
+    suggestions = client.send(lookup) # The client will also return the suggestions directly
+
+    puts
+    puts '*** Result with some filters ***'
+    puts
+
+    suggestions.each do |suggestion|
+      puts "#{suggestion.street_line} #{suggestion.city}, #{suggestion.state}"
+    end
+
+  end
+end
+
+USAutocompleteProExample.new.run
+

data/examples/us_extract_example.rb

@@ -0,0 +1,63 @@
+require 'smartystreets_ruby_sdk/static_credentials'
+require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/us_extract/lookup'
+
+class USExtractExample
+  Lookup = SmartyStreets::USExtract::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_extract_api_client
+
+    text = "Here is some text.\r\nMy address is 3785 Las Vegs Av." \
+           "\r\nLos Vegas, Nevada." \
+           "\r\nMeet me at 1 Rosedale Baltimore Maryland, not at 123 Phony Street, Boise Idaho."
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-extract-api
+
+    lookup = Lookup.new(text)
+    lookup.aggressive = true
+    lookup.addresses_have_line_breaks = false
+    lookup.addresses_per_line = 2
+
+    result = client.send(lookup)
+
+    metadata = result.metadata
+    puts "Found #{metadata.address_count} addresses."
+    puts "#{metadata.verified_count} of them were valid."
+    puts
+
+    addresses = result.addresses
+
+    puts "Addresses: \r\n**********************\r\n"
+    addresses.each do |address|
+      puts "\"#{address.text}\"\n\n"
+      puts "Verified? #{address.verified}"
+      if address.candidates.any?
+        puts("\nMatches:")
+
+        address.candidates.each do |candidate|
+          puts candidate.delivery_line_1
+          puts candidate.last_line
+          puts
+        end
+
+      else
+        puts
+      end
+
+      puts "**********************\n"
+    end
+  end
+end
+
+USExtractExample.new.run