devcycle-server-sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9724ae4c4241898d78424d62ec5153f8ee866315fdba153fe3e744639f8d8ea3
-  data.tar.gz: c3ccb44cd5347633ca37f4683eded5a55a072859a72527d03ee052a35040020e
+  metadata.gz: aa8e4179916b31d1838dbfc2bde1c3d0ba75b2faab66b90406579dae09868709
+  data.tar.gz: dec6f3e808e049e79b24962e390ae2581201ecbc6610b3df039be6daee71d00c
 SHA512:
-  metadata.gz: 3bf213b6acf6317956242ed995bc23f586f3b9df60ad5b19beed0861de447da408bd5e7e376425016466b52d89ff1e0c4a6042fc63b08b77a72d70b073642ceb
-  data.tar.gz: 342146317ceea77d9a3b67a27298772c674652c757c892e1a3a53a78135884cd83eff060065c10abbe1fc9e35402fe171aa8eb4ecc74388f32d5ebd6eaaa15c8
+  metadata.gz: 7fa695b877f3c5dd287bd4fe46c6c4f0f3c771ce9261ddf0c60ea9911fcde5dd23a25ed57a076b57cd4c074c7f4854a987fabefd63f8a341ad20393290a70166
+  data.tar.gz: 20f8ceebdf7695329019745bdd14cf6ab041679c5338ada6fc0ea3c99e064c277a52e045a77c94917977217e151e3e72acd9967885d041bd66426ee7be3987a3

data/README.md

@@ -12,35 +12,10 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 
 ## Installation
 
-### Build a gem
+Install the gem
 
-To build the Ruby code into a gem:
-
-```shell
-gem build devcycle-server-sdk.gemspec
-```
-
-Then either install the gem locally:
-
-```shell
-gem install ./devcycle-server-sdk-1.0.0.gem
-```
-
-(for development, run `gem install --dev ./devcycle-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 'devcycle-server-sdk', '~> 1.0.0'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
-
-```shell
-ruby -Ilib script.rb
-```
+`gem install devcycle-server-sdk`
+  
 
 ## Getting Started
 
@@ -61,10 +36,10 @@ user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData |
 
 begin
   #Get all features for user data
-  result = api_instance.get_features(user_data)
+  result = api_instance.all_features(user_data)
   p result
 rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->get_features: #{e}"
+  puts "Exception when calling DVCClient->all_features: #{e}"
 end
 
 ```
@@ -90,10 +65,10 @@ user_data = DevCycle::UserData.new({user_id: 'user_id_example'}) # UserData |
 ```ruby
 begin
   #Get all features for user data
-  result = api_instance.get_features(user_data)
+  result = api_instance.all_features(user_data)
   p result
 rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->get_features: #{e}"
+  puts "Exception when calling DVCClient->all_features: #{e}"
 end
 ```
 
@@ -101,10 +76,10 @@ end
 ```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.get_variable_by_key("variable-key", user_data, true)
+  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->get_variable_by_key: #{e}"
+  puts "Exception when calling DVCClient->variable: #{e}"
 end
 ```
 
@@ -112,10 +87,10 @@ end
 ```ruby
 begin
   #Get all variables for user data
-  result = api_instance.get_variables(user_data)
+  result = api_instance.all_variables(user_data)
   p result
 rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->get_variables: #{e}"
+  puts "Exception when calling DVCClient->all_variables: #{e}"
 end
 ```
 
@@ -133,10 +108,10 @@ event_data = DevCycle::Event.new({
 
 begin
   # Post events for given user data
-  result = api_instance.track_event(user_data, event_data)
+  result = api_instance.track(user_data, event_data)
   p result
 rescue DevCycle::ApiError => e
-  puts "Exception when calling DVCClient->track_event: #{e}"
+  puts "Exception when calling DVCClient->track: #{e}"
 end
 ```
 
@@ -173,3 +148,24 @@ end
  - [DevCycle::UserData](docs/UserData.md)
  - [DevCycle::Variable](docs/Variable.md)
 
+### Development
+
+To build the Ruby code into a gem:
+
+```shell
+gem build devcycle-server-sdk.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./devcycle-server-sdk-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./devcycle-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 'devcycle-server-sdk', '~> 1.0.0'

data/devcycle-server-sdk.gemspec

@@ -2,14 +2,10 @@
 
 =begin
 #DevCycle Bucketing API
-
 #Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs.
-
 The version of the OpenAPI document: 1.0.0
-
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.0
-
 =end
 
 $:.push File.expand_path("../lib", __FILE__)
@@ -21,9 +17,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["DevCycleHQ"]
   s.email       = ["support@devcycle.com"]
-  s.homepage    = "https://openapi-generator.tech"
+  s.homepage    = "https://devcycle.com"
   s.summary     = "DevCycle Bucketing API Ruby Gem"
-  s.description = "Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs."
+  s.description = "DevCycle Ruby Server SDK, for interacting with feature flags created with the DevCycle platform."
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.4"
 
@@ -35,4 +31,4 @@ Gem::Specification.new do |s|
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
-end
+end

data/examples/sinatra/Gemfile

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

data/examples/sinatra/Gemfile.lock

@@ -1,13 +1,9 @@
-PATH
-  remote: ../..
-  specs:
-    devcycle-server-sdk (1.0.0)
-      typhoeus (~> 1.0, >= 1.0.1)
-
 GEM
   remote: https://rubygems.org/
   specs:
     daemons (1.4.1)
+    devcycle-server-sdk (1.0.0)
+      typhoeus (~> 1.0, >= 1.0.1)
     ethon (0.15.0)
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
@@ -42,7 +38,7 @@ PLATFORMS
   x86_64-darwin-19
 
 DEPENDENCIES
-  devcycle-server-sdk!
+  devcycle-server-sdk
   sinatra
   sinatra-contrib
   thin

data/examples/sinatra/app.rb

@@ -25,7 +25,7 @@ get '/' do
 end
 
 get '/experiment' do
-    result = api_instance.get_variable_by_key("test-feature", user_data, false)
+    result = api_instance.variable("test-feature", user_data, false)
     p result
 
     "Your variable result is: #{result.value}"
@@ -41,7 +41,7 @@ get '/track-event' do
         }
     })
 
-    result = api_instance.track_event(user_data, event_data)
+    result = api_instance.track(user_data, event_data)
 
     p result
 end

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

@@ -29,14 +29,14 @@ module DevCycle
     # @param user_data [UserData] 
     # @param [Hash] opts the optional parameters
     # @return [Hash<String, Feature>]
-    def get_features(user_data, opts = {})
+    def all_features(user_data, opts = {})
       if !user_data.is_a?(DevCycle::UserData)
         fail ArgumentError, "user_data param must be an instance of UserData!"
       end
 
       validate_model(user_data)
 
-      data, _status_code, _headers = get_features_with_http_info(user_data, opts)
+      data, _status_code, _headers = all_features_with_http_info(user_data, opts)
       data
     end
 
@@ -44,13 +44,13 @@ module DevCycle
     # @param user_data [UserData] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Hash<String, Feature>, Integer, Hash)>] Hash<String, Feature> data, response status code and response headers
-    def get_features_with_http_info(user_data, opts = {})
+    def all_features_with_http_info(user_data, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DVCClient.get_features ...'
+        @api_client.config.logger.debug 'Calling API: DVCClient.all_features ...'
       end
       # verify the required parameter 'user_data' is set
       if @api_client.config.client_side_validation && user_data.nil?
-        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.get_features"
+        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.all_features"
       end
       # resource path
       local_var_path = '/v1/features'
@@ -81,7 +81,7 @@ module DevCycle
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"DVCClient.get_features",
+        :operation => :"DVCClient.all_features",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -92,7 +92,7 @@ module DevCycle
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DVCClient#get_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: DVCClient#all_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -103,14 +103,14 @@ module DevCycle
     # @param default Default value for variable if none is retrieved
     # @param [Hash] opts the optional parameters
     # @return [Variable]
-    def get_variable_by_key(key, user_data, default, opts = {})
+    def variable(key, user_data, default, opts = {})
       if !user_data.is_a?(DevCycle::UserData)
         fail ArgumentError, "user_data param must be an instance of UserData!"
       end
 
       validate_model(user_data)
 
-      data, _status_code, _headers = get_variable_by_key_with_http_info(key, user_data, default, opts)
+      data, _status_code, _headers = variable_with_http_info(key, user_data, default, opts)
       data
     end
 
@@ -120,17 +120,17 @@ module DevCycle
     # @param default Default value for variable if none is retrieved
     # @param [Hash] opts the optional parameters
     # @return [Array<(Variable, Integer, Hash)>] Variable data, response status code and response headers
-    def get_variable_by_key_with_http_info(key, user_data, default, opts = {})
+    def variable_with_http_info(key, user_data, default, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DVCClient.get_variable_by_key ...'
+        @api_client.config.logger.debug 'Calling API: DVCClient.variable ...'
       end
       # verify the required parameter 'key' is set
       if @api_client.config.client_side_validation && key.nil?
-        fail ArgumentError, "Missing the required parameter 'key' when calling DVCClient.get_variable_by_key"
+        fail ArgumentError, "Missing the required parameter 'key' when calling DVCClient.variable"
       end
       # verify the required parameter 'user_data' is set
       if @api_client.config.client_side_validation && user_data.nil?
-        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.get_variable_by_key"
+        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.variable"
       end
       # resource path
       local_var_path = '/v1/variables/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
@@ -161,7 +161,7 @@ module DevCycle
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"DVCClient.get_variable_by_key",
+        :operation => :"DVCClient.variable",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -173,7 +173,7 @@ module DevCycle
       begin 
         data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
         if @api_client.config.debugging
-          @api_client.config.logger.debug "API called: DVCClient#get_variable_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          @api_client.config.logger.debug "API called: DVCClient#variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
         end
         return data
       rescue ApiError => error
@@ -189,14 +189,14 @@ module DevCycle
     # @param user_data [UserData] 
     # @param [Hash] opts the optional parameters
     # @return [Hash<String, Variable>]
-    def get_variables(user_data, opts = {})
+    def all_variables(user_data, opts = {})
       if !user_data.is_a?(DevCycle::UserData)
         fail ArgumentError, "user_data param must be an instance of UserData!"
       end
 
       validate_model(user_data)
       
-      data, _status_code, _headers = get_variables_with_http_info(user_data, opts)
+      data, _status_code, _headers = all_variables_with_http_info(user_data, opts)
       data
     end
 
@@ -204,13 +204,13 @@ module DevCycle
     # @param user_data [UserData] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Hash<String, Variable>, Integer, Hash)>] Hash<String, Variable> data, response status code and response headers
-    def get_variables_with_http_info(user_data, opts = {})
+    def all_variables_with_http_info(user_data, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DVCClient.get_variables ...'
+        @api_client.config.logger.debug 'Calling API: DVCClient.all_variables ...'
       end
       # verify the required parameter 'user_data' is set
       if @api_client.config.client_side_validation && user_data.nil?
-        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.get_variables"
+        fail ArgumentError, "Missing the required parameter 'user_data' when calling DVCClient.all_variables"
       end
       # resource path
       local_var_path = '/v1/variables'
@@ -241,7 +241,7 @@ module DevCycle
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"DVCClient.get_variables",
+        :operation => :"DVCClient.all_variables",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -252,7 +252,7 @@ module DevCycle
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DVCClient#get_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: DVCClient#all_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -261,7 +261,7 @@ module DevCycle
     # @param user_data_and_events_body [UserDataAndEventsBody] 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse201]
-    def track_event(user_data, event_data, opts = {})
+    def track(user_data, event_data, opts = {})
       if !user_data.is_a?(DevCycle::UserData)
         fail ArgumentError, "user_data param must be an instance of UserData!"
       end
@@ -274,7 +274,7 @@ module DevCycle
 
       validate_model(event_data)
 
-      data, _status_code, _headers = track_event_with_http_info(user_data, event_data, opts)
+      data, _status_code, _headers = track_with_http_info(user_data, event_data, opts)
       data
     end
 
@@ -282,7 +282,7 @@ module DevCycle
     # @param user_data_and_events_body [UserDataAndEventsBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(InlineResponse201, Integer, Hash)>] InlineResponse201 data, response status code and response headers
-    def track_event_with_http_info(user_data, event_data, opts = {})
+    def track_with_http_info(user_data, event_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DVCClient.post_events ...'
       end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devcycle-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - DevCycleHQ
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -50,8 +50,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-description: Documents the DevCycle Bucketing API which provides and API interface
-  to User Bucketing and for generated SDKs.
+description: DevCycle Ruby Server SDK, for interacting with feature flags created
+  with the DevCycle platform.
 email:
 - support@devcycle.com
 executables: []
@@ -61,6 +61,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- devcycle-server-sdk-1.0.0.gem
 - devcycle-server-sdk.gemspec
 - docs/DevcycleApi.md
 - docs/ErrorResponse.md
@@ -97,7 +98,7 @@ files:
 - spec/models/user_data_spec.rb
 - spec/models/variable_spec.rb
 - spec/spec_helper.rb
-homepage: https://openapi-generator.tech
+homepage: https://devcycle.com
 licenses:
 - MIT
 metadata: {}