devcycle-ruby-server-sdk 1.2.0 → 2.0.1

data/docs/DevcycleApi.md

@@ -1,290 +0,0 @@
-# DevCycle::DevcycleApi
-
-All URIs are relative to *https://bucketing-api.devcycle.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**all_features**](DevcycleApi.md#all_features) | **POST** /v1/features | Get all features by key for user data |
-| [**variable**](DevcycleApi.md#variable) | **POST** /v1/variables/{key} | Get variable by key for user data |
-| [**all_variables**](DevcycleApi.md#all_variables) | **POST** /v1/variables | Get all variables by key for user data |
-| [**track**](DevcycleApi.md#track) | **POST** /v1/track | Post events to DevCycle for user |
-
-
-## all_features
-
-> <Hash<String, Feature>> all_features(user_data)
-
-Get all features by key for user data
-
-### Examples
-
-```ruby
-require 'time'
-require 'devcycle-ruby-server-sdk'
-# setup authorization
-DevCycle.configure do |config|
-  # Configure API key authorization: bearerAuth
-  config.api_key['bearerAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['bearerAuth'] = 'Bearer'
-end
-
-api_instance = DevCycle::DevcycleApi.new
-user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData | 
-
-begin
-  # Get all features by key for user data
-  result = api_instance.all_features(user_data)
-  p result
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->all_features: #{e}"
-end
-```
-
-#### Using the all_features_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Hash<String, Feature>>, Integer, Hash)> all_features_with_http_info(user_data)
-
-```ruby
-begin
-  # Get all features by key for user data
-  data, status_code, headers = api_instance.all_features_with_http_info(user_data)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Hash<String, Feature>>
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->all_features_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_data** | [**UserData**](UserData.md) |  |  |
-
-### Return type
-
-[**Hash&lt;String, Feature&gt;**](Feature.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## variable
-
-> <Variable> variable(user_data, key)
-
-Get variable by key for user data
-
-### Examples
-
-```ruby
-require 'time'
-require 'devcycle-ruby-server-sdk'
-# setup authorization
-DevCycle.configure do |config|
-  # Configure API key authorization: bearerAuth
-  config.api_key['bearerAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['bearerAuth'] = 'Bearer'
-end
-
-api_instance = DevCycle::DevcycleApi.new
-key = 'key_example' # String | Variable key
-user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData | 
-
-begin
-  # Get variable by key for user data
-  result = api_instance.variable(user_data, key)
-  p result
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->variable: #{e}"
-end
-```
-
-#### Using the variable_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Variable>, Integer, Hash)> variable_with_http_info(key, user_data)
-
-```ruby
-begin
-  # Get variable by key for user data
-  data, status_code, headers = api_instance.variable_with_http_info(key, user_data)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Variable>
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->variable_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | Variable key |  |
-| **user_data** | [**UserData**](UserData.md) |  |  |
-
-### Return type
-
-[**Variable**](Variable.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## all_variables
-
-> <Hash<String, Variable>> all_variables(user_data)
-
-Get all variables by key for user data
-
-### Examples
-
-```ruby
-require 'time'
-require 'devcycle-ruby-server-sdk'
-# setup authorization
-DevCycle.configure do |config|
-  # Configure API key authorization: bearerAuth
-  config.api_key['bearerAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['bearerAuth'] = 'Bearer'
-end
-
-api_instance = DevCycle::DevcycleApi.new
-user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData | 
-
-begin
-  # Get all variables by key for user data
-  result = api_instance.all_variables(user_data)
-  p result
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->all_variables: #{e}"
-end
-```
-
-#### Using the all_variables_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Hash<String, Variable>>, Integer, Hash)> all_variables_with_http_info(user_data)
-
-```ruby
-begin
-  # Get all variables by key for user data
-  data, status_code, headers = api_instance.all_variables_with_http_info(user_data)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Hash<String, Variable>>
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->all_variables_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_data** | [**UserData**](UserData.md) |  |  |
-
-### Return type
-
-[**Hash&lt;String, Variable&gt;**](Variable.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## track
-
-> <InlineResponse201> track(user_data, event_data)
-
-Post events to DevCycle for user
-
-### Examples
-
-```ruby
-require 'time'
-require 'devcycle-ruby-server-sdk'
-# setup authorization
-DevCycle.configure do |config|
-  # Configure API key authorization: bearerAuth
-  config.api_key['bearerAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['bearerAuth'] = 'Bearer'
-end
-
-api_instance = DevCycle::DevcycleApi.new
-user_data = DevCycle::UserData.new # UserData | 
-event_data = DevCycle::Event.new # Event | 
-
-begin
-  # Post events to DevCycle for user
-  result = api_instance.track(user_data, event_data)
-  p result
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->track: #{e}"
-end
-```
-
-#### Using the track_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<InlineResponse201>, Integer, Hash)> track_with_http_info(user_data_and_events_body)
-
-```ruby
-begin
-  # Post events to DevCycle for user
-  data, status_code, headers = api_instance.track_with_http_info(user_data_and_events_body)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <InlineResponse201>
-rescue DevCycle::ApiError => e
-  puts "Error when calling DevcycleApi->track_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_data_and_events_body** | [**UserDataAndEventsBody**](UserDataAndEventsBody.md) |  |  |
-
-### Return type
-
-[**InlineResponse201**](InlineResponse201.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/ErrorResponse.md

@@ -1,20 +0,0 @@
-# DevCycle::ErrorResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Error message |  |
-| **data** | **Object** | Additional error information detailing the error reasoning | [optional] |
-
-## Example
-
-```ruby
-require 'devcycle-ruby-server-sdk'
-
-instance = DevCycle::ErrorResponse.new(
-  message: null,
-  data: null
-)
-```
-

data/docs/Event.md

@@ -1,26 +0,0 @@
-# DevCycle::Event
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | Custom event type |  |
-| **target** | **String** | Custom event target / subject of event. Contextual to event type | [optional] |
-| **date** | **Float** | Unix epoch time the event occurred according to client | [optional] |
-| **value** | **Float** | Value for numerical events. Contextual to event type | [optional] |
-| **meta_data** | **Object** | Extra JSON metadata for event. Contextual to event type | [optional] |
-
-## Example
-
-```ruby
-require 'devcycle-server-sdk'
-
-instance = DevCycle::Event.new(
-  type: null,
-  target: null,
-  date: null,
-  value: null,
-  meta_data: null
-)
-```
-

data/docs/Feature.md

@@ -1,26 +0,0 @@
-# DevCycle::Feature
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **_id** | **String** | unique database id |  |
-| **key** | **String** | Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id. |  |
-| **type** | **String** | Feature type |  |
-| **_variation** | **String** | Bucketed feature variation |  |
-| **eval_reason** | **String** | Evaluation reasoning | [optional] |
-
-## Example
-
-```ruby
-require 'devcycle-server-sdk'
-
-instance = DevCycle::Feature.new(
-  _id: null,
-  key: null,
-  type: null,
-  _variation: null,
-  eval_reason: null
-)
-```
-

data/docs/UserData.md

@@ -1,48 +0,0 @@
-# DevCycle::UserData
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** | Unique id to identify the user |  |
-| **email** | **String** | User's email used to identify the user on the dashboard / target audiences | [optional] |
-| **name** | **String** | User's name used to identify the user on the dashboard / target audiences | [optional] |
-| **language** | **String** | User's language in ISO 639-1 format | [optional] |
-| **country** | **String** | User's country in ISO 3166 alpha-2 format | [optional] |
-| **app_version** | **String** | App Version of the running application | [optional] |
-| **app_build** | **String** | App Build number of the running application | [optional] |
-| **custom_data** | **Object** | User's custom data to target the user with, data will be logged to DevCycle for use in dashboard. | [optional] |
-| **private_custom_data** | **Object** | User's custom data to target the user with, data will not be logged to DevCycle only used for feature bucketing. | [optional] |
-| **created_date** | **Float** | Date the user was created, Unix epoch timestamp format | [optional] |
-| **last_seen_date** | **Float** | Date the user was created, Unix epoch timestamp format | [optional] |
-| **platform** | **String** | Platform the Client SDK is running on | [optional] |
-| **platform_version** | **String** | Version of the platform the Client SDK is running on | [optional] |
-| **device_model** | **String** | User's device model | [optional] |
-| **sdk_type** | **String** | DevCycle SDK type | [optional] |
-| **sdk_version** | **String** | DevCycle SDK Version | [optional] |
-
-## Example
-
-```ruby
-require 'devcycle-ruby-server-sdk'
-
-instance = DevCycle::UserData.new(
-  user_id: null,
-  email: null,
-  name: null,
-  language: null,
-  country: null,
-  app_version: null,
-  app_build: null,
-  custom_data: null,
-  private_custom_data: null,
-  created_date: null,
-  last_seen_date: null,
-  platform: null,
-  platform_version: null,
-  device_model: null,
-  sdk_type: null,
-  sdk_version: null
-)
-```
-

data/docs/Variable.md

@@ -1,24 +0,0 @@
-# DevCycle::Variable
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **_id** | **String** | unique database id |  |
-| **key** | **String** | Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id. |  |
-| **type** | **String** | Variable type |  |
-| **value** | **Object** | Variable value can be a string, number, boolean, or JSON |  |
-
-## Example
-
-```ruby
-require 'devcycle-server-sdk'
-
-instance = DevCycle::Variable.new(
-  _id: null,
-  key: null,
-  type: null,
-  value: null
-)
-```
-

data/examples/sinatra/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'sinatra'
-gem 'sinatra-contrib'
-gem 'thin'
-# gem 'devcycle-server-sdk'
-gem 'devcycle-ruby-server-sdk', path: "../../"
-

data/examples/sinatra/Gemfile.lock

@@ -1,51 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    devcycle-ruby-server-sdk (1.2.0)
-      typhoeus (~> 1.0, >= 1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    daemons (1.4.1)
-    ethon (0.15.0)
-      ffi (>= 1.15.0)
-    eventmachine (1.2.7)
-    ffi (1.15.5)
-    multi_json (1.15.0)
-    mustermann (1.1.1)
-      ruby2_keywords (~> 0.0.1)
-    rack (2.2.3)
-    rack-protection (2.2.0)
-      rack
-    ruby2_keywords (0.0.5)
-    sinatra (2.2.0)
-      mustermann (~> 1.0)
-      rack (~> 2.2)
-      rack-protection (= 2.2.0)
-      tilt (~> 2.0)
-    sinatra-contrib (2.2.0)
-      multi_json
-      mustermann (~> 1.0)
-      rack-protection (= 2.2.0)
-      sinatra (= 2.2.0)
-      tilt (~> 2.0)
-    thin (1.8.1)
-      daemons (~> 1.0, >= 1.0.9)
-      eventmachine (~> 1.0, >= 1.0.4)
-      rack (>= 1, < 3)
-    tilt (2.0.10)
-    typhoeus (1.4.0)
-      ethon (>= 0.9.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  devcycle-ruby-server-sdk!
-  sinatra
-  sinatra-contrib
-  thin
-
-BUNDLED WITH
-   1.17.3

data/examples/sinatra/README.md

@@ -1,14 +0,0 @@
-# DevCycle Ruby SDK Example App
-
-This is a test application demonstrating the use of the DevCycle Ruby SDK. It uses Sinatra as
-a web framework to define several routes which can be called to trigger SDK functionality.
-
-## Installation
-Install the dependencies using bundler:
-`bundle install`
-
-## Run
-Run the application using bundler:
-`bundle exec ruby app.rb <YOUR SDK TOKEN>`
-
-A valid DevCycle SDK token must be provided.

data/examples/sinatra/app.rb

@@ -1,48 +0,0 @@
-require 'sinatra'
-require "sinatra/reloader" if development?
-require 'devcycle-ruby-server-sdk'
-
-token = ARGV[0]
-
-if !token
-    fail Exception, 'Must provide server SDK token'
-end
-
-DevCycle.configure do |config|
-    # Configure API key authorization: bearerAuth
-    config.api_key['bearerAuth'] = token
-    # config.debugging = true
-    config.enable_edge_db = false
-end
-
-api_instance = DevCycle::DVCClient.new
-user_data = DevCycle::UserData.new({
-    user_id: 'my-user',
-    app_version: '1.2.3'
-})
-
-get '/' do
-  'Hello world!'
-end
-
-get '/experiment' do
-    result = api_instance.variable(user_data, "test-feature", false)
-    p result
-
-    "Your variable result is: #{result.value}"
-end
-
-get '/track-event' do
-    event_data = DevCycle::Event.new({
-        type: "my-event",
-        target: "some_event_target",
-        value: 12,
-        meta_data: {
-            myKey: "my-value"
-        }
-    })
-
-    result = api_instance.track(user_data, event_data)
-
-    p result
-end

data/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'