school21_api_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f53a4ed9751f4ad38c62dff08811e164694e1b84903847ce98392aa39ae9234
+  data.tar.gz: 46344c76969f24f6cd33d4b7ef9e1983e36e133c6bb258162b94dcb7ded7cc88
+SHA512:
+  metadata.gz: d7bf6101d76b1a93a5510335e0f69a39eac1b8643eb0bbebd716a9b1dace589a1443bc4ef7ee6576c4b1b8e721746bf0b01eaf2888e21c541804bf7b58cfc43e
+  data.tar.gz: fb4698307bc50ef4b896bda5277f556b5146e293042e9dbfec3a52b3a773792514d558c9f2235975813adace83d2ab3e426a250a9bcd1e1d7025b308c4e4ec59

data/LICENSE

@@ -0,0 +1,8 @@
+#        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+#                    Version 2, December 2004
+#
+#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+#
+#  0. You just DO WHAT THE FUCK YOU WANT TO.
+#

data/README.md

@@ -0,0 +1,48 @@
+# School21 API SDK
+
+![](https://github.com/ikael21/school21_api_sdk/actions/workflows/test.yml/badge.svg)
+[![codecov](https://codecov.io/github/ikael21/school21_api_sdk/branch/main/graph/badge.svg?token=O7I31Q7N96)](https://codecov.io/github/ikael21/school21_api_sdk)
+![](https://github.com/ikael21/school21_api_sdk/actions/workflows/rubocop.yml/badge.svg)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add school21_api_sdk
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install school21_api_sdk
+
+## Usage
+
+There are multiple API's method according to School21 OpenAPI Specification. Check https://edu.21-school.ru/docs
+
+```ruby
+require 'school21'
+
+login = 'your_login_here'
+password = 'your_password_here'
+
+client = School21::Client.new(login: login, password: password)
+
+# Example of getting base info about specific School21 participant
+participants_api = client.participants_api
+response = participants_api.participants('ikael@student.21-school.ru')
+
+if response.success?
+  puts response.data
+else
+  # Error handling
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ikael21/school21_api_sdk.

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'school21'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/school21/api/auth_api.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module School21
+  class AuthApi < BaseApi
+    def token(login:, password:)
+      new_request = new_request_builder(HttpMethod::POST, '/token', :auth)
+                    .form_param(new_parameter(login, key: :username))
+                    .form_param(new_parameter(password, key: :password))
+                    .form_param(new_parameter('password', key: :grant_type))
+                    .form_param(new_parameter('s21-open-api', key: :client_id))
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+  end
+end

data/lib/school21/api/base_api.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module School21
+  class BaseApi
+    include CoreLibrary
+
+    SINGLE_AUTH_PARTICIPANT = :global
+
+    def self.base_uri(server)
+      case server
+      when :api_v1
+        'https://edu-api.21-school.ru/services/21-school/api/v1'
+      when :auth
+        'https://auth.sberclass.ru/auth/realms/EduPowerKeycloak/protocol/openid-connect'
+      end
+    end
+
+    def self.response_convertor(api_response)
+      api_response.data.deep_transform_keys! do |key|
+        key.underscore.to_sym
+      end
+
+      api_response
+    end
+
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    def new_api_call_builder = @api_call.new_builder
+
+    def new_response_handler
+      ResponseHandler.new
+                     .deserializer(ApiHelper.method(:json_deserialize))
+                     .is_api_response(true)
+                     .convertor(self.class.method(:response_convertor))
+    end
+
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/school21/api/participants_api.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module School21
+  class ParticipantsApi < BaseApi
+    def participants(login)
+      path = "/participants/#{login}"
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+
+    def participants_projects(login, options: {})
+      path = "/participants/#{login}/projects"
+      default_options = { limit: 1000, offset: 0 }.merge(options)
+
+      parameters = default_options.map do |key, value|
+        new_parameter(value, key:)
+      end
+
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      parameters.each do |parameter|
+        new_request.query_param(parameter)
+      end
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+  end
+end

data/lib/school21/api/projects_api.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module School21
+  class ProjectsApi < BaseApi
+    def projects(project_id)
+      path = "/projects/#{project_id}"
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+
+    def projects_participants(project_id, options: {})
+      path = "/projects/#{project_id}/participants"
+      default_options = { limit: 1000, offset: 0 }.merge(options)
+
+      parameters = default_options.map do |key, value|
+        new_parameter(value, key:)
+      end
+
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      parameters.each do |parameter|
+        new_request.query_param(parameter)
+      end
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+  end
+end

data/lib/school21/auth/access_token.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module School21
+  class AccessToken
+    attr_reader :access_token
+
+    def initialize(access_token, expires_in)
+      @access_token = access_token
+      @expires_at = Time.now + expires_in
+    end
+
+    def expired?
+      Time.now >= @expires_at
+    end
+  end
+end

data/lib/school21/auth/authorization_header.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module School21
+  class AuthorizationHeader < CoreLibrary::HeaderAuth
+    def error_message
+      'BearerAuth: access_token is undefined.'
+    end
+
+    def initialize(bearer_auth_credentials)
+      auth_params = {}
+
+      @access_token = bearer_auth_credentials.access_token unless
+        bearer_auth_credentials.nil? || bearer_auth_credentials.access_token.nil?
+
+      auth_params['Authorization'] = "Bearer #{@access_token}" unless @access_token.nil?
+
+      super(auth_params)
+    end
+  end
+end

data/lib/school21/auth/bearer_auth_credentials.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module School21
+  class BearerAuthCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token.access_token
+    end
+  end
+end

data/lib/school21/client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module School21
+  class Client
+    include CoreLibrary
+
+    def initialize(login:, password:)
+      raise ArgumentError, "login can't be nil or empty" if login.nil? || login.empty?
+      raise ArgumentError, "password can't be nil or empty" if password.nil? || password.empty?
+
+      client_configuration = HttpClientConfiguration.new(logging_configuration:)
+      http_client = FaradayClient.new(client_configuration)
+      client_configuration.set_http_client(http_client)
+
+      @login = login
+      @password = password
+
+      @config = GlobalConfiguration
+                .new(client_configuration:)
+                .base_uri_executor(BaseApi.method(:base_uri))
+
+      initialize_auth!
+    end
+
+    def auth_api = @auth_api ||= AuthApi.new(@config)
+
+    def participants_api
+      initialize_auth! if @access_token.expired?
+
+      ParticipantsApi.new(@config)
+    end
+
+    def projects_api
+      initialize_auth! if @access_token.expired?
+
+      ProjectsApi.new(@config)
+    end
+
+    private
+
+    def initialize_auth!
+      @access_token = request_access_token!
+
+      initialize_auth_managers
+    end
+
+    def initialize_auth_managers
+      auth_managers = {}
+
+      creds = BearerAuthCredentials.new(access_token: @access_token)
+      auth_managers[BaseApi::SINGLE_AUTH_PARTICIPANT] = AuthorizationHeader.new(creds)
+
+      @config.auth_managers(auth_managers)
+    end
+
+    def request_access_token!
+      auth_api_response = auth_api.token(login: @login, password: @password)
+      raise 'Access Token Error' unless auth_api_response.success?
+
+      AccessToken.new(*auth_api_response.data.values_at(:access_token, :expires_in))
+    end
+
+    def logging_configuration
+      headers_to_exclude = ['Authorization']
+      api_request_config = ApiRequestLoggingConfiguration.new(true, true, headers_to_exclude, nil, nil, true)
+      api_response_config = ApiResponseLoggingConfiguration.new(true, true, nil, nil, nil)
+
+      ApiLoggingConfiguration.new(nil, nil, api_request_config, api_response_config, false)
+    end
+  end
+end

data/lib/school21/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module School21
+  VERSION = '0.1.0'
+end

data/lib/school21.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require 'active_support/all'
+
+require_relative 'school21/auth/access_token'
+require_relative 'school21/auth/authorization_header'
+require_relative 'school21/auth/bearer_auth_credentials'
+
+require_relative 'school21/api/base_api'
+require_relative 'school21/api/participants_api'
+require_relative 'school21/api/auth_api'
+require_relative 'school21/api/projects_api'
+
+require_relative 'school21/client'

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov-cobertura'
+
+SimpleCov.start
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'school21'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: school21_api_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Yudin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: apimatic_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: apimatic_core_interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: apimatic_faraday_client_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- ikael.fess@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/school21.rb
+- lib/school21/api/auth_api.rb
+- lib/school21/api/base_api.rb
+- lib/school21/api/participants_api.rb
+- lib/school21/api/projects_api.rb
+- lib/school21/auth/access_token.rb
+- lib/school21/auth/authorization_header.rb
+- lib/school21/auth/bearer_auth_credentials.rb
+- lib/school21/client.rb
+- lib/school21/version.rb
+- test/test_helper.rb
+homepage: https://github.com/ikael21/school21_api_sdk
+licenses:
+- Nonstandard
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: School21 API SDK
+test_files: []