sallie_mae_gateway 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Southern Illinois University Board of Trustees
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+SallieMae Electronic Payment Gateway SSO
+===
+
+A simple collection of models and helpers that speeds up the implementation of SallieMae EPG SSO within a **Rails 3.1.x** application.
+
+Installation
+===
+In your _Gemfile_ add the following line
+
+    gem 'sallie_mae_gateway', '~> 0.0.1'
+
+Configuration
+===
+You must create a YAML configuration file in your _config_ directory with the filename _salliemae.yml_. An example is included in the gem _config_ directory and is a good starting point.
+
+    $ cat config/salliemae.yml
+    
+    default: &default
+      url: 'https://stg.bosebill.salliemae.com/NetPay/Products/Gateway.aspx'
+      product_id: "0000"
+      school_id: "123456789"
+      postback_url: 'http://localhost:3000/sallie_mae/process'
+      finish_url: 'http://localhost:3000/sallie_mae/process'
+      cancel_url: 'http://localhost:3000/sallie_mae/cancel'
+    development:
+      <<: *default
+    test:
+      <<: *default
+    production:
+      <<: *default
+
+Example Usage
+===
+You'll use these models to create the payment object within your controller and to process the response from SallieMae. There are a couple of helpers to speed up creating your payment form within your views. That's it!
+This gem makes no assumptions about your payment processing system and does not contain any controllers to handle the creation or handling of responses.
+
+Controller - New Payment
+---
+Start in your controller by instantiating a _SallieMaeGateway::Student_ and at least one _SallieMaeGateway::LineItem_ objects. Then create a _SallieMaeGateway::Payment_ object providing your _student_ and *line_items*.
+
+    $ cat app/controllers/payment_controller.rb
+    .
+    .
+    .
+    def new
+      student = Student.find(123)
+      student_for_payment = SallieMaeGateway::Student.new(account: student.id, first_name: student.first_name, last_name: student.last_name, email: student.email )
+      line_items = [
+        SalieMaeGateway::LineItem.new(type: "AF", description: "Application Fee", amount: 75.00),
+        SalieMaeGateway::LineItem.new(type: "SCD", description: "Student Card Deposit", amount: 150.00)
+      ]
+      @payment = SallieMaeGateway::Payment.new(student: student_for_payment, line_items: line_items)
+    end
+    .
+    .
+    .
+View
+---
+In the view you can use the provided helpers to generate a simple button that can be clicked to take them to the payment gateway or you can display a read only form with more details
+
+    $ cat app/views/payment/new.html.erb
+    
+    # This helper displays the button
+    <%= sallie_mae_button @payment %>
+    
+    # This helper displays the read-only form
+    <%= sallie_mae_form @payment %>
+Controller - Process Response
+---
+You'll need to pass the response provided by SallieMae to the _SallieMaeGateway::Response_ object. You can then access the details from that instance, passing it to a model in your application or doing additional processing on .
+
+    $ cat app/controllers/payment_controller.rb
+    .
+    .
+    .
+    def process
+      @sallie_mae_response = SallieMaeResponse::Response.new(params)
+      # Use this object to access the response data, for example:
+      transaction = Transaction.new
+      transaction.transaction_id = @sallie_mae_response.transaction_id
+      transaction.amount = @sallie_mae_response.amount_paid
+      transaction.save
+    end
+    .
+    .
+    .
+
+
+
+Tests
+===
+Tests are written using Steak and RSpec 2 and are included in the _spec_ directory.
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SallieMaeGateway'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rubygems'
+require 'rspec'
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['*_spec.rb']
+  t.options = '-v'
+end
+
+task :default  => :spec

data/app/helpers/sallie_mae_helper.rb

@@ -0,0 +1,17 @@
+module SallieMaeHelper
+  def sallie_mae_button(payment,options={})
+    options[:hide_form] = true
+    options[:student_firstname] = false
+    options[:student_lastname] = false
+    options[:student_email] = false
+    options[:account] = false
+    options[:line_items] = false
+    sallie_mae_form(payment,options)
+  end
+  
+  def sallie_mae_form(payment,options={})
+    options[:button_label] ||= "Make a Payment"
+    options[:legend_text] ||= ""
+    render 'sallie_mae/sallie_mae_form', payment: payment, options: options
+  end
+end

data/app/models/sallie_mae_gateway/line_item.rb

@@ -0,0 +1,11 @@
+module SallieMaeGateway
+  class LineItem
+    attr_accessor :type, :description, :amount
+    
+    def initialize(args)
+      args.each { |key, value|
+        instance_variable_set "@#{key}", value
+      } if args.is_a? Hash
+    end   
+  end
+end

data/app/models/sallie_mae_gateway/payment.rb

@@ -0,0 +1,23 @@
+module SallieMaeGateway
+  class Payment
+    CHECKING, CREDIT_CARD, DEBIT_CARD, SAVINGS = 'A', 'C', 'D', 'S'
+    
+    attr_accessor :student, :line_items
+    attr_accessor :school_id, :postback_url, :finish_url, :cancel_url, :user_def1, :user_def2, :allow_edit, :payment_type
+    
+    def initialize(args)
+      if args.is_a? Hash
+        args[:allow_edit] ||= false 
+        args[:payment_type] ||= CREDIT_CARD
+        args.each { |key, value|
+          instance_variable_set "@#{key}", value
+        }
+      end
+      @line_items ||= []
+    end
+    
+    def total_amount
+      @line_items.reduce(0.0) { |sum, item| sum += item.amount }
+    end
+  end
+end

data/app/models/sallie_mae_gateway/response.rb

@@ -0,0 +1,79 @@
+module SallieMaeGateway
+  class Response
+    SUCCESS_INDICATOR = {
+      'A' => 'Credit Card Accepted',
+      'S' => 'ACH Scheduled',
+      'D' => 'Declined',
+      'P' => 'Pending',
+      'C' => 'Canceled'
+    }.freeze
+    
+    PAYMENT_INDICATOR = {
+      'AX' => 'American Express',
+      'DI' => 'Discover Card',
+      'DN' => 'Diners Club',
+      'CB' => 'Carte Blanche',
+      'JC' => 'JCB',
+      'MC' => 'Master Card',
+      'VI' => 'Visa',
+      'CK' => 'Checking Account',
+      'SV' => 'Savings Account'
+    }.freeze
+    
+    CANCELED, PENDING, SUCCESS, SCHEDULED = 'C', 'P', 'A', 'S'
+    
+    
+    attr_reader :raw_response
+    
+    def initialize(args=nil)
+      if args.is_a? Hash
+        @raw_response = args 
+        process_response
+      end      
+    end
+    
+    def raw_response=(response)
+      @raw_response = response
+      process_response
+    end
+    
+    def canceled?
+      raise 'Unable to determine status. Has a response been provided?' unless self.respond_to? :success_indicator
+      self.success_indicator.eql? CANCELED
+    end
+    
+    def success?
+      raise 'Unable to determine status. Has a response been provided?' unless self.respond_to? :success_indicator
+      self.success_indicator.eql? SUCCESS
+    end
+    
+    def success_message
+      raise 'Unable to determine status. Has a response been provided?' unless self.respond_to? :success_indicator
+      SUCCESS_INDICATOR[self.success_indicator]
+    end
+    
+    def payment_method
+      raise 'Unable to determine payment method. Has a response been provided?' unless self.respond_to? :pmt_indicator
+      PAYMENT_INDICATOR[self.pmt_indicator]
+    end
+    
+    private
+    def process_response
+      raise TypeError, "Unable to locate the raw response from SallieMae. Has it been provided?" if @raw_response.nil?
+      @raw_response.each_pair do |key, value|
+        key = key.downcase
+        unless self.respond_to? key
+          class_eval do
+            define_method key do
+              self.instance_variable_get "@#{key}"
+            end
+            define_method "#{key}=" do |new_value|
+              self.instance_variable_set "@#{key}", new_value
+            end
+          end
+        end
+        self.send "#{key}=", value
+      end
+    end
+  end
+end

data/app/models/sallie_mae_gateway/student.rb

@@ -0,0 +1,11 @@
+module SallieMaeGateway
+  class Student
+    attr_accessor :account, :email, :first_name, :last_name
+    
+    def initialize(args)
+      args.each { |key, value|
+        instance_variable_set "@#{key}", value
+      } if args.is_a? Hash
+    end   
+  end
+end

data/app/views/sallie_mae/_sallie_mae_form.html.haml

@@ -0,0 +1,49 @@
+= form_tag SALLIE_MAE_CONFIG["url"], :id => 'sallie_mae_gateway_form' do
+  = hidden_field_tag 'SCHOOL_ID', SALLIE_MAE_CONFIG["school_id"]
+  = hidden_field_tag 'ALT_OTPSSO_URL', SALLIE_MAE_CONFIG["postback_url"]
+  = hidden_field_tag 'FINISH_URL', SALLIE_MAE_CONFIG["finish_url"]
+  = hidden_field_tag 'CANCEL_URL', SALLIE_MAE_CONFIG["cancel_url"]
+  = hidden_field_tag 'PMT_INDICATOR', payment.payment_type
+  = hidden_field_tag 'EDIT_INDICATOR', payment.allow_edit ? "Y" : "N"
+  - if options[:account].eql? false
+    = hidden_field_tag 'ACCOUNT', payment.student.account
+  - else      
+    %p
+      = label_tag 'ACCOUNT', 'Student Account', :class => 'label'
+      = text_field_tag 'ACCOUNT', payment.student.account, :class => 'text_field', :readonly => 'readonly'
+  - if options[:student_firstname].eql? false
+    = hidden_field_tag 'STUDENT_FIRSTNAME', payment.student.first_name
+  - else
+    %p
+      = label_tag 'STUDENT_FIRSTNAME', 'Student First Name', :class => 'label'
+      = text_field_tag 'STUDENT_FIRSTNAME', payment.student.first_name, :class => 'text_field', :readonly => 'readonly'
+  - if options[:student_lastname].eql? false
+    = hidden_field_tag 'STUDENT_LASTNAME', payment.student.last_name
+  - else
+    %p
+      = label_tag 'STUDENT_LASTNAME', 'Student Last Name', :class => 'label'
+      = text_field_tag 'STUDENT_LASTNAME', payment.student.last_name, :class => 'text_field', :readonly => 'readonly'
+  - if options[:student_email].eql? false
+    = hidden_field_tag 'STUDENT_EMAIL_1', payment.student.email
+  - else
+    %p
+      = label_tag 'STUDENT_EMAIL', 'Student Email', :class => 'label'
+      = text_field_tag 'STUDENT_EMAIL_1', payment.student.email, :class => 'text_field', :readonly => 'readonly'
+  - unless options[:line_items].eql? false
+    %table#sallie_mae_line_items.table
+      %tr
+        %th Description
+        %th Amount
+      - payment.line_items.each_with_index do |line_item, i|
+        %tr{class: cycle('odd','even', name: 'sallie_mae_line_items')}
+          %td= line_item.description
+          %td.currency= "$" + "%.02f" % line_item.amount
+      %tr.total
+        %td.total Total
+        %td.currency= "$" + "%.02f" % payment.line_items.reduce(0.0) { |sum, item| sum += item.amount }
+  - payment.line_items.each_with_index do |line_item, i|
+    - item = (i.eql? 0) ? nil : i+1
+    = hidden_field_tag "PMT_TYPE#{item}", line_item.type
+    = hidden_field_tag "PMT_TYPE_DESC#{item}", line_item.description
+    = hidden_field_tag "AMOUNT_PAID#{item}", ("%.02f" % line_item.amount)
+  = submit_tag options[:button_label]

data/config/initializers/config.rb

@@ -0,0 +1,7 @@
+user_config = File.join(Rails.root,"config","salliemae.yml")
+if File.exists?(user_config)
+  config_path = user_config
+else
+  config_path = File.dirname(__FILE__) + "/../salliemae.yml"
+end
+SALLIE_MAE_CONFIG = YAML.load_file(config_path)[Rails.env]

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/config/salliemae.yml

@@ -0,0 +1,13 @@
+default: &default
+  url: 'https://stg.bosebill.salliemae.com/NetPay/Products/Gateway.aspx'
+  product_id: "0000"
+  school_id: "123456789"
+  postback_url: 'http://localhost:3000/sallie_mae/process'
+  finish_url: 'http://localhost:3000/sallie_mae/process'
+  cancel_url: 'http://localhost:3000/sallie_mae/cancel'
+development:
+  <<: *default
+test:
+  <<: *default
+production:
+  <<: *default

data/lib/sallie_mae_gateway.rb

@@ -0,0 +1,5 @@
+require "sallie_mae_gateway/engine"
+require 'haml'
+
+module SallieMaeGateway
+end

data/lib/sallie_mae_gateway/engine.rb

@@ -0,0 +1,10 @@
+require 'sallie_mae_gateway'
+require 'rails'
+
+module SallieMaeGateway
+  class Engine < Rails::Engine
+    config.to_prepare do
+      ActionView::Base.send(:include, SallieMaeHelper)
+    end
+  end
+end

data/lib/sallie_mae_gateway/version.rb

@@ -0,0 +1,3 @@
+module SallieMaeGateway
+  VERSION = "0.0.1"
+end

data/lib/tasks/sallie_mae_gateway_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sallie_mae_gateway do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sallie_mae_gateway
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Reedy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70135701650540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70135701650540
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &70135701650040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70135701650040
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70135701649580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70135701649580
+- !ruby/object:Gem::Dependency
+  name: steak
+  requirement: &70135701648960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70135701648960
+description: To accommodate the SSO functionality of SallieMae Business Office Solutions
+  Electronic Payment Gateway within a Rails applicaiton.
+email:
+- dreedy@housing.siu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/helpers/sallie_mae_helper.rb
+- app/models/sallie_mae_gateway/line_item.rb
+- app/models/sallie_mae_gateway/payment.rb
+- app/models/sallie_mae_gateway/response.rb
+- app/models/sallie_mae_gateway/student.rb
+- app/views/sallie_mae/_sallie_mae_form.html.haml
+- config/initializers/config.rb
+- config/routes.rb
+- config/salliemae.yml
+- lib/sallie_mae_gateway/engine.rb
+- lib/sallie_mae_gateway/version.rb
+- lib/sallie_mae_gateway.rb
+- lib/tasks/sallie_mae_gateway_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://www.housing.siu.edu
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: SallieMae Electronic Payment Gateway SSO Integration
+test_files: []