flagger 2.0.9 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 880f82d15f0805d0107c12d883025c4c555e01df667aa39ad07b646f68ec94a0
-  data.tar.gz: 061e3aa2d425d15d0a1372f421d404890bc5b099f478c13713fa0d8c36c3a3f5
+  metadata.gz: abec4e3ed555319d9e974c87174352957d54097395fb9435a9fc6ce4c2511ebb
+  data.tar.gz: fb42dad6b7af63308d2a65021c35f7aeb9c94d408b1dab60b8e4d8aca51cb6fe
 SHA512:
-  metadata.gz: 120ccdb7b2af506918fed5f56ac936a230c60ec2a1eb214ad0bdde334cb7a8e581d8d2f06346e1c816fb2d6e43ad97f30ffb4a22ad3333c93a60349ba15b6243
-  data.tar.gz: 0df9032a5087506744c5601c1b454c4af89b9c9124786cb87080c3073921fad9241ea013bc08a9d085db032ebc1772b817485b06c165a35f3204b4ddc3e74a7b
+  metadata.gz: 6b32614e2a9eeaa51e2bbf3fd4a789ce6f3c7f3edb89a78856594a56623552bcf3508d2859798de7274abaf445284158e7e93ad13852fba98f6ff9f0c3b99b19
+  data.tar.gz: 86bdaa5297356ebb695c859feef6370a41aeab8acd66b5fb5ca671640d96d5b0453ef896b118d5b4995afe9baa3ccf986dd0e23dc8d5aa728da862815434ac59

data/lib/flagger.rb

@@ -1,96 +1,82 @@
-require 'flagger/cloud'
-require 'flagger/microservice'
-
-class Flagger
-  class Flag
-    attr_accessor :flag_name
-    attr_accessor :delegate
-
-    def initialize(flag_name, delegate)
-      @flag_name = flag_name
-      @delegate = delegate
-    end
-
-    def treatment(entity)
-      @delegate&.treatment(self, entity) || 'off'
-    end
-
-    def payload(entity)
-      @delegate&.payload(self, entity) || nil
-    end
-
-    def eligible?(entity)
-      @delegate&.eligible?(self, entity) || false
-    end
-
-    def enabled?(entity)
-      @delegate&.enabled?(self, entity) || false
-    end
+require 'ffi'
+require 'flagger/entity'
+require 'flagger/response'
+require 'flagger/native'
+require 'flagger/version'
+
+module Flagger
+  include FlaggerNative, ResponseParser
+
+  # init method gets FlaggerConfiguration, establishes and maintains SSE connections and initializes Ingester
+  # init must be called only once, at the start of your application.
+  # Your program must wait for init to finish before using any other Flagger methods
+  def Flagger.init(api_key, **args)
+    request = {
+        apiKey: api_key,
+        sdkName: "ruby",
+        sdkVersion: Flagger::VERSION,
+        sourceURL: args[:source_url],
+        backupSourceURL: args[:backup_source_url],
+        sseURL: args[:sse_url],
+        ingestionURL: args[:ingestion_url],
+        logLevel: args[:log_level],
+    }.compact.to_json
+    ResponseParser::parse_error(FlaggerNative::Init(request))
   end
 
-  @@instance = Flagger.new
-
-  attr_accessor :env_key
-  attr_accessor :edge_url
-  attr_accessor :request_timeout
-  attr_accessor :delegate
-
-  def self.configure(options)
-    @@instance.configure(options)
-    @@instance
+  # Explicitly notify Airship about an Entity
+  def Flagger.publish(entity)
+    request = "{\"entity\": #{entity.to_json} }"
+    ResponseParser::parse_error(FlaggerNative::Publish(request))
   end
 
-  def configure(options)
-    @env_key = options[:env_key]
-    @edge_url = options[:edge_url]
-    @request_timeout = options[:request_timeout] || 10
-
-    applied_options = {
-      env_key: @env_key,
-      edge_url: @edge_url,
-      request_timeout: @request_timeout
-    }
-    if not @prev_options == applied_options
-      @prev_options = applied_options
-
-      @delegate&.cleanup
-      if @edge_url.nil? then
-        @delegate = FlaggerEnvironments::CloudDelegate.new(@env_key, @request_timeout)
-      else
-        @delegate = FlaggerEnvironments::MicroserviceDelegate.new(@env_key, @edge_url, @request_timeout)
-      end
-    end
+  # Simple event tracking API. Entity is an optional parameter if it was set before.
+  def Flagger.track(name, event_properties, *entity)
+    request = entity.empty? ? "{\"event\":{\"name\":\"#{name}\", \"eventProperties\": #{event_properties.to_json}}"
+                  : "{\"event\":{\"name\":\"#{name}\", \"eventProperties\": #{event_properties.to_json}, \"entity\":#{entity[0].to_json}}}"
+    ResponseParser::parse_error(FlaggerNative::Track(request))
   end
 
-  def self.flag(flag_name)
-    Flag.new(flag_name, @@instance.delegate)
+  # set_entity stores an entity in Flagger, which allows omission of entity in other API methods.
+  #
+  # If you don't provide any entity to Flagger:
+  # - flag functions always resolve with the default variation
+  # - track method doesn't record an event
+  def Flagger.set_entity(entity)
+    ResponseParser::parse_error(FlaggerNative::SetEntity("{\"entity\":#{entity.to_json}}"))
   end
 
-  def self.publish(entities)
-    @@instance.delegate&.publish(entities)
+  # Determines if flag is enabled for entity.
+  def Flagger.is_enabled(codename, *entity)
+    request = entity.empty? ? "{\"codename\": \"#{codename}\"}" : "{\"codename\": \"#{codename}\", \"entity\":#{entity[0].to_json}}"
+    ResponseParser::parse_error FlaggerNative::FlagIsEnabled(request)
   end
-end
 
-class Airship
-  def initialize(options)
-    STDERR.puts 'The Airship class is deprecated.'
-
-    @env_key = options[:env_key]
+  # Determines if entity is within the targeted subpopulations
+  def Flagger.is_sampled(codename, *entity)
+    request = entity.empty? ? "{\"codename\": \"#{codename}\"}" : "{\"codename\": \"#{codename}\", \"entity\":#{entity[0].to_json}}"
+    ResponseParser::parse_error FlaggerNative::FlagIsSampled(request)
   end
 
-  def init()
-    Flagger.configure(env_key: @env_key)
+  # Returns the variation assigned to the entity in a multivariate flag
+  def Flagger.get_variation(codename, *entity)
+    request = entity.empty? ? "{\"codename\": \"#{codename}\"}" : "{\"codename\": \"#{codename}\", \"entity\":#{entity[0].to_json}}"
+    ResponseParser::parse_error FlaggerNative::FlagGetVariation(request)
   end
 
-  def variation(flag, entity)
-    Flagger.flag(flag).treatment(entity)
+  # Returns the payload associated with the treatment assigned to the entity
+  def Flagger.get_payload(codename, *entity)
+    request = entity.empty? ? "{\"codename\": \"#{codename}\"}" : "{\"codename\": \"#{codename}\", \"entity\":#{entity[0].to_json}}"
+    ResponseParser::parse_error FlaggerNative::FlagGetPayload(request)
   end
 
-  def eligible?(flag, entity)
-    Flagger.flag(flag).eligible?(entity)
+  # shutdown ingests data(if any), stop ingester and closes SSE connection. shutdown waits to finish current ingestion
+  # request, but no longer than a timeoutMillis.
+  # returns true if closed by timeout
+  def Flagger.shutdown(timeout)
+    request = "{\"timeout\": #{timeout}}"
+    ResponseParser::parse_error FlaggerNative::Shutdown(request)
   end
 
-  def enabled?(flag, entity)
-    Flagger.flag(flag).enabled?(entity)
-  end
 end
+

data/lib/flagger/entity.rb

@@ -0,0 +1,49 @@
+require 'json'
+
+module Flagger
+
+  class Group
+
+    def initialize(id, **args)
+      @id = id.to_s
+      unless args.empty?
+        @type = args.has_key?(:type) ? args[:type].to_s : nil
+        @name = args.has_key?(:name) ? args[:name].to_s : nil
+        @attributes = args.has_key?(:attributes) ? args[:attributes].to_s : nil
+      end
+
+    end
+
+    def to_json
+      {
+          id: @id,
+          name: @name,
+          attributes: @attributes
+      }.compact.to_json
+    end
+  end
+
+
+  class Entity
+
+    def initialize(id, **args)
+      @id = id.to_s
+      unless args.empty?
+        @type = args.has_key?(:type) ? args[:type].to_s : nil
+        @name = args.has_key?(:name) ? args[:name].to_s : nil
+        @attributes = args.has_key?(:attributes)? args[:attributes] : nil
+        @group = args.has_key?(:group) ? args[:group] : nil
+      end
+    end
+
+    def to_json
+      {
+          id: @id,
+          name: @name,
+          type: @type,
+          attributes: @attributes,
+          group: @group
+      }.compact.to_json
+    end
+  end
+end

data/lib/flagger/native.rb

@@ -0,0 +1,31 @@
+require 'os'
+
+def __load_lib(name)
+  arch = OS.bits === 32 ? '386' : 'amd64'
+  if OS.windows?
+    name = name + '-' + arch + '.dll'
+  elsif OS.mac?
+    name = 'lib' + name + '.dylib'
+  elsif OS.linux?
+    name = 'lib' + name + '-' + arch + '.so'
+  else
+    raise 'unsupported platform'
+  end
+  File.join File.dirname(__FILE__), name
+end
+
+# Module that represents shared lib
+module FlaggerNative
+  extend FFI::Library
+  ffi_lib __load_lib('flagger')
+# foreign function definitions
+  attach_function :Init, [:string], :string
+  attach_function :Publish, [:string], :string
+  attach_function :Track, [:string], :string
+  attach_function :SetEntity, [:string], :string
+  attach_function :FlagIsEnabled, [:string], :string
+  attach_function :FlagIsSampled, [:string], :string
+  attach_function :FlagGetVariation, [:string], :string
+  attach_function :FlagGetPayload, [:string], :string
+  attach_function :Shutdown, [:string], :string
+end

data/lib/flagger/response.rb

@@ -0,0 +1,7 @@
+module ResponseParser
+  def self.parse_error(obj)
+    hash = JSON.parse(obj)
+    raise RuntimeError, hash['error'] if hash['error'] != '' && hash['error'] != nil
+    hash['data']
+  end
+end

data/lib/flagger/version.rb

@@ -1,4 +1,3 @@
-module FlaggerUtils
-  VERSION = '2.0.9'
-end
-
+module Flagger
+  VERSION = '3.0.1'
+end

metadata

@@ -1,117 +1,149 @@
 --- !ruby/object:Gem::Specification
 name: flagger
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 3.0.1
 platform: ruby
 authors:
-- Airship Dev Team
-autorequire: 
+- Airdeploy Dev Team
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
-  name: json
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.1
 - !ruby/object:Gem::Dependency
-  name: eventmachine
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: faye-websocket
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.7
-  type: :runtime
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.7
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: lru_redux
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
+        version: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: dry-validation
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
-description: Ruby SDK
-email: support@airshiphq.com
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: An open source Ruby SDK for feature flagging (feature gating, feature
+  toggles)
+email: engineering@airdeploy.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/flagger.rb
-- lib/flagger/cloud.rb
-- lib/flagger/microservice.rb
-- lib/flagger/models.rb
-- lib/flagger/stat.rb
+- lib/flagger/entity.rb
+- lib/flagger/flagger-386.dll
+- lib/flagger/flagger-amd64.dll
+- lib/flagger/libflagger-386.so
+- lib/flagger/libflagger-amd64.so
+- lib/flagger/libflagger.dylib
+- lib/flagger/native.rb
+- lib/flagger/response.rb
 - lib/flagger/version.rb
-homepage: https://airshiphq.com
+homepage: https://airdeploy.io
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/airshiphq/flagger-ruby
-post_install_message: 
+  documentation_uri: https://docs.airdeploy.io
+  homepage_uri: https://airdeploy.io
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,16 +151,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Flagger Ruby SDK
+summary: An open source Flagger Ruby SDK
 test_files: []