stage-ruby 0.0.02

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fca366a510de64357d0fe5b697797ea9ce0915fbde30e1cbff1c5c0a131a311
+  data.tar.gz: de34dfc043afd1b479f595536a34de81f8bde868e62aa32e7942f2a5980089b0
+SHA512:
+  metadata.gz: 693fae7376e6b09005bc78d00d03450fb1e427a15ed066a562000ddcc244bbe2b9a72c6bd2f44930acbec084d64ebbfa74e9a0b40d07fef6db6a72c1bde0408b
+  data.tar.gz: 28fa37e7a9be6100109ea9b570346a28a5a096450525d742afcc5cfb8d7b42c109773a6090574fb79dead0536ac542315fc64ce5f6a7313ea9b4e5646929b32f

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 1.29.0'
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    stage-ruby (0.0.01)
+      json (~> 2.1, >= 2.1.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)
+    json (2.6.1)
+    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)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    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 (1.29.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 1.29.0)
+  stage-ruby!
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -0,0 +1,143 @@
+# stage-ruby
+
+Stage - the Ruby gem for the Stage API Docs
+
+Stage Technologies, Inc. complete API Documentation
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- `stage-ruby`'s package version: 0.0.01
+- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
+
+For more information, please visit [https://heystage.com](https://heystage.com)
+
+## 1. Installation
+
+### 1.1. Install RVM, Ruby, and Gemsets
+
+1. Install [RVM](http://rvm.io/):
+
+```shell
+gpg --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+\curl -sSL https://get.rvm.io | bash -s stable
+source ~/.rvm/scripts/rvm
+```
+
+2. Install Ruby, and create a gemset:
+
+```shell
+rvm list known
+rvm install 3.0.0
+rvm use 3.0.0
+
+rvm gemset list
+rvm 3.0.0@stage-ruby  --create
+```
+
+From here on, you can activate ruby version 3.0.0 and the `stage-ruby` gemset by running the following:
+
+```shell
+rvm use 3.0.0@stage-ruby
+```
+
+3. Install dependencies:
+
+```shell
+bundle install
+```
+
+### 1.2. Build Gem and Install Locally
+
+1. Build Ruby code into a gem:
+
+```shell
+gem build stage-ruby.gemspec
+```
+
+2. Install the gem locally, where `{VERSION}` is the gem's version number:
+
+```shell
+gem install ./stage-ruby-{VERSION}.gem
+```
+
+## 2. Using `stage-ruby` Gem
+
+To use a locally installed `stage-ruby` gem, add the following to your project's Gemfile, where `{GEM_DIR}` is your
+local gem installation directory (run `rvm gemdir` to find out):
+
+```shell
+gem 'stage-ruby', "~> 0.0.01", :path => '{GEM_DIR}'
+```
+
+To use the `stage-ruby` that's uploaded to a gem service, add the following to your project's Gemfile, where `{VERSION}`
+is the gem's version number:
+
+```
+gem 'stage-ruby', '~> {VERSION}'
+```
+
+### 3. Including `stage-ruby` Code Directly
+
+To run a script that depends on `stage-ruby`'s code in `/lib`, run the following:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## 3. Getting Started
+
+Please follow the [installation](#installation) procedure, and then run the following code:
+
+```ruby
+require 'stage-ruby'
+
+Stage.configure do |config|
+  config.host = 'localhost:8080'
+  config.api_key['Authorization'] = 'YOUR_API_KEY'
+  config.api_key_prefix['Authorization'] = 'stage-api-token'
+end
+
+api_instance = Stage::StageApi.new
+
+begin
+  user_identifier = 'joe@heystage.com'
+  new_user = api_instance.create_user(user_identifier, feature_identifier: 'BASIC_PLAN')
+  p "Created user: #{new_user}"
+
+  result = api_instance.has_access(user_identifier, feature_identifier: 'BASIC_PLAN')
+  p "User #{user_identifier} has access to plan: #{result}"
+
+  updated_user = api_instance.update_user_plan(user_identifier, feature_identifier: 'PRO_PLAN')
+  p "Updated user: #{updated_user}"
+  
+rescue Stage::ApiError => e
+  puts "Exception caught: #{e}"
+end
+```
+
+## 4. Documentation for API Endpoints
+
+| Class             | Method                                                    | HTTP request                                        | Description                                            |
+|-------------------|-----------------------------------------------------------|-----------------------------------------------------|--------------------------------------------------------|
+| *Stage::StageApi* | [**create_user**](docs/StageApi.md#create_user)           | **POST** /sdk-api/v1/users                          | Creates a user and assigning it to a pre-defined role. |
+| *Stage::StageApi* | [**has_access**](docs/StageApi.md#has_access)             | **GET** /sdk-api/v1/users/{userIdentifier}/features | Checks if a user has access to the identified feature. |
+| *Stage::StageApi* | [**update_user_plan**](docs/StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans    | Updates a user's plan..                                |
+
+## 5. Documentation for Models
+
+ - [Stage::AccessFeatureForm](docs/AccessFeatureForm.md)
+ - [Stage::AccessForm](docs/AccessForm.md)
+ - [Stage::ClientUserForm](docs/ClientUserForm.md)
+ - [Stage::ClientUserObjectForm](docs/ClientUserObjectForm.md)
+ - [Stage::Field](docs/Field.md)
+ - [Stage::StageError](docs/StageError.md)
+
+## 6. Documentation for Authorization
+
+### stage-api-token
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccessFeatureForm.md

@@ -0,0 +1,8 @@
+# Stage::AccessFeatureForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_access** | **BOOLEAN** | A boolean value indicating whether the identified user has access to the feature or not. | 
+**identifier** | **String** | The feature identifier. | 
+

data/docs/AccessForm.md

@@ -0,0 +1,9 @@
+# Stage::AccessForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<StageError>**](StageError.md) | The list of any errors. | 
+**features** | [**Array<AccessFeatureForm>**](AccessFeatureForm.md) | The list of features. | 
+**user_identifier** | **String** | The user identifier. | 
+

data/docs/ClientUserForm.md

@@ -0,0 +1,7 @@
+# Stage::ClientUserForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_users** | [**Array<ClientUserObjectForm>**](ClientUserObjectForm.md) | A list of client users. | [optional] 
+

data/docs/ClientUserObjectForm.md

@@ -0,0 +1,13 @@
+# Stage::ClientUserObjectForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**arena_id** | **Integer** | The Arena ID of the client user. | [optional] 
+**created_at** | **DateTime** | The creation date. | [optional] 
+**deleted** | **BOOLEAN** | A boolean value indicating whether the client user is deleted or not. | [optional] 
+**id** | **Integer** | The ID of the client user. | [optional] 
+**identifier** | **String** | A client user identifier. | [optional] 
+**plan_id** | **Integer** | The plan to be assigned to the client user. | [optional] 
+**plan_identifier** | **String** | The plan to be assigned to the user. | [optional] 
+

data/docs/Field.md

@@ -0,0 +1,8 @@
+# Stage::Field
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the field causing the error. | [optional] 
+**value** | **String** | The value of the field causing the error. | [optional] 
+

data/docs/StageApi.md

@@ -0,0 +1,167 @@
+# Stage::StageApi
+
+All URIs are relative to *//localhost:8080/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_user**](StageApi.md#create_user) | **POST** /sdk-api/v1/users | Creates a user and assigning it to a pre-defined role.
+[**has_access**](StageApi.md#has_access) | **GET** /sdk-api/v1/users/{userIdentifier}/features | Checks if a user has access to the identified feature.
+[**update_user_plan**](StageApi.md#update_user_plan) | **PUT** /sdk-api/v1/users/{userIdentifier}/plans | Updates a user's plan..
+
+# **create_user**
+> ClientUserForm create_user(body)
+
+Creates a user and assigning it to a pre-defined role.
+
+### Example
+```ruby
+# load the gem
+require 'stage-ruby'
+# setup authorization
+Stage.configure do |config|
+  # Configure API key authorization: stage-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Stage::StageApi.new
+body = Stage::ClientUserForm.new # ClientUserForm | The payload containing the information to create a user.
+
+
+begin
+  #Creates a user and assigning it to a pre-defined role.
+  result = api_instance.create_user(body)
+  p result
+rescue Stage::ApiError => e
+  puts "Exception when calling StageApi->create_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ClientUserForm**](ClientUserForm.md)| The payload containing the information to create a user. | 
+
+### Return type
+
+[**ClientUserForm**](ClientUserForm.md)
+
+### Authorization
+
+[stage-api-token](../README.md#stage-api-token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **has_access**
+> AccessForm has_access(identifiers, user_identifier)
+
+Checks if a user has access to the identified feature.
+
+### Example
+```ruby
+# load the gem
+require 'stage-ruby'
+# setup authorization
+Stage.configure do |config|
+  # Configure API key authorization: stage-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Stage::StageApi.new
+identifiers = ['identifiers_example'] # Array<String> | identifiers
+user_identifier = 'user_identifier_example' # String | The identifier of the user who is accessing the feature.
+
+
+begin
+  #Checks if a user has access to the identified feature.
+  result = api_instance.has_access(identifiers, user_identifier)
+  p result
+rescue Stage::ApiError => e
+  puts "Exception when calling StageApi->has_access: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifiers** | [**Array&lt;String&gt;**](String.md)| identifiers | 
+ **user_identifier** | **String**| The identifier of the user who is accessing the feature. | 
+
+### Return type
+
+[**AccessForm**](AccessForm.md)
+
+### Authorization
+
+[stage-api-token](../README.md#stage-api-token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_user_plan**
+> ClientUserForm update_user_plan(bodyuser_identifier)
+
+Updates a user's plan..
+
+### Example
+```ruby
+# load the gem
+require 'stage-ruby'
+# setup authorization
+Stage.configure do |config|
+  # Configure API key authorization: stage-api-token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Stage::StageApi.new
+body = Stage::ClientUserForm.new # ClientUserForm | The payload containing the information to update a user's plan. Only identifier and planIdentifier fields are required.
+user_identifier = 'user_identifier_example' # String | The identifier of the user.
+
+
+begin
+  #Updates a user's plan..
+  result = api_instance.update_user_plan(bodyuser_identifier)
+  p result
+rescue Stage::ApiError => e
+  puts "Exception when calling StageApi->update_user_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ClientUserForm**](ClientUserForm.md)| The payload containing the information to update a user&#x27;s plan. Only identifier and planIdentifier fields are required. | 
+ **user_identifier** | **String**| The identifier of the user. | 
+
+### Return type
+
+[**ClientUserForm**](ClientUserForm.md)
+
+### Authorization
+
+[stage-api-token](../README.md#stage-api-token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/StageError.md

@@ -0,0 +1,11 @@
+# Stage::StageError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | The string representation of the HTTP status. | [optional] 
+**field** | [**Field**](Field.md) |  | [optional] 
+**message** | **String** | Additional error messages. | [optional] 
+**status** | **Integer** | The HTTP status of this request. | [optional] 
+**timestamp** | **Integer** |  | [optional] 
+

data/example.rb

@@ -0,0 +1,41 @@
+require 'stage-ruby'
+
+Stage.configure do |config|
+  config.host = 'localhost:8080'
+  config.api_key['Authorization'] = 'fakestageapikey'
+  config.api_key_prefix['Authorization'] = 'stage-api-token'
+end
+
+api_instance = Stage::StageApi.new
+feature_identifier = 'view_arenas'
+feature_identifiers = ['view_arenas', 'edit_arenas']
+user_identifier = 'dennis+1@heystage.com'
+
+begin
+  p "# has_access_verbose #"
+  result = api_instance.has_access_verbose(user_identifier, feature_identifiers)
+  p result
+
+  p "# has_access #"
+  result = api_instance.has_access(user_identifier, feature_identifier)
+  p result
+
+  p "# has_access_to_any #"
+  result = api_instance.has_access_to_any(user_identifier, feature_identifiers)
+  p result
+
+  p "# has_access_to_all #"
+  result = api_instance.has_access_to_all(user_identifier, feature_identifiers)
+  p result
+
+  p "# update_user_plan #"
+  # result = api_instance.update_user_plan(user_identifier, '3-Arena: no permission')
+  result = api_instance.update_user_plan(user_identifier, '5-Arena: edit')
+  p result
+
+  p "# create_user #"
+  result = api_instance.create_user('dennis+3@heystage.com', '3-Arena: no permission')
+  p result
+rescue Stage::ApiError => e
+  puts "Exception when calling StageApi->has_access: #{e}"
+end

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+