rbflagr 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d581712bb92f0f0bc0dcf1bd36fae8f9ed8e5511147bde6ed674f018ef8402b
-  data.tar.gz: 35f793dab20335bd32c8b8602b178cfd580ddaa5eb20a21759821f21be2eb6a6
+  metadata.gz: 72c1faf5b1ee8c6ae575b8e00a29320e92ee0e5fff91c2dfe6cd5a1d382453fd
+  data.tar.gz: 92a5d8eb871b5973da7ed14c3238ccc52efecbefc466d151848aa54ea9a1859f
 SHA512:
-  metadata.gz: 41dd88e56157dd2ca3df30e5bf40b4bd487c3c93634da94d0d331f0827274045426f4ef75c1d73426e4a5cb48fac7ccd351a091239ed4545aaa512b74dad1002
-  data.tar.gz: c3b140e97a2c4921df97ccd8d89669de4eeb65d378549d317a1419e5457a063fc7dab72e90f028b523059ca57a9281347cbedc499d2cdfb9f50c5f3a2596f162
+  metadata.gz: ae8cee2a697034e4e66be84b2d73042ebe7cb4912fc0314568ad134e85bdab52bb11e0d1d72431a46af335df5f47d7edd5ceed4780268d4a3167a2049fa67012
+  data.tar.gz: 3b4bcc9ba06ba719bd4514b5043c3d8414c39e120ff907478e4b9166a728d24fcd2ac606266e5581c405ff78601163e53ebc5656eb30a2b03967076d5a2329d9

data/README.md

@@ -2,12 +2,12 @@
 
 Flagr - the Ruby gem for the Flagr
 
-Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 1.0.8
-- Package version: 0.1.2
+- API version: 1.0.13
+- Package version: 0.2.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build rbflagr.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./rbflagr-0.1.2.gem
+gem install ./rbflagr-0.2.0.gem
 ```
-(for development, run `gem install --dev ./rbflagr-0.1.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./rbflagr-0.2.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 'rbflagr', '~> 0.1.2'
+    gem 'rbflagr', '~> 0.2.0'
 
 ### Install from Git
 
@@ -86,14 +86,16 @@ Class | Method | HTTP request | Description
 *Flagr::DistributionApi* | [**put_distributions**](docs/DistributionApi.md#put_distributions) | **PUT** /flags/{flagID}/segments/{segmentID}/distributions | 
 *Flagr::EvaluationApi* | [**post_evaluation**](docs/EvaluationApi.md#post_evaluation) | **POST** /evaluation | 
 *Flagr::EvaluationApi* | [**post_evaluation_batch**](docs/EvaluationApi.md#post_evaluation_batch) | **POST** /evaluation/batch | 
+*Flagr::ExportApi* | [**get_export_sq_lite**](docs/ExportApi.md#get_export_sq_lite) | **GET** /export/sqlite | 
 *Flagr::FlagApi* | [**create_flag**](docs/FlagApi.md#create_flag) | **POST** /flags | 
 *Flagr::FlagApi* | [**delete_flag**](docs/FlagApi.md#delete_flag) | **DELETE** /flags/{flagID} | 
 *Flagr::FlagApi* | [**find_flags**](docs/FlagApi.md#find_flags) | **GET** /flags | 
 *Flagr::FlagApi* | [**get_flag**](docs/FlagApi.md#get_flag) | **GET** /flags/{flagID} | 
+*Flagr::FlagApi* | [**get_flag_entity_types**](docs/FlagApi.md#get_flag_entity_types) | **GET** /flags/entity_types | 
 *Flagr::FlagApi* | [**get_flag_snapshots**](docs/FlagApi.md#get_flag_snapshots) | **GET** /flags/{flagID}/snapshots | 
 *Flagr::FlagApi* | [**put_flag**](docs/FlagApi.md#put_flag) | **PUT** /flags/{flagID} | 
 *Flagr::FlagApi* | [**set_flag_enabled**](docs/FlagApi.md#set_flag_enabled) | **PUT** /flags/{flagID}/enabled | 
-*Flagr::HealthApi* | [**health_get**](docs/HealthApi.md#health_get) | **GET** /health | 
+*Flagr::HealthApi* | [**get_health**](docs/HealthApi.md#get_health) | **GET** /health | 
 *Flagr::SegmentApi* | [**create_segment**](docs/SegmentApi.md#create_segment) | **POST** /flags/{flagID}/segments | 
 *Flagr::SegmentApi* | [**delete_segment**](docs/SegmentApi.md#delete_segment) | **DELETE** /flags/{flagID}/segments/{segmentID} | 
 *Flagr::SegmentApi* | [**find_segments**](docs/SegmentApi.md#find_segments) | **GET** /flags/{flagID}/segments | 

data/docs/CreateFlagRequest.md

@@ -4,5 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **description** | **String** |  | 
+**key** | **String** | unique key representation of the flag | [optional] 
 
 

data/docs/Distribution.md

@@ -5,7 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** |  | [optional] 
 **percent** | **Integer** |  | 
-**bitmap** | **String** |  | [optional] 
 **variant_key** | **String** |  | 
 **variant_id** | **Integer** |  | 
 

data/docs/EvalContext.md

@@ -4,9 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entity_id** | **String** | entityID is used to deterministically at random to evaluate the flag result. If it's empty, flagr will randomly generate one. | [optional] 
-**entity_type** | **String** |  | 
+**entity_type** | **String** |  | [optional] 
 **entity_context** | **Object** |  | [optional] 
 **enable_debug** | **BOOLEAN** |  | [optional] 
-**flag_id** | **Integer** |  | 
+**flag_id** | **Integer** | flagID | [optional] 
+**flag_key** | **String** | flagKey. flagID or flagKey will resolve to the same flag. Either works. | [optional] 
 
 

data/docs/EvalResult.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **flag_id** | **Integer** |  | 
+**flag_key** | **String** |  | 
 **flag_snapshot_id** | **Integer** |  | [optional] 
 **segment_id** | **Integer** |  | 
 **variant_id** | **Integer** |  | 

data/docs/EvaluationBatchRequest.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entities** | [**Array<EvaluationEntity>**](EvaluationEntity.md) |  | 
 **enable_debug** | **BOOLEAN** |  | [optional] 
-**flag_i_ds** | **Array<Integer>** |  | 
+**flag_i_ds** | **Array<Integer>** | flagIDs | [optional] 
+**flag_keys** | **Array<String>** | flagKeys. Either flagIDs or flagKeys works. If pass in both, Flagr may return duplicate results. | [optional] 
 
 

data/docs/EvaluationEntity.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entity_id** | **String** |  | [optional] 
-**entity_type** | **String** |  | 
+**entity_type** | **String** |  | [optional] 
 **entity_context** | **Object** |  | [optional] 
 
 

data/docs/ExportApi.md

@@ -0,0 +1,49 @@
+# Flagr::ExportApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_export_sq_lite**](ExportApi.md#get_export_sq_lite) | **GET** /export/sqlite | 
+
+
+# **get_export_sq_lite**
+> File get_export_sq_lite
+
+
+
+Export sqlite3 format of the db dump, which is converted from the main database.
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::ExportApi.new
+
+begin
+  result = api_instance.get_export_sq_lite
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling ExportApi->get_export_sq_lite: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/octet-stream
+
+
+

data/docs/Flag.md

@@ -4,10 +4,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** |  | [optional] 
+**key** | **String** | unique key representation of the flag | [optional] 
 **description** | **String** |  | 
 **enabled** | **BOOLEAN** |  | 
 **segments** | [**Array<Segment>**](Segment.md) |  | [optional] 
 **variants** | [**Array<Variant>**](Variant.md) |  | [optional] 
 **data_records_enabled** | **BOOLEAN** | enabled data records will get data logging in the metrics pipeline, for example, kafka. | 
+**entity_type** | **String** | it will override the entityType in the evaluation logs if it's not empty | [optional] 
+**created_by** | **String** |  | [optional] 
+**updated_by** | **String** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
 
 

data/docs/FlagApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**delete_flag**](FlagApi.md#delete_flag) | **DELETE** /flags/{flagID} | 
 [**find_flags**](FlagApi.md#find_flags) | **GET** /flags | 
 [**get_flag**](FlagApi.md#get_flag) | **GET** /flags/{flagID} | 
+[**get_flag_entity_types**](FlagApi.md#get_flag_entity_types) | **GET** /flags/entity_types | 
 [**get_flag_snapshots**](FlagApi.md#get_flag_snapshots) | **GET** /flags/{flagID}/snapshots | 
 [**put_flag**](FlagApi.md#put_flag) | **PUT** /flags/{flagID} | 
 [**set_flag_enabled**](FlagApi.md#set_flag_enabled) | **PUT** /flags/{flagID}/enabled | 
@@ -117,6 +118,7 @@ opts = {
   enabled: true, # BOOLEAN | return flags having given enabled status
   description: 'description_example', # String | return flags exactly matching given description
   description_like: 'description_like_example', # String | return flags partially matching given description
+  key: 'key_example', # String | return flags matching given key
   offset: 789 # Integer | return flags given the offset, it should usually set together with limit
 }
 
@@ -136,6 +138,7 @@ Name | Type | Description  | Notes
  **enabled** | **BOOLEAN**| return flags having given enabled status | [optional] 
  **description** | **String**| return flags exactly matching given description | [optional] 
  **description_like** | **String**| return flags partially matching given description | [optional] 
+ **key** | **String**| return flags matching given key | [optional] 
  **offset** | **Integer**| return flags given the offset, it should usually set together with limit | [optional] 
 
 ### Return type
@@ -197,6 +200,44 @@ No authorization required
 
 
 
+# **get_flag_entity_types**
+> Array<String> get_flag_entity_types
+
+
+
+### Example
+```ruby
+# load the gem
+require 'rbflagr'
+
+api_instance = Flagr::FlagApi.new
+
+begin
+  result = api_instance.get_flag_entity_types
+  p result
+rescue Flagr::ApiError => e
+  puts "Exception when calling FlagApi->get_flag_entity_types: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_flag_snapshots**
 > Array<FlagSnapshot> get_flag_snapshots(flag_id)
 

data/docs/HealthApi.md

@@ -4,14 +4,16 @@ All URIs are relative to *http://localhost/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**health_get**](HealthApi.md#health_get) | **GET** /health | 
+[**get_health**](HealthApi.md#get_health) | **GET** /health | 
 
 
-# **health_get**
-> health_get
+# **get_health**
+> get_health
 
 
 
+Check if Flagr is healthy
+
 ### Example
 ```ruby
 # load the gem
@@ -20,9 +22,9 @@ require 'rbflagr'
 api_instance = Flagr::HealthApi.new
 
 begin
-  api_instance.health_get
+  api_instance.get_health
 rescue Flagr::ApiError => e
-  puts "Exception when calling HealthApi->health_get: #{e}"
+  puts "Exception when calling HealthApi->get_health: #{e}"
 end
 ```
 

data/docs/PutFlagRequest.md

@@ -3,7 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**description** | **String** |  | 
+**description** | **String** |  | [optional] 
 **data_records_enabled** | **BOOLEAN** | enabled data records will get data logging in the metrics pipeline, for example, kafka. | [optional] 
+**entity_type** | **String** | it will overwrite entityType into evaluation logs if it's not empty | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+**key** | **String** |  | [optional] 
 
 

data/docs/PutVariantRequest.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **key** | **String** |  | 
-**attachment** | **Object** |  | 
+**attachment** | **Object** |  | [optional] 
 
 

data/lib/rbflagr.rb

@@ -1,9 +1,9 @@
 =begin
 #Flagr
 
-#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT
@@ -46,6 +46,7 @@ require 'rbflagr/models/variant'
 require 'rbflagr/api/constraint_api'
 require 'rbflagr/api/distribution_api'
 require 'rbflagr/api/evaluation_api'
+require 'rbflagr/api/export_api'
 require 'rbflagr/api/flag_api'
 require 'rbflagr/api/health_api'
 require 'rbflagr/api/segment_api'

data/lib/rbflagr/api/constraint_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Flagr
 
-#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/api/distribution_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Flagr
 
-#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/api/evaluation_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Flagr
 
-#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT

data/lib/rbflagr/api/export_api.rb

@@ -0,0 +1,69 @@
+=begin
+#Flagr
+
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
+
+OpenAPI spec version: 1.0.13
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module Flagr
+  class ExportApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Export sqlite3 format of the db dump, which is converted from the main database.
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_export_sq_lite(opts = {})
+      data, _status_code, _headers = get_export_sq_lite_with_http_info(opts)
+      data
+    end
+
+    # Export sqlite3 format of the db dump, which is converted from the main database.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def get_export_sq_lite_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExportApi.get_export_sq_lite ...'
+      end
+      # resource path
+      local_var_path = '/export/sqlite'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExportApi#get_export_sq_lite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/rbflagr/api/flag_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Flagr
 
-#Flagr is a feature flagging, A/B testing and dynamic configuration microservice
+#Flagr is a feature flagging, A/B testing and dynamic configuration microservice. The base path for all the APIs is \"/api/v1\". 
 
-OpenAPI spec version: 1.0.8
+OpenAPI spec version: 1.0.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.0-SNAPSHOT
@@ -127,6 +127,7 @@ module Flagr
     # @option opts [BOOLEAN] :enabled return flags having given enabled status
     # @option opts [String] :description return flags exactly matching given description
     # @option opts [String] :description_like return flags partially matching given description
+    # @option opts [String] :key return flags matching given key
     # @option opts [Integer] :offset return flags given the offset, it should usually set together with limit
     # @return [Array<Flag>]
     def find_flags(opts = {})
@@ -139,6 +140,7 @@ module Flagr
     # @option opts [BOOLEAN] :enabled return flags having given enabled status
     # @option opts [String] :description return flags exactly matching given description
     # @option opts [String] :description_like return flags partially matching given description
+    # @option opts [String] :key return flags matching given key
     # @option opts [Integer] :offset return flags given the offset, it should usually set together with limit
     # @return [Array<(Array<Flag>, Fixnum, Hash)>] Array<Flag> data, response status code and response headers
     def find_flags_with_http_info(opts = {})
@@ -154,6 +156,7 @@ module Flagr
       query_params[:'enabled'] = opts[:'enabled'] if !opts[:'enabled'].nil?
       query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
       query_params[:'description_like'] = opts[:'description_like'] if !opts[:'description_like'].nil?
+      query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
 
       # header parameters
@@ -235,6 +238,50 @@ module Flagr
       end
       return data, status_code, headers
     end
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def get_flag_entity_types(opts = {})
+      data, _status_code, _headers = get_flag_entity_types_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
+    def get_flag_entity_types_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FlagApi.get_flag_entity_types ...'
+      end
+      # resource path
+      local_var_path = '/flags/entity_types'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<String>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FlagApi#get_flag_entity_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # @param flag_id numeric ID of the flag to get
     # @param [Hash] opts the optional parameters
     # @return [Array<FlagSnapshot>]