shipsurance 0.1.2 → 0.1.3

data/Manifest

@@ -5,21 +5,30 @@ lib/extensions/hash.rb
 lib/shipsurance/address.rb
 lib/shipsurance/base.rb
 lib/shipsurance/claim.rb
+lib/shipsurance/claim_response.rb
+lib/shipsurance/claim_status.rb
+lib/shipsurance/claim_status_response.rb
 lib/shipsurance/person.rb
 lib/shipsurance/record_shipment.rb
+lib/shipsurance/record_shipment_response.rb
 lib/shipsurance/response.rb
 lib/shipsurance/shipsurance.rb
 lib/shipsurance/validation.rb
+lib/shipsurance/validation_response.rb
 lib/shipsurance/void_record_shipment.rb
+lib/shipsurance/void_record_shipment_response.rb
 lib/shipsurance.rb
 Rakefile
 README.rdoc
 spec/lib/shipsurance/address_spec.rb
 spec/lib/shipsurance/claim_spec.rb
+spec/lib/shipsurance/claim_status_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/rcov.opts
 spec/spec.opts
 spec/spec_helper.rb
+tasks/rspec.rake
 Manifest

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('shipsurance', '0.1.2') do |p|
+Echoe.new('shipsurance', '0.1.3') do |p|
   p.description              = "Integration gem for the ShipSurance gem"
   p.url                      = "http://www.ordercup.com"
   p.author                   = "Tim Matheson"

data/lib/extensions/hash.rb

@@ -3,7 +3,7 @@ require 'cgi'
 class Hash  
   def to_s
     keys.each do |key|
-      self[parametize(key.to_s)] = CGI.escape(self[key].to_s)
+      self[parametize(key.to_s)] = self[key].to_s
       delete(key)
     end
     self

data/lib/shipsurance.rb

@@ -4,11 +4,18 @@ require 'active_support'
 require 'extensions/hash'
 require 'shipsurance/shipsurance'
 require 'shipsurance/base'
+require 'shipsurance/response'
+require 'shipsurance/claim_response'
+require 'shipsurance/claim_status_response'
+require 'shipsurance/record_shipment_response'
+require 'shipsurance/void_record_shipment_response'
+require 'shipsurance/validation_response'
 require 'shipsurance/claim'
+require 'shipsurance/claim_status'
 require 'shipsurance/record_shipment'
 require 'shipsurance/void_record_shipment'
 require 'shipsurance/validation'
 require 'shipsurance/person'
 require 'shipsurance/address'
-require 'shipsurance/response'
+
 

data/lib/shipsurance/base.rb

@@ -48,7 +48,7 @@ module Shipsurance
       res = Net::HTTP.new(url.host, url.port).start {|http| http.request(req) }
       case res
       when Net::HTTPSuccess#, Net::HTTPRedirection
-        Shipsurance::Response.new(res)
+        response(res)
       else
         raise Shipsurance::RequestError, res.error!
       end
@@ -77,6 +77,10 @@ module Shipsurance
       @resource_class ||= self.class.to_s.split(":").last
     end
     
+    def response(response)
+      "#{self.class}Response".constantize.new(response)
+    end
+    
     def base_url
       return RAILS_ENV =~ /production/ ? @@live_base_url : @@test_base_url
     end
@@ -202,9 +206,12 @@ module Shipsurance
     def validate_request(post)
       @@errors.clear
       required.each do |key|
-        @@errors << "Missing required parameter #{key.to_s}" unless post.has_key?(key)
+        @@errors << "#{key.to_s}" unless post.has_key?(key)
+      end
+      unless @@errors.empty?
+        @@errors.unshift("Missing required #{@@errors.size > 1 ? "parameters" : "parameter"}")
+        raise Shipsurance::RequestError, @@errors.join(", ")
       end
-      raise Shipsurance::RequestError, @@errors.join(", ") unless @@errors.empty?
     end
     
     def credentials

data/lib/shipsurance/claim.rb

@@ -87,7 +87,7 @@ module Shipsurance
     end
     
     def add_file_date(date, post = {})
-      post[:file_date] = date.strftime("%m/%d/%Y %H:%M %p")#format_date(date)
+      post[:file_date] = format_date(date)
       post
     end
     

data/lib/shipsurance/claim_response.rb

@@ -0,0 +1,15 @@
+module Shipsurance
+  class ClaimResponse < Response
+    attr_reader :claim_id, :claim_code
+    
+    def initialize(response)
+      @response    = parse(response)
+      @code        = @response[0]
+      @reason_code = @response[1]
+      @claim_id    = @response[2]
+      @claim_code  = @response[3]
+      self
+    end
+    
+  end
+end

data/lib/shipsurance/claim_status.rb

@@ -0,0 +1,8 @@
+module Shipsurance
+  class ClaimStatus < Base
+        
+    def required
+      super.push(:ext_claim_id, :person_last_name, :person_email)
+    end
+  end
+end

data/lib/shipsurance/claim_status_response.rb

@@ -0,0 +1,14 @@
+module Shipsurance
+  class ClaimStatusResponse < Response
+    def initialize(response)
+      @response                      = response.body.split("|")
+      @code                          = @response[0]
+      @reason_code                   = @response[1]
+      @claim_status_type             = @response[2]
+      @claim_status_type_description = @response[3]
+      @claim_comments                = @response[4]
+      @last_updated                  = @response[5]
+      self
+    end
+  end
+end

data/lib/shipsurance/record_shipment.rb

@@ -118,7 +118,6 @@ module Shipsurance
     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

data/lib/shipsurance/record_shipment_response.rb

@@ -0,0 +1,13 @@
+module Shipsurance
+  class RecordShipmentResponse < Response
+    attr_reader :recorded_shipment_id
+    
+    def initialize(response)
+      @response              = parse(response)
+      @code                  = @response[0]
+      @reason_code           = @response[1]
+      @recorded_shipment_id  = @response[2]
+      self
+    end
+  end
+end

data/lib/shipsurance/response.rb

@@ -1,14 +1,30 @@
 module Shipsurance
   class Response
-    attr_reader :code, :body, :api_response_code, :success, :recorded_shipment_id
+    attr_reader :code, :body, :reason_code, :api_response_code
     
     def initialize(response)
-      response_arry = parse(response)
-      @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)
+      @response_arry = parse(response)
+      @code, @api_response_code, @body, @recorded_shipment_id = response.code.to_i, @response_arry[0].to_i, @response_arry[1], @response_arry[2]
+      @success = (@api_response_code == 1)
       self
     end 
     
+    def code
+      @code.to_i == 1 ? 200 : @code
+    end
+    
+    def body
+      @reason_code || @body
+    end
+    
+    def success
+      @code.to_i == 1
+    end
+    
+    def success?
+      @success ||= success
+    end
+    
     def parse(response)
       response.body.split(",")
     end

data/lib/shipsurance/validation_response.rb

@@ -0,0 +1,19 @@
+module Shipsurance
+  class ValidationResponse < Response
+    
+    attr_reader :validation_type, :response_reason, :response
+    
+    def initialize(response)
+      @response        = parse(response)
+      @code            = @response[0]
+      @reason_code     = @response[1]
+      @validation_type = @response[2]
+      @response        = @response[4]
+      self
+    end
+    
+    def body
+      @reason_code
+    end
+  end
+end

data/lib/shipsurance/void_record_shipment_response.rb

@@ -0,0 +1,11 @@
+module Shipsurance
+  class VoidRecordShipmentResponse < Response
+        
+    def initialize(response)
+      @response              = parse(response)
+      @code                  = @response[0]
+      @reason_code           = @response[1]
+      self
+    end
+  end
+end

data/shipsurance.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shipsurance}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Matheson"]
-  s.date = %q{2009-12-01}
+  s.date = %q{2009-12-07}
   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.extra_rdoc_files = ["lib/extensions/hash.rb", "lib/shipsurance/address.rb", "lib/shipsurance/base.rb", "lib/shipsurance/claim.rb", "lib/shipsurance/claim_response.rb", "lib/shipsurance/claim_status.rb", "lib/shipsurance/claim_status_response.rb", "lib/shipsurance/person.rb", "lib/shipsurance/record_shipment.rb", "lib/shipsurance/record_shipment_response.rb", "lib/shipsurance/response.rb", "lib/shipsurance/shipsurance.rb", "lib/shipsurance/validation.rb", "lib/shipsurance/validation_response.rb", "lib/shipsurance/void_record_shipment.rb", "lib/shipsurance/void_record_shipment_response.rb", "lib/shipsurance.rb", "README.rdoc", "tasks/rspec.rake"]
+  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/claim_response.rb", "lib/shipsurance/claim_status.rb", "lib/shipsurance/claim_status_response.rb", "lib/shipsurance/person.rb", "lib/shipsurance/record_shipment.rb", "lib/shipsurance/record_shipment_response.rb", "lib/shipsurance/response.rb", "lib/shipsurance/shipsurance.rb", "lib/shipsurance/validation.rb", "lib/shipsurance/validation_response.rb", "lib/shipsurance/void_record_shipment.rb", "lib/shipsurance/void_record_shipment_response.rb", "lib/shipsurance.rb", "Rakefile", "README.rdoc", "spec/lib/shipsurance/address_spec.rb", "spec/lib/shipsurance/claim_spec.rb", "spec/lib/shipsurance/claim_status_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/rcov.opts", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake", "Manifest", "shipsurance.gemspec"]
   s.homepage = %q{http://www.ordercup.com}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Shipsurance", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/spec/lib/shipsurance/claim_spec.rb

@@ -8,26 +8,24 @@ describe Shipsurance::Claim do
   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
+    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)
+      response = @claim.commit(post)
+      response.body.should == "The transaction was accepted."
+    end
   end
   
   context " attributes" do

data/spec/lib/shipsurance/claim_status_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe Shipsurance::ClaimStatus do
+  before(:each) do
+    @claim_status = Shipsurance::ClaimStatus.new
+    @claim        = Shipsurance::Claim.new
+    @shipment_id = Shipsurance::RecordShipment.new.commit(valid_record_shipment_params).recorded_shipment_id
+    @claim_response = @claim.commit({:recorded_shipment_id => @shipment_id}.merge!(add_params(valid_record_shipment_params)))
+  end
+  
+  it "should return success" do
+    post = {}
+    post[:person_last_name] = "Matheson"
+    post[:person_email] = CREDENTIALS[:person_email] 
+    post[:ext_claim_id] = @claim_response.claim_code
+    post[:claim_id] = @claim_response.claim_id
+    response = @claim_status.commit(post)
+    puts post.inspect
+    response.reason_code.should == "foo"
+  end
+  
+  private
+  
+  def add_params(post = {})
+    post[:person_source_identifier]      = '1' 
+    post[:person_first_name]             = 'Tim' 
+    post[:person_last_name]              = 'Matheson' 
+    post[:ext_carrier_id]                = '2' 
+    post[:consignee_full_name]           = 'Tim Matheson' 
+    post[:claim_payment_full_name]       = 'Bill Smith' 
+    post[:claim_payment_address_1]       = '123 Test Address' 
+    post[:claim_payment_city]            = 'RSM' 
+    post[:claim_payment_postal_code]     = '92688' 
+    post[:claim_payment_country]         = 'US' 
+    post[:claim_payment_phone]           = '9492945624' 
+    post[:file_date]                     = Time.now.strftime("%m/%d/%Y") 
+    post[:loss_discovered_date]          = Time.now.strftime("%m/%d/%Y")
+    post[:ext_claim_type_id]             = '1' 
+    post[:claim_description]             = 'Test Description' 
+    post[:claim_amount]                  = '11.99' 
+    post[:certify_correct]               = '1' 
+    post[:claim_shipment_date]           = Time.now.strftime("%m/%d/%Y")
+    post
+  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/record_shipment_spec.rb

@@ -14,6 +14,7 @@ describe Shipsurance::RecordShipment do
     
     it "should return a transaction key given valid params" do
       response = @record_shipment.commit(valid_request_params)
+      response.body.should == "The transaction was accepted."
       response.recorded_shipment_id.should_not be_nil
     end
     
@@ -24,7 +25,7 @@ describe Shipsurance::RecordShipment do
     
     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
+      response.code.should == 200
     end
   end
   

data/spec/lib/shipsurance/validation_spec.rb

@@ -12,7 +12,7 @@ describe Shipsurance::Validation do
   
   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
+     response.code.should == 200
    end
   
   it "should return an error given an invalid validation type" do
@@ -22,6 +22,6 @@ describe Shipsurance::Validation do
   
   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
+    response.code.should == "2"
   end
 end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*,gems/*"

data/tasks/rspec.rake

@@ -0,0 +1,13 @@
+require 'spec/rake/spectask'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/../spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = lambda do
+      IO.readlines(File.dirname(__FILE__) + "/../spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shipsurance
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Tim Matheson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 -08:00
+date: 2009-12-07 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -24,14 +24,21 @@ extra_rdoc_files:
 - lib/shipsurance/address.rb
 - lib/shipsurance/base.rb
 - lib/shipsurance/claim.rb
+- lib/shipsurance/claim_response.rb
+- lib/shipsurance/claim_status.rb
+- lib/shipsurance/claim_status_response.rb
 - lib/shipsurance/person.rb
 - lib/shipsurance/record_shipment.rb
+- lib/shipsurance/record_shipment_response.rb
 - lib/shipsurance/response.rb
 - lib/shipsurance/shipsurance.rb
 - lib/shipsurance/validation.rb
+- lib/shipsurance/validation_response.rb
 - lib/shipsurance/void_record_shipment.rb
+- lib/shipsurance/void_record_shipment_response.rb
 - lib/shipsurance.rb
 - README.rdoc
+- tasks/rspec.rake
 files: 
 - config/credentials.example.yml
 - config/credentials.yml
@@ -40,23 +47,32 @@ files:
 - lib/shipsurance/address.rb
 - lib/shipsurance/base.rb
 - lib/shipsurance/claim.rb
+- lib/shipsurance/claim_response.rb
+- lib/shipsurance/claim_status.rb
+- lib/shipsurance/claim_status_response.rb
 - lib/shipsurance/person.rb
 - lib/shipsurance/record_shipment.rb
+- lib/shipsurance/record_shipment_response.rb
 - lib/shipsurance/response.rb
 - lib/shipsurance/shipsurance.rb
 - lib/shipsurance/validation.rb
+- lib/shipsurance/validation_response.rb
 - lib/shipsurance/void_record_shipment.rb
+- lib/shipsurance/void_record_shipment_response.rb
 - lib/shipsurance.rb
 - Rakefile
 - README.rdoc
 - spec/lib/shipsurance/address_spec.rb
 - spec/lib/shipsurance/claim_spec.rb
+- spec/lib/shipsurance/claim_status_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/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb
+- tasks/rspec.rake
 - Manifest
 - shipsurance.gemspec
 has_rdoc: true