teamster 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d93ad44983fe5b937e8c559ec945eb74a45dda9
-  data.tar.gz: 838c9848d967b9ea66e17b372bb54cc51979a726
+  metadata.gz: efa78525723570ac964b9cde25d7188e4cbcc2fc
+  data.tar.gz: 0df540f5059c29981a08704f42425bb56dcfb8eb
 SHA512:
-  metadata.gz: 825caf684e6dbf9711cb325e7543b6c3ff3627cf5605600702c464b27b5b1b88c7968977cfe2da59cd010e3818f164bcf5fe3809680177f9fb2f6ee9ee14b8dc
-  data.tar.gz: 66497ff2540821ce4deb8fa7bceadf39d6482fcde393274895c60a0e4933c69991b6802d73b24ef45d995dfd16ccc5995e8c87f42c0975daa8e2a3690c94d180
+  metadata.gz: e48c0e5723c8aabecb87c897300db7037ef86057bd87e9cd2e666b07012346567fadbd8f44c1fbabc8ded588ddcbaa35a92720f959ed675d344c6937ea27cd9b
+  data.tar.gz: 9852bdffc5ef8d64fc424328445ec5f0f0ed65bfc64141ce510fe8e8a35212a303cf919335a256c1c64ca002bf036b9f5ddfa20ee49056eefa79d153ea6a6663

data/README.md

@@ -22,6 +22,10 @@ Teamster has been packaged into a gem. To install, simply run `gem install teams
 
 Open a browser and point to http://localhost:9292. A bare teamster page should be shown.
 
+#### Login Credentials
+
+Right now, the default login credential is "Administrator/password". There is no way to create new users, short of modifying the users file directly.
+
 
 ## Running In A "Production" Environment
 
@@ -65,8 +69,17 @@ This will create the following files in your site folder:
 * lib/teamster-modules/MODULENAME.rb
 * lib/teamster-modules/MODULENAME/views/MODULENAME.erb
 
-In MODULENAME.rb, a class MODULENAME will be created. While it may sub-class from Teamster::Module::Base, it is also a sub-class of Sinatra::Base. When developing it, you can use helper methods and other nifty stuff available from Sinatra. However, do take note of the scoping.
+In MODULENAME.rb, a class MODULENAME will be created. It is subclassed from Sinatra::Base and it also includes some helper class methods from Teamster::Modules::BaseModule. When developing it, you can treat it just like a Sinatra web application.
+
+#### Conventions To Adhere To
+
+Your teamster module application should reside in the `lib/teamster-modules` folder, and all other files should be in the `lib/teamster-modules/<modulename>` folder. Thie will help greatly when importing and exporting. If you need to modulename configuration, data or other content, please store them in subfolders, for example, `lib/teamster-modules/<modulename>/conf`.
+
+The only exception to this rule are css & javascript files. Name your files as `<modulename>.css` & `<modulename>.js` and place them in the public/css & public/js folders respectively.
+
+When creating HTTP routes, your base route should always be `/<modulename>`. Other routes for your teamster module should be children of this route.
 
+When creating views, your summary view should be named `<modulename>_summary.erb` in lowercase. It is highly encouraged for other views of the same module to be prepended with `<modulename>_`.
 
 #### Helpers Available To Modules
 
@@ -78,9 +91,9 @@ This returns `true` or `false`. Useful to check if a user has logged in.
 
     get '/login_checker' do
       if logged_in?
-        puts "User has logged in."
+        "User has logged in."
       else
-        puts "You are not logged in."
+        "You are not logged in."
       end
     end
 
@@ -95,7 +108,7 @@ This halts a route from being run if a user has not yet logged in. Once a user h
 
 * **current_user**
 
-This just returns the username (or canonical name) of the currently logged in user. Since login is not yet implemented, this returns some random string.
+This just returns the username of the currently logged in user.
 
     get '/show_name' do
       login_required

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.1

data/bin/teamster

@@ -5,6 +5,7 @@ require 'getoptlong'
 require 'yaml'
 require 'bcrypt'
 require 'base64'
+require "#{File.dirname(__FILE__)}/../lib/teamster-cli"
 
 DEFAULT_UNIX_SOCKET_FILE = '/tmp/teamster.app.sock'
 DEFAULT_APP_STATE_FILE   = '/srv/my-site/teamster.app.state'
@@ -12,6 +13,8 @@ CONFIG_FILE              = 'conf/teamster.conf'
 VERSION = File.read(File.dirname(__FILE__) + '/../VERSION')
 
 class TeamsterApp
+  include Teamster::CLI
+
   class << self
     def read_options_and_run
       read_options
@@ -25,9 +28,6 @@ class TeamsterApp
         ["--prod",                 GetoptLong::NO_ARGUMENT      ],
         ["--help",                 GetoptLong::NO_ARGUMENT      ],
         ["--overwrite",            GetoptLong::NO_ARGUMENT      ],
-        ["--create-module",        GetoptLong::REQUIRED_ARGUMENT],
-        ["--import-module",        GetoptLong::REQUIRED_ARGUMENT],
-        ["--export-module",        GetoptLong::REQUIRED_ARGUMENT],
         ["--socket-file",          GetoptLong::REQUIRED_ARGUMENT],
         ["--state-file",           GetoptLong::REQUIRED_ARGUMENT])
       @config = {}.tap do |hsh|
@@ -45,15 +45,10 @@ class TeamsterApp
         quit detailed_usage
       elsif @config[:version]
         quit show_version
-      elsif name = @config[:create_module]
-        create_module_for name.downcase
-      elsif name = @config[:import_module]
-        import_module_for name.downcase
-      elsif name = @config[:export_module]
-        export_module_for name.downcase
-      elsif ARGV.size == 1
-        command = ARGV.first.to_sym
-        send command
+      elsif ARGV.size > 0
+        command = ARGV.shift.to_sym
+        args = ARGV
+        send command, *args
       else
         quit usage
       end
@@ -63,13 +58,14 @@ class TeamsterApp
 
     # --{ COMMANDS }-- #
 
-    def init
+    def init(*args)
       current_working_folder = Dir.pwd
+      team_name = args[0]
       content = File.dirname(__FILE__) + '/../content'
       puts "Initializing Teamster in current folder."
       puts "Creating required content..."
       FileUtils.mkdir_p "conf"
-      create_config
+      create_config team_name
       FileUtils.mkdir_p "data"
       create_user
       FileUtils.cp_r "#{content}/views", current_working_folder
@@ -78,11 +74,11 @@ class TeamsterApp
       FileUtils.mkdir_p "lib/teamster-modules"
       create_file "lib/teamster-modules.rb", "teamster_modules"
       puts "Teamster initialized!"
-      puts "- Run \"teamster --create-module <NAME>\" to create a placeholder module."
+      puts "- Run \"teamster create <NAME>\" to create a placeholder module."
       puts "- Run \"teamster start\" to start teamster!"
     end
 
-    def start
+    def start(*)
       puts "Starting teamster..."
       if File.exists?(CONFIG_FILE)
         if @config[:prod]
@@ -97,7 +93,7 @@ class TeamsterApp
       end
     end
 
-    def stop
+    def stop(*)
       puts "Stopping teamster..."
       state_file  = @config[:state_file] || DEFAULT_APP_STATE_FILE
       if File.exists? state_file
@@ -108,7 +104,7 @@ class TeamsterApp
       end
     end
 
-    def restart
+    def restart(*)
       puts "Restarting teamster..."
       state_file  = @config[:state_file] || DEFAULT_APP_STATE_FILE
       if File.exists? state_file
@@ -118,228 +114,23 @@ class TeamsterApp
       end
     end
 
-    # --{ HELPERS }-- #
-
-    def quit(msg, code = 0)
-      warn msg
-      exit code
-    end
-
-    def create_config
-      ask_user_for :title, "What is your team name"
-      File.open(CONFIG_FILE, 'w') {|fh| fh.write @config.to_yaml}
+    def create(*args)
+      name = args[0]
+      create_module_for name.downcase
     end
 
-    def create_user
-      puts "Creating default user.."
-      users = [{"name" => "Administrator", "pass" => b64_enc(BCrypt::Password.create("password"))}]
-      File.open("./data/users", "w") do |fh|
-        fh.write({"users" => users}.to_yaml)
-      end
-      FileUtils.chmod 0600, './data/users'
-    end
-
-    def b64_enc(obj)
-      Base64.strict_encode64(obj)
+    def import(*args)
+      name = args[0]
+      import_module_for name.downcase
     end
 
-    def ask_user_for(opt, question)
-      unless @config[opt]
-        @config[opt] = ask_user question
-      end
-    end
-
-    def ask_user(question)
-      print "#{question}: "
-      STDIN.gets.strip
-    end
-
-    def create_module_for(name)
-      puts "Creating placeholders for module #{name}...\n"
-      FileUtils.mkdir_p "lib/teamster-modules/#{name}/views"
-      create_file "lib/teamster-modules/#{name}.rb", "module_placeholder_for", name
-      create_file "lib/teamster-modules/#{name}/#{name}_helper.rb", "module_helper_placeholder_for", name
-      create_file "lib/teamster-modules/#{name}/views/#{name}.erb", "view_placeholder_for", name
-      create_file "lib/teamster-modules/#{name}/views/#{name}_summary.erb", "view_summary_placeholder_for", name
-      puts "\nBasic module creation done!"
-      puts "Controller   : \"lib/teamster-modules/#{name}.rb\""
-      puts "Helper       : \"lib/teamster-modules/#{name}/#{name}_helper.rb\""
-      puts "View         : \"lib/teamster-modules/#{name}/views/#{name}.erb\""
-      puts "Summary View : \"lib/teamster-modules/#{name}/views/#{name}_summary.erb\""
-    end
-
-    def import_module_for(name)
-      puts "Importing module: #{name}"
-      zip_file = "#{name}.zip"
-      if File.exists?(zip_file)
-        if `which unzip`.length != 0
-          `unzip #{zip_file}`
-          puts "\nSuccessfully imported #{name}. Please restart teamster to use."
-        else
-          puts "\nUnable to import module. Export depends on cli tool \"unzip\"."
-        end
-      else
-        puts "Unable to find file: #{zip_file}"
-      end
+    def export(*args)
+      name = args[0]
+      export_module_for name.downcase
     end
 
-    def export_module_for(name)
-      puts "Exporting module: #{name}"
-      zip_file = "#{name}.zip"
-      puts "The following files will be zipped:"
-      puts "- lib/teamster-modules/#{name}.rb"
-      puts '- Everything in folder lib/teamster-modules/#{name}/'
-      if `which zip`.length != 0
-        `zip -r #{zip_file} lib/teamster-modules/#{name}.rb lib/teamster-modules/#{name}/`
-        puts "\nExported to #{zip_file}!"
-      else
-        puts "\nUnable to export module. Export depends on cli tool \"zip\"."
-      end
-    end
-
-    def create_file(filename, method, *args)
-      case [File.exists?(filename), !!@config[:overwrite]]
-      when [true, false]
-        puts "File \"#{filename}\" exists. Run with --overwrite to overwrite file."
-      else
-        puts "Creating file #{filename}..."
-        File.open(filename, "w") {|fh| fh.write(send(method.to_sym, *args))}
-      end
-    end
-
-    def show_version
-      "Current version of teamster: #{VERSION}"
-    end
-
-    def usage
-      <<-HELP
-Initialize application:
-  teamster init
-
-Run web application:
-  teamster start
-
-Run web application in production (uses unix socket & state file):
-  teamster start --prod [--socket-file FILE] [--state-file FILE]
-
-Verify by opening browser and navigating to "http://localhost:9292".
-
-For more detailed help, please run "teamster --help".
-      HELP
-    end
-
-    def detailed_usage
-      <<-DETAIL
-Teamster is a simple and extensible web portal for teams.
-
-Current version: #{VERSION}
-
-Usage:
-  teamster [COMMAND] [OPTIONS]
-
-Commands:
-  init, start, stop, restart
-
-Options (standalone):
-  --help                    Display this detailed help.
-  --version                 Version of the teamster used.
-  --create-module NAME      Creates a stub of a module
-  --import-module FILE      << PENDING IMPLEMENTATION >>
-  --export-module FILE      << PENDING IMPLEMENTATION >>
-
-
-Options used with \"start\":
-  --prod                    Binds a unix socket to be used by a web
-                            server (eg. Nginx) and creates a state file
-                            that is used by the Puma app server.
-  --socket-file FILE        Relative/absolute path to the UNIX socket file.
-  --state-file FILE         Relative/absolute path to the Puma state file.
-
-
-Options used with \"stop\":
-  --socket-file FILE        Relative/absolute path to the UNIX socket file.
-  --state-file FILE         Relative/absolute path to the Puma state file.
-
-
-Options used with \"restart\":
-  --socket-file FILE        Relative/absolute path to the UNIX socket file.
-  --state-file FILE         Relative/absolute path to the Puma state file.
-      DETAIL
-    end
-
-    def config_ru
-      <<-CODE
-require 'teamster'
-Dir.glob("lib/*.rb").each {|file| require File.absolute_path(file)}
-run Teamster::Core::App
-      CODE
-    end
-
-    def teamster_modules
-      <<-CODE
-Dir.glob(File.dirname(__FILE__) + '/teamster-modules/*.rb').each do |mdl|
-  require mdl
-end
-      CODE
-    end
-
-    def module_placeholder_for(name)
-      <<-CODE
-require_relative \"#{name}/#{name}_helper\"
-
-\# NOTE: If the namespace is changed, please take care of the
-\#       namespace of the sub-class and helper modules.
-
-module Teamster
-  module Modules
-    class #{name.capitalize} < Base
-      \# Stuff that needs to be done before registration with core.
-      has_helpers #{name.capitalize}Helper \# Add modules here (comma separated) if there are helper modules.
-      views_at \"\#\{File.dirname(__FILE__)\}/#{name}/views\"
-      under_development \# Remove this line when development is finished.
-
-      \# Register this class so it can be used.
-      register self
-
-      get '/#{name}/?' do
-        erb :#{name}
-      end
-    end
-  end
-end
-      CODE
-    end
-
-    def module_helper_placeholder_for(name)
-      <<-CODE
-module Teamster
-  module Modules
-    module #{name.capitalize}Helper
-      def #{name}_summary?
-        true
-      end
-
-      def #{name}_summary
-        erb :#{name}_summary
-      end
-    end
-  end
-end
-      CODE
-    end
-
-    def view_placeholder_for(name)
-      <<-CODE
-<h1 style='text-align: center'>PLACEHOLDER FOR #{name.upcase}</h1>
-<p style='text-align: center'>Page under construction. Please check back later!</p>
-      CODE
-    end
+    # --{ HELPERS }-- #
 
-    def view_summary_placeholder_for(name)
-      <<-CODE
-<p>Under development right now..</p>
-      CODE
-    end
   end
 end
 

data/lib/teamster/base_module.rb

@@ -1,7 +1,11 @@
 module Teamster
   module Modules
-    class Base < Sinatra::Base
-      class << self
+    module BaseModule
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
         def register(klass)
           Teamster::Core::App.use_module klass
         end

data/lib/teamster-cli.rb

@@ -0,0 +1,237 @@
+module Teamster
+  module CLI
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def quit(msg, code = 0)
+        warn msg
+        exit code
+      end
+
+      def create_config(team_name)
+        if team_name
+          @config[:title] = team_name
+        else
+          ask_user_for :title, "What is your team name"
+        end
+        File.open(CONFIG_FILE, 'w') {|fh| fh.write @config.to_yaml}
+      end
+
+      def create_user
+        puts "Creating default user.."
+        users = [{"name" => "Administrator", "pass" => b64_enc(BCrypt::Password.create("password"))}]
+        File.open("./data/users", "w") do |fh|
+          fh.write({"users" => users}.to_yaml)
+        end
+        FileUtils.chmod 0600, './data/users'
+      end
+
+      def b64_enc(obj)
+        Base64.strict_encode64(obj)
+      end
+
+      def ask_user_for(opt, question)
+        unless @config[opt]
+          @config[opt] = ask_user question
+        end
+      end
+
+      def ask_user(question)
+        print "#{question}: "
+        STDIN.gets.strip
+      end
+
+      def create_module_for(name)
+        puts "Creating placeholders for module #{name}...\n"
+        FileUtils.mkdir_p "lib/teamster-modules/#{name}/views"
+        create_file "lib/teamster-modules/#{name}.rb", "module_placeholder_for", name
+        create_file "lib/teamster-modules/#{name}/#{name}_helper.rb", "module_helper_placeholder_for", name
+        create_file "lib/teamster-modules/#{name}/views/#{name}.erb", "view_placeholder_for", name
+        create_file "lib/teamster-modules/#{name}/views/#{name}_summary.erb", "view_summary_placeholder_for", name
+        puts "\nBasic module creation done!"
+        puts "Controller   : \"lib/teamster-modules/#{name}.rb\""
+        puts "Helper       : \"lib/teamster-modules/#{name}/#{name}_helper.rb\""
+        puts "View         : \"lib/teamster-modules/#{name}/views/#{name}.erb\""
+        puts "Summary View : \"lib/teamster-modules/#{name}/views/#{name}_summary.erb\""
+      end
+
+      def import_module_for(name)
+        puts "Importing module: #{name}"
+        zip_file = "#{name}.zip"
+        if File.exists?(zip_file)
+          if `which unzip`.length != 0
+            `unzip #{zip_file}`
+            puts "\nSuccessfully imported #{name}. Please restart teamster to use."
+          else
+            puts "\nUnable to import module. Export depends on cli tool \"unzip\"."
+          end
+        else
+          puts "Unable to find file: #{zip_file}"
+        end
+      end
+
+      def export_module_for(name)
+        puts "Exporting module: #{name}"
+        zip_file = "#{name}.zip"
+        puts "The following files will be zipped:"
+        puts "- lib/teamster-modules/#{name}.rb"
+        puts '- Everything in folder lib/teamster-modules/#{name}/'
+        if `which zip`.length != 0
+          `zip -r #{zip_file} lib/teamster-modules/#{name}.rb lib/teamster-modules/#{name}/`
+          puts "\nExported to #{zip_file}!"
+        else
+          puts "\nUnable to export module. Export depends on cli tool \"zip\"."
+        end
+      end
+
+      def create_file(filename, method, *args)
+        case [File.exists?(filename), !!@config[:overwrite]]
+        when [true, false]
+          puts "File \"#{filename}\" exists. Run with --overwrite to overwrite file."
+        else
+          puts "Creating file #{filename}..."
+          File.open(filename, "w") {|fh| fh.write(send(method.to_sym, *args))}
+        end
+      end
+
+      def show_version
+        "Current version of teamster: #{VERSION}"
+      end
+
+      def usage
+        <<-HELP
+Initialize application:
+  teamster init
+
+Run web application:
+  teamster start
+
+Run web application in production (uses unix socket & state file):
+  teamster start --prod [--socket-file FILE] [--state-file FILE]
+
+Verify by opening browser and navigating to "http://localhost:9292".
+
+For more detailed help, please run "teamster --help".
+        HELP
+      end
+
+      def detailed_usage
+        <<-DETAIL
+Teamster is a simple and extensible web portal for teams.
+
+Current version: #{VERSION}
+
+Usage:
+  teamster [COMMAND] [OPTIONS]
+
+Commands:
+  init, start, stop, restart
+
+Options (standalone):
+  --help                    Display this detailed help.
+  --version                 Version of the teamster used.
+  --create-module NAME      Creates a stub of a module
+  --import-module FILE      << PENDING IMPLEMENTATION >>
+  --export-module FILE      << PENDING IMPLEMENTATION >>
+
+
+Options used with \"start\":
+  --prod                    Binds a unix socket to be used by a web
+                            server (eg. Nginx) and creates a state file
+                            that is used by the Puma app server.
+  --socket-file FILE        Relative/absolute path to the UNIX socket file.
+  --state-file FILE         Relative/absolute path to the Puma state file.
+
+
+Options used with \"stop\":
+  --socket-file FILE        Relative/absolute path to the UNIX socket file.
+  --state-file FILE         Relative/absolute path to the Puma state file.
+
+
+Options used with \"restart\":
+  --socket-file FILE        Relative/absolute path to the UNIX socket file.
+  --state-file FILE         Relative/absolute path to the Puma state file.
+      DETAIL
+      end
+
+      def config_ru
+        <<-CODE
+require 'teamster'
+Dir.glob("lib/*.rb").each {|file| require File.absolute_path(file)}
+run Teamster::Core::App
+        CODE
+      end
+
+      def teamster_modules
+        <<-CODE
+Dir.glob(File.dirname(__FILE__) + '/teamster-modules/*.rb').each do |mdl|
+  require mdl
+end
+        CODE
+      end
+
+      def module_placeholder_for(name)
+        <<-CODE
+require_relative \"#{name}/#{name}_helper\"
+
+\# NOTE: If the namespace is changed, please take care of the
+\#       namespace of the sub-class and helper modules.
+
+module Teamster
+  module Modules
+    class #{name.capitalize} < Sinatra::Base
+      \# Class methods that contain Teamster-Module specific helpers.
+      include BaseModule
+
+      \# Stuff that needs to be done before registration with core.
+      has_helpers #{name.capitalize}Helper \# Add modules here (comma separated) if there are helper modules.
+      views_at \"\#\{File.dirname(__FILE__)\}/#{name}/views\"
+      under_development \# Remove this line when development is finished.
+
+      \# Register this class so it can be used.
+      register self
+
+      get '/#{name}/?' do
+        erb :#{name}
+      end
+    end
+  end
+end
+        CODE
+      end
+
+      def module_helper_placeholder_for(name)
+        <<-CODE
+module Teamster
+  module Modules
+    module #{name.capitalize}Helper
+      def #{name}_summary?
+        true
+      end
+
+      def #{name}_summary
+        erb :#{name}_summary
+      end
+    end
+  end
+end
+        CODE
+      end
+
+      def view_placeholder_for(name)
+        <<-CODE
+<h1 style='text-align: center'>PLACEHOLDER FOR #{name.upcase}</h1>
+<p style='text-align: center'>Page under construction. Please check back later!</p>
+        CODE
+      end
+
+      def view_summary_placeholder_for(name)
+        <<-CODE
+<p>Under development right now..</p>
+        CODE
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamster
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Nur Muhammad Bin Sirat
@@ -69,6 +69,7 @@ files:
 - content/views/login_required.erb
 - content/views/navbar.erb
 - content/views/no_summary.erb
+- lib/teamster-cli.rb
 - lib/teamster.rb
 - lib/teamster/base_module.rb
 - lib/teamster/core_helper.rb