devcycle-server-sdk 1.0.0

data/examples/sinatra/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: ../..
+  specs:
+    devcycle-server-sdk (1.0.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.4)
+    multi_json (1.15.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    sinatra-contrib (2.1.0)
+      multi_json
+      mustermann (~> 1.0)
+      rack-protection (= 2.1.0)
+      sinatra (= 2.1.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
+  x86_64-darwin-19
+
+DEPENDENCIES
+  devcycle-server-sdk!
+  sinatra
+  sinatra-contrib
+  thin
+
+BUNDLED WITH
+   2.2.31

data/examples/sinatra/README.md

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

@@ -0,0 +1,47 @@
+require 'sinatra'
+require "sinatra/reloader" if development?
+require 'devcycle-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
+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.get_variable_by_key("test-feature", user_data, 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_event(user_data, event_data)
+
+    p result
+end

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/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'

data/lib/devcycle-server-sdk/api/devcycle_api.rb

@@ -0,0 +1,347 @@
+=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
+
+require 'cgi'
+
+module DevCycle
+  class DVCClient
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    def validate_model(model)
+      return if model.valid?
+      fail ArgumentError, "Invalid data provided for model #{model.class.name}: #{model.list_invalid_properties()}"
+    end
+
+    # Get all features by key for user data
+    # @param user_data [UserData] 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Feature>]
+    def get_features(user_data, opts = {})
+      if !user_data.is_a?(DevCycle::UserData)
+        fail ArgumentError, "user_data param must be an instance of UserData!"
+      end
+
+      validate_model(user_data)
+
+      data, _status_code, _headers = get_features_with_http_info(user_data, opts)
+      data
+    end
+
+    # Get all features by key for user data
+    # @param user_data [UserData] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Feature>, Integer, Hash)>] Hash<String, Feature> data, response status code and response headers
+    def get_features_with_http_info(user_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DVCClient.get_features ...'
+      end
+      # verify the required parameter 'user_data' is set
+      if @api_client.config.client_side_validation && user_data.nil?
+        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.get_features"
+      end
+      # resource path
+      local_var_path = '/v1/features'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(user_data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Feature>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DVCClient.get_features",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DVCClient#get_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get variable by key for user data
+    # @param key [String] Variable key
+    # @param user_data [UserData] 
+    # @param default Default value for variable if none is retrieved
+    # @param [Hash] opts the optional parameters
+    # @return [Variable]
+    def get_variable_by_key(key, user_data, default, opts = {})
+      if !user_data.is_a?(DevCycle::UserData)
+        fail ArgumentError, "user_data param must be an instance of UserData!"
+      end
+
+      validate_model(user_data)
+
+      data, _status_code, _headers = get_variable_by_key_with_http_info(key, user_data, default, opts)
+      data
+    end
+
+    # Get variable by key for user data
+    # @param key [String] Variable key
+    # @param user_data [UserData] 
+    # @param default Default value for variable if none is retrieved
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Variable, Integer, Hash)>] Variable data, response status code and response headers
+    def get_variable_by_key_with_http_info(key, user_data, default, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DVCClient.get_variable_by_key ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling DVCClient.get_variable_by_key"
+      end
+      # verify the required parameter 'user_data' is set
+      if @api_client.config.client_side_validation && user_data.nil?
+        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.get_variable_by_key"
+      end
+      # resource path
+      local_var_path = '/v1/variables/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(user_data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Variable'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DVCClient.get_variable_by_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      begin 
+        data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: DVCClient#get_variable_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data
+      rescue ApiError => error
+        if error.code != 404
+          @api_client.config.logger.error("Failed to retrieve variable value: #{error.message}")
+        end
+
+        return Variable.new(key: key, value: default)
+      end
+    end
+
+    # Get all variables by key for user data
+    # @param user_data [UserData] 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Variable>]
+    def get_variables(user_data, opts = {})
+      if !user_data.is_a?(DevCycle::UserData)
+        fail ArgumentError, "user_data param must be an instance of UserData!"
+      end
+
+      validate_model(user_data)
+      
+      data, _status_code, _headers = get_variables_with_http_info(user_data, opts)
+      data
+    end
+
+    # Get all variables by key for user data
+    # @param user_data [UserData] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Variable>, Integer, Hash)>] Hash<String, Variable> data, response status code and response headers
+    def get_variables_with_http_info(user_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DVCClient.get_variables ...'
+      end
+      # verify the required parameter 'user_data' is set
+      if @api_client.config.client_side_validation && user_data.nil?
+        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.get_variables"
+      end
+      # resource path
+      local_var_path = '/v1/variables'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(user_data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Variable>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DVCClient.get_variables",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DVCClient#get_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Post events to DevCycle for user
+    # @param user_data_and_events_body [UserDataAndEventsBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse201]
+    def track_event(user_data, event_data, opts = {})
+      if !user_data.is_a?(DevCycle::UserData)
+        fail ArgumentError, "user_data param must be an instance of UserData!"
+      end
+
+      validate_model(user_data)
+
+      if !event_data.is_a?(DevCycle::Event)
+        fail ArgumentError, "event_data param must be an instance of Event!"
+      end
+
+      validate_model(event_data)
+
+      data, _status_code, _headers = track_event_with_http_info(user_data, event_data, opts)
+      data
+    end
+
+    # Post events to DevCycle for user
+    # @param user_data_and_events_body [UserDataAndEventsBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse201, Integer, Hash)>] InlineResponse201 data, response status code and response headers
+    def track_event_with_http_info(user_data, event_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DVCClient.post_events ...'
+      end
+      # verify the required parameter 'user_data_and_events_body' is set
+      if @api_client.config.client_side_validation && (user_data.nil? || event_data.nil?)
+        fail ArgumentError, "Missing the required parameter 'user_data_and_events_body' when calling DVCClient.post_events"
+      end
+
+      user_data_and_events_body = DevCycle::UserDataAndEventsBody.new({
+        user: user_data,
+        events: [event_data]
+      })
+
+      # resource path
+      local_var_path = '/v1/track'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(user_data_and_events_body)
+
+      # if post_body.user.respond_to?(:to_hash)
+      #   post_body.user = post_body.user.to_hash()
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse201'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DVCClient.post_events",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DVCClient#post_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end