stash_notifier 1.1.0 → 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## version 2.0.0
+Add stash_pwd option to notify
+Add VCR support for offline testing
+Refactor StashNotifier into Module
+  Create StashNotifier::BuildResult class
+  Create StashNotifier::HTTPClient class
+
+Fixes #8: Add to_s method to StashNotifier class
+
 ## version 1.1.0
 Fixes #4: Rename "job\_" parameters to "build\_" and add `build_name` param
 

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,4 +1,5 @@
 # StashNotifier
+[![Build Status](https://travis-ci.org/dougireton/stash_notifier.png)](https://travis-ci.org/dougireton/stash_notifier)
 
 A Ruby gem to send CI build status to [Atlassian Stash 2.1+][1]
 

data/bin/notify

@@ -16,31 +16,38 @@
 # limitations under the License.
 
 require 'slop'
-
 require 'stash_notifier'
+require 'chef-vault'
 
 # EXAMPLE:
-# notify -s https://git.mycompany.com -u my_chef_user -c e2b8a34c60eeec41d3e9d83f60d3b288e909c1eb -r failed -k REPO-MASTER -n REPO-MASTER-12 -l http://jenkins.my_company.com/jenkins/view/FOO/job/Deploy/17/console -d 'Jenkins deploy job'
+# notify -s https://git.mycompany.com -u my_stash_user -g e2b8a34c60eeec41d3e9d83f60d3b288e909c1eb -r failed -k REPO-MASTER -n REPO-MASTER-12 -l http://jenkins.my_company.com/jenkins/view/FOO/job/Deploy/17/console -d 'Jenkins deploy job'
 
-opts = Slop.parse( help: true, strict: true, arguments: true ) do
+opts = Slop.parse(help: true, strict: true, arguments: true) do
   banner 'Usage: notify [options]'
-  on :s, :stash_url=, 'Atlassian Stash server base URL, e.g. https://git.mycompany.com'
-  on :u, :stash_user=, 'Stash API user'
-  on :g, :git_commit=, 'Git commit sha'
-  on :d, :data_bag=, 'Name of Chef passwords data bag'
-  on :c, :config=, 'Chef config file'
-  on :r, :build_status=, 'CI server job status, e.g. INPROGRESS, SUCCESSFUL, FAILED'
-  on :k, :build_key=, 'CI server job name'
-  on :n, :build_name=, 'CI server build name'
-  on :l, :build_url=, 'URL to CI server job results'
-  on :d, :build_description=, 'CI server job description'
+  on :s,  :stash_url=,          'Atlassian Stash server base URL, e.g. https://git.mycompany.com'
+  on :u,  :stash_user=,         'Stash API user'
+  on :p,  :stash_pwd=,          "Stash API user's password"
+  on :g,  :git_commit=,         'Git commit sha'
+
+  on :d,  :data_bag=,           'Name of Chef passwords data bag'
+  on :c,  :config=,             'Chef config file'
+
+  on :r,  :build_status=,       'CI server job status, e.g. INPROGRESS, SUCCESSFUL, FAILED'
+  on :k,  :build_key=,          'CI server job name'
+  on :n,  :build_name=,         'CI server build name'
+  on :l,  :build_url=,          'URL to CI server job results'
+  on :d,  :build_description=,  'CI server job description'
 end
 
-args = opts.to_hash
+@args = opts.to_hash
+
+def get_stash_pwd
+  ChefVault.load_config(@args[:config])
+  user = ChefVault::Item.load(@args[:data_bag], @args[:stash_user])
+  user['password']
+end
 
-# this is bad. ChefVault should set this.
-args[:data_bag] ||= 'passwords'
+@args[:stash_pwd] ||= get_stash_pwd
 
-notify = StashNotifier.new(args)
-notify.pwd_vault = ChefVault.new(args[:data_bag], args[:config])
+notify = StashNotifier.new(@args)
 notify.post_to_stash

data/lib/stash_notifier.rb

@@ -13,93 +13,26 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'faraday'
-require 'chef-vault'
-require 'json'
-require "stash_notifier/version"
-
-class StashNotifier
-  attr_accessor :stash_url, :stash_user, :git_commit,
-    :build_key, :build_name, :build_url, :build_description, :http_client, :pwd_vault
-
-  attr_reader :build_status
-
-  VALID_BUILD_STATUSES = %w{ INPROGRESS SUCCESSFUL FAILED }
-  STASH_BUILD_STATUS_PATH = 'rest/build-status/1.0/commits'
-
-  DEFAULTS = {
-    http_client: Faraday.new,
-    pwd_vault:   ChefVault.new('passwords')
-  }
-
-  def initialize(args)
-    args = DEFAULTS.merge(args) {|key, arg, default| arg.nil? ? default : arg}
-
-    @stash_url         = args[:stash_url]
-    @stash_user        = args[:stash_user]
-    @git_commit        = args[:git_commit]
-    self.build_status  = args[:build_status]
-    @build_key         = args[:build_key]
-    @build_name        = args[:build_name]
-    @build_url         = args[:build_url]
-    @build_description = args[:build_description]
-    @http_client       = args[:http_client]
-    @pwd_vault         = args[:pwd_vault]
-  end
-
-  def build_status=(new_build_status)
-    new_build_status = new_build_status.strip.upcase
-
-    if VALID_BUILD_STATUSES.include?(new_build_status)
-      @build_status = new_build_status
-    else
-      raise ArgumentError, "'#{new_build_status}' is not a valid Stash Build Status! Valid job statuses are #{VALID_BUILD_STATUSES}."
-    end
-  end
-
-  def post_to_stash
-    setup_http_client
-    response = post_results
-    check_errors(response)
-  end
-
-  private
-
-  def setup_http_client
-    http_client.url_prefix = stash_url
-    http_client.path_prefix = STASH_BUILD_STATUS_PATH
-    http_client.basic_auth(stash_user, get_pwd)
-    http_client.ssl[:verify] = false
-  end
-
-  def post_results
-    http_client.post do |req|
-      req.url git_commit
-      req.headers['Content-Type'] = 'application/json'
-      req.body = format_build_result
-    end
-  end
-
-  def check_errors(response, success_codes=[204])
-    unless success_codes.include?(response.status)
-      # raise an error here please
-      puts "FAILED: #{response.to_s}"
+require 'stash_notifier/build_result'
+require 'stash_notifier/http_client'
+require 'stash_notifier/version'
+
+module StashNotifier
+  class << self
+    def new(args)
+      # TODO: Refactor this into private method
+      build_args               = {}
+      build_args[:state]       = args[:build_status]
+      build_args[:key]         = args[:build_key]
+      build_args[:name]        = args[:build_name]
+      build_args[:url]         = args[:build_url]
+      build_args[:description] = args[:build_description]
+
+      build_result = StashNotifier::BuildResult.new(build_args)
+
+      args[:build_result] = build_result.to_json
+
+      StashNotifier::HTTPClient.new(args)
     end
   end
-
-  def format_build_result
-    build_result = {
-      state:       build_status,
-      key:         build_key,
-      name:        build_name,
-      url:         build_url,
-      description: build_description
-    }
-    build_result.to_json
-  end
-
-  def get_pwd
-    user = pwd_vault.user(stash_user)
-    user.decrypt_password
-  end
 end

data/lib/stash_notifier/build_result.rb

@@ -0,0 +1,53 @@
+# build_result.rb
+# Copyright 2013 Doug Ireton
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module StashNotifier
+  class BuildResult
+
+    attr_accessor :key, :name, :url, :description
+    attr_reader :state
+
+    VALID_BUILD_STATES = %w{ INPROGRESS SUCCESSFUL FAILED }
+
+    def initialize(args)
+      self.state   = args[:state]
+      @key         = args[:key]
+      @name        = args[:name]
+      @url         = args[:url]
+      @description = args[:description]
+    end
+
+    def state=(new_state)
+      new_state = new_state.upcase
+      if VALID_BUILD_STATES.include?(new_state)
+        @state = new_state
+      else
+        raise ArgumentError, "'#{new_state}' is not a valid Stash Build state! Valid states are #{VALID_BUILD_STATES}."
+      end
+    end
+
+    def to_json
+      result = {
+        state:       state,
+        key:         key,
+        name:        name,
+        url:         url,
+        description: description
+      }
+      result.to_json
+    end
+
+  end
+end

data/lib/stash_notifier/exceptions.rb

@@ -0,0 +1,20 @@
+# exceptions.rb
+# Copyright 2013 Doug Ireton
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module StashNotifier
+  class Error < StandardError; end
+  class BadRequest < StandardError; end
+  class Unauthorized < StandardError; end
+end

data/lib/stash_notifier/http_client.rb

@@ -0,0 +1,97 @@
+# stash_nofier.rb
+# Copyright 2013 Doug Ireton
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'faraday'
+require 'json'
+require 'stash_notifier/exceptions'
+
+module StashNotifier
+
+  class HTTPClient
+    STASH_BUILD_STATUS_PATH = 'rest/build-status/1.0/commits'
+    DEFAULTS = {
+      http_client: Faraday.new
+    }.freeze
+
+    attr_accessor :stash_url, :stash_user, :stash_pwd, :git_commit,
+                  :build_result, :http_client
+
+    def initialize(args)
+      args = DEFAULTS.merge(args)
+
+      @stash_url    = args[:stash_url]
+      @stash_user   = args[:stash_user]
+      @stash_pwd    = args[:stash_pwd]
+      @git_commit   = args[:git_commit]
+      @build_result = args[:build_result]
+      @http_client  = args[:http_client]
+    end
+
+    def to_s
+      "StashNotifier connection:
+      url: #{stash_url},
+      git_commit: #{git_commit},
+      user: #{stash_user},
+      pwd: ***********,
+      build_result: #{build_result}"
+    end
+
+    def post_to_stash
+      setup_http_client
+      response = post_results
+      check_errors(response)
+      response
+    end
+
+    private
+
+    def setup_http_client
+      http_client.url_prefix = stash_url
+      http_client.path_prefix = STASH_BUILD_STATUS_PATH
+      http_client.basic_auth(stash_user, stash_pwd)
+      http_client.ssl[:verify] = false
+    end
+
+    def post_results
+      http_client.post do |req|
+        req.url git_commit
+        req.headers['Content-Type'] = 'application/json'
+        req.body = build_result
+      end
+    end
+
+    def check_errors(response)
+      unless response.success?
+
+        err_msg = get_stash_err(response)
+
+        case response.status
+        when 400
+          raise StashNotifier::BadRequest, err_msg
+        when 401
+          raise StashNotifier::Unauthorized, err_msg
+        else
+          raise StashNotifier::Error, err_msg
+        end
+      end
+    end
+
+    def get_stash_err(response)
+      response_body = JSON.parse(response.body)
+      response_body['errors'].first['message']
+    end
+
+  end
+end

data/lib/stash_notifier/version.rb

@@ -13,6 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-class StashNotifier
-  VERSION = "1.1.0"
+module StashNotifier
+  VERSION = '2.0.0'
 end

data/spec/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/spec/cassettes/StashNotifier/_post_to_stash/returns_204_when_passed_valid_parameters.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stash.example.com/rest/build-status/1.0/commits/68ccfc66971c2e1e2ca57e17707dbebb6c6b4ebb
+    body:
+      encoding: UTF-8
+      string: ! '{"state":"SUCCESSFUL","key":"repo-master","name":"repo-master-42","url":"https://jenkins.example.com/view/All/job/myproject/57/console","description":null}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Basic <Base-64 encoded password>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      x-arequestid:
+      - 1018x2286998x1
+      set-cookie:
+      - JSESSIONID=78EC7ADF309F13A72875495FA5DE378D; Path=/; Secure; HttpOnly
+      x-ausername:
+      - MY_STASH_USER
+      x-asessionid:
+      - p4ihzt
+      cache-control:
+      - no-cache, no-transform
+      vary:
+      - X-AUSERNAME, Cookie
+      content-type:
+      - application/json
+      date:
+      - Tue, 17 Sep 2013 23:58:14 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 23:58:13 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_passed_an_invalid_git_commit.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stash.example.com/rest/build-status/1.0/commits/bogus
+    body:
+      encoding: UTF-8
+      string: ! '{"state":"SUCCESSFUL","key":"repo-master","name":"repo-master-42","url":"https://jenkins.example.com/view/All/job/myproject/57/console","description":null}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Basic <Base-64 encoded password>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      x-arequestid:
+      - 1018x2287000x1
+      set-cookie:
+      - JSESSIONID=902D30453B14A38C1D8978CAFB949FDE; Path=/; Secure; HttpOnly
+      x-ausername:
+      - MY_STASH_USER
+      x-asessionid:
+      - 12cpxek
+      cache-control:
+      - no-cache, no-transform
+      vary:
+      - X-AUSERNAME, Cookie
+      content-type:
+      - application/json;charset=UTF-8
+      transfer-encoding:
+      - chunked
+      date:
+      - Tue, 17 Sep 2013 23:58:14 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"errors":[{"context":null,"message":"Please specify the changeset
+        id as a 40-character hash","exceptionName":null}]}'
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 23:58:13 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_key_is_missing_or_invalid.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stash.example.com/rest/build-status/1.0/commits/68ccfc66971c2e1e2ca57e17707dbebb6c6b4ebb
+    body:
+      encoding: UTF-8
+      string: ! '{"state":"successful","key":null,"name":"repo-master-42","url":"https://gittst.example.com","description":"This
+        is the description"}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Basic <Base-64 encoded password>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      x-arequestid:
+      - 1018x2286996x1
+      set-cookie:
+      - JSESSIONID=A67AE640B7FA3BC552DE426A490B7FCB; Path=/; Secure; HttpOnly
+      x-ausername:
+      - MY_STASH_USER
+      x-asessionid:
+      - 1l5rkd0
+      cache-control:
+      - no-cache, no-transform
+      vary:
+      - X-AUSERNAME, Cookie
+      content-type:
+      - application/json;charset=UTF-8
+      transfer-encoding:
+      - chunked
+      date:
+      - Tue, 17 Sep 2013 23:58:13 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"errors":[{"context":null,"message":"Please specify a non-blank
+        key","exceptionName":null}]}'
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 23:58:12 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_state_is_missing_or_invalid.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stash.example.com/rest/build-status/1.0/commits/68ccfc66971c2e1e2ca57e17707dbebb6c6b4ebb
+    body:
+      encoding: UTF-8
+      string: ! '{"state":"bogus","key":"repo-master","name":"repo-master-42","url":"https://gittst.example.com","description":"This
+        is the description"}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Basic <Base-64 encoded password>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      x-arequestid:
+      - 1018x2286997x1
+      set-cookie:
+      - JSESSIONID=EF4D56A1F42560CBBD897C99B903E0C0; Path=/; Secure; HttpOnly
+      x-ausername:
+      - MY_STASH_USER
+      x-asessionid:
+      - 879ej3
+      cache-control:
+      - no-cache, no-transform
+      vary:
+      - X-AUSERNAME, Cookie
+      content-type:
+      - application/json;charset=UTF-8
+      transfer-encoding:
+      - chunked
+      date:
+      - Tue, 17 Sep 2013 23:58:13 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"errors":[{"context":null,"message":"Please specify a valid state
+        (valid states: {SUCCESSFUL,FAILED,INPROGRESS})","exceptionName":null}]}'
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 23:58:13 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_url_is_missing_or_invalid.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stash.example.com/rest/build-status/1.0/commits/68ccfc66971c2e1e2ca57e17707dbebb6c6b4ebb
+    body:
+      encoding: UTF-8
+      string: ! '{"state":"successful","key":"repo-master","name":"repo-master-42","url":"bogus","description":"This
+        is the description"}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Basic <Base-64 encoded password>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      x-arequestid:
+      - 1018x2286994x1
+      set-cookie:
+      - JSESSIONID=9FC5CD033AAEE6B9019416F415E4D03F; Path=/; Secure; HttpOnly
+      x-ausername:
+      - MY_STASH_USER
+      x-asessionid:
+      - 16txqub
+      cache-control:
+      - no-cache, no-transform
+      vary:
+      - X-AUSERNAME, Cookie
+      content-type:
+      - application/json;charset=UTF-8
+      transfer-encoding:
+      - chunked
+      date:
+      - Tue, 17 Sep 2013 23:58:13 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"errors":[{"context":null,"message":"Please specify a valid url","exceptionName":null}]}'
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 23:58:12 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/StashNotifier/_post_to_stash/returns_401_when_passed_an_invalid_stash_pwd.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stash.example.com/rest/build-status/1.0/commits/68ccfc66971c2e1e2ca57e17707dbebb6c6b4ebb
+    body:
+      encoding: UTF-8
+      string: ! '{"state":"SUCCESSFUL","key":"repo-master","name":"repo-master-42","url":"https://jenkins.example.com/view/All/job/myproject/57/console","description":null}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+        - Basic <Base-64 encoded password>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 401
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      x-arequestid:
+      - 1018x2286999x1
+      set-cookie:
+      - JSESSIONID=6B3D48F2656588A1AF9F323BDA04FFA7; Path=/; Secure; HttpOnly, _atl_stash_remember_me="";
+        Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/
+      www-authenticate:
+      - Basic realm="Atlassian Stash"
+      content-type:
+      - application/json;charset=UTF-8
+      content-length:
+      - '130'
+      date:
+      - Tue, 17 Sep 2013 23:58:14 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"errors":[{"context":null,"message":"Authentication failed. Please
+        check your credentials and try again.","exceptionName":null}]}'
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 23:58:13 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/StashNotifier/_post_to_stash/returns_401_when_passed_an_invalid_stash_user.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stash.example.com/rest/build-status/1.0/commits/68ccfc66971c2e1e2ca57e17707dbebb6c6b4ebb
+    body:
+      encoding: UTF-8
+      string: ! '{"state":"SUCCESSFUL","key":"repo-master","name":"repo-master-42","url":"https://jenkins.example.com/view/All/job/myproject/57/console","description":null}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Basic Ym9ndXM6TTBiaWxlLXNoZWxs
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 401
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      x-arequestid:
+      - 1018x2286995x1
+      set-cookie:
+      - JSESSIONID=F0BB7905B2B5E65755F44E61DCDF9215; Path=/; Secure; HttpOnly, _atl_stash_remember_me="";
+        Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/
+      www-authenticate:
+      - Basic realm="Atlassian Stash"
+      content-type:
+      - application/json;charset=UTF-8
+      content-length:
+      - '130'
+      date:
+      - Tue, 17 Sep 2013 23:58:13 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"errors":[{"context":null,"message":"Authentication failed. Please
+        check your credentials and try again.","exceptionName":null}]}'
+    http_version: 
+  recorded_at: Tue, 17 Sep 2013 23:58:12 GMT
+recorded_with: VCR 2.5.0

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# speck_helper.rb
+# spec_helper.rb
 # Copyright 2013 Doug Ireton
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,3 +15,28 @@
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'stash_notifier'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :faraday
+  c.configure_rspec_metadata!
+end
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # disable should syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/stash_notifier/build_result_spec.rb

@@ -0,0 +1,79 @@
+# build_result_spec.rb
+# Copyright 2013 Doug Ireton
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+require 'spec_helper'
+
+describe StashNotifier::BuildResult do
+
+  let(:args) {
+    {
+      state: 'successful',
+      key: 'repo-master',
+      name: 'repo-master-42',
+      url: 'https://gittst.example.com',
+      description: 'This is the description'
+    }
+  }
+
+  let(:build_result)  { StashNotifier::BuildResult.new(args) }
+
+  describe '#state' do
+    it "returns UPPERCASE state" do
+      expect(build_result.state).to eq('SUCCESSFUL')
+    end
+
+    it 'accepts a different state' do
+      build_result.state = 'failed'
+      expect(build_result.state).to eq('FAILED')
+    end
+
+    it 'raises an ArgumentError when state is not valid' do
+      expect { build_result.state = 'foo' }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#key' do
+    it 'returns the build key' do
+      expect(build_result.key).to eq 'repo-master'
+    end
+  end
+
+  describe '#name' do
+    it 'returns the name' do
+      expect(build_result.name).to eq 'repo-master-42'
+    end
+  end
+
+  describe '#url' do
+    it 'returns the url' do
+      expect(build_result.url).to eq 'https://gittst.example.com'
+    end
+  end
+
+  describe '#description' do
+    it 'returns the description' do
+      expect(build_result.description).to eq 'This is the description'
+    end
+  end
+
+  describe '#to_json' do
+    it 'returns a JSON string suitable for sending to the Stash Build Result API endpoint' do
+      args[:state] = 'SUCCESSFUL'
+      expect(build_result.to_json).to eq(args.to_json)
+    end
+  end
+
+end

data/spec/stash_notifier_spec.rb

@@ -14,10 +14,110 @@
 # limitations under the License.
 
 require 'spec_helper'
+require 'json'
 
 describe StashNotifier do
-  it 'should have a version number' do
-    expect(StashNotifier::VERSION).to_not be_nil
+
+  let(:build_result) do
+    {
+      state:       'successful',
+      key:         'repo-master',
+      name:        'repo-master-42',
+      url:         'https://jenkins.example.com/view/All/job/myproject/57/console',
+      description: 'This is the description'
+    }
+  end
+
+  let(:args) do
+    {
+      stash_url:    'https://stash.example.com',
+      stash_user:   'my_stash_user',
+      stash_pwd:    'P@ssword',
+      git_commit:   '68ccfc66971c2e1e2ca57e17707dbebb6c6b4ebb',
+      build_status: build_result[:state],
+      build_key:    build_result[:key],
+      build_name:   build_result[:name],
+      build_url:    build_result[:url],
+      description:  build_result[:description],
+      # you must supply http_client so that VCR can override it
+      http_client:  Faraday.new
+    }
+  end
+
+  let!(:stash_notifier) { StashNotifier.new(args) }
+
+  it 'should have a SimVer compatible version number' do
+    SIMVER_REGEXP = /^\d{1}\.\d{1,2}\.\d{1,2}\.*\w*$/
+    expect(StashNotifier::VERSION).to match SIMVER_REGEXP
+  end
+
+  describe '#post_to_stash', :vcr do
+    it 'returns 204 when passed valid parameters' do
+
+      response = stash_notifier.post_to_stash
+      expect(response.status).to eq 204
+    end
+
+    it 'returns 401 when passed an invalid stash_user' do
+      stash_notifier.stash_user = 'bogus'
+
+      expect { stash_notifier.post_to_stash }.to \
+        raise_error(StashNotifier::Unauthorized,
+                    'Authentication failed. Please check your credentials and try again.')
+    end
+
+    it 'returns 401 when passed an invalid stash_pwd' do
+      stash_notifier.stash_pwd = 'bogus'
+
+      expect { stash_notifier.post_to_stash }.to \
+        raise_error(StashNotifier::Unauthorized,
+                    'Authentication failed. Please check your credentials and try again.')
+    end
+
+    it 'returns 400 when passed an invalid git_commit' do
+      stash_notifier.git_commit = 'bogus'
+
+      expect { stash_notifier.post_to_stash }.to \
+        raise_error(StashNotifier::BadRequest)
+    end
+
+    it 'returns 400 when the build state is missing or invalid' do
+      build_result[:state] = 'bogus'
+      stash_notifier.build_result = build_result.to_json
+
+      expect { stash_notifier.post_to_stash }.to \
+        raise_error(StashNotifier::BadRequest)
+    end
+
+    it 'returns 400 when the build key is missing or invalid' do
+      build_result[:key] = nil
+      stash_notifier.build_result = build_result.to_json
+
+      expect { stash_notifier.post_to_stash }.to \
+        raise_error(StashNotifier::BadRequest)
+    end
+
+    it 'returns 400 when the build url is missing or invalid' do
+      build_result[:url] = 'bogus'
+      stash_notifier.build_result = build_result.to_json
+
+      expect { stash_notifier.post_to_stash }.to \
+        raise_error(StashNotifier::BadRequest)
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns a nice, descriptive string' do
+      stash_notifier = StashNotifier.new(args)
+      expect(stash_notifier.to_s).to start_with('StashNotifier connection')
+    end
+
+  end
+
+  describe '#http_client' do
+    it 'returns the http_client' do
+      expect(stash_notifier.http_client).to be_an_instance_of(Faraday::Connection)
+    end
   end
 
 end

data/stash_notifier.gemspec

@@ -19,25 +19,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'stash_notifier/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "stash_notifier"
+  spec.name          = 'stash_notifier'
   spec.version       = StashNotifier::VERSION
-  spec.authors       = ["Doug Ireton"]
-  spec.email         = ["doug.ireton@nordstrom.com"]
+  spec.authors       = ['Doug Ireton']
+  spec.email         = ['doug.ireton@nordstrom.com']
   spec.description   = %q{Send per-commit CI server build results to Atlassian Stash}
   spec.summary       = %q{Send per-commit CI server build results to Atlassian Stash}
-  spec.homepage      = "https://github.com/dougireton/stash_notifier"
-  spec.license       = "Apache License, Version 2.0"
+  spec.homepage      = 'https://github.com/dougireton/stash_notifier'
+  spec.license       = 'Apache License, Version 2.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday', '~> 0.8'
-  spec.add_dependency 'chef-vault', '~> 1.2'
+  spec.add_dependency 'chef-vault', '~> 2.0'
   spec.add_dependency 'slop'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'vcr', '~> 2.5'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: stash_notifier
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Doug Ireton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,20 +30,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-vault
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -83,6 +94,55 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -90,6 +150,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -107,39 +168,62 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/notify
 - lib/stash_notifier.rb
+- lib/stash_notifier/build_result.rb
+- lib/stash_notifier/exceptions.rb
+- lib/stash_notifier/http_client.rb
 - lib/stash_notifier/version.rb
+- spec/.rspec
+- spec/cassettes/StashNotifier/_post_to_stash/returns_204_when_passed_valid_parameters.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_passed_an_invalid_git_commit.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_key_is_missing_or_invalid.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_state_is_missing_or_invalid.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_url_is_missing_or_invalid.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_401_when_passed_an_invalid_stash_pwd.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_401_when_passed_an_invalid_stash_user.yml
 - spec/spec_helper.rb
+- spec/stash_notifier/build_result_spec.rb
 - spec/stash_notifier_spec.rb
 - stash_notifier.gemspec
 homepage: https://github.com/dougireton/stash_notifier
 licenses:
 - Apache License, Version 2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Send per-commit CI server build results to Atlassian Stash
 test_files:
+- spec/.rspec
+- spec/cassettes/StashNotifier/_post_to_stash/returns_204_when_passed_valid_parameters.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_passed_an_invalid_git_commit.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_key_is_missing_or_invalid.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_state_is_missing_or_invalid.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_400_when_the_build_url_is_missing_or_invalid.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_401_when_passed_an_invalid_stash_pwd.yml
+- spec/cassettes/StashNotifier/_post_to_stash/returns_401_when_passed_an_invalid_stash_user.yml
 - spec/spec_helper.rb
+- spec/stash_notifier/build_result_spec.rb
 - spec/stash_notifier_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDQ5MWE1ZGYxMTgwNjVkZDUzYTFmYzkzZTZmMWIzMWY3ZTc0MDcwYQ==
-  data.tar.gz: !binary |-
-    OTlhZTZjYTYxYzZiNGE1ZTc5MjkwNjcyMTQwODdmM2UzOTg1MGJlMg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NTgxOGE5NGQxYjcxODQwNzFjOTUxZWYzYmQxZjVhNjMwNDZiYWE1NTIxYjhh
-    MGZhMDVlOWVhM2JlNDdjZmVhZGYyYzFiYzg4MGQzMmUyZjQ4ZDU0N2UwMGY4
-    ZDhhMjI0NjEyNzZmNmQwM2VmNWVhOGRmZDVmOWNkZmU1NzdkMTA=
-  data.tar.gz: !binary |-
-    MmMwZDlmNGM3MjI2ZjZmMmM4ZDBlZDViNjkyMTUyOGRlYTdhZTM3Y2JkYTQ4
-    NGIxMDkwMjI0ZDkzZTJhM2FkNmJkMWY2YjMzYTQwNDUxM2FiODA0ZTg2ZjBh
-    OWU1ZjczZTc1MDc2NzcyZTNkZjBkOThlOGFjNTc1YWI4N2I3NmY=