postmaster 1.0.0

data/test/test_postmaster.rb

@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require 'postmaster'
+require 'shoulda'
+require 'mocha'
+require 'rest-client'
+require 'cgi'
+require 'uri'
+
+class TestPostmasterRuby < Test::Unit::TestCase
+  include Mocha
+  
+  context "Util" do
+    should "symbolize_names should convert names to symbols" do
+      start = {
+        'foo' => 'bar',
+        'array' => [{ 'foo' => 'bar' }],
+        'nested' => {
+          1 => 2,
+          :symbol => 9,
+          'string' => nil
+        }
+      }
+      finish = {
+        :foo => 'bar',
+        :array => [{ :foo => 'bar' }],
+        :nested => {
+          1 => 2,
+          :symbol => 9,
+          :string => nil
+        }
+      }
+
+      symbolized = Postmaster::Util.symbolize_names(start)
+      assert_equal(finish, symbolized)
+    end
+
+    should "flatten_params should convert data" do
+      start = {
+        :foo => 'bar',
+        :array => [
+           'foo', 
+           'bar',
+           { :foo => 'bar' }
+        ],
+        
+        :nested => {
+          :foo => 'bar',
+          :bar => 'foo'
+        }
+      }
+      finish = [
+        ["array[]", "bar"],
+        ["array[]", "foo"],
+        ["array[foo]", "bar"],
+        ["foo", "bar"],
+        ["nested[bar]", "foo"],
+        ["nested[foo]", "bar"]
+      ]
+
+      flattened = Postmaster::Util.flatten_params(start)
+      assert_equal(finish.sort, flattened.sort)
+    end
+  end
+  
+  context "PostmasterObject" do
+    should "behave like Hash" do
+      obj = Postmaster::PostmasterObject.construct_from({
+        :param1 => "value1",
+        :param2 => "value2",
+      })
+      
+      assert(obj.method_exists?(:param1))
+      assert(obj.method_exists?(:param2))
+      assert_equal('value1', obj.param1)
+      assert_equal('value2', obj.param2)
+
+      assert(obj.has_key?(:param1))
+      assert(obj.has_key?(:param2))
+      assert_equal('value1', obj[:param1])
+      assert_equal('value2', obj[:param2])
+      
+      assert_equal([:param1, :param2], obj.keys.sort_by {|sym| sym.to_s})
+      assert_equal(['value1', 'value2'], obj.values.sort)
+    end
+    
+    should "set and unset accessors" do
+      obj = Postmaster::PostmasterObject.new()
+      
+      assert(!obj.method_exists?(:foo))
+
+      obj[:foo] = 'bar'
+      assert(obj.method_exists?(:foo))
+      assert_equal('bar', obj.foo)
+      
+      obj.delete(:foo)
+      assert(!obj.method_exists?(:foo))
+    end
+    
+    should "be serializable" do
+      obj = Postmaster::PostmasterObject.construct_from({
+        :foo => "bar",
+      })
+      
+      assert_equal('{"foo":"bar"}', obj.to_s)
+      assert_equal('{"foo":"bar"}', obj.to_json)
+      assert(obj.inspect.include? 'JSON: {"foo":"bar"}')
+    end
+    
+  end
+
+  context "API Bindings" do
+    setup do
+      @mock = mock
+      Postmaster.mock_rest_client = @mock
+    end
+
+    teardown do
+      Postmaster.mock_rest_client = nil
+    end
+
+    should "creating a new APIResource should not fetch over the network" do
+      @mock.expects(:get).never
+      c = Postmaster::Shipment.new(123)
+    end
+
+    should "creating a new APIResource from a hash should not fetch over the network" do
+      @mock.expects(:get).never
+      c = Postmaster::Shipment.construct_from({
+        :id => 123,
+        :param => "value"
+      })
+    end
+
+    should "not fetch if only accessing id" do
+      @mock.expects(:get).never
+      c = Postmaster::Shipment.new(123);
+      c.id
+    end
+
+    should "specifying invalid api credentials should raise an exception" do
+      Postmaster.api_key = "invalid"
+      response = test_response(test_invalid_api_key_error, 401)
+      assert_raises Postmaster::AuthenticationError do
+        @mock.expects(:get).once.raises(RestClient::ExceptionWithResponse.new(response, 401))
+        Postmaster::Shipment.retrieve(-1)
+      end
+    end
+
+    should "AuthenticationErrors should have an http status, http body, and JSON body" do
+      Postmaster.api_key = "invalid"
+      response = test_response(test_invalid_api_key_error, 401)
+      begin
+        @mock.expects(:get).once.raises(RestClient::ExceptionWithResponse.new(response, 401))
+        Postmaster::Shipment.retrieve(-1)
+      rescue Postmaster::AuthenticationError => e
+        assert_equal(401, e.http_status)
+        assert_equal(true, !!e.http_body)
+        assert_equal(true, !!e.json_body[:error][:message])
+        assert_equal(test_invalid_api_key_error['error']['message'], e.json_body[:error][:message])
+        assert_equal('(Status 401) Invalid API Key provided: invalid', e.to_s)
+      end
+    end
+    
+    should "raise an exception if objest id is not specified" do
+      assert_raises Postmaster::InvalidRequestError do
+        Postmaster::Shipment.new().refresh
+      end
+    end
+  end
+end

data/test/test_shipment.rb

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require 'postmaster'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'rest-client'
+require 'cgi'
+require 'uri'
+
+class TestShipmentRuby < Test::Unit::TestCase
+  include Mocha
+ 
+  sample_shipment = {
+    :to => {
+      :company => "ASLS",
+      :contact => "Joe Smith",
+      :line1 => "1110 Algarita Ave",
+      :city => "Austin",
+      :state => "TX",
+      :zip_code => "78704-4429",
+      :phone_no => "919-720-7941",
+      :country => "US"
+    },
+    :from_ => {
+      :company => "ASLS",
+      :contact => "Joe Smith",
+      :line1 => "1110 Algarita Ave",
+      :city => "Austin",
+      :state => "TX",
+      :zip_code => "78704-4429",
+      :phone_no => "919-720-7941",
+      :country => "US"
+    },
+    :carrier => "ups",
+    :service => "2DAY",
+    :package => {
+      :value => 55,
+      :weight => 1.5,
+      :length => 10,
+      :width => 6,
+      :height => 8,
+    },
+    :reference => "Order # 54321"
+  }
+ 
+  context "Shipment" do
+
+    should "be created" do
+      result = Postmaster::Shipment.create(params=sample_shipment)
+      assert_instance_of(Postmaster::Shipment, result)
+      assert(result.keys.include?(:status))
+      assert_equal("Processing", result[:status])
+      assert(result.keys.include?(:package))
+      assert_instance_of(Postmaster::Package, result[:package])
+      assert(result[:package].keys.include?(:type_))
+      assert_equal("CUSTOM", result[:package][:type_])
+      assert_instance_of(Postmaster::Address, result[:to])
+      assert_instance_of(Postmaster::Address, result[:from_])
+    end
+    
+    should "be the same after retreave" do
+      shipment1 = Postmaster::Shipment.create(params=sample_shipment)
+      shipment2 = Postmaster::Shipment.retrieve(shipment1.id)
+      
+      shipment1hash = shipment1.to_hash
+      shipment2hash = shipment2.to_hash
+      # label_urls can be different, so ignore it during check
+      shipment1hash[:package].delete(:label_url)
+      shipment2hash[:package].delete(:label_url)
+      shipment1hash[:packages][0].delete(:label_url)
+      shipment2hash[:packages][0].delete(:label_url)
+      assert_equal(shipment1hash, shipment2hash)
+    end
+
+    should "list" do
+      shipments = Postmaster::Shipment.all()
+
+      assert_kind_of(Array, shipments)
+      shipments.each do |shipment|
+        assert_instance_of(Postmaster::Shipment, shipment)
+      end
+    end
+    
+    should "track" do
+      shipment = Postmaster::Shipment.create(params=sample_shipment)
+      result = shipment.track()
+      
+      assert_kind_of(Array, result)
+      assert(!result.empty?)
+      assert_instance_of(Postmaster::Tracking, result[0])
+      
+      assert(result[0].keys.include?(:status))
+      assert(result[0].keys.include?(:history))
+      assert(!result[0].history.empty?)
+      assert_instance_of(Postmaster::TrackingHistory, result[0].history[0])
+    end
+    
+    should "void" do
+      shipment = Postmaster::Shipment.create(params=sample_shipment)
+      result = shipment.void()
+      
+      assert(result.is_a?(TrueClass))
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification 
+name: postmaster
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Postmaster
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 0
+        - 4
+        version: 1.0.4
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: Postmaster takes the pain out of sending shipments via UPS, Fedex, and USPS. Save money before you ship, while you ship, and after you ship. See https://postmaster.io for details.
+email: 
+- support@postmaster.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/example.rb
+- lib/postmaster.rb
+- lib/postmaster/address.rb
+- lib/postmaster/api_operations/create.rb
+- lib/postmaster/api_operations/list.rb
+- lib/postmaster/api_resource.rb
+- lib/postmaster/errors/api_connection_error.rb
+- lib/postmaster/errors/api_error.rb
+- lib/postmaster/errors/authentication_error.rb
+- lib/postmaster/errors/invalid_request_error.rb
+- lib/postmaster/errors/postmaster_error.rb
+- lib/postmaster/json.rb
+- lib/postmaster/package.rb
+- lib/postmaster/postmaster_object.rb
+- lib/postmaster/shipment.rb
+- lib/postmaster/tracking.rb
+- lib/postmaster/util.rb
+- lib/postmaster/version.rb
+- postmaster.gemspec
+- test/test_address.rb
+- test/test_helper.rb
+- test/test_postmaster.rb
+- test/test_shipment.rb
+homepage: https://postmaster.io
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Library for postmaster.io service
+test_files: 
+- test/test_address.rb
+- test/test_helper.rb
+- test/test_postmaster.rb
+- test/test_shipment.rb