netcity 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24de9d2d19d1e4fbb099524730790458a61d98f2dc75fc139c74b6c86b636b05
-  data.tar.gz: 1fbf557670cebc5faa508d18fde393c26b95c2ae3fcd5dcce1b4c8fb8011b3b2
+  metadata.gz: acf2517bc6c976016890ba1caf76949805d6afec2aa413f3172ba9754cc5b081
+  data.tar.gz: 93806e656f0404d18f6dcea593c80b8de5b5cfe69960291036207a0f4883a31f
 SHA512:
-  metadata.gz: 73002751295a82ab78a9f4af076f2b33fc9307b6af3aff75b4708b604cce17e8d44f54091e6f6f0b35b1bdf3e6c74d4bc01b252402c38feea7953b0a90e94361
-  data.tar.gz: 1713737e21a113d0f0068f0205d3d71df483e719e982e34cdd73904e7df35a27263a0f5abb39d704480c4812f773cb6d384231ee8eaaa3879f97d4439ac23617
+  metadata.gz: 3631c97c268327d2ebef673a49808d7b74c9bed5dae476daaa44c99a527d4f3f1373f6f3f36a4c5b7a6482e438defd8fb7e5ea904a2b11d68d3a214888cba0a3
+  data.tar.gz: 137e08d1f8a1385f06ce3b3ae9be7195e65024be11c6ef0fd5205f159ed0c2e49b73024abf44b8b3cfb1a2ffd34aed4e7069040fdcc272eb6287ea64b71d8d5b

data/README.md

@@ -1,20 +1,46 @@
-# netcity
+<center><h2>netcity</h2></center>
 
 [![Gem Version](https://badge.fury.io/rb/netcity.svg)](https://badge.fury.io/rb/netcity)
 ![Gem](https://img.shields.io/gem/dt/netcity)
 [![License](https://img.shields.io/github/license/tulen34/netcity)](https://github.com/tulen34/netcity/blob/main/LICENSE)
 
-**API** клиент для "Сетевого города". Он позволяет легко взаимодействовать с **электронным дневником**.
+**API** клиент для "Сетевого города". Он позволяет легко взаимодействовать с **электронным дневником**. Клиент разрабатывался изначально для **Волгоградской области**, поэтому, возможно, у вас он **может не работать**.
 
-### Установка
+### :hammer_and_wrench: Установка
 
-```bash
+```sh
 gem install netcity
 ```
 
-### :warning: Внимание 
+Или добавьте в ваш Gemfile эту строку:
 
-Клиент разрабатывался изначально для **Волгоградской области**, поэтому, возможно, у вас он может **не работать**
+```ruby
+gem "http"
+```
+
+### :book: Пример
+
+```ruby
+require 'netcity'
+
+client = NetCity.new('https://sgo.volganet.ru',
+                     'Волгоградская обл',
+                     'Городской округ Волжский',
+                     'Волжский, г.',
+                     'Общеобразовательная',
+                     'МОУ СШ № 123',
+                     'Иванов',
+                     '123456789')
+client.session do |session|
+    puts session.diary
+end
+```
+
+### :footprints: Прогресс разработки
+
+- [x] Авторизация
+- [x] Получение дневника
+- [ ] Получение доски объявлений
 
 ### :love_letter: Благодарность
 

data/lib/netcity/data.rb

@@ -1,21 +1,100 @@
+require 'json'
+require 'date'
+
 class NetCity
-  SchoolAddress = Struct.new(:state, :province, :city, :func, :school)
+  SchoolAddress = Struct.new(:state, 
+                             :province, 
+                             :city, 
+                             :func, 
+                             :school)
+
+  LoginInfo = Struct.new(:school_address,
+                         :user_name,
+                         :password)
+
+  class Diary
+    include Enumerable
+
+    attr_reader :start, :end
+
+    def initialize(hash)
+      @start = hash['weekStart']
+      @end   = hash['weekEnd']
+      @days  = hash['weekDays'].map { |h| Day.new(h) }
+    end
 
-  class Context
-    attr_reader :full_name, :user_id, :year_id
+    def [](index)
+      @days[index]
+    end
 
-    def initialize(data)
-      @full_name = data['user']['name']
-      @user_id   = data['user']['id']
-      @year_id   = data['schoolYearId']
+    def each(&block)
+      @days.each { |lesson| block.call(day) }
     end
   end
 
-  class Diary
-    attr_reader :week_start, :week_end, :schedule
+  class Day
+    include Enumerable
+
+    attr_reader :date
+
+    def initialize(hash)
+      @date    = hash['date']
+      @lessons = hash['lessons'].map { |h| Lesson.new(h) }
+    end
+
+    def [](index)
+      @lessons[index]
+    end
 
-    def initilaize(data)
+    def each(&block)
+      @lessons.each { |lesson| block.call(lesson) }
+    end
+  end
+
+  Assignment = Struct.new(:id, 
+                          :type, 
+                          :name,
+                          :mark,
+                          :deadline)
+
+  class Lesson
+    include Enumerable
+
+    attr_reader :start, :end, :number, :name, :room
+
+    def initialize(hash)
+      @start  = hash['startTime']
+      @end    = hash['endTime']
+      @number = hash['number']
+      @name   = hash['subjectName']
+      @room   = hash['room']
+      return unless hash.include?('assignments')
+
+      @assignments = hash['assignments'].map do |h|
+        Assignment.new.tap do |a|
+          a.id       = h['id']
+          a.type     = h['typeId']
+          a.name     = h['assignmentName']
+          a.mark     = h['mark']['mark'] if h.include?('mark') 
+          a.deadline = h['dueDate']
+        end
+      end
+    end
+
+    def [](index)
+      @assignments[index]
+    end
 
+    def each(&block)
+      @assignments.each { |assignment| block.call(assignment) }
     end
   end
 end
+
+module JSON
+  def parse_diary(source)
+    NetCity::Diary.new(JSON.parse(source))
+  end
+
+  module_function :parse_diary
+end

data/lib/netcity/netcity.rb

@@ -1,23 +1,31 @@
 require 'http'
+require 'date' 
 require 'digest'
 
 class NetCity
-  attr_accessor :client, :user_name, :password, :school_address
-  attr_reader :context
+  attr_accessor :client, :login_info
 
   def initialize(base_url, 
                  state, province, city, func, school, 
                  user_name, password)
-    @client = HTTP["user-agent": "netcity/#{VERSION}", referer: base_url]
+    @client = HTTP['user-agent': "netcity/#{VERSION}", referer: base_url]
       .persistent(base_url)
 
-    @user_name      = user_name
-    @password       = password
-    @school_address = SchoolAddress.new(state, province, city, func, school)
+    @login_info = LoginInfo.new.tap do |l|
+      l.user_name      = user_name
+      l.password       = password
+      l.school_address = SchoolAddress.new(state, province, city, func, school)
+    end
   end
 
-  def diary(options = {})
-
+  def diary(week_start: Date.today - Date.today.wday + 1,
+            week_end: Date.today - Date.today.wday + 6)
+    JSON.parse_diary(@client.get('/webapi/student/diary', params: {
+      'studentId' => @user_id,
+      'weekStart' => week_start.to_s,
+      'weekEnd'   => week_end.to_s,
+      'yearId'    => @year_id
+    }))
   end
 
   def session
@@ -31,21 +39,23 @@ class NetCity
     form = JSON.parse(@client.get('/webapi/prepareloginform')).keep_if do |k|
       %w[cid sid pid cn sft scid].include?(k) 
     end
-
     queue = form
       .keys[...-1]
       .each_index
-      .zip(@school_address.members)
+      .zip(@login_info.school_address.members)
 
     queue.each do |i, member|
       current_form = JSON.parse(@client.get('/webapi/loginform', params: {
-        lastname: form.keys[i]
+        'lastname' => form.keys[i]
       }.merge(form)))
 
       match = current_form['items'].find do |item|
-        item['name'] == @school_address[member]
-      end or raise LoginFormError.new(member, @school_address[member])
+        item['name'] == @login_info.school_address[member]
+      end 
 
+      if match.nil?
+        raise LoginFormError.new(member, @login_info.school_address[member])
+      end
       form.update(form.keys[i + 1] => match['id'])
     end
 
@@ -56,15 +66,15 @@ class NetCity
     end
 
     md5 = Digest::MD5.new.tap do |md5|
-      md5 << data.delete("salt") << Digest::MD5.hexdigest(@password)
+      md5 << data.delete('salt') << Digest::MD5.hexdigest(@login_info.password)
     end.hexdigest
 
     info = {}.tap do |h|
       responce = @client.post('/webapi/login', form: {
-        logintype: 1,
-        un: @user_name,
-        pw: md5[...@password.size],
-        pw2: md5
+        'logintype' => 1,
+        'un'        => @login_info.user_name,
+        'pw'        => md5[...@login_info.password.size],
+        'pw2'       => md5
       }.merge(form, data))
 
       @client = @client.cookies(responce.cookies)
@@ -74,7 +84,9 @@ class NetCity
     raise Error, info['message'] unless info.include?('at')
     @client = @client.headers(at: info['at'])
 
-    @context = Context.new(JSON.parse(@client.get('/webapi/context')))
+    context  = JSON.parse(@client.get('/webapi/context'))
+    @user_id = context['user']['id']
+    @year_id = context['schoolYearId']
     nil
   end
 

data/lib/netcity/version.rb

@@ -1,3 +1,3 @@
 class NetCity
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/netcity.gemspec

@@ -26,9 +26,9 @@ Gem::Specification.new do |s|
     "Gemfile",
     "LICENSE",
     "netcity.gemspec",
-    "README.md",
+    "README.md"
   ]
-  s.executables = s.files.grep(/^bin\/.+/) { |f| File.basename(f) }
+  s.executable  = "netcity"
 
   s.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netcity
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Glushonkov Ilya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies: []
 description: |
   API клиент для "Сетевого города". Он позволяет легко взаимодействовать с