selligent 0.1.1

data/lib/selligent/client/status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Selligent
+  class Client
+    # Implements the Status endpoint
+    #
+    # /Status
+    module Status
+      # Get the Selligent status
+      def status
+        get "#{root_url}/Status"
+      end
+    end
+  end
+end

data/lib/selligent/client/stored_procedures.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Selligent
+  class Client
+    # Implements the stored procedures endpoints
+    #
+    # /organizations/:organization/storedprocedures/*
+    module StoredProcedures
+      # Get stored procedures defined in the given organization
+      #
+      # @param options [Hash] Additional options
+      # @option options [String] :filter Filter by type
+      # @option options [String] :search Search by name or description
+      def stored_procedures(options = {})
+        get "#{base_url}/storedprocedures", options
+      end
+
+      # Get details of a stored procedure
+      #
+      # @param name [String] Name of the stored procedure
+      def stored_procedure(name)
+        get "#{base_url}/storedprocedures/#{name}"
+      end
+    end
+  end
+end

data/lib/selligent/client/tasks.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Selligent
+  class Client
+    # Implements the task endpoints
+    #
+    # /organizations/:organization/tasks/*
+    module Tasks
+      # Get a collection of tasks
+      #
+      # @param options [Hash] Additional options
+      # @option options [String] :filter Filter by type
+      # @option options [String] :search Search by name, description or tags
+      # @option options [Integer] :skip Specify index to start form
+      # @option options [Integer] :take Specify number of tasks to take
+      def tasks(options = {})
+        get "#{base_url}/tasks", options
+      end
+
+      # Get task details by name
+      #
+      # @param name [String] The task name
+      def task(name)
+        get "#{base_url}/tasks/#{name}"
+      end
+
+      # Get task-actions by task name
+      #
+      # @param task_name [String] The task name
+      def task_actions(task_name)
+        get "#{base_url}/tasks/#{task_name}/actions"
+      end
+
+      # Disable a task
+      #
+      # @param name [String] The task name
+      def disable_task(name)
+        post "#{base_url}/tasks/#{name}/actions/disable"
+      end
+
+      # Enable a task
+      #
+      # @param name [String] The task name
+      def enable_task(name)
+        post "#{base_url}/tasks/#{name}/actions/enable"
+      end
+
+      # Run a task
+      #
+      # @param name [String] The task name
+      def run_task(name)
+        post "#{base_url}/tasks/#{name}/actions/run"
+      end
+    end
+  end
+end

data/lib/selligent/client/transactional_bulk.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Selligent
+  class Client
+    # Implements the transactional bulk endpoint
+    #
+    # /organizations/:organization/journeys/transcational/bulk/:name/send
+    module TransactionalBulk
+      # Trigger a bulk journey in a transactional way
+      #
+      # @params name [String] The name of the execution that should be sent
+      def send_transactional_bulk(name)
+        post "#{base_url}/journeys/transactional/bulk/#{name}/send"
+      end
+    end
+  end
+end

data/lib/selligent/client/transactionals.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Selligent
+  class Client
+    # Implements the transactional endpoints
+    #
+    # /organizations/:organization/journeys/transactional/*
+    module Transactionals
+      # Returns a list of the transactional journeys defined on the organization.
+      def transactionals
+        get "#{base_url}/journeys/transactional"
+      end
+
+      # Returns information on the transactional journey with the given api name.
+      #
+      # @param api_name [String] The api name
+      def transactional(api_name)
+        get "#{base_url}/journeys/transactional/#{api_name}"
+      end
+
+      # Sends (multiple) transactional messages (email, mobile push, sms)
+      #
+      # The model has the following shape:
+      #
+      # {
+      #   items: [
+      #     recipient: "info@example.com",
+      #     language: "EN',
+      #     data: {},
+      #     dtsdata: [
+      #       {
+      #         data_selection: "DTS1",
+      #         content: [
+      #           {
+      #             id: "AB"
+      #           },
+      #           {
+      #             id: "CD"
+      #           }
+      #         ]
+      #       }
+      #     ]
+      #   ]
+      # }
+      #
+      # @param api_name [String] The name of the execution that should be sent
+      # @param model [Hash] The model containing the data that should be sent
+      # @option model [Array] :items The send requests
+      def send_transactional(api_name, model)
+        post "#{base_url}/journeys/transactional/#{api_name}/send", model
+      end
+
+      # Create and/or update a user profile and then trigger the transactional message
+      # with the given api-name on the given organization.
+      #
+      # The model has the following shape:
+      #
+      # {
+      #   items: [
+      #     {
+      #       recipient: "fff",
+      #       language: "EN",
+      #       profile: [
+      #         {
+      #           scope: "MASTER",
+      #           fields: {
+      #             "Name": "John",
+      #             "LastName": "Smith"
+      #           }
+      #         }
+      #       ],
+      #       data: {},
+      #       dtsdata: [
+      #         {
+      #           data_selection: "DTS1",
+      #           content: [
+      #             {
+      #               id: "AB"
+      #             },
+      #             {
+      #               id: "CD"
+      #             }
+      #           ]
+      #         }
+      #       ]
+      #     }
+      #   ]
+      # }
+      #
+      # @param api_name [String] The name of the execution that should be sent
+      # @param model [Hash] The model containing the data that should be sent
+      # @option model [Array] :items The request bodies
+      def update_profile_and_send_transactional(api_name, model)
+        post "#{base_url}/journeys/transactional/shortcut/#{api_name}/updateProfileAndSend", model
+      end
+
+      # Returns a list of transactional-status-objects for the messages that correspond to
+      # the list of guids that is submitted, for the transactional journeys defined on the
+      # given organization.
+      #
+      # @param ids [Array<String>] The message identifiers
+      def transactionals_status(ids)
+        post "#{base_url}/journeys/transactional/status", ids
+      end
+
+      # Returns a transactional-status-object for the transactional journey with the given
+      # id on the given organization.
+      #
+      # @param id [String] The message id
+      def transactional_status(id)
+        get "#{base_url}/journeys/transactional/status/#{id}"
+      end
+    end
+  end
+end

data/lib/selligent/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Selligent
+  # Configuration options for the Selligent Client.
+  class Configuration
+    attr_accessor :host, :api_key, :api_secret, :organization
+
+    def initialize(options = {})
+      @host = options[:host]
+      @api_key = options[:api_key]
+      @api_secret = options[:api_key]
+      @organization = options[:organization]
+    end
+
+    def inspect
+      inspected = super
+      inspected.gsub! @api_key, '*******' if @api_key
+      inspected.gsub! @api_secret, '*******' if @api_secret
+
+      inspected
+    end
+  end
+end

data/lib/selligent/connection.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module Selligent
+  # Network layer
+  module Connection
+    def get(url, options = {}, &block)
+      connection.get url, options, &block
+    end
+
+    def post(url, options = {}, &block)
+      connection.post url, options, &block
+    end
+
+    def put(url, options = {}, &block)
+      connection.put url, options, &block
+    end
+
+    def delete(url, options = {}, &block)
+      connection.delete url, options, &block
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: config.host) do |conn|
+        conn.request :json
+        conn.request :selligent_auth
+
+        conn.response :json, parser_options: { symbolize_names: true }
+
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/selligent/middlewares/authorization.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+require 'selligent'
+
+module Selligent
+  module Middlewares
+    # Auth is a Faraday middleware
+    class Authorization < ::Faraday::Middleware
+      AUTH_HEADER = 'X-ApiKey'.freeze
+
+      def call(env)
+        env[:request_headers][AUTH_HEADER] = auth_header
+        @app.call(env)
+      end
+
+      def self.setup!
+        Faraday::Request.register_middleware selligent_auth: -> { self }
+      end
+
+      def auth_header
+        "#{Selligent.config.api_key}:#{Selligent.config.api_secret}"
+      end
+    end
+  end
+end

data/lib/selligent/version.rb

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

data/selligent.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selligent/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'selligent'
+  s.version     = Selligent::VERSION
+  s.authors     = ['Werner Hofstra']
+  s.email       = ['w.hofstra@catawiki.nl']
+  s.homepage    = 'https://github.com/catawiki/selligent'
+  s.summary     = 'Selligent Ruby API client'
+  s.description = 'Provides access to the Selligent REST API'
+  s.license     = 'proprietary'
+
+  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_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: selligent
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Werner Hofstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-30 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides access to the Selligent REST API
+email:
+- w.hofstra@catawiki.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- lib/selligent.rb
+- lib/selligent/client.rb
+- lib/selligent/client/content.rb
+- lib/selligent/client/cumulio.rb
+- lib/selligent/client/data.rb
+- lib/selligent/client/journeys.rb
+- lib/selligent/client/lists.rb
+- lib/selligent/client/organizations.rb
+- lib/selligent/client/single_batch.rb
+- lib/selligent/client/status.rb
+- lib/selligent/client/stored_procedures.rb
+- lib/selligent/client/tasks.rb
+- lib/selligent/client/transactional_bulk.rb
+- lib/selligent/client/transactionals.rb
+- lib/selligent/configuration.rb
+- lib/selligent/connection.rb
+- lib/selligent/middlewares/authorization.rb
+- lib/selligent/version.rb
+- selligent.gemspec
+homepage: https://github.com/catawiki/selligent
+licenses:
+- proprietary
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Selligent Ruby API client
+test_files: []