unienv_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ef0257ec3ffbcb4d0b412000d9f53d4c1d0fa871e8d18e501cc4135f9235193
+  data.tar.gz: 2821ca07f44585f0bd596e00466fbc7b508cb48e88c19a5cf868ceb923d38dde
+SHA512:
+  metadata.gz: 61e2bad048c35e02924aaa274546d7b8a208b271c70bcca0c857abe4cccaf073d6b32b4cda797854d0d10e63cb236b4765c600e4fdc36e4e22aa22139f3badbe
+  data.tar.gz: bd923657fd644d971bb5b5d8b47a5dfc7bfa490be17338614f94ad911104c1a2a9aea8d4607930773a7035af4fb0a48483b11a9746fc4f3ad5c008f9e8e555ae

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 (30-Oct-21)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+Copyright (c) 2021 UniEnvAPI, Gizatullin Amirkhan
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# unienv_api
+
+## Быстрый старт
+**Гем UniEnv** - устанавливаемый из пакетного менеджера модуль, который позволяет взаимодействовать с платформой UniEnv: производить авторизацию пользователей через OAuth и выполнять API запросы.
+
+
+```ruby 
+        require 'unienv_api'
+        
+        # Авторизация
+        @unienv = UniEnv.new(client_id, client_secret, redirect_uri)
+        
+        # получение ссылки
+        auth_url = @unienv.authorize
+        
+        # получение токена
+        token = @unienv.get_token(code)
+        
+        # отзыв токена
+        re_token = @unienv.revoke_token
+        
+        # получение нового токена
+        new_token = auth.refresh_token
+        
+        # API        
+        # получение профиля
+        profile = @unienv.get_profile
+```
+
+
+## Авторизация
+Реализованы следующие методы:
++ `authorize` - возвращает ссылку для переадресации пользователя на страницу авторизации
++ `get_token(code)` - получение access token c дополнительными данными для выполнения следующих запросов
++ `revoke_token`  - отзыв токена (выход)
++ `refresh_token` - обновление токена
+
+## API
+Реализованы методы для обращения к API UniEnv
+Методы сгенерировались на основе документации в формате OpenAPI (Swagger):
++ `get_profile` - получение профиля

data/lib/api_gen/README.md

@@ -0,0 +1,103 @@
+# swagger_client
+
+SwaggerClient - the Ruby gem for the UniEnv Core API
+
+Документация по API UniEnv
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build swagger_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./swagger_client-1.0.0.gem
+```
+(for development, run `gem install --dev ./swagger_client-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 'swagger_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'swagger_client'
+
+# Setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ProfileApi.new
+
+opts = { 
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56 # Integer | The initial index from which to return the results.
+}
+
+begin
+  #Получение профиля
+  result = api_instance.profile_get(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ProfileApi->profile_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://uenv-core.kpfu.ru/api/v1.0/*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SwaggerClient::ProfileApi* | [**profile_get**](docs/ProfileApi.md#profile_get) | **GET** /profile/ | Получение профиля
+
+
+## Documentation for Models
+
+ - [SwaggerClient::Group](docs/Group.md)
+ - [SwaggerClient::Institute](docs/Institute.md)
+ - [SwaggerClient::Profile](docs/Profile.md)
+
+
+## Documentation for Authorization
+
+
+### Basic
+
+- **Type**: HTTP basic authentication
+

data/lib/api_gen/docs/Group.md

@@ -0,0 +1,12 @@
+# SwaggerClient::Group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**title** | **String** |  | 
+**start_year** | **Integer** |  | [optional] 
+**end_year** | **Integer** |  | [optional] 
+**current_course** | **String** | Номер курса | [optional] 
+
+

data/lib/api_gen/docs/Institute.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Institute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**title** | **String** |  | 
+**short_title** | **String** |  | [optional] 
+
+

data/lib/api_gen/docs/Profile.md

@@ -0,0 +1,17 @@
+# SwaggerClient::Profile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**email** | **String** |  | [optional] 
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**middle_name** | **String** |  | [optional] 
+**role** | **String** |  | [optional] 
+**student_group** | [**Group**](Group.md) |  | [optional] 
+**institute** | [**Institute**](Institute.md) |  | 
+**photo_url** | **String** |  | [optional] 
+**gitlab_auth_time** | **String** | Авторизация в Gitlab: дата последней авторизации или null, если авторизации еще не было | [optional] 
+
+

data/lib/api_gen/docs/ProfileApi.md

@@ -0,0 +1,65 @@
+# SwaggerClient::ProfileApi
+
+All URIs are relative to *http://uenv-core.kpfu.ru/api/v1.0/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**profile_get**](ProfileApi.md#profile_get) | **GET** /profile/ | Получение профиля
+
+
+# **profile_get**
+> Profile profile_get(opts)
+
+Получение профиля
+
+
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ProfileApi.new
+
+opts = { 
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56 # Integer | The initial index from which to return the results.
+}
+
+begin
+  #Получение профиля
+  result = api_instance.profile_get(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ProfileApi->profile_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+
+### Return type
+
+[**Profile**](Profile.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/lib/api_gen/lib/swagger_client/api/profile_api.rb

@@ -0,0 +1,77 @@
+=begin
+#UniEnv Core API
+
+#Документация по API UniEnv
+
+OpenAPI spec version: v1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.24-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module SwaggerClient
+  class ProfileApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Получение профиля
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @return [Profile]
+    def profile_get(opts = {})
+      data, _status_code, _headers = profile_get_with_http_info(opts)
+      data
+    end
+
+    # Получение профиля
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @return [Array<(Profile, Fixnum, Hash)>] Profile data, response status code and response headers
+    def profile_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_get ...'
+      end
+      # resource path
+      local_var_path = '/profile/'
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # 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 = ['Basic']
+      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 => 'Profile')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProfileApi#profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end