selligent 0.1.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6faef8370041f9b1f8c5da19505e395fdcd8d8a6a3d1e4558bfd933651e220
-  data.tar.gz: 8e449eeb011415cc0f00166148e8509a3e10f671b6235b140b057fb595bba931
+  metadata.gz: 4617530beb4b985250cf5e72e540c43b3a4c2fa39ebe3d6ffde9e357fc89221d
+  data.tar.gz: 2cde2ba1726810ce0fb9d6b14d1e2d703f2f65056f431036ecd01e8b56af64b7
 SHA512:
-  metadata.gz: eccae6c1af4879c29655efcc115370f1bfcbb96feec983ef7a92021a256767e0995b19f7d6e5add573d9add8d8ea5e8735f19520f47f17ddc14b7dc9d8c5dd0d
-  data.tar.gz: abea162c004234d8cbaf7117f0c674d12ada5f9a5702b8abbf30a93d3b01e5cbc069ef2002a4d83fdac62579428c2b8f323c8271224abe0c50ab07d2996cd56e
+  metadata.gz: 7c77f0f37b5f5f1860ea4be718728e73ffd46f6dfbe05e3ce3af8e813d0c6877a354482c886d548b5590023e235e1e6ea44aee4ce767cb63a145ca66676ba7b3
+  data.tar.gz: e7993edb3aa6af3c55004b4ac88d57aa9d113d3bf1b8ce288bcebe7c02161e23da257bde2f594473c8fafc1dc4573429e3fa83de52acd6f62aad480752c05a7b

data/.circleci/config.yml

@@ -1,88 +1,41 @@
-version: 2.0
+version: 2.1
 
-jobs:
-  ruby2.2:
-    docker:
-      - image: circleci/ruby:2.2
-    steps:
-      - checkout
-      - restore_cache:
-          key: gemfile-2-2-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
-      - run: bundle install -j3 --path vendor/bundle
-      - save_cache:
-          key: gemfile-2-2-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
-          paths:
-            - vendor/bundle
-      - run: bundle check --path vendor/bundle
-      - run: bundle exec rubocop
-      - run: |
-          bundle exec rspec --profile 10 \
-                            --format RspecJunitFormatter \
-                            --out tmp/results/rspec.xml \
-                            --format progress \
-                            $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
-      - store_test_results:
-          path: tmp/results
-
-  ruby2.3:
-    docker:
-      - image: circleci/ruby:2.3
-    steps:
-      - checkout
-      - restore_cache:
-          key: gemfile-2-3-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
-      - run: bundle install -j3 --path vendor/bundle
-      - save_cache:
-          key: gemfile-2-3-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
-          paths:
-            - vendor/bundle
-      - run: bundle check --path vendor/bundle
-      - run: bundle exec rubocop
-      - run: |
-          bundle exec rspec --profile 10 \
-                            --format RspecJunitFormatter \
-                            --out tmp/results/rspec.xml \
-                            --format progress \
-                            $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
-      - store_test_results:
-          path: tmp/results
+docker-auth: &docker-auth
+  auth:
+    username: $DOCKERHUB_USERNAME
+    password: $DOCKERHUB_ACCESS_TOKEN
 
-  ruby2.4:
+jobs:
+  bundle:
+    parameters:
+      ruby_version: { type: string }
     docker:
-      - image: circleci/ruby:2.4
+      - image: cimg/ruby:<< parameters.ruby_version >>
+        <<: *docker-auth
     steps:
       - checkout
       - restore_cache:
-          key: gemfile-2-4-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
-      - run: bundle install -j3 --path vendor/bundle
+          key: gemfile-<< parameters.ruby_version >>-{{ checksum "Gemfile" }}
+      - run: gem install bundler:2.6.7
+      - run: bundle install -j3
       - save_cache:
-          key: gemfile-2-4-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
+          key: gemfile-<< parameters.ruby_version >>-{{ checksum "Gemfile" }}
           paths:
             - vendor/bundle
-      - run: bundle check --path vendor/bundle
-      - run: bundle exec rubocop
-      - run: |
-          bundle exec rspec --profile 10 \
-                            --format RspecJunitFormatter \
-                            --out tmp/results/rspec.xml \
-                            --format progress \
-                            $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
-      - store_test_results:
-          path: tmp/results
 
-  ruby2.5:
+  ruby:
+    parameters:
+      ruby_version: { type: string }
     docker:
-      - image: circleci/ruby:2.5
+      - image: cimg/ruby:<< parameters.ruby_version >>
+        <<: *docker-auth
     steps:
       - checkout
       - restore_cache:
-          key: gemfile-2-5-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
-      - run: bundle install -j3 --path vendor/bundle
-      - save_cache:
-          key: gemfile-2-5-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
-          paths:
-            - vendor/bundle
-      - run: bundle check --path vendor/bundle
+          key: gemfile-<< parameters.ruby_version >>-{{ checksum "Gemfile" }}
+      - run: gem install bundler:2.6.7
+      - run: bundle install -j3
+      - run: bundle check
       - run: bundle exec rubocop
       - run: |
           bundle exec rspec --profile 10 \
@@ -93,12 +46,19 @@ jobs:
       - store_test_results:
           path: tmp/results
 
-
 workflows:
   version: 2
   build:
     jobs:
-      - ruby2.2
-      - ruby2.3
-      - ruby2.4
-      - ruby2.5
+      - bundle:
+          context: org-global
+          matrix:
+            parameters:
+              ruby_version: ['3.2', '3.3', '3.4']
+      - ruby:
+          context: org-global
+          matrix:
+            parameters:
+              ruby_version: ['3.2', '3.3', '3.4']
+          requires:
+            - bundle

data/.rubocop.yml

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

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 group :development do

data/README.md

@@ -131,7 +131,6 @@ Selligent.transactionals_status(ids)
 Selligent.transactional_status(id)
 ```
 
-
 ### Transactional Bulk
 
 ```ruby
@@ -261,6 +260,35 @@ Selligent.cumulio_datasets
 Selligent.cumulio_query(model)
 ```
 
+### Custom journey
+
+```ruby
+# Trigger custom journey. Reffer to the docs from CRM team for input.
+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/custom_journey.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Selligent
+  class Client
+    # Implements the custom journeys endpoints
+    #
+    # /organizations/:organization/journeys/custom/:api_name/entrypoints/:entrypoint_name/trigger
+    module CustomJourney
+      # Trigger execution of a custom journey
+      #
+      # The input has the following shape:
+      # Please note that parameter_values will differ per journey
+      #
+      # {
+      #   "user_id": 0,
+      #   "parameter_values": {
+      #      "catawiki_id": Interger,
+      #      "bid_timestamp": String
+      #   }
+      # }
+      #
+      # @param user_id [Integer] Internal Selligent user ID. Sent as 0 by default.
+      # @param parameter_values [Hash] The input data in the format provided by the CRM team.
+      def trigger_custom_journey(api_name, entrypoint_name, input)
+        post "#{base_url}/journeys/custom/#{api_name}/entrypoints/#{entrypoint_name}/trigger", input
+      end
+    end
+  end
+end

data/lib/selligent/client.rb

@@ -4,6 +4,8 @@ require 'selligent/configuration'
 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'
@@ -24,6 +26,8 @@ module Selligent
     include Selligent::Connection
     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/middlewares/authorization.rb

@@ -8,7 +8,7 @@ module Selligent
   module Middlewares
     # Auth is a Faraday middleware
     class Authorization < ::Faraday::Middleware
-      AUTH_HEADER = 'X-ApiKey'.freeze
+      AUTH_HEADER = 'X-ApiKey'
 
       def call(env)
         env[:request_headers][AUTH_HEADER] = auth_header

data/lib/selligent/version.rb

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

data/selligent.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'selligent/version'
@@ -7,19 +9,20 @@ 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     = 'proprietary'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 3.2'
 
-  s.files       = `git ls-files -z`.split("\x0").reject do |f|
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'bundler', '~> 1.16'
+  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.3
+  version: 1.0.2
 platform: ruby
 authors:
 - Werner Hofstra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-13 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: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        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,8 +67,10 @@ 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
 - lib/selligent/client/data.rb
 - lib/selligent/client/journeys.rb
 - lib/selligent/client/lists.rb
@@ -86,9 +88,9 @@ files:
 - selligent.gemspec
 homepage: https://github.com/catawiki/selligent-rb
 licenses:
-- proprietary
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,15 +98,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Selligent Ruby API client
 test_files: []