usps-proxy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78f73a0f353f4c4e347b9faad52ee5278c1f2831
+  data.tar.gz: 95c73e8af6d4e161b1c5dfe84f8b366481aba4ca
+SHA512:
+  metadata.gz: 2196068af5b5c2c1a4e069331ccfe75b95a38c5cab738df01a710bd4747e797e8fccb0199ed5be4d3074c69562b7c99d2e03caa24447f2b640af0be1b9bd963e
+  data.tar.gz: 16068e817a742ed02390484ed6f62a5907a4b578152d63782baf004a45ef06b5e7499517c598accfc032495f6e13c6656deedefbaca7eaf0b8a90629c8cb9d04

data/.env.example

@@ -0,0 +1 @@
+USPS_USER="your api key"

data/.gitignore

@@ -0,0 +1,36 @@
+.env
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+## Welcome!
+
+We're so glad you're thinking about contributing to an 18F open source project! If you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contribution, and don't want a wall of rules to get in the way of that.
+
+Before contributing, we encourage you to read our CONTRIBUTING policy (you are here), our LICENSE, and our README, all of which should be in this repository. If you have any questions, or want to read more about our underlying policies, you can consult the 18F Open Source Policy GitHub repository at https://github.com/18f/open-source-policy, or just shoot us an email/official government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
+
+## Public domain
+
+This project is in the public domain within the United States, and
+copyright and related rights in the work worldwide are waived through
+the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    usps-proxy (0.0.1)
+      dotenv
+      sinatra
+      thin
+      usps (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    coderay (1.1.0)
+    daemons (1.1.9)
+    dotenv (1.0.2)
+    ethon (0.7.1)
+      ffi (>= 1.3.0)
+    eventmachine (1.0.3)
+    ffi (1.9.6)
+    method_source (0.8.2)
+    mini_portile (0.6.1)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.6.0)
+    thin (1.6.3)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0)
+      rack (~> 1.0)
+    tilt (1.4.1)
+    typhoeus (0.6.9)
+      ethon (>= 0.7.1)
+    usps (0.1.3)
+      builder (>= 2.1.2)
+      nokogiri (>= 1.4.1)
+      typhoeus (>= 0.1.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake (~> 10.0)
+  usps-proxy!

data/LICENSE.md

@@ -0,0 +1,31 @@
+As a work of the United States Government, this project is in the
+public domain within the United States.
+
+Additionally, we waive copyright and related rights in the work
+worldwide through the CC0 1.0 Universal public domain dedication.
+
+## CC0 1.0 Universal Summary
+
+This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
+
+### No Copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.
+
+### Other Information
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.

data/README.md

@@ -0,0 +1,159 @@
+# usps-proxy
+
+A Sinatra server that makes the USPS API a tad easier to consume on the client-side.
+
+This gem sits alongside the namespace created by the [`USPS` gem](https://github.com/gaffneyc/usps).
+
+## Why?
+
+- The USPS API is XML-based. This gem makes it JSON-accessible.
+- Keep API keys completely secret
+- Monitor and throttle client-side requests to USPS's servers (tbd)
+
+## What is supported?
+
+This is still a work-in-progress, but there is basic support for:
+
+- city/state lookup
+- address standardization/verification
+
+## Usage
+
+### As part of a Rails app
+
+In `Gemfile`:
+
+```ruby
+gem 'usps-proxy', github: '18F/usps-proxy', branch: 'master'
+```
+
+By default, `USPS::Proxy` will look for the `USPS_USER` environment variable. However, you can override this in `config/initializers/[production|development|test].rb`:
+
+```ruby
+USPS.username = 'your usps username'
+```
+
+(note that this is a method on the [`USPS` gem](https://github.com/gaffneyc/usps) and not this gem)
+
+USPS offers several APIs. You likely won't need to use all of them. Because of that, `USPS::Proxy` allows you to mix and match them:
+
+In `config/routes.rb`:
+
+```ruby
+scope '/usps' do
+  mount USPS::Proxy::CityState, at: '/city_state'
+  mount USPS::Proxy::AddressStandardization, at: '/address_standardixation'
+end
+```
+
+Each API is its own mini `Sinatra` application with a single route, `'/'`.
+
+### Standalone
+
+Clone this repo and `cd` into it.
+
+Edit `config.ru` as needed. Also be sure your `USPS_USER` environment variable is set (or user the `USPS.username` *somewhere* before the app runs).
+
+```ruby
+require './lib/usps-proxy'
+
+run Rack::URLMap.new(
+  '/city_state' => USPS::Proxy::CityState,
+  '/address_standardization' => USPS::Proxy::AddressStandardization
+)
+```
+
+```
+$ bundle
+$ bundle exec thin start
+```
+
+### APIs
+
+#### City/State Lookup
+
+GET `/city_state`
+
+Request params (in the query string):
+
+- `zip5` *required*
+
+Example path: `/city_state?zip5=20006`
+
+Example response:
+
+```javascript
+{
+    "results": {
+        "20008": {
+            "zip": 20008,
+            "city": "WASHINGTON",
+            "state": "DC"
+        }
+    }
+}
+```
+
+#### Address Standardization/Verification
+
+GET `/address_standardization`
+
+Request params (in the query string):
+
+- `firm`
+- `address1` *required*
+- `address2`
+- `city` *required*
+- `state` *required*
+- `zip5` *required*
+- `zip4`
+
+Example path: `/address_standardization?address1=1800%20F%20street%20NW&city=washington&state=DC&zip5=20006`
+
+Example response:
+
+```javascript
+{
+    "results": [
+        {
+            "name": null,
+            "company": "",
+            "address1": "1901 F ST NW",
+            "address2": "",
+            "city": "WASHINGTON",
+            "state": "DC",
+            "zip5": "20006",
+            "zip4": "",
+            "return_text": ""
+        }
+    ]
+}
+```
+
+```javascript
+{
+    "results": [
+        {
+            "name": null,
+            "company": "",
+            "address1": "1801 F ST NW",
+            "address2": "",
+            "city": "WASHINGTON",
+            "state": "DC",
+            "zip5": "20006",
+            "zip4": "4406",
+            "return_text": "Default address: The address you entered was found but more information is needed (such as an apartment, suite, or box number) to match to a specific address."
+        }
+    ]
+}
+```
+
+## Public domain
+
+This project is in the public domain within the United States, and
+copyright and related rights in the work worldwide are waived through
+the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/config.ru

@@ -0,0 +1,6 @@
+require './lib/usps-proxy'
+
+run Rack::URLMap.new(
+  '/city_state' => USPS::Proxy::CityState,
+  '/address_standardization' => USPS::Proxy::AddressStandardization
+)

data/lib/usps-proxy.rb

@@ -0,0 +1,18 @@
+require 'usps-proxy/version'
+require 'usps-proxy/protocol'
+require 'usps-proxy/city_state'
+require 'usps-proxy/address_standardization'
+
+require 'bundler/setup'
+require 'sinatra/base'
+
+require 'usps'
+require 'dotenv'
+require 'pry'
+require 'json'
+Dotenv.load
+
+module USPS
+  module Proxy 
+  end
+end

data/lib/usps-proxy/address_standardization.rb

@@ -0,0 +1,28 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'pry'
+
+module USPS
+  module Proxy
+    class AddressStandardization < Sinatra::Base
+      get '/' do
+        content_type :json     
+
+        address = USPS::Address.new(params)
+        request = USPS::Request::AddressStandardization.new(address)
+        
+        begin
+          response = request.send!
+          {
+            results: response.to_h.values
+          }.to_json
+        rescue USPS::Error => error
+          {
+            error: error.message,
+            code: error.number
+          }.to_json
+        end
+      end
+    end
+  end
+end

data/lib/usps-proxy/city_state.rb

@@ -0,0 +1,31 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'pry'
+require 'json'
+
+module USPS
+  module Proxy
+    
+    class CityState < Sinatra::Base
+      get '/' do
+        content_type :json
+              
+        request = USPS::Request::CityAndStateLookup.new(params[:zip5])          
+        
+        begin
+          response = request.send!          
+          
+          {
+            results: response.to_h
+          }.to_json
+        rescue USPS::Error => error
+          {
+            error: error.message,
+            code: error.number
+          }.to_json
+        end
+      end
+    end
+
+  end
+end

data/lib/usps-proxy/protocol.rb

@@ -0,0 +1,45 @@
+module USPS
+  module Proxy
+    module Protocol
+      
+      CITY_STATE_PARAMS = [
+        {
+          name: :zip5,
+          required: true
+        }
+      ]
+  
+      ADDRESS_STANDARDIZATION_PARAMS = [
+        {
+          name: :firm,
+          required: false
+        },
+        {
+          name: :address1,
+          required: true
+        },
+        {
+          name: :address2,
+          required: false
+        },
+        {
+          name: :city,
+          required: true
+        },
+        {
+          name: :state,
+          required: true
+        },
+        {
+          name: :zip5,
+          required: true
+        },
+        {
+          name: :zip4,
+          required: false
+        }
+      ]
+
+    end
+  end
+end

data/lib/usps-proxy/version.rb

@@ -0,0 +1,3 @@
+module UspsProxy
+  VERSION = '0.0.1'
+end

data/usps-proxy.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usps-proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "usps-proxy"
+  spec.version       = UspsProxy::VERSION
+  spec.authors       = ["Alan deLevie"]
+  spec.email         = ["alan.delevie@gsa.gov"]
+  spec.summary       = %q{Some space between the USPS API and your users}
+  spec.description   = %q{Makes the USPS API a bit easier to consumer on the client-side.}
+  spec.homepage      = ""
+  spec.license       = "Public Domain. See LICENSE.md"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  
+  spec.add_dependency "dotenv"
+  spec.add_dependency "sinatra"
+  spec.add_dependency "usps", "~>0.1"
+  spec.add_dependency "thin"
+  
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: usps-proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alan deLevie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: usps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes the USPS API a bit easier to consumer on the client-side.
+email:
+- alan.delevie@gsa.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".ruby-version"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- config.ru
+- lib/usps-proxy.rb
+- lib/usps-proxy/address_standardization.rb
+- lib/usps-proxy/city_state.rb
+- lib/usps-proxy/protocol.rb
+- lib/usps-proxy/version.rb
+- usps-proxy.gemspec
+homepage: ''
+licenses:
+- Public Domain. See LICENSE.md
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Some space between the USPS API and your users
+test_files: []