rock_rms 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 765aea7d65ac938d72b224db13b53ef9a14a01a4
-  data.tar.gz: e61962b4c4647bd2c0a75a654c6662ab9a3adcd0
+  metadata.gz: 65ed9a699a31184f1078ecace1c1b051a1b47cec
+  data.tar.gz: 32794e0d15893c90bdf25837bdef55ba091ae849
 SHA512:
-  metadata.gz: 2fbbab71f6c18d1ee19ec069ac1eec9223240bff7a9e38dfcf7256e9d6f4d018af61f1c7be2a15ee07f886eeb950637ae2f210ebfd20136bf7a311882ae61ca4
-  data.tar.gz: ae2d0c9953da765fe8af28c1b672bfb97006c260d97254447e945776f8c1ea77657562280d45463dcaa52b576b1df3fe4fa253d0864bf7c92888ea11ef06ba4f
+  metadata.gz: df5926061ebb2526b41a1628b028e77925ec7e9708cbf7e452762b9c840a7bc266a2bf84885cbd1526f9f202b70e9d5f56a727f3aec3bda9fea1ca9a925824a1
+  data.tar.gz: bf1cd9228b9196b391419cd287b42a59340dd5320dc82d4d4259f0317d9da25f3cc29bf2a906e64a21f2d85fa14e4d541c4a52deb75907c6529a9894be4661be

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.3.6

data/lib/rock_rms/client.rb

@@ -3,12 +3,11 @@ require 'faraday_middleware'
 require 'faraday_middleware/parse_oj'
 
 Dir[File.expand_path('../resources/*.rb', __FILE__)].each { |f| require f }
-Dir[File.expand_path('../responses/*.rb', __FILE__)].each { |f| require f }
+Dir[File.expand_path('../response/*.rb', __FILE__)].each { |f| require f }
 
 module RockRMS
   class Client
     include RockRMS::Client::Batch
-    include RockRMS::Client::Donation
     include RockRMS::Client::Fund
     include RockRMS::Client::Group
     include RockRMS::Client::GroupMember
@@ -16,6 +15,7 @@ module RockRMS
     include RockRMS::Client::Person
     include RockRMS::Client::PhoneNumber
     include RockRMS::Client::RecurringDonation
+    include RockRMS::Client::Transaction
     include RockRMS::Client::TransactionDetail
 
     attr_reader :url, :username, :password, :logger, :cookie, :connection

data/lib/rock_rms/resources/batch.rb

@@ -2,11 +2,13 @@ module RockRMS
   class Client
     module Batch
       def list_batches(options = {})
-        get(batches_path, options)
+        res = get(batches_path, options)
+        Response::Batch.format(res)
       end
 
       def find_batch(id)
-        get(batches_path(id))
+        res = get(batches_path(id))
+        Response::Batch.format(res)
       end
 
       def create_batch(name:, start_time:, end_time:, foreign_key: nil)

data/lib/rock_rms/resources/fund.rb

@@ -3,7 +3,7 @@ module RockRMS
     module Fund
       def list_funds(options = {})
         res = get(fund_path, options)
-        RockRMS::Fund.format(res)
+        Response::Fund.format(res)
       end
 
       private

data/lib/rock_rms/resources/group.rb

@@ -2,11 +2,11 @@ module RockRMS
   class Client
     module Group
       def list_groups(options = {})
-        RockRMS::Responses::Group.format(get(group_path, options))
+        Response::Group.format(get(group_path, options))
       end
 
       def find_group(id)
-        RockRMS::Responses::Group.format(get(group_path(id)))
+        Response::Group.format(get(group_path(id)))
       end
 
       def list_groups_for_person(person_id, options = {})
@@ -20,7 +20,7 @@ module RockRMS
       end
 
       def list_families_for_person(person_id, options = {})
-        RockRMS::Responses::Group.format(
+        Response::Group.format(
           get("Groups/GetFamilies/#{person_id}", options)
         )
       end

data/lib/rock_rms/resources/person.rb

@@ -3,17 +3,17 @@ module RockRMS
     module Person
       def list_people(options = {})
         res = get(people_path, options)
-        RockRMS::Responses::Person.format(res)
+        Response::Person.format(res)
       end
 
       def find_person(id)
         res = get(people_path(id))
-        RockRMS::Responses::Person.format(res)
+        Response::Person.format(res)
       end
 
       def find_person_by_email(email)
         res = get("People/GetByEmail/#{email}")
-        RockRMS::Responses::Person.format(res)
+        Response::Person.format(res)
       end
 
       NAME_SEARCH_DEFAULTS = {
@@ -26,7 +26,7 @@ module RockRMS
       def find_person_by_name(full_name, options = {})
         priority = options.merge(name: full_name)
 
-        RockRMS::Responses::Person.format(
+        Response::Person.format(
           get('People/Search', NAME_SEARCH_DEFAULTS.merge(priority))
         )
       end

data/lib/rock_rms/resources/phone_number.rb

@@ -2,7 +2,7 @@ module RockRMS
   class Client
     module PhoneNumber
       def list_phone_numbers(options = {})
-        RockRMS::Responses::PhoneNumber.format(get(phone_number_path, options))
+        Response::PhoneNumber.format(get(phone_number_path, options))
       end
 
       private

data/lib/rock_rms/resources/recurring_donation.rb

@@ -3,12 +3,12 @@ module RockRMS
     module RecurringDonation
       def list_recurring_donations(options = {})
         res = get(recurring_donation_path, options)
-        RockRMS::Responses::RecurringDonation.format(res)
+        Response::RecurringDonation.format(res)
       end
 
       def find_recurring_donation(id)
         res = get(recurring_donation_path(id))
-        RockRMS::Responses::RecurringDonation.format(res)
+        Response::RecurringDonation.format(res)
       end
 
       def update_recurring_donation(

data/lib/rock_rms/resources/{donation.rb → transaction.rb}

@@ -1,22 +1,24 @@
 module RockRMS
   class Client
-    module Donation
-      def list_donations(options = {})
+    module Transaction
+      PATH = 'FinancialTransactions'.freeze
+
+      def list_transactions(options = {})
         res = get(transaction_path, options)
-        RockRMS::Responses::Donation.format(res)
+        Response::Transaction.format(res)
       end
 
       def find_donations_by_giving_id(id, raw = false)
-        res = get("FinancialTransactions/GetByGivingId/#{id}?$expand=TransactionDetails")
-        raw ? res : RockRMS::Responses::Donation.format(res)
+        res = get("#{PATH}/GetByGivingId/#{id}?$expand=TransactionDetails")
+        raw ? res : Response::Transaction.format(res)
       end
 
-      def find_donation(id)
+      def find_transaction(id)
         res = get(transaction_path(id))
-        RockRMS::Responses::Donation.format(res)
+        Response::Transaction.format(res)
       end
 
-      def create_donation(
+      def create_transaction(
         authorized_person_id:,
         batch_id:,
         date:,
@@ -43,7 +45,7 @@ module RockRMS
         post(transaction_path, options)
       end
 
-      def update_donation(id, batch_id: nil, summary: nil, recurring_donation_id: nil)
+      def update_transaction(id, batch_id: nil, summary: nil, recurring_donation_id: nil)
         options = {}
 
         options['Summary'] = summary  if summary
@@ -53,7 +55,7 @@ module RockRMS
         patch(transaction_path(id), options)
       end
 
-      def delete_donation(id)
+      def delete_transaction(id)
         delete(transaction_path(id))
       end
 
@@ -69,7 +71,7 @@ module RockRMS
       end
 
       def transaction_path(id = nil)
-        id ? "FinancialTransactions/#{id}" : 'FinancialTransactions'
+        id ? "#{PATH}/#{id}" : PATH
       end
     end
   end

data/lib/rock_rms/resources/transaction_detail.rb

@@ -3,12 +3,12 @@ module RockRMS
     module TransactionDetail
       def list_transaction_details(options = {})
         res = get(transaction_detail_path, options)
-        RockRMS::Responses::TransactionDetail.format(res)
+        Response::TransactionDetail.format(res)
       end
 
       def find_transaction_detail(id)
         res = get(transaction_detail_path(id))
-        RockRMS::Responses::TransactionDetail.format(res)
+        Response::TransactionDetail.format(res)
       end
 
       def update_transaction_detail(id, fund_id:)

data/lib/rock_rms/response/base.rb

@@ -0,0 +1,29 @@
+module RockRMS
+  module Response
+    class Base
+      attr_reader :data
+
+      def self.format(data)
+        new(data).format
+      end
+
+      def initialize(data)
+        @data = data
+      end
+
+      def format
+        if data.is_a?(Array)
+          data.map { |item| format_single(item) }
+        else
+          format_single(data)
+        end
+      end
+
+      def to_h(dict, data)
+        dict.each_with_object({}) do |(l, r), object|
+          object[l] = data[r]
+        end
+      end
+    end
+  end
+end

data/lib/rock_rms/response/batch.rb

@@ -0,0 +1,23 @@
+module RockRMS
+  module Response
+    class Batch < Base
+      MAP = {
+        id: 'Id',
+        name: 'Name',
+        control_amount: 'ControlAmount',
+        transactions: 'Transactions'
+      }.freeze
+
+      def format_single(data)
+        response = to_h(MAP, data)
+        response[:transactions] = Transaction.format(response[:transactions])
+        response[:amount]       = calculate_total(response[:transactions])
+        response
+      end
+
+      def calculate_total(transactions)
+        transactions.reduce(0) { |sum, txn| sum + txn[:amount] }
+      end
+    end
+  end
+end

data/lib/rock_rms/{responses → response}/campus.rb

@@ -1,6 +1,6 @@
 module RockRMS
-  module Responses
-    class Campus
+  module Response
+    class Campus < Base
       MAP = {
         id: 'Id',
         name: 'Name',
@@ -14,18 +14,8 @@ module RockRMS
         guid: 'Guid'
       }.freeze
 
-      def self.format(data)
-        if data.is_a?(Array)
-          data.map { |object| format_single(object) }
-        else
-          format_single(data)
-        end
-      end
-
-      def self.format_single(data)
-        MAP.each.with_object({}) do |(l, r), object|
-          object[l] = data[r]
-        end
+      def format_single(data)
+        to_h(MAP, data)
       end
     end
   end

data/lib/rock_rms/response/fund.rb

@@ -0,0 +1,14 @@
+module RockRMS
+  module Response
+    class Fund < Base
+      MAP = {
+        id:   'Id',
+        name: 'Name'
+      }.freeze
+
+      def format_single(data)
+        to_h(MAP, data)
+      end
+    end
+  end
+end

data/lib/rock_rms/{responses → response}/group.rb

@@ -1,6 +1,6 @@
 module RockRMS
-  module Responses
-    class Group
+  module Response
+    class Group < Base
       MAP = {
         id: 'Id',
         name: 'Name',
@@ -12,18 +12,8 @@ module RockRMS
         members: 'Members'
       }.freeze
 
-      def self.format(data)
-        if data.is_a?(Array)
-          data.map { |object| format_single(object) }
-        else
-          format_single(data)
-        end
-      end
-
-      def self.format_single(data)
-        result = MAP.each.with_object({}) do |(l, r), object|
-          object[l] = data[r]
-        end
+      def format_single(data)
+        result = to_h(MAP, data)
 
         if group_locations = data['GroupLocations']
           result[:group_locations] = GroupLocation.format(group_locations)

data/lib/rock_rms/response/group_location.rb

@@ -0,0 +1,22 @@
+module RockRMS
+  module Response
+    class GroupLocation < Base
+      MAP = {
+        id: 'Id',
+        group_id: 'GroupId',
+        location_id: 'LocationId',
+        guid: 'Guid'
+      }.freeze
+
+      def format_single(data)
+        result = to_h(MAP, data)
+
+        if location = data['Location']
+          result[:location] = Location.format(location)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/rock_rms/{responses → response}/location.rb

@@ -1,6 +1,6 @@
 module RockRMS
-  module Responses
-    class Location
+  module Response
+    class Location < Base
       MAP = {
         id: 'Id',
         name: 'Name',
@@ -17,18 +17,8 @@ module RockRMS
         guid: 'Guid'
       }.freeze
 
-      def self.format(data)
-        if data.is_a?(Array)
-          data.map { |object| format_single(object) }
-        else
-          format_single(data)
-        end
-      end
-
-      def self.format_single(data)
-        MAP.each.with_object({}) do |(l, r), object|
-          object[l] = data[r]
-        end
+      def format_single(data)
+        to_h(MAP, data)
       end
     end
   end

data/lib/rock_rms/response/payment_method.rb

@@ -0,0 +1,16 @@
+module RockRMS
+  module Response
+    class PaymentMethod < Base
+      MAP = {
+        id: 'Id',
+        foreign_key: 'ForeignKey',
+        payment_type_id: 'CurrencyTypeValueId',
+        masked_number: 'AccountNumberMasked'
+      }.freeze
+
+      def format_single(data)
+        to_h(MAP, data)
+      end
+    end
+  end
+end

data/lib/rock_rms/response/person.rb

@@ -0,0 +1,20 @@
+module RockRMS
+  module Response
+    class Person < Base
+      MAP = {
+        id:         'Id',
+        name:       'FullName',
+        email:      'Email',
+        first_name: 'FirstName',
+        last_name:  'LastName',
+        giving_id:  'GivingId',
+        alias_id:   'PrimaryAliasId',
+        connection_status_value_id: 'ConnectionStatusValueId'
+      }.freeze
+
+      def format_single(data)
+        to_h(MAP, data)
+      end
+    end
+  end
+end