shippo 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85b2b23425a202d40c7136f79f3a5124cf80969d
-  data.tar.gz: a8c700f918325afae4fdf2f4cc594f9ab22fe7a4
+  metadata.gz: 7cf3a2a856cd835b2b6bd4b9dd581be7aa861c1d
+  data.tar.gz: 9e18225119fd342921378279dd15ef5827bfe4a0
 SHA512:
-  metadata.gz: f0ad9eef6f26034009b9c320258afc1cfbb70b5e290ac874f0962a25800f24604962c151bed0fb67a0042a78bee1af8479a0af38445d4761c69896232451f3cc
-  data.tar.gz: 31a69491bcfd82afa39d2464594294a99d06fa0405b41bf0f117c76c093ce6e07d7e93529ad0a3ec9d50e61c738e5ba3d2fc7278530c6f7fe95dbd2a1621d819
+  metadata.gz: 8a4516e0260ac10b5e4437ccd3603f5f69384422a1ff9f57dd014e0b28dc20419ff455e2a334024c9d7482b5940197ef3ac6b9bf1ceb783633d8904dadbab043
+  data.tar.gz: d103a9d4cf47d126303892dac1281c84e3813525597eca4c8640bfa69f11f21e5ace1f81d5e6081adc963155ae8896e23dab1d7d29f2c8c0069d314eed7a6e4e

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 2.0.7 release, Jan 2nd, 2017
+- Fixed bug preventing address validation
+- Removed trailing slash from base URL, added spec test to ensure this configuration
+- Added address validation example
+- Updated basic shipment example to include how to access the Shippo object id
+### 2.0.6 release, Nov 22nd, 2016
+- Fixed bug to send request with correct API version header
 #### 2.0.5 release, Oct 24th, 2016
  - Updated README.md
  - now possible to send API version

data/bin/address_validation_example

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+#
+# © 2016 Shippo, Inc.
+#
+# License: MIT
+#
+# This example demonstrates how to purchase a label for a domestic US shipment.
+# Please set +SHIPPO_TOKEN+ in the environment before running it.
+#
+# You can also set +SHIPPO_DEBUG+ to see detailed printouts of objects returned.
+#
+#
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler/setup'
+require 'shippo'
+require 'shippo/api/category'
+require 'shippo/exceptions/api_error'
+require 'awesome_print'
+require 'json'
+
+Shippo::API.token = ENV['SHIPPO_TOKEN']
+
+# Simple wrapper class to help us print objects to the STDOUT
+class ExampleHelper
+  def self.log_operation(msg)
+    printf '%s', msg
+    result = yield
+    puts 'OK'
+    result
+  rescue Exception => e
+    raise(e)
+  end
+
+  def self.dump_object(instance, msg = nil)
+    return unless Shippo::API.debug?
+    sep
+    puts "#{msg.upcase}:" if msg
+    puts "\#<#{instance.class.inspect}:0x#{instance.object_id.to_s(16)}> ⇒ "
+    ap instance
+    sep
+    # See https://github.com/goshippo/shippo-ruby-client#resource-id-and-other-object-fields
+    puts "Shippo object id: #{instance.object.id}"
+    sep
+  end
+
+  def self.sep
+    puts '—' * (ENV['COLUMNS'] || 80)
+  end
+end
+
+# Create address object
+address = {
+  :object_purpose => 'PURCHASE',
+  :name           => 'Mr Hippo',
+  :company        => 'Shippo',
+  :street1        => '215 Clayton St.',
+  :street2        => '',
+  :city           => 'San Francisco',
+  :state          => 'CA',
+  :zip            => '94117',
+  :country        => 'US',
+  :phone          => '+1 555 341 9393',
+  :email          => 'support@goshippo.com',
+  :is_residential => true,
+  :metadata       => 'some metadata'
+}
+
+begin
+  address = ExampleHelper.log_operation 'Creating address... ' do
+    Shippo::Address.create(address)
+  end
+  raise Shippo::Exceptions::UnsuccessfulResponseError.new(address.object.inspect) unless address.valid?
+  File.open('example-address.json', 'w') do |file|
+    file.puts JSON.dump(address.to_hash)
+  end
+rescue Shippo::Exceptions::APIServerError => e
+  puts "Server returned an error:\n#{e}"
+  exit 3
+rescue Shippo::Exceptions::ConnectionError
+  puts 'Error connecting to remote host. Is your Internet working?'
+  exit 2
+rescue Shippo::Exceptions::AuthenticationError
+  if Shippo::API.token
+    puts "Token '#{Shippo::API.token}' does not appear to be valid."
+    puts 'Access denied.'
+  else
+    puts 'Please set authentication token in the environment:'
+    puts 'export SHIPPO_TOKEN="<your token here>"'
+    puts 'and re-run the example.'
+  end
+  exit 1
+end
+
+# Validate the address that we created
+resp = Shippo::Address.validate(address.object.id)
+ExampleHelper.dump_object(resp, 'Validation complete')
+

data/bin/{example → basic_shipment_example}

@@ -41,6 +41,9 @@ class ExampleHelper
     puts "\#<#{instance.class.inspect}:0x#{instance.object_id.to_s(16)}> ⇒ "
     ap instance
     sep
+    # See https://github.com/goshippo/shippo-ruby-client#resource-id-and-other-object-fields
+    puts "Shippo object id: #{instance.object.id}"
+    sep
   end
 
   def self.sep

data/lib/shippo/api.rb

@@ -11,7 +11,7 @@ require 'shippo/api/resource'
 
 module Shippo
   module API
-    @base     = 'https://api.goshippo.com/'
+    @base     = 'https://api.goshippo.com'
     @version  = nil
     @token    = ''
     @debug    = Integer(ENV['SHIPPO_DEBUG'] || 0) > 0 ? true : false

data/lib/shippo/api/operations/validate.rb

@@ -2,8 +2,8 @@ module Shippo
   module API
     module Operations
       module Validate
-        def validate(params={})
-          response = Shippo::API.get("#{url}/validate/", params)
+        def validate(object_id, params={})
+          response = Shippo::API.get("#{url}/#{CGI.escape(object_id)}/validate/", params)
           Shippo::Address.from(response)
         end
       end

data/lib/shippo/api/resource.rb

@@ -99,6 +99,10 @@ module Shippo
       def success?
         self.object && self.object.status && self.object.status.eql?(Shippo::API::Category::Status::SUCCESS)
       end
+
+      def valid?
+        self.object && self.object.state && self.object.state.eql?(Shippo::API::Category::State::VALID)
+      end
     end
   end
 end

data/lib/shippo/api/version.rb

@@ -1,5 +1,5 @@
 module Shippo
   module API
-    VERSION = '2.0.6'
+    VERSION = '2.0.7'
   end
 end

data/lib/shippo/model/address.rb

@@ -1,5 +1,5 @@
 module Shippo
   class Address < ::Shippo::API::Resource
-    operations :list, :create
+    operations :list, :create, :validate
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shippo
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Shippo & Contributors
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -188,8 +188,9 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- bin/address_validation_example
+- bin/basic_shipment_example
 - bin/console
-- bin/example
 - lib/shippo.rb
 - lib/shippo/api.rb
 - lib/shippo/api/api_object.rb
@@ -249,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 4
 summary: API client for Shippo® APIs. Shippo helps you connect with multiple carriers