rock_rms 8.4.0 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99595984bdaa0f88e5c67214510f387e8140da99eb8c19838e157e34fe8cbde5
-  data.tar.gz: c52d968559001749f7793259241bc15b7417f8ebb2173d0b057c5c5e0dabfb72
+  metadata.gz: a9c04e1fe039a7d8bfadb17f09ba3bae6c9da6519b501dcaa0e911fd590b81df
+  data.tar.gz: 4ad41691163a7479d9b80387f3d36072a487238cbc1235844e5a718ff2452fd8
 SHA512:
-  metadata.gz: 2baef9f7cf2861dbb34d70e978d0a479ca064c4bd95f2408bfbf125e84f3472bfb44991f2f607efd920e9a752e31bf32e36489b1b9beb9c7aa040d97365c7af7
-  data.tar.gz: 1ced4bd65ca1ed1669f8a9a64968a889ab04b576c8c4df03e8773d53f04bcbf762035e1bf2b77259689c448dbd5ebbf2cd66be42954da3ad7f818d441fd147ee
+  metadata.gz: 7483f4c398437d73dcfb1daa0bbd1fa9cbea89a52bfb2ed8b5fee65f3567048564d6634b544d59aec684c78d6879d749428d1d2f7f37a0c991836e54c4f881f3
+  data.tar.gz: e53e8d7a856f72fd85b4bec5fe21c7f95bfc59d9d564417262076d1a082ec793c4a565dd9a9ada1cf80e80d9b0b54f57defcd0825edc1d935fb433c989c47187

data/README.md

@@ -22,12 +22,19 @@ Add this line to your application's Gemfile:
 
 ### Usage
 ````ruby
+  # Authenticating with username and password
   client = RockRMS::Client.new(
     url: ...,
     username: ...,
     password: ...,
   )
 
+  # Authenticating with authorization token
+  client = RockRMS::Client.new(
+    url: ...,
+    authorization_token: ...,
+  )
+
   # Find a specific person
   client.find_person_by_email('gob@bluthco.com')
   client.find_person_by_name('Tobias Funke')

data/lib/rock_rms/client.rb

@@ -4,11 +4,13 @@ require 'faraday/multipart'
 
 Dir[File.expand_path('../resources/*.rb', __FILE__)].each { |f| require f }
 require File.expand_path('../response/base.rb', __FILE__)
+require File.expand_path('../transform_hash_keys.rb', __FILE__)
 require File.expand_path('../recurring_frequencies.rb', __FILE__)
 Dir[File.expand_path('../response/*.rb', __FILE__)].each { |f| require f }
 
 module RockRMS
   class Client
+    include TransformHashKeys
     include RecurringFrequencies
     include RockRMS::Client::Attribute
     include RockRMS::Client::AttributeValue
@@ -46,16 +48,21 @@ module RockRMS
     include RockRMS::Client::WorkflowActivityType
     include RockRMS::Client::WorkflowType
 
-    attr_reader :url, :username, :password, :logger, :cookie, :connection, :adapter, :ssl
+    attr_reader :url, :username, :password, :logger, :cookie, :connection, :adapter, :ssl, :authorization_token
+
+    def initialize(url:, username: nil, password: nil, authorization_token: nil, logger: true, adapter: Faraday.default_adapter, ssl: nil)
+      if username.nil? && password.nil? && authorization_token.nil?
+        raise ArgumentError, 'either username and password or authorization_token is required'
+      end
 
-    def initialize(url:, username:, password:, logger: true, adapter: Faraday.default_adapter, ssl: nil)
       @url      = "#{url}/api/"
-      @username = username
-      @password = password
+      @username = username unless authorization_token
+      @password = password unless authorization_token
+      @authorization_token = authorization_token unless username && password
       @logger   = logger
       @adapter  = adapter
       @ssl      = ssl
-      @cookie   = auth['set-cookie']
+      @cookie   = auth['set-cookie'] unless auth.nil?
     end
 
     def delete(path, options = {})
@@ -81,6 +88,8 @@ module RockRMS
     private
 
     def auth
+      return nil if username.nil? && password.nil?
+
       begin
         auth_request('Auth/Login')
       rescue Faraday::ParsingError => e
@@ -108,6 +117,7 @@ module RockRMS
       }
 
       headers['Cookie'] = cookie if cookie
+      headers['Authorization-Token'] = authorization_token if authorization_token
 
       client_opts = {
         url: url,

data/lib/rock_rms/resources/group.rb

@@ -25,6 +25,23 @@ module RockRMS
         )
       end
 
+      #
+      # address_format
+      # {
+      #   street1:,
+      #   street2:,
+      #   city:,
+      #   state:,
+      #   postal_code:,
+      #   country:,
+      # }
+      #
+      def save_group_address(group_id:, location_type_id:, address:)
+        url_params = TransformHashKeys.camelize_keys(address)
+
+        put("Groups/SaveAddress/#{group_id}/#{location_type_id}?#{URI.encode_www_form(url_params)}")
+      end
+
       private
 
       def group_path(id = nil)

data/lib/rock_rms/resources/group_member.rb

@@ -15,10 +15,26 @@ module RockRMS
         )
       end
 
+      def list_group_members(options = {})
+        Response::GroupMember.format(
+          get(group_member_path, options)
+        )
+      end
+
       def delete_group_member(id)
         delete(group_member_path(id))
       end
 
+      def create_known_relationship(person_id:, related_person_id:, relationship_role_id:)
+        url_params = {
+          personId: person_id,
+          relatedPersonId: related_person_id,
+          relationshipRoleId: relationship_role_id
+        }
+
+        post("GroupMembers/KnownRelationship?#{URI.encode_www_form(url_params)}")
+      end
+
       private
 
       def group_member_path(id = nil)

data/lib/rock_rms/resources/transaction.rb

@@ -58,7 +58,8 @@ module RockRMS
         transaction_code: nil,
         transaction_type_value_id: nil,
         authorized_person_id: nil,
-        date: nil
+        date: nil,
+        foreign_currency_code_value_id: nil
       )
         options = {}
 
@@ -71,6 +72,7 @@ module RockRMS
         options['TransactionCode']         = transaction_code          if transaction_code
         options['AuthorizedPersonAliasId'] = authorized_person_id      if authorized_person_id
         options['TransactionDateTime']     = date                      if date
+        options['ForeignCurrencyCodeValueId'] = foreign_currency_code_value_id if foreign_currency_code_value_id
 
         patch(transaction_path(id), options)
       end

data/lib/rock_rms/response/group_member.rb

@@ -0,0 +1,22 @@
+module RockRMS
+  module Response
+    class GroupMember < Base
+      MAP = {
+        person: 'Person',
+        group_id: 'GroupId',
+      }.freeze
+
+      def format_single(data)
+        response                   = to_h(MAP, data)
+        response[:person]          = format_person(response[:person])
+        response
+      end
+
+      def format_person(res)
+        return res if res.nil?
+        Person.format(res)
+      end
+
+    end
+  end
+end

data/lib/rock_rms/response/person.rb

@@ -2,6 +2,7 @@ module RockRMS
   module Response
     class Person < Base
       MAP = {
+        id:         'Id',
         name:       'FullName',
         email:      'Email',
         first_name: 'FirstName',
@@ -10,7 +11,8 @@ module RockRMS
         giving_group_id: 'GivingGroupId',
         alias_id:   'PrimaryAliasId',
         connection_status_value_id: 'ConnectionStatusValueId',
-        record_type_value_id: 'RecordTypeValueId'
+        record_type_value_id: 'RecordTypeValueId',
+        primary_family_id: 'PrimaryFamilyId',
       }.freeze
 
       def format_single(data)

data/lib/rock_rms/transform_hash_keys.rb

@@ -0,0 +1,11 @@
+module TransformHashKeys
+  def self.camelize_keys(hash)
+    hash
+      .filter { |_, v| v }
+      .transform_keys { |k| camelize(k) }
+  end
+
+  def self.camelize(term)
+    term.to_s.gsub(/(?:^|_+)([^_])/) { $1.upcase }.tap { |s| s[0] = s[0].downcase }
+  end
+end

data/lib/rock_rms/version.rb

@@ -1,3 +1,3 @@
 module RockRMS
-  VERSION = '8.4.0'.freeze
+  VERSION = '8.6.0'.freeze
 end

data/spec/rock_rms/client_spec.rb

@@ -9,6 +9,14 @@ RSpec.describe RockRMS::Client do
     }
   end
   let(:attrs_without_logging) { attrs.merge(logger: false) }
+  let(:attrs_without_authentication)  do
+    {
+      url: 'http://some-rock-uri.com',
+      username: nil,
+      password: nil,
+      authorization_token: nil
+    }
+  end
 
   subject(:client) { described_class.new(**attrs_without_logging) }
   let(:noisy_client) { described_class.new(**attrs) }
@@ -19,14 +27,9 @@ RSpec.describe RockRMS::Client do
         .to raise_error(ArgumentError, /url/)
     end
 
-    it 'requries `username` param' do
-      expect { described_class.new }
-        .to raise_error(ArgumentError, /username/)
-    end
-
-    it 'requries `password` param' do
-      expect { described_class.new }
-        .to raise_error(ArgumentError, /password/)
+    it 'requries either `username` and `password` params or `authorization_token` param' do
+      expect { described_class.new(attrs_without_authentication) }
+        .to raise_error(ArgumentError, /username and password or authorization_token/)
     end
 
     context 'url' do

data/spec/rock_rms/resources/group_member_spec.rb

@@ -3,6 +3,18 @@ require 'spec_helper'
 RSpec.describe RockRMS::Client::GroupMember, type: :model do
   include_context 'resource specs'
 
+  describe '#list_group_members' do
+    it 'returns a array' do
+      resource = client.list_group_members
+
+      expect(resource).to be_a(Array)
+      expect(resource.first).to be_a(Hash)
+      expect(resource.first).to include(:group_id)
+      expect(resource.first[:person]).to include(:id)
+      expect(resource.first[:person]).to include(:email)
+    end
+  end
+
   describe '#create_group_member' do
     context 'arguments' do
       it 'require `group_id`' do
@@ -63,4 +75,43 @@ RSpec.describe RockRMS::Client::GroupMember, type: :model do
       client.delete_group_member(123)
     end
   end
+
+  describe '#create_known_relationship' do
+    context 'arguments' do
+      it 'require `person_id`' do
+        expect { client.create_known_relationship }
+          .to raise_error(ArgumentError, /person_id/)
+      end
+
+      it 'require `related_person_id`' do
+        expect { client.create_known_relationship }
+          .to raise_error(ArgumentError, /related_person_id/)
+      end
+
+      it 'require `relationship_role_id`' do
+        expect { client.create_known_relationship }
+          .to raise_error(ArgumentError, /relationship_role_id/)
+      end
+
+    end
+
+    subject(:resource) do
+      client.create_known_relationship(
+        person_id: 123,
+        relationship_role_id: 1,
+        related_person_id: 456,
+      )
+    end
+
+    it 'returns integer' do
+      expect(resource).to be_a(Integer)
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with('GroupMembers/KnownRelationship?personId=123&relatedPersonId=456&relationshipRoleId=1').and_call_original
+      resource
+    end
+  end
+
 end

data/spec/rock_rms/resources/group_spec.rb

@@ -107,4 +107,35 @@ RSpec.describe RockRMS::Client::Group, type: :model do
       client.list_families_for_person(123)
     end
   end
+
+
+  describe '#save_address' do
+    context 'arguments' do
+      it 'require `group_id`' do
+        expect { client.save_group_address }
+          .to raise_error(ArgumentError, /group_id/)
+      end
+
+      it 'require `location_type_id`' do
+        expect { client.save_group_address }
+          .to raise_error(ArgumentError, /location_type_id/)
+      end
+
+      it 'require `address`' do
+        expect { client.save_group_address }
+          .to raise_error(ArgumentError, /address/)
+      end
+
+    end
+
+    subject(:resource) do
+      client.save_group_address(group_id: 1, location_type_id: 1, address: { street1: '123 Main St', postal_code: '12345' })
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:put)
+        .with("Groups/SaveAddress/1/1?street1=123+Main+St&postalCode=12345").and_call_original
+      resource
+    end
+  end
 end

data/spec/support/fixtures/create_known_relationship.json

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

data/spec/support/fixtures/group_members.json

@@ -0,0 +1,186 @@
+[
+  {
+    "Person": {
+      "IsSystem": true,
+      "RecordTypeValueId": 1,
+      "RecordStatusValueId": 3,
+      "RecordStatusLastModifiedDateTime": null,
+      "RecordStatusReasonValueId": null,
+      "ConnectionStatusValueId": 66,
+      "ReviewReasonValueId": null,
+      "IsDeceased": false,
+      "TitleValueId": null,
+      "FirstName": "Alisha",
+      "NickName": "Alisha",
+      "MiddleName": "",
+      "LastName": "Admin",
+      "SuffixValueId": null,
+      "PhotoId": 417,
+      "BirthDay": 11,
+      "BirthMonth": 4,
+      "BirthYear": 2006,
+      "Gender": 0,
+      "MaritalStatusValueId": null,
+      "AnniversaryDate": null,
+      "GraduationYear": null,
+      "GivingId": "P1",
+      "GivingLeaderId": 1,
+      "Email": "admin@organization.com",
+      "IsEmailActive": false,
+      "EmailNote": null,
+      "EmailPreference": 0,
+      "CommunicationPreference": 1,
+      "ReviewReasonNote": null,
+      "InactiveReasonNote": "",
+      "SystemNote": null,
+      "ViewedCount": null,
+      "TopSignalColor": null,
+      "TopSignalIconCssClass": null,
+      "TopSignalId": null,
+      "AgeClassification": 1,
+      "PrimaryFamilyId": 23,
+      "PrimaryCampusId": 1,
+      "IsLockedAsChild": false,
+      "DeceasedDate": null,
+      "ContributionFinancialAccountId": null,
+      "AccountProtectionProfile": 3,
+      "PreferredLanguageValueId": null,
+      "ReminderCount": null,
+      "RaceValueId": null,
+      "EthnicityValueId": null,
+      "DaysUntilBirthday": 0,
+      "GivingGroupId": null,
+      "BirthDate": "2006-04-11T00:00:00",
+      "DaysUntilAnniversary": null,
+      "CreatedDateTime": null,
+      "ModifiedDateTime": "2023-04-11T14:08:24.297",
+      "CreatedByPersonAliasId": null,
+      "ModifiedByPersonAliasId": 10,
+      "Id": 1,
+      "Guid": "ad28da19-4af1-408f-9090-2672f8376f27",
+      "ForeignId": null,
+      "ForeignGuid": null,
+      "ForeignKey": null
+    },
+    "IsSystem": false,
+    "GroupId": 2,
+    "GroupTypeId": 1,
+    "PersonId": 1,
+    "GroupRoleId": 1,
+    "Note": null,
+    "GroupMemberStatus": 1,
+    "GuestCount": null,
+    "DateTimeAdded": null,
+    "IsNotified": false,
+    "GroupOrder": null,
+    "InactiveDateTime": null,
+    "IsArchived": false,
+    "ArchivedDateTime": null,
+    "ArchivedByPersonAliasId": null,
+    "ScheduleTemplateId": null,
+    "ScheduleStartDate": null,
+    "ScheduleReminderEmailOffsetDays": null,
+    "CommunicationPreference": 0,
+    "CreatedDateTime": null,
+    "ModifiedDateTime": null,
+    "CreatedByPersonAliasId": null,
+    "ModifiedByPersonAliasId": null,
+    "Id": 3,
+    "Guid": "6f23caca-6749-4454-85df-5a55251b644c",
+    "ForeignId": null,
+    "ForeignGuid": null,
+    "ForeignKey": null
+  },
+  {
+    "Person": {
+      "IsSystem": true,
+      "RecordTypeValueId": 1,
+      "RecordStatusValueId": 3,
+      "RecordStatusLastModifiedDateTime": null,
+      "RecordStatusReasonValueId": null,
+      "ConnectionStatusValueId": 66,
+      "ReviewReasonValueId": null,
+      "IsDeceased": false,
+      "TitleValueId": null,
+      "FirstName": "Alisha",
+      "NickName": "Alisha",
+      "MiddleName": "",
+      "LastName": "Admin",
+      "SuffixValueId": null,
+      "PhotoId": 417,
+      "BirthDay": 11,
+      "BirthMonth": 4,
+      "BirthYear": 2006,
+      "Gender": 0,
+      "MaritalStatusValueId": null,
+      "AnniversaryDate": null,
+      "GraduationYear": null,
+      "GivingId": "P1",
+      "GivingLeaderId": 1,
+      "Email": "admin@organization.com",
+      "IsEmailActive": false,
+      "EmailNote": null,
+      "EmailPreference": 0,
+      "CommunicationPreference": 1,
+      "ReviewReasonNote": null,
+      "InactiveReasonNote": "",
+      "SystemNote": null,
+      "ViewedCount": null,
+      "TopSignalColor": null,
+      "TopSignalIconCssClass": null,
+      "TopSignalId": null,
+      "AgeClassification": 1,
+      "PrimaryFamilyId": 23,
+      "PrimaryCampusId": 1,
+      "IsLockedAsChild": false,
+      "DeceasedDate": null,
+      "ContributionFinancialAccountId": null,
+      "AccountProtectionProfile": 3,
+      "PreferredLanguageValueId": null,
+      "ReminderCount": null,
+      "RaceValueId": null,
+      "EthnicityValueId": null,
+      "DaysUntilBirthday": 0,
+      "GivingGroupId": null,
+      "BirthDate": "2006-04-11T00:00:00",
+      "DaysUntilAnniversary": null,
+      "CreatedDateTime": null,
+      "ModifiedDateTime": "2023-04-11T14:08:24.297",
+      "CreatedByPersonAliasId": null,
+      "ModifiedByPersonAliasId": 10,
+      "Id": 1,
+      "Guid": "ad28da19-4af1-408f-9090-2672f8376f27",
+      "ForeignId": null,
+      "ForeignGuid": null,
+      "ForeignKey": null
+    },
+    "IsSystem": false,
+    "GroupId": 21,
+    "GroupTypeId": 11,
+    "PersonId": 1,
+    "GroupRoleId": 5,
+    "Note": null,
+    "GroupMemberStatus": 1,
+    "GuestCount": null,
+    "DateTimeAdded": null,
+    "IsNotified": false,
+    "GroupOrder": null,
+    "InactiveDateTime": null,
+    "IsArchived": false,
+    "ArchivedDateTime": null,
+    "ArchivedByPersonAliasId": null,
+    "ScheduleTemplateId": null,
+    "ScheduleStartDate": null,
+    "ScheduleReminderEmailOffsetDays": null,
+    "CommunicationPreference": 0,
+    "CreatedDateTime": null,
+    "ModifiedDateTime": null,
+    "CreatedByPersonAliasId": null,
+    "ModifiedByPersonAliasId": null,
+    "Id": 4,
+    "Guid": "cf41a302-d249-44d5-85b2-aeee05c96c8a",
+    "ForeignId": null,
+    "ForeignGuid": null,
+    "ForeignKey": null
+  }
+]

data/spec/support/rock_mock.rb

@@ -31,6 +31,7 @@ class RockMock < Sinatra::Base
     families:      'Groups/GetFamilies/:id',
     gateways:      'FinancialGateways',
     group:         'Groups/:id',
+    group_members: 'GroupMembers',
     groups:        'Groups',
     payment_details: 'FinancialPaymentDetails',
     people_search: 'People/Search',
@@ -58,6 +59,7 @@ class RockMock < Sinatra::Base
     create_attribute: 'Attributes',
     create_attribute_value: 'AttributeValues',
     create_group_member: 'GroupMembers',
+    create_known_relationship: 'GroupMembers/KnownRelationship',
     create_transaction: 'FinancialTransactions',
     create_payment_detail: 'FinancialPaymentDetails',
     create_phone_number: 'PhoneNumbers',
@@ -74,6 +76,15 @@ class RockMock < Sinatra::Base
     end
   end
 
+  # PUT requests
+  {
+    group_save_address: 'Groups/SaveAddress/:group_id/:location_type_id',
+  }.each do |json, end_point|
+    put "/api/#{end_point}" do
+      json_response 204, "#{json}.json"
+    end
+  end
+
   # PATCH requests
   [
     'FinancialBatches/:id',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rock_rms
 version: !ruby/object:Gem::Version
-  version: 8.4.0
+  version: 8.6.0
 platform: ruby
 authors:
 - Taylor Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -249,6 +249,7 @@ files:
 - lib/rock_rms/response/gateway.rb
 - lib/rock_rms/response/group.rb
 - lib/rock_rms/response/group_location.rb
+- lib/rock_rms/response/group_member.rb
 - lib/rock_rms/response/history.rb
 - lib/rock_rms/response/location.rb
 - lib/rock_rms/response/page.rb
@@ -269,6 +270,7 @@ files:
 - lib/rock_rms/response/workflow_action_type.rb
 - lib/rock_rms/response/workflow_activity_type.rb
 - lib/rock_rms/response/workflow_type.rb
+- lib/rock_rms/transform_hash_keys.rb
 - lib/rock_rms/version.rb
 - rock_rms.gemspec
 - spec/rock_rms/client_spec.rb
@@ -323,6 +325,7 @@ files:
 - spec/support/fixtures/create_attribute_value.json
 - spec/support/fixtures/create_batch.json
 - spec/support/fixtures/create_group_member.json
+- spec/support/fixtures/create_known_relationship.json
 - spec/support/fixtures/create_payment_detail.json
 - spec/support/fixtures/create_phone_number.json
 - spec/support/fixtures/create_recurring_donation.json
@@ -337,6 +340,8 @@ files:
 - spec/support/fixtures/gateways.json
 - spec/support/fixtures/group.json
 - spec/support/fixtures/group_locations.json
+- spec/support/fixtures/group_members.json
+- spec/support/fixtures/group_save_address.json
 - spec/support/fixtures/groups.json
 - spec/support/fixtures/groups_with_campus.json
 - spec/support/fixtures/groups_with_locations.json