git_handler 0.2.0 → 0.2.1

data/lib/git_handler.rb

@@ -7,4 +7,10 @@ require 'git_handler/request'
 require 'git_handler/git_command'
 require 'git_handler/session'
 
-module GitHandler ; end
+module GitHandler
+  # Shorthand for GitHandler::Session.new
+  # @return [Session] new session instance
+  def self.new(config)
+    GitHandler::Session.new(config)
+  end
+end

data/lib/git_handler/core_ext/hash.rb

@@ -1,9 +1,9 @@
 class Hash
-  def keys_all?(keys)
+  def include_all?(keys)
     self.keys.include_all?(keys)
   end
 
-  def keys_any?(keys)
+  def include_any?(keys)
     self.keys.include_any?(keys)
   end
 end

data/lib/git_handler/git_command.rb

@@ -1,6 +1,6 @@
 module GitHandler
   module GitCommand
-    GIT_COMMAND = /^(git-upload-pack|git upload-pack|git-upload-archive|git upload-archive|git-receive-pack|git receive-pack) '(.*)'$/
+    GIT_COMMAND = /\A(git-upload-pack|git upload-pack|git-upload-archive|git upload-archive|git-receive-pack|git receive-pack) '(.*)'\z/
 
     COMMANDS_READONLY = [
       'git-upload-pack',
@@ -43,4 +43,4 @@ module GitHandler
       COMMANDS_WRITE.include?(cmd)
     end
   end
-end
+end

data/lib/git_handler/session.rb

@@ -8,9 +8,7 @@ module GitHandler
     attr_reader :log
 
     # Initialize a new Session
-    # 
-    # config - GitHandler::Configuration instance
-    #
+    # @param [Configuration] config an existing configuration instance
     def initialize(config=nil)
       unless config.kind_of?(GitHandler::Configuration)
         raise SessionError, 'Configuration required!'
@@ -28,12 +26,11 @@ module GitHandler
       @log = Logger.new(@config.log_path)
     end
     
-    # Execute session
-    #
-    # args    - Command arguments
-    # env     - Environment parameters
-    # run_git - Execute git shell if no block provided#
-    #
+    # Execute session 
+    # 
+    # @param [Array] args session arguments
+    # @param [Hash] env hash with environment variables, use ENV.to_hash.dup
+    # @param [Boolean] run_git execute git command if set to true
     def execute(args, env, run_git=true)
       @args = args
       @env  = env
@@ -77,9 +74,12 @@ module GitHandler
       # exec("ssh", "git@TARGET", "#{args.join(' ')}")
     end
 
-    # Execute session in safe manner, catch all exceptions
-    # and terminate session
-    #
+    # Execute session with catch-all-exceptions wrapper
+    # terminates session on SessionError or Exception
+    # 
+    # @param [Array] args session arguments
+    # @param [Hash] env hash with environment variables, use ENV.to_hash.dup
+    # @param [Boolean] run_git execute git command if set to true
     def execute_safe(args, env, run_git=true)
       begin
         execute(args, env, run_git)
@@ -94,9 +94,8 @@ module GitHandler
 
     # Terminate session execution
     # 
-    # reason - Process termination reason message
-    # exit_status - Exit code (default: 1)
-    #
+    # @param [String] reason
+    # @param [Fixnum] exit_status
     def terminate(reason='', exit_status=1)
       logger.error("Session terminated. Reason: #{reason}")
       $stderr.puts("Request failed: #{reason}")
@@ -104,15 +103,13 @@ module GitHandler
     end
     
     # Check if session environment is valid
-    #
     def valid_environment?
       env['USER'] == config.user && env['HOME'] == config.home_path
     end
     
     # Check if session request is valid
-    #
     def valid_request?
-      if env.keys_all?(['SSH_CLIENT', 'SSH_CONNECTION', 'SSH_ORIGINAL_COMMAND'])
+      if env.include_all?(['SSH_CLIENT', 'SSH_CONNECTION', 'SSH_ORIGINAL_COMMAND'])
         if valid_command?(env['SSH_ORIGINAL_COMMAND'])
           return true
         end

data/lib/git_handler/version.rb

@@ -1,3 +1,3 @@
 module GitHandler
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/command_spec.rb

@@ -5,29 +5,29 @@ class TestInstance
 end
 
 describe GitHandler::GitCommand do
-  before do
-    @obj = TestInstance.new
-  end
+  let(:command) { TestInstance.new }
 
   it 'detects a valid git command' do
-    @obj.valid_command?("invalid command").should be_false
-    @obj.valid_command?("git-receive-pack").should be_false
-    @obj.valid_command?("git-receive-pack repo.git").should be_false
-    @obj.valid_command?("git-receive-pack 'repo'").should be_true
-    @obj.valid_command?("git-receive-pack 'repo.git'").should be_true
+    command.valid_command?("invalid command").should be_false
+    command.valid_command?("line1\nline2").should be_false
+    command.valid_command?("git-receive-pack").should be_false
+    command.valid_command?("git-receive-pack repo.git").should be_false
+    command.valid_command?("git-receive-pack 'repo'").should be_true
+    command.valid_command?("git-receive-pack 'repo.git'").should be_true
+    command.valid_command?("git-receive-pack 'repo'\ngit-upload-pack 'repo'").should be_false
   end
 
   context '.parse_command' do
     it 'raises error on invalid git command' do
-      proc { @obj.parse_command("invalid command") }.
+      proc { command.parse_command("invalid command") }.
         should raise_error GitHandler::ParseError
 
-      proc { @obj.parse_command("git-receive-pack 'repo.git'") }.
+      proc { command.parse_command("git-receive-pack 'repo.git'") }.
         should_not raise_error GitHandler::ParseError
     end
 
     it 'returns a proper action and repo' do
-      result = @obj.parse_command("git-receive-pack 'repo.git'")
+      result = command.parse_command("git-receive-pack 'repo.git'")
       result.should be_a Hash
       result.should eql(
         :action => 'git-receive-pack', 
@@ -39,17 +39,17 @@ describe GitHandler::GitCommand do
   end
 
   it 'detects read command' do
-    @obj.read_command?('git-receive-pack').should be_false
-    @obj.read_command?('git-upload-pack').should be_true
-    @obj.read_command?('git upload-pack').should be_true
-    @obj.read_command?('git-upload-archive').should be_true
-    @obj.read_command?('git upload-archive').should be_true
+    command.read_command?('git-receive-pack').should be_false
+    command.read_command?('git-upload-pack').should be_true
+    command.read_command?('git upload-pack').should be_true
+    command.read_command?('git-upload-archive').should be_true
+    command.read_command?('git upload-archive').should be_true
   end
 
   it 'detects write command' do
-    @obj.write_command?("git-upload-pack").should be_false
-    @obj.write_command?("git-upload-archive").should be_false
-    @obj.write_command?("git receive-pack").should be_true
-    @obj.write_command?("git-receive-pack").should be_true
+    command.write_command?("git-upload-pack").should be_false
+    command.write_command?("git-upload-archive").should be_false
+    command.write_command?("git receive-pack").should be_true
+    command.write_command?("git-receive-pack").should be_true
   end
 end

data/spec/core_ext_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Array do
+  it { should respond_to :include_all? }
+  it { should respond_to :include_any? }
+
+  it 'should include all elements' do
+    [1,2,3].include_all?([1,2,3]).should be_true
+    [1,2,3].include_all?([1,2]).should be_true
+    [1,2].include_all?([1,2,3]).should be_false
+    [1,2].include_all?([4,5,6]).should be_false
+    [].include_all?([4,5,6]).should be_false
+    [].include_all?([]).should be_true
+  end
+
+  it 'should include any elements' do
+    [1,2,3].include_any?([1,2,3]).should be_true
+    [1,2,3].include_any?([1,2]).should be_true
+    [1,2,3].include_any?([1,4,5]).should be_true
+    [1,2,3].include_any?([4,5,6]).should be_false
+    [].include_any?([]).should be_false
+  end
+end
+
+describe Hash do
+  it { should respond_to :include_all? }
+  it { should respond_to :include_any? }
+
+  it 'should include all keys' do
+    ({'a' => 1, 'b' => 2, 'c' => 3}.include_all?(['a','b','c'])).should be_true
+    ({'a' => 1, 'b' => 2, 'c' => 3}.include_all?(['a','b'])).should be_true
+    ({'a' => 1, :b => 2}).include_all?(['a', 'b']).should be_false
+    ({'a' => 1, 'b' => 2}.include_all?(['c'])).should be_false
+  end
+
+  it 'should include any keys' do
+    ({'a' => 1, 'b' => 2}.include_any?(['a', 'b', 'c'])).should be_true
+    ({'a' => 1, :b => 2}.include_any?(['a', 'b', 'c'])).should be_true
+    ({'a' => 1, 'b' => 2}.include_any?([:a, :b])).should be_false
+    ({'a' => 1, 'b' => 2}.include_any?(['d', 'e'])).should be_false
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: git_handler
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-23 00:00:00 Z
+date: 2012-06-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -87,6 +87,7 @@ files:
 - spec/authorized_keys_spec.rb
 - spec/command_spec.rb
 - spec/configuration_spec.rb
+- spec/core_ext_spec.rb
 - spec/fixtures/.gitkeep
 - spec/public_key_spec.rb
 - spec/session_spec.rb
@@ -122,6 +123,7 @@ test_files:
 - spec/authorized_keys_spec.rb
 - spec/command_spec.rb
 - spec/configuration_spec.rb
+- spec/core_ext_spec.rb
 - spec/fixtures/.gitkeep
 - spec/public_key_spec.rb
 - spec/session_spec.rb