bpescatore-stash 0.3.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDBlOTcxYzM3YzkzYjY3ZTQ5NWRlYmQ5N2Y0NWVhODQ5MzQ4MzE2Ng==
+  data.tar.gz: !binary |-
+    M2EyZTlhNDk2ODY0OGQxN2I2MmE3OGQ2YmZmMmQ2OWMzZTdhMzhjYw==
+SHA512:
+  metadata.gz: !binary |-
+    ZTllZDZmNjY2NjQ3OGViMGY4YjJlMDg4MTc4YWJmZGE0MmU5ZDMxZjE0MmFm
+    MDZiMjljOGFmYzhiMjU0NzgxMzM1ODNhZDM2NzI4MWVmZTQwNTU3M2RhMGI3
+    ZTkxNjEwNzJjZjA5ODFiNGExYWI5ODU3YjUwYmJlNTU2MmQyNjY=
+  data.tar.gz: !binary |-
+    ZTZjZGI0NGVmOTQ2YzVjMGYxYWI4MTJhNDIxNmQ1NTU4ZjhmYjM0ZjY5OTAx
+    ODhkMzEwYjczZjJhZDY2YmE2MTJiMDg0NjYxNmRmMmYwNDMzYjNhYmI5MTQ2
+    OTEzNjQ1ZjM3ZDY2YzA2YTliYTVmZTY1N2VmNWJjYmEwNDM0MDI=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "git", ">= 1.2.5"
+gem "json", ">= 1.7.5"
+gem "commander", "~> 4.1.2"
+gem "launchy", "~> 2.4.2"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.2.0"
+  gem "jeweler", "~> 2.0.0"
+  gem "rcov", ">= 0", :platforms => :ruby_18
+  gem "simplecov", ">= 0", :platforms => :ruby_19, :require => "false"
+  gem "minitest", ">= 0", :platforms => :ruby_19
+  gem "mocha", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Seb Ruiz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Atlassian Stash Command Line Tools
+
+## Installing this tool
+This command line helper for Stash is written in Ruby and is deployed as a [Ruby Gem](https://rubygems.org/gems/atlassian-stash/). Installation is easy, simply run the following command
+
+```
+#!text
+$> gem install atlassian-stash
+```
+
+(Protip: you might need to `sudo`)
+
+Once the gem is installed, the command `stash` will be in your `$PATH`
+
+## Configuration and usage
+Run `stash configure`. This will prompt for details about your Stash instance. If no password is provided, then you will be prompted for a password when executing commands to Stash. Currently, the password is stored in plain text in a configuration file, `~/.stashconfig.yml` which is protected with a permission bit of `0600`. 
+
+### Creating a pull request
+Use the `pull-request` command to create a pull request in Stash. For example:
+
+```
+#!text
+$> stash pull-request topicBranch master @michael
+Create a pull request from branch 'topicBranch' into 'master' with 'michael' added as a reviewer
+```
+
+See the usage for command details 
+
+```
+#!text
+$> stash help pull-request
+```
+
+### Opening the Stash web UI
+Use the `browse` command to open the Stash UI for your repository in the browser.
+
+```
+#!text
+$> stash browse -b develop
+Open the browser at the Stash repository page for the branch 'develop'
+```
+
+For more options, see the help
+
+```
+#!text
+stash help browse
+```
+
+## Configuration options
+
+Running `stash configure` will prepopulate `~/.stashconfig.yml` with a variety of options. Complete options are:
+
+```
+#!yaml
+username: seb # username to connect to stash server.
+password: s3cr3t # password for user. If ommitted, you will be prompted at the terminal when making a request to Stash
+stash_url: https://stash.server.com # fully qualified stash url
+open: true # opens newly created pull requests in the browser
+ssl_no_verify: true # do not check ssl certificates for the configured stash server
+```
+
+## Troubleshooting
+Q: I installed the gem, but the `stash` command doesn't work.  
+A: Do you have another command called `stash` or do you have an alias? Have a look where the command maps to
+
+```
+#!text
+$> which -a stash
+```
+
+Then check the value of your $PATH
+
+## I want to contribute
+Thanks! Please [fork this project](https://bitbucket.org/atlassian/stash-command-line-tools/fork) and create a pull request to submit changes back to the original project.
+
+### Build instructions
+Building this gem is easy. To get started, run the following commands:
+
+```
+#!text
+$> gem install bundler
+$> bundle install
+```
+
+Now start hacking, and run the stash command by invoking `./bin/stash command`
+
+### Testing
+
+Easy:
+
+```
+$> rake test
+```
+
+### Releasing
+
+#### Bumping versions
+
+Use `rake version`:
+
+```
+version             -- displays the current version
+version:bump:major  -- bump the major version by 1
+version:bump:minor  -- bump the a minor version by 1
+version:bump:patch  -- bump the patch version by 1
+version:write       -- writes out an explicit version
+```
+
+#### Releasing
+
+```
+$> rake release
+```

data/Rakefile

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bpescatore-stash"
+  gem.homepage = "https://bitbucket.org/atlassian/stash-command-line-tools"
+  gem.license = "MIT"
+  gem.summary = "Command line tools for Atlassian Stash"
+  gem.description = "Provides convenient functions for interacting with Atlassian Stash through the command line" 
+  gem.email = "bpescatore@mocana.com"
+  gem.authors = ["Seb Ruiz"]
+  # dependencies defined in Gemfile
+  gem.executables = ["stash"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+    test.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError => e
+end
+
+begin
+  require "simplecov"
+
+  desc "Execute tests with coverage report"
+  task :simplecov do
+    ENV["COVERAGE"]="true"
+    Rake::Task["test"].execute
+  end
+rescue LoadError
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "atlassian-stash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.2

data/bin/stash

@@ -0,0 +1,170 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.dirname(__FILE__) + "/../lib/stash_cli"
+require 'commander/import'
+require 'yaml'
+require 'launchy'
+require 'pathname'
+
+program :name, "Atlassian Stash CLI"
+program :version, Atlassian::Stash::Version::STRING
+program :description, "Provides convenient functions for interacting with Atlassian Stash through the command line"
+
+include Atlassian::Stash
+include Atlassian::Stash::Git
+
+$configFileName = ".stashconfig.yml"
+$configFile = File.join(ENV['HOME'], $configFileName)
+
+def load_config
+  raise "No Stash configuration found; please run configure" unless File.exists? $configFile
+  config = YAML.load_file($configFile)
+  raise "Stash configuration file is incomplete, please re-run configure" unless config['username'] and config['stash_url']
+  config.merge! repo_config if repo_config
+  config
+end
+
+def repo_config
+  return @repo_config if @repo_config
+
+  repo_root = get_repo_root_directory.strip
+  repo_directory = Pathname.new(repo_root)
+  stash_config = repo_directory + $configFileName
+  if (stash_config.exist? && stash_config.file?)
+    @repo_config = YAML.load_file(stash_config)
+  end
+  Hash.new
+end
+
+command 'configure' do |c|
+  c.syntax = 'configure'
+  c.description = 'Setup configuration details to your Stash instance'
+  c.example 'stash configure --username sebr --password s3cre7 --stash_url http://stash.mycompany.com', 'Setup Stash CLI with credentials to the Stash server'
+  c.option '--username user', String, 'Writes your Stash username to the configuration file'
+  c.option '--password password', String, 'Writes your Stash user password to the configuration file. If omitted, password will be prompted to be entered'
+  c.option '--stashUrl', String, 'Writes the Stash server url to the configuration file'
+  c.option '--remote', String, 'Pull requests will be created in the Stash repository specified by the given remote'
+  c.action do |args, options|
+    username = options.username ? options.username : ask("Stash Username: ")
+    password = options.password ? options.password : ask("Stash Password (optional): ") { |q| q.echo = "*" }
+    stashUrl = options.stashUrl ? options.stashUrl : ask("Stash URL: ")
+    remote   = options.remote   ? options.remote   : ask("Remote (optional): ")
+
+    c = {
+      'stash_url' => stashUrl.to_s
+    }
+
+    c['username'] = username.to_s unless username.empty?
+    c['password'] = password.to_s unless password.empty?
+    c['remote']   = remote.to_s   unless remote.empty?
+
+    File.open($configFile, 'w') do |out|
+      YAML.dump(c, out)
+    end
+
+    File.chmod 0600, $configFile
+
+    create_git_alias if agree "Create a git alias 'git create-pull-request'? "
+  end
+end
+
+command 'pull-request' do |c|
+  def extract_reviewers(args = [])
+    default_reviewers = repo_config.nil? ? Array.new : Array(repo_config[:reviewers])
+    default_reviewers.concat args.collect { |user|
+      user[1..-1] if user.start_with?("@")
+    }.compact
+  end
+
+  c.syntax = 'pull-request [sourceBranch] targetBranch [@reviewer1 @reviewer2] [options]'
+  c.description = 'Create a pull request in Stash'
+  c.option '-d DESCRIPTION', '--description DESCRIPTION', String, 'Use the following description when creating the pull request'
+  c.option '-T TITLE', '--title TITLE', String, 'Use the following title when creating the pull request'
+  c.option '-r remote', '--remote remote', String, 'Creates the pull request in the Stash repository specified by the given remote'
+  c.option '-o', '--open', 'Open the created pull request page in a web browser'
+  c.example 'stash pull-request topicBranch master @michael', "Create a pull request from branch 'topicBranch' into 'master' with 'michael' added as a reviewer"
+  c.example 'stash pull-request master', "Create a pull request from the current git branch into 'master'"
+  c.example 'stash pull-request master -T "JIRA-1234 new feature" -d "Adds new feature as described in JIRA-1234"', "Create a pull request from the current git branch into 'master' with the title 'JIRA-1234 new feature' and description 'Adds new feature as described in JIRA-1234'"
+  c.example 'stash pull-request topicBranch upstream/master', "Create a pull request from branch 'topicBranch' into branch 'master' on the remote named 'upstream'"
+  c.example 'stash pull-request remotes/upstream/master', "Create a pull request from the current branch into branch 'master' on the remote named 'upstream'"
+  c.action do |args, options|
+    if args.length == 0
+      command(:help).run('pull-request')
+      Process.exit
+    end
+
+    source = args.shift
+    if args.empty? or args.first.start_with?("@")
+      target = source
+      source = get_current_branch
+      reviewers = extract_reviewers args
+    else
+      target = args.shift
+      reviewers = extract_reviewers args
+    end
+
+    # Strip out any starting 'remotes/' from branch name for matching
+    if source.index('remotes/') == 0
+        source = source['remotes/'.size..-1]
+    end
+    if target.index('remotes/') == 0
+        target = target['remotes/'.size..-1]
+    end
+
+    options.src_remote = options.remote
+    if not is_branch?(source)
+      if not is_branch?("remotes/" + source)
+        raise "fatal: unrecogonized source branch"
+      end
+      # If a remote matches, split the remote out of the refspec
+      options.src_remote = source.split('/')[0]
+      source = source.split('/')[1..-1].join('/')
+    end
+
+    if not is_branch?(target)
+      if not is_branch?("remotes/" + target)
+        raise "fatal: unrecognized target branch"
+      end
+      # If a remote matches, split the remote out of the refspec
+      options.target_remote = target.split('/')[0]
+      target = target.split('/')[1..-1].join('/')
+    end
+
+    ensure_within_git! do
+      cpr = CreatePullRequest.new(load_config)
+      cpr.create_pull_request source, target, reviewers, options
+    end
+  end
+end
+
+command 'browse' do |c|
+  c.syntax = 'browse [browse|commits|pull-requests]'
+  c.description = 'Open the Stash web ui for this repository'
+  c.option '-b branch', '--branch branch', String, 'Open the Stash web ui at the specified branch, tag or commit hash. Defaults to the current branch'
+  c.option '-r remote', '--remote remote', String, 'Creates the pull request in the Stash repository specified by the given remote'
+  c.example 'stash browse -b master', 'Open the files view for this repository at the current branch'
+  c.example 'stash browse -r upstream', 'Open the files view for the "upstream" remote repository'
+
+  c.action do |args, options|
+
+    tab = args.shift unless args.empty?
+
+    config = load_config
+
+    repoInfo = RepoInfo.create(config, options.remote)
+
+    branch = options.branch || get_current_branch
+
+    Launchy.open repoInfo.repoUrl(tab, branch)
+  end
+end
+
+
+default_command :help
+program :help_formatter, :compact
+program :help, 'Authors', 'Seb Ruiz <sruiz@atlassian.com>'
+program :help, 'Website', 'https://bitbucket.org/atlassian/stash-command-line-tools'
+
+
+# vim set ft=ruby

data/lib/atlassian/stash/git.rb

@@ -0,0 +1,57 @@
+
+
+module Atlassian
+  module Stash
+    module Git
+
+      DEFAULT_REMOTE="origin"
+
+      def get_current_branch
+        %x(git symbolic-ref HEAD)[/refs\/heads\/(.*)/, 1]
+      end
+
+      def get_branches()
+        %x{git branch -a}
+      end
+
+      def is_branch?(match)
+        not get_branches.split().select{|x| x == match}.empty?
+      end
+
+      def is_in_git_repository?
+        system('git rev-parse')
+      end
+
+      def get_remotes
+        %x(git remote -v)
+      end
+
+      def get_remote_url(remote=nil)
+        remotes = get_remotes
+        return nil if remotes.empty?
+
+        remote = DEFAULT_REMOTE if remote.nil? || remote.empty?
+
+        origin = remotes.split("\n").collect { |r| r.strip }.grep(/^#{remote}.*\(push\)$/).first
+        return nil if origin.nil?
+        URI.extract(origin).first
+      end
+
+      def ensure_within_git!
+        if is_in_git_repository?
+          yield
+        else
+          raise "fatal: Not a git repository"
+        end
+      end
+
+      def create_git_alias
+        %x(git config --global alias.create-pull-request "\!sh -c 'stash pull-request \\$0'")
+      end
+
+      def get_repo_root_directory
+        %x(git rev-parse --show-toplevel)
+      end
+    end
+  end
+end