selligent 0.1.4 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad45d9f6139a62885e82c40fea33f78c288b8a42a652cbfd71924410676072a6
-  data.tar.gz: 2325d061753ff1a97eb91c8ef3f7674b92cfabdd7423c1d8b9ec22f222d877ea
+  metadata.gz: 4617530beb4b985250cf5e72e540c43b3a4c2fa39ebe3d6ffde9e357fc89221d
+  data.tar.gz: 2cde2ba1726810ce0fb9d6b14d1e2d703f2f65056f431036ecd01e8b56af64b7
 SHA512:
-  metadata.gz: 524d8e138358e6d1a884cebebb739915412a78efd38cee0e47163a6dc2f8886ba994e2314a0e3c6d77daf3746a3621ac375cb0941b626d09a6f3c8039ac16e7a
-  data.tar.gz: 25a74dc22bdd7b46daaa9a48112dc1cd762a3f2cf5893fd8eb80c61accfb590293e416ac082b4e0722007ae13a5e3ad20e4b8c04b8cf49d46229d1c525d592cd
+  metadata.gz: 7c77f0f37b5f5f1860ea4be718728e73ffd46f6dfbe05e3ce3af8e813d0c6877a354482c886d548b5590023e235e1e6ea44aee4ce767cb63a145ca66676ba7b3
+  data.tar.gz: e7993edb3aa6af3c55004b4ac88d57aa9d113d3bf1b8ce288bcebe7c02161e23da257bde2f594473c8fafc1dc4573429e3fa83de52acd6f62aad480752c05a7b

data/.circleci/config.yml

@@ -16,6 +16,7 @@ jobs:
       - checkout
       - restore_cache:
           key: gemfile-<< parameters.ruby_version >>-{{ checksum "Gemfile" }}
+      - run: gem install bundler:2.6.7
       - run: bundle install -j3
       - save_cache:
           key: gemfile-<< parameters.ruby_version >>-{{ checksum "Gemfile" }}
@@ -32,8 +33,9 @@ jobs:
       - checkout
       - restore_cache:
           key: gemfile-<< parameters.ruby_version >>-{{ checksum "Gemfile" }}
-      - run: gem install bundler:2.3.26
-      - run: bundle check --path vendor/bundle
+      - run: gem install bundler:2.6.7
+      - run: bundle install -j3
+      - run: bundle check
       - run: bundle exec rubocop
       - run: |
           bundle exec rspec --profile 10 \
@@ -52,11 +54,11 @@ workflows:
           context: org-global
           matrix:
             parameters:
-              ruby_version: ['2.7', '3.0']
+              ruby_version: ['3.2', '3.3', '3.4']
       - ruby:
           context: org-global
           matrix:
             parameters:
-              ruby_version: ['2.7', '3.0']
+              ruby_version: ['3.2', '3.3', '3.4']
           requires:
             - bundle

data/.rubocop.yml

@@ -1,9 +1,9 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100

data/README.md

@@ -131,7 +131,6 @@ Selligent.transactionals_status(ids)
 Selligent.transactional_status(id)
 ```
 
-
 ### Transactional Bulk
 
 ```ruby
@@ -268,6 +267,28 @@ Selligent.cumulio_query(model)
 Selligent.trigger_custom_journey(api_name, entrypoint_name, input)
 ```
 
+### CIM
+
+```ruby
+# Create a CIM collect request
+Selligent.cim_collect(api_name, data)
+
+# Create a CIM optout request
+Selligent.cim_optout(api_name, data)
+
+# Create a CIM remove request
+Selligent.cim_remove(api_name, data)
+
+# Cancel a CIM request
+Selligent.cim_cancel(request_id)
+
+# Get the state of a CIM request
+Selligent.cim_state(request_id)
+
+# Get the result of a CIM collect request
+Selligent.cim_result(request_id)
+```
+
 ### Status
 
 ```ruby

data/lib/selligent/client/cim.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Selligent
+  class Client
+    # Implements the CIM endpoints
+    #
+    # /organizations/:organization/cim/*
+    module CIM
+      # The request body for collect/optout/remove
+      # should have the following structure:
+      #
+      # {
+      #   "filters": [
+      #     {
+      #       "field": "string",
+      #       "value": "string"
+      #     }
+      #   ]
+      # }
+      #
+      # @param api_name [String] The api name
+      # @param filters [Array<Hash>] The filters to apply
+      # @option filters [String] :field The field to filter on
+      # @option filters [String] :value The value to filter by
+      # You can choose up to four fields to identify the subject
+      # for the request.
+
+      # Collects, for the selected lists, all data available
+      # in the Engage environment, including Site and Recommendations.
+      # Once the data has been gathered, it can be downloaded and
+      # made available in a JSON file. The dashboard indicates when
+      # the file is available for download
+      def cim_collect(api_name, data)
+        post("#{base_url}/cim/#{api_name}/collect", data)
+      end
+
+      # Unsubscribes a subject from the selected lists
+      def cim_optout(api_name, data)
+        post("#{base_url}/cim/#{api_name}/optout", data)
+      end
+
+      # Permanently removes the data after 30 days.
+      # No restore of the data is possible.
+      def cim_remove(api_name, data)
+        post("#{base_url}/cim/#{api_name}/remove", data)
+      end
+
+      # Cancel a CIM request
+      def cim_cancel(request_id)
+        delete("#{base_url}/cim/request/#{request_id}")
+      end
+
+      # Get the state of a CIM request
+      def cim_state(request_id)
+        get("#{base_url}/cim/request/#{request_id}/state")
+      end
+
+      # Get the result of a CIM collect request
+      def cim_result(request_id)
+        get("#{base_url}/cim/request/#{request_id}")
+      end
+    end
+  end
+end

data/lib/selligent/client.rb

@@ -5,6 +5,7 @@ require 'selligent/connection'
 require 'selligent/client/content'
 require 'selligent/client/cumulio'
 require 'selligent/client/custom_journey'
+require 'selligent/client/cim'
 require 'selligent/client/data'
 require 'selligent/client/journeys'
 require 'selligent/client/lists'
@@ -26,6 +27,7 @@ module Selligent
     include Selligent::Client::Content
     include Selligent::Client::Cumulio
     include Selligent::Client::CustomJourney
+    include Selligent::Client::CIM
     include Selligent::Client::Data
     include Selligent::Client::Journeys
     include Selligent::Client::Lists

data/lib/selligent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Selligent
-  VERSION = '0.1.4'
+  VERSION = '1.0.2'
 end

data/selligent.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |s|
   s.name        = 'selligent'
   s.version     = Selligent::VERSION
   s.authors     = ['Werner Hofstra']
-  s.email       = ['w.hofstra@catawiki.nl']
+  s.email       = ['opensource@catawiki.nl']
   s.homepage    = 'https://github.com/catawiki/selligent-rb'
   s.summary     = 'Selligent Ruby API client'
   s.description = 'Provides access to the Selligent REST API'
   s.license     = 'MIT'
-  s.required_ruby_version = '>= 2.7'
+  s.required_ruby_version = '>= 3.2'
 
   s.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'bundler', '~> 2.3'
+  s.add_development_dependency 'bundler'
   s.add_dependency 'faraday'
   s.add_dependency 'faraday_middleware'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: selligent
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.2
 platform: ruby
 authors:
 - Werner Hofstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
 description: Provides access to the Selligent REST API
 email:
-- w.hofstra@catawiki.nl
+- opensource@catawiki.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -67,6 +67,7 @@ files:
 - README.md
 - lib/selligent.rb
 - lib/selligent/client.rb
+- lib/selligent/client/cim.rb
 - lib/selligent/client/content.rb
 - lib/selligent/client/cumulio.rb
 - lib/selligent/client/custom_journey.rb
@@ -97,14 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Selligent Ruby API client