mumukit-platform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 024bf781a48ada1f1e2536ece324a305771a6d4d
+  data.tar.gz: 69c6dfb30d9dcaf02fd59000c3dc5c8c4e2356be
+SHA512:
+  metadata.gz: 1e22b6cb08f1df7284ed97b60d66280f158e3bc892279614700b4952b23b6ddb9ef6732e43fbc5e827e15ed04d5e0cd47256b3f643b616bd491131e5c6d4d5a8
+  data.tar.gz: 35b20ce05e326cd56a73e064d86c9189c55167b90f70a488fe866b11dc676c54090c0dba88052e2c3efc49a8be0d9b0d596f1fbe1704a911eaf315918631ec3c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.14.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: peqcsnX2NXwCvy20HfitFl7Dhhi4jrkeu2ZuJz6eEVml5xkkGOuTiAXiSFMvysuV1uCueWNKvQJzNl6u82cwM/InYjFj1kG3SRLIZCkEKks2tOxtJmky7CpIh9jI5SZKOL/DKuMRIuYJwhN0WURi58aCybqyhAsh0XQYGN0EFo6jwnJHehe1KEwgxaTFFB1Q1bn41o+7LWw4r39j7mj28x+WTnl11iM/CRndrQj/YSB8Xk92il8W2vfEWbn4xY2rK/joQ9Doi+rbrW90J7ArGkiMbbsofKkt2snOjrO5UDqqDGWi1/iQmBwtf2qgqB+TmTELrqd4ehRraq4P7dgW3uWGQe/0gR5xoYDusimcBQ5N+JDZbac/YKMRYG0+Ce09ggIaGjq2iEyn9zus00aaaoEGixqVtTwMtkvApmlM/c7CaeSmKSUhYdYE8ayOuCqHgIhCKoZPhADylTc3NL5qizk3/3/wrCyAf9Slq/Oa04Wa4NRXfC5yDkdJggaIzYwq03mc1diechM1ZrovZHNOWznbtjq1JrbEDQk95A29BsrTRLCk98QnChaTHrGmwvlk7g40iUurDplfg5IpUHnSc9BBQg+hcKd5IjKVkrHH5cUHq+U8pXIXgf4vs8cYFX8B1asIO7ApiSABxnC8bsjBZx4ccu303LWILiFBurQQn7w=
+  gem: mumukit-platform
+  on:
+    tags: true
+    repo: mumuki/mumukit-platform

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at flbulgarelli@yahoo.com.ar. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mumuki Project, Franco Leonardo Bulgarelli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+[![Build Status](https://travis-ci.org/mumuki/mumukit-platform.svg?branch=master)](https://travis-ci.org/mumuki/mumukit-platform)
+[![Code Climate](https://codeclimate.com/github/mumuki/mumukit-platform/badges/gpa.svg)](https://codeclimate.com/github/mumuki/mumukit-platform)
+[![Test Coverage](https://codeclimate.com/github/mumuki/mumukit-platform/badges/coverage.svg)](https://codeclimate.com/github/mumuki/mumukit-platform)
+[![Issue Count](https://codeclimate.com/github/mumuki/mumukit-platform/badges/issue_count.svg)](https://codeclimate.com/github/mumuki/mumukit-platform)
+
+# Mumukit::Platform
+
+> Generic components for building Mumuki Platform applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mumukit-platform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mumukit-platform
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mumukit/platform"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mumukit/platform/application.rb

@@ -0,0 +1,50 @@
+class Mumukit::Platform::Application
+  attr_accessor :url
+
+  def initialize(url)
+    @url = url
+  end
+
+  def uri
+    URI(@url)
+  end
+
+  required :organic_uri
+
+  def organic_url(organization)
+    organic_uri(organization).to_s
+  end
+
+  def organic_domain(organization)
+    organic_uri(organization).host
+  end
+
+  def domain
+    uri.host
+  end
+
+  def url_for(path)
+    uri.url_for(path) if path
+  end
+
+  def organic_url_for(organization, path)
+    organic_uri(organization).url_for(path)
+  end
+
+  class Basic < Mumukit::Platform::Application
+    def organic_uri(_organization)
+      uri
+    end
+  end
+
+  class Organic < Mumukit::Platform::Application
+    def initialize(url, organization_mapping)
+      super(url)
+      @organization_mapping = organization_mapping
+    end
+
+    def organic_uri(organization)
+      @organization_mapping.organic_uri(uri, organization)
+    end
+  end
+end

data/lib/mumukit/platform/organization_mapping.rb

@@ -0,0 +1,40 @@
+module Mumukit::Platform::OrganizationMapping
+  def self.from_env
+    mapping = ENV['MUMUKI_ORGANIZATION_MAPPING']&.strip
+    if ENV['RACK_ENV'] == 'test' || ENV['RAILS_ENV'] == 'test' || mapping == 'subdomain'
+      Subdomain
+    elsif mapping == 'path'
+      Path
+    else
+      raise "Unrecognized organization mapping #{mapping}"
+    end
+  end
+
+  module Subdomain
+    def self.map_organization_routes!(native, _framework, &block)
+      native.instance_eval(&block)
+    end
+
+    def self.organization_name(request, domain)
+      request.first_subdomain_after(domain) || 'central'
+    end
+
+    def self.organic_uri(uri, organization)
+      uri.subdominate(organization)
+    end
+  end
+
+  module Path
+    def self.map_organization_routes!(native, framework, &block)
+      framework.configure_tenant_path_routes! native, &block
+    end
+
+    def self.organization_name(request, _domain)
+      request.path.split('/')[1]
+    end
+
+    def self.organic_uri(uri, organization)
+      uri.subroute(organization)
+    end
+  end
+end

data/lib/mumukit/platform/uri.rb

@@ -0,0 +1,31 @@
+class URI::HTTP
+  def subdominate(subdomain)
+    if host.start_with? 'www.'
+      new_host = host.gsub('www.', "www.#{subdomain}.")
+    else
+      new_host = "#{subdomain}.#{host}"
+    end
+    URI::HTTP.build(scheme: scheme,
+                    host: new_host,
+                    path: path,
+                    query: query,
+                    port: port)
+  end
+
+  def subroute(route)
+    if path.start_with? '/'
+      new_path = "/#{route}#{path}"
+    else
+      new_path = "/#{route}/#{path}"
+    end
+    URI::HTTP.build(scheme: scheme,
+                    host: host,
+                    path: new_path,
+                    query: query,
+                    port: port)
+  end
+
+  def url_for(path)
+    URI.join(self, path).to_s
+  end
+end

data/lib/mumukit/platform/version.rb

@@ -0,0 +1,5 @@
+module Mumukit
+  module Platform
+    VERSION = "0.1.0"
+  end
+end

data/lib/mumukit/platform/web_framework.rb

@@ -0,0 +1,29 @@
+module Mumukit::Platform::WebFramework
+  module Rails
+    class LazyString
+      def initialize(proc)
+        @proc = proc
+      end
+
+      def to_s
+        @proc.call.to_s
+      end
+    end
+
+    def self.lazy_string(&block)
+      LazyString.new(proc(&block))
+    end
+
+    def self.configure_tenant_path_routes!(mapper, &block)
+      mapper.scope '/:tenant', defaults: {tenant: lazy_string { Mumukit::Platform.current_organization_name }}, &block
+    end
+  end
+
+  module Sinatra
+    def self.configure_tenant_path_routes!(mapper, &block)
+      require 'sinatra/namespace'
+
+      mapper.send :namespace, '/:tenant', &block
+    end
+  end
+end

data/lib/mumukit/platform/with_applications.rb

@@ -0,0 +1,32 @@
+module Mumukit::Platform::WithApplications
+  delegate :application, to: :config
+  delegate :url_for, :organic_url_for, to: :application
+
+  def laboratory
+    Mumukit::Platform::Application::Organic.new config.laboratory_url, organization_mapping
+  end
+
+  def classroom
+    Mumukit::Platform::Application::Organic.new config.classroom_url, organization_mapping
+  end
+
+  def classroom_api
+    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
+
+  def bibliotheca_api
+    Mumukit::Platform::Application::Basic.new config.bibliotheca_api_url
+  end
+
+  def application_for(name)
+    send name
+  end
+end

data/lib/mumukit/platform/with_organization_mapping.rb

@@ -0,0 +1,11 @@
+module Mumukit::Platform::WithOrganizationMapping
+  delegate :organization_mapping, to: :config
+
+  def organization_name(request)
+    organization_mapping.organization_name(request, application.domain)
+  end
+
+  def map_organization_routes!(native_mapper, &block)
+    organization_mapping.map_organization_routes!(native_mapper, config.web_framework, &block)
+  end
+end

data/lib/mumukit/platform.rb

@@ -0,0 +1,49 @@
+require 'mumukit/core'
+
+require_relative './platform/version'
+require_relative './platform/uri'
+
+module Mumukit::Platform
+  def self.configure
+    @config ||= defaults
+    yield @config
+  end
+
+  def self.defaults
+    struct.tap do |config|
+      domain = platform_domain_from_env
+
+      config.laboratory_url = ENV['MUMUKI_LABORATORY_URL'] || "http://#{domain}"
+      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
+    end
+  end
+
+  def self.platform_domain_from_env
+    if ENV['RACK_ENV'] == 'test' || ENV['RAILS_ENV'] == 'test'
+      'localmumuki.io'
+    else
+      ENV['MUMUKI_PLATFORM_DOMAIN'] || 'mumuki.io'
+    end
+  end
+
+  def self.config
+    @config
+  end
+end
+
+require_relative './platform/application'
+require_relative './platform/organization_mapping'
+require_relative './platform/web_framework'
+require_relative './platform/with_applications'
+require_relative './platform/with_organization_mapping'
+
+module Mumukit::Platform
+  extend Mumukit::Platform::WithApplications
+  extend Mumukit::Platform::WithOrganizationMapping
+end

data/mumukit-platform.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mumukit/platform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mumukit-platform'
+  spec.version       = Mumukit::Platform::VERSION
+  spec.authors       = ['Franco Leonardo Bulgarelli']
+  spec.email         = ['franco@mumuki.org']
+
+  spec.summary       = %q{Shared Mumuki Platform Components}
+  spec.description   = %q{Library for accessing shared models of the Mumuki Platform}
+  spec.homepage      = 'https://mumuki.io'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mumukit-core', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mumukit-platform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Franco Leonardo Bulgarelli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mumukit-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Library for accessing shared models of the Mumuki Platform
+email:
+- franco@mumuki.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mumukit/platform.rb
+- lib/mumukit/platform/application.rb
+- lib/mumukit/platform/organization_mapping.rb
+- lib/mumukit/platform/uri.rb
+- lib/mumukit/platform/version.rb
+- lib/mumukit/platform/web_framework.rb
+- lib/mumukit/platform/with_applications.rb
+- lib/mumukit/platform/with_organization_mapping.rb
+- mumukit-platform.gemspec
+homepage: https://mumuki.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Shared Mumuki Platform Components
+test_files: []