shipping-scale 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3356c36762733c31023ea62e9652f0b12b0b92f6
+  data.tar.gz: 1b2c906fcad03b078f56f88e82dc5ff48a22057f
+SHA512:
+  metadata.gz: de91ad6c1681d17285898c92848d738c35bd16d55809551e56d230028c93411abe6065379e75bb7235533e102df575cbed8db133bad94ad3b06755ae68acffc9
+  data.tar.gz: 412db0928def8f25de3e52272e552087a525f0062b1e8601b75521ddc2a6add145e9e7598498cb69970d83268d332b475c1908aa6aecfb77ffb9262fa216402f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Josh Reinhardt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# ShippingScale
+
+ShippingScale is a simple interface with the USPS Price Calculator API.  With it, you can quickly and easily calculate postage prices for packages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shipping-scale'
+
+# or from the github repository
+gem 'shipping-scale', :git => 'https://github.com/jereinhardt/shipping-scale.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shipping-scale
+
+## Setup
+
+In order to properly configure your interface, you must first have a registered developer account with the US Postal Service.  
+
+Add an initializer to your application and configure it to use your API USER ID
+
+```ruby 
+ShippingScale.configure do |config|
+  config.user_id = ENV["USPS_USER_ID"]
+  config.timeout = 5
+  config.testing = false
+end
+```
+
+## Usage
+
+If you have all of the necessary information for the package you want to ship, using the gem is as simples as creating an instance of `ShipingScale::Package` and using `#get_price!`.  Other details are also returned with this method.
+
+```ruby
+package_options = { 
+  weight: 1,
+  length: 3,
+  width: 2,
+  height: 3,
+  zip_origin: "66204",
+  zip_destination: "63501" 
+}
+
+package = ShippingScale::Package.new(package_options)
+
+package.get_price!
+
+# for the floating point value of postage
+package.price # => 15
+
+# for other details sent back from the request
+package.details # => { zip_origination: "66204", zip_destination: "63501", pounds: "1", ... }
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jereinhardt/shipping-scale.
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir.glob("tasks/**/*.rake").each(&method(:import))
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shipping_scale"
+
+# 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
+
+require "shipping_scale"
+
+# ShippingScale.config
+# ShippingScale::Request.config
+
+# package1_options = { weight: 1.5, length: 3, width: 2, height: 3, zip_origin: "66204", zip_destination: "63501" }
+# package2_options = { weight: 2.5, length: 1, width: 2, height: 5, zip_origin: "63501", zip_destination: "66204" }
+# package_1 = ShippingScale::Package.new(package1_options)
+# package_2 = ShippingScale::Package.new(package2_options)
+# packages = [package_1, package_2]
+
+# request = ShippingScale.new(packages: packages)
+
+# xml = request.build
+
+# puts xml

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/lib/shipping_scale.rb

@@ -0,0 +1,34 @@
+require "shipping_scale/version"
+require "builder"
+require "nokogiri"
+require "snakecase_string"
+
+module ShippingScale 
+
+  autoload :Client,          "shipping_scale/client"
+  autoload :Configuration,   "shipping_scale/configuration"
+  autoload :Request,         "shipping_scale/request"
+  autoload :Response,        "shipping_scale/response"
+  autoload :Error,           "shipping_scale/error"
+  autoload :Package,         "shipping_scale/package"
+
+  class << self 
+    attr_writer :config
+
+    def client
+      @client ||= Client.new
+    end
+
+    def testing=(val)
+      config.testing = val
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure(&block)
+      block.call(self.config)
+    end
+  end
+end

data/lib/shipping_scale/client.rb

@@ -0,0 +1,43 @@
+require "typhoeus"
+
+module ShippingScale
+  class Client
+    def request(request)
+      server = server(request)
+
+      response = Typhoeus::Request.get(server, {
+        timeout: ShippingScale.config.timeout,
+        params: {
+          "API" => request.api,
+          "XML" => request.build
+        }
+      })
+
+      xml = Nokogiri::XML.parse(response.body)
+
+      if ((error = xml.search('Error')).any?)
+        why = error.search("Description").children.first
+        code = error.search("Number").children.first.to_s
+        source = error.search("Source").children.first
+        raise ShippingScale::Error.for_code(code).new(why, code, source)
+      end
+
+      ShippingScale::Response.parse(xml)
+    end
+
+    def testing?
+      ShippingScale.config.testing?
+    end
+
+    def server(request)
+      case 
+      when request.secure? 
+        "https://secure.shippingapis.com/ShippingAPI.dll"
+      when testing?
+        "http://testing.shippingapis.com/ShippingAPI.dll"
+      else
+        "http://production.shippingapis.com/ShippingAPI.dll"
+      end
+    end
+  end
+end

data/lib/shipping_scale/configuration.rb

@@ -0,0 +1,11 @@
+module ShippingScale
+  class Configuration < Struct.new(:user_id, :timeout, :testing, :zip_origin, :zip_destination)
+    def initialize
+      self.timeout = 5
+      self.testing = false
+      self.user_id = (ENV.fetch("USPS_USER_ID")) ? ENV.fetch("USPS_USER_ID") : nil
+    end
+
+    alias :testing? :testing
+  end
+end

data/lib/shipping_scale/error.rb

@@ -0,0 +1,36 @@
+module ShippingScale
+  class Error < StandardError
+    attr_reader :code, :source
+
+    def initialize(message, code, source)
+      super(message)
+
+      @code = code
+      @source = source
+    end
+
+    class << self 
+      def for_code(code)
+        case code 
+        when "-2147219498"    ; AuthorizationError
+        when "-2147219100"    ; MissingZipOriginError
+        when "-2147219099"    ; MissingZipDestinationError
+        when "-2147219497"    ; InvalidZipDestinationError
+        when "-2147219498"    ; InvalidZipOriginError
+        when "-2147219097"    ; MissingWeightError
+        when "-2147219098"    ; MissingWeightError
+        else                  ; Error
+        end
+      end
+    end
+  end
+
+  class AuthorizationError < Error; end
+
+  class ValidationError < Error; end
+  class InvalidZipOriginError < ValidationError; end
+  class InvalidZipDestinationError < ValidationError; end
+  class MissingZipOriginError < ValidationError; end
+  class MissingZipDestinationError < ValidationError; end
+  class MissingWeightError < ValidationError; end
+end

data/lib/shipping_scale/package.rb

@@ -0,0 +1,40 @@
+module ShippingScale
+  class Package
+    def initialize(**options)
+      @weight = options[:weight]
+      @pounds = options[:pounds]
+      @ounces = options[:ounces]
+      @length = options[:length]
+      @width = options[:width]
+      @height = options[:height]
+      @zip_origin = (options[:zip_origin]) ? options[:zip_origin] : ShippingScale.config.zip_origin 
+      @zip_destination = (options[:zip_destination]) ? options[:zip_destination] : ShippingScale.config.zip_destination
+
+      @attrs = options
+    end
+
+    attr_accessor :response
+    
+    def build_xml(package) 
+      package.tag!("Service", "All")
+      package.tag!("Container", "VARAIBLE")
+      package.tag!("Size", "REGULAR")
+      @attrs.each { |k, v| package.tag!(k.to_s, v) }
+    end
+
+    def get_price!(options = {})
+      ShippingScale::Request.config(options)
+      @response = ShippingScale::Request.new(packages: [self]).send!     
+    end
+
+    def price 
+      response.price
+    end
+
+    def details
+      response.details
+    end
+
+    #TODO set methods to determin service, container, and size
+  end
+end

data/lib/shipping_scale/request.rb

@@ -0,0 +1,57 @@
+module ShippingScale
+  class Request
+    class << self
+      attr_reader :api, :tag, :secure
+
+      def config(options = {})
+        defaults = {api: "RateV4", tag: "RateV4Request"}
+        options = defaults.merge(options)
+
+        @api = options[:api]
+        @tag = options[:tag]
+        @secure = !!options[:secure]
+      end
+    end
+
+    def initialize(options={})
+      @response = options[:response]
+      @packages = options[:packages]
+    end
+
+    attr_accessor :response
+    attr_reader :packages
+
+    def secure?
+      !!self.class.secure
+    end
+
+    def api
+      self.class.api
+    end
+
+    def build
+      xml.tag!(self.class.tag, USERID: ShippingScale.config.user_id) do |req|
+        req.tag!("Revision", "2")
+        packages_to_xml(req)
+      end 
+    end
+
+    def send!
+      ShippingScale.client.request(self)
+    end
+
+    private 
+
+    def packages_to_xml(xml)
+      i = 1
+      packages.each do |package|
+        xml.tag!("Package", ID: i) { |pac| package.build_xml(pac) }
+        i += 1
+      end
+    end
+
+    def xml
+      @_xml ||= Builder::XmlMarkup.new(indent: 0)
+    end
+  end
+end

data/lib/shipping_scale/response.rb

@@ -0,0 +1,33 @@
+module ShippingScale
+  class Response
+    attr_accessor :raw
+
+    class << self
+      def parse(xml)
+        response = self.new(xml)
+        response.raw = xml
+        response
+      end
+    end
+
+    def initialize(xml)
+      @xml = xml
+    end
+
+    attr_reader :xml
+
+    def details
+      details = {}
+
+      xml.search("Package").children.each do |node|
+        details[node.name.snakecase.to_sym] = node.text
+      end
+
+      return details
+    end
+
+    def price
+      xml.search("Package").children.search("Postage").text.to_f
+    end
+  end
+end

data/lib/shipping_scale/version.rb

@@ -0,0 +1,3 @@
+module ShippingScale
+  VERSION = "0.1.0"
+end

data/lib/snakecase_string.rb

@@ -0,0 +1,10 @@
+class String
+  def snakecase
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr('-', '_').
+    gsub(/\s/, '_').
+    gsub(/__+/, '_').
+    downcase
+  end
+end

data/shipping-scale.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shipping_scale/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shipping-scale"
+  spec.version       = ShippingScale::VERSION
+  spec.authors       = ["Josh Reinhardt"]
+  spec.email         = ["joshua.e.reinhardt@gmail.com"]
+
+  spec.summary       = %q{A simple Ruby API wrapper for the USPS price calculator API}
+  spec.homepage      = "https://github.com/jereinhardt/shipping-scale"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "builder", "~> 2.0"
+  spec.add_runtime_dependency 'nokogiri', '~> 1.4', '>= 1.4.1'
+  spec.add_runtime_dependency 'typhoeus', '~> 0.1', '>= 0.1.18'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'dotenv', '~> 0'
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: shipping-scale
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Reinhardt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.18
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+description: 
+email:
+- joshua.e.reinhardt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/shipping_scale.rb
+- lib/shipping_scale/client.rb
+- lib/shipping_scale/configuration.rb
+- lib/shipping_scale/error.rb
+- lib/shipping_scale/package.rb
+- lib/shipping_scale/request.rb
+- lib/shipping_scale/response.rb
+- lib/shipping_scale/version.rb
+- lib/snakecase_string.rb
+- shipping-scale.gemspec
+- tasks/rspec.rake
+homepage: https://github.com/jereinhardt/shipping-scale
+licenses:
+- MIT
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A simple Ruby API wrapper for the USPS price calculator API
+test_files: []