postmaster 1.0.1 → 1.1.0

data/lib/example.rb

@@ -1,29 +1,59 @@
 require "postmaster"
 
+# at startup set API key
 Postmaster.api_key = "example-api-key"
 
+# at first validate recipient address
 result = Postmaster::AddressValidation.validate(
-  :company => "ASLS",
+  :company => "Postmaster Inc.",
   :contact => "Joe Smith",
-  :line1 => "1110 Someplace Ave.",
+  :line1 => "701 Brazos St. Suite 1616",
   :city => "Austin",
   :state => "TX",
-  :zip => "78704",
+  :zip => "78701",
   :country => "US"
 )
+#puts result.inspect
 
+# if address is ok you can ask for time and rates for it
+result = Postmaster::TransitTimes.get(
+    :from_zip => "78701",
+    :to_zip => "78704",
+    :weight => 1.5,
+    :carrier => "fedex"
+)
+#puts result.inspect
+
+result = Postmaster::Rates.get(
+    :from_zip => "78701",
+    :to_zip => "78704",
+    :weight => 1.5,
+    :carrier => "fedex"
+)
+#puts result.inspect
+
+# when user will choose delivery type you create shipment
 result = Postmaster::Shipment.create(
+  :from => {
+    :company => "Postmaster Inc.",
+    :contact => "Joe Smith",
+    :line1 => "701 Brazos St. Suite 1616",
+    :city => "Austin",
+    :state => "TX",
+    :zip_code => "78701",
+    :phone_no => "512-693-4040",
+    :country => "US"
+  },
   :to => {
-    :company => "ASLS",
     :contact => "Joe Smith",
-    :line1 => "1110 Someplace Ave.",
+    :line1 => "701 Brazos St. Suite 1616",
     :city => "Austin",
     :state => "TX",
-    :zip_code => "78704",
-    :phone_no => "919-720-7941",
+    :zip_code => "78701",
+    :phone_no => "512-693-4040",
     :country => "US"
   },
-  :carrier => "ups",
+  :carrier => "fedex",
   :service => "2DAY",
   :package => {
     :value => 55,
@@ -34,9 +64,19 @@ result = Postmaster::Shipment.create(
   },
   :reference => "Order # 54321"
 )
+#puts result.inspect
+
+# store in your DB shipment ID for later use
+shipment_id = result.id
+
+# anytime you can extract shipment data
+shipment = Postmaster::Shipment.retrieve(shipment_id)
+#puts shipment.inspect
 
-shipment = Postmaster::Shipment.retrieve(1)
+# or check delivery status
 result = shipment.track()
+#puts result.inspect
 
-shipment = Postmaster::Shipment.retrieve(1)
+# you can cancel shipment, but only before being picked up by the carrier
 result = shipment.void()
+#puts result.inspect

data/lib/postmaster.rb

@@ -2,6 +2,7 @@
 require 'pp'
 require 'cgi'
 require 'set'
+require 'date'
 require 'rubygems'
 require 'openssl'
 
@@ -26,6 +27,8 @@ require 'postmaster/address'
 require 'postmaster/shipment'
 require 'postmaster/package'
 require 'postmaster/tracking'
+require 'postmaster/transit_times'
+require 'postmaster/rates'
 
 # Errors
 require 'postmaster/errors/postmaster_error'
@@ -159,7 +162,13 @@ module Postmaster
     begin
       error_obj = Postmaster::JSON.load(rbody)
       error_obj = Util.symbolize_names(error_obj)
-      error = error_obj[:error] or raise PostmasterError.new # escape from parsing
+      if error_obj.has_key?(:message)
+        error = error_obj
+      elsif error_obj.has_key?(:error)
+        error = error_obj[:error]
+      else
+        raise PostmasterError.new # escape from parsing
+      end
     rescue MultiJson::DecodeError, PostmasterError
       raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
     end

data/lib/postmaster/address.rb

@@ -9,6 +9,7 @@ module Postmaster
   class AddressValidation < APIResource
   
     def self.validate(params={})
+      Util.normalize_address(params)
       response = Postmaster.request(:post, '/v1/validate', params)
       self.construct_from(response)
     end

data/lib/postmaster/postmaster_object.rb

@@ -35,11 +35,12 @@ module Postmaster
       # which keys should be converted to Postmaster_Objects
       obj_keys = {
         'Postmaster::Shipment.to' => Postmaster::Address,
-        'Postmaster::Shipment.from_' => Postmaster::Address,
+        'Postmaster::Shipment.from' => Postmaster::Address,
         'Postmaster::Shipment.package' => Postmaster::Package,
         'Postmaster::AddressProposal.address' => Postmaster::Address,
-        #'Postmaster::Tracking.last_update' => 'DateTime',
-        #'Postmaster::TrackingHistory.timestamp' => 'DateTime'
+        'Postmaster::Tracking.last_update' => 'DateTime',
+        'Postmaster::TrackingHistory.timestamp' => 'DateTime',
+        'Postmaster::TransitTime.delivery_timestamp' => 'DateTime'
       }
   
       # which keys should be converted to list of Postmaster_Objects
@@ -66,7 +67,11 @@ module Postmaster
         full_key = self.class.name + "." + k.to_s
         if obj_keys.has_key?(full_key)
           klass = obj_keys[full_key]
-          @values[k] = klass.construct_from(v)
+          if klass == 'DateTime'
+            @values[k] = DateTime.strptime(v.to_s, '%s')
+          else
+            @values[k] = klass.construct_from(v)
+          end
         elsif obj_list_keys.has_key?(full_key)
           klass = obj_list_keys[full_key]
           @values[k] = []

data/lib/postmaster/rates.rb

@@ -0,0 +1,11 @@
+module Postmaster
+
+  class Rates < APIResource
+  
+    def self.get(params={})
+      response = Postmaster.request(:post, '/v1/rates', params)
+      self.construct_from(response)
+    end
+  end
+  
+end

data/lib/postmaster/shipment.rb

@@ -1,9 +1,15 @@
 module Postmaster
   
   class Shipment < APIResource
-    include Postmaster::APIOperations::Create
     include Postmaster::APIOperations::List
     
+    def self.create(params={})
+      Util.normalize_address(params[:to])
+      Util.normalize_address(params[:from])
+      response = Postmaster.request(:post, self.url, params)
+      self.construct_from(response)
+    end
+    
     def track
       response = Postmaster.request(:get, url('track'))
       if response[:results].nil?

data/lib/postmaster/tracking.rb

@@ -1,6 +1,11 @@
 module Postmaster
 
   class Tracking < APIResource
+  
+    def self.track(tracking_id)
+      response = Postmaster.request(:get, '/v1/track', {:tracking => tracking_id})
+      self.construct_from(response)
+    end
   end
 
   class TrackingHistory < APIResource

data/lib/postmaster/transit_times.rb

@@ -0,0 +1,17 @@
+module Postmaster
+
+  class TransitTimes < APIResource
+  
+    def self.get(params={})
+      response = Postmaster.request(:post, '/v1/times', params)
+      if response[:services].nil?
+        return nil
+      end
+      response[:services].map { |i| Postmaster::TransitTime.construct_from(i) }
+    end
+  end
+
+  class TransitTime < APIResource
+  end
+  
+end

data/lib/postmaster/util.rb

@@ -64,5 +64,15 @@ module Postmaster
       end
       result
     end
+    
+    def self.normalize_address(params)
+      if params != nil && params.has_key?(:address)
+        line1, line2, line3 = params.delete(:address)
+        params[:line1] = line1 if line1
+        params[:line2] = line2 if line2
+        params[:line3] = line3 if line3
+      end
+    end
+    
   end
 end

data/lib/postmaster/version.rb

@@ -1,3 +1,3 @@
 module Postmaster
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/test/test_address.rb

@@ -10,19 +10,17 @@ require 'uri'
 
 class TestAddressRuby < Test::Unit::TestCase
   include Mocha
- 
-  sample_address = 
- 
+
   context "Address" do
 
     should "be valid" do
       result = Postmaster::AddressValidation.validate({
-        :company => "Asls",
+        :company => "Postmaster Inc.",
         :contact => "Joe Smith",
-        :line1 => "1110 Algarita Ave",
+        :line1 => "701 Brazos St. Suite 1616",
         :city => "Austin",
         :state => "TX",
-        :zip_code => "78704",
+        :zip_code => "78701",
         :country => "US",
       })
       
@@ -34,23 +32,43 @@ class TestAddressRuby < Test::Unit::TestCase
       address = result[:addresses][0]
       assert_instance_of(Postmaster::Address, address);
       assert(address.keys.include?(:zip_code))
-      assert_equal("78704", address[:zip_code])
+      assert_equal("78701", address[:zip_code])
     end
     
     should "be invalid" do
+      assert_raises Postmaster::InvalidRequestError do
+          result = Postmaster::AddressValidation.validate({
+            :company => "Postmaster Inc.",
+            :contact => "Joe Smith",
+            :line1 => "007 Nowhere Ave",
+            :city => "Austin",
+            :state => "TX",
+            :zip_code => "00001",
+            :country => "US",
+          })
+      end
+    end
+    
+    should "be valid with address instead of line1" do
       result = Postmaster::AddressValidation.validate({
-        :company => "Asls",
+        :company => "Postmaster Inc.",
         :contact => "Joe Smith",
-        :line1 => "007 Nowhere Ave",
+        :address => ["701 Brazos St. Suite 1616"],
         :city => "Austin",
         :state => "TX",
-        :zip_code => "00001",
+        :zip_code => "78701",
         :country => "US",
       })
       
       assert_instance_of(Postmaster::AddressValidation, result);
       assert(result.keys.include?(:status))
-      assert_equal("WRONG_ADDRESS", result[:status])
+      assert_kind_of(Array, result[:addresses])
+      assert(!result[:addresses].empty?)
+      
+      address = result[:addresses][0]
+      assert_instance_of(Postmaster::Address, address);
+      assert(address.keys.include?(:zip_code))
+      assert_equal("78701", address[:zip_code])
     end
     
   end

data/test/test_rates.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require 'postmaster'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'rest-client'
+require 'cgi'
+require 'uri'
+
+class TestRatesRuby < Test::Unit::TestCase
+  include Mocha
+ 
+  context "Rates" do
+
+    should "return data" do
+      result = Postmaster::Rates.get(
+        :from_zip => "78701",
+        :to_zip => "78704",
+        :weight => 1.5,
+        :carrier => "fedex"
+      )
+      
+      assert_instance_of(Postmaster::Rates, result);
+      assert(result.keys.include?(:currency))
+      assert(result.keys.include?(:charge))
+      assert(result.keys.include?(:service))
+      
+      possible_values = ['GROUND', '3DAY', '2DAY', '2DAY_EARLY', '1DAY', '1DAY_EARLY', '1DAY_MORNING']
+      assert(possible_values.include?(result[:service]))
+    end
+
+  end
+end

data/test/test_shipment.rb

@@ -13,35 +13,31 @@ class TestShipmentRuby < Test::Unit::TestCase
  
   sample_shipment = {
     :to => {
-      :company => "ASLS",
+      :company => "Postmaster Inc.",
       :contact => "Joe Smith",
-      :line1 => "1110 Algarita Ave",
+      :line1 => "701 Brazos St. Suite 1616",
       :city => "Austin",
       :state => "TX",
-      :zip_code => "78704-4429",
-      :phone_no => "919-720-7941",
-      :country => "US"
+      :zip_code => "78701",
+      :phone_no => "512-693-4040",
     },
-    :from_ => {
-      :company => "ASLS",
+    :from => {
+      :company => "Postmaster Inc.",
       :contact => "Joe Smith",
-      :line1 => "1110 Algarita Ave",
+      :address => ["701 Brazos St. Suite 1616"],
       :city => "Austin",
       :state => "TX",
-      :zip_code => "78704-4429",
-      :phone_no => "919-720-7941",
-      :country => "US"
+      :zip_code => "78701",
+      :phone_no => "512-693-4040",
     },
-    :carrier => "ups",
+    :carrier => "fedex",
     :service => "2DAY",
     :package => {
-      :value => 55,
       :weight => 1.5,
       :length => 10,
       :width => 6,
       :height => 8,
     },
-    :reference => "Order # 54321"
   }
  
   context "Shipment" do
@@ -51,12 +47,14 @@ class TestShipmentRuby < Test::Unit::TestCase
       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(result.keys.include?(:packages))
+      assert_kind_of(Array, result[:packages])
+      assert(!result[:packages].empty?)
+      assert_instance_of(Postmaster::Package, result[:packages][0])
+      assert(result[:packages][0].keys.include?(:type))
+      assert_equal("CUSTOM", result[:packages][0][:type])
       assert_instance_of(Postmaster::Address, result[:to])
-      assert_instance_of(Postmaster::Address, result[:from_])
+      assert_instance_of(Postmaster::Address, result[:from])
     end
     
     should "be the same after retreave" do
@@ -66,8 +64,6 @@ class TestShipmentRuby < Test::Unit::TestCase
       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)

data/test/test_tracking.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require 'postmaster'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'rest-client'
+require 'cgi'
+require 'uri'
+
+class TestTrackingRuby < Test::Unit::TestCase
+  include Mocha
+ 
+  context "Tracking" do
+
+    should "return data" do
+      result = Postmaster::Tracking.track('1ZW470V80310800043')
+      
+      assert_instance_of(Postmaster::Tracking, result);
+      assert(result.keys.include?(:status))
+      assert(result.keys.include?(:history))
+      assert(!result.history.empty?)
+      assert_instance_of(Postmaster::TrackingHistory, result.history[0])
+    end
+
+  end
+end

data/test/test_transit_times.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require 'postmaster'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'rest-client'
+require 'date'
+require 'cgi'
+require 'uri'
+
+class TestTransitTimesRuby < Test::Unit::TestCase
+  include Mocha
+ 
+  context "Transit times" do
+
+    should "be able to get" do
+      result = Postmaster::TransitTimes.get(
+        :from_zip => "78701",
+        :to_zip => "78704",
+        :weight => 1.5,
+        :carrier => "fedex"
+      )
+      
+      assert_kind_of(Array, result)
+      assert(!result.empty?)
+      assert_instance_of(Postmaster::TransitTime, result[0])
+      assert(result[0].keys.include?(:delivery_timestamp))
+      assert(result[0].keys.include?(:service))
+      assert_instance_of(DateTime, result[0][:delivery_timestamp])
+      
+      possible_values = ['GROUND', '3DAY', '2DAY', '2DAY_EARLY', '1DAY', '1DAY_EARLY', '1DAY_MORNING']
+      assert(possible_values.include?(result[0][:service]))
+    end
+    
+
+    
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: postmaster
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Postmaster
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-27 00:00:00 Z
+date: 2013-05-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -136,15 +136,20 @@ files:
 - lib/postmaster/json.rb
 - lib/postmaster/package.rb
 - lib/postmaster/postmaster_object.rb
+- lib/postmaster/rates.rb
 - lib/postmaster/shipment.rb
 - lib/postmaster/tracking.rb
+- lib/postmaster/transit_times.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_rates.rb
 - test/test_shipment.rb
+- test/test_tracking.rb
+- test/test_transit_times.rb
 homepage: https://www.postmaster.io
 licenses: []
 
@@ -182,4 +187,7 @@ test_files:
 - test/test_address.rb
 - test/test_helper.rb
 - test/test_postmaster.rb
+- test/test_rates.rb
 - test/test_shipment.rb
+- test/test_tracking.rb
+- test/test_transit_times.rb