mumukit-platform 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9debde5cab571898e9f88dd89a6f6800dfc9a1549ae00fc5d84792aa15cdc17
-  data.tar.gz: 6eae2161b167142e81ea81920316d3ec68e394545c0b0952fd8c5ec5606f22b1
+  metadata.gz: a1e1ce06ac9d7055da2a3f86b3a865630a7788e182e0c021485c9b2b638df543
+  data.tar.gz: d1ab26c3c29648fea155c0aef57315b57e1405efab03b44fadfa2f8e06c0724c
 SHA512:
-  metadata.gz: ff19191a1dbca41064ecf36df3e0e945546ad30a179a53bd3f763552c86cb65e9ccb8819f755c7b1fff5bedc0571c7ef25bb8eb2eecb5f734c47184567e926d4
-  data.tar.gz: a76f6ca3e5b593d77f748e9205503d2986808eade31f2207e7e30ffdf880b027237e69d18245d1b5e2f8972fb8d2884cf1e31cbf8160f4561a6c2f2aaadb86ea
+  metadata.gz: 74adaec00a74e0774e0136b6295462a0f47d26380b915cdef19e04a1a7458de90987a599c25c6843362d21bd1626819e5fcfaed6b23d21e9f0b109d4eae77dac
+  data.tar.gz: d40805aa710719fef5c0a78a306787946f312e8d685ed927501696045e1754a3a6f56c855ec3d8f8e9fe02c1a92fd1bf9b8661a00b373576a22ccd0bba65d7b5

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.6.3

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-- 2.3.1
+- 2.6.3
 before_install: gem install bundler -v 1.14.2
 deploy:
   provider: rubygems

data/README.md

@@ -23,6 +23,23 @@ Or install it yourself as:
 
     $ gem install mumukit-platform
 
+## Requeriments
+
+In order to properly use this gem, you must declare _organization_, _course_ and _user_ classes, and implement some required methods:
+
+ _organization_:
+   * `#name`
+   * `#locale`
+   * `.find_by_name!`
+
+ _user_:
+   * `.for_profile`
+   * `.find_by_uid!`
+
+ _course_:
+   * `.find_by_slug!`
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mumuki/mumukit-platform. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -30,4 +47,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/mumuki
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/mumukit/platform.rb

@@ -26,6 +26,20 @@ module Mumukit::Platform
   end
 
   CORE_MODELS.each do |klass|
+    # Configured classes must implement the following methods:
+    #
+    # _organization_:
+    #   * `#name`
+    #   * `#locale`
+    #   * `.find_by_name!`
+    #
+    # _user_:
+    #   * `.for_profile`
+    #   * `.find_by_uid!`
+    #
+    # _course_:
+    #   * `.find_by_slug!`
+    #
     define_singleton_method("#{klass}_class") do
       begin
         config["#{klass}_class"] ||= config["#{klass}_class_name"].constantize
@@ -42,8 +56,8 @@ require_relative './platform/domain'
 require_relative './platform/model'
 require_relative './platform/locale'
 require_relative './platform/course'
-require_relative './platform/user'
 require_relative './platform/organization'
+require_relative './platform/user'
 require_relative './platform/organization_mapping'
 require_relative './platform/application'
 require_relative './platform/web_framework'

data/lib/mumukit/platform/course.rb

@@ -3,5 +3,3 @@ module Mumukit::Platform::Course
     Mumukit::Platform.course_class.find_by_slug!(slug)
   end
 end
-
-require_relative './course/helpers'

data/lib/mumukit/platform/organization.rb

@@ -25,7 +25,3 @@ module Mumukit::Platform::Organization
   end
 end
 
-require_relative './organization/settings'
-require_relative './organization/profile'
-require_relative './organization/theme'
-require_relative './organization/helpers'

data/lib/mumukit/platform/organization_mapping.rb

@@ -9,10 +9,10 @@ module Mumukit::Platform::OrganizationMapping
 
   def self.parse(name)
     mapping = name.try { |it| it.strip.downcase }
-    if mapping.blank? || mapping == 'subdomain'
-      Subdomain
-    elsif mapping == 'path'
+    if mapping.blank? || mapping == 'path'
       Path
+    elsif mapping == 'subdomain'
+      Subdomain
     else
       raise "Unrecognized organization mapping #{mapping}"
     end

data/lib/mumukit/platform/user.rb

@@ -3,5 +3,3 @@ module Mumukit::Platform::User
     Mumukit::Platform.user_class.find_by_uid!(uid)
   end
 end
-
-require_relative './user/helpers'

data/lib/mumukit/platform/version.rb

@@ -1,5 +1,5 @@
 module Mumukit
   module Platform
-    VERSION = '4.2.0'
+    VERSION = '5.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumukit-platform
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit-nuntius
@@ -144,20 +144,14 @@ files:
 - lib/mumukit/platform/application.rb
 - lib/mumukit/platform/bridge.rb
 - lib/mumukit/platform/course.rb
-- lib/mumukit/platform/course/helpers.rb
 - lib/mumukit/platform/domain.rb
 - lib/mumukit/platform/locale.rb
 - lib/mumukit/platform/model.rb
 - lib/mumukit/platform/notifiable.rb
 - lib/mumukit/platform/organization.rb
-- lib/mumukit/platform/organization/helpers.rb
-- lib/mumukit/platform/organization/profile.rb
-- lib/mumukit/platform/organization/settings.rb
-- 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
@@ -184,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Shared Mumuki Platform Components

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

@@ -1,43 +0,0 @@
-module Mumukit::Platform::Course::Helpers
-  include Mumukit::Platform::Notifiable
-
-  ## Implementors must declare the following methods:
-  #
-  #  * slug
-  #  * shifts
-  #  * code
-  #  * days
-  #  * period
-  #  * description
-
-  def platform_class_name
-    :Course
-  end
-
-  ## API Exposure
-
-  def to_param
-    slug
-  end
-
-  ## Resource Hash
-
-  def self.slice_resource_h(resource_h)
-    resource_h.slice(:slug, :shifts, :code, :days, :period, :description)
-  end
-
-  def to_resource_h
-    {
-      slug: slug,
-      shifts: shifts,
-      code: code,
-      days: days,
-      period: period,
-      description: description
-    }.except(*protected_resource_fields).compact
-  end
-
-  def protected_resource_fields
-    []
-  end
-end

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

@@ -1,112 +0,0 @@
-module Mumukit::Platform::Organization::Helpers
-  extend ActiveSupport::Concern
-  include Mumukit::Platform::Notifiable
-
-  ## Implementors must declare the following methods:
-  #
-  #  * name
-  #  * book
-  #  * profile
-  #  * settings
-  #  * theme
-
-  included do
-    delegate *Mumukit::Platform::Organization::Theme.accessors, to: :theme
-    delegate *Mumukit::Platform::Organization::Settings.accessors, :private?, :login_settings, to: :settings
-    delegate *Mumukit::Platform::Organization::Profile.accessors, :locale_json, to: :profile
-  end
-
-  def platform_class_name
-    :Organization
-  end
-
-  def slug
-    Mumukit::Auth::Slug.join_s name
-  end
-
-  def central?
-    name == 'central'
-  end
-
-  def test?
-    name == 'test'
-  end
-
-  def base?
-    name == 'base'
-  end
-
-  def switch!
-    Mumukit::Platform::Organization.switch! self
-  end
-
-  def to_s
-    name
-  end
-
-  def url_for(path)
-    Mumukit::Platform.application.organic_url_for(name, path)
-  end
-
-  def url
-    url_for '/'
-  end
-
-  def domain
-    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
-
-  def self.anchored_valid_name_regex
-    /\A#{valid_name_regex}\z/
-  end
-
-  def self.valid_name_regex
-    /([-a-z0-9_]+(\.[-a-z0-9_]+)*)?/
-  end
-
-  ## Resource Hash
-
-  def self.slice_resource_h(resource_h)
-    resource_h.slice(:name, :book, :profile, :settings, :theme)
-  end
-
-  def to_resource_h
-    {
-      name: name,
-      book: book.slug,
-      profile: profile,
-      settings: settings,
-      theme: theme
-    }.except(*protected_resource_fields).compact
-  end
-
-  def protected_resource_fields
-    []
-  end
-
-  module ClassMethods
-    def current
-      Mumukit::Platform::Organization.current
-    end
-
-    def parse(json)
-      json
-        .slice(:name)
-        .merge(theme: Mumukit::Platform::Organization::Theme.parse(json[:theme]))
-        .merge(settings: Mumukit::Platform::Organization::Settings.parse(json[:settings]))
-        .merge(profile: Mumukit::Platform::Organization::Profile.parse(json[:profile]))
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-class Mumukit::Platform::Organization::Profile < Mumukit::Platform::Model
-  LOCALES = Mumukit::Platform::Locale::SPECS
-
-  model_attr_accessor :logo_url,
-                      :banner_url,
-                      :favicon_url,
-                      :breadcrumb_image_url,
-                      :open_graph_image_url,
-                      :locale,
-                      :description,
-                      :contact_email,
-                      :terms_of_service,
-                      :community_link,
-                      :errors_explanations
-
-  def locale_json
-    locale_h.to_json
-  end
-
-  def locale_h
-    Mumukit::Platform::Locale::SPECS[locale]
-  end
-
-  def logo_url
-    @logo_url ||= 'https://mumuki.io/logo-alt-large.png' # Best image size: 350x75
-  end
-
-  def banner_url
-    @banner_url || logo_url  # Best image size: 350x75
-  end
-
-  def favicon_url
-    @favicon_url ||= '/favicon.ico'  # Best image size: 16x16, 32x32 or 48x48
-  end
-
-  def open_graph_image_url
-    @open_graph_image_url ||= Mumukit::Platform.application.url_for("logo-alt.png")  # Best image size: 256x256
-  end
-end

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

@@ -1,25 +0,0 @@
-class Mumukit::Platform::Organization::Settings < Mumukit::Platform::Model
-  model_attr_accessor :login_methods,
-                      :login_provider,
-                      :login_provider_settings,
-                      :forum_discussions_minimal_role,
-                      :raise_hand_enabled?,
-                      :feedback_suggestions_enabled?,
-                      :public?,
-                      :embeddable?,
-                      :immersive?,
-                      :forum_enabled?,
-                      :report_issue_enabled?
-
-  def private?
-    !public?
-  end
-
-  def login_methods
-    @login_methods ||= ['user_pass']
-  end
-
-  def forum_discussions_minimal_role
-    (@forum_discussions_minimal_role || 'student').to_sym
-  end
-end

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

@@ -1,4 +0,0 @@
-class Mumukit::Platform::Organization::Theme < Mumukit::Platform::Model
-  model_attr_accessor :theme_stylesheet,
-                      :extension_javascript
-end

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

@@ -1,142 +0,0 @@
-module Mumukit::Platform::User::Helpers
-  include Mumukit::Auth::Roles
-  include Mumukit::Platform::Notifiable
-
-  extend Gem::Deprecate
-
-  ## 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 platform_class_name
-    :User
-  end
-
-  def merge_permissions!(new_permissions)
-    self.permissions = permissions.merge(new_permissions)
-  end
-
-  (Mumukit::Auth::Roles::ROLES - [:writer, :editor, :owner] + [:discusser]).each do |role|
-    role_of = "#{role}_of?"
-    role_here = "#{role}_here?"
-
-    # Tells whether this user has #{role} permissions in
-    # the given organization
-    define_method role_of do |organization|
-      has_permission? role, organization.slug
-    end
-
-    # Tells whether this user has #{role} permissions in
-    # the current organization
-    define_method role_here do
-      send role_of, Mumukit::Platform::Organization.current
-    end
-  end
-
-  # Tells whether this user has forum discusser permissions in
-  # the given organization
-  def discusser_of?(organization)
-    has_permission? organization.forum_discussions_minimal_role, organization.slug
-  end
-
-  (Mumukit::Auth::Roles::ROLES - [:owner]).each do |role|
-
-    # Assignes the #{role} role to this user
-    # for the given slug
-    define_method "make_#{role}_of!" do |slug|
-      add_permission! role, slug
-    end
-  end
-
-  ## Profile
-
-  def full_name
-    "#{first_name} #{last_name}"
-  end
-
-  alias_method :name, :full_name
-
-  def profile_completed?
-    [first_name, last_name].all? &:present?
-  end
-
-  def to_s
-    "#{full_name} <#{email}> [#{uid}]"
-  end
-
-  ## Accesible organizations
-
-  def student_granted_organizations
-    permissions.student_granted_organizations.map do |org|
-      Mumukit::Platform::Organization.find_by_name!(org) rescue nil
-    end.compact
-  end
-
-  def has_student_granted_organizations?
-    student_granted_organizations.present?
-  end
-
-  [[:accessible_organizations, :student_granted_organizations],
-   [:has_accessible_organizations?, :has_student_granted_organizations?]].each do |it, replacement|
-    alias_method it, replacement
-    deprecate it, replacement, 2019, 6
-  end
-
-  def main_organization
-    student_granted_organizations.first
-  end
-
-  def has_main_organization?
-    student_granted_organizations.length == 1
-  end
-
-  def has_immersive_main_organization?
-    !!main_organization.try(&:immersive?)
-  end
-
-  ## API Exposure
-
-  def to_param
-    uid
-  end
-
-  ## Resource Hash
-
-  def self.slice_resource_h(resource_h)
-    resource_h.slice(:uid, :social_id, :image_url, :email, :first_name, :last_name, :permissions)
-  end
-
-  def to_resource_h
-    {
-      uid: uid,
-      social_id: social_id,
-      image_url: image_url,
-      email: email,
-      first_name: first_name,
-      last_name: last_name,
-      permissions: permissions
-    }.except(*protected_resource_fields).compact
-  end
-
-  def protected_resource_fields
-    []
-  end
-end