stamps 0.2.0 → 0.3.0

data/.gitignore

@@ -1,5 +1,9 @@
 coverage/*
+test/client/coverage/*
+test/coverage/*
 pkg/*
 *.gem
 .bundle
 runner.rb
+.yardoc/*
+doc/*

data/Gemfile.lock

@@ -1,29 +1,30 @@
 PATH
   remote: .
   specs:
-    stamps (0.0.1)
+    stamps (0.2.0)
       hashie (~> 1.0.0)
       httpi (= 0.7.9)
       json (~> 1.5.1)
-      multi_json (~> 0.0.5)
-      savon (>= 0.8.6)
+      multi_json (~> 1.0)
+      savon (= 0.8.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.2.4)
     awesome_print (0.3.2)
-    builder (2.1.2)
+    bluecloth (2.1.0)
+    builder (3.0.0)
     crack (0.1.8)
-    gyoku (0.4.2)
+    gyoku (0.4.5)
       builder (>= 2.1.2)
     hashie (1.0.0)
     httpi (0.7.9)
       rack
-    json (1.5.1)
+    json (1.5.4)
     mocha (0.9.12)
-    multi_json (0.0.5)
-    rack (1.2.2)
+    multi_json (1.3.6)
+    rack (1.4.1)
     savon (0.8.6)
       builder (>= 2.1.2)
       crack (~> 0.1.8)
@@ -36,14 +37,17 @@ GEM
     webmock (1.6.2)
       addressable (>= 2.2.2)
       crack (>= 0.1.7)
+    yard (0.6.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   awesome_print
+  bluecloth
   mocha (~> 0.9.11)
   shoulda (~> 2.11.3)
   simplecov (~> 0.4.0)
   stamps!
   webmock (~> 1.6.2)
+  yard

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Matt Sears
+
+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/Rakefile

@@ -11,3 +11,18 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "lib" << "test"
   t.ruby_opts << '-rubygems' if defined? Gem
 end
+
+if ENV['RAILS_ENV']=='development' # yard gem is only in development
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    #t.options = ['--one-file']
+  end
+end
+
+namespace :docs do
+  desc 'Generate documentation for the appliaction with Yard'
+  task :yard do
+    system("yardoc 'lib/**/*.rb' - README.md")
+  end
+end
+

data/lib/stamps/api.rb

@@ -1,8 +1,10 @@
 require File.expand_path('../request', __FILE__)
 
 module Stamps
+
   # @private
   class API
+
     # @private
     attr_accessor *Configuration::VALID_OPTIONS_KEYS
 

data/lib/stamps/client/account.rb

@@ -10,7 +10,7 @@ module Stamps
       def account(params = {})
         params[:authenticator] = authenticator_token
         response = request('GetAccountInfo', Stamps::Mapping::Account.new(params) )
-        response[:get_account_info_response][:account_info] if response
+        response[:errors].empty? ? response[:get_account_info_response][:account_info] : response
       end
 
       # Add funds to postage account
@@ -18,7 +18,7 @@ module Stamps
       def purchase_postage(params = {})
         params[:authenticator] = authenticator_token
         response = request('PurchasePostage', Stamps::Mapping::PurchasePostage.new(params))
-        response[:purchase_postage_response] if response
+        response[:errors].empty? ? response[:purchase_postage_response] : response
       end
 
       # Request carrier pickup
@@ -27,7 +27,7 @@ module Stamps
       def carrier_pickup(params = {})
         params[:authenticator] = authenticator_token
         response = request('CarrierPickup', Stamps::Mapping::CarrierPickup.new(params))
-        response[:carrier_pickup_response] if response
+        response[:errors].empty? ?  response[:carrier_pickup_response] : response
       end
 
     end

data/lib/stamps/configuration.rb

@@ -2,7 +2,7 @@ module Stamps
   # Defines constants and methods related to configuration
   module Configuration
 
-    # An array of valid keys in the options hash when configuring a {Twitter::API}
+    # An array of valid keys in the options hash when configuring a {Stamps::API}
     VALID_OPTIONS_KEYS = [
       :integration_id,
       :username,
@@ -16,8 +16,8 @@ module Stamps
       :endpoint].freeze
 
     # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = 'https://swsim.testing.stamps.com/swsim/swsimv12.asmx'.freeze
-
+    DEFAULT_ENDPOINT = 'https://swsim.stamps.com/swsim/swsimv12.asmx'.freeze
+    
     # The default namespace used on Stamps.com wsdl
     DEFAULT_NAMESPACE = 'http://stamps.com/xml/namespace/2010/11/swsim/swsimv12'
 

data/lib/stamps/mapping.rb

@@ -114,7 +114,11 @@ module Stamps
       # Maps :from to Address map
       def from=(val)
         # Set the defult :from address from address
-        self[:From] = Address.new(Stamps.return_address.merge!(val))
+        if Stamps.return_address
+          self[:From] = Address.new(Stamps.return_address.merge!(val))
+        else
+          self[:From] = Address.new(val)
+        end
       end
 
       # Maps :to to Address map
@@ -134,31 +138,32 @@ module Stamps
     end
 
     class Address < Hashie::Trash
-      property :FullName,     :from => :full_name
-      property :NamePrefix,   :from => :name_prefix
-      property :FirstName,    :from => :first_name
-      property :MiddleName,   :from => :middle_name
-      property :LastName,     :from => :last_name
-      property :NameSuffix,   :from => :name_suffex
-      property :Title,        :from => :title
-      property :Department,   :from => :deparartment
-      property :Company,      :from => :company
-      property :Address1,     :from => :address1
-      property :Address2,     :from => :address2
-      property :City,         :from => :city
-      property :State,        :from => :state
-      property :ZIPCode,      :from => :zip_code
-      property :ZIPCodeAddOn, :from => :zip_code_add_on
-      property :DPB,          :from => :dpb
-      property :CheckDigit,   :from => :check_digit
-      property :Province,     :from => :province
-      property :PostalCode,   :from => :postal_code
-      property :Country,      :from => :country
-      property :Urbanization, :from => :urbanization
-      property :PhoneNumber,  :from => :phone_number
-      property :Extension,    :from => :extentsion
-      property :CleanseHash,  :from => :cleanse_hash
-      property :OverrideHash, :from => :override_hash
+      property :Authenticator, :from => :authenticator
+      property :FullName,      :from => :full_name
+      property :NamePrefix,    :from => :name_prefix
+      property :FirstName,     :from => :first_name
+      property :MiddleName,    :from => :middle_name
+      property :LastName,      :from => :last_name
+      property :NameSuffix,    :from => :name_suffex
+      property :Title,         :from => :title
+      property :Department,    :from => :deparartment
+      property :Company,       :from => :company
+      property :Address1,      :from => :address1
+      property :Address2,      :from => :address2
+      property :City,          :from => :city
+      property :State,         :from => :state
+      property :ZIPCode,       :from => :zip_code
+      property :ZIPCodeAddOn,  :from => :zip_code_add_on
+      property :DPB,           :from => :dpb
+      property :CheckDigit,    :from => :check_digit
+      property :Province,      :from => :province
+      property :PostalCode,    :from => :postal_code
+      property :Country,       :from => :country
+      property :Urbanization,  :from => :urbanization
+      property :PhoneNumber,   :from => :phone_number
+      property :Extension,     :from => :extentsion
+      property :CleanseHash,   :from => :cleanse_hash
+      property :OverrideHash,  :from => :override_hash
     end
 
     class CleanseAddress < Hashie::Trash

data/lib/stamps/version.rb

@@ -1,3 +1,3 @@
 module Stamps
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/stamps.gemspec

@@ -24,10 +24,15 @@ Gem::Specification.new do |s|
   s.add_development_dependency('mocha', '~> 0.9.11')
   s.add_development_dependency('webmock', '~> 1.6.2')
   s.add_development_dependency('awesome_print')
+  s.add_development_dependency('yard')
+  s.add_development_dependency('bluecloth')
 
+  # We have to use savon 0.8.6 for now since newer versions of savon don't
+  # convert booleans, dates, or decimals consistently.
+  # See: https://github.com/rubiii/savon/issues/301
+  s.add_runtime_dependency('savon', '0.8.6')
   s.add_runtime_dependency('httpi', '0.7.9')
-  s.add_runtime_dependency('savon', '>= 0.8.6')
   s.add_runtime_dependency('json', '~> 1.5.1')
-  s.add_runtime_dependency('multi_json', '~> 0.0.5')
+  s.add_runtime_dependency('multi_json', '~> 1.0')
   s.add_runtime_dependency('hashie', '~> 1.0.0')
 end

data/test/client/account_test.rb

@@ -49,15 +49,15 @@ class AccountTest < Test::Unit::TestCase
       end
 
       should 'return pickup date' do
-        assert '01/29/2011', @carrier_pickup[:pickup_date]
+        assert_equal '01/29/2011', @carrier_pickup[:pickup_date]
       end
 
       should 'return pickup day of the week' do
-        assert 'Saturday', @carrier_pickup[:pick_up_day_of_week]
+        assert_equal 'Saturday', @carrier_pickup[:pick_up_day_of_week]
       end
 
       should 'return a confirmation number' do
-        assert 'WTC7812296', @carrier_pickup[:confirmation_number]
+        assert_equal 'WTC7812296', @carrier_pickup[:confirmation_number]
       end
     end
   end

data/test/client/address_test.rb

@@ -22,7 +22,7 @@ class AddressTest < Test::Unit::TestCase
       end
 
       should 'return a cleanse hash' do
-        assert 'W9pHbVsNIdYE8/B6SyQ4wOkIIr9kZWFkYmVlZg==20110713', @address[:address][:cleanse_hash]
+        assert_equal 'W9pHbVsNIdYE8/B6SyQ4wOkIIr9kZWFkYmVlZg==20110713', @address[:address][:cleanse_hash].to_s
       end
 
       should 'indicate if the address match' do

data/test/client/rate_test.rb

@@ -8,7 +8,6 @@ class StampsTest < Test::Unit::TestCase
     end
 
     context ".get_rates" do
-
       setup do
         stub_post("GetRates")
         @rates = Stamps.get_rates
@@ -22,10 +21,13 @@ class StampsTest < Test::Unit::TestCase
         assert_equal '2.41', @rates.first[:amount]
       end
 
+      should 'return the ship date' do
+        assert_equal '2011-04-01', @rates.first[:ship_date]
+      end
+
     end
 
     context '.get_rates with package and service types' do
-
       setup do
         stub_post("GetRate", 'GetRates')
         @rate = Stamps.get_rate
@@ -38,7 +40,6 @@ class StampsTest < Test::Unit::TestCase
       should 'return an array of addons' do
         assert_equal Hash, @rate[:add_ons].class
       end
-
     end
   end
 end

metadata

@@ -1,142 +1,222 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: stamps
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Matt Sears
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-15 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: simplecov
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.4.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.11.3
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 0.9.11
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.6.2
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+- !ruby/object:Gem::Dependency
   name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: httpi
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.7.9
-  type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.9
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.9
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: multi_json
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.0.5
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  version_requirements: *id010
-description: Stamps is Stamps.com backed library for creating postage labels, calculate the shipping cost of packages, standardize domestic addresses via USPS CASS certified Address Matching Software, and track shipments.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Stamps is Stamps.com backed library for creating postage labels, calculate
+  the shipping cost of packages, standardize domestic addresses via USPS CASS certified
+  Address Matching Software, and track shipments.
+email:
 - matt@mattsears.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/stamps.rb
@@ -176,35 +256,31 @@ files:
 - test/response_test.rb
 - test/stamps_test.rb
 - test/types_test.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/stamps
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: stamps
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Stamps.com Web Services API
-test_files: 
+test_files:
 - test/client/account_test.rb
 - test/client/address_test.rb
 - test/client/rate_test.rb
@@ -226,3 +302,4 @@ test_files:
 - test/response_test.rb
 - test/stamps_test.rb
 - test/types_test.rb
+has_rdoc: