gemical 0.0.2 → 0.0.3

data/lib/gemical/auth.rb

@@ -1,10 +1,15 @@
 class Gemical::Auth
   include Gemical::Singleton
 
+  # @return [Gemical::Configuration]
+  #   The configuration
   def configuration
     Gemical.configuration
   end
 
+  # Verifies account, asks for credentials if not setup
+  # @return [Hash]
+  #   Account information
   def verify_account!
     @verified_account ||= if credentials
       get_account
@@ -15,6 +20,9 @@ class Gemical::Auth
     end
   end
 
+  # Verifies account, asks for primary choice if not setup
+  # @return [Hash]
+  #   Vault information
   def verify_vault!
     verify_account!
 
@@ -25,6 +33,8 @@ class Gemical::Auth
     end
   end
 
+  # @return [Array<Gemical::Vault>]
+  #   Available vaults
   def vaults
     verify_account!
     @vaults ||= Gemical.connection.get("/vaults").map do |hash|
@@ -32,16 +42,22 @@ class Gemical::Auth
     end
   end
 
+  # @return [[String, String]]
+  #   Username and password
   def credentials
     return nil unless configuration.credentials?
     pair = configuration.credentials.read.split(/\s+/)[0..1]
     pair if pair.size == 2 && pair.all? {|v| string_value?(v) }
   end
 
+  # @return [Array]
+  #   Basic authentication credentials, for API request
   def basic_auth
     [credentials.last, 'x'] if credentials
   end
 
+  # @return [String]
+  #   The user's primary vault setting
   def primary_vault
     return nil unless configuration.primary_vault?
     value = configuration.primary_vault.read.split(/\s+/).first
@@ -50,12 +66,18 @@ class Gemical::Auth
 
   private
 
+    # @return [Hash]
+    #   Retrieved account info from the API
     def get_account
       Gemical.connection.get("/account")
     rescue Gemical::Connection::HTTPUnauthorized
       renew_credentials?
     end
 
+    # Collects user credentials and tries to retrieve account information
+    # from the API
+    # @return [Hash]
+    #   Retrieved account info from the API
     def collect_credentials(attempt = 1)
       email   = ask('Email:    ')
       pass    = password
@@ -76,6 +98,7 @@ class Gemical::Auth
       end
     end
 
+    # Asks the user if he wants to renew credentials
     def renew_credentials?
       say_warning "\nYour stored credentials seem to be outdated."
       if agree("Do you want to re-authenticate your account? ")
@@ -86,11 +109,13 @@ class Gemical::Auth
       end
     end
 
+    # Fetch vault
     def get_vault(name)
       ensure_vaults!
       vaults.find {|v| v == name }
     end
 
+    # Collect user's preference about primary vault
     def collect_vault(message, save = true)
       ensure_vaults!
       say_warning "\n#{message}"
@@ -99,6 +124,7 @@ class Gemical::Auth
       get_vault(name)
     end
 
+    # Ensure user has vaults, or exit
     def ensure_vaults!
       return unless vaults.empty?
       say_error "You have no vaults associated with your account."
@@ -106,6 +132,7 @@ class Gemical::Auth
       exit(1)
     end
 
+    # @return [Boolean] true, if the value is a non-empty string
     def string_value?(value)
       value.is_a?(String) && !value.strip.empty?
     end

data/lib/gemical/commands/base.rb

@@ -2,20 +2,39 @@ class Gemical::Commands::Base
 
   protected
 
+    # @return [Pathname]
+    #   The current working path
     def current_path
       @current_path ||= Pathname.new(File.expand_path('.'))
     end
 
-    def terminate(message)
+    # Output error message and exit
+    # @param [String] message
+    #   Message to be printed in the console as an error
+    # @param [Integer] status
+    #   Exit status, defaults to 1
+    def terminate(message, status = 1)
       say_error message
-      exit(1)
+      exit(status)
     end
 
-    def success(message)
+    # Output success message and exit
+    # @param [String] message
+    #   Message to be printed to the console
+    # @param [Integer] status
+    #   Exit status, defaults to 0
+    def success(message, status = 0)
       say_ok message
-      exit(0)
+      exit(status)
     end
 
+    # Expands API errors to messages
+    # @param [Array] errors
+    #   Original errors
+    # @param [Hash] mappings
+    #   Message mapptings
+    # @return [String]
+    #   Full error messages
     def full_errors(errors, mappings = {})
       errors.map do |attr, messages|
         name = mappings[attr] || attr
@@ -25,18 +44,26 @@ class Gemical::Commands::Base
       end.join(', ')
     end
 
+    # Authenticate the user
     def authenticate!
       Gemical.auth.verify_account!
     end
 
+    # Connection accessor
     def conn
       Gemical.connection
     end
 
+    # @param [Commander::Command::Options]
+    #   The parsed command line options
+    # @return [String]
+    #   The current vault name
     def current_vault(options)
       options.vault || primary_vault
     end
 
+    # @return [String]
+    #   The user's primary name
     def primary_vault
       Gemical.auth.verify_vault!
     end

data/lib/gemical/commands/gems.rb

@@ -15,13 +15,14 @@ class Gemical::Commands::Gems < Gemical::Commands::Base
   def create(args, options)
     terminate "Please provide a GEM file." unless args.first.is_a?(String)
 
-    file = current_path.join(args.first)
-    terminate "Hmm, no file in #{file}" unless file.file?
+    files = Pathname.glob(args).select(&:file?)
+    terminate "Hmm, no files found!" if files.empty?
 
     authenticate!
-    vault    = current_vault(options)
-    response = conn.post("/vaults/#{vault}/gems", :params => { "rubygem[file]" => file.open('rb') })
-    success "#{response['original_name']} was successfully added to vault '#{vault}'."
+    vault = current_vault(options)
+    files.each do |file|
+      upload(file, vault)
+    end
   rescue Gemical::Connection::HTTPNotFound
     terminate "Sorry, no such vault '#{vault}'."
   rescue Gemical::Connection::HTTPUnprocessable => e
@@ -43,4 +44,13 @@ class Gemical::Commands::Gems < Gemical::Commands::Base
     "Sorry, #{full_errors(e.response)}"
   end
 
+  private
+
+    def upload(file, vault)
+      res = conn.post("/vaults/#{vault}/gems", :params => { "rubygem[file]" => file.open('rb') })
+      say_ok "#{res['original_name']} was successfully added to vault '#{vault}'."
+    rescue Gemical::Connection::HTTPUnprocessable => e
+      say_error "Sorry, #{full_errors(e.response, 'name' => 'gem')} (#{file.basename})"
+    end
+
 end

data/lib/gemical/configuration.rb

@@ -9,36 +9,48 @@ class Gemical::Configuration
     @home = ENV['HOME']
   end
 
+  # @return [Pathname] credentials store
   def root
     @root ||= Pathname.new File.join(@home, ".gemical")
   end
 
+  # @return [Pathname] credentials storage file
   def credentials
     root.join('credentials')
   end
 
+  # @return [Pathname] primary vault storage file
   def primary_vault
     root.join('primary_vault')
   end
 
+  # @return [Boolean] true, if configuration root exists
   def root?
     root.directory? && root.readable?
   end
 
+  # @return [Boolean] true, if credentials are available
   def credentials?
     readable_file? credentials
   end
 
+  # @return [Boolean] true, if primary vault is available
   def primary_vault?
     readable_file? primary_vault
   end
 
+  # Create a configuration root directory
   def create_root!
     return if root?
     FileUtils.mkdir_p root
     FileUtils.chmod_R 0700, root
   end
 
+  # Write a file
+  # @param [Symbol] symbol
+  #   Either :credentials or :primary_vault
+  # @param [Array] lines
+  #   Lines to write
   def write!(symbol, *lines)
     create_root!
     send(symbol).open "w", 0600 do |file|
@@ -48,6 +60,8 @@ class Gemical::Configuration
 
   private
 
+    # @param [Pathname] path
+    # @return [Boolean] true, if file is readable
     def readable_file?(path)
       root? && path.file? && path.readable?
     end

data/lib/gemical/import.rb

@@ -39,6 +39,7 @@ command :"gems:add" do |c|
   c.option '--vault VAULT', 'Specify a vault'
   c.when_called Gemical::Commands::Gems, :create
 end
+alias_command :push, :'gems:add'
 
 command :"gems:remove" do |c|
   c.syntax = 'gemical gems:remove GEM VERSION [options]'

data/lib/gemical/vault.rb

@@ -2,6 +2,8 @@ class Gemical::Vault < String
 
   attr_reader :token
 
+  # Constructor
+  # @param [Hash] with "token" and "name" keys
   def initialize(hash)
     @token = hash["token"]
     super hash["name"]

data/lib/gemical/version.rb

@@ -2,7 +2,7 @@ module Gemical
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemical
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-12 00:00:00.000000000 Z
+date: 2011-12-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &14809440 !ruby/object:Gem::Requirement
+  requirement: &7740460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14809440
+  version_requirements: *7740460
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &14808980 !ruby/object:Gem::Requirement
+  requirement: &7739960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14808980
+  version_requirements: *7739960
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &14808520 !ruby/object:Gem::Requirement
+  requirement: &7739400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14808520
+  version_requirements: *7739400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14808080 !ruby/object:Gem::Requirement
+  requirement: &7738640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14808080
+  version_requirements: *7738640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14807560 !ruby/object:Gem::Requirement
+  requirement: &7737920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14807560
+  version_requirements: *7737920
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &14807060 !ruby/object:Gem::Requirement
+  requirement: &7737140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14807060
+  version_requirements: *7737140
 description: Manage your private Gems through the command line.
 email: info@blacksquaremedia.com
 executables: