credit_officer 0.1.0 → 0.2.0

data/README.rdoc

@@ -11,7 +11,7 @@ Use this library so that you can validate credit card information before sending
 Checks credit card number formats, checksums, and other required details. Supports i18n for better message
 customization
 
-  cc = CreditOfficer::CreditCard.new(
+  cc = CreditOfficer::CreditCard.new({
     :number => "411111111111111",
     :provider_name => "visa",
     :name_on_card => "John Doe",
@@ -29,7 +29,7 @@ customization
 If you want to turn requiring verification values off, make it so:
 
   CreditOfficer::CreditCard.require_verification_value = false
-  cc = CreditOfficer::CreditCard.new(
+  cc = CreditOfficer::CreditCard.new({
     :number => "411111111111111",
     :provider_name => "visa",
     :name_on_card => "John Doe",
@@ -48,7 +48,7 @@ Want to only support certain credit cards and card number formats? Make it so:
     'amex'
   ]
 
-  cc = CreditOfficer::CreditCard.new(
+  cc = CreditOfficer::CreditCard.new({
     :number => "411111111111111",
     :provider_name => "visa",
     :name_on_card => "John Doe",
@@ -57,6 +57,29 @@ Want to only support certain credit cards and card number formats? Make it so:
     :verification_value => ""
   }).valid? => false
 
+== Deriving provider names
+
+Most of the time, you can derive the credit card provider (Mastercard, AMEX, Visa, etc) based on the format
+of the card number. By default, credit officer attempts to derive this provider name automatically
+
+  cc = CreditOfficer::CreditCard.new({
+    :number => "411111111111111",
+    :name_on_card => "John Doe",
+    :expiration_year => 2010,
+    :expiration_month => 1,
+  }).valid? => true
+
+  cc.provider_name => visa
+
+
+You can toggle this so that the user must provide a valid provider name like so:
+
+  CreditOfficer::CreditCard.automatically_derive_provider_name = false
+
+You can manually attempt the provider name like so (this will set the provider name according to your number):
+
+  cc.derive_provider_name
+
 == i18n
 
 Error messages can be customized with i18n translations

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/credit_officer.gemspec

@@ -0,0 +1,109 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{credit_officer}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Pickett"]
+  s.date = %q{2010-12-22}
+  s.description = %q{An upgrade/port of ActiveMerchant's credit card class}
+  s.email = %q{dpickett@enlightsolutions.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "credit_officer.gemspec",
+    "lib/credit_officer.rb",
+    "lib/credit_officer/base.rb",
+    "lib/credit_officer/credit_card.rb",
+    "lib/credit_officer/month_year_pair.rb",
+    "spec/credit_officer/base_spec.rb",
+    "spec/credit_officer/credit_card_spec.rb",
+    "spec/credit_officer/month_year_pair_spec.rb",
+    "spec/credit_officer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/active_model_shared_examples.rb",
+    "spec/support/factories.rb"
+  ]
+  s.homepage = %q{http://github.com/dpickett/credit_officer}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{An activemodel compliant credit card validator}
+  s.test_files = [
+    "spec/credit_officer/base_spec.rb",
+    "spec/credit_officer/credit_card_spec.rb",
+    "spec/credit_officer/month_year_pair_spec.rb",
+    "spec/credit_officer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/active_model_shared_examples.rb",
+    "spec/support/factories.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemodel>, [">= 3.0.3"])
+      s.add_runtime_dependency(%q<luhney_bin>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, ["= 0.3.5"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<remarkable_activemodel>, [">= 4.0.0.alpha4"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
+      s.add_development_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<fuubar>, [">= 0"])
+    else
+      s.add_dependency(%q<activemodel>, [">= 3.0.3"])
+      s.add_dependency(%q<luhney_bin>, [">= 0"])
+      s.add_dependency(%q<timecop>, ["= 0.3.5"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<remarkable_activemodel>, [">= 4.0.0.alpha4"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<reek>, ["~> 1.2.8"])
+      s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_dependency(%q<fuubar>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, [">= 3.0.3"])
+    s.add_dependency(%q<luhney_bin>, [">= 0"])
+    s.add_dependency(%q<timecop>, ["= 0.3.5"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<remarkable_activemodel>, [">= 4.0.0.alpha4"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<reek>, ["~> 1.2.8"])
+    s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+    s.add_dependency(%q<fuubar>, [">= 0"])
+  end
+end
+

data/lib/credit_officer/credit_card.rb

@@ -11,7 +11,7 @@ module CreditOfficer
   #store this private information
   #
   #@example
-  #  cc = CreditOfficer::CreditCard.new(
+  #  cc = CreditOfficer::CreditCard.new({
   #    :number => "411111111111111",
   #    :provider_name => "visa",
   #    :name_on_card => "John Doe",
@@ -91,7 +91,8 @@ module CreditOfficer
     
     validate :expiration_date_is_in_future
     validate :expiration_date_is_in_recent_future
-    validate :number_is_valid
+    validate :number_is_valid 
+
     validate :provider_name_is_supported
 
     #SOLO or Switch validations
@@ -107,9 +108,17 @@ module CreditOfficer
     validate :start_date_is_in_the_past,
       :if => proc{|cc| cc.switch_or_solo? }
 
-    #set this flag accordingly to enable/disable validating verification codes (CVV/CVV2)
+    #set this flag accordingly to enable/disable validating verification codes 
+    #(CVV/CVV2)
+    #@note defaults to true
     cattr_accessor :require_verification_value
     self.require_verification_value = true
+
+    #set this flag accordingly if you want CreditOfficer to attempt to derive 
+    #the provider name before validation takes place
+    #@note defaults to true
+    cattr_accessor :automatically_derive_provider_name
+    self.automatically_derive_provider_name = true
  
     #checks the configuration setting require_verification_value to see if 
     #verification is required
@@ -161,7 +170,27 @@ module CreditOfficer
       SWITCH_OR_SOLO_PROVIDERS.include?(provider_name)
     end
 
+    def derive_provider_name
+      self.class.supported_providers_and_formats.each do |name, format|
+        if number =~ format
+          self.provider_name = name
+          return
+        end
+      end
+    end
+
+    def masked_number
+      if number.present? && number.size >= 4
+        "X" * (number.size - 4) + number[-4..-1]
+      end
+    end
+ 
     protected
+    def run_validations!
+      derive_provider_name if self.class.automatically_derive_provider_name
+      super
+    end
+
     I18N_ERROR_SCOPE = [:credit_officer, :errors, :messages]
 
     def expiration_date_is_in_future
@@ -182,7 +211,8 @@ module CreditOfficer
     end
     
     def number_is_valid
-      if provider_name.present? && number.present? 
+      if (provider_name.present? || self.class.automatically_derive_provider_name) && 
+        number.present? 
         if self.class.supported_providers_and_formats[provider_name].nil? || 
           !(number =~ self.class.supported_providers_and_formats[provider_name]) || 
           !checksum_valid?
@@ -195,7 +225,9 @@ module CreditOfficer
     end
 
     def provider_name_is_supported
-      unless self.class.supported_providers.include?(provider_name.downcase)
+      if !self.class.automatically_derive_provider_name &&
+        !self.class.supported_providers.include?(provider_name.try(:downcase))
+
         errors.add(:provider_name, translate(:unsupported_provider,
           :scope   => I18N_ERROR_SCOPE,
           :default => "is not supported"))

data/spec/credit_officer/credit_card_spec.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
 describe CreditOfficer::CreditCard do
+  TEST_AMEX = "378282246310005"
+  TEST_MASTER = "5555555555554444"
+
   subject { Factory.build(:credit_card) }
   it_should_behave_like "ActiveModel"
   
@@ -65,14 +68,14 @@ describe CreditOfficer::CreditCard do
       old_supported_providers = subject.class.supported_providers.dup
       subject.class.supported_providers = ['master']
       subject.should_not be_valid
-      subject.errors[:provider_name].should_not be_blank
+      subject.errors[:number].should_not be_blank
 
       #reset supported providers
       subject.class.supported_providers = old_supported_providers
     end
 
     it "rejects a provider that is not in the whitelist" do
-      old_supported_providers = subject.class.supported_providers
+      old_supported_providers = subject.class.supported_providers.dup
       subject.class.supported_providers = ["gaga", "ohlala"]     
       subject.class.supported_providers.should be_empty
 
@@ -124,4 +127,52 @@ describe CreditOfficer::CreditCard do
       subject.errors[:start_year].should_not be_blank
     end
   end
+
+  it "reveals the last 4 digits in your masked card number" do
+    subject.masked_number.should =~ /#{subject.number[-4..-1]}$/
+  end
+
+  it  "obfuscates all the digits except the last for in your masked card numbers" do 
+    subject.masked_number.should =~ /^#{"X" * (subject.number.size - 4)}/
+  end
+
+  it "returns a nil masked number if I don't have more than 4 digits in my credit card number" do
+    subject.number = ""
+    subject.masked_number.should be_nil
+  end
+
+  context "deriving provider name" do  
+    it "derives visa from a visa formatted card number" do
+      subject.provider_name = ""
+      subject.derive_provider_name
+      subject.provider_name.should eql("visa")
+    end
+
+    it "derives master from a mastercard formatted number" do
+      subject.provider_name = ""
+      subject.number = TEST_MASTER
+      subject.derive_provider_name
+      subject.provider_name.should eql('master')
+    end
+
+    it "derives american express from an amex formatted number" do
+      subject.provider_name = ""
+      subject.number = TEST_AMEX
+      subject.derive_provider_name
+      subject.provider_name.should eql('american_express')
+    end
+
+    it "does not validate the provider name if provider name derivation is on" do
+      subject.provider_name = ""
+      subject.number = TEST_AMEX
+      subject.should be_valid
+      subject.provider_name.should eql('american_express')
+    end
+
+    it "should not set an error on provider name if the credit card number is invalid" do
+      subject.number = "fasdfas"
+      subject.should_not be_valid
+      subject.errors[:provider_name].should be_blank
+    end
+  end
 end

data/spec/support/factories.rb

@@ -1,6 +1,5 @@
 Factory.define :credit_card, :class => CreditOfficer::CreditCard do |c|
   c.number "4111111111111111"
-  c.provider_name 'visa'
   c.expiration_month 1
   c.expiration_year { Time.now.advance(:year => 1) }
   c.name_on_card "John Smith"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: credit_officer
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dan Pickett
@@ -252,6 +252,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- credit_officer.gemspec
 - lib/credit_officer.rb
 - lib/credit_officer/base.rb
 - lib/credit_officer/credit_card.rb