launchdarkly_api_helper 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d2501cb34864b4ae9586a01455dfe28ceb011a7ea1b146d595449e16a1b05ec
-  data.tar.gz: 37ec6115e79b2804cb698cbae919b5ddd533a25e55646abab55c574099d173d1
+  metadata.gz: ce783cd020dfb08afa37d2c2def2a34e637ac5206372cde1e33692fce4fc7e9c
+  data.tar.gz: 001f9d326e6361449587ac36107296af04e02cacc1d238c903a7622cb9af718f
 SHA512:
-  metadata.gz: 276d0aaaf2df1e706a25e2e163c21cd215d0d238cbc8f9ac811d2f98434d6da65fa87194404a5ca0c3de1c9255bc93fcf0832958004e432eb68fd63a0530a3f6
-  data.tar.gz: 0a05bccf8b2573faf986fd3c53fae9aff85f2b156c7f8ca2edcc7d7f810560207d526cf517fe6d10f5ef137dee9cf946aea8f9b1bb3e1e6fc4fdc483a3b5c846
+  metadata.gz: 97992fe3501448666a630a59f779e35228fe75afa9e2b57d55396d56e2a8917caac50f232041bb5c59e6d9f356093628c4730db192dca2225bbd384323f57e0f
+  data.tar.gz: ebb0edb818fb938053a390ee8680d6fe6e309a6433c634ad2cd0e9de93220577584db74aa5157ea643b6f0a19f8ba70591e780493cce4fb0e6d776546cd7b628

data/.rubocop.yml

@@ -9,12 +9,21 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
   Max: 100
 
+Metrics/MethodName:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 150
+
 Metrics/AbcSize:
   Enabled: false
 

data/lib/launchdarkly_api_helper/launchdarkly_api_helper_class.rb

@@ -4,7 +4,7 @@ require 'uri'
 require 'json'
 require 'net/http'
 require 'logger'
-# require_relative 'constants'
+require_relative 'constants'
 
 # All methods related to launch darkly api are defined here
 class LaunchdarklyApiHelperClass
@@ -14,8 +14,7 @@ class LaunchdarklyApiHelperClass
   end
 
   def parse_json(json)
-    puts "json: #{json}"
-    # json.read_body.empty? ? JSON.parse(json) ? JSON.parse(json.read_body)
+    JSON.parse(json)
   end
 
   def convert_to_json(hash)
@@ -40,7 +39,120 @@ class LaunchdarklyApiHelperClass
       raise StandardError, "Undefined HTTP method #{http_method} found"
     end
     response = https.request(request)
-    puts "response: #{response}"
-    JSON.parse(response.read_body)
+    @response = parse_json(response.read_body)
+  end
+
+  def fetch_flag_details(env, flag)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}?env=#{env}"
+    ld_request(:get, request_url)
+  end
+
+  def fetch_flag_toggle_status(env, flag)
+    flag_details_response = fetch_flag_details(env, flag)
+    flag_details_response['environments'][env]['on']
+  end
+
+  def create_flag(key, name, description, tags)
+    request_url = LAUNCH_DARKLY_FLAGS
+    request_body = {}
+    request_body.merge!(key: key, name: name, description: description, tags: tags)
+    ld_request(:post, request_url, request_body)
+  end
+
+  def toggle_specific_environment(env, flag, flag_value)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_body = { 'op' => 'replace', 'path' => "/environments/#{env}/on", 'value' => flag_value }
+    response_body = ld_request(:patch, request_url, [request_body])
+    response_body['environments'][env]['on']
+  end
+
+  def feature_flag_variation_index(status_response, details_response)
+    variations = details_response['variations']
+    value_at_index = -1
+    variations.length.times do |index|
+      next unless variations[index]['value'].eql? status_response
+
+      value_at_index = index
+      break
+    end
+    value_at_index
+  end
+
+  def feature_flag_variation_value(details_response, index_response)
+    details_response['variations'][index_response]['value']
+  end
+
+  def feature_flag_variation_name(details_response, index_response)
+    details_response['variations'][index_response]['name']
+  end
+
+  def ld_toggle_variation_served(env, flag)
+    details_response = fetch_flag_details(env, flag)
+    toggle_status_response = fetch_flag_toggle_status(env, flag)
+    variation_index_response = feature_flag_variation_index(toggle_status_response, details_response) # ['environments'][env]['fallthrough']['variation']
+    variation_value_response = feature_flag_variation_value(details_response, variation_index_response) # ['variations'][variation_index_response]['value']
+    variation_name_response = feature_flag_variation_name(details_response, variation_index_response)
+    [toggle_status_response, variation_index_response, variation_value_response, variation_name_response]
+  end
+
+  def search_rule_index_clause_index(clause_name)
+    rule_at_index = -1
+    clause_at_index = -1
+    @feature_flag_rules_list.length.times do |rule_index|
+      @feature_flag_clauses_list = @feature_flag_rules_list[rule_index]['clauses']
+      @feature_flag_clauses_list.length.times do |clause_index|
+        next unless @feature_flag_clauses_list[clause_index]['attribute'].eql? clause_name
+
+        rule_at_index = rule_index
+        clause_at_index = clause_index
+        break
+      end
+    end
+    [rule_at_index, clause_at_index]
+  end
+
+  def search_value_index(rule_at_index, clause_at_index, clause_value)
+    value_at_index = -1
+    @feature_flag_values_list = @feature_flag_rules_list[rule_at_index]['clauses'][clause_at_index]['values']
+    @feature_flag_values_list.length.times do |value_index|
+      next unless @feature_flag_values_list[value_index].eql? clause_value
+
+      value_at_index = value_index
+      break
+    end
+    value_at_index
+  end
+
+  def rules_clauses_index(env, flag, clause_name)
+    feature_flag_response = fetch_flag_details(env, flag)
+    @feature_flag_rules_list = feature_flag_response['environments'][env]['rules']
+    search_rule_index_clause_index(clause_name)
+  end
+
+  def get_values_from_clauses(env, flag, clause_name)
+    rule_at_index, clause_at_index = feature_flag_rules_clauses_index(env, flag, clause_name)
+    @feature_flag_rules_list[rule_at_index]['clauses'][clause_at_index]['values']
+  end
+
+  def add_values_to_clause(env, flag, clause_name, clause_value)
+    rule_at_index, clause_at_index = feature_flag_rules_clauses_index(env, flag, clause_name)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_body = { 'op' => 'add', 'path' => "/environments/#{env}/rules/#{rule_at_index}/clauses/#{clause_at_index}/values/0", 'value' => clause_value }
+    ld_request(:patch, request_url, [request_body])
+  end
+
+  def remove_values_from_clause(env, flag, clause_name, clause_value)
+    rule_at_index, clause_at_index = feature_flag_rules_clauses_index(env, flag, clause_name)
+    value_at_index = search_value_index(rule_at_index, clause_at_index, clause_value)
+    puts "value_index: #{value_at_index}"
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_body = { 'op' => 'test', 'path' => "/environments/#{env}/rules/#{rule_at_index}/clauses/#{clause_at_index}/values/#{value_at_index}", 'value' => clause_value },
+                   { 'op' => 'remove', 'path' => "/environments/#{env}/rules/#{rule_at_index}/clauses/#{clause_at_index}/values/#{value_at_index}" }
+    ld_request(:patch, request_url, request_body)
+  end
+
+  def delete_flag(flag)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    ld_request(:delete, request_url)
   end
 end

data/lib/launchdarkly_api_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LaunchdarklyApiHelper
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

data/lib/launchdarkly_api_helper.rb

@@ -22,10 +22,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'uri'
-require 'json'
-require 'net/http'
-require 'logger'
 require_relative 'launchdarkly_api_helper/constants'
 require_relative 'launchdarkly_api_helper/launchdarkly_api_helper_class'
 
@@ -49,16 +45,27 @@ module LaunchdarklyApiHelper
   # https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression
   #
   # == key (*required)
-  # env
+  # env, flag
   #
-  # == Here, 'developer_flag_for_regression' is the flag key and default is our Project name - Browserstack
+  # == Here, 'developer_flag_for_regression' is the feature flag name and default is our Project name - eg. AmitSinghBisht
   # == By default, this returns the configurations for all environments
-  # == You can filter environments with the env query parameter. For example, setting env=k8s restricts the returned configurations to just the k8s environment
-  # https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression?env=k8s
+  # == You can filter environments with the env query parameter. For example, setting env=staging restricts the returned configurations to just the staging environment
+  # https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression?env=staging
+
+  def ld_fetch_flag_details(env, flag)
+    @launchdarkly_helper.fetch_flag_details(env, flag)
+  end
+
+  # == Get toggle status feature flag
+  #
+  # == key (*required)
+  # env, flag
+  #
+  # response = https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression?env=staging
+  # grab the value of the ['environments'][env]['on'] obtained from the above response
 
-  def fetch_flag(flag, env)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}?env=#{env}"
-    @launchdarkly_helper.ld_request(:get, request_url)
+  def ld_fetch_flag_toggle_status(env, flag)
+    @launchdarkly_helper.fetch_flag_toggle_status(env, flag)
   end
 
   # == Create a feature flag
@@ -113,11 +120,8 @@ module LaunchdarklyApiHelper
   #
   # Default will specify which variation to serve when flag is on or off. In above example when flag is turned on, '1' variation is served [Note: 0 and 1 are index position], so variations at first index ie variations[1] will be served when flag is turned on ie 'age': 20
 
-  def create_flag(key, name: key, description: key, tags: ['created_via_regression_api'])
-    request_url = LAUNCH_DARKLY_FLAGS
-    request_body = {}
-    request_body.merge!(key: key, name: name, description: description, tags: tags)
-    ld_request(:post, request_url, request_body)
+  def ld_create_flag(key, name = key, description = key, tags = ['created_via_regression_api'])
+    @launchdarkly_helper.create_flag(key, name, description, tags)
   end
 
   # == Update feature flag
@@ -131,68 +135,36 @@ module LaunchdarklyApiHelper
   # == Here, 'developer_flag_for_regression' is the flag key and default is our Project name - Browserstack
   # == You can update any parameter of feature flag using this method
 
-  def toggle_flag_for_specific_environment(env, flag, flag_value: true)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
-    request_body = { 'op' => 'replace', 'path' => "/environments/#{env}/on", 'value' => flag_value }
-    response_body = ld_request(:patch, request_url, [request_body])
-    response_body['environments'][env]['on']
+  def ld_toggle_specific_environment(env, flag, flag_value = true)
+    @launchdarkly_helper.toggle_specific_environment(env, flag, flag_value)
   end
 
-  def toggle_variation_served_status(flag, env = ENV['PROFILE'])
-    feature_flag_response = fetch_flag(flag, env)
-    feature_flag_env = feature_flag_response['environments'][env]
-    feature_flag_toggle_status = feature_flag_env['on']
-    feature_flag_variation_index = feature_flag_env['fallthrough']['variation']
-    feature_flag_variation = feature_flag_response['variations'][feature_flag_variation_index]
-    feature_flag_variation_value = feature_flag_variation['value']
-    feature_flag_variation_name = feature_flag_variation['name']
-    [feature_flag_toggle_status, feature_flag_variation_value, feature_flag_variation_name]
-  end
+  # == Get status of feature flag
+  # https://apidocs.launchdarkly.com/tag/Feature-flags#operation/patchFeatureFlag
+  #
+  # [fetch_flag_toggle_status_response, feature_flag_variation_index_response, feature_flag_variation_value_response, feature_flag_variation_name_response]
 
-  def search_value_in_hash(feature_flag_hash, attribute)
-    value_at_index = -1
-    feature_flag_hash.length.times do |index|
-      next unless feature_flag_hash[index].to_s.include? attribute.to_s
+  def ld_toggle_variation_served(env, flag)
+    @launchdarkly_helper.ld_toggle_variation_served(env, flag)
+  end
 
-      value_at_index = index
-      break
-    end
-    value_at_index
+  def ld_rules_clauses_index(env, flag, clause_name)
+    @launchdarkly_helper.rules_clauses_index(env, flag, clause_name)
   end
 
-  def feature_flag_rules_clauses_index(flag, attribute, env = ENV['PROFILE'])
-    @feature_flag_response = fetch_flag(flag, env)
-    feature_flag_env = @feature_flag_response['environments'][env]
-    @feature_flag_env_rules = feature_flag_env['rules']
-    rule_index = search_value_in_hash(@feature_flag_env_rules, attribute)
-    @feature_flag_env_rules_clauses = @feature_flag_env_rules[rule_index]['clauses']
-    clause_index = search_value_in_hash(@feature_flag_env_rules_clauses, attribute)
-    [rule_index, clause_index]
+  def ld_get_values_from_clauses(env, flag, clause_name)
+    @launchdarkly_helper.get_values_from_clauses(env, flag, clause_name)
   end
 
-  def feature_flag_add_values_to_rules(flag, attribute, value, env = ENV['PROFILE'])
-    @flag = flag
-    @attribute = attribute
-    @value = value
-    @rule_index, @clause_index = feature_flag_rules_clauses_index(flag, attribute)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
-    request_body = { 'op' => 'add', 'path' => "/environments/#{env}/rules/#{@rule_index}/clauses/#{@clause_index}/values/0", 'value' => value }
-    ld_request(:patch, request_url, [request_body])
+  def ld_add_values_to_clause(env, flag, clause_name, clause_value)
+    @launchdarkly_helper.add_values_to_clause(env, flag, clause_name, clause_value)
   end
 
-  def feature_flag_remove_values_to_rules(flag = @flag, attribute = @attribute, value = @value, env = ENV['PROFILE'])
-    @rule_index, @clause_index = feature_flag_rules_clauses_index(flag, attribute, env = ENV['PROFILE']) unless flag || attribute
-    feature_flag_env_rules_clauses_values = @feature_flag_env_rules_clauses[@clause_index]['values']
-    value_index = search_value_in_hash(feature_flag_env_rules_clauses_values, value)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
-    request_body = { 'op': 'test', 'path': "/environments/#{env}/rules/#{@rule_index}/clauses/#{@clause_index}/values/#{value_index}", 'value': value }, { 'op' => 'remove', 'path' => "/environments/#{env}/rules/#{@rule_index}/clauses/#{@clause_index}/values/#{value_index}" }
-    ld_request(:patch, request_url, request_body)
+  def ld__remove_values_from_clause(env, flag, clause_name, clause_value)
+    @launchdarkly_helper.remove_values_from_clause(env, flag, clause_name, clause_value)
   end
 
-  def delete_flag(flag)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
-    ld_request(:delete, request_url)
+  def ld_delete_flag(flag)
+    @launchdarkly_helper.delete_flag(flag)
   end
 end
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly_api_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - amit-singh-bisht