murmurs 0.1.0 → 0.1.1

data/README.md

@@ -1,48 +1,17 @@
 Murmurs
 ================
 
-Murmurs is a rubygem provides commands to post a murmur message to your Mingle project.
-And Git post-receive hook to post murmurs when new commits pushed to Git server.
+Murmurs is a rubygem for integrating Git with your Mingle project.
 
-Ruby 1.9+ is required.
-
-Installation
-----------------
-
-    gem install murmurs
-
-A command 'murmurs' will be installed. (In some OS, the script name maybe changed to murmurs1.9 for ruby 1.9)
+Ruby 1.9+ is required. Windows is not supported.
 
 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 you murmur something:
-
-    murmurs "text"
+What you need from your Mingle site/project:
 
-Type "murmurs -h" for full help.
-
-Integrating Mingle Murmurs with Git
-----------------
-Murmurs gem can be used to integrate with Git. Use the following instructions to setup your git server so that it murmurs everytime something has been pushed to the server.
+1. Mingle project murmurs URL. You can get it by substituting your site name and project identifier to the following URL: https://<your-site>.mingle-api.thoughtworks.com/api/v2/projects/<your-project>/murmurs.xml
+2. HMAC auth access key id and access secret key to access your Mingle project. You can get it from existing team member, or create a new user and add the user to your project. The HMAC auth access key id and access secret key is generated at "HMAC Auth Key" tab on user's profile page. 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
 
 On your Git server:
 
@@ -50,14 +19,32 @@ On your Git server:
     install rubygems if there was no one installed with ruby
     gem install murmurs
 
-murmurs gem should install a new command 'murmurs'
+murmurs gem should install a new command 'murmurs' (In some OS, the script name maybe changed to murmurs1.9 for ruby 1.9).
 
-Install the git hook for post-receive:
+Install the git hook post-receive (you may need to execute as the user having write permission to the git repository path) on Git server:
 
     murmurs -a <git 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.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>
+
+After installed, try push a new commit to the server, and you should see something like the followings in your console:
+
+    remote: murmur => your-project@your-site.mingle-api.thoughtworks.com
+
+Note, the post-receive hook installed will never block you push commits to server, because Git calls the hook after the push work is done.
+
+Test Git integration
+-------------------
+
+To confirm you can post a murmur o your Mingle project from the Git server with the configurations, you can run the following command:
+
+    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  "This is a test."
+
+Type "murmurs -h" for full details.
+
+
+So before you integrate Git server with your Mingle project, you can test the configurations on your Git server first, for example:

data/bin/murmurs

@@ -26,7 +26,7 @@ http://www.thoughtworks.com/products/docs/mingle/current/help/configuring_hmac_a
 
 GIT_INTALLATION_NOTES = %Q{
 Please setup the following git config:
-git config hooks.minglemurmursurl "https://<your_site>.mingle.thoughtworks.com/api/v2/pro
+git config hooks.minglemurmursurl "https://<your-site>.mingle-api.thoughtworks.com/api/v2/projects/<your-project>/murmurs.xml"
 git config hooks.mingleaccesskeyid "MINGLE ACCESS KEY ID"
 git config hooks.mingleaccesssecretkey "MINGLE ACCESS SECRET KEY"
 

data/lib/murmurs.rb

@@ -2,7 +2,6 @@ require 'net/http'
 require 'net/https'
 require 'time'
 require 'api-auth'
-require 'json'
 require 'murmurs/git'
 
 module Murmurs
@@ -26,7 +25,7 @@ module Murmurs
       end
     else
       validate_murmurs_url!(url)
-      http_post(url, {:murmur => {:body => msg}}, options)
+      http_post(url, "{\"murmur\":{\"body\":#{msg.inspect}}}", options)
     end
   end
 
@@ -54,7 +53,7 @@ module Murmurs
     end
   end
 
-  def http_post(url, params, options={})
+  def http_post(url, body, options={})
     uri = URI.parse(url)
     http = Net::HTTP.new(uri.host, uri.port)
     if uri.scheme == 'https'
@@ -63,7 +62,6 @@ module Murmurs
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
     end
-    body = params.to_json
 
     request = Net::HTTP::Post.new(uri.request_uri)
     request.body = body

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: murmurs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-10 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api-auth
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.3
-- !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: ! 'Post murmur to your Mingle project from command line.
 
   Git post-receive hook to post murmurs when new commits pushed to Git server.
@@ -74,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1940277211336045179
+      hash: 716371937611647900
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -83,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1940277211336045179
+      hash: 716371937611647900
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23