murmurs 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,61 @@
+Murmurs
+================
+
+Murmurs is a rubygem provides commands to post a murmur message to your Mingle project.
+
+Ruby 1.9+ is required.
+
+Installation
+----------------
+
+    gem install murmurs
+
+A command 'murmurs' will be installed.
+
+Usage
+----------------
+
+For posting a murmur on your Mingle project, you need specify:
+
+1. Mingle murmurs URL. It is pointing to your Mingle site and project murmurs api endpoint.
+   Example: https://site-name.mingle-api.thoughtworks.com/api/v2/projects/your_project/murmurs.xml
+2. Mingle uses HMAC auth access key id and HMAC auth access secret key. Every user can generate one HMAC secret key from his or her profile page under the HMAC Auth Key tab.
+   For further information about Mingle user access key id and secret key, please read:
+   http://www.thoughtworks.com/products/docs/mingle/current/help/configuring_hmac_authentication.html
+
+Example:
+
+    murmurs -m https://site-name.mingle-api.thoughtworks.com/api/v2/projects/your_project/murmurs.xml -k mingle_access_key_id -s mingle_access_secure_key  "Murmurs Git integration is done. Our git commits will stream to our project's Murmurs."
+
+You can also setup environment variables for the configurations needed as follows:
+
+    export MINGLE_MURMURS_URL=https://site-name.mingle-api.thoughtworks.com/api/v2/projects/your_project/murmurs.xml
+    export MINGLE_ACCESS_KEY_ID=mingle_access_key_id
+    export MINGLE_ACCESS_SECRET_KEY=mingle_access_secret_key
+
+So that you don't need to specify them when murmur something:
+
+    murmurs "text"
+
+Type "murmurs -h" for full help.
+
+Integrate Mingle Murmurs with Git
+----------------
+
+On your Git server:
+
+    install ruby 1.9+
+    install rubygems if there was no one installed with ruby
+    gem install murmurs
+
+murmurs gem should install a new command 'murmurs-git' (In some OS, the script name maybe changed to murmurs-git1.9 for ruby 1.9)
+
+Install the git hook for post-receive:
+
+    murmurs-git <mingle repository path>
+
+Then, in the git repository, setup the following configs:
+
+    git config hooks.minglemurmursurl "https://your-site.mingle-api.thoughtworks.com/api/v2/projects/your_project/murmurs.xml"
+    git config hooks.mingleaccesskeyid <Mingle user access key id>
+    git config hooks.mingleaccesssecretkey <Mingle user access secret key>

data/lib/murmurs.rb

@@ -6,6 +6,7 @@ require 'json'
 
 module Murmurs
   class InvalidMurmursURLError < StandardError; end
+  class UnexpectedResponseError < StandardError; end
 
   def murmur(url, msg, options={})
     if options[:git]
@@ -70,6 +71,8 @@ module Murmurs
              end
       `git rev-list #{revs}`.split("\n").map do |rev|
         `git log -n 1 #{rev}`
+      end.reverse.map do |msg|
+        "Repository: #{File.basename(Dir.getwd)}\n#{msg}"
       end
     end
   end
@@ -99,7 +102,11 @@ module Murmurs
     response = http.request(request)
 
     if response.code.to_i > 300
-      response.error!
+      raise UnexpectedResponseError, <<-ERROR
+\nRequest URL: #{url}
+Response: #{response.code} #{response.message}
+Response Headers: #{response.to_hash.inspect}\nResponse Body: #{response.body}"
+ERROR
     end
   end
 end

metadata

@@ -1,46 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: murmurs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
+  prerelease: 
 platform: ruby
 authors:
 - ThoughtWorks Mingle Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api-auth
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.8.1
-description: |
-  Use HMAC to create murmur in Mingle project.
+description: ! 'Use HMAC to create murmur in Mingle project.
+
   Git post-receive hook to post murmurs when new commits pushed to Git server.
+
+'
 email:
 - mingle-dev@thoughtworks.com
 executables:
@@ -56,25 +63,26 @@ files:
 homepage: https://github.com/ThoughtWorksStudios/murmurs
 licenses:
 - MIT
-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.2.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Post murmur to Mingle project murmurs
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 5ceb67cfc3d4fb198e351f552d210920b5a4782c
-  data.tar.gz: 13873e634d77ec001d70ce537e8420da3ac25618
-SHA512:
-  metadata.gz: ea6cabec5e53fc13b741d9a2c7b8864e98196d8c39f46d78b7e560d03cb718f2178d30e5ae269f64ee11fb5b69dfa5dc8ff934ed8fa32eb4b5507e735acb2be4
-  data.tar.gz: ddf79b99bc3ee18f5e9987c771bf5fe05e8bf6f5da8c585c59686860559dd0898a7cc1857c739a8081646a9aaff436fb70356a906bee8199fe5e1a99707831ca