magellan-cli 0.2.17 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f4e43cba003703ac59d09769322e20631ad8263
-  data.tar.gz: dc834f389b116d04f17462af5c516925625de761
+  metadata.gz: eb40bd948d572f7f0a642dc9b3baff058c112eb4
+  data.tar.gz: 50c8e29d10da813eddf77cf192ab9bb7e3782bf3
 SHA512:
-  metadata.gz: b091d5d9cd5597238b0551638f524d5050c64a1b554e6669e1810251bdf925a997448af46f455ed73522b3815587a2a18bfa591626721a0b910a02ff71f82af8
-  data.tar.gz: a42e0c771742a0ea42118f578f2c3bacf4a1b35899b908481fd58c1a972c1cdd03494bbecee193622e218690c740b3880dc5e5e736069c0a1e1e6a81ec2f403f
+  metadata.gz: e9d3a89a666fe6454a1c1bd1f1ccb65b7a6daa9f334ab253d86f65cae27a5aff4e35586e9a78abed6b7d457c794a5abe06cc5b51552143f02f9047fd0a22f7c2
+  data.tar.gz: d3db854dcefaa6d1a7b6bbc62b5566a355a473496331166e5ad1c49ae85ed0689672d07c707e40e1d1819cd117af02df8968c760e8a686f954901f62bca5e08e

data/Gemfile

@@ -5,4 +5,6 @@ gemspec
 
 group :development do
   gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    magellan-cli (0.2.17)
+    magellan-cli (0.2.18)
       activesupport (~> 4.1.4)
       groovenauts-thor
       httpclient (~> 2.5)
@@ -17,7 +17,15 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
     coderay (1.1.0)
+    columnize (0.9.0)
+    debug_inspector (0.0.2)
+    debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
     groovenauts-thor (0.19.1)
     httpclient (2.6.0.1)
@@ -32,6 +40,12 @@ GEM
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
+    pry-byebug (1.3.2)
+      byebug (~> 2.7)
+      pry (~> 0.9.12)
+    pry-stack_explorer (0.4.9.1)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
     rake (10.3.2)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)
@@ -58,5 +72,7 @@ DEPENDENCIES
   bundler (~> 1.6)
   magellan-cli!
   pry
+  pry-byebug
+  pry-stack_explorer
   rake (~> 10.0)
   rspec

data/README.md

@@ -18,6 +18,25 @@ Or install it yourself as:
 
     $ gem install magellan-cli
 
+
+## generate reference pages
+
+```
+DEST=/path/to/magellan-devcenter.github.io bundle exec rake reference
+```
+
+then 
+
+```
+cd /path/to/magellan-devcenter.github.io
+bundle exec jekyll serve
+```
+
+open http://localhost:4000/reference/magellan-cli
+
+After check the pages, you can commit the .md files to magellan-devcenter.github.io repogitory.
+
+
 ## Usage
 
 ### All-in-one patterns

data/Rakefile

@@ -13,3 +13,10 @@ module Bundler
     end
   end
 end
+
+desc "generate reference options: DEST, SUBDIR"
+task :reference do
+  require 'magellan/cli'
+  gen = Magellan::Cli::ReferenceGenerator.new(dest: ENV["DEST"] || "doc", subdir: ENV["SUBDIR"])
+  gen.run
+end

data/bin/magellan-cli

@@ -2,15 +2,4 @@
 
 require 'magellan/cli'
 
-begin
-  Magellan::Cli::Command.start(ARGV)
-rescue Magellan::Cli::Error => e
-  $stderr.puts("\e[31m#{e.message}\e[0m")
-  exit(1)
-rescue => e
-  verbose = ARGV.include?("-V") || ARGV.include?("--verbose")
-  msg = "\e[31m[#{e.class}] #{e.message}\e[0m"
-  msg << "\n  " << e.backtrace.join("\n  ") if verbose
-  $stderr.puts(msg)
-  exit(1)
-end
+Magellan::Cli::Command.start(ARGV)

data/lib/magellan/cli/base.rb

@@ -7,6 +7,7 @@ module Magellan
     class Base < Thor
       class_option :verbose, type: :boolean, aliases: "-V"
       class_option :dryrun , type: :boolean, aliases: "-D"
+      class_option :version, type: :boolean, aliases: "-v"
 
       no_commands do
 
@@ -29,17 +30,17 @@ module Magellan
         end
 
         def verbose(msg)
-          $stderr.puts("\e[34m#{msg}\e[0m") if verbose?
+          self.class.verbose(msg) if verbose?
         end
 
         def info(msg)
-          $stderr.puts(msg)
+          self.class.info(msg)
         end
         def success(msg)
-          $stderr.puts("\e[32m#{msg}\e[0m")
+          self.class.success(msg)
         end
         def error(msg)
-          $stderr.puts("\e[31m#{msg}\e[0m")
+          self.class.error(msg)
         end
 
         def fatal(msg)
@@ -48,6 +49,101 @@ module Magellan
         end
       end
 
+      class << self
+        def puts_with_color(color_no, msg)
+          $stderr.puts("\e[#{color_no}m#{msg}\e[0m")
+        end
+
+        def verbose(msg, flag = true)
+          puts_with_color(34, msg) if flag
+        end
+        def info(msg)
+          puts_with_color(0, msg)
+        end
+        def success(msg)
+          puts_with_color(32, msg)
+        end
+        def error(msg)
+          puts_with_color(31, msg)
+        end
+
+        def sorted_commands(all = true)
+          cmd_hash = all_commands.dup
+          Thor::Util.thor_classes_in(self).each do |klass|
+            cmd_hash.update(klass.commands)
+          end
+          if order = self.const_get(:COMMAND_ORDER) rescue nil
+            result = order.map{|i| cmd_hash[i]}
+            result += (cmd_hash.keys - order).map{|i| cmd_hash[i]}
+          else
+            result = cmd_hash.values
+          end
+          if idx = result.index{|cmd| cmd.name == "help" }
+            h = result.delete_at(idx)
+            result << h
+          end
+          return result
+        end
+
+        def sorted_printable_commands(all = true, subcommand = false)
+          list = printable_commands(all, subcommand)
+          Thor::Util.thor_classes_in(self).each do |klass|
+            list += klass.printable_commands(false)
+          end
+          order = self.const_get(:COMMAND_ORDER) rescue nil
+          if order
+            orig = list
+            list = order.map do |ptn|
+              idx = orig.index{|t| t.first =~ /\b#{ptn}\b/}
+              raise "#{ptn} not found" unless idx
+              orig.delete_at(idx)
+            end
+            list += orig # add items not in COMMAND_ORDER
+          end
+          # # don't sort in alphabetical order
+          # list.sort! { |a, b| a[0] <=> b[0] }
+
+          # move help to the end of list
+          if idx = list.index{|t| t.first =~ /\bhelp\b/ }
+            h = list.delete_at(idx)
+            list << h
+          end
+          return list
+        end
+
+        # overwrite Thor.help method
+        def help(shell, subcommand = false)
+          if defined?(@package_name) && @package_name
+            shell.say "#{@package_name} commands:"
+          else
+            shell.say "Commands:"
+          end
+
+          shell.print_table(sorted_printable_commands(true, subcommand), :indent => 2, :truncate => true)
+          shell.say
+          class_options_help(shell)
+        end
+
+        # override Thor.command_help
+        def command_help(shell, command_name)
+          meth = normalize_command_name(command_name)
+          command = all_commands[meth]
+          handle_no_command_error(meth) unless command
+
+          shell.say "Usage:"
+          shell.say "  #{banner(command)}"
+          shell.say
+          class_options_help(shell, nil => command.options.map { |_, o| o })
+          if command.long_description
+            shell.say "Description:"
+            shell.print_wrapped(command.long_description, :indent => 2)
+          else
+            shell.say command.description
+          end
+        end
+
+      end
+
     end
   end
 end

data/lib/magellan/cli/command.rb

@@ -6,40 +6,80 @@ require 'active_support/core_ext/string/inflections'
 module Magellan
   module Cli
     class Command < Base
+
+      class << self
+        # override Thor::Base.start method
+        def start(given_args = ARGV, config = {})
+          # class_options verbose and version are defined in Magellan::Cli::Base
+          if ARGV.include?("-v") || ARGV.include?("--version")
+            info(File.basename($0) << " " << Magellan::Cli::VERSION)
+          end
+          begin
+            super(given_args, config)
+          rescue Magellan::Cli::Error => e
+            error(e.message)
+            exit(1)
+          rescue => e
+            error("[#{e.class}] #{e.message}")
+            verbose("  " << e.backtrace.join("\n  "), ARGV.include?("-V") || ARGV.include?("--verbose"))
+            exit(1)
+          end
+        end
+
+        # overwrite Magellan::Cli::Base.help method
+        def help(shell, subcommand = false)
+          super(shell, subcommand)
+
+          shell.say
+          shell.say "RESOURCES:"
+          shell.say "  " << RESOURCES.keys.join(", ")
+          shell.say "  type `#{File.basename($0)} help RESOURCE` for more detail"
+          shell.say
+        end
+      end
+
+      RESOURCES =\
       {
-        "organization"  => "Organization",
-        "team"          => "Team",
-        "project"       => "Project",
-        "stage"         => "Stage",
-        "client_version" => "ClientVersion",
-        #"tr"            => "TransactionRouter",
-        "worker"        => "Worker",
-        "image"         => "Image",
-        "container"     => "Container",
-        "cloudsql"      => "Cloudsql",
-      }.each do |name, classname|
-        desc "#{name} SUBCOMMAND ...ARGS", "manage #{name}"
+        "Organization"  => "organization",
+        "Team"          => "team",
+        "Project"       => "project",
+        "Stage"         => "stage",
+        "ClientVersion" => "client_version",
+        #"TransactionRouter" => "tr",
+        "Worker"        => "worker",
+        "Image"         => "image",
+        "Container"     => "container",
+        "Cloudsql"      => "cloudsql",
+      }
+
+      RESOURCES.each do |classname, name|
+        desc "#{name} SUBCOMMAND ...ARGS", "manage #{name.pluralize}"
         subcommand name, ::Magellan::Cli::Resources.const_get(classname)
       end
 
+      COMMAND_ORDER = %w[login] + RESOURCES.values
+
       #desc "direct SUBCOMMAND ...ARGS", "send request directly"
       #subcommand "direct", ::Magellan::Cli::Direct
 
-      desc "login", "login to a Magellan API server"
+      desc "login", "login to the Magellan server"
+      method_option :email,    aliases: "-e", desc: "email address for login"
+      method_option :password, aliases: "-p", desc: "password for login"
       def login
-        print "email: "
-        email = STDIN.gets.chomp
-        print "password: "
-        password = STDIN.noecho(&:gets).chomp
-        puts ""
+        unless email = options[:email]
+          print "email: "
+          email = STDIN.gets.strip
+        end
+
+        unless password = options[:password]
+          print "password: "
+          password = STDIN.noecho(&:gets).chomp
+          puts ""
+        end
 
         Magellan::Cli::Http.new.login!(email, password)
       end
 
-      desc "version", "show version"
-      def version
-        $stdout.puts Magellan::Cli::VERSION
-      end
     end
   end
 end

data/lib/magellan/cli/http.rb

@@ -19,7 +19,15 @@ module Magellan
 
         def access_api
           cli = Cli::Login.new
-          return block_given? ? yield(cli) : success("OK")
+          if block_given?
+            auth = cli.login_auth
+            if auth.nil? || auth.empty?
+              raise Magellan::Cli::Error, "Not logined yet. type `#{File.basename($0)} login`."
+            end
+            return yield(cli)
+          else
+            return success("OK")
+          end
         end
 
         def check_response(res)

data/lib/magellan/cli/login.rb

@@ -78,6 +78,8 @@ module Magellan
         if logined
           body = JSON.parse res2.body
           update_selections("login" => {"email" => email, "token" => body["token"] })
+        else
+          update_selections("login" => nil)
         end
         logined
       end

data/lib/magellan/cli/reference_generator.rb

@@ -0,0 +1,100 @@
+require 'magellan/cli'
+
+require 'fileutils'
+
+module Magellan
+  module Cli
+    class ReferenceGenerator
+
+      def initialize(options = {})
+        @dest = options[:dest] || "doc"
+        @subdir = options[:subdir] || "."
+        @io = $stdout
+      end
+
+      def run
+        @shell = Thor::Shell::Basic.new
+        change_global_var_temporarily(["$PROGRAM_NAME", "magellan-cli"]) do
+          process(Magellan::Cli::Command, "index.md")
+          Magellan::Cli::Command::RESOURCES.each do |class_name, res_name|
+            klass = Magellan::Cli::Resources.const_get(class_name)
+            process(klass, "#{res_name}.md", res_name)
+          end
+        end
+      end
+
+      def change_global_var_temporarily(*tuples, &block)
+        if tuples.empty?
+          block.call if block
+        else
+          gvar_name, value = *tuples.shift
+          backup = eval(gvar_name)
+          begin
+            eval("#{gvar_name} = value")
+            change_global_var_temporarily(*tuples, &block)
+          ensure
+            eval("#{gvar_name} = backup")
+          end
+        end
+      end
+
+      def process(klass, filename, res_name = nil)
+        path = File.expand_path(File.join(@subdir, filename), @dest)
+        FileUtils.mkdir_p(File.dirname(path))
+        instance = klass.new
+        open(path, "w") do |f|
+          f.puts "---"
+          f.puts "layout: index"
+          f.puts %!breadcrumb: <a href="/">Top</a> / <a href="/reference">Reference</a> / <a href="/reference/magellan-cli">magellan-cli</a> / magellan-cli #{res_name}!
+          f.puts "---"
+          f.puts
+
+          f.puts "## Commands"
+          f.puts
+          klass.sorted_commands.each do |cmd|
+            rel_path = Magellan::Cli::Command::RESOURCES.values.include?(cmd.name) ? "./#{cmd.name}.html" : "##{cmd.name}"
+            f.puts "- [%s](%s)" % [Thor.send(:banner, cmd, false, false), rel_path]
+          end
+          f.puts
+
+          f.puts "## Global Options"
+          f.puts
+          change_global_var_temporarily(["$stdout", f], ["$stderr", f]) do
+            f.puts "```text"
+            klass.send(:print_options, @shell, klass.class_options.values)
+            f.puts "```"
+            f.puts
+          end
+          f.puts
+
+          f.puts "## Details"
+          klass.sorted_commands.each do |cmd|
+            next if Magellan::Cli::Command::RESOURCES.values.include?(cmd.name)
+            f.puts "### <a name=\"#{cmd.name}\"></a>#{cmd.name}"
+            f.puts
+            f.puts "```text"
+            f.puts Thor.send(:banner, cmd)
+            f.puts "```"
+            f.puts
+            unless cmd.options.empty?
+              change_global_var_temporarily(["$stdout", f], ["$stderr", f]) do
+                f.puts "```text"
+                  klass.send(:print_options, @shell, cmd.options.values)
+                f.puts "```"
+                f.puts
+              end
+            end
+            if cmd.long_description
+              f.puts cmd.long_description
+            else
+              f.puts cmd.description
+            end
+            f.puts
+          end
+
+        end
+      end
+
+    end
+  end
+end

data/lib/magellan/cli/resources/base.rb

@@ -64,7 +64,7 @@ module Magellan
               i = fields.index(f)
               next unless i
               fields[i] = obj[:name]
-              res = obj[:resource] || ((k = Resources.const_get(obj[:class])) ? k.resource_name : nil)
+              res = obj[:resource] || ((k = Resources.const_get(obj[:class])) ? k.resource_key : nil)
               res2 = get_json("/admin/#{res}.json", {"compact" => true})
               associations[f] = res2.each_with_object({}){|r,d| d[ r["id"].to_i ] = r["label"] }
             end
@@ -81,7 +81,7 @@ module Magellan
 
 
           def query_list
-            get_json("/admin/#{self.class.resource_name}.json", default_query)
+            get_json("/admin/#{self.class.resource_key}.json", default_query)
           end
           private :query_list
 
@@ -115,7 +115,7 @@ module Magellan
           end
 
           def show(id)
-            r = get_json("/admin/#{self.class.resource_name}/#{id}.json")
+            r = get_json("/admin/#{self.class.resource_key}/#{id}.json")
             t = Text::Table.new
             t.head = ["field", "value"]
 
@@ -151,7 +151,7 @@ module Magellan
 
           def select(name)
             q = build_query("name" => name).update(default_query)
-            update_first_result(self.class.parameter_name, "/admin/#{self.class.resource_name}.json", q)
+            update_first_result(self.class.parameter_name, "/admin/#{self.class.resource_key}.json", q)
           end
 
           def deselect
@@ -162,38 +162,45 @@ module Magellan
 
           def self.inherited(klass)
             base_name = klass.name.split(/::/).last
-            res_name = base_name.underscore
+            res_name = Magellan::Cli::Command::RESOURCES[base_name] or raise "resource not found for #{base_name}"
+
+            klass.instance_eval(<<-EOM, __FILE__, __LINE__ + 1)
+              def resource_name
+                "#{res_name}"
+              end
+            EOM
+
             klass.module_eval(<<-EOM, __FILE__, __LINE__ + 1)
               no_commands do
-                cattr_accessor :resource_name
+                cattr_accessor :resource_key
                 cattr_accessor :resource_dependency
                 cattr_accessor :field_associations
                 cattr_accessor :hidden_fields, :multiline_fields
 
                 def self.parameter_name
-                  resource_name.gsub(/~/, "_")
+                  resource_key.gsub(/~/, "_")
                 end
                 def parameter_name
                   self.class.parameter_name
                 end
               end
 
-              desc "list", "list #{base_name}"
+              desc "list", "Show a list of the #{res_name.pluralize}"
               def list
                 super
               end
 
-              desc "show ID", "show #{base_name} specified by ID"
+              desc "show ID", "Show the detail of the #{res_name} specified by ID"
               def show(id)
                 super(id)
               end
 
-              desc "select NAME", "select #{base_name} by NAME"
+              desc "select NAME", "Select the #{res_name} by NAME"
               def select(name)
                 super
               end
 
-              desc "deselect", "deselect #{base_name}"
+              desc "deselect", "Deselect the #{res_name}"
               def deselect
                 super
               end

data/lib/magellan/cli/resources/client_version.rb

@@ -6,7 +6,7 @@ module Magellan
     module Resources
 
       class ClientVersion < Base
-        self.resource_name = "client_version"
+        self.resource_key = "client_version"
         self.resource_dependency = {"project" => "project"}
 
         self.hidden_fields = %w[project_id created_at updated_at].map(&:freeze).freeze
@@ -14,7 +14,7 @@ module Magellan
           "stage_title_id" => {name: "stage", class: "Stage"},
         }
 
-        desc "create VERSION", "create New Client Version"
+        desc "create VERSION", "Create a new #{resource_name}"
         def create(version)
           stage = load_selection("stage")
           params = {
@@ -23,7 +23,7 @@ module Magellan
               "version" => version,
             }
           }
-          post_json("/admin/#{resource_name}/new.json", params)
+          post_json("/admin/#{resource_key}/new.json", params)
           # TODO implement select method
           # select(version)
         end

data/lib/magellan/cli/resources/cloudsql.rb

@@ -6,11 +6,11 @@ module Magellan
     module Resources
 
       class Cloudsql < Base
-        self.resource_name = "cloudsql~database"
+        self.resource_key = "cloudsql~database"
         self.resource_dependency = {"stage" => "stage"}
         self.hidden_fields = %w[cloudsql_instance_id].map(&:freeze).freeze
 
-        desc "create NAME", "create new CloudSQL Database with NAME"
+        desc "create NAME", "Create a new #{resource_name} database with NAME"
         def create(name)
           o = load_selection("stage")
           params = {
@@ -19,13 +19,13 @@ module Magellan
               "name" => name,
             }
           }
-          post_json("/admin/#{resource_name}/new.json", params)
+          post_json("/admin/#{resource_key}/new.json", params)
           select(name)
         end
 
-        desc "delete ID", "delete CloudSQL Database"
+        desc "delete ID", "Delete the #{resource_name} database specified by ID"
         def delete(id)
-          super("/admin/#{resource_name}/#{id}/delete.js")
+          super("/admin/#{resource_key}/#{id}/delete.js")
         end
       end
     end

data/lib/magellan/cli/resources/container.rb

@@ -6,7 +6,7 @@ module Magellan
     module Resources
 
       class Container < Base
-        self.resource_name = "container~instance"
+        self.resource_key = "container~instance"
         self.resource_dependency = {"stage" => "stage-version"}
         self.hidden_fields = %w[created_at updated_at].map(&:freeze).freeze
         self.multiline_fields = %w[docker_properties_json links_yaml publishings_yaml volumes_yaml env_yaml].map(&:freeze).freeze

data/lib/magellan/cli/resources/image.rb

@@ -6,7 +6,7 @@ module Magellan
     module Resources
 
       class Image < Base
-        self.resource_name = "container~image"
+        self.resource_key = "container~image"
         self.resource_dependency = {"stage" => "stage-version"}
         self.hidden_fields = %w[function_id function_type created_at updated_at].map(&:freeze).freeze
         self.field_associations = {"stage_version_id" => {name: "stage", resource: "stage~version"} }

data/lib/magellan/cli/resources/organization.rb

@@ -6,17 +6,18 @@ module Magellan
     module Resources
 
       class Organization < Base
-        self.resource_name = "magellan~auth~organization"
+
+        self.resource_key = "magellan~auth~organization"
         # self.field_associations = {"creator_id" => {name: "creator", class: "User"} }
 
-        desc "create NAME", "create Organization with NAME"
+        desc "create NAME", "create a new #{resource_name} with NAME"
         def create(name)
           params = {
             parameter_name => {
               "name" => name,
             }
           }
-          post_json("/admin/#{self.resource_name}/new.json", params)
+          post_json("/admin/#{self.resource_key}/new.json", params)
           select(name)
         end
       end

data/lib/magellan/cli/resources/project.rb

@@ -6,19 +6,19 @@ module Magellan
     module Resources
 
       class Project < Base
-        self.resource_name = "project"
+        self.resource_key = "project"
         self.resource_dependency = nil
         self.hidden_fields = %w[default_nebula_id created_at updated_at].map(&:freeze).freeze
         self.field_associations = {"organization_id" => {name: "organization", class: "Organization"} }
 
-        desc "update ATTRIBUTES", "update project with ATTRIBUTES"
+        desc "update ATTRIBUTES", "Update the ATTRIBUTES of the selected #{resource_name}"
         def update(attrs)
           s = load_selection("project")
           attrs = JSON.parse(File.readable?(attrs) ? File.read(attrs) : attrs)
           put_json("/admin/project/#{s['id']}/edit", {"project" => attrs})
         end
 
-        desc "create NAME", "create new project with NAME"
+        desc "create NAME", "Create a new #{resource_name} with NAME"
         def create(name)
           o = load_selection(Organization.parameter_name)
           params = {
@@ -27,7 +27,7 @@ module Magellan
               "name" => name,
             }
           }
-          post_json("/admin/#{resource_name}/new.json", params)
+          post_json("/admin/#{resource_key}/new.json", params)
           select(name)
         end
       end

data/lib/magellan/cli/resources/stage.rb

@@ -7,12 +7,12 @@ module Magellan
     module Resources
 
       class Stage < Base
-        self.resource_name = "stage~title"
+        self.resource_key = "stage~title"
         self.resource_dependency = {"project" => "project"}
         self.hidden_fields = %w[nebula_id created_at updated_at].map(&:freeze).freeze
         self.field_associations = {"project_id" => {name: "project", class: "Project"} }
 
-        desc "create NAME [-t development|staging|production|other]", "create Stage with Name and Type"
+        desc "create NAME [-t development|staging|production|other]", "Create a new #{resource_name} with Name and Type"
         option :t, type: :string, default: "development", desc: "-t development|staging|production. specify Stage Type"
         def create(name)
           type = options["t"]
@@ -27,11 +27,11 @@ module Magellan
               "stage_type" => type,
             }
           }
-          post_json("/admin/#{resource_name}/new.json", params)
+          post_json("/admin/#{resource_key}/new.json", params)
           select(name)
         end
 
-        desc "select NAME", "select Stage named by NAME"
+        desc "select NAME", "Select the #{resource_name} named by NAME"
         def select(name)
           q = build_query("name" => name).update(default_query)
           r = update_first_result("stage", "/admin/stage~title.json", q)
@@ -45,7 +45,7 @@ module Magellan
           update_first_result("stage-version", "/admin/stage~version.json", q, %w[id])
         end
 
-        desc "deselect", "deselect Stage"
+        desc "deselect", "Deselect the #{resource_name}"
         def deselect
           update_selections do |s|
             s.delete("stage")
@@ -53,12 +53,12 @@ module Magellan
           end
         end
 
-        desc "planning", "switch to planning to build next released version"
+        desc "planning", "Switch to planning to build next released version"
         def planning
           switch_version(1)
         end
 
-        desc "current", "switch to current released version"
+        desc "current", "Switch to current released version"
         def current
           switch_version(2)
         end
@@ -71,7 +71,7 @@ module Magellan
           end
         end
 
-        desc "prepare", "prepare containers"
+        desc "prepare", "Prepare the #{Container.resource_name.pluralize}"
         def prepare
           s = load_selection("stage")
           id = s["id"]
@@ -79,7 +79,7 @@ module Magellan
           Container.new.show_list(r["result"])
         end
 
-        desc "repair", "repair stage status"
+        desc "repair", "Repair the #{resource_name} status"
         def repair
           r = call_repair
           puts r["success"] ? "\e[32msucceeded to repair stage\e[0m" : "\e[31mfailed to repair stage\e[0m"
@@ -93,14 +93,14 @@ module Magellan
           end
         end
 
-        desc "update ATTRIBUTES", "update stage with ATTRIBUTES"
+        desc "update ATTRIBUTES", "Update ATTRIBUTES of the #{resource_name}"
         def update(attrs)
           s = load_selection("stage")
           attrs = JSON.parse(File.readable?(attrs) ? File.read(attrs) : attrs)
           put_json("/admin/stage~title/#{s['id']}/edit", {"stage_title" => attrs})
         end
 
-        desc "release_now", "release changes now"
+        desc "release_now", "Release the changes now"
         option :A, type: :boolean, default: false, desc: "-A async mode. release_now returns soon"
         option :i, type: :numeric, default: 10, desc: "-i polling interval(seconds)"
         option :t, type: :numeric, default: 600, desc: "-t timeout(seconds)"
@@ -156,7 +156,7 @@ module Magellan
           end
         end
 
-        desc "logs", "fetch worker logs"
+        desc "logs", "Fetch the logs of the #{Worker.resource_name.pluralize}"
         def logs
           s = load_selection("stage")
           id = s["id"]
@@ -168,7 +168,7 @@ module Magellan
           end
         end
 
-        desc "set_container_num NUM", "set container numbers for selected stage and image"
+        desc "set_container_num NUM", "Set the number of #{Container.resource_name.pluralize} for the selected #{Image.resource_name}"
         def set_container_num(num)
           s = load_selection("stage")
           v = load_selection("stage-version")
@@ -176,7 +176,7 @@ module Magellan
           post_json("/admin/stage~version/#{v["id"]}/set_container_num.json", { container_num: num, container_image_id: i["id"] })
         end
 
-        desc "reload", "reload last selections"
+        desc "reload", "Reload the last selections"
         def reload
           s = load_selection("stage")
           select(s["name"])

data/lib/magellan/cli/resources/team.rb

@@ -6,11 +6,11 @@ module Magellan
     module Resources
 
       class Team < Base
-        self.resource_name = "magellan~auth~team"
+        self.resource_key = "magellan~auth~team"
         self.resource_dependency = { "organization" =>  Organization.parameter_name }
         self.field_associations = {"organization_id" => {name: "organization", class: "Organization"} }
 
-        desc "create NAME ROLE", "create Team with NAME ROLE"
+        desc "create NAME ROLE", "Create a new #{resource_name} with NAME and ROLE"
         def create(name, role)
           unless %w{ reader admin }.include?(role)
             raise "ROLE should be 'reader' or 'admin'"
@@ -23,18 +23,18 @@ module Magellan
               "role" => role,
             }
           }
-          post_json("/admin/#{self.resource_name}/new.json", params)
+          post_json("/admin/#{self.resource_key}/new.json", params)
           select(name)
         end
 
 =begin
-        desc "invite EMAIL", "invite a user to the Team"
+        desc "invite EMAIL", "Invite a user to the #{Team.resource_name}"
         def invite(email)
           o = load_selection(parameter_name)
           params = {
             "email" => email
           }
-          post_json("/admin/#{self.resource_name}/#{o["id"]}/team_invite.json", params)
+          post_json("/admin/#{self.resource_key}/#{o["id"]}/team_invite.json", params)
         end
 =end
       end

data/lib/magellan/cli/resources/transaction_router.rb

@@ -6,10 +6,10 @@ module Magellan
     module Resources
 
       class TransactionRouter < Base
-        self.resource_name = "functions~transaction_router"
+        self.resource_key = "functions~transaction_router"
         self.resource_dependency = {"stage" => Stage.parameter_name}
 
-        desc "create NAME", "create TransactionRouter with NAME"
+        desc "create NAME", "Create a new #{resource_name} with NAME"
         def create(name)
           s = load_selection("stage-version")
           params = {
@@ -19,7 +19,7 @@ module Magellan
               # "instance_base_name" => name,
             }
           }
-          post_json("/admin/#{self.resource_name}/new.json", params)
+          post_json("/admin/#{self.resource_key}/new.json", params)
           select(name)
         end
 

data/lib/magellan/cli/resources/worker.rb

@@ -6,13 +6,13 @@ module Magellan
     module Resources
 
       class Worker < Base
-        self.resource_name = "functions~worker"
+        self.resource_key = "functions~worker"
         self.resource_dependency = {"stage" => "stage-version"}
         self.hidden_fields = %w[created_at updated_at].map(&:freeze).freeze
         self.multiline_fields = %w[migration_command_1 migration_command_2 run_command environment_vars_yaml].map(&:freeze).freeze
         self.field_associations = {"stage_version_id" => {name: "stage", resource: "stage~version"} }
 
-        desc "create NAME, IMAGE", "create Worker with NAME, IMAGE"
+        desc "create NAME, IMAGE", "Create a new #{resource_name} with NAME and IMAGE"
         method_option :attributes_yaml, aliases: "-A", desc: "path to YAML file which defines attributes"
         def create(name, image_name)
           s = load_selection("stage-version")
@@ -30,11 +30,11 @@ module Magellan
               # "instance_base_name" => name,
             }.update(attrs)
           }
-          post_json("/admin/#{self.resource_name}/new.json", params)
+          post_json("/admin/#{self.resource_key}/new.json", params)
           select(name)
         end
 
-        desc "update ATTRIBUTE", "update selected worker with ATTRIBUTE(filename or JSON)"
+        desc "update ATTRIBUTES", "Update the ATTRIBUTES(filename or JSON) of the selected #{resource_name}"
         def update(attrs)
           if File.readable?(attrs)
             attrs = YAML.load_file(attrs)
@@ -47,10 +47,10 @@ module Magellan
           params = {
             parameter_name => attrs
           }
-          put_json("/admin/#{resource_name}/#{w["id"]}/edit.js", params)
+          put_json("/admin/#{resource_key}/#{w["id"]}/edit.js", params)
         end
 
-        desc "prepare_images", "prepare worker images"
+        desc "prepare_images", "prepare the #{Image.resource_name.pluralize} for the selected #{Worker.resource_name}"
         def prepare_images
           s = load_selection("functions_worker")
           id = s["id"]

data/lib/magellan/cli/version.rb

@@ -1,5 +1,5 @@
 module Magellan
   module Cli
-    VERSION = "0.2.17"
+    VERSION = "0.2.18"
   end
 end

data/lib/magellan/cli.rb

@@ -20,5 +20,6 @@ module Magellan
       "Content-Type" => "application/json"
     }.freeze
 
+    autoload :ReferenceGenerator, "magellan/cli/reference_generator"
   end
 end

data/spec/magellan/cli/command_spec.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Magellan::Cli::Command do
+  let(:command){ Magellan::Cli::Command.new }
+  let(:string){ "string" }
+
+  describe :login do
+    describe :intaractive do
+      before do
+        $stdout = StringIO.new
+        allow(Magellan::Cli::Http).to receive_message_chain(:new, :login!).and_return("OK")
+      end
+      it "nothing options" do
+        allow($stdin).to receive(:gets).and_return(string).once
+        allow($stdin).to receive(:noecho).and_return(string).once
+        expect(command.login).to eq "OK"
+        expect($stdout.string).to eq "email: password: \n"
+      end
+
+      it "only email" do
+        allow($stdin).to receive(:noecho).and_return(string).twice
+        expect(command.invoke(:login, [], {email: string})).to eq "OK"
+        expect($stdout.string).to eq "password: \n"
+      end
+
+      it "only password" do
+        allow($stdin).to receive(:gets).and_return(string).once
+        expect(command.invoke(:login, [], {password: string})).to eq "OK"
+        expect($stdout.string).to eq "email: "
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magellan-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.2.18
 platform: ruby
 authors:
 - akm2000
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -148,6 +148,7 @@ files:
 - lib/magellan/cli/file_access.rb
 - lib/magellan/cli/http.rb
 - lib/magellan/cli/login.rb
+- lib/magellan/cli/reference_generator.rb
 - lib/magellan/cli/resources.rb
 - lib/magellan/cli/resources/base.rb
 - lib/magellan/cli/resources/client_version.rb
@@ -165,6 +166,7 @@ files:
 - lib/magellan/cli/version.rb
 - magellan-cli.gemspec
 - spec/magellan/cli/Magellan.yml
+- spec/magellan/cli/command_spec.rb
 - spec/magellan/cli/login_page.html
 - spec/magellan/cli/login_spec.rb
 - spec/magellan/cli/resources/client_version_spec.rb
@@ -199,6 +201,7 @@ specification_version: 4
 summary: commandline tools for magellanic cloud service.
 test_files:
 - spec/magellan/cli/Magellan.yml
+- spec/magellan/cli/command_spec.rb
 - spec/magellan/cli/login_page.html
 - spec/magellan/cli/login_spec.rb
 - spec/magellan/cli/resources/client_version_spec.rb