school21_api_sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e94bb6054dc91242b21c99220f3c30931f0b6b24418ef8f0ba140052f2220fb3
-  data.tar.gz: f4fc58b78bfe7a25291cab9f34de83f5361ecd8afc929a500b7bb4958bbb54a2
+  metadata.gz: a8b8fc46a01614de5e5b6cfb19de30d5471eb154d293a02d7eab835f8c2042bd
+  data.tar.gz: ef32e49acfbb13fc44384c0b58b26b3633c1878a6a7c8e5ab86f9eb9efbd1287
 SHA512:
-  metadata.gz: 379828e0c0f1bc42e3d66751ee73db4163fbaf35232d7200aa7fe552f36c08bf2f31dc702aeeac37cd72d0ea02dff01c0c89937f55284115ca10264d88ce9611
-  data.tar.gz: 707c86e1a6fb0bc5b4c92e3f71ed720b3219ddf5c569a5fc4614f7f2c78a96a45356900f6f6df942dad41f89c06ed31cac2e28a6e4caf77f7715bf8ca02657c8
+  metadata.gz: becf9958c2bc4dcc57fb0ecb8d6b0b5473c47b800375c6e70e92c209cb47c569c5759e79d887a3a423cfeac01b3e072936221ce4570daf01302c35fc1f010ef7
+  data.tar.gz: a2fdb94e72a53583d147732ba4971653335c1f9ed2cb6ef0bc74b2a73d42b2632415d327198f3d3e7abb2865bcd1ab5f1fc8289c6162e6bd8c5c030d7bd874f8

data/README.md

@@ -32,15 +32,22 @@ password = 'your_password_here'
 
 client = School21::Client.configure do |config|
   config.credentials = { login: login, password: password }
-  config.enable_logging = true # false by default
+
+  # If you want to log client's requests and responses (turned off by default)
+  config.enable_logging = true
 end
+
+# Request access token from the API server.
+# Access token is stored inside client object and reused for API requests.
+# If access token is expired client will automatically request a new one.
+client.authenticate!
 ```
 
 - 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`
 
 ```ruby
 participants_api = client.participants_api
-response = participants_api.participants('ikael@student.21-school.ru')
+response = participants_api.participant('peer_nickname')
 
 if response.success?
   puts response.data
@@ -57,4 +64,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ikael21/school21_api_sdk.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/ikael21/school21_api_sdk>.

data/lib/school21/api/auth_api.rb

@@ -9,10 +9,7 @@ module School21
                     .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
+      execute_request(new_request)
     end
   end
 end

data/lib/school21/api/base_api.rb

@@ -49,5 +49,18 @@ module School21
                .key(key)
                .value(value)
     end
+
+    def authenticated_request(...)
+      auth_participant = CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT)
+
+      new_request_builder(...).auth(auth_participant)
+    end
+
+    def execute_request(new_request)
+      new_api_call_builder
+        .request(new_request)
+        .response(new_response_handler)
+        .execute
+    end
   end
 end

data/lib/school21/api/campuses_api.rb

@@ -4,64 +4,45 @@ 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_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
-      new_api_call_builder
-        .request(new_request)
-        .response(new_response_handler)
-        .execute
+      execute_request(new_request)
     end
 
-    def campuses_participants(campus_id, options: {})
+    def campus_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))
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
       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
+      execute_request(new_request)
     end
 
-    def campuses_coalitions(campus_id, options: {})
+    def campus_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))
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
       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
+      execute_request(new_request)
     end
 
-    def campuses_clusters(campus_id, options: {})
+    def campus_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))
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
       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
+      execute_request(new_request)
     end
   end
 end

data/lib/school21/api/clusters_api.rb

@@ -2,21 +2,16 @@
 
 module School21
   class ClustersApi < BaseApi
-    def clusters_map(cluster_id, options: {})
+    def cluster_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 = { limit: 50, offset: 0 }.merge(options)
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
       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
+      execute_request(new_request)
     end
   end
 end

data/lib/school21/api/participants_api.rb

@@ -2,32 +2,30 @@
 
 module School21
   class ParticipantsApi < BaseApi
-    def participants(login)
+    def participant(login)
       path = "/participants/#{login}"
-      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
-                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
-      new_api_call_builder
-        .request(new_request)
-        .response(new_response_handler)
-        .execute
+      execute_request(new_request)
     end
 
-    def participants_projects(login, options: {})
+    def participant_projects(login, options: {})
       path = "/participants/#{login}/projects"
       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))
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
       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
+      execute_request(new_request)
+    end
+
+    def participant_project(login, project_id)
+      path = "/participants/#{login}/projects/#{project_id}"
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
+
+      execute_request(new_request)
     end
   end
 end

data/lib/school21/api/projects_api.rb

@@ -2,32 +2,23 @@
 
 module School21
   class ProjectsApi < BaseApi
-    def projects(project_id)
+    def project(project_id)
       path = "/projects/#{project_id}"
-      new_request = new_request_builder(HttpMethod::GET, path, :api_v1)
-                    .auth(CoreLibrary::Single.new(SINGLE_AUTH_PARTICIPANT))
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
-      new_api_call_builder
-        .request(new_request)
-        .response(new_response_handler)
-        .execute
+      execute_request(new_request)
     end
 
-    def projects_participants(project_id, options: {})
+    def project_participants(project_id, options: {})
       path = "/projects/#{project_id}/participants"
       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))
+      new_request = authenticated_request(HttpMethod::GET, path, :api_v1)
 
       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
+      execute_request(new_request)
     end
   end
 end

data/lib/school21/client.rb

@@ -4,96 +4,108 @@ module School21
   class Client
     include CoreLibrary
 
-    def self.configure(&)
-      new(&)
+    attr_reader :config, :access_token
+
+    class << self
+      def configure(&) = new(&)
     end
 
     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 = GlobalConfig
-                .new
-                .base_uri_executor(BaseApi.method(:base_uri))
+      @config = GlobalConfig.new.base_uri_executor(BaseApi.method(:base_uri))
 
       yield(@config)
 
       validate_credentials!
 
-      initialize_logging
+      initialize_logging if @config.enable_logging
 
       http_client = FaradayClient.new(@config.client_configuration)
       @config.client_configuration.set_http_client(http_client)
+    end
+
+    def authenticate!
+      @access_token = request_access_token!
 
-      initialize_auth!
+      initialize_auth_managers
     end
 
     def auth_api
-      @auth_api ||= AuthApi.new(@config)
+      @auth_api ||= AuthApi.new(config)
     end
 
     def participants_api
-      initialize_auth! if @access_token.expired?
-      ParticipantsApi.new(@config)
+      authenticate! if access_token.expired?
+      ParticipantsApi.new(config)
     end
 
     def projects_api
-      initialize_auth! if @access_token.expired?
-      ProjectsApi.new(@config)
+      authenticate! if access_token.expired?
+      ProjectsApi.new(config)
     end
 
     def campuses_api
-      initialize_auth! if @access_token.expired?
-      CampusesApi.new(@config)
+      authenticate! if access_token.expired?
+      CampusesApi.new(config)
     end
 
     def clusters_api
-      initialize_auth! if @access_token.expired?
-      ClustersApi.new(@config)
+      authenticate! if access_token.expired?
+      ClustersApi.new(config)
     end
 
     private
 
     def validate_credentials!
-      login = @config.credentials[:login]
-      password = @config.credentials[:password]
+      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!
-
-      initialize_auth_managers
-    end
-
     def initialize_auth_managers
       auth_managers = {}
-
-      creds = BearerAuthCredentials.new(access_token: @access_token)
+      creds = BearerAuthCredentials.new(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: @config.credentials[:login], password: @config.credentials[: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 semantic_logger
+      SemanticLogger.default_level = :trace
+      SemanticLogger.add_appender(io: $stdout, formatter: :color)
+
+      SemanticLogger[self.class.to_s]
+    end
+
     def initialize_logging
-      return unless @config.enable_logging
+      logger = if config.logger.nil?
+                 semantic_logger
+               else
+                 config.logger
+               end
 
       headers_to_exclude = ['Authorization']
-      api_logging_config = ApiLoggingConfig.new(nil, nil, nil, nil, false)
+      api_logging_config = ApiLoggingConfig.new(logger, 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)
 
-      @config.client_configuration.logging_configuration = api_logging_config
+      config.client_configuration.logging_configuration = api_logging_config
     end
   end
 end

data/lib/school21/config/global_config.rb

@@ -2,7 +2,7 @@
 
 module School21
   class GlobalConfig < CoreLibrary::GlobalConfiguration
-    attr_accessor :auth_managers, :enable_logging, :credentials
+    attr_accessor :auth_managers, :enable_logging, :credentials, :logger
     attr_writer :client_configuration
 
     def initialize(client_configuration: ClientConfig.new)

data/lib/school21/version.rb

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

data/lib/school21.rb

@@ -2,6 +2,7 @@
 
 require 'apimatic_core'
 require 'apimatic_faraday_client_adapter'
+require 'semantic_logger'
 
 require 'active_support/all'
 

data/test/client_test.rb

@@ -34,7 +34,7 @@ describe 'Client Test' do
   it 'successfully stubs client auth' do
     stub = stub_token
 
-    valid_init_client
+    valid_init_client.authenticate!
 
     assert_requested(stub)
   end

data/test/support/stubs/base_stub.rb

@@ -2,5 +2,5 @@
 
 module BaseStub
   BASE_AUTH_URL = 'https://auth.sberclass.ru'
-  API_V1_URL = 'https://edu-api.21-school.ru/services/21-school/api/v1'
+  BASE_API_V1_URL = 'https://edu-api.21-school.ru/services/21-school/api/v1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: school21_api_sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Anton Yudin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  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