ff-ruby-server-sdk 0.0.2 → 1.0.0

data/lib/ff/ruby/server/sdk/connector/harness_connector.rb

@@ -0,0 +1,236 @@
+require "jwt"
+
+require_relative "events"
+require_relative "connector"
+
+require_relative "../version"
+
+class HarnessConnector < Connector
+
+  def initialize(api_key, config, on_unauthorized)
+
+    @api_key = api_key
+    @config = config
+    @on_unauthorized = on_unauthorized
+    @user_agent = "RubySDK " + Ff::Ruby::Server::Sdk::VERSION
+
+    @api = OpenapiClient::ClientApi.new(make_api_client)
+    @metrics_api = OpenapiClient::MetricsApi.new(make_metrics_api_client)
+
+    @config.logger.debug "Api: " + @api.to_s
+    @config.logger.debug "Metrics api: " + @metrics_api.to_s
+  end
+
+  def authenticate
+
+    begin
+
+      options = {
+        :'authentication_request' => {
+          :'apiKey' => @api_key
+        }
+      }
+
+      response = @api.authenticate(opts = options)
+      @token = response.auth_token
+
+      @config.logger.info "Token has been obtained"
+      process_token
+      return true
+
+    rescue OpenapiClient::ApiError => e
+
+      log_error(e)
+    end
+
+    false
+  end
+
+  def get_flags
+
+    begin
+
+      return @api.get_feature_config(
+
+        environment_uuid = @environment,
+        opts = get_query_params
+      )
+
+    rescue OpenapiClient::ApiError => e
+
+      log_error(e)
+    end
+  end
+
+  def get_segments
+
+    begin
+
+      return @api.get_all_segments(
+
+        environment_uuid = @environment,
+        opts = get_query_params
+      )
+
+    rescue OpenapiClient::ApiError => e
+
+      log_error(e)
+    end
+  end
+
+  def get_flag(identifier)
+
+    @api.get_feature_config_by_identifier(
+
+      identifier = identifier,
+      environment_uuid = @environment,
+      opts = get_query_params
+    )
+  end
+
+  def get_segment(identifier)
+
+    @api.get_segment_by_identifier(
+
+      identifier = identifier,
+      environment_uuid = @environment,
+      opts = get_query_params
+    )
+  end
+
+  def post_metrics(metrics)
+
+    begin
+
+      options = {
+
+        :'metrics' => metrics,
+        :'query_params' => {
+
+          :'cluster' => @cluster
+        }
+      }
+
+      @metrics_api.post_metrics(
+
+        environment = @environment,
+        opts = options
+      )
+
+      @config.logger.info "Successfully sent analytics data to the server"
+
+    rescue OpenapiClient::ApiError => e
+
+      log_error(e)
+      @config.logger.error "Exception while posting metrics to the event server"
+    end
+  end
+
+  def stream(updater)
+
+    if @event_source != nil
+
+      @event_source.close
+      @event_source = nil
+    end
+
+    url = @config.config_url + "/stream?cluster=" + @cluster.to_s
+
+    headers = {
+
+      "Authorization" => "Bearer " + @token,
+      "API-Key" => @api_key
+    }
+
+    @event_source = Events.new(
+
+      url,
+      headers,
+      updater,
+      @config.logger
+    )
+
+    @event_source
+  end
+
+  def close
+
+    if @event_source != nil
+
+      @event_source.close
+      @event_source = nil
+    end
+  end
+
+  protected
+
+  def make_api_client
+
+    api_client = OpenapiClient::ApiClient.new
+
+    api_client.config = @config
+    api_client.user_agent = @user_agent
+
+    api_client
+  end
+
+  def make_metrics_api_client
+
+    max_timeout = 30 * 60 * 1000
+
+    api_client = OpenapiClient::ApiClient.new
+
+    config = @config.clone
+
+    config.read_timeout = max_timeout
+    config.write_timeout = max_timeout
+    config.connection_timeout = max_timeout
+    config.config_url = config.event_url
+
+    api_client.config = config
+    api_client.user_agent = @user_agent
+
+    api_client
+  end
+
+  def process_token
+
+    headers = {
+
+      "Authorization" => "Bearer " + @token
+    }
+
+    @api.api_client.default_headers = @api.api_client.default_headers.merge(headers)
+    @metrics_api.api_client.default_headers = @metrics_api.api_client.default_headers.merge(headers)
+
+    decoded_token = JWT.decode @token, nil, false
+
+    if decoded_token != nil && !decoded_token.empty?
+
+      @environment = decoded_token[0]["environment"]
+      @cluster = decoded_token[0]["clusterIdentifier"]
+
+      @config.logger.debug "Token has been processed: environment='" + @environment.to_s + "', cluster='" + @cluster.to_s + "'"
+    else
+
+      @config.logger.error "ERROR: Could not obtain the environment and cluster data from the token"
+    end
+  end
+
+  private
+
+  def get_query_params
+
+    {
+      :'query_params' => {
+
+        :'cluster' => @cluster
+      }
+    }
+  end
+
+  def log_error(e)
+
+    @config.logger.error "ERROR - Start\n\n" + e.to_s + "\nERROR - End"
+  end
+end

data/lib/ff/ruby/server/sdk/connector/service.rb

@@ -0,0 +1,19 @@
+require_relative "../common/closeable"
+
+class Service < Closeable
+
+  def initialize
+
+    @tbi = "To be implemented"
+  end
+
+  def start
+
+    raise @tbi
+  end
+
+  def stop
+
+    raise @tbi
+  end
+end

data/lib/ff/ruby/server/sdk/connector/updater.rb

@@ -0,0 +1,32 @@
+class Updater
+
+  def initialize
+
+    @tbi = "To be implemented"
+  end
+
+  def on_connected
+
+    raise @tbi
+  end
+
+  def on_disconnected
+
+    raise @tbi
+  end
+
+  def on_ready
+
+    raise @tbi
+  end
+
+  def on_error
+
+    raise @tbi
+  end
+
+  def update(message)
+
+    raise @tbi
+  end
+end

data/lib/ff/ruby/server/sdk/dto/message.rb

@@ -0,0 +1,13 @@
+class Message
+
+  attr_accessor :event, :domain, :identifier, :version
+
+  def initialize
+    super
+
+    @event = ""
+    @domain = ""
+    @identifier = ""
+    @version = 0
+  end
+end

data/lib/ff/ruby/server/sdk/dto/target.rb

@@ -0,0 +1,24 @@
+class Target
+
+  attr_accessor :name, :identifier, :attributes, :is_private, :private_attributes
+
+  def initialize(
+
+    name,
+    identifier = name,
+    attributes = [],
+    is_private = false
+  )
+
+    @name = name
+    @identifier = identifier
+    @attributes = attributes
+    @is_private = is_private
+    @private_attributes = Set[]
+  end
+
+  def is_valid
+
+    @identifier != nil && !@identifier.strip.empty?
+  end
+end

data/lib/ff/ruby/server/sdk/version.rb

@@ -4,7 +4,8 @@ module Ff
   module Ruby
     module Server
       module Sdk
-        VERSION = "0.0.2"
+
+        VERSION = "1.0.0"
       end
     end
   end

data/lib/ff/ruby/server/sdk.rb

@@ -1,14 +1,50 @@
 # frozen_string_literal: true
 
 require_relative "sdk/version"
-require_relative "sdk/cf_client"
+
+require_relative "sdk/common/cache"
+require_relative "sdk/common/storage"
+require_relative "sdk/common/closeable"
+require_relative "sdk/common/repository"
+require_relative "sdk/common/destroyable"
+
+require_relative "sdk/dto/target"
+require_relative "sdk/dto/message"
+
+require_relative "sdk/api/config"
+require_relative "sdk/api/operators"
+require_relative "sdk/api/cf_client"
+require_relative "sdk/api/evaluation"
+require_relative "sdk/api/inner_client"
+require_relative "sdk/api/auth_service"
+require_relative "sdk/api/metrics_event"
+require_relative "sdk/api/default_cache"
+require_relative "sdk/api/config_builder"
+require_relative "sdk/api/file_map_store"
+require_relative "sdk/api/summary_metrics"
+require_relative "sdk/api/client_callback"
+require_relative "sdk/api/update_processor"
+require_relative "sdk/api/metrics_callback"
+require_relative "sdk/api/metrics_processor"
+require_relative "sdk/api/polling_processor"
+require_relative "sdk/api/storage_repository"
+require_relative "sdk/api/repository_callback"
+require_relative "sdk/api/inner_client_updater"
+require_relative "sdk/api/flag_evaluate_callback"
+require_relative "sdk/api/inner_client_repository_callback"
+require_relative "sdk/api/inner_client_flag_evaluate_callback"
+
+require_relative "sdk/connector/updater"
+require_relative "sdk/connector/service"
+require_relative "sdk/connector/connector"
+require_relative "sdk/connector/events"
+require_relative "sdk/connector/harness_connector"
 
 module Ff
   module Ruby
     module Server
       module Sdk
-        class Error < StandardError; end
-        # Your code goes here...
+
       end
     end
   end

data/openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "5.2.1"
+  }
+}

data/scripts/openapi.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+full_path=$(realpath "$0")
+dir_path=$(dirname "$full_path")
+
+. "$dir_path/sdk_specs.sh"
+
+if which openapi-generator; then
+
+  generated_path="$dir_path/../generated"
+
+  if test -e "$generated_path"; then
+
+    if rm -rf "$generated_path"; then
+
+      echo "'$generated_path' was removed with success 🙂"
+    else
+
+      echo "ERROR: '$$generated_path' was not removed before the generation process 😬"
+      exit 1
+    fi
+  fi
+
+  cd "$dir_path/.." &&
+    openapi-generator generate -i api.yaml -g ruby -o generated &&
+    cd "$generated_path" && gem build openapi_client.gemspec && cd .. &&
+    echo "Please enter your 'sudo' password if asked" &&
+    sudo gem install "$generated_path/openapi_client-1.0.0.gem" &&
+    echo "Generated API has been installed with success 🤟"
+
+else
+
+  echo "ERROR: 'openapi-generator' is not installed 😬"
+  exit 1
+fi

data/scripts/sdk_specs.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 export ff_ruby_sdk="ff-ruby-server-sdk"
-export ff_ruby_sdk_version="0.0.2"
+export ff_ruby_sdk_version="1.0.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ff-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Milos Vasic
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies: []
 description: Harness is a feature management platform that helps teams to build better
   software and to test features quicker.
@@ -19,22 +19,65 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".idea/.gitignore"
+- ".run/build.sh.run.xml"
 - ".run/example.run.xml"
+- ".run/install.sh.run.xml"
+- ".run/openapi.sh.run.xml"
+- ".run/publish.sh.run.xml"
 - ".run/sdk_test.rb.run.xml"
+- ".run/unpublish.sh.run.xml"
 - ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- api.yaml
 - bin/console
 - bin/setup
 - example/example.rb
 - lib/ff/ruby/server/sdk.rb
-- lib/ff/ruby/server/sdk/cf_client.rb
+- lib/ff/ruby/server/sdk/api/auth_service.rb
+- lib/ff/ruby/server/sdk/api/cf_client.rb
+- lib/ff/ruby/server/sdk/api/client_callback.rb
+- lib/ff/ruby/server/sdk/api/config.rb
+- lib/ff/ruby/server/sdk/api/config_builder.rb
+- lib/ff/ruby/server/sdk/api/default_cache.rb
+- lib/ff/ruby/server/sdk/api/evaluation.rb
+- lib/ff/ruby/server/sdk/api/evaluator.rb
+- lib/ff/ruby/server/sdk/api/file_map_store.rb
+- lib/ff/ruby/server/sdk/api/flag_evaluate_callback.rb
+- lib/ff/ruby/server/sdk/api/inner_client.rb
+- lib/ff/ruby/server/sdk/api/inner_client_flag_evaluate_callback.rb
+- lib/ff/ruby/server/sdk/api/inner_client_metrics_callback.rb
+- lib/ff/ruby/server/sdk/api/inner_client_repository_callback.rb
+- lib/ff/ruby/server/sdk/api/inner_client_updater.rb
+- lib/ff/ruby/server/sdk/api/metrics_callback.rb
+- lib/ff/ruby/server/sdk/api/metrics_event.rb
+- lib/ff/ruby/server/sdk/api/metrics_processor.rb
+- lib/ff/ruby/server/sdk/api/operators.rb
+- lib/ff/ruby/server/sdk/api/polling_processor.rb
+- lib/ff/ruby/server/sdk/api/repository_callback.rb
+- lib/ff/ruby/server/sdk/api/storage_repository.rb
+- lib/ff/ruby/server/sdk/api/summary_metrics.rb
+- lib/ff/ruby/server/sdk/api/update_processor.rb
+- lib/ff/ruby/server/sdk/common/cache.rb
+- lib/ff/ruby/server/sdk/common/closeable.rb
+- lib/ff/ruby/server/sdk/common/destroyable.rb
+- lib/ff/ruby/server/sdk/common/repository.rb
+- lib/ff/ruby/server/sdk/common/storage.rb
+- lib/ff/ruby/server/sdk/connector/connector.rb
+- lib/ff/ruby/server/sdk/connector/events.rb
+- lib/ff/ruby/server/sdk/connector/harness_connector.rb
+- lib/ff/ruby/server/sdk/connector/service.rb
+- lib/ff/ruby/server/sdk/connector/updater.rb
+- lib/ff/ruby/server/sdk/dto/message.rb
+- lib/ff/ruby/server/sdk/dto/target.rb
 - lib/ff/ruby/server/sdk/version.rb
+- openapitools.json
 - scripts/build.sh
 - scripts/install.sh
+- scripts/openapi.sh
 - scripts/publish.sh
 - scripts/sdk_specs.sh
 - scripts/unpublish.sh

data/lib/ff/ruby/server/sdk/cf_client.rb

@@ -1,6 +0,0 @@
-class CfClient
-
-  def hello
-    puts "Hello from the client"
-  end
-end