school21_api_sdk 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f53a4ed9751f4ad38c62dff08811e164694e1b84903847ce98392aa39ae9234
-  data.tar.gz: 46344c76969f24f6cd33d4b7ef9e1983e36e133c6bb258162b94dcb7ded7cc88
+  metadata.gz: e94bb6054dc91242b21c99220f3c30931f0b6b24418ef8f0ba140052f2220fb3
+  data.tar.gz: f4fc58b78bfe7a25291cab9f34de83f5361ecd8afc929a500b7bb4958bbb54a2
 SHA512:
-  metadata.gz: d7bf6101d76b1a93a5510335e0f69a39eac1b8643eb0bbebd716a9b1dace589a1443bc4ef7ee6576c4b1b8e721746bf0b01eaf2888e21c541804bf7b58cfc43e
-  data.tar.gz: fb4698307bc50ef4b896bda5277f556b5146e293042e9dbfec3a52b3a773792514d558c9f2235975813adace83d2ab3e426a250a9bcd1e1d7025b308c4e4ec59
+  metadata.gz: 379828e0c0f1bc42e3d66751ee73db4163fbaf35232d7200aa7fe552f36c08bf2f31dc702aeeac37cd72d0ea02dff01c0c89937f55284115ca10264d88ce9611
+  data.tar.gz: 707c86e1a6fb0bc5b4c92e3f71ed720b3219ddf5c569a5fc4614f7f2c78a96a45356900f6f6df942dad41f89c06ed31cac2e28a6e4caf77f7715bf8ca02657c8

data/README.md

@@ -1,22 +1,28 @@
 # School21 API SDK
 
-![](https://github.com/ikael21/school21_api_sdk/actions/workflows/test.yml/badge.svg)
+![test](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)
+![rubocop](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
+```bash
+bundle add school21_api_sdk
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install school21_api_sdk
+```bash
+gem install school21_api_sdk
+```
 
 ## Usage
 
-There are multiple API's method according to School21 OpenAPI Specification. Check https://edu.21-school.ru/docs
+Please check [docs](https://edu.21-school.ru/docs) for more information.
+
+- Require the gem and configure client object
 
 ```ruby
 require 'school21'
@@ -24,9 +30,15 @@ require 'school21'
 login = 'your_login_here'
 password = 'your_password_here'
 
-client = School21::Client.new(login: login, password: password)
+client = School21::Client.configure do |config|
+  config.credentials = { login: login, password: password }
+  config.enable_logging = true # false by default
+end
+```
+
+- Select the domain specific API that you want to use. This API has all endpoints related to that domain. Here's an example of `Participant API` and a call to `/participants/:login`
 
-# Example of getting base info about specific School21 participant
+```ruby
 participants_api = client.participants_api
 response = participants_api.participants('ikael@student.21-school.ru')
 

data/lib/school21/api/campuses_api.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module School21
+  class CampusesApi < BaseApi
+    def campuses
+      path = '/campuses'
+      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 campuses_participants(campus_id, options: {})
+      path = "/campuses/#{campus_id}/participants"
+      default_options = { limit: 50, offset: 0 }.merge(options)
+
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      default_options.each do |key, value|
+        new_request.query_param(new_parameter(value, key:))
+      end
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+
+    def campuses_coalitions(campus_id, options: {})
+      path = "/campuses/#{campus_id}/coalitions"
+      default_options = { limit: 50, offset: 0 }.merge(options)
+
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      default_options.each do |key, value|
+        new_request.query_param(new_parameter(value, key:))
+      end
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+
+    def campuses_clusters(campus_id, options: {})
+      path = "/campuses/#{campus_id}/clusters"
+      default_options = { limit: 50, offset: 0 }.merge(options)
+
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      default_options.each do |key, value|
+        new_request.query_param(new_parameter(value, key:))
+      end
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+  end
+end

data/lib/school21/api/clusters_api.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module School21
+  class ClustersApi < BaseApi
+    def clusters_map(cluster_id, options: {})
+      path = "/clusters/#{cluster_id}/map"
+      default_options = { limit: 50, offset: 0, occupied: true }.merge(options)
+
+      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
+                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+
+      default_options.each do |key, value|
+        new_request.query_param(new_parameter(value, key:))
+      end
+
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
+  end
+end

data/lib/school21/api/participants_api.rb

@@ -15,17 +15,13 @@ module School21
 
     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
+      default_options = { limit: 10, offset: 0 }.merge(options)
 
       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)
+      default_options.each do |key, value|
+        new_request.query_param(new_parameter(value, key:))
       end
 
       new_api_call_builder

data/lib/school21/api/projects_api.rb

@@ -15,17 +15,13 @@ module School21
 
     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
+      default_options = { limit: 10, offset: 0 }.merge(options)
 
       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)
+      default_options.each do |key, value|
+        new_request.query_param(new_parameter(value, key:))
       end
 
       new_api_call_builder

data/lib/school21/client.rb

@@ -4,40 +4,64 @@ 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)
+    def self.configure(&)
+      new(&)
+    end
 
-      @login = login
-      @password = password
+    def initialize(&block)
+      raise 'A block must be given' unless block_given?
+      raise 'You must provide block argument that represents config instance' if block.arity != 1
 
-      @config = GlobalConfiguration
-                .new(client_configuration:)
+      @config = GlobalConfig
+                .new
                 .base_uri_executor(BaseApi.method(:base_uri))
 
+      yield(@config)
+
+      validate_credentials!
+
+      initialize_logging
+
+      http_client = FaradayClient.new(@config.client_configuration)
+      @config.client_configuration.set_http_client(http_client)
+
       initialize_auth!
     end
 
-    def auth_api = @auth_api ||= AuthApi.new(@config)
+    def auth_api
+      @auth_api ||= AuthApi.new(@config)
+    end
 
     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
 
+    def campuses_api
+      initialize_auth! if @access_token.expired?
+      CampusesApi.new(@config)
+    end
+
+    def clusters_api
+      initialize_auth! if @access_token.expired?
+      ClustersApi.new(@config)
+    end
+
     private
 
+    def validate_credentials!
+      login = @config.credentials[:login]
+      password = @config.credentials[:password]
+
+      raise "Login can't be nil or empty" if login.nil? || login.empty?
+      raise "Password can't be nil or empty" if password.nil? || password.empty?
+    end
+
     def initialize_auth!
       @access_token = request_access_token!
 
@@ -50,22 +74,26 @@ module School21
       creds = BearerAuthCredentials.new(access_token: @access_token)
       auth_managers[BaseApi::SINGLE_AUTH_PARTICIPANT] = AuthorizationHeader.new(creds)
 
-      @config.auth_managers(auth_managers)
+      @config.auth_managers = auth_managers
     end
 
     def request_access_token!
-      auth_api_response = auth_api.token(login: @login, password: @password)
+      auth_api_response = auth_api.token(login: @config.credentials[:login], password: @config.credentials[: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
+    def initialize_logging
+      return unless @config.enable_logging
+
       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)
+      api_logging_config = ApiLoggingConfig.new(nil, nil, nil, nil, false)
+      api_logging_config.request_logging_config = ApiRequestLoggingConfiguration.new(true, true, headers_to_exclude,
+                                                                                     nil, nil, true)
+      api_logging_config.response_logging_config = ApiResponseLoggingConfiguration.new(true, true, nil, nil, nil)
 
-      ApiLoggingConfiguration.new(nil, nil, api_request_config, api_response_config, false)
+      @config.client_configuration.logging_configuration = api_logging_config
     end
   end
 end

data/lib/school21/config/api_logging_config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module School21
+  class ApiLoggingConfig < CoreLibrary::ApiLoggingConfiguration
+    attr_writer :request_logging_config, :response_logging_config
+  end
+end

data/lib/school21/config/client_config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module School21
+  class ClientConfig < CoreLibrary::HttpClientConfiguration
+    attr_writer :logging_configuration, :timeout
+  end
+end

data/lib/school21/config/global_config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module School21
+  class GlobalConfig < CoreLibrary::GlobalConfiguration
+    attr_accessor :auth_managers, :enable_logging, :credentials
+    attr_writer :client_configuration
+
+    def initialize(client_configuration: ClientConfig.new)
+      super
+
+      @enable_logging = false
+      @credentials = {}
+    end
+  end
+end

data/lib/school21/version.rb

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

data/lib/school21.rb

@@ -13,5 +13,11 @@ 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/api/campuses_api'
+require_relative 'school21/api/clusters_api'
+
+require_relative 'school21/config/api_logging_config'
+require_relative 'school21/config/client_config'
+require_relative 'school21/config/global_config'
 
 require_relative 'school21/client'

data/test/client_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe 'Client Test' do
+  include AuthStub
+
+  before do
+    @login = 'login'
+    @password = 'password'
+  end
+
+  let(:valid_init_client) do
+    School21::Client.configure do |config|
+      config.credentials = { login: @login, password: @password }
+      config.enable_logging = false
+    end
+  end
+
+  let(:init_client_without_login) do
+    School21::Client.configure do |config|
+      config.credentials = { login: nil, password: @password }
+      config.enable_logging = false
+    end
+  end
+
+  let(:init_client_without_password) do
+    School21::Client.configure do |config|
+      config.credentials = { login: @login, password: nil }
+      config.enable_logging = false
+    end
+  end
+
+  it 'successfully stubs client auth' do
+    stub = stub_token
+
+    valid_init_client
+
+    assert_requested(stub)
+  end
+
+  it 'raises an exception without login' do
+    stub = stub_token
+
+    assert_raises(RuntimeError, "Login can't be nil or empty") do
+      init_client_without_login
+    end
+
+    refute_requested(stub)
+  end
+
+  it 'raises an exception without password' do
+    stub = stub_token
+
+    assert_raises(RuntimeError, "Password can't be nil or empty") do
+      init_client_without_password
+    end
+
+    refute_requested(stub)
+  end
+end

data/test/support/stubs/auth_stub.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module AuthStub
+  include BaseStub
+
+  def stub_token
+    body = {
+      access_token: 'access_token',
+      expires_in: 36_000
+    }
+
+    stub_request(:post, stubbed_auth_url).to_return_json(body:)
+  end
+
+  private
+
+  def stubbed_auth_url
+    [BASE_AUTH_URL, '/auth/realms/EduPowerKeycloak/protocol/openid-connect/token'].join
+  end
+end

data/test/support/stubs/base_stub.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BaseStub
+  BASE_AUTH_URL = 'https://auth.sberclass.ru'
+  API_V1_URL = 'https://edu-api.21-school.ru/services/21-school/api/v1'
+end

data/test/test_helper.rb

@@ -2,6 +2,10 @@
 
 require 'simplecov'
 require 'simplecov-cobertura'
+require 'webmock/minitest'
+
+require_relative 'support/stubs/base_stub'
+require_relative 'support/stubs/auth_stub'
 
 SimpleCov.start
 SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
@@ -10,3 +14,6 @@ $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'school21'
 require 'minitest/autorun'
+require 'minitest/reporters'
+
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: school21_api_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton Yudin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-03 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,13 +94,21 @@ files:
 - lib/school21.rb
 - lib/school21/api/auth_api.rb
 - lib/school21/api/base_api.rb
+- lib/school21/api/campuses_api.rb
+- lib/school21/api/clusters_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/config/api_logging_config.rb
+- lib/school21/config/client_config.rb
+- lib/school21/config/global_config.rb
 - lib/school21/version.rb
+- test/client_test.rb
+- test/support/stubs/auth_stub.rb
+- test/support/stubs/base_stub.rb
 - test/test_helper.rb
 homepage: https://github.com/ikael21/school21_api_sdk
 licenses:
@@ -122,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: School21 API SDK