lolita-first-data 1.0.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem 'rails', '>= 3.0.0'
+gem "activemerchant", "~> 1.17.0"
+
+group :development do
+  gem 'sqlite3', '~> 1.3.4'
+  gem 'rspec', '~> 2.6.0'
+  gem 'webmock', '~> 1.7.6'
+  gem 'ruby-debug19', '~> 0.11.6'
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'fabrication', "~> 1.1.0"
+end

data/Gemfile.lock

@@ -0,0 +1,140 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemerchant (1.17.0)
+      activesupport (>= 2.3.11)
+      braintree (>= 2.0.0)
+      builder (>= 2.0.0)
+      json (>= 1.5.1)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    addressable (2.2.6)
+    archive-tar-minitar (0.5.2)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.0)
+    braintree (2.11.0)
+      builder (>= 2.0.0)
+    builder (3.0.0)
+    columnize (0.3.4)
+    crack (0.1.8)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    fabrication (1.1.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.4)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    multi_json (1.0.3)
+    polyglot (0.3.2)
+    rack (1.3.2)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
+      bundler (~> 1.0)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rcov (0.9.10)
+    rdoc (3.9.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    webmock (1.7.6)
+      addressable (> 2.2.5, ~> 2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemerchant (~> 1.17.0)
+  bundler (~> 1.0.0)
+  fabrication (~> 1.1.0)
+  jeweler (~> 1.6.4)
+  rails (>= 3.0.0)
+  rcov
+  rspec (~> 2.6.0)
+  ruby-debug19 (~> 0.11.6)
+  sqlite3 (~> 1.3.4)
+  webmock (~> 1.7.6)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 ITHouse and Gatis Tomsons
+
+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,89 @@
+### INSTALL
+
+- `gem install lolita-first-data`
+- `rails g lolita_first_data:install`
+
+### SETUP
+
+For example create model *Payment* and then add these special methods and modify them to suit your needs:
+    
+    include Lolita::Billing:FirstData
+
+    # Methods for #Lolita::Billing:FirstData
+    #---------------------------------------
+
+    # returns integer in cents
+    def price
+      self.total_price
+    end
+
+    # string up to 125 symbols
+    # this will included in payment description
+    def description
+      "Payment to INC Lolipop"
+    end
+
+    # returns 3 digit string according to http://en.wikipedia.org/wiki/ISO_4217
+    def currency
+      "840"
+    end
+    
+    # triggered when FirstData transaction is saved
+    def fd_trx_saved trx
+      case trx.status
+      when 'processing'
+        # update_attribute(:status, 'processing')
+      when 'completed'
+        # update_attribute(:status, 'completed')
+      when 'rejected'
+        # update_attribute(:status, 'rejected')
+      end
+    end
+    
+    # optional
+    # this is called when FirstData merchant is taking some actions
+    # there you can save the log message other than the default log file
+    def log severity, message
+      #self.logs.create(:severity => severity, :message => message)
+    end
+    #---------------------------------------
+
+Generate certificates by running:
+
+    rake first_data:generate_certificate
+
+Generate certificates for both environments - test/production and specify correct merchantId.
+
+Use `Lolita::FirstData::TestController` to pass all tests by running server and executing:
+
+    http://localhost:3000/first_data_test/test?nr=1
+    http://localhost:3000/first_data_test/test?nr=2
+    http://localhost:3000/first_data_test/test?nr=3
+    ...
+
+Configure your environments
+
+    # For development.rb and test.rb
+    #---------------------
+
+    FD_PEM   = "#{Rails.root}/config/first-data/test.pem"
+    FD_PASS  = "qwerty"
+
+    config.after_initialize do
+      ActiveMerchant::Billing::Base.mode = :test
+    end
+
+When you are ready to pay your payment controller action should end like this:
+
+    @payment = Payment....
+    ....
+    ....
+    session[:first_data] ||= {}
+    session[:first_data][:billing_class] = @payment.class.to_s
+    session[:first_data][:billing_id]    = @payment.id
+    session[:first_data][:finish_path]   = done_payments_path
+    redirect_to checkout_first_data_path
+
+### TESTS
+
+Get source and run `rspec spec`

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lolita-first-data"
+  gem.homepage = "http://github.com/ithouse/lolita-first-data"
+  gem.license = "MIT"
+  gem.summary = %Q{FirstData Payment plugin for Lolita}
+  gem.description = %Q{FirstData Payment plugin for Lolita using ActiveMerchant}
+  gem.email = "gatis@ithouse.cc"
+  gem.authors = ["ITHouse, Gatis Tomsons"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lolita-first-data #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/controllers/lolita/first_data/common_controller.rb

@@ -0,0 +1,25 @@
+module Lolita::FirstData
+  class CommonController < ApplicationController
+    include ActiveMerchant::Billing
+    before_filter :set_gateway
+    skip_before_filter :verify_authenticity_token
+
+    private
+
+    def set_gateway
+      @gateway ||= ActiveMerchant::Billing::FirstDataGateway.new(
+        :pem => File.open(FD_PEM).read,
+        :pem_password => FD_PASS,
+        :payment => set_active_payment
+      )
+    end
+
+    # returns current payment instance from session
+    def set_active_payment
+      if session && session[:first_data] && params[:controller] == 'Lolita::FirstData::Transaction'
+        @payment ||= session[:first_data][:billing_class].constantize.find(session[:first_data][:billing_id])
+      end
+    end
+    
+  end
+end

data/app/controllers/lolita/first_data/test_controller.rb

@@ -0,0 +1,78 @@
+module Lolita::FirstData
+  class TestController < Lolita::FirstData::CommonController
+    before_filter :render_nothing
+
+    # renders nothing if not in development environment
+    def render_nothing
+      render :nothing => true unless Rails.env == 'development'
+    end
+
+    #FIXME: refactor
+    # There are all 12 FirstData tests
+    # you should pass them to get production certificates
+    # use:  http://localhost:3000/first_data_test/test?nr=1
+    # then increment the "nr" until done
+    def test
+      ip = params[:nr] == '9' ? '192.168.1.2' : request.remote_ip
+      # REQUEST
+      case params[:nr]
+      when /^(1|2|5|6|7|8|10)$/
+        session[:first_data] = {}
+        session[:first_data][:test] = params[:nr]
+        rs = @gateway.purchase(100,428,ip,'tests')
+        if rs.success?
+          session[:first_data][:trans_id] = rs.params['TRANSACTION_ID']
+          return redirect_to(@gateway.go_out)
+        else
+          return render(:text => "<pre>#{rs.message}</pre>", :satus => 400)
+        end
+      when /^(3|4|9|11)$/
+        session[:first_data] = {}
+        session[:first_data][:test] = params[:nr]
+        rs = @gateway.authorize(100,428,ip,'tests')
+        if rs.success?
+          session[:first_data][:trans_id] = rs.params['TRANSACTION_ID']
+          return redirect_to(@gateway.go_out)
+        else
+          return render(:text => "<pre>#{rs.message}</pre>", :satus => 400)
+        end
+      when /^(12)$/
+        session[:first_data] = {}
+        session[:first_data][:test] = params[:nr]
+        rs = @gateway.close_day
+        return render(:text => "<pre>#{rs.message}</pre>")
+      end
+
+      # RESPONSE
+      case session[:first_data][:test]
+      when /^(1|2|5|6|7|8)$/
+        rs = @gateway.get_trans_result(ip,session[:first_data][:trans_id])
+        msg = %^
+        trans_id: #{session[:first_data][:trans_id]} <br />
+        <pre>#{rs.message}</pre>
+        ^
+        return render(:text => msg)
+      when /^3|4|9$/
+        rs = @gateway.complete(session[:first_data][:trans_id],100,428,ip,'tests')
+        msg = %^
+        trans_id: #{session[:first_data][:trans_id]} <br />
+        <pre>#{rs.message}</pre>
+        ^
+        return render(:text => msg)
+      when /^(10|11)$/
+        if session[:first_data][:test] == '11'
+          @gateway.complete(session[:first_data][:trans_id],100,428,ip,'tests')
+          @gateway.close_day
+        end
+        rs = @gateway.reverse(session[:first_data][:trans_id],100)
+        msg = %^
+        trans_id: #{session[:first_data][:trans_id]} <br />
+        <pre>#{rs.message}</pre>
+        ^
+        return render(:text => msg)
+      end if session[:first_data]
+      render :text => "WRONG REQUEST", :status => 400
+    end
+
+  end
+end

data/app/controllers/lolita/first_data/transaction_controller.rb

@@ -0,0 +1,49 @@
+module Lolita::FirstData
+  class TransactionController < Lolita::FirstData::CommonController
+    before_filter :is_ssl_required
+
+    # should exist
+    #   session[:first_data][:billing_class]
+    #   session[:first_data]:billing_id]
+    #   Class should respond to these methods:
+    # => :price - cents
+    # => :currency - according to http://en.wikipedia.org/wiki/ISO_4217
+    # => :description - string that will show up in payment details
+    def checkout
+      if @payment && !@payment.paid?
+        rs = @gateway.purchase(@payment.price,@payment.currency,request.remote_ip,@payment.description)
+        if rs.success?
+          Lolita::FirstData::Transaction.add(@payment, request, rs)
+          redirect_to(@gateway.go_out)
+        else
+          if request.xhr? || !request.referer
+            render :text => I18n.t('fd.purchase_failed'), :status => 400
+          else
+            redirect_to :back              
+          end
+        end        
+      else
+        render :text => I18n.t('fd.wrong_request'), :status => 400
+      end
+    end
+
+    # there we land after returning from FirstData server
+    # then we get transactions result and redirect to your given "finish" path
+    def answer
+      if trx = Lolita::FirstData::Transaction.where(transaction_id: params[:trans_id]).first
+        rs = @gateway.get_trans_result(request.remote_ip,params[:trans_id])
+        trx.process_answer(rs, @gateway, request)
+        redirect_to "#{session[:first_data][:finish_path]}?merchant=fd&trans_id=#{CGI::escape(params[:trans_id])}"
+      else
+        render :text => "wrong transaction ID", :status => 400
+      end
+    end
+
+    private
+
+    # forces SSL in production mode if available
+    def is_ssl_required
+      ssl_required(:answer, :checkout) if defined?(ssl_required) && (Rails.env == 'production' || Rails.env == 'staging')
+    end
+  end
+end