mumukit-platform 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a6a060c216d2ab7dcae48ff7d9301e711e83d21ce0259401ac9982eb6cffc15
-  data.tar.gz: ae565a64db783ddfd919773d4a59142ee2f3943dc3562cb8b225fe99723b4dc8
+  metadata.gz: a00ec1f20246a0081a57e61844c352e4bc14b16b61d593cdebd496f1b8712852
+  data.tar.gz: 07307e831a3c64c6292f28e22fe3fcb4f9d1009f29c602c552e5bd6f113137af
 SHA512:
-  metadata.gz: 26b62658bb879bb9d467b1c0a8502c9166af67d9b4db3964c0ef4389dc145f7410e40d9d3ca8be964a1375e3315ab145de7f9317f125e9c86b63a97c6ceec5d3
-  data.tar.gz: e51ded70e610773da6ffd4bc1d4479ebb75853582c033d351e2d79d6ec0014e6b157d8e8b213d226a52bc0f1179c0fbfe2667b818a98ddc0cb56fe15efe1ab60
+  metadata.gz: 22f6140f40dca4b7f981e47cd773a09e9b72f48d8c4e833fd9442c6e433c0edcf91af9f05172e7aabcb12e0862bd79e61a5718c9183cf399eb7ada182bcd650c
+  data.tar.gz: 397c264e64d2d0cd0076d6942d91f8dc69df4312dc9f1aa3d082b46960c473c51faed547d66835d4174efdbb50809457cdb809ab37ee4d0f5afc20ef52d8731f

data/lib/mumukit/platform.rb

@@ -1,4 +1,5 @@
 require 'mumukit/core'
+require 'mumukit/auth'
 
 require_relative './platform/version'
 require_relative './platform/uri'
@@ -17,7 +18,6 @@ module Mumukit::Platform
       config.thesaurus_url = ENV['MUMUKI_THESAURUS_URL'] || "http://thesaurus.#{domain}"
       config.bibliotheca_url = ENV['MUMUKI_BIBLIOTHECA_URL'] || "http://bibliotheca.#{domain}"
       config.bibliotheca_api_url = ENV['MUMUKI_BIBLIOTHECA_API_URL'] || "http://bibliotheca-api.#{domain}"
-      config.office_url = ENV['MUMUKI_OFFICE_URL'] || "http://office.#{domain}"
       config.classroom_url = ENV['MUMUKI_CLASSROOM_URL'] || "http://classroom.#{domain}"
       config.classroom_api_url = ENV['MUMUKI_CLASSROOM_API_URL'] || "http://classroom-api.#{domain}"
       config.organization_mapping = Mumukit::Platform::OrganizationMapping.from_env
@@ -27,11 +27,22 @@ module Mumukit::Platform
   def self.config
     @config
   end
+
+  [:organization, :user].each do |klass|
+    define_singleton_method("#{klass}_class") do
+      begin
+        config["#{klass}_class"] ||= config["#{klass}_class_name"].constantize
+      rescue
+        raise "You must configure your #{klass} class first"
+      end
+    end
+  end
 end
 
 require_relative './platform/domain'
 require_relative './platform/model'
 require_relative './platform/locale'
+require_relative './platform/user'
 require_relative './platform/organization'
 require_relative './platform/organization_mapping'
 require_relative './platform/application'

data/lib/mumukit/platform/model.rb

@@ -8,17 +8,40 @@ class Mumukit::Platform::Model
   end
 
   def self.model_attr_accessor(*keys)
+    bools, raws = keys.partition { |it| it.to_s.end_with? '?' }
+    raw_bools = bools.map { |it| it.to_s[0..-2].to_sym }
+    keys = raws + raw_bools
+
     attr_accessor(*keys)
+
+    raw_bools.each do |it|
+      define_method("#{it}?") { !!send(it) }
+      define_method("#{it}=") { |value| instance_variable_set("@#{it}", value.to_boolean) }
+    end
+
+    # Parses model from an event.
+    # Only allowed keys are accepted
     define_singleton_method :parse do |hash|
       hash ? new(hash.slice(*keys)) : new
     end
   end
 
+  ## Serialization
+
+  # Serializes model
   def self.dump(obj)
     obj.to_json
   end
 
+  # Deserializes model
   def self.load(json)
     json ? new(JSON.parse(json)) : new
   end
 end
+
+
+class Object
+  def to_boolean
+    [true, 'true', '1', 1].include?(self)
+  end
+end

data/lib/mumukit/platform/organization.rb

@@ -11,6 +11,10 @@ module Mumukit::Platform::Organization
   def self.current
     Thread.current[:organization] || raise('organization not selected')
   end
+
+  def self.find_by_name!(name)
+    Mumukit::Platform.organization_class.find_by_name!(name)
+  end
 end
 
 require_relative './organization/settings'

data/lib/mumukit/platform/organization/helpers.rb

@@ -1,7 +1,14 @@
-
 module Mumukit::Platform::Organization::Helpers
   extend ActiveSupport::Concern
 
+  ## Implementors must declare the following methods:
+  #
+  #  * name
+  #  * book
+  #  * profile
+  #  * settings
+  #  * theme
+
   included do
     delegate :theme_stylesheet,
              :theme_stylesheet=,
@@ -37,6 +44,7 @@ module Mumukit::Platform::Organization::Helpers
              :description,
              :description=,
              :community_link,
+             :community_link=,
              :terms_of_service,
              :terms_of_service=,
              :contact_email,
@@ -76,6 +84,14 @@ module Mumukit::Platform::Organization::Helpers
     Mumukit::Platform.application.organic_domain(name)
   end
 
+  ## API Exposure
+
+  def to_param
+    name
+  end
+
+  ## Name validation
+
   def self.valid_name?(name)
     !!(name =~ anchored_valid_name_regex)
   end
@@ -88,6 +104,36 @@ module Mumukit::Platform::Organization::Helpers
     /([-a-z0-9_]+(\.[-a-z0-9_]+)*)?/
   end
 
+  ## Platform JSON
+
+  def as_platform_json
+    {
+      name: name,
+      book: book.slug,
+      banner_url: banner_url,
+      breadcrumb_image_url: breadcrumb_image_url,
+      community_link: community_link,
+      contact_email: contact_email,
+      description: description,
+      extension_javascript: extension_javascript,
+      favicon_url: favicon_url,
+      feedback_suggestions_enabled: feedback_suggestions_enabled?,
+      immersive: immersive?,
+      locale: locale,
+      login_methods: login_methods,
+      logo_url: logo_url,
+      open_graph_image_url: open_graph_image_url,
+      public: public?,
+      raise_hand_enabled: raise_hand_enabled?,
+      terms_of_service: terms_of_service,
+      theme_stylesheet: theme_stylesheet
+    }.except(*protected_platform_fields).compact
+  end
+
+  def protected_platform_fields
+    []
+  end
+
   module ClassMethods
     def current
       Mumukit::Platform::Organization.current

data/lib/mumukit/platform/organization/settings.rb

@@ -1,30 +1,14 @@
 class Mumukit::Platform::Organization::Settings < Mumukit::Platform::Model
   model_attr_accessor :login_methods,
-                      :raise_hand_enabled,
-                      :feedback_suggestions_enabled,
-                      :public,
-                      :immersive
-
-  def raise_hand_enabled?
-    !!raise_hand_enabled
-  end
-
-  def feedback_suggestions_enabled?
-    !!feedback_suggestions_enabled
-  end
-
-  def public?
-    !!public
-  end
+                      :raise_hand_enabled?,
+                      :feedback_suggestions_enabled?,
+                      :public?,
+                      :immersive?
 
   def private?
     !public?
   end
 
-  def immersive?
-    !!immersive
-  end
-
   def login_methods
     @login_methods ||= ['user_pass']
   end

data/lib/mumukit/platform/user.rb

@@ -0,0 +1,7 @@
+module Mumukit::Platform::User
+  def self.find_by_uid!(uid)
+    Mumukit::Platform.user_class.find_by_uid!(uid)
+  end
+end
+
+require_relative './user/helpers'

data/lib/mumukit/platform/user/helpers.rb

@@ -0,0 +1,108 @@
+module Mumukit::Platform::User::Helpers
+  include Mumukit::Auth::Roles
+
+  ## Implementors must declare the following methods:
+  #
+  #  * permissions
+  #  * uid
+  #  * social_id
+  #  * image_url
+  #  * email
+  #  * first_name
+  #  * last_name
+
+  ## Permissions
+
+  delegate :has_role?,
+           :add_permission!,
+           :remove_permission!,
+           :has_permission?,
+           :has_permission_delegation?,
+           :protect!,
+           :protect_delegation!,
+           :protect_permissions_assignment!,
+           to: :permissions
+
+  def merge_permissions!(new_permissions)
+    self.permissions = permissions.merge(new_permissions)
+  end
+
+  [:student, :teacher, :headmaster, :janitor].each do |role|
+    role_of = "#{role}_of?"
+    role_here = "#{role}_here?"
+
+    define_method role_of do |organization|
+      has_permission? role, organization.slug
+    end
+
+    define_method role_here do
+      send role_of, Mumukit::Platform::Organization.current
+    end
+  end
+
+  def make_student_of!(organization)
+    add_permission! :student, organization.slug
+  end
+
+  ## Profile
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+
+  def profile_completed?
+    [first_name, last_name].all? &:present?
+  end
+
+  def to_s
+    "#{full_name} <#{email}> [#{uid}]"
+  end
+
+  ## Accesible organizations
+
+  def accessible_organizations
+    permissions.accessible_organizations.map do |org|
+      Mumukit::Platform::Organization.find_by_name!(org) rescue nil
+    end.compact
+  end
+
+  def has_accessible_organizations?
+    accessible_organizations.present?
+  end
+
+  def main_organization
+    accessible_organizations.first
+  end
+
+  def has_main_organization?
+    accessible_organizations.length == 1
+  end
+
+  def has_immersive_main_organization?
+    !!main_organization.try(&:immersive?)
+  end
+
+  ## API Exposure
+
+  def to_param
+    uid
+  end
+
+  ## Platform JSON
+
+  def as_platform_json
+    {
+      uid: uid,
+      social_id: social_id,
+      image_url: image_url,
+      email: email,
+      first_name: first_name,
+      last_name: last_name,
+      permissions: permissions
+    }.except(*protected_platform_fields).compact
+  end
+
+  def protected_platform_fields
+    []
+  end
+end

data/lib/mumukit/platform/version.rb

@@ -1,5 +1,5 @@
 module Mumukit
   module Platform
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
   end
 end

data/lib/mumukit/platform/with_applications.rb

@@ -14,10 +14,6 @@ module Mumukit::Platform::WithApplications
     Mumukit::Platform::Application::Organic.new config.classroom_api_url, organization_mapping
   end
 
-  def office
-    Mumukit::Platform::Application::Basic.new config.office_url
-  end
-
   def bibliotheca
     Mumukit::Platform::Application::Basic.new config.bibliotheca_url
   end
@@ -29,4 +25,4 @@ module Mumukit::Platform::WithApplications
   def application_for(name)
     send name
   end
-end
+end

data/mumukit-platform.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'mumukit-core', '~> 1.2'
+  spec.add_dependency 'mumukit-auth', '~> 7.0'
   spec.add_dependency 'activemodel', '>= 4.0'
 
   spec.add_development_dependency 'bundler', '~> 1.14'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumukit-platform
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit-core
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mumukit-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +124,8 @@ files:
 - lib/mumukit/platform/organization/theme.rb
 - lib/mumukit/platform/organization_mapping.rb
 - lib/mumukit/platform/uri.rb
+- lib/mumukit/platform/user.rb
+- lib/mumukit/platform/user/helpers.rb
 - lib/mumukit/platform/version.rb
 - lib/mumukit/platform/web_framework.rb
 - lib/mumukit/platform/with_applications.rb
@@ -137,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Shared Mumuki Platform Components