atlassian-stash-avisi 0.4.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd4aa7e0c2c0f4fc7f9590c8a505a5fab6d70cd5
+  data.tar.gz: 9b22cd3452ff21e9978f39ccbf38c9edb6a5288e
+SHA512:
+  metadata.gz: e9d1279424f61ba9c9d692ceb8a36b26669673b0212e4a4975b888cb695c1d9d1f3a613e78504ac75e1cdc656a0f9ebc642de298ad060c944b23190fb2d08b78
+  data.tar.gz: fe991aba491b3a95e26c1b079d98953ff4ea2cbfab56ab3e18af936e2078c30fc7d882ad9f7b622668e7d2b1fb39751939a83a324981a7d4ba4c959478409539

data/.document

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

data/Gemfile

@@ -0,0 +1,23 @@
+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"
+gem 'ruby-keychain', :require => 'keychain'
+
+#
+# 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
+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 = "atlassian-stash-avisi"
+  gem.homepage = "https://insight.avisi.nl/stash/projects/TPL/repos/stash-command-line-tools"
+  gem.license = "MIT"
+  gem.summary = "Command line tools for Atlassian Stash Avisi version"
+  gem.description = "Provides convenient functions for interacting with Atlassian Stash through the command line"
+  gem.email = "m.diepenbroek@avisi.nl"
+  gem.authors = ["Seb Ruiz", "Maik Diepenbroek"]
+  # 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.4.15

data/bin/stash

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.dirname(__FILE__) + "/../lib/stash_cli"
+require 'commander/import'
+require 'yaml'
+require 'launchy'
+require 'pathname'
+require 'base64'
+
+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
+
+
+$configFile = File.join(ENV['HOME'], ".stashconfig.yml")
+
+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['stash_url']
+  # config.merge! repo_config
+  config
+end
+
+# def repo_config
+#   return @repo_config if @repo_config
+#   ascender = Pathname.pwd.to_enum(:ascend)
+#   config_path = ascender.detect { |path| (path + '.stash').exist? }
+#   @repo_config = YAML.load_file(path + '.stash')
+#   @repo_config
+# 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|
+    useKeyChain = options.useKeyChain ? options.useKeyChain : ask("Use the keychain to authenticate with stash (y/n)")
+    if useKeyChain.downcase != "y"
+      username = options.username ? options.username : ask("Stash Username: ")
+      password = options.password ? options.password : ask("Stash Password (optional): ") { |q| q.echo = "*" }
+    else
+      username = ""
+      password = ""
+    end
+    stashUrl = options.stashUrl ? options.stashUrl : ask("Stash URL: ")
+    remote   = options.remote   ? options.remote   : ask("Remote (optional): ")
+    certificateFile = options.certificateFile ? options.certificateFile : ask("Absolute path to certificate file: (/Users/username/certificate.p12)")
+    certificatePassword = options.certificatePassword ? options.certificatePassword : ask("Certificate password: ") { |q| q.echo = "*"}
+
+    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?
+    c['certificateFile'] = certificateFile.to_s unless certificateFile.empty?
+    c['certificatePassword'] = Base64.strict_encode64(certificatePassword.to_s)
+    c['ssl_no_verify'] = true
+
+    if useKeyChain.downcase == "y"
+      c['useKeyChain'] = true
+    else
+      c['useKeyChain'] = false
+    end
+
+    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 = []
+    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.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
+
+    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
+    remote = options.remote || config['remote']
+    remote_url = get_remote_url(remote)
+
+    repoInfo = RepoInfo.create(config, remote_url)
+
+    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,36 @@
+
+
+module Atlassian
+  module Stash
+    module Git
+      def get_current_branch
+        %x(git symbolic-ref HEAD)[/refs\/heads\/(.*)/, 1]
+      end
+
+      def is_in_git_repository?
+        system('git rev-parse')
+      end
+
+      def get_remotes
+        %x(git remote -v)
+      end
+
+      def get_remote_url(remote = 'origin')
+        origin = get_remotes.split("\n").collect { |r| r.strip }.grep(/^#{remote}.*\(push\)$/).first
+        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
+    end
+  end
+end

data/lib/atlassian/stash/pull_request.rb

@@ -0,0 +1,163 @@
+require 'json'
+require 'net/https'
+require 'uri'
+require 'git'
+require 'launchy'
+require 'keychain'
+require 'base64'
+
+include Atlassian::Util::TextUtil
+
+module Atlassian
+  module Stash
+    class CreatePullRequestResource
+      attr_accessor :resource
+
+      def initialize(projectKey, slug, title, description, reviewers, source, target)
+        repository = {
+        'slug' => slug,
+        'project' => {
+          'key' => projectKey
+          }
+        }
+        fromRef = {
+          'id' => source,
+          'repository' => repository
+        }
+        toRef = {
+          'id' => target,
+          'repository' => repository
+        }
+        @resource = {
+          'title' => title,
+          'fromRef' => fromRef,
+          'toRef' => toRef
+        }
+
+        @resource["description"] = description unless description.empty?
+
+        @resource["reviewers"] = reviewers.collect { |r|
+            {
+              'user' => {
+                'name' => r
+              }
+            }
+        } unless reviewers.empty?
+      end
+    end
+
+    class CreatePullRequest
+
+      def initialize(config)
+        @config = config
+      end
+
+      def create_pull_request(source, target, reviewers, options)
+
+        Process.exit if not target or not source
+
+        @source = source
+        @target = target
+
+        remote = get_remote_url(options.remote || @config["remote"])
+        repoInfo = RepoInfo.create(@config, remote)
+
+        title, description = title_and_description(options)
+
+        resource = CreatePullRequestResource.new(repoInfo.projectKey, repoInfo.slug, title, description, reviewers, @source, @target).resource
+        if(@config['useKeyChain'])
+          stashKeyChain = Keychain.internet_passwords.where({:server =>"insight.avisi.nl", :path => '/stash/login'} ).first
+          
+          username = stashKeyChain.account
+          password = stashKeyChain.password
+        else
+          username = @config["username"]
+          password = @config["password"]
+        end
+        proxy_addr, proxy_port = parse_proxy(@config["proxy"])
+        if(!@config['useKeyChain'])
+          username = ask("Username: ") unless @config["username"]
+          password = ask("Password: ") { |q| q.echo = '*' } unless @config["password"]
+        end
+        uri = URI.parse(@config["stash_url"])
+        prPath = repoInfo.repoPath + '/pull-requests'
+
+        req = Net::HTTP::Post.new(uri.query.nil? ? "#{prPath}" : "#{prPath}?#{uri.query}", {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+        req.basic_auth username, password
+        req.body = resource.to_json
+        http = Net::HTTP.new(uri.host, uri.port, proxy_addr, proxy_port)
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @config["ssl_no_verify"]
+        http.use_ssl = uri.scheme.eql?("https")
+
+
+
+        if not @config["certificateFile"].empty?
+          p12 = OpenSSL::PKCS12.new(File.read(@config["certificateFile"]), Base64.strict_decode64(@config['certificatePassword']))
+          http.cert = p12.certificate
+          http.key = p12.key
+        end
+
+        response = http.start {|conn| conn.request(req) }
+
+        if not response.is_a? Net::HTTPCreated
+          responseBody = JSON.parse(response.body)
+          if responseBody['errors']
+            responseBody['errors'].collect { |error|
+              puts error['message']
+              if error['reviewerErrors']
+                error['reviewerErrors'].collect { |revError|
+                  puts revError['message']
+                }
+              end
+            }
+          elsif responseBody['message']
+            puts responseBody['message']
+          else
+            puts 'An unknown error occurred.'
+            puts response.code
+            puts response.body
+          end
+        else
+          responseBody = JSON.parse(response.body)
+          prUri = uri.clone
+          prUri.path = prPath + '/' + responseBody['id'].to_s
+          prUri.query = uri.query
+          puts prUri.to_s
+
+          if @config["open"] || options.open
+            Launchy.open prUri.to_s
+          end
+        end
+      end
+
+      private
+
+      def title_from_branch
+        convert_branch_name_to_sentence(@source) || "Merge '#{@source}' into '#{@target}'"
+      end
+
+      def git_commit_messages
+        @commit_messages ||= `git log --reverse --format=%s #{@target}..#{@source}`
+      end
+
+      def parse_proxy(conf)
+        return nil, nil unless conf
+
+        addr, port = conf.split(":")
+        if port =~ /\d+/
+          port = port.to_i
+        else
+          port = nil
+        end
+        [addr, port]
+      end
+
+      def title_and_description(options)
+        descr = (options.description or git_commit_messages)
+        title = (options.title or title_from_branch)
+
+        [title, descr]
+      end
+    end
+  end
+end