manabu 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e858021472f03b2d532caf72061380aeabe89a644faae4471492496604ac48
-  data.tar.gz: 176b6bdba3acfb636ecd2c6d71b67e16ae6e833bc759d5b8cd2742b812171643
+  metadata.gz: 4d0d8774904775b780856094912549fe8e73842344fa9ed1abf2367eb6d3f432
+  data.tar.gz: 607865e224db1f430b3e317bfced10d724457ec7c0500a71ce6bf71390f7e1ff
 SHA512:
-  metadata.gz: 306735afa0cf37124823c0feb56e445822667423e6c2ad460d6a3781ce266944b840b5b9c2ec5eaaeb1fc639cdd8b6c0eed4fea400a894b8e79edf9dad962b14
-  data.tar.gz: 31653b603f44ed4a2c69cc4545eb4002f81e956cb2874b1f165710d8d9a3b5aa108fbd1c1ebf55730c6f78f55ca3076bfa7436aa9f04c500cd9e32e333161f9f
+  metadata.gz: 5edabccb9131aa2a723b57acb03c92268677cd62534b99cc4fc900156a92da92802c711d05bab9daf73615ac9e78b8a8d88cd37ea825e145afe4b1de09553384
+  data.tar.gz: 9a827582764ffc1856e251bb980bfc8a76d7c3a244f51b11e9dfd4401f3a93ef559708582d7fd5339b30c1bcc9d2a091bc8826760cee872fb43bfc2885099569

data/lib/manabu/client.rb

@@ -33,6 +33,10 @@ module Manabu
       end
     end
 
+    def simple_get(endpoint)
+      @transactor.simple_get(endpoint)
+    end
+
     # Performs a GET against the API
     #
     # == Parameters:

data/lib/manabu/connection/auth.rb

@@ -27,6 +27,10 @@ module Manabu
 
       end
 
+      def full_host
+        @transactor.full_host
+      end
+
       def _authenticate(username, password)
         response = @transactor.post("authenticate", username: username, password: password)
         @connection = true

data/lib/manabu/connection/transactor.rb

@@ -21,7 +21,7 @@ module Manabu
         @status = :unknown
         @force_secure_connection = force_secure_connection
         @options = options
-        @api_version = options[:api_version] || 1
+        @api_version = options.fetch(:api_version, 1)
         connect
         _check_server_status
       end
@@ -29,6 +29,7 @@ module Manabu
       def connect()
         return @connection if @connection
         @connection = Faraday.new do |conn|
+          conn.request :multipart
           conn.request :url_encoded
 
           case @transport_type
@@ -50,6 +51,10 @@ module Manabu
         _check_server_status
       end
 
+      def simple_get(endpoint)
+        Faraday.get("#{full_host}/api/v#{@api_version}/#{endpoint}")
+      end
+
       # Gets data from the server
       def get(endpoint, **args)
         _define_action(:get, endpoint, args)
@@ -68,11 +73,15 @@ module Manabu
         _define_action(:delete, endpoint, args)
       end
 
+      def full_host
+        "#{@protocol}://#{@server_url}:#{@server_port}"
+      end
+
       def _define_action(action, endpoint, args)
         response = connect.send(
           action,
           URI.encode(
-            "#{@protocol}://#{@server_url}:#{@server_port}/api/v#{@api_version}/#{endpoint}"),
+            "#{full_host}/api/v#{@api_version}/#{endpoint}"),
             args,
             _header_hash
           )

data/lib/manabu/contact.rb

@@ -0,0 +1,16 @@
+require_relative './resource'
+
+module Manabu
+  class Contact < Resource
+    attr_accessor :id, :data, :contact_type_id
+
+    def fill(**info)
+      @id = info.fetch(:id, @id)
+      @data = info.fetch(:data, @data)
+      @contact_type_id = info.fetch(:contact_type_id, @contact_type_id)
+
+      self
+    end
+
+  end
+end

data/lib/manabu/contact_types.rb

@@ -0,0 +1,26 @@
+module Manabu
+  class ContactTypes
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+      @contact_types = {}
+    end
+
+    def register(name)
+      response = @client.post("/contact_types", name: name)
+      response[:id]
+    rescue
+      nil
+    end
+
+    def all
+      return @contact_types unless @contact_types.empty?
+
+      response = @client.get("/contact_types")
+      @contact_types = response[:contact_types].each_with_object({}) do |type, obj|
+        obj[type[:name]] = type[:id]
+      end
+    end
+  end
+end

data/lib/manabu/enrollment_status.rb

@@ -0,0 +1,14 @@
+module Manabu
+  class EnrollmentStatus < Resource
+    attr_reader :id, :active, :code, :immutable
+
+    def fill(**info)
+      @id = info.fetch(:id, @id)
+      @code = info.fetch(:code, @code)
+      @active = info.fetch(:active, @active)
+      @immutable = info.fetch(:immutable, @immutable)
+      self
+    end
+
+  end
+end

data/lib/manabu/enrollment_statuses.rb

@@ -0,0 +1,21 @@
+require_relative 'enrollment_status'
+module Manabu
+  class EnrollmentStatuses
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+      @enrollment_statuses = []
+    end
+
+    def all
+      return @enrollment_statuses unless @enrollment_statuses.empty?
+
+      response = @client.get("/enrollment_statuses")
+
+      @enrollment_statuses =  response.map do |enrollment_status|
+        Manabu::EnrollmentStatus.new(@client, enrollment_status)
+      end
+    end
+  end
+end

data/lib/manabu/student.rb

@@ -1,11 +1,22 @@
+require 'filemagic'
 require_relative './resource'
 require_relative './guardian'
+require_relative './enrollment_status'
+require_relative './contact'
 
 module Manabu
   class Student < Resource
     class GuardianNotAdded < StandardError; end
+    class ContactNotAdded < StandardError; end
     attr_accessor :id, :surname, :name, :name_reading,
-                    :surname_reading, :birth_date, :gender
+                    :surname_reading, :middle_name,
+                    :middle_name_reading,:birth_date, :gender, :enrollment_status
+
+    def initialize(client, **info)
+      super
+      @contacts = []
+      @picture = nil
+    end
 
     def fill(**info)
       @id = info.fetch(:id, @id)
@@ -15,15 +26,31 @@ module Manabu
       @surname_reading = info.fetch(:surname_reading, @surname_reading)
       @birth_date = info.fetch(:birth_date, @birth_date)
       @gender = info.fetch(:gender, @gender)
-
+      @enrollment_status = Manabu::EnrollmentStatus.new(@client, info[:enrollment_status] || {})
       self
     end
 
+    def picture
+      return unless @id
+      return @picture if @picture
+
+      response = @client.simple_get("students/#{id}/picture")
+      @picture = response.body
+    end
+
     def set(**info)
       response = @client.patch("students/#{@id}", info)
       fill(response)
     end
 
+    def add_picture(path)
+      file = Faraday::UploadIO.new(path, FileMagic.new(FileMagic::MAGIC_MIME).file(path))
+
+      response = @client.patch("students/#{@id}", picture: file)
+      @picture = nil
+      fill(response)
+    end
+
     def add_guardian(guardian)
       # NOTE: detect when guardian is already added to student
       response = @client.post("students/#{id}/student_guardians", guardian_id: guardian.id)
@@ -32,6 +59,17 @@ module Manabu
       raise GuardianNotAdded, 'Guardian is not added to student'
     end
 
+    def add_contact(contact_type_id, data)
+      response = @client.post("students/#{id}/contacts",
+        contact_type_id: contact_type_id,
+        data: data
+      )
+      @contacts.push Contact.new(@client, response)
+      self
+    # rescue StandardError
+      # raise ContactNotAdded, 'Contact is not added to student'
+    end
+
     def guardians
       response = @client.get("students/#{id}/guardians")
       response[:guardians].map do |guardian|

data/lib/manabu/students.rb

@@ -34,6 +34,14 @@ module Manabu
       end
     end
 
+    def filter(attrs = {})
+      result = students.dup
+      if attrs.has_key?(:enrollment_status)
+        result.select! { |student| student.enrollment_status&.code == attrs[:enrollment_status]  }
+      end
+      result
+    end
+
     def register(student)
       new_student = case student
       when Manabu::Student
@@ -73,8 +81,8 @@ module Manabu
       end
     end
 
-    def whitelist_filter_attributes()
-      [:name, :surname]
+    def whitelist_filter_attributes
+      [:id, :name, :surname]
     end
 
     def _fetch_students()

data/manabu.gemspec

@@ -1,18 +1,18 @@
 Gem::Specification.new do |s|
   s.name          = 'manabu'
-  s.version       = '0.0.3'
+  s.version       = '0.0.4'
   s.licenses      = ['AGPL-3.0', 'GPL-3.0']
   s.summary       = 'API client for GAKU Engine'
   s.description   = 'Manabu is an API client module used to access the GAKU Engine API'
   s.post_install_message =  \
-    '╔═════════════════════════╼' +
-    "║Manabu API Client for ⚙学 GAKU Engine [学エンジン] " +
-    '╟─────────────────────────╼' +
-    '║©2015 (株)幻創社 [Phantom Creation Inc.]' +
-    '║http://www.gakuengine.com' +
-    '╟─────────────────────────╼' +
-    '║Manabu is Open Sourced under the AGPLv3/GPLv3.' +
-    '╚═════════════════════════╼' 
+    "╔═════════════════════════╼\n" +
+    "║Manabu API Client for ⚙学 GAKU Engine [学エンジン] \n" +
+    "╟─────────────────────────╼\n" +
+    "║©2015 (株)幻創社 [Phantom Creation Inc.]\n" +
+    "║http://www.gakuengine.com\n" +
+    "╟─────────────────────────╼\n" +
+    "║Manabu is Open Sourced under the AGPLv3/GPLv3.\n" +
+    "╚═════════════════════════╼\n"
   s.authors       = ['Rei Kagetsuki']
   s.email         = 'info@gakuengine.com'
   s.homepage      = 'http://www.gakuengine.com'
@@ -25,5 +25,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday_middleware', '~> 0.12', '~> 0.12.2'
   s.add_dependency 'typhoeus', '~> 1.3', '~> 1.3.0'
   s.add_dependency 'msgpack', '~> 1.2', '~> 1.2.2'
-  s.add_development_dependency 'gaku', '~> 0.3.0', '~> 0.3.0.pre.4'
+  s.add_dependency 'ruby-filemagic'
+  s.add_development_dependency 'gaku', '~> 0.3', '~> 0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manabu
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Rei Kagetsuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -90,26 +90,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  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: gaku
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0.pre.4
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0.pre.4
+        version: 0.3.0
 description: Manabu is an API client module used to access the GAKU Engine API
 email: info@gakuengine.com
 executables: []
@@ -123,8 +137,12 @@ files:
 - lib/manabu/connection/auth.rb
 - lib/manabu/connection/error.rb
 - lib/manabu/connection/transactor.rb
+- lib/manabu/contact.rb
+- lib/manabu/contact_types.rb
 - lib/manabu/course.rb
 - lib/manabu/courses.rb
+- lib/manabu/enrollment_status.rb
+- lib/manabu/enrollment_statuses.rb
 - lib/manabu/guardian.rb
 - lib/manabu/resource.rb
 - lib/manabu/student.rb
@@ -136,9 +154,9 @@ licenses:
 - AGPL-3.0
 - GPL-3.0
 metadata: {}
-post_install_message: "╔═════════════════════════╼║Manabu API Client for ⚙学 GAKU Engine
-  [学エンジン] ╟─────────────────────────╼║©2015 (株)幻創社 [Phantom Creation Inc.]║http://www.gakuengine.com╟─────────────────────────╼║Manabu
-  is Open Sourced under the AGPLv3/GPLv3.╚═════════════════════════╼"
+post_install_message: "╔═════════════════════════╼\n║Manabu API Client for ⚙学 GAKU
+  Engine [学エンジン] \n╟─────────────────────────╼\n║©2015 (株)幻創社 [Phantom Creation Inc.]\n║http://www.gakuengine.com\n╟─────────────────────────╼\n║Manabu
+  is Open Sourced under the AGPLv3/GPLv3.\n╚═════════════════════════╼\n"
 rdoc_options: []
 require_paths:
 - lib