selligent 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf89ee98092bf6e2e79ce775aee2b675f0c565cfb062c99d3b55d6f664cc1ad
-  data.tar.gz: fee9a48adbe5efedb493e7f4d1ebfc0f828178b00594aa2245faf08a995dcba8
+  metadata.gz: ad45d9f6139a62885e82c40fea33f78c288b8a42a652cbfd71924410676072a6
+  data.tar.gz: 2325d061753ff1a97eb91c8ef3f7674b92cfabdd7423c1d8b9ec22f222d877ea
 SHA512:
-  metadata.gz: 15c039f38aa2664885c88dcbd36a3fdb8e1ec5b78855e52f350fe8f673c9502324f06a3fda52948ca61c8b7cd3966c41e4f6241168fb1ed2bd18a55f7cca275d
-  data.tar.gz: 51d6814010d48aa7f0977f4132ca837e46a3bc5a491fdb3a39add900c56afeedcc35fe4c08890c1c2c916539c9ccff796a770c5cda88bfee7cb61ea8cc953480
+  metadata.gz: 524d8e138358e6d1a884cebebb739915412a78efd38cee0e47163a6dc2f8886ba994e2314a0e3c6d77daf3746a3621ac375cb0941b626d09a6f3c8039ac16e7a
+  data.tar.gz: 25a74dc22bdd7b46daaa9a48112dc1cd762a3f2cf5893fd8eb80c61accfb590293e416ac082b4e0722007ae13a5e3ad20e4b8c04b8cf49d46229d1c525d592cd

data/.circleci/config.yml

@@ -1,87 +1,38 @@
-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
+docker-auth: &docker-auth
+  auth:
+    username: $DOCKERHUB_USERNAME
+    password: $DOCKERHUB_ACCESS_TOKEN
 
-  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
-
-  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: 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
+          key: gemfile-<< parameters.ruby_version >>-{{ checksum "Gemfile" }}
+      - run: gem install bundler:2.3.26
       - run: bundle check --path vendor/bundle
       - run: bundle exec rubocop
       - run: |
@@ -93,12 +44,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: ['2.7', '3.0']
+      - ruby:
+          context: org-global
+          matrix:
+            parameters:
+              ruby_version: ['2.7', '3.0']
+          requires:
+            - bundle

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/Gemfile

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

data/README.md

@@ -1,5 +1,25 @@
 # Selligent Ruby API client
 
+## Install
+
+Install via Rubygems
+
+```bash
+gem install selligent
+```
+
+... or add to your Gemfile
+
+```ruby
+gem 'selligent', '~> 0.1'
+```
+
+Access the library in Ruby:
+
+```ruby
+require 'selligent'
+```
+
 ## Configure
 
 ```ruby
@@ -241,6 +261,13 @@ 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)
+```
+
 ### Status
 
 ```ruby

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,7 @@ require 'selligent/configuration'
 require 'selligent/connection'
 require 'selligent/client/content'
 require 'selligent/client/cumulio'
+require 'selligent/client/custom_journey'
 require 'selligent/client/data'
 require 'selligent/client/journeys'
 require 'selligent/client/lists'
@@ -24,6 +25,7 @@ module Selligent
     include Selligent::Connection
     include Selligent::Client::Content
     include Selligent::Client::Cumulio
+    include Selligent::Client::CustomJourney
     include Selligent::Client::Data
     include Selligent::Client::Journeys
     include Selligent::Client::Lists

data/lib/selligent/connection.rb

@@ -30,6 +30,7 @@ module Selligent
         conn.request :selligent_auth
 
         conn.response :json, parser_options: { symbolize_names: true }
+        conn.response :raise_error
 
         conn.adapter Faraday.default_adapter
       end

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.2'.freeze
+  VERSION = '0.1.4'
 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'
@@ -11,15 +13,16 @@ Gem::Specification.new do |s|
   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 = '>= 2.7'
 
-  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', '~> 2.3'
   s.add_dependency 'faraday'
   s.add_dependency 'faraday_middleware'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selligent
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Werner Hofstra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-30 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +69,7 @@ files:
 - lib/selligent/client.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 +87,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,16 +97,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Selligent Ruby API client
 test_files: []