rock_rms 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3bf2fbd0092ad9afa7bc274f05201848d886b5f
-  data.tar.gz: 10715556852bd2472671646798a50ab35c78dd54
+  metadata.gz: 8020457d40757f3f46ae6fdbbbe7c9552503b9b8
+  data.tar.gz: 914245cc572c0d6d528f904cc06c84becb679f16
 SHA512:
-  metadata.gz: 96eda68c2764ce38ecab7e8efcda03c6558c279c12f728bc9a927223ceb60bc40ce0ec971086475ce51d770f54036b8c933eec78d8c7ac1a9643d118b19a5536
-  data.tar.gz: 2862be265f417d8a922a6c45c123d2d8c85cb4347be3d2f279bfc949a0af56c8a3df5c20a424227ddbb8895d404678491e1e857c5b5a048dac1e79d05bba4277
+  metadata.gz: d5f676541b1191b279237d2c64249b2af91b4556ffacbbde09eca5542f58f67d8711a8209beb3f8d9b81d74ae4b563c9065b200fd6652e4601eb954e1d1de211
+  data.tar.gz: ca8621d50b0e2971cbbea78b616e81742956523ea4a88b0973eb46776c46dc0ba066edabbaaaebc93da9bea2deacdf2dc042199166419999e6016bab186e8d49

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/README.md

@@ -1,4 +1,8 @@
-### A Ruby wrapper for the Rock RMS API
+![](https://www.rockrms.com/Themes/RockExternal/Assets/Images/rock-logo.svg)
+
+# Rock RMS Ruby Client [![Build Status](https://travis-ci.org/taylorbrooks/rock_rms.svg?branch=master)](https://travis-ci.org/taylorbrooks/rock_rms)
+
+A Ruby wrapper for the Rock RMS API
 
 To get a general overview of Rock RMS: https://www.rockrms.com
 

data/lib/rock_rms/resources/phone_number.rb

@@ -8,7 +8,7 @@ module RockRMS
       private
 
       def phone_number_path(id = nil)
-        id ? "PhoneNumbers/#{id}" : "PhoneNumbers"
+        id ? "PhoneNumbers/#{id}" : 'PhoneNumbers'
       end
     end
   end

data/lib/rock_rms/resources/recurring_donation.rb

@@ -3,12 +3,23 @@ module RockRMS
     module RecurringDonation
       def list_recurring_donations(options = {})
         res = get(recurring_donation_path, options)
-        RockRMS::RecurringDonation.format(res)
+        RockRMS::Responses::RecurringDonation.format(res)
       end
 
       def find_recurring_donation(id)
         res = get(recurring_donation_path(id))
-        RockRMS::RecurringDonation.format(res)
+        RockRMS::Responses::RecurringDonation.format(res)
+      end
+
+      def update_recurring_donation(
+        id,
+        next_payment_date:,
+        transaction_code: nil
+      )
+        options = { 'NextPaymentDate' => next_payment_date }
+        options['TransactionCode'] = transaction_code if transaction_code
+
+        patch(recurring_donation_path(id), options)
       end
 
       private

data/lib/rock_rms/responses/campus.rb

@@ -22,10 +22,8 @@ module RockRMS
         end
       end
 
-      private
-
       def self.format_single(data)
-        MAP.each.with_object({}) do |(l,r), object|
+        MAP.each.with_object({}) do |(l, r), object|
           object[l] = data[r]
         end
       end

data/lib/rock_rms/responses/phone_number.rb

@@ -18,7 +18,7 @@ module RockRMS
       end
 
       def self.format_number(data)
-        MAP.each.with_object({}) do |(l,r), object|
+        MAP.each.with_object({}) do |(l, r), object|
           object[l] = data[r]
         end
       end

data/lib/rock_rms/responses/recurring_donation.rb

@@ -1,26 +1,31 @@
 module RockRMS
-  class RecurringDonation
-    MAP = {
-      id: 'Id',
-      person_id: 'AuthorizedPersonAliasId',
-      transaction_details: 'ScheduledTransactionDetails'
-    }.freeze
+  module Responses
+    class RecurringDonation
+      MAP = {
+        id: 'Id',
+        foreign_key: 'ForeignKey',
+        next_payment_date: 'NextPaymentDate',
+        person_id: 'AuthorizedPersonAliasId',
+        transaction_details: 'ScheduledTransactionDetails',
+        transaction_code: 'TransactionCode'
+      }.freeze
 
-    def self.format(data)
-      if data.is_a?(Array)
-        data.map { |object| format_single(object) }
-      else
-        format_single(data)
+      def self.format(data)
+        if data.is_a?(Array)
+          data.map { |object| format_single(object) }
+        else
+          format_single(data)
+        end
       end
-    end
 
-    def self.format_single(data)
-      MAP.each.with_object({}) do |(l, r), object|
-        object[l] = if l == :transaction_details
-                      RockRMS::RecurringDonationDetails.format(data[r])
-                    else
-                      data[r]
-                    end
+      def self.format_single(data)
+        MAP.each.with_object({}) do |(l, r), object|
+          object[l] = if l == :transaction_details
+                        RockRMS::Responses::RecurringDonationDetails.format(data[r])
+                      else
+                        data[r]
+                      end
+        end
       end
     end
   end

data/lib/rock_rms/responses/recurring_donation_details.rb

@@ -1,21 +1,23 @@
 module RockRMS
-  class RecurringDonationDetails
-    MAP = {
-      fund_id: 'AccountId',
-      amount: 'Amount'
-    }.freeze
+  module Responses
+    class RecurringDonationDetails
+      MAP = {
+        fund_id: 'AccountId',
+        amount: 'Amount'
+      }.freeze
 
-    def self.format(data)
-      if data.is_a?(Array)
-        data.map { |object| format_single(object) }
-      else
-        format_single(data)
+      def self.format(data)
+        if data.is_a?(Array)
+          data.map { |object| format_single(object) }
+        else
+          format_single(data)
+        end
       end
-    end
 
-    def self.format_single(data)
-      MAP.each.with_object({}) do |(l, r), object|
-        object[l] = data[r]
+      def self.format_single(data)
+        MAP.each.with_object({}) do |(l, r), object|
+          object[l] = data[r]
+        end
       end
     end
   end

data/lib/rock_rms/version.rb

@@ -1,3 +1,3 @@
 module RockRMS
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/spec/rock_rms/resources/group_member_spec.rb

@@ -24,17 +24,16 @@ RSpec.describe RockRMS::Client::GroupMember, type: :model do
         expect { client.create_group_member }
           .to raise_error(ArgumentError, /person_id/)
       end
-
     end
 
-    subject(:resource) {
+    subject(:resource) do
       client.create_group_member(
         group_id: 123,
         group_member_status: 1,
         group_role_id: 456,
         person_id: 123456
       )
-    }
+    end
 
     it 'returns integer' do
       expect(resource).to be_a(Integer)

data/spec/rock_rms/resources/recurring_donation_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Client::RecurringDonation, type: :model do
+  include_context 'resource specs'
+
+  describe '#list_recurring_donations(options = {})' do
+    it 'returns a array of hashes' do
+      resource = client.list_recurring_donations
+      expect(resource).to be_a(Array)
+      expect(resource.first).to be_a(Hash)
+    end
+
+    it 'queries recurring donations' do
+      expect(client).to receive(:get)
+        .with('FinancialScheduledTransactions', {})
+        .and_call_original
+      client.list_recurring_donations
+    end
+
+    it 'formats with RecurringDonation' do
+      response = double
+      expect(RockRMS::Responses::RecurringDonation).to receive(:format).with(response)
+      allow(client).to receive(:get).and_return(response)
+      client.list_recurring_donations
+    end
+  end
+
+  describe '#find_recurring_donation(id)' do
+    it 'returns a hash' do
+      expect(client.find_recurring_donation(12_345)).to be_a(Hash)
+    end
+
+    it 'queries recurring donations' do
+      expect(client).to receive(:get)
+        .with('FinancialScheduledTransactions/12345')
+        .and_call_original
+
+      resource = client.find_recurring_donation(12_345)
+
+      expect(resource[:id]).to eq(12_345)
+    end
+
+    it 'formats with RecurringDonation' do
+      response = double
+      expect(RockRMS::Responses::RecurringDonation).to receive(:format).with(response)
+      allow(client).to receive(:get).and_return(response)
+      client.find_recurring_donation(12_345)
+    end
+  end
+
+  describe '#update_recurring_donation(id)' do
+    it 'queries updates the recurring donation' do
+      expect(client).to receive(:patch)
+        .with(
+          'FinancialScheduledTransactions/123',
+          'NextPaymentDate' => '2018-01-01'
+      ).and_call_original
+
+      resource = client.update_recurring_donation(
+        123,
+        next_payment_date: '2018-01-01'
+      )
+
+      expect(resource).to be_nil
+    end
+
+    context 'arguments' do
+      it 'require `id`' do
+        expect { client.update_recurring_donation }
+          .to raise_error(ArgumentError, /wrong number/)
+      end
+    end
+
+    subject(:resource) do
+      client.update_recurring_donation(
+        1,
+        transaction_code: 'recur_1234',
+        next_payment_date: '2018-01-01'
+      )
+    end
+
+    it 'returns nil' do
+      expect(resource).to be_nil
+    end
+  end
+end

data/spec/rock_rms/responses/recurring_donation_details_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Responses::RecurringDonationDetails, type: :model do
+  let(:parsed) { JSON.parse(FixturesHelper.read('recurring_donation_details.json')) }
+
+  describe '.format' do
+    subject(:result) { described_class.format(parsed) }
+
+    context 'when response is array' do
+      it 'returns an array' do
+        expect(described_class.format([])).to be_a(Array)
+      end
+    end
+
+    it 'translates keys' do
+      result.zip(parsed) do |r, p|
+        expect(r[:fund_id]).to eq(p['AccountId'])
+        expect(r[:amount]).to eq(p['Amount'])
+      end
+    end
+  end
+end

data/spec/rock_rms/responses/recurring_donation_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+RSpec.describe RockRMS::Responses::RecurringDonation, type: :model do
+  let(:parsed) { JSON.parse(FixturesHelper.read('recurring_donations.json')) }
+
+  describe '.format' do
+    subject(:result) { described_class.format(parsed) }
+
+    context 'when response is array' do
+      it 'returns an array' do
+        expect(described_class.format([])).to be_a(Array)
+      end
+    end
+
+    it 'translates keys' do
+      result.zip(parsed) do |r, p|
+        expect(r[:id]).to eq(p['Id'])
+        expect(r[:foreign_key]).to eq(p['ForeignKey'])
+        expect(r[:next_payment_date]).to eq(p['NextPaymentDate'])
+        expect(r[:person_id]).to eq(p['AuthorizedPersonAliasId'])
+        expect(r[:transaction_details]).to eq(
+          RockRMS::Responses::RecurringDonationDetails.format(p['ScheduledTransactionDetails'])
+        )
+        expect(r[:transaction_code]).to eq(p['TransactionCode'])
+      end
+    end
+  end
+end

data/spec/support/fixtures/recurring_donation.json

@@ -0,0 +1,37 @@
+  {
+    "AuthorizedPersonAliasId": 1234,
+    "TransactionTypeValueId": null,
+    "SourceTypeValueId": 10,
+    "TransactionFrequencyValueId": 135,
+    "StartDate": "2018-01-26T00:00:00",
+    "EndDate": null,
+    "NumberOfPayments": null,
+    "NextPaymentDate": null,
+    "LastStatusUpdateDateTime": null,
+    "IsActive": true,
+    "FinancialGatewayId": 4,
+    "FinancialPaymentDetailId": 28,
+    "TransactionCode": "",
+    "GatewayScheduleId": "",
+    "CardReminderDate": null,
+    "LastRemindedDate": null,
+    "TransactionTypeValue": null,
+    "SourceTypeValue": null,
+    "FinancialGateway": null,
+    "FinancialPaymentDetail": null,
+    "TransactionFrequencyValue": null,
+    "ScheduledTransactionDetails": [],
+    "Transactions":[],
+    "CreatedDateTime": "2018-01-23T17:12:54.123",
+    "ModifiedDateTime": "2018-01-23T17:12:54.123",
+    "CreatedByPersonAliasId": null,
+    "ModifiedByPersonAliasId": null,
+    "ModifiedAuditValuesAlreadyUpdated": false,
+    "Attributes": null,
+    "AttributeValues": null,
+    "Id": 12345,
+    "Guid": "036c27ba-7cba-4a8f-b8d6-36a2e60a9bb0",
+    "ForeignId": 56789,
+    "ForeignGuid": null,
+    "ForeignKey": "RecurringDonation"
+  }

data/spec/support/fixtures/recurring_donation_details.json

@@ -0,0 +1,23 @@
+[
+  {
+    "ScheduledTransactionId": 1,
+    "AccountId": 1,
+    "Amount": 10.00,
+    "Summary": null,
+    "EntityTypeId": null,
+    "EntityId": null,
+    "EntityType": null,
+    "CreatedDateTime": "2017-12-19T14:48:02.553",
+    "ModifiedDateTime": "2017-12-19T14:48:02.553",
+    "CreatedByPersonAliasId": 12,
+    "ModifiedByPersonAliasId": 12,
+    "ModifiedAuditValuesAlreadyUpdated": false,
+    "Attributes": null,
+    "AttributeValues": null,
+    "Id": 1,
+    "Guid": "c5b5ebf6-faec-41d8-8089-51b83633334f",
+    "ForeignId": null,
+    "ForeignGuid": null,
+    "ForeignKey": null
+  }
+]

data/spec/support/fixtures/recurring_donations.json

@@ -0,0 +1,45 @@
+[
+  {
+    "AuthorizedPersonAliasId": 1234,
+    "TransactionTypeValueId": null,
+    "SourceTypeValueId": 10,
+    "TransactionFrequencyValueId": 135,
+    "StartDate": "2018-01-26T00:00:00",
+    "EndDate": null,
+    "NumberOfPayments": null,
+    "NextPaymentDate": null,
+    "LastStatusUpdateDateTime": null,
+    "IsActive": true,
+    "FinancialGatewayId": 4,
+    "FinancialPaymentDetailId": 28,
+    "TransactionCode": "",
+    "GatewayScheduleId": "",
+    "CardReminderDate": null,
+    "LastRemindedDate": null,
+    "TransactionTypeValue": null,
+    "SourceTypeValue": null,
+    "FinancialGateway": null,
+    "FinancialPaymentDetail": null,
+    "TransactionFrequencyValue": null,
+    "ScheduledTransactionDetails": [
+      {
+        "ScheduledTransactionId": 1,
+        "AccountId": 1,
+        "Amount": 10.00
+      }
+    ],
+    "Transactions":[],
+    "CreatedDateTime": "2018-01-23T17:12:54.123",
+    "ModifiedDateTime": "2018-01-23T17:12:54.123",
+    "CreatedByPersonAliasId": null,
+    "ModifiedByPersonAliasId": null,
+    "ModifiedAuditValuesAlreadyUpdated": false,
+    "Attributes": null,
+    "AttributeValues": null,
+    "Id": 12345,
+    "Guid": "036c27ba-7cba-4a8f-b8d6-36a2e60a9bb0",
+    "ForeignId": 56789,
+    "ForeignGuid": null,
+    "ForeignKey": "RecurringDonation"
+  }
+]

data/spec/support/rock_mock.rb

@@ -19,7 +19,9 @@ class RockMock < Sinatra::Base
     group:         'Groups/:id',
     groups:        'Groups',
     people_search: 'People/Search',
-    phone_numbers: 'PhoneNumbers'
+    phone_numbers: 'PhoneNumbers',
+    recurring_donation: 'FinancialScheduledTransactions/:id',
+    recurring_donations: 'FinancialScheduledTransactions'
   }.each do |json, end_point|
     get "/api/#{end_point}" do
       json_response 200, "#{json}.json"
@@ -35,6 +37,16 @@ class RockMock < Sinatra::Base
     end
   end
 
+  # PATCH requests
+  [
+    'FinancialScheduledTransactions/:id'
+  ].each do |end_point|
+    patch "/api/#{end_point}" do
+      content_type :json
+      status 204
+    end
+  end
+
   post '/api/Auth/Login' do
     content_type :json
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rock_rms
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Taylor Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -175,6 +175,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -212,11 +213,14 @@ files:
 - spec/rock_rms/resources/group_spec.rb
 - 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/responses/campus_spec.rb
 - spec/rock_rms/responses/group_location_spec.rb
 - spec/rock_rms/responses/group_spec.rb
 - spec/rock_rms/responses/location_spec.rb
 - spec/rock_rms/responses/phone_number_spec.rb
+- spec/rock_rms/responses/recurring_donation_details_spec.rb
+- spec/rock_rms/responses/recurring_donation_spec.rb
 - spec/rock_rms_spec.rb
 - spec/spec_helper.rb
 - spec/support/client_factory.rb
@@ -232,6 +236,9 @@ files:
 - spec/support/fixtures/locations.json
 - spec/support/fixtures/people_search.json
 - spec/support/fixtures/phone_numbers.json
+- spec/support/fixtures/recurring_donation.json
+- spec/support/fixtures/recurring_donation_details.json
+- spec/support/fixtures/recurring_donations.json
 - spec/support/fixtures_helper.rb
 - spec/support/rock_mock.rb
 homepage: https://github.com/taylorbrooks/rock_rms