blockspring-cli 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c647f46f6e49b14b2ba979986d7b6517628fb21
-  data.tar.gz: f7df8fa46e4767ffa45c6ffce256720ef818994b
+  metadata.gz: 40fc4b8327edac4958e68b52e7e194b748b3b9f6
+  data.tar.gz: e36d3719f2fe7c13256ee9339f9cb97d2989d61c
 SHA512:
-  metadata.gz: 5a91732d62b47962c6455d72d37e30016fcac7fd970072fd509146924e1c7d10fc9d1edf97e93fa2d7ea9a3bb48870226e01a4f346a4277e907de35a946e582a
-  data.tar.gz: 0fdcc5444687a8489e64ae91c4e54631b8d8161ad37c055f060887927fac893e6dcac3f8a3a189005a7dc8c08765a15b21a08465c0333ae130d9397320fd81b3
+  metadata.gz: b36c9bff1f7765f623a54ca615e5e0e36c496c11b1e0663478944e5bc0b71568c3a281192e6bffd33e63dae873e1ed532758cc41ed3258724f3218ee90c09588
+  data.tar.gz: 72873bebf67836331326951cfca76c6a9da5f56535852377d8a47bcbcb21f5d7d8bcd428fcf9b673491b280a384f2a4f2f243095988a0d1434b35b29aa06ad99

data/lib/blockspring/cli.rb

@@ -5,6 +5,7 @@ require 'json'
 require "blockspring/cli/version"
 require "blockspring/cli/auth"
 require "blockspring/cli/command"
+require "blockspring/cli/helpers"
 
 module Blockspring
   module CLI
@@ -36,9 +37,9 @@ module Blockspring
         else
           error("Command cancelled.")
         end
-      rescue => error
-        puts error.inspect
-        exit(1)
+      # rescue => error
+      #   puts error.inspect
+      #   exit(1)
       end
     end
   end

data/lib/blockspring/cli/auth.rb

@@ -1,5 +1,9 @@
+require "blockspring/cli/helpers"
+
 class Blockspring::CLI::Auth
   class << self
+    include Blockspring::CLI::Helpers
+
     def host
       ENV['BLOCKSPRING_API_HOST'] || 'localhost:3000'
     end
@@ -46,6 +50,24 @@ class Blockspring::CLI::Auth
       return password
     end
 
+    def ask_for_password_on_windows
+      require "Win32API"
+      char = nil
+      password = ''
+
+      while char = Win32API.new("crtdll", "_getch", [ ], "L").Call do
+        break if char == 10 || char == 13 # received carriage return or newline
+        if char == 127 || char == 8 # backspace and delete
+          password.slice!(-1, 1)
+        else
+          # windows might throw a -1 at us so make sure to handle RangeError
+          (password << char.chr) rescue RangeError
+        end
+      end
+      puts
+      return password
+    end
+
     def ask_for_credentials
       puts "Enter your Blockspring credentials."
 
@@ -53,7 +75,7 @@ class Blockspring::CLI::Auth
       login = ask
 
       print "Password (typing will be hidden): "
-      password = ask_for_password
+      password = running_on_windows? ? ask_for_password_on_windows : ask_for_password
 
       [login, api_key(login, password)]
     end
@@ -92,6 +114,9 @@ class Blockspring::CLI::Auth
     def write_credentials
       FileUtils.mkdir_p(File.dirname(netrc_path))
       FileUtils.touch(netrc_path)
+      unless running_on_windows?
+        FileUtils.chmod(0600, netrc_path)
+      end
       netrc[host] = @credentials
       netrc.save
     end

data/lib/blockspring/cli/command.rb

@@ -10,6 +10,10 @@ module Blockspring
         @@command_aliases ||= {}
       end
 
+      def self.files
+        @@files ||= Hash.new {|hash,key| hash[key] = File.readlines(key).map {|line| line.strip}}
+      end
+
       def self.load
         Dir[File.join(File.dirname(__FILE__), "command", "*.rb")].each do |file|
           require file
@@ -34,6 +38,14 @@ module Blockspring
       def self.parse(cmd)
         commands[cmd] || commands[command_aliases[cmd]]
       end
+
+      def self.namespaces
+        @@namespaces ||= {}
+      end
+
+      def self.register_namespace(namespace)
+        namespaces[namespace[:name]] = namespace
+      end
     end
   end
 end

data/lib/blockspring/cli/command/auth.rb

@@ -1,6 +1,12 @@
 require "blockspring/cli/command/base"
 
+# authentication (login, logout)
+#
 class Blockspring::CLI::Command::Auth < Blockspring::CLI::Command::Base
+
+  # auth
+  #
+  # Authenticate, display current user
   def index
     user, _key = Blockspring::CLI::Auth.get_credentials
     if user
@@ -8,6 +14,18 @@ class Blockspring::CLI::Command::Auth < Blockspring::CLI::Command::Base
     end
   end
 
+  # auth:login
+  #
+  # log in with your blockspring credentials
+  #
+  #Example:
+  #
+  # $ blockspring auth:login
+  # Enter your Blockspring credentials:
+  # Username or email: email@example.com
+  # Password (typing will be hidden):
+  # You are logged in as example
+  #
   def login
     user, _key = Blockspring::CLI::Auth.reauthorize
     if user
@@ -15,6 +33,14 @@ class Blockspring::CLI::Command::Auth < Blockspring::CLI::Command::Base
     end
   end
 
+  # auth:logout
+  #
+  # clear your blockspring credentials
+  #
+  #Example:
+  #
+  # $ blockspring auth:logout
+  #
   def logout
     Blockspring::CLI::Auth.delete_credentials
     puts "You have been logged out"

data/lib/blockspring/cli/command/base.rb

@@ -1,4 +1,6 @@
 class Blockspring::CLI::Command::Base
+  include Blockspring::CLI::Helpers
+
   attr_reader :args
   attr_reader :options
 
@@ -13,21 +15,99 @@ class Blockspring::CLI::Command::Base
 
   protected
 
+  def self.inherited(klass)
+    unless klass == Blockspring::CLI::Command::Base
+      help = extract_help_from_caller(caller.first)
+
+      Blockspring::CLI::Command.register_namespace(
+        :name => klass.namespace,
+        :description => help.first
+      )
+    end
+  end
+
   def self.method_added(method)
     return if self == Blockspring::CLI::Command::Base
     return if private_method_defined?(method)
     return if protected_method_defined?(method)
 
+    help = extract_help_from_caller(caller.first)
     resolved_method = (method.to_s == "index") ? nil : method.to_s
     command = [ self.namespace, resolved_method ].compact.join(":")
+    banner = extract_banner(help) || command
 
     Blockspring::CLI::Command.register_command(
       :klass       => self,
       :method      => method,
-      :command     => command
+      :command     => command,
+      :namespace   => self.namespace,
+      :banner      => banner.strip,
+      :summary     => extract_summary(help),
+      :description => extract_description(help),
+      :help        => help.join("\n")
     )
   end
 
+  #
+  # Parse the caller format and identify the file and line number as identified
+  # in : http://www.ruby-doc.org/core/classes/Kernel.html#M001397.  This will
+  # look for a colon followed by a digit as the delimiter.  The biggest
+  # complication is windows paths, which have a colon after the drive letter.
+  # This regex will match paths as anything from the beginning to a colon
+  # directly followed by a number (the line number).
+  #
+  def self.extract_help_from_caller(line)
+    # pull out of the caller the information for the file path and line number
+    if line =~ /^(.+?):(\d+)/
+      extract_help($1, $2)
+    else
+      raise("unable to extract help from caller: #{line}")
+    end
+  end
+
+  def self.extract_help(file, line_number)
+    buffer = []
+    lines = Blockspring::CLI::Command.files[file]
+
+    (line_number.to_i-2).downto(0) do |i|
+      line = lines[i]
+      case line[0..0]
+        when ""
+        when "#"
+          buffer.unshift(line[1..-1])
+        else
+          break
+      end
+    end
+
+    buffer
+  end
+
+  def self.extract_banner(help)
+    help.first
+  end
+
+  def self.extract_summary(help)
+    extract_description(help).split("\n")[2].to_s.split("\n").first
+  end
+
+  def self.extract_description(help)
+    help.reject do |line|
+      line =~ /^\s+-(.+)#(.+)/
+    end.join("\n")
+  end
+
+  def self.extract_options(help)
+    help.select do |line|
+      line =~ /^\s+-(.+)#(.+)/
+    end.inject([]) do |options, line|
+      args = line.split('#', 2).first
+      args = args.split(/,\s*/).map {|arg| arg.strip}.sort.reverse
+      name = args.last.split(' ', 2).first[2..-1]
+      options << { :name => name, :args => args }
+    end
+  end
+
   def self.alias_command(new, old)
     raise "no such command: #{old}" unless Blockspring::CLI::Command.commands[old]
     Blockspring::CLI::Command.command_aliases[new] = old

data/lib/blockspring/cli/command/block.rb

@@ -1,6 +1,20 @@
 require "blockspring/cli/command/base"
 
+# manipulate blocks (get, push, pull, new)
+#
 class Blockspring::CLI::Command::Block < Blockspring::CLI::Command::Base
+  # block:get BLOCKID
+  #
+  # pull down an existing block from blockspring
+  #
+  #Example:
+  #
+  # $ blockspring get testuser/f19512619b94678ea0b4bf383f3a9cf5
+  # Creating directory cool-block-f1951261
+  # Syncing script file cool-block-f1951261/block.py
+  # Syncing config file cool-block-f1951261/blockspring.json
+  # Done.
+  #
   def get
     block_parts = @args[0].split("/")
     block = get_block(block_parts[block_parts.length - 1])
@@ -14,6 +28,17 @@ class Blockspring::CLI::Command::Block < Blockspring::CLI::Command::Base
 
   end
 
+  # block:pull
+  #
+  # pull block changes from the server to current directory
+  #
+  #Example:
+  #
+  # $ blockspring pull
+  # Syncing script file block.py
+  # Syncing config file blockspring.json
+  # Done.
+  #
   def pull
     # load config file
     config_text = File.read('blockspring.json')
@@ -25,6 +50,17 @@ class Blockspring::CLI::Command::Block < Blockspring::CLI::Command::Base
     puts "Done."
   end
 
+  # block:push
+  #
+  # push local block changes or new block to the server
+  #
+  #Example:
+  #
+  # $ blockspring push
+  # Syncing script file block.py
+  # Syncing config file blockspring.json
+  # Done.
+  #
   def push
     _user, key = Blockspring::CLI::Auth.get_credentials
     config_text = File.read('blockspring.json')
@@ -49,6 +85,19 @@ class Blockspring::CLI::Command::Block < Blockspring::CLI::Command::Base
     save_block_files(json_response, '.')
   end
 
+  # block:new LANGUAGE "Block Name"
+  #
+  # generate a new block
+  #
+  # LANGUAGE: js|php|py|R|rb
+  #
+  #Example:
+  #
+  # $ blockspring new js "My Cool Block"
+  # Creating directory my-cool-block
+  # Syncing script file my-cool-block/block.js
+  # Syncing config file my-cool-block/blockspring.json
+  #
   def new
     user, key = Blockspring::CLI::Auth.get_credentials
     language = @args[0]

data/lib/blockspring/cli/command/help.rb

@@ -1,9 +1,155 @@
 require "blockspring/cli/command/base"
 
+# Get information about commands
+#
 class Blockspring::CLI::Command::Help < Blockspring::CLI::Command::Base
+
+  PRIMARY_NAMESPACES = %w( auth block run )
+
+  # help [COMMAND]
+  #
+  # "Yo dawg. I heard you liked help..." -Xzibit
+  #
+  #Examples:
+  #
+  # $ blockspring help
+  # Usage: blockspring COMMAND [command-specific-options]
+  #
+  # Primary help topics, type "blockspring help TOPIC" for more details:
+  #
+  #   auth   #  authentication (login, logout)
+  #   block  #  manipulate blocks (get, push, pull, new)
+  #   run    #  set BLOCKSPRING_API_KEY environment variable and run command
+  #
+  # Additional topics:
+  #
+  #   help     #  huh?
+  #   version  #  display version
+  #
+  # $ blockspring help block:new
+  # Usage: blockspring block:new LANGUAGE "Block Name"
+  #
+  #  generate a new block
+  #
+  #  LANGUAGE: js|php|py|R|rb
+  #
+  # Example:
+  #
+  #  $ blockspring new js "My Cool Block"
+  #  Creating directory my-cool-block
+  #  Syncing script file my-cool-block/block.js
+  #  Syncing config file my-cool-block/blockspring.json
+
+
   def index
-    puts "Usage: blockspring COMMAND [options]"
+    if command = args.shift
+      help_for_command(command)
+    else
+      help_for_root
+    end
+  end
+
+  private
+
+  def help_for_root
+    puts "Usage: blockspring COMMAND [command-specific-options]"
+    puts
+    puts "Primary help topics, type \"blockspring help TOPIC\" for more details:"
+    puts
+    summary_for_namespaces(primary_namespaces)
     puts
-    puts "More info at http://www.blockspring.com/documentation/cli"
+    puts "Additional topics:"
+    puts
+    summary_for_namespaces(additional_namespaces)
+    puts
+  end
+
+  def commands
+    Blockspring::CLI::Command.commands
+  end
+
+  def help_for_command(name)
+    if command_alias = Blockspring::CLI::Command.command_aliases[name]
+      display("Alias: #{name} redirects to #{command_alias}")
+      name = command_alias
+    end
+    if command = commands[name]
+      puts "Usage: blockspring #{command[:banner]}"
+
+      if command[:help].strip.length > 0
+        help = command[:help].split("\n").reject do |line|
+          line =~ /HIDDEN/
+        end
+        puts help[1..-1].join("\n")
+      end
+      puts
+    end
+
+    namespace_commands = commands_for_namespace(name).reject do |command|
+      command[:help] =~ /DEPRECATED/
+    end
+
+    if !namespace_commands.empty?
+      puts "Additional commands, type \"blockspring help COMMAND\" for more details:"
+      puts
+      help_for_namespace(name)
+      puts
+    elsif command.nil?
+      error "#{name} is not a blockspring command. See `heroku help`."
+    end
+  end
+
+  def commands_for_namespace(name)
+    Blockspring::CLI::Command.commands.values.select do |command|
+      command[:namespace] == name && command[:command] != name
+    end
+  end
+
+  def help_for_namespace(name)
+    namespace_commands = commands_for_namespace(name)
+
+    unless namespace_commands.empty?
+      size = longest(namespace_commands.map { |c| c[:banner] })
+      namespace_commands.sort_by { |c| c[:banner].to_s }.each do |command|
+        next if skip_command?(command)
+        command[:summary] ||= ""
+        puts "  %-#{size}s  # %s" % [ command[:banner], command[:summary] ]
+      end
+    end
+  end
+
+  def skip_namespace?(ns)
+    return true if ns[:description] =~ /DEPRECATED:/
+    return true if ns[:description] =~ /HIDDEN:/
+    false
+  end
+
+  def skip_command?(command)
+    return true if command[:help] =~ /DEPRECATED:/
+    return true if command[:help] =~ /^ HIDDEN:/
+    false
+  end
+
+  def namespaces
+    namespaces = Blockspring::CLI::Command.namespaces
+    namespaces
+  end
+
+  def primary_namespaces
+    PRIMARY_NAMESPACES.map { |name| namespaces[name] }.compact
+  end
+
+  def additional_namespaces
+    (namespaces.values - primary_namespaces)
+  end
+
+  def summary_for_namespaces(namespaces)
+    size = longest(namespaces.map { |n| n[:name] })
+    namespaces.sort_by {|namespace| namespace[:name]}.each do |namespace|
+      next if skip_namespace?(namespace)
+      name = namespace[:name]
+      namespace[:description] ||= ""
+      puts "  %-#{size}s  # %s" % [ name, namespace[:description] ]
+    end
   end
 end

data/lib/blockspring/cli/command/run.rb

@@ -1,5 +1,7 @@
 require "blockspring/cli/command/base"
 
+# set BLOCKSPRING_API_KEY environment variable and run command
+#
 class Blockspring::CLI::Command::Run < Blockspring::CLI::Command::Base
   def index
     if ENV['BLOCKSPRING_API_KEY'].to_s.strip.empty?

data/lib/blockspring/cli/command/version.rb

@@ -1,6 +1,17 @@
 require "blockspring/cli/command/base"
 
+# display version
+#
 class Blockspring::CLI::Command::Version < Blockspring::CLI::Command::Base
+
+  # version
+  #
+  # show blockspring command line tool version
+  #
+  #Example:
+  #
+  # blockspring version
+  # blockspring-cli-gem/1.0.4 (x86_64-darwin13.0) ruby/2.1.2
   def index
     puts Blockspring::CLI.user_agent
   end

data/lib/blockspring/cli/helpers.rb

@@ -0,0 +1,58 @@
+module Blockspring
+  module CLI
+    module Helpers
+
+      def home_directory
+        running_on_windows? ? ENV['USERPROFILE'].gsub("\\","/") : ENV['HOME']
+      end
+
+      def running_on_windows?
+        RUBY_PLATFORM =~ /mswin32|mingw32/
+      end
+
+      def running_on_a_mac?
+        RUBY_PLATFORM =~ /-darwin\d/
+      end
+
+      def display(msg="", new_line=true)
+        if new_line
+          puts(msg)
+        else
+          print(msg)
+        end
+        $stdout.flush
+      end
+
+      def longest(items)
+        items.map { |i| i.to_s.length }.sort.last
+      end
+
+      def format_with_bang(message)
+        return '' if message.to_s.strip == ""
+        " !    " + message.split("\n").join("\n !    ")
+      end
+
+      def output_with_bang(message="", new_line=true)
+        return if message.to_s.strip == ""
+        display(format_with_bang(message), new_line)
+      end
+
+      def error(message)
+        if Blockspring::CLI::Helpers.error_with_failure
+          display("failed")
+          Blockspring::CLI::Helpers.error_with_failure = false
+        end
+        $stderr.puts(format_with_bang(message))
+        exit(1)
+      end
+
+      def self.error_with_failure
+        @@error_with_failure ||= false
+      end
+
+      def self.error_with_failure=(new_error_with_failure)
+        @@error_with_failure = new_error_with_failure
+      end
+    end
+  end
+end

data/lib/blockspring/cli/version.rb

@@ -1,5 +1,5 @@
 module Blockspring
   module CLI
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blockspring-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Blockspring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ files:
 - lib/blockspring/cli/command/help.rb
 - lib/blockspring/cli/command/run.rb
 - lib/blockspring/cli/command/version.rb
+- lib/blockspring/cli/helpers.rb
 - lib/blockspring/cli/version.rb
 homepage: http://www.blockspring.com
 licenses: