rock_rms 8.5.0 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19e99238273531c1c5f3be2e95cb7d10d3b5c025043a11157e10ae7f01b984a5
-  data.tar.gz: 4d5e4758dac63b7174305d2ed3d576b60e298c30d4f5b07f7a90b5bb2d76841a
+  metadata.gz: e043a1d0535862e33752e94420a46d88c9f4fea44a35dfe89e2107f6d5123f98
+  data.tar.gz: d444592864acd5d433e0d0dae2524148626e794f49981a92ca8f6bab50a5a8cd
 SHA512:
-  metadata.gz: 60ae0f673bad03a9a86eab352448a176b7ad8b48fd63c7d48a4571f7fdd14fda6b402ca06e0de9bd8c97960877b9bafab570f2bcd02b081e6205c81ec84d0b15
-  data.tar.gz: 3cec7a048167ec96a7fa20033a28c768056eca3ec940ec8ef5e491fd1852cba804abbf93004a39bef26ad418e7f18d7321c7befe72bbfe6028b8c16a699dae16
+  metadata.gz: f182e50f62ba496c0b164201731a62261262be9e8b12b54fba9c94c015b83beb704183761524cb1230f6ca9835c985509c3884737dbfef11f61e66e53fb10097
+  data.tar.gz: c239b799deec1dacfd080f93191dfe4afaa7de7a4791a7421c835a314dfe91c89d5b0be54bcd4472f9a92b3301a379d736ce833d89abad2f31affa41f17cbc66

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

@@ -1,14 +1,15 @@
 require 'faraday'
-require 'faraday_middleware'
 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 +47,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 +87,8 @@ module RockRMS
     private
 
     def auth
+      return nil if username.nil? && password.nil?
+
       begin
         auth_request('Auth/Login')
       rescue Faraday::ParsingError => e
@@ -108,6 +116,7 @@ module RockRMS
       }
 
       headers['Cookie'] = cookie if cookie
+      headers['Authorization-Token'] = authorization_token if authorization_token
 
       client_opts = {
         url: url,

data/lib/rock_rms/error.rb

@@ -13,7 +13,7 @@ end
 
 require 'faraday'
 module FaradayMiddleware
-  class RockRMSErrorHandler < Faraday::Response::Middleware
+  class RockRMSErrorHandler < Faraday::Middleware
     ERROR_STATUSES = 400..600
 
     def on_complete(env)

data/lib/rock_rms/parse_oj.rb

@@ -1,11 +1,19 @@
-require 'faraday_middleware/response_middleware'
+require 'oj'
 
 module FaradayMiddleware
-  class ParseOj < ResponseMiddleware
-    dependency 'oj'
+  class ParseOj < Faraday::Middleware
+    def on_complete(env)
+      if empty_body?(env[:body].strip)
+        env[:body] = nil
+      else
+        env[:body] = Oj.load(env[:body], mode: :compat)
+      end
+    end
+
+    private
 
-    define_parser do |body|
-      Oj.load(body, mode: :compat) unless body.strip.empty?
+    def empty_body?(body)
+      body.empty? && body == ''
     end
   end
 end

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/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/person.rb

@@ -11,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.5.0'.freeze
+  VERSION = '8.7.0'.freeze
 end

data/rock_rms.gemspec

@@ -20,8 +20,7 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency     'faraday'
-  s.add_runtime_dependency     'faraday_middleware'
+  s.add_runtime_dependency     'faraday', '> 2.0'
   s.add_runtime_dependency     'faraday-multipart'
   s.add_runtime_dependency     'json'
   s.add_runtime_dependency     'oj'

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_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/rock_mock.rb

@@ -76,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,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rock_rms
 version: !ruby/object:Gem::Version
-  version: 8.5.0
+  version: 8.7.0
 platform: ruby
 authors:
 - Taylor Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
@@ -270,6 +256,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
@@ -340,6 +327,7 @@ files:
 - 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