pbshipping 1.0.0

data/lib/pbshipping/manifest.rb

@@ -0,0 +1,130 @@
+#
+# Copyright 2016 Pitney Bowes Inc.
+#
+# Licensed under the MIT License (the "License"); you may not use this file 
+# except in compliance with the License. You may obtain a copy of the License 
+# in the LICENSE file or at 
+#     https://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software 
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+# See the License for the specific language governing permissions and 
+# limitations under the License.
+#
+# File: manifest.rb
+# Description: manifest management functions
+# 
+
+module PBShipping
+  class Manifest < ShippingApiResource
+ 
+    # 
+    # MANAGING MANIFESTS
+    # API: POST /manifests
+    # API signature: post/manifests
+    #
+    # Create a USPS scan form
+    #
+    # By default, the returned result would overwrite the current state 
+    # of the object. To avoid overwriting, set the input argument 
+    # overwrite to False and a copy of the result would be generated and
+    # returned instead      
+    #
+    def create(auth_obj, txid, overwrite=true)
+      if self.key?(:carrier) == false
+        raise MissingResourceAttribute.new(:carrier)
+      elsif self.key?(:parcelTrackingNumbers) == false
+        raise MissingResourceAttribute.new(:parcelTrackingNumbers)
+      elsif self.key?(:submissionDate) == false
+        raise MissingResourceAttribute.new(:submissionDate)
+      elsif self.key?(:fromAddress) == false
+        raise MissingResourceAttribute.new(:fromAddress)
+      end
+      hdrs = { PBShipping::txid_attrname => txid }
+      payload = {
+        :carrier => self[:carrier],
+        :parcelTrackingNumbers => self[:parcelTrackingNumbers],
+        :submissionDate => self[:submissionDate],
+        :fromAddress => self[:fromAddress]
+      }
+      api_sig = "post/manifests"
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/manifests"
+      json_resp = PBShipping::api_request(
+        auth_obj, :post, api_version, api_path, hdrs, {}, payload)
+      if overwrite == true
+        self.update(json_resp)
+        self
+      else
+        Manifest.new(json_resp)
+      end
+    end
+
+    # 
+    # MANAGING MANIFESTS
+    # API: GET /manifests/{manifestId}
+    # API signature: get/manifests/...
+    #
+    # Reprint the USPS scan form
+    #
+    # By default, the returned result would overwrite the current state 
+    # of the object. To avoid overwriting, set the input argument 
+    # overwrite to False and a copy of the result would be generated and
+    # returned instead  
+    #    
+    def reprint(auth_obj, overwrite=true)
+      if self.key?(:manifestId) == false
+        raise MissingResourceAttribute.new(:manifestId)
+      end
+      api_sig = "get/manifests/..."
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/manifests/" + self[:manifestId]
+      json_resp = PBShipping::api_request(
+        auth_obj, :get, api_version, api_path, {}, {}, {})
+      if overwrite == true
+        self.update(json_resp)
+        self
+      else
+        Manifest.new(json_resp)   
+      end     
+    end
+    
+    def self.reprintById(auth_obj, manifestId)
+      Manifest.new({:manifestId => manifestId}).reprint(auth_obj)
+    end
+
+    # 
+    # MANAGING MANIFESTS
+    # API: GET /manifests
+    # API signature: get/manifests/
+    #
+    # Retry a manifest request that was previously submitted with no successful 
+    # response
+    #
+    # By default, the returned result would overwrite the current state 
+    # of the object. To avoid overwriting, set the input argument 
+    # overwrite to False and a copy of the result would be generated and
+    # returned instead      
+    #    
+    def retry(auth_obj, txid, originalTxid, overwrite=true)
+      hdrs = { PBShipping::txid_attrname => txid }
+      params = { :originalTransactionId => originalTxid }
+      api_sig = "get/manifests"
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/manifests"
+      json_resp = PBShipping::api_request(
+        auth_obj, :get, api_version, api_path, hdrs, params, {})
+      if overwrite == true
+        self.update(json_resp)
+        self
+      else
+        Manifest.new(json_resp)      
+      end  
+    end
+    
+    def self.retryByTransactionId(auth_obj, txid, originalTxid)
+      Manifest.new().retry(auth_obj, txid, originalTxid)
+    end
+  end
+end

data/lib/pbshipping/merchant.rb

@@ -0,0 +1,22 @@
+#
+# Copyright 2016 Pitney Bowes Inc.
+#
+# Licensed under the MIT License (the "License"); you may not use this file 
+# except in compliance with the License. You may obtain a copy of the License 
+# in the LICENSE file or at 
+#     https://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software 
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+# See the License for the specific language governing permissions and 
+# limitations under the License.
+#
+# File: merchant.rb
+# Description: merchant account class
+# 
+
+module PBShipping
+  class Merchant < ShippingApiResource
+  end
+end

data/lib/pbshipping/parcel.rb

@@ -0,0 +1,26 @@
+#
+# Copyright 2016 Pitney Bowes Inc.
+#
+# Licensed under the MIT License (the "License"); you may not use this file 
+# except in compliance with the License. You may obtain a copy of the License 
+# in the LICENSE file or at 
+#     https://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software 
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+# See the License for the specific language governing permissions and 
+# limitations under the License.
+#
+# File: parcel.rb
+# Description: parcel class
+# 
+
+module PBShipping
+  class Parcel < ShippingApiResource
+  end
+  class ParcelDimension < ShippingApiResource
+  end  
+  class ParcelWeight < ShippingApiResource
+  end  
+end

data/lib/pbshipping/rate.rb

@@ -0,0 +1,32 @@
+#
+# Copyright 2016 Pitney Bowes Inc.
+#
+# Licensed under the MIT License (the "License"); you may not use this file 
+# except in compliance with the License. You may obtain a copy of the License 
+# in the LICENSE file or at 
+#     https://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software 
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+# See the License for the specific language governing permissions and 
+# limitations under the License.
+#
+# File: rate.rb
+# Description: shipping rate class
+# 
+
+module PBShipping
+  class Rate < ShippingApiResource
+  end
+  class DeliveryCommitment < ShippingApiResource
+  end
+  class Discount < ShippingApiResource
+  end
+  class SpecialService < ShippingApiResource
+  end
+  class Surcharge < ShippingApiResource
+  end
+  class Tax < ShippingApiResource
+  end  
+end

data/lib/pbshipping/scandetails.rb

@@ -0,0 +1,22 @@
+#
+# Copyright 2016 Pitney Bowes Inc.
+#
+# Licensed under the MIT License (the "License"); you may not use this file 
+# except in compliance with the License. You may obtain a copy of the License 
+# in the LICENSE file or at 
+#     https://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software 
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+# See the License for the specific language governing permissions and 
+# limitations under the License.
+#
+# File: scandetails.rb
+# Description: SCAN form details object
+# 
+
+module PBShipping
+  class ScanDetails < ShippingApiResource
+  end
+end

data/lib/pbshipping/shipment.rb

@@ -0,0 +1,185 @@
+#
+# Copyright 2016 Pitney Bowes Inc.
+#
+# Licensed under the MIT License (the "License"); you may not use this file 
+# except in compliance with the License. You may obtain a copy of the License 
+# in the LICENSE file or at 
+#     https://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software 
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+# See the License for the specific language governing permissions and 
+# limitations under the License.
+#
+# File: shipment.rb
+# Description: shipment rate quote, creation, and other functions
+# 
+
+module PBShipping
+  class Shipment < ShippingApiResource
+    
+    # 
+    # MANAGING RATES AND SHIPMENTS
+    # API: POST /rates
+    # API signature: post/rates
+    #
+    # Rate a shipment before a shipment label is purchased and printed.
+    #
+    # By default, the returned result would overwrite the current state 
+    # of the object. To avoid overwriting, set the input argument 
+    # overwrite to False and a copy of the result would be generated and
+    # returned instead      
+    #       
+    def getRates(auth_obj, txid, includeDeliveryCommitment=nil, extraHdrs=nil)
+      hdrs = { PBShipping::txid_attrname => txid } 
+      if extraHdrs != nil
+        hdrs.update(extraHdrs)
+      end
+      if includeDeliveryCommitment == nil
+        params = { :includeDeliveryCommitment => false }            
+      else
+        params = { :includeDeliveryCommitment => includeDeliveryCommitment }     
+      end      
+      api_sig = "post/rates"
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/rates"
+      json_resp = PBShipping::api_request(
+        auth_obj, :post, api_version, api_path, hdrs, params, self)
+      rate_list = []
+      json_resp[:rates].each { |rate| rate_list << Rate.new(rate) }
+      return rate_list        
+    end
+
+    # 
+    # MANAGING RATES AND SHIPMENTS
+    # API: POST /shipments/
+    # API signature: post/shipments
+    #
+    # Create a shipment and purchase a shipment label.
+    #     
+    def createAndPurchase(auth_obj, txid, includeDeliveryCommitment=nil, 
+      extraHdrs=nil, overwrite=true)
+      hdrs = { PBShipping::txid_attrname => txid }
+      if extraHdrs != nil
+        hdrs.update(extraHdrs)      
+      end
+      if includeDeliveryCommitment == nil
+        params = { :includeDeliveryCommitment => false }            
+      else
+        params = { :includeDeliveryCommitment => includeDeliveryCommitment }     
+      end  
+      api_sig = "post/shipments"
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/shipments"
+      json_resp = PBShipping::api_request(
+        auth_obj, :post, api_version, api_path, hdrs, params, self)
+      if overwrite == true 
+        self.update(json_resp)
+        self
+      else
+        Shipment.new(json_resp)
+      end
+    end
+ 
+    # 
+    # MANAGING RATES AND SHIPMENTS
+    # API: GET /shipments/{shipmentId}
+    # API signature: get/shipments/...
+    #
+    # Reprint a shipment label. 
+    # Note that the number of reprints of a shipment label will be scrutinized 
+    # and restricted.
+    #
+    # By default, the returned result would overwrite the current state 
+    # of the object. To avoid overwriting, set the input argument 
+    # overwrite to False and a copy of the result would be generated and
+    # returned instead      
+    #    
+    def reprintLabel(auth_obj, overwrite=true)
+      if self.key?(:shipmentId) == false
+        raise MissingResourceAttribute.new(:shipmentId)      
+      end
+      api_sig = "get/shipments/..."
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/shipments/" + self[:shipmentId]
+      json_resp = PBShipping::api_request(
+        auth_obj, :get, api_version, api_path, {}, {}, {})
+      if overwrite == true 
+        self.update(json_resp)
+        self
+      else
+        Shipment.new(json_resp) 
+      end       
+    end
+    
+    def self.reprintLabelByShipmentId(auth_obj, shipmentId)
+      Shipment.new({:shipmentId => shipmentId}).reprintLabel(auth_obj)
+    end
+
+    # 
+    # MANAGING RATES AND SHIPMENTS
+    # API: GET /shipments?originalTransactionId
+    # API signature: get/shipments
+    #
+    # Retry a shipment that was previously submitted with no successful response.
+    #
+    # By default, the returned result would overwrite the current state 
+    # of the object. To avoid overwriting, set the input argument 
+    # overwrite to False and a copy of the result would be generated and
+    # returned instead      
+    #         
+    def retry(auth_obj, txid, originalTxid, overwrite=true)
+      hdrs = { PBShipping::txid_attrname => txid }
+      params = {:originalTransactionId => originalTxid}
+      api_sig = "get/shipments"
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/shipments"
+      json_resp = PBShipping::api_request(
+        auth_obj, :get, api_version, api_path, hdrs, params, {})   
+      if overwrite == true 
+        self.update(json_resp)
+        self
+      else
+        Shipment.new(json_resp)   
+      end     
+    end
+    
+    def self.retryByTransactionId(auth_obj, txid, originalTxid)
+      Shipment.new().retry(auth_obj, txid, originalTxid)
+    end
+
+    # 
+    # MANAGING RATES AND SHIPMENTS
+    # API: DELETE /shipment/{shipmentId}
+    # API signature: delete/shipments/...
+    #
+    # Cancel/void a shipment, and submit the shipment label for refund.
+    #       
+    def cancel(auth_obj, txid, carrier, cancelInitiator=nil)
+      if self.key?(:shipmentId) == false
+        raise MissingResourceAttribute.new(:shipmentId)
+      end
+      hdrs = { PBShipping::txid_attrname => txid }
+      payload = { :carrier => carrier }
+      if cancelInitiator != nil
+        payload[:cancelInitiator] = cancelInitiator
+      end
+      api_sig = "delete/shipments/..."
+      api_version = PBShipping::get_api_version(api_sig)
+      api_path = "/shipments/" + self[:shipmentId]
+      json_resp = PBShipping::api_request(
+        auth_obj, :delete, api_version, api_path, hdrs, nil, payload) 
+      ApiObject.new(json_resp)
+    end
+    
+    def cancelByShipmentId(auth_obj, txid, shipmentId, carrier, cancelInitiator=nil)
+      Shipment.new({:shipmentId => shipmentId}).cancel(
+        auth_obj, txid, carrier, cancelInitiator)
+    end
+  end
+  class ShipmentOptions < ShippingApiResource
+  end
+  class ShipmentLabel < ShippingApiResource
+  end  
+end

data/lib/pbshipping/shipping_api_resource.rb

@@ -0,0 +1,26 @@
+#
+# Copyright 2016 Pitney Bowes Inc.
+#
+# Licensed under the MIT License (the "License"); you may not use this file 
+# except in compliance with the License. You may obtain a copy of the License 
+# in the LICENSE file or at 
+#     https://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software 
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+# See the License for the specific language governing permissions and 
+# limitations under the License.
+#
+# File: shipping_api_resource.rb
+# Description: shipping api resource base class
+# 
+
+module PBShipping
+  class ShippingApiResource < ApiResource
+  end
+  class Document < ShippingApiResource
+  end
+  class Parameter < ShippingApiResource
+  end
+end