rock_rms 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cbd1e3135b8af5ee807b31db1540e14d922a24e
-  data.tar.gz: c39a14cdfb5d434b9ee74ae95a462d82555c4aad
+  metadata.gz: 0ce2e3c0428ddbc12f3f61174a80bfe26a118396
+  data.tar.gz: 486cfc3c44790ec1e12641653189edef93919e6f
 SHA512:
-  metadata.gz: d2793c043b4a20524975f842667453774a943bae5a891ee762857b56077ddd318a4ee21a0738f1d67ce4709770e610ed783233a5d85ef26c704d2c2fa624f3d1
-  data.tar.gz: fb61bec8b329ef95b6166e6dc162c01ed830b43f37b67465b832673537bc32f779742e3e5c94262a2845a913f143691d5b638544112afb4c872eaab2ce360fed
+  metadata.gz: 545647157dcd6a2ac1e0092adbd0b232ed48be5db15b5634a89af339ebbc988db094757cfb46dcf91d1fcb7ce688da76b6533e107c89af81949092dd8d176d24
+  data.tar.gz: 734b379adb815d742ed2373497752ff454c961d9a8223d6e90b2a5db28a038f2a3ccb1aabb79f2db0c10ff687c73e9324add58a9f975674203f8389d12e4d7e6

data/lib/rock_rms/client.rb

@@ -16,6 +16,7 @@ module RockRMS
     include RockRMS::Client::Person
     include RockRMS::Client::PhoneNumber
     include RockRMS::Client::RecurringDonation
+    include RockRMS::Client::Refund
     include RockRMS::Client::Transaction
     include RockRMS::Client::TransactionDetail
 

data/lib/rock_rms/resources/refund.rb

@@ -0,0 +1,48 @@
+module RockRMS
+  class Client
+    module Refund
+      PATH = 'FinancialTransactionRefunds'.freeze
+
+      def create_refund(
+        batch_id:,
+        date:,
+        reason_id:,
+        transaction_id:
+      )
+        old_transaction = list_transactions(
+          '$expand' => 'TransactionDetails',
+          '$filter' => "Id eq #{transaction_id}"
+        ).first
+
+        params = {
+          'OriginalTransactionId' => transaction_id,
+          'RefundReasonValueId' => reason_id,
+          'FinancialTransaction' => {
+            'AuthorizedPersonAliasId' => old_transaction[:person_id],
+            'BatchId' => batch_id,
+            'FinancialPaymentDetailId' => old_transaction[:payment_detail_id],
+            'TransactionDateTime' => date,
+            'TransactionDetails'  => translate_negative(old_transaction[:details]),
+            'TransactionTypeValueId' => old_transaction[:transaction_type_id]
+          }
+        }
+        post(refund_path, params)
+      end
+
+      private
+
+      def translate_negative(details)
+        details.map do |dt|
+          {
+            'Amount' => -dt[:amount],
+            'AccountId' => dt[:fund_id]
+          }
+        end
+      end
+
+      def refund_path(id = nil)
+        id ? "#{PATH}/#{id}" : PATH
+      end
+    end
+  end
+end

data/lib/rock_rms/response/transaction.rb

@@ -9,7 +9,9 @@ module RockRMS
         recurring_donation_id: 'ScheduledTransactionId',
         summary: 'Summary',
         transaction_code: 'TransactionCode',
-        details: 'TransactionDetails'
+        details: 'TransactionDetails',
+        payment_detail_id: 'FinancialPaymentDetailId',
+        transaction_type_id: 'TransactionTypeValueId'
       }.freeze
 
 

data/lib/rock_rms/version.rb

@@ -1,3 +1,3 @@
 module RockRMS
-  VERSION = '3.0.2'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/spec/rock_rms/resources/refund_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Client::Refund, type: :model do
+  include_context 'resource specs'
+
+  describe '#create_refund' do
+    context 'arguments' do
+      it 'require `authorized_person_id`' do
+        expect { client.create_refund }
+          .to raise_error(ArgumentError, /transaction_id/)
+      end
+
+      it 'require `batch_id`' do
+        expect { client.create_refund }
+          .to raise_error(ArgumentError, /batch_id/)
+      end
+
+      it 'require `date`' do
+        expect { client.create_refund }
+          .to raise_error(ArgumentError, /date/)
+      end
+
+      it 'require `funds`' do
+        expect { client.create_refund }
+          .to raise_error(ArgumentError, /reason_id/)
+      end
+
+    end
+
+    subject(:resource) do
+      client.create_refund(
+        transaction_id: 1422,
+        batch_id: 1,
+        date: '2018-02-01',
+        reason_id: 1
+      )
+    end
+
+    it 'returns integer' do
+      expect(resource).to be_a(Integer)
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'FinancialTransactionRefunds',
+          'OriginalTransactionId' => 1422,
+          'RefundReasonValueId' => 1,
+          'FinancialTransaction' => {
+            'AuthorizedPersonAliasId' => 120,
+            'BatchId' => 1,
+            'FinancialPaymentDetailId' => 156,
+            'TransactionDateTime' => '2018-02-01',
+            'TransactionDetails'  => [
+              {
+                'Amount' => -100.0,
+                'AccountId' => 23
+              }
+            ],
+            'TransactionTypeValueId' => 53
+          }
+        )
+        .and_call_original
+      resource
+    end
+  end
+end

data/spec/rock_rms/response/transaction_spec.rb

@@ -20,6 +20,8 @@ RSpec.describe RockRMS::Response::Transaction, type: :model do
         expect(r[:recurring_donation_id]).to eq(p['ScheduledTransactionId'])
         expect(r[:summary]).to eq(p['Summary'])
         expect(r[:transaction_code]).to eq(p['TransactionCode'])
+        expect(r[:payment_detail_id]).to eq(p['FinancialPaymentDetailId'])
+        expect(r[:transaction_type_id]).to eq(p['TransactionTypeValueId'])
         expect(r[:details]).to eq(
           RockRMS::Response::TransactionDetail.format(p['TransactionDetails'])
         )

data/spec/support/fixtures/create_refund.json

@@ -0,0 +1 @@
+12345

data/spec/support/rock_mock.rb

@@ -40,7 +40,8 @@ class RockMock < Sinatra::Base
   {
     create_group_member: 'GroupMembers',
     create_transaction: 'FinancialTransactions',
-    create_batch: 'FinancialBatches'
+    create_batch: 'FinancialBatches',
+    create_refund: 'FinancialTransactionRefunds'
   }.each do |json, end_point|
     post "/api/#{end_point}" do
       json_response 201, "#{json}.json"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rock_rms
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Taylor Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,6 +192,7 @@ files:
 - lib/rock_rms/resources/person.rb
 - lib/rock_rms/resources/phone_number.rb
 - lib/rock_rms/resources/recurring_donation.rb
+- lib/rock_rms/resources/refund.rb
 - lib/rock_rms/resources/transaction.rb
 - lib/rock_rms/resources/transaction_detail.rb
 - lib/rock_rms/response/base.rb
@@ -218,6 +219,7 @@ files:
 - spec/rock_rms/resources/person_spec.rb
 - spec/rock_rms/resources/phone_number_spec.rb
 - spec/rock_rms/resources/recurring_donation_spec.rb
+- spec/rock_rms/resources/refund_spec.rb
 - spec/rock_rms/resources/transaction_detail_spec.rb
 - spec/rock_rms/resources/transaction_spec.rb
 - spec/rock_rms/response/batch_spec.rb
@@ -238,6 +240,7 @@ files:
 - spec/support/fixtures/campuses.json
 - spec/support/fixtures/create_batch.json
 - spec/support/fixtures/create_group_member.json
+- spec/support/fixtures/create_refund.json
 - spec/support/fixtures/create_transaction.json
 - spec/support/fixtures/families.json
 - spec/support/fixtures/group.json