shipsurance 0.1.0

data/Manifest

@@ -0,0 +1,25 @@
+config/credentials.example.yml
+config/credentials.yml
+init.rb
+lib/extensions/hash.rb
+lib/shipsurance/address.rb
+lib/shipsurance/base.rb
+lib/shipsurance/claim.rb
+lib/shipsurance/person.rb
+lib/shipsurance/record_shipment.rb
+lib/shipsurance/response.rb
+lib/shipsurance/shipsurance.rb
+lib/shipsurance/validation.rb
+lib/shipsurance/void_record_shipment.rb
+lib/shipsurance.rb
+Rakefile
+README.rdoc
+spec/lib/shipsurance/address_spec.rb
+spec/lib/shipsurance/claim_spec.rb
+spec/lib/shipsurance/person_spec.rb
+spec/lib/shipsurance/record_shipment_spec.rb
+spec/lib/shipsurance/validation_spec.rb
+spec/lib/shipsurance/void_record_shipment_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,22 @@
+# Testing URL's
+
+# Claim
+
+# Test Url: http://dev.dsiins.com/dsiapp/api.net/dsi_claim.aspx
+# Live Url: https://www.dsiins.com/api.net/dsi_claim.aspx
+
+# Recorded Shipment
+
+# Test Url: http://dev.dsiins.com/dsiapp/api.net/dsi_recordShipment.aspx
+# Live Url: https://www.dsiins.com/api.net/dsi_recordShipment.aspx
+
+# Validation API
+
+# Test Url: http://dev.dsiins.com/dsiapp/api.net/dsi_Validation.aspx
+# Live Url: https://www.dsiins.com/api.net/dsi_Validation.aspx
+
+# Voided Recorded Shipments
+
+# Test Url: http://dev.dsiins.com/dsiapp/api.net/dsi_voidRecordShipment.aspx
+# Live Url: https://www.dsiins.com/api.net/dsi_voidRecordShipment.aspx
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('shipsurance', '0.1.0') do |p|
+  p.description              = "Integration gem for the ShipSurance gem"
+  p.url                      = "http://www.ordercup.com"
+  p.author                   = "Tim Matheson"
+  p.email                    = "tim.matheson@ordercup.com"
+  p.ignore_pattern           = ["tmp/*","script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/config/credentials.example.yml

@@ -0,0 +1,13 @@
+production:
+  username: ""
+  password: ""
+  ext_person_source_id: ""
+  ext_policy_id: ""
+  person_email: ""
+  
+development:
+  username: ""
+  password: ""
+  ext_person_source_id: ""
+  ext_policy_id: ""
+  person_email: ""

data/config/credentials.yml

@@ -0,0 +1,21 @@
+production:
+  username: "ordercup"
+  password: "ock88j67"
+  ext_policy_id: "311974"
+  ext_person_source_id: "38"
+  person_email: "aloke.nath@ordercup.com"
+  
+development:
+  username: "ordercup"
+  password: "ock88j67"
+  ext_policy_id: "311974"
+  ext_person_source_id: "38"
+  person_email: "aloke.nath@ordercup.com"
+  
+test:
+  username: "ordercup"
+  password: "ock88j67"
+  ext_policy_id: "311974"
+  ext_person_source_id: "38"
+  person_email: "aloke.nath@ordercup.com"
+  

data/init.rb

@@ -0,0 +1 @@
+require 'lib/shipsurance'

data/lib/extensions/hash.rb

@@ -0,0 +1,22 @@
+require 'cgi'
+
+class Hash  
+  def to_s
+    keys.each do |key|
+      self[parametize(key.to_s)] = CGI.escape(self[key].to_s)
+      delete(key)
+    end
+    self
+  end
+  
+  def parametize(str)
+    if str.to_s == "ext_rs_void_reason_id"
+      "extRSVoidReasonId"
+    else
+      params = str.to_s.split("_")
+      params[0] + params[1..-1].map(&:titleize).join
+    end
+  end
+end
+
+

data/lib/shipsurance.rb

@@ -0,0 +1,14 @@
+RAILS_ENV = "development" #unless defined?(RAILS_ENV) #stub for dev
+require 'rubygems'
+require 'active_support'
+require 'extensions/hash'
+require 'shipsurance/shipsurance'
+require 'shipsurance/base'
+require 'shipsurance/claim'
+require 'shipsurance/record_shipment'
+require 'shipsurance/void_record_shipment'
+require 'shipsurance/validation'
+require 'shipsurance/person'
+require 'shipsurance/address'
+require 'shipsurance/response'
+

data/lib/shipsurance/address.rb

@@ -0,0 +1,14 @@
+# Simple address object for API requests
+module Shipsurance
+  class Address
+    attr_reader :attributes
+    attr_accessor :address_1, :address_2, :city, :state, :postal_code, :country
+    
+    def initialize(attributes = {})
+      @attributes = attributes
+      attributes.map do |name, value|
+        instance_variable_set("@#{name.to_s}",value)
+      end
+    end
+  end
+end

data/lib/shipsurance/base.rb

@@ -0,0 +1,107 @@
+# Module for integrating with the Shipsurance API.
+module Shipsurance
+  class Base
+    require 'net/http'
+    require 'yaml'
+    @@live_base_url = "https://www.dsiins.com/api.net"
+    @@test_base_url = "http://dev.dsiins.com/dsiapp/api.net"
+    @@errors        = []
+    
+    # Adds the request credentials to the request.
+    # This method should be called for every request that requires
+    # authentication to process the request.
+    def add_credentials(post = {})
+      post[:ext_person_source_id] = credentials[:ext_person_source_id]
+      post[:source_username]      = credentials[:username]
+      post[:source_password]      = credentials[:password]
+      post[:ext_policy_id]        = credentials[:ext_policy_id]
+      post
+    end
+    
+    # Adds a person to the request parameters
+    # Accepts a Shipsurance::Person object
+    def add_person(person, post = {})
+      post[:person_source_identifier] = person.source_identifier
+      post[:person_company]            = person.company
+      post[:person_first_name]         = person.first_name
+      post[:person_last_name]          = person.last_name
+      post[:person_phone]              = person.phone
+      post[:person_fax]                = person.fax
+      post[:person_email]              = person.email
+      post
+    end
+    
+    # Adds the recorded shipment id to the parameters hash
+    def add_recorded_shipment_id(recorded_shipment_id, post = {})
+      post[:recorded_shipment_id] = recorded_shipment_id
+      post
+    end
+        
+    # Commit the parameters to the API
+    # This processes the request, and returns the response
+    def commit(post)
+      add_credentials(post)
+      validate_request(post)
+      url = URI.parse(resource_url)
+      req = Net::HTTP::Post.new(url.path)
+      req.set_form_data(post.to_s)
+      res = Net::HTTP.new(url.host, url.port).start {|http| http.request(req) }
+      case res
+      when Net::HTTPSuccess#, Net::HTTPRedirection
+        Shipsurance::Response.new(res)
+      else
+        raise Shipsurance::RequestError, res.error!
+      end
+    end
+    
+    # Used for debugging, alias to puts
+    def display(msg)
+      puts "=" * 15 + " REQUEST " + "=" * 15 
+      puts msg
+      puts "=" * 15 + " EOF REQUEST " + "=" * 15
+    end
+    
+    # Returns the correct url for the current resource
+    # Appends the correct path to the base_url
+    def resource_url
+      base_url + "/dsi_" + resource_name + ".aspx"
+    end
+    
+    # Returns the resource name downcased as a string
+    def resource_name
+      resource_class.slice(0,1).downcase + resource_class.slice(1,resource_class.length)
+    end
+    
+    # Returns the class name of the current class as a string
+    def resource_class
+      @resource_class ||= self.class.to_s.split(":").last
+    end
+    
+    def base_url
+      return RAILS_ENV =~ /production/ ? @@live_base_url : @@test_base_url
+    end
+    
+    # Returns an array of the required parameters for the current class.
+    def required
+      [:ext_person_source_id, :source_username, :source_password, :ext_policy_id]
+    end
+    
+    private
+   
+    def format_date(date, format = "%m/%d/%Y")
+      date.is_a?(Time) ? date.strftime(format) : date
+    end
+    
+    def validate_request(post)
+      @@errors.clear
+      required.each do |key|
+        @@errors << "Missing required parameter #{key.to_s}" unless post.has_key?(key)
+      end
+      raise Shipsurance::RequestError, @@errors.join(", ") unless @@errors.empty?
+    end
+    
+    def credentials
+      @credentials ||= YAML.load_file(File.dirname(__FILE__) + "/../../config/credentials.yml")[RAILS_ENV].symbolize_keys
+    end
+  end
+end

data/lib/shipsurance/claim.rb

@@ -0,0 +1,132 @@
+# FIELD                  REQUIRED VALUE MAX DESCRIPTION
+# extPersonSourceId      Required Varies by User The Source ID used to access the system
+# sourceUsername         Required Varies by User 50 The Username used to access the system
+# sourcePassword         Required Varies by User 50 The Password used to access the system
+# extPolicyId            Required String 10 DSI Policy Number
+# personSourceIdentifier Required String 100 External Person identifier
+# personCompany          Optional String 150 Person Company name
+# personFirstName        Required String 50 Person First Name
+# personLastName         Required String 50 Person Last Name
+# personPhone            Optional String 50 Person Phone
+# personFax              Optional String 50 Person Fax
+# personEmail            Required String 50 Person Email
+# recordedShipmentId     Required String 36 DSI Recorded Shipment ID
+# claimSourceIdentifier  Optional String 50 External Transaction Identifier
+# extCarrierId           Required See Lookup Codes Carrier ID’s - Appendix 1
+# carrierServiceName     Optional Strinf 150 Carrier Service Name
+# consigneeFullName      Required String 100 Full Name of Consignee
+# claimPaymentFullName   Required String 15 Name to make the Claim Check Payable To
+# claimPaymentAddress1   Required String 100 Claim Payment Address
+# claimPaymentAddress2   Optional String 100 Claim Payment Address
+# claimPaymentCity       Required String 50 Claim Payment Address
+# claimPaymentState      Optional String 2 Claim Payment Address
+# claimPaymentPostalCode Required String 100 Claim Payment Address
+# claimPaymentCountry    Required String 100 Claim Payment Address
+# claimPaymentPhone      Required String 100 Claim Payment Phone
+# claimPaymentFax        Optional String 50 Claim Payment Fax
+# claimPaymentEmail      Optional String 100 Claim Payment Email
+# fileDate               Required MM/DD/YYYY Date claim filed (Now)
+# lossDiscoveredDate     Required MM/DD/YYYY Date loss discovered
+# extClaimTypeId         Required 1 or 2 1 1 = Loss 2 = Damage
+# claimDescription       Required String 4000 Description of claim
+# claimAmount            Required Currency 8 Claim Amount (must be less than recorded shipment declared value)
+# certifyCorrect         Required 0 or 1 1 0 = No 1 = Yes (Must answer 1 to file)
+module Shipsurance
+  class Claim < Base
+    def add_claim_source_identifier(claim_source_identifier, post = {})
+      post[:claim_source_identifier] = claim_source_identifier
+      post
+    end
+    
+    def add_ext_carrier_id(id, post = {})
+      post[:ext_carrier_id] = id
+      post
+    end
+    
+    def add_consignee_full_name(full_name, post = {})
+      post[:consignee_full_name] = full_name
+      post
+    end
+    
+    def add_claim_payment_full_name(full_name, post = {})
+      post[:claim_payment_full_name] = full_name
+      post
+    end
+    
+    def add_claim_payment_address(address, post = {})
+      add_claim_payment_address_1(address.address_1, post)
+      add_claim_payment_city(address.city, post)
+      add_claim_payment_postal_code(address.postal_code, post)
+      add_claim_payment_country(address.country, post)
+      post
+    end
+    
+    def add_claim_payment_address_1(address_1, post = {})
+      post[:claim_payment_address_1] = address_1
+      post
+    end
+    
+    def add_claim_payment_city(city, post = {})
+      post[:claim_payment_city] = city
+      post
+    end
+    
+    def add_claim_payment_postal_code(postal_code, post = {})
+      post[:claim_payment_postal_code] = postal_code
+      post
+    end
+    
+    def add_claim_payment_country(country, post = {})
+      post[:claim_payment_country] = country
+      post
+    end
+    
+    def add_claim_payment_phone(phone, post = {})
+      post[:claim_payment_phone] = phone
+      post
+    end
+    
+    def add_file_date(date, post = {})
+      post[:file_date] = date.strftime("%m/%d/%Y %H:%M %p")#format_date(date)
+      post
+    end
+    
+    def add_loss_discovered_date(date, post = {})
+      post[:loss_discovered_date] = format_date(date)
+      post
+    end
+    
+    def add_ext_claim_type_id(id, post = {})
+      post[:ext_claim_type_id] = id
+      post
+    end
+    
+    def add_claim_description(description, post = {})
+      post[:claim_description] = description
+      post
+    end
+    
+    def add_claim_amount(amount, post = {})
+      post[:claim_amount] = amount
+      post
+    end
+    
+    def add_certify_correct(bool, post = {})
+      post[:certify_correct] = bool ? 1 : 0
+    end
+    
+    def add_claim_shipment_date(date, post = {})
+      post[:claim_shipment_date] = format_date(date)
+      post
+    end
+    
+    def required
+      super.push(:person_source_identifier, :person_first_name, :person_last_name, 
+       :person_email, :recorded_shipment_id, :ext_carrier_id, :consignee_full_name, 
+       :claim_payment_full_name, :claim_payment_address_1, :claim_payment_city,
+       :claim_payment_postal_code, :claim_payment_country, :claim_payment_phone, :file_date, 
+       :loss_discovered_date, :ext_claim_type_id,:claim_description,:claim_amount, :certify_correct, :claim_shipment_date)
+    end
+  end
+end
+  

data/lib/shipsurance/person.rb

@@ -0,0 +1,14 @@
+# Simple person object for API requests
+module Shipsurance
+  class Person
+    attr_reader :attributes
+    attr_accessor :source_identifier, :company, :first_name, :last_name, :phone, :fax, :email
+    
+    def initialize(attributes = {})
+      @attributes = attributes
+      attributes.map do |name, value|
+        instance_variable_set("@#{name.to_s}",value)
+      end
+    end
+  end
+end

data/lib/shipsurance/record_shipment.rb

@@ -0,0 +1,216 @@
+# FIELD                    REQUIRED   VALUE  MAX DESCRIPTION
+# extPersonSourceId        Required   Varies by User The Source ID used to access the system
+# sourceUsername           Required   Varies by User 50 The Username used to access the system
+# sourcePassword           Required   Varies by User 50 The Password used to access the system
+# extPolicyId              Required   String 10 Shipsurance Policy Number
+# personSourceIdentifier   Optional   String 100 External Person identifier
+# personCompany            Optional   String 150 Person Company name
+# personFirstName          Optional   String 50 Person First Name
+# personLastName           Optional   String 50 Person Last Name
+# personPhone              Optional   String 50 Person Phone
+# personFax                Optional   String 50 Person Fax
+# personEmail              Required   String 50 Person Email
+# recordSourceIdentifier   Optional   String 50 External Transaction Identifier
+# extShipmentTypeId        Required   1 or 2 1 1 = Parcel 2 = Cargo/Freight
+# extCarrierId             Required   See Lookup Codes Carrier ID’s - Appendix 1
+# carrierServiceName       Required   String 150 Class of shipping service
+# referenceNumber          Optional   String 100 Reference Number
+# trackingNumber           Optional   String 100 Tracking Number
+# declaredValue            Required   Currency 8 Declared Value of the recorded shipment
+# transactionDate          Optional   MM/DD/YYYY Date of Transaction - REMOVED
+# shipmentDate             Required   MM/DD/YYYY Date of Shipment
+# arrivalDate              Optional   MM/DD/YYYY Date of Shipment Arrival
+# extCommodityCategoryId   Optional   See Lookup Codes Commodity Category - Appendix 1
+# extCommodityTypeId       Optional   See Lookup Codes Commodity Type - Appendix 1
+# extPackageTypeId         Optional   See Lookup Codes Package Type - Appendix 1
+# packageCount             Optional   String 100 Number of packages
+# containsGlass            Optional   0 or 1 1 0 = No 1 = Yes
+# packageDescription       Required   String 4000 Contents of shipment
+# departureAddress1        Optional   String 100 Parcel Departure Address
+# departureAddress2        Optional   String 100 Parcel Departure Address
+# departureCity            Optional   String 50 Parcel Departure Address
+# departureState           Optional   String 2 Parcel Departure Address
+# departurePostalCode      Optional   String 100 Parcel Departure Address
+# departureCountry         Optional   String 100 Parcel Departure Address
+# consigneeFirstName       Optional   String 50 Recipient First Name- REMOVED
+# consigneeLastName        Optional   String 50 Recipient Last Name- REMOVED
+# consigneeFullName        Optional   String 150 Recipient Full Name
+# destinationAddress1      Optional   String 100 Parcel Destination Address
+# destinationAddress2      Optional   String 100 Parcel Destination Address
+# destinationCity          Optional   String 50 Parcel Destination Address
+# destinationState         Optional   String 2 Parcel Destination Address
+# destinationPostalCode    Optional   String 100 Parcel Destination Address
+# destinationCountry       Optional   String 100 Parcel Destination Address
+# insuredCompany           Optional   String 150 Insured’s Company Name
+module Shipsurance
+  class RecordShipment < Base
+    def add_tracking_number(number, post = {})
+      post[:tracking_number] = number
+      post
+    end
+    
+    def add_reference_number(number, post = {})
+      post[:reference_number] = number
+      post
+    end
+    
+    def add_carrier(id, service_name, post = {})
+      post[:ext_carrier_id] = id
+      post[:carrier_name]   = service_name
+      post
+    end
+    
+    def add_ext_shipment_type_id(ext_shipment_type_id, post = {})
+      post[:ext_shipment_type_id] = ext_shipment_type_id
+      post
+    end
+    
+    def add_record_source_identifier(record_source_identifier, post = {})
+      post[:record_source_identifier] = record_source_identifier
+      post
+    end
+    
+    def add_shipment_date(date, post = {})
+      post[:shipment_date] = format_date(date)
+      post
+    end
+    
+    def add_arrival_date(date, post = {})
+      post[:arrival_date] = format_date(date)
+      post
+    end
+    
+    def add_ext_commodity_category_id(category_id, post = {})
+      post[:ext_commodity_category_id] = category_id
+      post
+    end
+    
+    def add_ext_package_type_id(ext_package_type_id, post = {})
+      post[:ext_package_type_id] = ext_package_type_id
+      post
+    end
+    
+    def add_package_count(package_count, post = {})
+      post[:package_count] = package_count
+      post
+    end
+    
+    # optional 0 = No, 1 = Yes
+    def add_contains_glass(contains_glass, post = {})
+      post[:contains_glass] = contains_glass
+      post
+    end
+    
+    def add_package_description(package_description, post = {})
+      post[:package_description] = package_description
+      post
+    end
+    
+    # Accepts a Shipsurance address object
+    # Adds the departure address to the request
+    def add_departure_address(address, post = {})
+      add_departure_address_1(address.address_1, post)
+      add_departure_address_2(address.address_2, post) if address.address_2
+      add_departure_city(address.city, post)
+      add_departure_state(address.state, post)
+      add_departure_postal_code(address.postal_code, post)
+      add_departure_country(address.country, post)
+    end
+    
+    def add_departure_address_1(departure_address_1, post = {})
+      puts "Invoked #{add_departure_address_1}"
+      post[:departure_address_1] = departure_address_1
+      post
+    end
+    
+    def add_departure_address_2(departure_address_2, post = {})
+      post[:departure_address_2] = departure_address_2
+      post
+    end
+    
+    def add_departure_city(departure_city, post = {})
+      post[:departure_city] = departure_city
+      post
+    end
+    
+    def add_departure_state(departure_state, post = {})
+      post[:departure_state] = departure_state
+      post
+    end
+    
+    def add_departure_postal_code(departure_postal_code, post = {})
+      post[:departure_postal_code] = departure_postal_code
+      post
+    end
+    
+    def add_departure_country(departure_country, post = {})
+      post[:departure_country] = departure_country
+      post
+    end
+    
+    def add_consignee_first_name(consignee_first_name, post = {})
+      post[:consignee_first_name] = consignee_first_name
+      post
+    end
+
+    def add_consignee_last_name(consignee_last_name, post = {})
+      post[:consignee_last_name] = consignee_last_name
+      post
+    end
+
+    def add_consignee_full_name(consignee_full_name ,post = {})
+      post[:consignee_full_name] = consignee_full_name
+      post
+    end
+    
+    # Accepts a Shipsurance address object
+    # Adds the destination address to the request
+    def add_destination_address(address, post = {})
+      add_destination_address_1(address.address_1, post)
+      add_destination_address_2(address.address_2, post) if address.address_2
+      add_destination_city(address.city, post)
+      add_destination_state(address.state, post)
+      add_destination_postal_code(address.postal_code, post)
+      add_destination_country(address.country, post)
+    end
+
+    def add_destination_address_1(destination_address_1, post = {})
+      post[:destination_address_1] = destination_address_1
+      post
+    end
+
+    def add_destination_address_2(destination_address_2, post = {})
+      post[:destination_address_2] = destination_address_2
+      post
+    end
+
+    def add_destination_city(destination_city, post = {})
+      post[:destination_city] = destination_city
+      post
+    end
+
+    def add_destination_state(destination_state, post = {})
+      post[:destination_state] = destination_state
+      post
+    end
+
+    def add_destination_postal_code(destination_postal_code, post = {})
+      post[:destination_postal_code] = destination_postal_code
+      post
+    end
+    
+    def add_destination_country(destination_country, post = {})
+      post[:destination_country] = destination_country
+      post
+    end
+
+    def add_insured_company(insured_company, post = {})
+      post[:insured_company] = insured_company
+      post
+    end
+        
+    def required
+      super.push(:ext_shipment_type_id, :ext_carrier_id, :carrier_service_name, :declared_value, :shipment_date, :person_email, :package_description)
+    end
+  end
+end

data/lib/shipsurance/response.rb

@@ -0,0 +1,16 @@
+module Shipsurance
+  class Response
+    attr_reader :code, :body, :api_response_code, :success, :recorded_shipment_id
+    
+    def initialize(response)
+      response_arry = response.body.split(",")
+      @code, @api_response_code, @body, @recorded_shipment_id = response.code.to_i, response_arry[0].to_i, response_arry[1], response_arry[2]
+      @success = (@response_code == 1)
+      self
+    end 
+    
+    def parse(response)
+      response.body.split(",")
+    end
+  end
+end

data/lib/shipsurance/shipsurance.rb

@@ -0,0 +1,3 @@
+module Shipsurance
+  class RequestError < StandardError; end;
+end

data/lib/shipsurance/validation.rb

@@ -0,0 +1,7 @@
+module Shipsurance
+  class Validation < Base
+    def required
+      super.push(:validation_type)
+    end
+  end
+end

data/lib/shipsurance/void_record_shipment.rb

@@ -0,0 +1,7 @@
+module Shipsurance
+  class VoidRecordShipment < Base
+    def required
+      super.push(:person_email,:recorded_shipment_id,:ext_rs_void_reason_id)
+    end
+  end
+end

data/shipsurance.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shipsurance}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Matheson"]
+  s.date = %q{2009-11-28}
+  s.description = %q{Integration gem for the ShipSurance gem}
+  s.email = %q{tim.matheson@ordercup.com}
+  s.extra_rdoc_files = ["lib/extensions/hash.rb", "lib/shipsurance/address.rb", "lib/shipsurance/base.rb", "lib/shipsurance/claim.rb", "lib/shipsurance/person.rb", "lib/shipsurance/record_shipment.rb", "lib/shipsurance/response.rb", "lib/shipsurance/shipsurance.rb", "lib/shipsurance/validation.rb", "lib/shipsurance/void_record_shipment.rb", "lib/shipsurance.rb", "README.rdoc"]
+  s.files = ["config/credentials.example.yml", "config/credentials.yml", "init.rb", "lib/extensions/hash.rb", "lib/shipsurance/address.rb", "lib/shipsurance/base.rb", "lib/shipsurance/claim.rb", "lib/shipsurance/person.rb", "lib/shipsurance/record_shipment.rb", "lib/shipsurance/response.rb", "lib/shipsurance/shipsurance.rb", "lib/shipsurance/validation.rb", "lib/shipsurance/void_record_shipment.rb", "lib/shipsurance.rb", "Rakefile", "README.rdoc", "spec/lib/shipsurance/address_spec.rb", "spec/lib/shipsurance/claim_spec.rb", "spec/lib/shipsurance/person_spec.rb", "spec/lib/shipsurance/record_shipment_spec.rb", "spec/lib/shipsurance/validation_spec.rb", "spec/lib/shipsurance/void_record_shipment_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Manifest", "shipsurance.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://www.ordercup.com}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Shipsurance", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{shipsurance}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Integration gem for the ShipSurance gem}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/lib/shipsurance/address_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Shipsurance::Address do
+  it "should accept all valid address attributes" do
+    address = Shipsurance::Address.new(valid_address_attributes)
+    address.attributes.should == valid_address_attributes
+  end
+  
+  it "should mass assign the address_1 attribute" do
+    address = Shipsurance::Address.new(valid_address_attributes)
+    address.attributes[:address_1].should == valid_address_attributes[:address_1]
+  end
+  
+  it "should mass assign the address_2 attribute" do
+    address = Shipsurance::Address.new(valid_address_attributes)
+    address.attributes[:address_2].should == valid_address_attributes[:address_2]
+  end
+  
+  it "should mass assign the city attribute" do
+    address = Shipsurance::Address.new(valid_address_attributes)
+    address.attributes[:city].should == valid_address_attributes[:city]
+  end
+  
+  it "should mass assign the country attribute" do
+    address = Shipsurance::Address.new(valid_address_attributes)
+    address.attributes[:country].should == valid_address_attributes[:country]
+  end
+  
+  it "should mass assign the postal_code attribute" do
+    address = Shipsurance::Address.new(valid_address_attributes)
+    address.attributes[:postal_code].should == valid_address_attributes[:postal_code]
+  end
+  
+  it "should mass assign the country attribute" do
+    address = Shipsurance::Address.new(valid_address_attributes)
+    address.attributes[:country].should == valid_address_attributes[:country]
+  end
+  
+  
+  private
+  
+  def valid_address_attributes
+    {
+      :address_1 => "123 East St.", 
+      :address_2 => "APT #3", 
+      :city => "Rancho Santa Margarita", 
+      :state => "CA", 
+      :postal_code => 92688, 
+      :country => "US"
+    }
+  end
+end

data/spec/lib/shipsurance/claim_spec.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Shipsurance::Claim do
+  before(:each) do
+    @claim = Shipsurance::Claim.new
+    @address = Shipsurance::Address.new(address_attributes)
+    @shipment_id = Shipsurance::RecordShipment.new.commit(valid_record_shipment_params).recorded_shipment_id
+  end
+  
+  context " a valid request" do
+    # TODO, there is some issue with this call
+    # It complains about fileDate not being set as DateTime but
+    # the API specifies it should be mm/dd/yyyy format.
+    # it "should return success" do
+    #   post = @claim.add_person(person)
+    #   @claim.add_recorded_shipment_id(@shipment_id,post)
+    #   @claim.add_ext_carrier_id(1,post)
+    #   @claim.add_consignee_full_name("Tim Matheson", post)
+    #   @claim.add_claim_payment_full_name("Tim Matheson", post)
+    #   @claim.add_claim_payment_address(@address, post)
+    #   @claim.add_claim_payment_phone("9495551212", post)
+    #   @claim.add_file_date(Time.now, post)
+    #   @claim.add_loss_discovered_date(Time.now, post)
+    #   @claim.add_claim_shipment_date(Time.now, post)
+    #   @claim.add_ext_claim_type_id(1, post)
+    #   @claim.add_claim_description("Test #{rand(9999)}", post)
+    #   @claim.add_claim_amount(5.00, post)
+    #   @claim.add_certify_correct(true, post)
+    #   @claim.commit(post).success.should == true
+    # end
+  end
+  
+  context " attributes" do
+    it "should add the claim_source_identifier" do
+      @claim.add_claim_source_identifier(1).has_key?(:claim_source_identifier).should == true
+    end
+  end
+  
+  private
+  
+  def http_get(domain,path,params)
+    require 'net/http'
+    return Net::HTTP.get(domain, "#{path}?".concat(params.collect { |k,v| '#{k}=#{CGI::escape(v.to_s)}' }.reverse.join('&'))) if not params.nil?
+    return Net::HTTP.get(domain, path)
+  end
+  
+  
+  def person
+    Shipsurance::Person.new({
+      :source_indentifier => 1,
+      :company => "OrderCup",
+      :first_name => "Tim",
+      :last_name => "Matheson",
+      :phone => "9495551212",
+      :fax => "9495551212",
+      :email => CREDENTIALS[:person_email]
+    })
+  end
+  
+  def valid_record_shipment_params
+    {
+      :ext_shipment_type_id => 1,
+      :ext_carrier_id => 1,
+      :carrier_service_name => "UPS",
+      :declared_value => 50.00,
+      :shipment_date => Time.now.strftime("%m/%d/%Y"),
+      :person_email => CREDENTIALS[:person_email],
+      :package_description => "Test Description #{rand(9999999)}"
+    }
+  end
+end

data/spec/lib/shipsurance/person_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Shipsurance::Person do
+  it "should accept all valid person attributes" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes.should == valid_person_attributes
+  end
+  
+  it "should mass assign the first_name attribute" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes[:first_name].should == valid_person_attributes[:first_name]
+  end
+  
+  it "should mass assign the last_name attribute" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes[:last_name].should == valid_person_attributes[:last_name]
+  end
+  
+  it "should mass assign the email attribute" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes[:email].should == valid_person_attributes[:email]
+  end
+  
+  it "should mass assign the source_identifier attribute" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes[:source_identifier].should == valid_person_attributes[:source_identifier]
+  end
+  
+  it "should mass assign the company attribute" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes[:company].should == valid_person_attributes[:company]
+  end
+  
+  it "should mass assign the phone attribute" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes[:phone].should == valid_person_attributes[:phone]
+  end
+  
+  it "should mass assign the fax attribute" do
+    person = Shipsurance::Person.new(valid_person_attributes)
+    person.attributes[:fax].should == valid_person_attributes[:fax]
+  end
+  
+  private
+  
+  def valid_person_attributes
+    {
+      :source_indentifier => 1, 
+      :company => "Ordercup", 
+      :first_name => "Tim", 
+      :last_name => "Matheson", 
+      :phone => "9495551212", 
+      :fax => "9495551212", 
+      :email => "tim.matheson@ordercup.com"
+    }
+  end
+end

data/spec/lib/shipsurance/record_shipment_spec.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Shipsurance::RecordShipment do
+  before(:each) do
+    @record_shipment = Shipsurance::RecordShipment.new
+    @address         = Shipsurance::Address.new(address_attributes)
+  end
+  
+  context " a valid request" do
+    it "should return a successful response given valid params" do
+      response = @record_shipment.commit(valid_request_params)
+      response.body.should == "The transaction was accepted."
+    end
+    
+    it "should return a transaction key given valid params" do
+      response = @record_shipment.commit(valid_request_params)
+      response.recorded_shipment_id.should_not be_nil
+    end
+    
+    it "should return a status code of 200 given valid params" do
+      response = @record_shipment.commit(valid_request_params)
+      response.code.should == 200
+    end
+    
+    it "should return an api response code of 1 given valid params" do
+      response = @record_shipment.commit(valid_request_params)
+      response.api_response_code.should == 1
+    end
+  end
+  
+  context " attributes" do
+    it "should add the tracking number" do
+      @record_shipment.add_tracking_number("1Z999999999999999").has_key?(:tracking_number).should == true
+    end
+
+    it "should add the reference number" do
+      @record_shipment.add_reference_number(123456).has_key?(:reference_number).should == true
+    end
+
+    it "should add the carrier" do
+      params = @record_shipment.add_carrier(1,"UPS")
+      params.has_key?(:carrier_name).should == true
+      params.has_key?(:ext_carrier_id).should == true
+    end
+
+    it "should add the ext_shipment_type_id" do
+      @record_shipment.add_ext_shipment_type_id(1).has_key?(:ext_shipment_type_id).should == true
+    end
+
+    it "should add the record_source_identifier" do
+      @record_shipment.add_record_source_identifier(123456).has_key?(:record_source_identifier).should == true
+    end
+
+    it "should add the recorded_shipment_id" do
+      @record_shipment.add_recorded_shipment_id(1).has_key?(:recorded_shipment_id).should == true
+    end
+
+    it "should add the shipment_date" do
+      params = @record_shipment.add_shipment_date(Time.now)
+      params.has_key?(:shipment_date).should == true
+      params[:shipment_date].should == Time.now.strftime("%m/%d/%Y")
+    end
+
+    it "should add the arrival_date" do
+      params = @record_shipment.add_arrival_date(Time.now)
+      params.has_key?(:arrival_date).should == true
+      params[:arrival_date].should == Time.now.strftime("%m/%d/%Y")
+    end
+
+    it "should add the ext_commodity_category_id" do
+      @record_shipment.add_ext_commodity_category_id(1).has_key?(:ext_commodity_category_id).should == true
+    end
+
+    it "should add the ext_package_type_id" do
+      @record_shipment.add_ext_package_type_id(1).has_key?(:ext_package_type_id).should == true
+    end
+
+    it "should add the package_count" do
+      @record_shipment.add_package_count(1).has_key?(:package_count).should == true
+    end
+
+    it "should add contains_glass" do
+      @record_shipment.add_contains_glass(1).has_key?(:contains_glass).should == true
+    end
+
+    it "should add the package_description" do
+      @record_shipment.add_package_description("Test Description").has_key?(:package_description).should == true
+    end
+
+    it "should add the departure_address" do
+      @record_shipment.should_receive(:add_departure_address_1).once.with(@address.address_1,{})
+      @record_shipment.should_receive(:add_departure_address_2).once.with(@address.address_2,{})
+      @record_shipment.should_receive(:add_departure_city).once.with(@address.city,{})
+      @record_shipment.should_receive(:add_departure_state).once.with(@address.state,{})
+      @record_shipment.should_receive(:add_departure_postal_code).once.with(@address.postal_code,{})
+      @record_shipment.should_receive(:add_departure_country).once.with(@address.country,{})
+      @record_shipment.add_departure_address(@address)
+    end
+  end
+  
+  private
+  
+  def valid_request_params
+    {
+      :ext_shipment_type_id => 1,
+      :ext_carrier_id => 1,
+      :carrier_service_name => "UPS",
+      :declared_value => 50.00,
+      :shipment_date => Time.now.strftime("%m/%d/%Y"),
+      :person_email => CREDENTIALS[:person_email],
+      :package_description => "Test Description #{rand(9999999)}"
+    }
+  end
+end

data/spec/lib/shipsurance/validation_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Shipsurance::Validation do
+  before :each do
+    @validation = Shipsurance::Validation.new
+  end
+  
+  it "should return Accepted given a valid validation type" do
+    response = @validation.commit({ :validation_type => "activePolicy" })
+    response.body.should == "Accepted"
+  end
+  
+  it "should return an api_response_code of 1 given a valid validation type" do
+     response = @validation.commit({ :validation_type => "activePolicy" })
+     response.api_response_code.should == 1
+   end
+  
+  it "should return an error given an invalid validation type" do
+    response = @validation.commit({ :validation_type => "foo" })
+    response.body.should == "The validationType is not valid."
+  end
+  
+  it "should return an api_response_code of 2 given an invalid validation type" do
+    response = @validation.commit({ :validation_type => "foo" })
+    response.api_response_code.should == 2
+  end
+end

data/spec/lib/shipsurance/void_record_shipment_spec.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Shipsurance::VoidRecordShipment do
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + "/../lib/shipsurance"
+
+def address_attributes
+  {
+    :address_1    => "123 West street",
+    :address_2    => "APT #1",
+    :city        => "Rancho Santa Margarita",
+    :state       => "CA",
+    :postal_code => 92688,
+    :country     => "US"
+  }
+end
+
+CREDENTIALS = YAML.load_file("config/credentials.yml")["test"].symbolize_keys

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: shipsurance
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Matheson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-28 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Integration gem for the ShipSurance gem
+email: tim.matheson@ordercup.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/extensions/hash.rb
+- lib/shipsurance/address.rb
+- lib/shipsurance/base.rb
+- lib/shipsurance/claim.rb
+- lib/shipsurance/person.rb
+- lib/shipsurance/record_shipment.rb
+- lib/shipsurance/response.rb
+- lib/shipsurance/shipsurance.rb
+- lib/shipsurance/validation.rb
+- lib/shipsurance/void_record_shipment.rb
+- lib/shipsurance.rb
+- README.rdoc
+files: 
+- config/credentials.example.yml
+- config/credentials.yml
+- init.rb
+- lib/extensions/hash.rb
+- lib/shipsurance/address.rb
+- lib/shipsurance/base.rb
+- lib/shipsurance/claim.rb
+- lib/shipsurance/person.rb
+- lib/shipsurance/record_shipment.rb
+- lib/shipsurance/response.rb
+- lib/shipsurance/shipsurance.rb
+- lib/shipsurance/validation.rb
+- lib/shipsurance/void_record_shipment.rb
+- lib/shipsurance.rb
+- Rakefile
+- README.rdoc
+- spec/lib/shipsurance/address_spec.rb
+- spec/lib/shipsurance/claim_spec.rb
+- spec/lib/shipsurance/person_spec.rb
+- spec/lib/shipsurance/record_shipment_spec.rb
+- spec/lib/shipsurance/validation_spec.rb
+- spec/lib/shipsurance/void_record_shipment_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- Manifest
+- shipsurance.gemspec
+has_rdoc: true
+homepage: http://www.ordercup.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Shipsurance
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: shipsurance
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Integration gem for the ShipSurance gem
+test_files: []
+