devcycle-ruby-server-sdk 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 568a1d631763d70e2ab7588459b8db1383e53495a10c35baf55e1e5f0f733a12
-  data.tar.gz: 5f68fba2022de817bed7a35287003578b736c0c35d82b766062a3a1ad8983daa
+  metadata.gz: b37103165cc47272d718527f01a20fd41e5a4fa851329a1b9ae472d04c561e87
+  data.tar.gz: dc33b920301e236e1f4829c3c5b2bfa811c4c7649146d59719aefb81111bded1
 SHA512:
-  metadata.gz: 7c72105c1f5646f22adfb9e3b80851fafc91e3f712702a1acf7032b5d0034ca8c96cad02c657a18d03a9125ceaed0caf0d4d325f26a8633d8343212c7c8220b3
-  data.tar.gz: 404abbde5b200a05cab28052cf762714f328068e7f4a7336271b5115b9249d515e3f7c3de4f9ba35860726ebdbf723d4af483ef74512cd9b892dd921bb38b647
+  metadata.gz: bd9a35095127bfd7e51a9af0894b7d0244e9d8f494566a85b95b71179c1090f79cf4d757d427a98553aaccbc90bbcb1cd8606f0001b3b09f36dedc3629286588
+  data.tar.gz: 5ca612fe98bad4539f5b5d87ac1b3512d0eca2fbb285a3482d5675c1b4cfd52643bd94ff3dbebca585cf5f288e8bb08d7bee5ccee869b45d27e44c08bd472116

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    devcycle-ruby-server-sdk (1.2.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.4)
+      stringio
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    stringio (3.0.2)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  devcycle-ruby-server-sdk!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -1,14 +1,6 @@
-# devcycle-ruby-server-sdk
+# DevCycle Ruby Server SDK
 
-DevCycle - the Ruby gem for the DevCycle Bucketing API
-
-Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs.
-
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 1.0.0
-- Package version: 1.0.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+Welcome to the the DevCycle Ruby SDK, initially generated via the [DevCycle Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/devcycle).
 
 ## Installation
 
@@ -23,7 +15,7 @@ Please follow the [installation](#installation) procedure and then run the follo
 
 ```ruby
 # Load the gem
-require 'devcycle-server-sdk'
+require 'devcycle-ruby-server-sdk'
 
 # Setup authorization
 DevCycle.configure do |config|
@@ -46,126 +38,4 @@ end
 
 ## Usage
 
-### Configure SDK
-```ruby
-# Load the gem
-require 'devcycle-server-sdk'
-
-# Setup authorization
-DevCycle.configure do |config|
-  # Configure API key authorization
-  config.api_key['bearerAuth'] = 'YOUR API KEY'
-end
-
-api_instance = DevCycle::DVCClient.new
-user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData | 
-```
-
-### Get all features
-```ruby
-begin
-  #Get all features for user data
-  result = api_instance.all_features(user_data)
-  p result
-rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->all_features: #{e}"
-end
-```
-
-### Get variable by key
-```ruby
-begin
-  # Get value of given variable by key, using default value if segmentation is not passed or variable does not exit
-  result = api_instance.variable("variable-key", user_data, true)
-  p "Received value for #{result.key}: #{result.value}"
-rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->variable: #{e}"
-end
-```
-
-### Get all variables
-```ruby
-begin
-  #Get all variables for user data
-  result = api_instance.all_variables(user_data)
-  p result
-rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->all_variables: #{e}"
-end
-```
-
-### Send events
-```ruby
-
-event_data = DevCycle::Event.new({
-  type: "my-event",
-  target: "some_event_target",
-  value: 12,
-  meta_data: {
-    myKey: "my-value"
-  }
-})
-
-begin
-  # Post events for given user data
-  result = api_instance.track(user_data, event_data)
-  p result
-rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->track: #{e}"
-end
-```
-
-### Override Logger
-To provide a custom logger, override the `logger` property of the SDK configuration.
-```ruby
-DevCycle.configure do |config|
-  # Configure API key authorization
-  config.api_key['bearerAuth'] = 'YOUR API KEY'
-
-  # Override the default logger
-  config.logger = MyLogger
-end
-```
-
-### Troubleshooting
-To see a detailed log of the requests being made to the DevCycle API, enable SDK debug logging:
-```ruby
-DevCycle.configure do |config|
-  # Configure API key authorization
-  config.api_key['bearerAuth'] = 'YOUR API KEY'
-
-  # Enable detailed debug logs of requests being sent to the DevCycle API
-  config.debugging = true
-end
-```
-
-
-## Documentation for Models
-
- - [DevCycle::ErrorResponse](docs/ErrorResponse.md)
- - [DevCycle::Event](docs/Event.md)
- - [DevCycle::Feature](docs/Feature.md)
- - [DevCycle::UserData](docs/UserData.md)
- - [DevCycle::Variable](docs/Variable.md)
-
-### Development
-
-To build the Ruby code into a gem:
-
-```shell
-gem build devcycle-ruby-server-sdk.gemspec
-```
-
-Then either install the gem locally:
-
-```shell
-gem install ./devcycle-ruby-server-sdk-1.0.0.gem
-```
-
-(for development, run `gem install --dev ./devcycle-ruby-server-sdk-1.0.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 'ruby-server-sdk', '~> 1.0.0'
+To find usage documentation, visit our [docs](https://docs.devcycle.com/docs/sdk/server-side-sdks/ruby#usage).

data/docs/DevcycleApi.md

@@ -20,7 +20,7 @@ Get all features by key for user data
 
 ```ruby
 require 'time'
-require 'devcycle-server-sdk'
+require 'devcycle-ruby-server-sdk'
 # setup authorization
 DevCycle.configure do |config|
   # Configure API key authorization: bearerAuth
@@ -81,7 +81,7 @@ end
 
 ## variable
 
-> <Variable> variable(key, user_data)
+> <Variable> variable(user_data, key)
 
 Get variable by key for user data
 
@@ -89,7 +89,7 @@ Get variable by key for user data
 
 ```ruby
 require 'time'
-require 'devcycle-server-sdk'
+require 'devcycle-ruby-server-sdk'
 # setup authorization
 DevCycle.configure do |config|
   # Configure API key authorization: bearerAuth
@@ -104,7 +104,7 @@ user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData |
 
 begin
   # Get variable by key for user data
-  result = api_instance.variable(key, user_data)
+  result = api_instance.variable(user_data, key)
   p result
 rescue DevCycle::ApiError => e
   puts "Error when calling DevcycleApi->variable: #{e}"
@@ -160,7 +160,7 @@ Get all variables by key for user data
 
 ```ruby
 require 'time'
-require 'devcycle-server-sdk'
+require 'devcycle-ruby-server-sdk'
 # setup authorization
 DevCycle.configure do |config|
   # Configure API key authorization: bearerAuth
@@ -229,7 +229,7 @@ Post events to DevCycle for user
 
 ```ruby
 require 'time'
-require 'devcycle-server-sdk'
+require 'devcycle-ruby-server-sdk'
 # setup authorization
 DevCycle.configure do |config|
   # Configure API key authorization: bearerAuth

data/docs/ErrorResponse.md

@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'devcycle-server-sdk'
+require 'devcycle-ruby-server-sdk'
 
 instance = DevCycle::ErrorResponse.new(
   message: null,

data/docs/UserData.md

@@ -24,7 +24,7 @@
 ## Example
 
 ```ruby
-require 'ruby-server-sdk'
+require 'devcycle-ruby-server-sdk'
 
 instance = DevCycle::UserData.new(
   user_id: null,

data/examples/sinatra/Gemfile

@@ -3,4 +3,6 @@ source 'https://rubygems.org'
 gem 'sinatra'
 gem 'sinatra-contrib'
 gem 'thin'
-gem 'devcycle-ruby-server-sdk'
+# gem 'devcycle-server-sdk'
+gem 'devcycle-ruby-server-sdk', path: "../../"
+

data/examples/sinatra/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: ../..
+  specs:
+    devcycle-ruby-server-sdk (1.2.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -5,26 +11,24 @@ GEM
     ethon (0.15.0)
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
-    ffi (1.15.4)
+    ffi (1.15.5)
     multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     rack (2.2.3)
-    rack-protection (2.1.0)
+    rack-protection (2.2.0)
       rack
-    ruby-server-sdk (1.0.1)
-      typhoeus (~> 1.0, >= 1.0.1)
     ruby2_keywords (0.0.5)
-    sinatra (2.1.0)
+    sinatra (2.2.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.0)
       tilt (~> 2.0)
-    sinatra-contrib (2.1.0)
+    sinatra-contrib (2.2.0)
       multi_json
       mustermann (~> 1.0)
-      rack-protection (= 2.1.0)
-      sinatra (= 2.1.0)
+      rack-protection (= 2.2.0)
+      sinatra (= 2.2.0)
       tilt (~> 2.0)
     thin (1.8.1)
       daemons (~> 1.0, >= 1.0.9)
@@ -35,14 +39,13 @@ GEM
       ethon (>= 0.9.0)
 
 PLATFORMS
-  universal-darwin-20
-  x86_64-darwin-19
+  ruby
 
 DEPENDENCIES
-  ruby-server-sdk
+  devcycle-ruby-server-sdk!
   sinatra
   sinatra-contrib
   thin
 
 BUNDLED WITH
-   2.2.31
+   1.17.3

data/examples/sinatra/app.rb

@@ -12,6 +12,7 @@ DevCycle.configure do |config|
     # Configure API key authorization: bearerAuth
     config.api_key['bearerAuth'] = token
     # config.debugging = true
+    config.enable_edge_db = false
 end
 
 api_instance = DevCycle::DVCClient.new
@@ -25,7 +26,7 @@ get '/' do
 end
 
 get '/experiment' do
-    result = api_instance.variable("test-feature", user_data, false)
+    result = api_instance.variable(user_data, "test-feature", false)
     p result
 
     "Your variable result is: #{result.value}"

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

@@ -98,12 +98,12 @@ module DevCycle
     end
 
     # Get variable by key for user data
-    # @param key [String] Variable key
     # @param user_data [UserData]
+    # @param key [String] Variable key
     # @param default Default value for variable if none is retrieved
     # @param [Hash] opts the optional parameters
     # @return [Variable]
-    def variable(key, user_data, default, opts = {})
+    def variable(user_data, key, default, opts = {})
       if !user_data.is_a?(DevCycle::UserData)
         fail ArgumentError, "user_data param must be an instance of UserData!"
       end

data/lib/devcycle-ruby-server-sdk/api_client.rb

@@ -94,6 +94,10 @@ module DevCycle
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
+      if @config.enable_edge_db
+        query_params.store("enableEdgeDB", true)
+      end
+
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)

data/lib/devcycle-ruby-server-sdk/configuration.rb

@@ -137,6 +137,10 @@ module DevCycle
 
     attr_accessor :force_ending_format
 
+   # Define if EdgeDB is Enabled (Boolean)
+   # Default to false
+   attr_accessor :enable_edge_db
+
     def initialize
       @scheme = 'https'
       @host = 'bucketing-api.devcycle.com'
@@ -158,6 +162,7 @@ module DevCycle
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @enable_edge_db = false
 
       yield(self) if block_given?
     end
@@ -274,5 +279,11 @@ module DevCycle
       url
     end
 
+    def enable_edge_db=(enable_edge_db = false)
+      if(enable_edge_db)
+        @enable_edge_db = true
+      end
+    end
+
   end
 end

data/lib/devcycle-ruby-server-sdk/models/feature.rb

@@ -27,6 +27,12 @@ module DevCycle
     # Bucketed feature variation
     attr_accessor :_variation
 
+    # Bucketed feature variation key
+    attr_accessor :variationKey
+
+    # Bucketed feature variation name
+    attr_accessor :variationName
+
     # Evaluation reasoning
     attr_accessor :eval_reason
 
@@ -59,6 +65,8 @@ module DevCycle
         :'key' => :'key',
         :'type' => :'type',
         :'_variation' => :'_variation',
+        :'variationKey' => :'variationKey',
+        :'variationName' => :'variationName',
         :'eval_reason' => :'evalReason'
       }
     end
@@ -75,6 +83,8 @@ module DevCycle
         :'key' => :'String',
         :'type' => :'String',
         :'_variation' => :'String',
+        :'variationKey' => :'String',
+        :'variationName' => :'String',
         :'eval_reason' => :'String'
       }
     end
@@ -116,6 +126,14 @@ module DevCycle
         self._variation = attributes[:'_variation']
       end
 
+      if attributes.key?(:'variationKey')
+        self.variationKey = attributes[:'variationKey']
+      end
+
+      if attributes.key?(:'variationName')
+        self.variationName = attributes[:'variationName']
+      end
+
       if attributes.key?(:'eval_reason')
         self.eval_reason = attributes[:'eval_reason']
       end
@@ -141,6 +159,14 @@ module DevCycle
         invalid_properties.push('invalid value for "_variation", _variation cannot be nil.')
       end
 
+      if @variationKey.nil?
+        invalid_properties.push('invalid value for "variationKey", variationKey cannot be nil.')
+      end
+
+      if @variationName.nil?
+        invalid_properties.push('invalid value for "variationName", variationName cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -153,6 +179,8 @@ module DevCycle
       type_validator = EnumAttributeValidator.new('String', ["release", "experiment", "permission", "ops"])
       return false unless type_validator.valid?(@type)
       return false if @_variation.nil?
+      return false if @variationKey.nil?
+      return false if @variationName.nil?
       true
     end
 
@@ -175,6 +203,8 @@ module DevCycle
           key == o.key &&
           type == o.type &&
           _variation == o._variation &&
+          variationKey == o.variationKey &&
+          variationName == o.variationName &&
           eval_reason == o.eval_reason
     end
 
@@ -187,7 +217,7 @@ module DevCycle
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [_id, key, type, _variation, eval_reason].hash
+      [_id, key, type, _variation, variationKey, variationName, eval_reason].hash
     end
 
     # Builds the object from hash

data/lib/devcycle-ruby-server-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.0
 =end
 
 module DevCycle
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/spec/api/devcycle_api_spec.rb

@@ -63,7 +63,7 @@ describe 'DVCClient' do
   # @return [Variable]
   describe 'get_variable_by_key test' do
     it 'should work' do
-      result = @api_instance.variable("activate-flag", @user_data, false)
+      result = @api_instance.variable(@user_data, "activate-flag", false)
 
       expect(result.isDefaulted).to eq false
     end

data/spec/api_client_spec.rb

@@ -49,6 +49,23 @@ describe DevCycle::ApiClient do
         end
       end
     end
+
+    context 'Enabled Edge DB' do
+      it 'defaults the enable_edge_db value to false when no value is provided' do
+        DevCycle.configure { }
+        expect(DevCycle::Configuration.default.enable_edge_db).to eq(false)
+      end
+      
+      it 'sets the enable_edge_db value to false when false is provided' do
+        DevCycle.configure { |c| c.enable_edge_db = false }
+        expect(DevCycle::Configuration.default.enable_edge_db).to eq(false)
+      end
+      
+      it 'sets the enable_edge_db value to true when true is provided' do
+        DevCycle.configure { |c| c.enable_edge_db = true }
+        expect(DevCycle::Configuration.default.enable_edge_db).to eq(true)
+      end
+    end
   end
 
   describe 'params_encoding in #build_request' do

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ OpenAPI Generator version: 5.3.0
 =end
 
 # load the gem
-require 'devcycle-server-sdk'
+require 'devcycle-ruby-server-sdk'
 
 # The following  was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devcycle-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - DevCycleHQ
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -59,6 +59,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -95,7 +96,7 @@ homepage: https://devcycle.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: DevCycle Bucketing API Ruby Gem
 test_files: