devcycle-server-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9724ae4c4241898d78424d62ec5153f8ee866315fdba153fe3e744639f8d8ea3
+  data.tar.gz: c3ccb44cd5347633ca37f4683eded5a55a072859a72527d03ee052a35040020e
+SHA512:
+  metadata.gz: 3bf213b6acf6317956242ed995bc23f586f3b9df60ad5b19beed0861de447da408bd5e7e376425016466b52d89ff1e0c4a6042fc63b08b77a72d70b073642ceb
+  data.tar.gz: 342146317ceea77d9a3b67a27298772c674652c757c892e1a3a53a78135884cd83eff060065c10abbe1fc9e35402fe171aa8eb4ecc74388f32d5ebd6eaaa15c8

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,175 @@
+# devcycle-server-sdk
+
+DevCycle - the Ruby gem for the DevCycle Bucketing API
+
+Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build devcycle-server-sdk.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./devcycle-server-sdk-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./devcycle-server-sdk-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'devcycle-server-sdk', '~> 1.0.0'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'devcycle-server-sdk'
+
+# Setup authorization
+DevCycle.configure do |config|
+  # Configure API key authorization
+  config.api_key['bearerAuth'] = 'YOUR API KEY'
+end
+
+api_instance = DevCycle::DVCClient.new
+user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData | 
+
+begin
+  #Get all features for user data
+  result = api_instance.get_features(user_data)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Exception when calling DVCClient->get_features: #{e}"
+end
+
+```
+
+## Usage
+
+### Configure SDK
+```ruby
+# Load the gem
+require 'devcycle-server-sdk'
+
+# Setup authorization
+DevCycle.configure do |config|
+  # Configure API key authorization
+  config.api_key['bearerAuth'] = 'YOUR API KEY'
+end
+
+api_instance = DevCycle::DVCClient.new
+user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData | 
+```
+
+### Get all features
+```ruby
+begin
+  #Get all features for user data
+  result = api_instance.get_features(user_data)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Exception when calling DVCClient->get_features: #{e}"
+end
+```
+
+### Get variable by key
+```ruby
+begin
+  # Get value of given variable by key, using default value if segmentation is not passed or variable does not exit
+  result = api_instance.get_variable_by_key("variable-key", user_data, true)
+  p "Received value for #{result.key}: #{result.value}"
+rescue DevCycle::ApiError => e
+  puts "Exception when calling DVCClient->get_variable_by_key: #{e}"
+end
+```
+
+### Get all variables
+```ruby
+begin
+  #Get all variables for user data
+  result = api_instance.get_variables(user_data)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Exception when calling DVCClient->get_variables: #{e}"
+end
+```
+
+### Send events
+```ruby
+
+event_data = DevCycle::Event.new({
+  type: "my-event",
+  target: "some_event_target",
+  value: 12,
+  meta_data: {
+    myKey: "my-value"
+  }
+})
+
+begin
+  # Post events for given user data
+  result = api_instance.track_event(user_data, event_data)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Exception when calling DVCClient->track_event: #{e}"
+end
+```
+
+### Override Logger
+To provide a custom logger, override the `logger` property of the SDK configuration.
+```ruby
+DevCycle.configure do |config|
+  # Configure API key authorization
+  config.api_key['bearerAuth'] = 'YOUR API KEY'
+
+  # Override the default logger
+  config.logger = MyLogger
+end
+```
+
+### Troubleshooting
+To see a detailed log of the requests being made to the DevCycle API, enable SDK debug logging:
+```ruby
+DevCycle.configure do |config|
+  # Configure API key authorization
+  config.api_key['bearerAuth'] = 'YOUR API KEY'
+
+  # Enable detailed debug logs of requests being sent to the DevCycle API
+  config.debugging = true
+end
+```
+
+
+## Documentation for Models
+
+ - [DevCycle::ErrorResponse](docs/ErrorResponse.md)
+ - [DevCycle::Event](docs/Event.md)
+ - [DevCycle::Feature](docs/Feature.md)
+ - [DevCycle::UserData](docs/UserData.md)
+ - [DevCycle::Variable](docs/Variable.md)
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/devcycle-server-sdk.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#DevCycle Bucketing API
+
+#Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "devcycle-server-sdk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devcycle-server-sdk"
+  s.version     = DevCycle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["DevCycleHQ"]
+  s.email       = ["support@devcycle.com"]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "DevCycle Bucketing API Ruby Gem"
+  s.description = "Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs."
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/DevcycleApi.md

@@ -0,0 +1,289 @@
+# DevCycle::DevcycleApi
+
+All URIs are relative to *https://bucketing-api.devcycle.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_features**](DevcycleApi.md#get_features) | **POST** /v1/features | Get all features by key for user data |
+| [**get_variable_by_key**](DevcycleApi.md#get_variable_by_key) | **POST** /v1/variables/{key} | Get variable by key for user data |
+| [**get_variables**](DevcycleApi.md#get_variables) | **POST** /v1/variables | Get all variables by key for user data |
+| [**post_events**](DevcycleApi.md#post_events) | **POST** /v1/track | Post events to DevCycle for user |
+
+
+## get_features
+
+> <Hash<String, Feature>> get_features(user_data)
+
+Get all features by key for user data
+
+### Examples
+
+```ruby
+require 'time'
+require 'devcycle-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.get_features(user_data)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Error when calling DevcycleApi->get_features: #{e}"
+end
+```
+
+#### Using the get_features_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Hash<String, Feature>>, Integer, Hash)> get_features_with_http_info(user_data)
+
+```ruby
+begin
+  # Get all features by key for user data
+  data, status_code, headers = api_instance.get_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->get_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
+
+
+## get_variable_by_key
+
+> <Variable> get_variable_by_key(key, user_data)
+
+Get variable by key for user data
+
+### Examples
+
+```ruby
+require 'time'
+require 'devcycle-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.get_variable_by_key(key, user_data)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Error when calling DevcycleApi->get_variable_by_key: #{e}"
+end
+```
+
+#### Using the get_variable_by_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Variable>, Integer, Hash)> get_variable_by_key_with_http_info(key, user_data)
+
+```ruby
+begin
+  # Get variable by key for user data
+  data, status_code, headers = api_instance.get_variable_by_key_with_http_info(key, user_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Variable>
+rescue DevCycle::ApiError => e
+  puts "Error when calling DevcycleApi->get_variable_by_key_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
+
+
+## get_variables
+
+> <Hash<String, Variable>> get_variables(user_data)
+
+Get all variables by key for user data
+
+### Examples
+
+```ruby
+require 'time'
+require 'devcycle-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.get_variables(user_data)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Error when calling DevcycleApi->get_variables: #{e}"
+end
+```
+
+#### Using the get_variables_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Hash<String, Variable>>, Integer, Hash)> get_variables_with_http_info(user_data)
+
+```ruby
+begin
+  # Get all variables by key for user data
+  data, status_code, headers = api_instance.get_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->get_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
+
+
+## post_events
+
+> <InlineResponse201> post_events(user_data_and_events_body)
+
+Post events to DevCycle for user
+
+### Examples
+
+```ruby
+require 'time'
+require 'devcycle-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_and_events_body = DevCycle::UserDataAndEventsBody.new # UserDataAndEventsBody | 
+
+begin
+  # Post events to DevCycle for user
+  result = api_instance.post_events(user_data_and_events_body)
+  p result
+rescue DevCycle::ApiError => e
+  puts "Error when calling DevcycleApi->post_events: #{e}"
+end
+```
+
+#### Using the post_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse201>, Integer, Hash)> post_events_with_http_info(user_data_and_events_body)
+
+```ruby
+begin
+  # Post events to DevCycle for user
+  data, status_code, headers = api_instance.post_events_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->post_events_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

@@ -0,0 +1,20 @@
+# 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-server-sdk'
+
+instance = DevCycle::ErrorResponse.new(
+  message: null,
+  data: null
+)
+```
+

data/docs/Event.md

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,48 @@
+# 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-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

@@ -0,0 +1,24 @@
+# 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

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