mumuki-bibliotheca 6.1.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18df96dc9b7855810a92637771997a49de9e1e8e8466ec059e2356c23fdb38cc
-  data.tar.gz: 33701f7db090a41ede274c8237f9dea5d07449f5666bee5bc709cf031e1742e3
+  metadata.gz: c3452b76785a90e339640007046881e3809e48c6ce158eee40eeb65b6752d41d
+  data.tar.gz: de7f3eaaec9d4a7374b092bd8e96d23b4b71f36806aa1d45f6d64bd5bb1a0882
 SHA512:
-  metadata.gz: c87f0397d47f4d4fd300229840256b963d32deaa2397cfb19092d2d9297c219c3021f2ca76cd55269130d7e4015b60bcbb27697ec08ca7c21eb69dd701f435ab
-  data.tar.gz: f7ee7e4502f59c5c8ab6b7335c00a935427bce5737ebad821f3cabe3b63c3f125cd98572d028429f3a1e1c7e21551c57e84d4d1df270fb07b7c4fce5d41788d6
+  metadata.gz: 9dd4c6cc8910b5fb34a7ff19f2895d7b6d8f27c6ae35a50759fbc151a8566e57edc172fdfbb1f3e81ccba893561f81bc2dcba7d4b5d4210539f07daede005ff0
+  data.tar.gz: dcbda9975fa69aaaed8c335655976736bd29f92fcee7fcf73518832a8b72158fc891ef6140f59c041096bd602ebee694058cd100bc5ec9d9f409c7226b4482ad

data/README.md

@@ -19,22 +19,17 @@ Bibliotheca is a service for storing Mumuki content - Books, Topics and Guides.
 ## Preparing environment
 
 ### 1. Install essentials and base libraries
-
-> First, we need to install some software: MongoDB and some common Ruby on Rails native dependencies
-
-1. Follow [MongoDB installation guide](https://docs.mongodb.com/v3.2/tutorial/install-mongodb-on-ubuntu/)
-2. Run:
+> First, we need to install some software: [PostgreSQL](https://www.postgresql.org) database, [RabbitMQ](https://www.rabbitmq.com/) queue, and some common Ruby on Rails native dependencies
 
 ```bash
-sudo apt-get install autoconf curl git build-essential libssl-dev autoconf bison libreadline6 libreadline6-dev zlib1g zlib1g-dev
+sudo apt-get install autoconf curl git build-essential libssl-dev autoconf bison libreadline6 libreadline6-dev zlib1g zlib1g-dev postgresql libpq-dev rabbitmq-server
 ```
 
 ### 2. Install rbenv
-
 > [rbenv](https://github.com/rbenv/rbenv) is a ruby versions manager, similar to rvm, nvm, and so on.
 
 ```bash
-curl https://raw.githubusercontent.com/rbenv/rbenv-installer/master/bin/rbenv-installer | bash
+curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-installer | bash
 echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc # or .bash_profile
 echo 'eval "$(rbenv init -)"' >> ~/.bashrc # or .bash_profile
 ```
@@ -48,7 +43,6 @@ rbenv install 2.3.1
 rbenv global 2.3.1
 rbenv rehash
 gem install bundler
-gem install escualo
 ```
 
 ### 4. Clone this repository
@@ -56,8 +50,27 @@ gem install escualo
 > Because, err... we need to clone this repostory before developing it :stuck_out_tongue:
 
 ```bash
-git clone https://github.com/mumuki/mumuki-bibliotheca-api bibliotheca-api
-cd bibliotheca-api
+git clone https://github.com/mumuki/mumuki-bibliotheca-api
+cd mumuki-bibliotheca-api
+```
+
+### 5. Install and setup database
+
+> We need to create a PostgreSQL role - AKA a user - who will be used by Laboratory to create and access the database
+
+```bash
+# create db user for linux users
+sudo -u postgres psql <<EOF
+  create role mumuki with createdb login password 'mumuki';
+EOF
+
+# create db user for mac users
+psql postgres
+#once inside postgres server
+create role mumuki with createdb login password 'mumuki';
+
+# create schema and initial development data
+./devinit
 ```
 
 ## Installing and Running

data/lib/mumuki/bibliotheca/engine.rb

@@ -1,7 +1,7 @@
 module Mumuki
   module Bibliotheca
     class Engine < ::Rails::Engine
-      endpoint Sinatra::Application.new
+      endpoint Mumuki::Bibliotheca::App
       config.generators.api_only = true
     end
   end

data/lib/mumuki/bibliotheca/sinatra/books.rb

@@ -1,29 +1,31 @@
-helpers do
-  def list_books(books)
-    { books: books.as_json(only: [:name, :slug, :chapters]) }
+class Mumuki::Bibliotheca::App < Sinatra::Application
+  helpers do
+    def list_books(books)
+      { books: books.as_json(only: [:name, :slug, :chapters]) }
+    end
   end
-end
 
-get '/books' do
-  list_books Book.all
-end
+  get '/books' do
+    list_books Book.all
+  end
 
-get '/books/writable' do
-  list_books Book.allowed(current_user.permissions)
-end
+  get '/books/writable' do
+    list_books Book.allowed(current_user.permissions)
+  end
 
-get '/books/:organization/:repository' do
-  Book.find_by_slug!(slug.to_s).to_resource_h
-end
+  get '/books/:organization/:repository' do
+    Book.find_by_slug!(slug.to_s).to_resource_h
+  end
 
-post '/books' do
-  upsert! :book
-end
+  post '/books' do
+    upsert! :book
+  end
 
-post '/book/:organization/:repository/fork' do
-  fork! Book
-end
+  post '/book/:organization/:repository/fork' do
+    fork! Book
+  end
 
-delete '/books/:organization/:repository' do
-  delete! Book
+  delete '/books/:organization/:repository' do
+    delete! Book
+  end
 end

data/lib/mumuki/bibliotheca/sinatra/guides.rb

@@ -1,45 +1,47 @@
-helpers do
-  def list_guides(guides)
-    { guides: guides.map { |it| it.as_json(only: [:name, :slug, :type]).merge(language: it.language.name) } }
+class Mumuki::Bibliotheca::App < Sinatra::Application
+  helpers do
+    def list_guides(guides)
+      { guides: guides.map { |it| it.as_json(only: [:name, :slug, :type]).merge(language: it.language.name) } }
+    end
+
+    def slice_guide_resource_h_for_api(guide)
+      guide.merge(language: guide.dig(:language, :name)).merge(exercises: guide[:exercises].map { |it| it.tap { |it| it[:language] = it.dig(:language, :name) if it[:language]}})
+    end
   end
 
-  def slice_guide_resource_h_for_api(guide)
-    guide.merge(language: guide.dig(:language, :name)).merge(exercises: guide[:exercises].map { |it| it.tap { |it| it[:language] = it.dig(:language, :name) if it[:language]}})
+  get '/guides' do
+    list_guides Guide.visible(current_user&.permissions)
   end
-end
-
-get '/guides' do
-  list_guides Guide.visible(current_user&.permissions)
-end
 
-get '/guides/writable' do
-  list_guides Guide.allowed(current_user&.permissions)
-end
+  get '/guides/writable' do
+    list_guides Guide.allowed(current_user&.permissions)
+  end
 
-delete '/guides/:organization/:repository' do
-  delete! Guide
-end
+  delete '/guides/:organization/:repository' do
+    delete! Guide
+  end
 
-get '/guides/:organization/:repository/markdown' do
-  slice_guide_resource_h_for_api Guide.find_by_slug!(slug.to_s).to_markdownified_resource_h
-end
+  get '/guides/:organization/:repository/markdown' do
+    slice_guide_resource_h_for_api Guide.find_by_slug!(slug.to_s).to_markdownified_resource_h
+  end
 
-get '/guides/:organization/:repository' do
-  slice_guide_resource_h_for_api Guide.find_by_slug!(slug.to_s).to_resource_h
-end
+  get '/guides/:organization/:repository' do
+    slice_guide_resource_h_for_api Guide.find_by_slug!(slug.to_s).to_resource_h
+  end
 
-post '/guides' do
-  upsert! :guide
-end
+  post '/guides' do
+    upsert! :guide
+  end
 
-post '/guides/import/:organization/:repository' do
-  history_syncer.locate_and_import! :guide, slug.to_s
-end
+  post '/guides/import/:organization/:repository' do
+    history_syncer.locate_and_import! :guide, slug.to_s
+  end
 
-post '/guides/:organization/:repository/assets' do
-  Mumuki::Bibliotheca.upload_asset! slug, json_body['filename'], json_body['content']
-end
+  post '/guides/:organization/:repository/assets' do
+    Mumuki::Bibliotheca.upload_asset! slug, json_body['filename'], json_body['content']
+  end
 
-post '/guides/:organization/:repository/fork' do
-  fork! Guide
+  post '/guides/:organization/:repository/fork' do
+    fork! Guide
+  end
 end

data/lib/mumuki/bibliotheca/sinatra/languages.rb

@@ -1,9 +1,11 @@
-get '/languages' do
-  { languages: Language.all.map { |it| transform(it) } }
-end
+class Mumuki::Bibliotheca::App < Sinatra::Application
+  get '/languages' do
+    { languages: Language.all.map { |it| transform(it) } }
+  end
 
-def transform(language)
-  language
-    .to_resource_h
-    .replace_key!(:runner_url, :test_runner_url)
+  def transform(language)
+    language
+      .to_resource_h
+      .replace_key!(:runner_url, :test_runner_url)
+  end
 end

data/lib/mumuki/bibliotheca/sinatra/organization.rb

@@ -1,3 +1,5 @@
-get '/organization' do
-  Organization.base.to_resource_h
+class Mumuki::Bibliotheca::App < Sinatra::Application
+  get '/organization' do
+    Organization.base.to_resource_h
+  end
 end

data/lib/mumuki/bibliotheca/sinatra/topics.rb

@@ -1,29 +1,31 @@
-helpers do
-  def list_topics(topics)
-    { topics: topics.as_json(only: [:name, :slug]) }
+class Mumuki::Bibliotheca::App < Sinatra::Application
+  helpers do
+    def list_topics(topics)
+      { topics: topics.as_json(only: [:name, :slug]) }
+    end
   end
-end
 
-get '/topics' do
-  list_topics Topic.all
-end
+  get '/topics' do
+    list_topics Topic.all
+  end
 
-get '/topics/writable' do
-  list_topics Topic.allowed(current_user.permissions)
-end
+  get '/topics/writable' do
+    list_topics Topic.allowed(current_user.permissions)
+  end
 
-get '/topics/:organization/:repository' do
-  Topic.find_by_slug!(slug.to_s).to_resource_h
-end
+  get '/topics/:organization/:repository' do
+    Topic.find_by_slug!(slug.to_s).to_resource_h
+  end
 
-post '/topics' do
-  upsert! :topic
-end
+  post '/topics' do
+    upsert! :topic
+  end
 
-post '/book/:organization/:repository/fork' do
-  fork! Topic
-end
+  post '/book/:organization/:repository/fork' do
+    fork! Topic
+  end
 
-delete '/topics/:organization/:repository' do
-  delete! Topic
+  delete '/topics/:organization/:repository' do
+    delete! Topic
+  end
 end

data/lib/mumuki/bibliotheca/sinatra.rb

@@ -1,4 +1,4 @@
-require 'sinatra'
+require 'sinatra/base'
 require 'mumukit/content_type'
 
 require 'sinatra/cross_origin'
@@ -8,167 +8,168 @@ require 'mumukit/auth'
 require 'json'
 require 'yaml'
 
-configure do
-  enable :cross_origin
-  set :allow_methods, [:get, :put, :post, :options, :delete]
-  set :show_exceptions, false
+class Mumuki::Bibliotheca::App < Sinatra::Application
+  configure do
+    enable :cross_origin
+    set :allow_methods, [:get, :put, :post, :options, :delete]
+    set :show_exceptions, false
 
-  set :app_name, 'bibliotheca'
-  set :static, true
-  set :public_folder, 'public'
+    set :app_name, 'bibliotheca'
+    set :static, true
+    set :public_folder, 'public'
 
-  use ::Rack::CommonLogger, Rails.logger
-end
-
-helpers do
-  def json_body
-    @json_body ||= JSON.parse(request.body.read) rescue nil
+    use ::Rack::CommonLogger, Rails.logger
   end
 
-  def slug
-    if route_slug_parts.present?
-      Mumukit::Auth::Slug.join(*route_slug_parts)
-    elsif subject
-      Mumukit::Auth::Slug.parse(subject.slug)
-    elsif json_body
-      Mumukit::Auth::Slug.parse(json_body['slug'])
-    else
-      raise Mumukit::Auth::InvalidSlugFormatError.new('Slug not available')
+  helpers do
+    def json_body
+      @json_body ||= JSON.parse(request.body.read) rescue nil
     end
-  end
 
-  def route_slug_parts
-    []
+    def slug
+      if route_slug_parts.present?
+        Mumukit::Auth::Slug.join(*route_slug_parts)
+      elsif subject
+        Mumukit::Auth::Slug.parse(subject.slug)
+      elsif json_body
+        Mumukit::Auth::Slug.parse(json_body['slug'])
+      else
+        raise Mumukit::Auth::InvalidSlugFormatError.new('Slug not available')
+      end
+    end
+
+    def route_slug_parts
+      []
+    end
   end
-end
 
-before do
-  content_type 'application/json', 'charset' => 'utf-8'
-end
+  before do
+    content_type 'application/json', 'charset' => 'utf-8'
+  end
 
-after do
-  error_message = env['sinatra.error']
-  if response.body.is_a?(Array)&& response.body[0].is_a?(String)
-    if content_type != 'application/csv'
-      content_type 'text/html'
-      response.body[0] = <<HTML
+  after do
+    error_message = env['sinatra.error']
+    if response.body.is_a?(Array)&& response.body[0].is_a?(String)
+      if content_type != 'application/csv'
+        content_type 'text/html'
+        response.body[0] = <<HTML
     <html>
       <body>
         #{response.body[0]}
       </body>
     </html>
 HTML
+      end
+      response.body = response.body[0]
+    elsif error_message.blank?
+      response.body = response.body.to_json
+    else
+      response.body = {message: env['sinatra.error'].message}.to_json
     end
-    response.body = response.body[0]
-  elsif error_message.blank?
-    response.body = response.body.to_json
-  else
-    response.body = {message: env['sinatra.error'].message}.to_json
   end
-end
-
-error JSON::ParserError do
-  halt 400
-end
 
-error Mumukit::Auth::InvalidTokenError do
-  halt 401
-end
-
-error Mumukit::Auth::UnauthorizedAccessError do
-  halt 403
-end
-
-error ActiveRecord::RecordInvalid do
-  halt 400
-end
-
-error Mumukit::Auth::InvalidSlugFormatError do
-  halt 400
-end
-
-error ActiveRecord::RecordNotFound do
-  halt 404
-end
-
-options '*' do
-  response.headers['Allow'] = settings.allow_methods.map { |it| it.to_s.upcase }.join(',')
-  response.headers['Access-Control-Allow-Headers'] = 'X-Mumuki-Auth-Token, X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept, Authorization'
-  200
-end
-
-helpers do
-  Mumukit::Login.configure_controller! self
-end
-
-before do
-  I18n.locale = 'en' #TODO: Remove hardcoded locale
-end
+  error JSON::ParserError do
+    halt 400
+  end
 
-helpers do
-  def authenticate!
-    halt 401 unless current_user?
+  error Mumukit::Auth::InvalidTokenError do
+    halt 401
   end
 
-  def authorization_slug
-    slug
+  error Mumukit::Auth::UnauthorizedAccessError do
+    halt 403
   end
 
-  def subject
-    Guide.find_by_id(params[:id])
+  error ActiveRecord::RecordInvalid do
+    halt 400
   end
 
-  def route_slug_parts
-    [params[:organization], params[:repository]].compact
+  error Mumukit::Auth::InvalidSlugFormatError do
+    halt 400
   end
 
-  def history_syncer
-    Mumuki::Bibliotheca.history_syncer(current_user)
+  error ActiveRecord::RecordNotFound do
+    halt 404
   end
 
-  def api_syncer
-    Mumuki::Bibliotheca.api_syncer(json_body)
+  options '*' do
+    response.headers['Allow'] = settings.allow_methods.map { |it| it.to_s.upcase }.join(',')
+    response.headers['Access-Control-Allow-Headers'] = 'X-Mumuki-Auth-Token, X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept, Authorization'
+    200
   end
 
-  def upsert!(content_kind)
-    authorize! :writer
-    content = api_syncer.locate_and_import! content_kind, slug.to_s
-    history_syncer.export! content
-    content.to_resource_h
+  helpers do
+    Mumukit::Login.configure_controller! self
   end
 
-  def fork!(collection_class)
-    authorize! :writer
-    destination = json_body['organization']
-    collection_class.find_by_slug!(slug.to_s).fork_to!(destination, history_syncer).as_json
+  before do
+    I18n.locale = 'en' #TODO: Remove hardcoded locale
   end
 
-  def delete!(collection_class)
-    authorize! :editor
-    collection_class.find_by_slug!(slug.to_s).destroy!
-    {}
+  helpers do
+    def authenticate!
+      halt 401 unless current_user?
+    end
+
+    def authorization_slug
+      slug
+    end
+
+    def subject
+      Guide.find_by_id(params[:id])
+    end
+
+    def route_slug_parts
+      [params[:organization], params[:repository]].compact
+    end
+
+    def history_syncer
+      Mumuki::Bibliotheca.history_syncer(current_user)
+    end
+
+    def api_syncer
+      Mumuki::Bibliotheca.api_syncer(json_body)
+    end
+
+    def upsert!(content_kind)
+      authorize! :writer
+      content = api_syncer.locate_and_import! content_kind, slug.to_s
+      history_syncer.export! content
+      content.to_resource_h
+    end
+
+    def fork!(collection_class)
+      authorize! :writer
+      destination = json_body['organization']
+      collection_class.find_by_slug!(slug.to_s).fork_to!(destination, history_syncer).as_json
+    end
+
+    def delete!(collection_class)
+      authorize! :editor
+      collection_class.find_by_slug!(slug.to_s).destroy!
+      {}
+    end
   end
-end
 
-post '/markdown' do
-  {markdown: Mumukit::ContentType::Markdown.to_html(json_body['markdown'])}
-end
+  post '/markdown' do
+    {markdown: Mumukit::ContentType::Markdown.to_html(json_body['markdown'])}
+  end
 
-post '/markdowns' do
-  json_body.with_indifferent_access.tap do |guide|
-    guide[:exercises].each do |exercise|
-      exercise[:description] = Mumukit::ContentType::Markdown.to_html(exercise[:description])
+  post '/markdowns' do
+    json_body.with_indifferent_access.tap do |guide|
+      guide[:exercises].each do |exercise|
+        exercise[:description] = Mumukit::ContentType::Markdown.to_html(exercise[:description])
+      end
     end
   end
-end
 
-get '/permissions' do
-  authenticate!
+  get '/permissions' do
+    authenticate!
 
-  {permissions: current_user.permissions}
+    {permissions: current_user.permissions}
+  end
 end
 
-
 require_relative './sinatra/organization'
 require_relative './sinatra/languages'
 require_relative './sinatra/guides'

data/lib/mumuki/bibliotheca/version.rb

@@ -1,5 +1,5 @@
 module Mumuki
   module Bibliotheca
-    VERSION = '6.1.1'
+    VERSION = '6.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-bibliotheca
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.0
 platform: ruby
 authors:
 - Franco Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sinatra-cross_origin
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   name: mumukit-login
   requirement: !ruby/object:Gem::Requirement
@@ -179,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
 summary: API for editing content on mumuki