auth_net_receiver 1.0.beta1 → 1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa66b884447c0da4498451cab15afb8d609b00d5
-  data.tar.gz: 510b888ac62fb9cda6517662413ed95b7b3dbe03
+  metadata.gz: a8a7dac5bb13d948a9e61e2c2d1ee8833f39dee2
+  data.tar.gz: c57e624ca342235e98954af74de284b0023ac14d
 SHA512:
-  metadata.gz: ed7ed451278edbbae60f06a04a52233c5e6acc0e572fb495d703d3bb9d0c08eb303bae6e40014a197750765a731dc20eaf9de51f1e6c498add038b8d3d26a79a
-  data.tar.gz: 8da8bf5dd05b192fb4bbc010a2531bb0b534e39a93bc5a0e4d97eb5905c18af5894e573cbcee6c2f4409bb1610182e849a62f3b12ee1edf3c6dec793862914a4
+  metadata.gz: 00a140441b4099d4d2656472880ca631b50165e7861963cb96ac47e9767f9d4e606491fffa0fbf6e3cd4f89b4390d228c93f2102e60577760a711c5c0a7fe13a
+  data.tar.gz: ef0db621f7e2d1fbba3e63f5c8dc1f00f8ac5e7dfce2173d041cb99b0a7024fe59f200857b014c4f829cc91c84ed90bd45fcc3dd60dca35afa8db7e5af3472b0

data/README.md

@@ -4,7 +4,13 @@ The goal of this project is to capture and process transactions posted via the A
 
 ## What is that?
 
-The Silent Post URL is a feature of Authorize.Net that makes a post to a user-defined URL any time a transaction is made. Transactions are posted in real time and must be accepted by the web server within 2 seconds.
+The Silent Post URL is a feature of Authorize.Net that makes a post to a user-defined URL any time a transaction is made. Take note of the following rules:
+
+- Transactions are sent in real time
+- Each transaction is only ever sent once, regardless of server response
+- A transaction must be accepted within 2 seconds.
+
+For this reason, Authorize.net recommends that the post action is only used to collect raw data, while parsing and validation is pushed off to a later time.
 
 This is primarily useful for those using the [Automated Recurring Billing](http://developer.authorize.net/api/arb/) system, or ARB for short. Subscriptions created in ARB will make their transactions at the requested schedule, but (at this time) there is no direct API for pulling down those transactions. By making use of the Silent Post, you can capture all ARB transactions and use that data to reconcile the state of your user's subscription. 
 
@@ -46,9 +52,13 @@ As a final step, you should log in to your Authorize.Net account and enter the d
 
 **NOTE:** Because Authorize.Net has to actually make an HTTP post to your endpoint, it is not possible to run this application on localhost without a bit of work on the networking side. I won't attempt to cover the entire topic here, but if you are comfortable with DNS and port forwards you can probably figure out the rest. 
 
-## Processing
+## Processing with ActiveJob
+
+If you are running Rails 4.2, we can take advantage of [ActiveJob](http://edgeguides.rubyonrails.org/active_job_basics.html) and process transactions in the background. Set `AuthNetReceiver.config.active_job = false` if you wish to disable this feature.
+
+## Processing without ActiveJob
 
-Run the `auth_net_receiver:process` rake task to process all pending transactions:
+If you are not using ActiveJob, raw transactions will pile up in the database and need to be processed manually. Run the `auth_net_receiver:process` rake task to process all pending transactions:
 
     $ rake auth_net_receiver:process 
     D, [2014-11-06T19:31:38.191435 #39766] DEBUG -- : Processing Authorize.Net transactions...

data/app/controllers/auth_net_receiver/raw_transactions_controller.rb

@@ -4,6 +4,7 @@ module AuthNetReceiver
   class RawTransactionsController < ApplicationController
 
     skip_before_filter :verify_authenticity_token
+    after_action :perform_job
   
     def create
       @raw_transaction = RawTransaction.create({
@@ -12,5 +13,13 @@ module AuthNetReceiver
       render :nothing => true, :status => 200
     end
 
+private
+    
+    def perform_job
+      if AuthNetReceiver.config.active_job
+        AuthNetReceiver::ProcessTransactionJob.perform_later(@raw_transaction)
+      end
+    end
+
   end
 end

data/app/jobs/auth_net_receiver/process_transaction_job.rb

@@ -0,0 +1,10 @@
+module AuthNetReceiver
+  class ProcessTransactionJob < ActiveJob::Base
+    queue_as :default
+
+    def perform(raw_transaction)
+      raw_transaction.process!
+    end
+
+  end
+end

data/lib/auth_net_receiver/configuration.rb

@@ -1,6 +1,7 @@
 module AuthNetReceiver
   include ActiveSupport::Configurable
-  config_accessor :hash_value, :gateway_login
+  config_accessor :hash_value, :gateway_login, :active_job
   self.hash_value = nil
   self.gateway_login = nil
+  self.active_job = defined?(ActiveJob) != nil
 end

data/lib/auth_net_receiver/version.rb

@@ -1,3 +1,3 @@
 module AuthNetReceiver
-  VERSION = "1.0.beta1"
+  VERSION = "1.0.beta2"
 end

data/spec/controllers/auth_net_receiver/raw_transactions_controller_spec.rb

@@ -6,7 +6,7 @@ module AuthNetReceiver
     it "should create a new raw transaction" do
       post :create, {:use_route => :auth_net_receiver}
       expect(response).to be_success
-      expect(AuthNetReceiver::RawTransaction.unprocessed.count).to eq(1)
+      expect(AuthNetReceiver::RawTransaction.count).to eq(1)
     end
 
   end

data/spec/dummy/bin/delayed_job

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'environment'))
+require 'delayed/command'
+Delayed::Command.new(ARGV).daemonize

data/spec/dummy/config/environments/test.rb

@@ -36,4 +36,6 @@ Rails.application.configure do
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
+
+  config.active_job.queue_adapter = :delayed_job
 end

data/spec/dummy/db/migrate/20141214034049_create_auth_net_receiver_raw_transactions.auth_net_receiver.rb

@@ -0,0 +1,11 @@
+# This migration comes from auth_net_receiver (originally 20141106200527)
+class CreateAuthNetReceiverRawTransactions < ActiveRecord::Migration
+  def change
+    create_table :auth_net_receiver_raw_transactions do |t|
+      t.boolean :is_processed, :default => false
+      t.boolean :is_authentic, :default => false
+      t.text :data
+      t.timestamps :null => false
+    end
+  end
+end

data/spec/dummy/db/migrate/20141214034050_create_auth_net_receiver_transactions.auth_net_receiver.rb

@@ -0,0 +1,20 @@
+# This migration comes from auth_net_receiver (originally 20141106200940)
+class CreateAuthNetReceiverTransactions < ActiveRecord::Migration
+  def change
+    create_table :auth_net_receiver_transactions do |t|
+      t.references :raw_transaction, :index => true
+      t.references :transaction, :index => true, :limit => 8
+      t.references :subscription, :index => true, :limit => 8
+      t.integer :subscription_paynum
+      t.string :invoice_num
+      t.string :transaction_type
+      t.decimal :amount, :precision => 10, :scale => 2, :default => 0
+      t.string :card_type
+      t.string :account_number
+      t.string :description
+      t.integer :response_reason_code
+      t.string :response_reason_text
+      t.timestamps :null => false
+    end
+  end
+end

data/spec/dummy/db/migrate/20141214034232_create_delayed_jobs.rb

@@ -0,0 +1,22 @@
+class CreateDelayedJobs < ActiveRecord::Migration
+  def self.up
+    create_table :delayed_jobs, :force => true do |table|
+      table.integer :priority, :default => 0, :null => false # Allows some jobs to jump to the front of the queue
+      table.integer :attempts, :default => 0, :null => false # Provides for retries, but still fail eventually.
+      table.text :handler, :null => false                    # YAML-encoded string of the object that will do work
+      table.text :last_error                                 # reason for last failure (See Note below)
+      table.datetime :run_at                                 # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+      table.datetime :locked_at                              # Set when a client is working on this object
+      table.datetime :failed_at                              # Set when all retries have failed (actually, by default, the record is deleted instead)
+      table.string :locked_by                                # Who is working on this object (if locked)
+      table.string :queue                                    # The name of the queue this job is in
+      table.timestamps
+    end
+
+    add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+  end
+
+  def self.down
+    drop_table :delayed_jobs
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,35 +11,51 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20141106200940) do
+ActiveRecord::Schema.define(version: 20141214034232) do
 
   create_table "auth_net_receiver_raw_transactions", force: true do |t|
-    t.boolean  "is_processed", default: false
-    t.boolean  "is_authentic", default: false
-    t.text     "data"
-    t.datetime "created_at",                   null: false
-    t.datetime "updated_at",                   null: false
+    t.boolean  "is_processed", limit: 1,     default: false
+    t.boolean  "is_authentic", limit: 1,     default: false
+    t.text     "data",         limit: 65535
+    t.datetime "created_at",                                 null: false
+    t.datetime "updated_at",                                 null: false
   end
 
   create_table "auth_net_receiver_transactions", force: true do |t|
-    t.integer  "raw_transaction_id"
+    t.integer  "raw_transaction_id",   limit: 4
     t.integer  "transaction_id",       limit: 8
     t.integer  "subscription_id",      limit: 8
-    t.integer  "subscription_paynum"
-    t.string   "invoice_num"
-    t.string   "transaction_type"
-    t.decimal  "amount",                         precision: 10, scale: 2, default: 0.0
-    t.string   "card_type"
-    t.string   "account_number"
-    t.string   "description"
-    t.integer  "response_reason_code"
-    t.string   "response_reason_text"
-    t.datetime "created_at",                                                            null: false
-    t.datetime "updated_at",                                                            null: false
+    t.integer  "subscription_paynum",  limit: 4
+    t.string   "invoice_num",          limit: 255
+    t.string   "transaction_type",     limit: 255
+    t.decimal  "amount",                           precision: 10, scale: 2, default: 0.0
+    t.string   "card_type",            limit: 255
+    t.string   "account_number",       limit: 255
+    t.string   "description",          limit: 255
+    t.integer  "response_reason_code", limit: 4
+    t.string   "response_reason_text", limit: 255
+    t.datetime "created_at",                                                              null: false
+    t.datetime "updated_at",                                                              null: false
   end
 
   add_index "auth_net_receiver_transactions", ["raw_transaction_id"], name: "index_auth_net_receiver_transactions_on_raw_transaction_id", using: :btree
   add_index "auth_net_receiver_transactions", ["subscription_id"], name: "index_auth_net_receiver_transactions_on_subscription_id", using: :btree
   add_index "auth_net_receiver_transactions", ["transaction_id"], name: "index_auth_net_receiver_transactions_on_transaction_id", using: :btree
 
+  create_table "delayed_jobs", force: true do |t|
+    t.integer  "priority",   limit: 4,     default: 0, null: false
+    t.integer  "attempts",   limit: 4,     default: 0, null: false
+    t.text     "handler",    limit: 65535,             null: false
+    t.text     "last_error", limit: 65535
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string   "locked_by",  limit: 255
+    t.string   "queue",      limit: 255
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "delayed_jobs", ["priority", "run_at"], name: "delayed_jobs_priority", using: :btree
+
 end

data/spec/jobs/auth_net_receiver/process_transaction_job_spec.rb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+module AuthNetReceiver
+  RSpec.describe ProcessTransactionJob, :type => :job do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: auth_net_receiver
 version: !ruby/object:Gem::Version
-  version: 1.0.beta1
+  version: 1.0.beta2
 platform: ruby
 authors:
 - Greg Woods
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +113,7 @@ files:
 - Rakefile
 - app/controllers/auth_net_receiver/application_controller.rb
 - app/controllers/auth_net_receiver/raw_transactions_controller.rb
+- app/jobs/auth_net_receiver/process_transaction_job.rb
 - app/models/auth_net_receiver/raw_transaction.rb
 - app/models/auth_net_receiver/transaction.rb
 - config/routes.rb
@@ -126,6 +133,7 @@ files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
+- spec/dummy/bin/delayed_job
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
 - spec/dummy/bin/setup
@@ -148,6 +156,9 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/migrate/20141214034049_create_auth_net_receiver_raw_transactions.auth_net_receiver.rb
+- spec/dummy/db/migrate/20141214034050_create_auth_net_receiver_transactions.auth_net_receiver.rb
+- spec/dummy/db/migrate/20141214034232_create_delayed_jobs.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -155,6 +166,7 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/factories/auth_net_receiver_raw_transactions.rb
 - spec/factories/auth_net_receiver_transactions.rb
+- spec/jobs/auth_net_receiver/process_transaction_job_spec.rb
 - spec/models/auth_net_receiver/raw_transaction_spec.rb
 - spec/models/auth_net_receiver/transaction_spec.rb
 - spec/rails_helper.rb
@@ -192,6 +204,7 @@ test_files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
+- spec/dummy/bin/delayed_job
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
 - spec/dummy/bin/setup
@@ -214,6 +227,9 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
 - spec/dummy/config.ru
+- spec/dummy/db/migrate/20141214034049_create_auth_net_receiver_raw_transactions.auth_net_receiver.rb
+- spec/dummy/db/migrate/20141214034050_create_auth_net_receiver_transactions.auth_net_receiver.rb
+- spec/dummy/db/migrate/20141214034232_create_delayed_jobs.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -223,6 +239,7 @@ test_files:
 - spec/dummy/README.rdoc
 - spec/factories/auth_net_receiver_raw_transactions.rb
 - spec/factories/auth_net_receiver_transactions.rb
+- spec/jobs/auth_net_receiver/process_transaction_job_spec.rb
 - spec/models/auth_net_receiver/raw_transaction_spec.rb
 - spec/models/auth_net_receiver/transaction_spec.rb
 - spec/rails_helper.rb