mumukit-platform 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b089e4ed42661cce634490d1e6d714e33408b31c272e91028ef11e505a4070f4
-  data.tar.gz: 44a80514586a38975e1d975f25574865c2e6c6c12715949a100a918f65d07411
+  metadata.gz: 5eff1d483904e69e76c1114b058358a6d2e5eb3b041a95fda5aa28f441700601
+  data.tar.gz: 439d16d1874d455e85b76c53a79d3a147b2ff7ddea45be50e12d62881680940f
 SHA512:
-  metadata.gz: d95eab6d563e8a87ecf7a09c0e64950e9c5b4dfdb758a9e3e35b80772913d93529c3e4022a73ddc797d4dde8143b6c6ac2c30242e08b603c8cdd5bf7a3f8fe68
-  data.tar.gz: 11ed531dbb9b95e89de392f81b445363fda7fdc8a65a55104a14a61169b806730244f96474a1dd019035940e98edeb218d8e653f58be68e78b28afbff96a8f50
+  metadata.gz: 2fe97f05b46bc6d60c2df137e5d87b67d2767f1ed36d6505d1f11817428304b61a36279b06e158f9745efaf59697ed3ac127952e03cd21e6996d3078d3805934
+  data.tar.gz: 589cf58ab0cffc2e24f61726ddab0e4fc38a52cd4dc8379f8a3b4bb3dc1a3814e3b9649addfc819e00b77b913bf54c2992d89dc892a6e6d5942a2cf690c53330

data/lib/mumukit/platform.rb

@@ -1,10 +1,13 @@
 require 'mumukit/core'
 require 'mumukit/auth'
+require 'mumukit/nuntius'
 
 require_relative './platform/version'
 require_relative './platform/uri'
 
 module Mumukit::Platform
+  CORE_MODELS = [:organization, :user, :course]
+
   def self.configure
     @config ||= defaults
     yield @config
@@ -28,7 +31,7 @@ module Mumukit::Platform
     @config
   end
 
-  [:organization, :user].each do |klass|
+  CORE_MODELS.each do |klass|
     define_singleton_method("#{klass}_class") do
       begin
         config["#{klass}_class"] ||= config["#{klass}_class_name"].constantize
@@ -39,9 +42,12 @@ module Mumukit::Platform
   end
 end
 
+require_relative './platform/notifiable'
+
 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/organization_mapping'

data/lib/mumukit/platform/course.rb

@@ -0,0 +1,7 @@
+module Mumukit::Platform::Course
+  def self.find_by_slug!(slug)
+    Mumukit::Platform.course_class.find_by_slug!(slug)
+  end
+end
+
+require_relative './course/helpers'

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

@@ -0,0 +1,43 @@
+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
+
+  ## Platform JSON
+
+  def self.slice_platform_json(json)
+    json.slice(:slug, :shifts, :code, :days, :period, :description)
+  end
+
+  def as_platform_json
+    {
+      slug: slug,
+      shifts: shifts,
+      code: code,
+      days: days,
+      period: period,
+      description: description
+    }.except(*protected_platform_fields).compact
+  end
+
+  def protected_platform_fields
+    []
+  end
+end

data/lib/mumukit/platform/notifiable.rb

@@ -0,0 +1,13 @@
+module Mumukit::Platform::Notifiable
+  def notify!(event_type = :changed)
+    Mumukit::Nuntius.notify_event! platform_event_name(event_type), as_platform_event
+  end
+
+  def platform_event_name(event_type)
+    "#{platform_class_name}#{event_type.to_s.titlecase}"
+  end
+
+  def as_platform_event
+    { platform_class_name.downcase => as_platform_json }
+  end
+end

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

@@ -1,5 +1,6 @@
 module Mumukit::Platform::Organization::Helpers
   extend ActiveSupport::Concern
+  include Mumukit::Platform::Notifiable
 
   ## Implementors must declare the following methods:
   #
@@ -54,6 +55,10 @@ module Mumukit::Platform::Organization::Helpers
 
   end
 
+  def platform_class_name
+    :Organization
+  end
+
   def slug
     Mumukit::Auth::Slug.join_s name
   end
@@ -108,27 +113,17 @@ module Mumukit::Platform::Organization::Helpers
 
   ## Platform JSON
 
+  def self.slice_platform_json(json)
+    json.slice(:name, :book, :profile, :settings, :theme)
+  end
+
   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
+      profile: profile,
+      settings: settings,
+      theme: theme
     }.except(*protected_platform_fields).compact
   end
 
@@ -144,9 +139,9 @@ module Mumukit::Platform::Organization::Helpers
     def parse(json)
       json
         .slice(:name)
-        .merge(theme: Mumukit::Platform::Organization::Theme.parse(json))
-        .merge(settings: Mumukit::Platform::Organization::Settings.parse(json))
-        .merge(profile: Mumukit::Platform::Organization::Profile.parse(json))
+        .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/user/helpers.rb

@@ -1,5 +1,6 @@
 module Mumukit::Platform::User::Helpers
   include Mumukit::Auth::Roles
+  include Mumukit::Platform::Notifiable
 
   ## Implementors must declare the following methods:
   #
@@ -23,6 +24,10 @@ module Mumukit::Platform::User::Helpers
            :protect_permissions_assignment!,
            to: :permissions
 
+  def platform_class_name
+    :User
+  end
+
   def merge_permissions!(new_permissions)
     self.permissions = permissions.merge(new_permissions)
   end
@@ -50,6 +55,8 @@ module Mumukit::Platform::User::Helpers
     "#{first_name} #{last_name}"
   end
 
+  alias_method :name, :full_name
+
   def profile_completed?
     [first_name, last_name].all? &:present?
   end
@@ -90,6 +97,10 @@ module Mumukit::Platform::User::Helpers
 
   ## Platform JSON
 
+  def self.slice_platform_json(json)
+    json.slice(:uid, :social_id, :image_url, :email, :first_name, :last_name, :permissions)
+  end
+
   def as_platform_json
     {
       uid: uid,

data/lib/mumukit/platform/version.rb

@@ -1,5 +1,5 @@
 module Mumukit
   module Platform
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

data/mumukit-platform.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'mumukit-nuntius', '~> 6.0'
   spec.add_dependency 'mumukit-core', '~> 1.2'
   spec.add_dependency 'mumukit-auth', '~> 7.0'
   spec.add_dependency 'activemodel', '>= 4.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mumukit-platform
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mumukit-nuntius
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mumukit-core
   requirement: !ruby/object:Gem::Requirement
@@ -114,9 +128,12 @@ files:
 - bin/setup
 - lib/mumukit/platform.rb
 - lib/mumukit/platform/application.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