selligent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20173662906a961d5ca1844796ca230884bef6ecfd450ebe21051568047d59ba
+  data.tar.gz: 4fd6002eee2db1e3c4d2a154206de818e77183c2a48cc8f4f1dfe5329c8eb12c
+SHA512:
+  metadata.gz: 1b5559f4c000b7ef7be7cb593c4a4640caff4c3352bf4d220ab03dc1712d8fdf9fd6f0c91485da8a5fed3d121c3bfbb5e2cd1ae1cc06371fb2f3b095b769c833
+  data.tar.gz: 3780bc877fb2401cf8d331fba79fcd8db552528d7728123c7b0230368958eb71ff08a3ed588e9e2af104452b9eeafb4f2d6e03d5e84090303972e552185194eb

data/.circleci/config.yml

@@ -0,0 +1,104 @@
+version: 2.0
+
+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
+
+  ruby2.4:
+    docker:
+      - image: circleci/ruby:2.4
+    steps:
+      - checkout
+      - restore_cache:
+          key: gemfile-2-4-{{ checksum "Gemfile" }}-{{ checksum "selligent.gemspec" }}
+      - run: bundle install -j3 --path vendor/bundle
+      - save_cache:
+          key: gemfile-2-4-{{ 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.5:
+    docker:
+      - image: circleci/ruby:2.5
+    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
+      - 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
+
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - ruby2.2
+      - ruby2.3
+      - ruby2.4
+      - ruby2.5

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+
+Gemfile.lock
+
+log/*.log
+pkg/
+.rspec_status
+
+/doc
+/.yardoc

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 100

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rubocop', '>= 0.49'
+  gem 'yard'
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'rspec_junit_formatter', '~> 0.3'
+  gem 'timecop'
+  gem 'webmock'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Catawiki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,255 @@
+# Selligent Ruby API client
+
+## Configure
+
+```ruby
+Selligent.configure do |c|
+  c.host = 'www.selligent.com'
+  c.api_key = 'key'
+  c.api_secret = 'secret'
+  c.organization = 'catawiki'
+end
+```
+
+## API Documentation
+
+To generate API documentation, use yard:
+
+```ruby
+yard
+```
+
+Documentation can be found in /path/to/selligent/doc/index.html
+
+## Endpoints
+
+### Organization
+
+```ruby
+# Get an overview of all organizations
+Selligent.organizations
+
+# Get details on the current organization
+Selligent.organization
+```
+
+### Content
+
+```ruby
+# Create simple (HTML only) single language email message content
+Selligent.create_email(model, params = {})
+
+# Create mobile push message content
+Selligent.create_push_message(model, params = {})
+
+# Create simple page content
+Selligent.create_page(model, params = {})
+
+# Create SMS content
+Selligent.create_sms(model, params = {})
+```
+
+### Journey
+
+```ruby
+# Get an overview of all journeys
+Selligent.journeys
+```
+
+### Single Batch
+
+```ruby
+# Get all journeys of type Single Batch
+Selligent.single_batches
+
+# Create a Single Batch journey
+Selligent.create_single_batch(model)
+
+# Get information on a Single Batch journey
+Selligent.single_batch(name)
+
+# Cancel launching of a single batch
+Selligent.cancel_single_batch(name)
+
+# Launch a single batch
+Selligent.launch_single_batch(name, request)
+
+# Trigger execution of a single batch journey
+Selligent.trigger_single_batch(name, model)
+
+# Send single batch with email message
+Selligent.send_single_batch_email(model)
+
+# Send single batch mobile push message
+Selligent.send_single_batch_push(model)
+
+# Send single batch sms
+Selligent.send_single_batch_sms(model)
+```
+
+### Transactional
+
+```ruby
+# List all transactional journeys
+Selligent.transactionals
+
+# Returns information on the transactional journey with the given name
+Selligent.transactional(name)
+
+# Sends transactional messages to the journey with the given name. See rdoc for model
+# definition.
+Selligent.send_transactional(name, model)
+
+# Create or update a user profile and trigger a transactional message. See rdoc for model
+# definition.
+Selligent.update_profile_and_send_transactional(api_name, model)
+
+# Get a list of status objects for the given message ids
+Selligent.transactionals_status(ids)
+
+# Get the status of a given message
+Selligent.transactional_status(id)
+```
+
+
+### Transactional Bulk
+
+```ruby
+# Trigger a bulk journey in a transactional way
+Selligent.send_transactional_bulk(name)
+```
+
+### Lists
+
+```ruby
+# Get an overview of all of the lists
+Selligent.lists(options = {})
+
+# Create a new list
+Selligent.create_list(model)
+
+# Delete a list
+Selligent.delete_list(list_name, options = {})
+
+# Get details for the list with the given name
+Selligent.list(list_name)
+
+# Update a list
+Selligent.update_list(list_name, model)
+
+# Get list fields for the given list
+Selligent.fields(list_name)
+
+# Create list fields
+Selligent.create_fields(list_name, model)
+
+# Delete a list field
+Selligent.delete_field(list_name, field_name)
+
+# Update a list field
+Selligent.update_field(list_name, field_name, model)
+
+# Get the number of records for the given list
+Selligent.records_count(list_name)
+
+# Delete a single record by id
+Selligent.delete_record(list_name, record_id)
+
+# Get all relations associated with a list
+Selligent.relations(list_name)
+
+# Create a relation between two lists
+Selligent.create_relation(list_name, model)
+
+# Delete a relation between two lists
+Selligent.delete_relation(list_name, scope)
+
+# Get relation details based on the list name and the relation scope name
+Selligent.relation(list_name, scope)
+
+# Update an existing relation
+Selligent.update_relation(list_name, scope, model)
+
+# Get an overview of the segments defined on the given list
+Selligent.segments(list_name, options = {})
+
+# Get segment details based on list API name and segment API name
+Selligent.segment(list_name, segment_name)
+```
+
+### Data
+
+```ruby
+# Delete data from the list with the given api-name
+Selligent.delete_data(api_name, data, params = {})
+
+# Load data into the list with the given api-name
+Selligent.load_data(api_name, data, params = {})
+
+# Search for data records in a specific table
+Selligent.search_data(api_name, request, params = {})
+
+# Delete data from the segment with the given segment-api-name
+Selligent.delete_data_from_segment(api_name, segment_api_name, data, params = {})
+
+# Load data into the segment using given segment-api-name
+Selligent.load_data_into_segment(api_name, segment_api_name, data, params = {})
+
+# Search for data records within a segment of specific table
+Selligent.search_data_within_segment(api_name, segment_api_name, request, params = {})
+```
+
+### Stored Procedure
+
+```ruby
+# Get list of stored procedures
+Selligent.stored_procedures(options = {})
+
+# Get details of stored procedure by name
+Selligent.stored_procedure(name)
+```
+
+### Task
+
+```ruby
+# Get collection of tasks
+Selligent.tasks(options = {})
+
+# Get task details
+Selligent.task(task_name)
+
+# Get actions of task
+Selligent.task_actions(task_name)
+
+# Disable a task
+Selligent.disable_task(task_name)
+
+# Enable a task
+Selligent.enable_task(task_name)
+
+# Run a task
+Selligent.run_task(task_name)
+```
+
+### Cumulio
+
+```ruby
+# Get datasets
+Selligent.cumulio_datasets
+
+# Run a cumulio query
+Selligent.cumulio_query(model)
+```
+
+### Status
+
+```ruby
+# Get the Selligent status
+Selligent.status
+```
+
+
+## Develop
+
+Please take a look at https://github.com/catawiki/selligent/pull/9 and use it as a
+blueprint for adding other endpoints. Don't forget to update the readme as well.

data/lib/selligent.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'selligent/client'
+
+# Selligent API client
+module Selligent
+  class << self
+    def client
+      @client ||= Selligent::Client.new
+    end
+
+    private
+
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private)
+    end
+
+    def method_missing(method_name, *args, &block)
+      return client.send(method_name, *args, &block) if client.respond_to?(method_name)
+
+      super
+    end
+  end
+end