strongmind-platform-sdk 3.19.0 → 3.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a116ab2dded0c9438031825118549bba4f66437bba41e21a05f5b10eee34f0f9
-  data.tar.gz: cf95cc4393e3718a60f57a41348f11be5b2a5e7e850ba0476a69e9d0a6a604e3
+  metadata.gz: dd597a3c3a31921754c613bf53ce663646111eb15958eb9e259f9f8110da7b87
+  data.tar.gz: 0ef2bc5c64de9fe8482bc80c5a919b7d7a8a1fe9d9af244052b46cfcdd1a4089
 SHA512:
-  metadata.gz: 6789b299100a35dc404bd7d9628949efe05e12c3eedf1642f3dd22d419e43c7f16555f6ac1ffe245e338b06fbb10a22fbb4a1ef2cdec81efb44fb5272402ad55
-  data.tar.gz: bc04bdfc93c81a2a5c843f70b34d8dc1d7a224771bd31ed17bb3bfed3bf0c9cc60cc85f8f872f6d2e4e1eb2e7dbb11f3b1f217d6982add5599f2a230972ac102
+  metadata.gz: 5f8b7902628784c4e38886f7e54b4e59f76bdc18d617439bb05585fbc3185a3675d4911a8dd989a0829e5e86e76876bbfd835ea5ffb278dfdce2a17dc3692409
+  data.tar.gz: a14a4e3f84780ef8af02fab7358ba258576f4fe13cc424130f6e3941cde6eed4fed30751a7b57190eb0bb6b2ec209479bc18d4907a3048d12b11cca5622d0571

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strongmind-platform-sdk (3.19.0)
+    strongmind-platform-sdk (3.19.2)
       activesupport (~> 7.1)
       aws-sdk-secretsmanager (~> 1.66)
       faraday (~> 2.5, >= 2.5.2)

data/README.md

@@ -11,7 +11,7 @@ First [configure your GitHub credentials](#configure-github-credentials)
 Install the gem and add to the application's Gemfile by executing:
 
 ```
-gem "strongmind-platform-sdk", "~> 3.9.2"
+gem "strongmind-platform-sdk", "~> 3.19.1"
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
@@ -67,9 +67,15 @@ gem push --key github --host https://rubygems.pkg.github.com/StrongMind platform
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Migrate the database for the dummy app:
+```
+cd spec/dummy
+rails db:migrate
+```
+
+Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
@@ -83,10 +89,78 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 Everyone interacting in the Platform::Ruby::Sdk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/platform-ruby-sdk/blob/main/CODE_OF_CONDUCT.md).
 
-## Setting up IRB for OneRoster Calls
+## Data Pipeline Concern
+
+The `DataPipelineable` concern is a shared concern that can be included in models
+automatically to send data to the Data Pipeline on creates, updates, and destroys.
+
+### Installation
+Ensure that `platform-sdk` is required in the application.
+
+One way to do this is to require the SDK via the `Gemfile`:
+
+```ruby
+gem 'strongmind-platform-sdk', require: 'platform_sdk'
+```
+
+This provides the application access to the `DataPipelineable` concern and RSpec shared examples.
+
+### Usage
+
+To use the `DataPipelineable` concern in a model, include the concern in the model:
+
+```ruby
+class MyModel < ApplicationRecord
+  include PlatformSdk::ActiveRecord::DataPipelineable
+end
+```
+
+For the concern to function, the model must have a `pipeline_noun` class method that returns the noun of the model.
+
+This can be done once by defining the method in the ApplicationRecord class:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  def self.pipeline_noun
+    "StrongMind.Central.#{name}}"
+  end
+end
+```
+
+Or it can be defined in each model:
+
+```ruby
+class MyModel < ApplicationRecord
+  include PlatformSdk::ActiveRecord::DataPipelineable
+
+  def self.pipeline_noun
+    "StrongMind.Central.#{name}}"
+  end
+end
+```
+
+### Testing
+
+To test the `DataPipelineable` concern for a model, include the common shared examples in the model's spec file:
+
+```ruby
+RSpec.describe MyModel, type: :model do
+  describe 'sends to the Data Pipeline' do
+    it_behaves_like 'DataPipelineable'
+  end
+end
+```
+
+
+
+## Setting up IRB for API Client Testing
 Require needed dependencies:
 `require 'platform_sdk'`
 
+
+### OneRoster API Client Initialization Example
 Open IRB and initialize dependencies:
 * IDENTITY_CLIENT_ID
 * IDENTITY_CLIENT_SECRET
@@ -102,6 +176,7 @@ Create Identity Auth Client:
 Create OneRoster Client:
 `one_roster_client = PlatformSdk::OneRoster::Client.new(ONEROSTER_BASE_URL, auth_client)`
 
+### Additional Client Initialization Examples
 Create Aws Client:
 `aws_client = PlatformSdk::Aws::SecretsManagerClient.new(access_key_id: 'ACCESS_KEY_ID', secret_access_key: 'SECRET_ACCESS_KEY', region: 'REGION')`
 

data/lib/platform_sdk/identity/clients.rb

@@ -39,6 +39,8 @@ module PlatformSdk
 
       def with_rescue
         yield
+      rescue Faraday::TimeoutError => e
+        raise TimeoutError, e
       rescue Faraday::ServerError => e
         raise_error_with_payload(ServerError, e)
       rescue Faraday::ClientError => e

data/lib/platform_sdk/identity.rb

@@ -13,5 +13,6 @@ module PlatformSdk
     class ResourceNotFound < Faraday::ResourceNotFound; end
     class ServerError < Faraday::ServerError; end
     class ClientError < Faraday::ClientError; end
+    class TimeoutError < Faraday::TimeoutError; end
   end
 end

data/lib/platform_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlatformSdk
-  VERSION = "3.19.0"
+  VERSION = "3.19.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-platform-sdk
 version: !ruby/object:Gem::Version
-  version: 3.19.0
+  version: 3.19.2
 platform: ruby
 authors:
 - Platform Team