git-semaphore 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 796fce310598b663f7a73fa5f98d68602de41bf6
-  data.tar.gz: 25ace2adb5a1a3f245ab1a02c9f86553917d0550
+  metadata.gz: 40184be592c2c2afc8dc9ca98da908756e67df2d
+  data.tar.gz: ee4104f83902c4e3ccbfde0514f4e00d84e36ccd
 SHA512:
-  metadata.gz: 24e942d6b710d328183c42d89937ca5e80c2c51ed5dc2d3e5f5cea4780bd3b1b2ad890c3bfb43d01a55dbcbcb2b7b4bba889e1adb7473562662d4ad00bc488b0
-  data.tar.gz: 168659a4950ecdba848365456bea3052ca393734cf72e942affdf81e859fbdfb139067a303e21b5ee44124f1143030b450e69df4a338f0996ce54739ede739f4
+  metadata.gz: 86e2abea939c3ad674cffdd68f01bb8d39651d281b9d51a1ef4bc9a325c5b2cea8ea5c22a4b9ed1e8e2ff782b873037921b2dc70844782422631ce69b8844fe1
+  data.tar.gz: 041c9f620e57de36d55849665c3ff06f153870bdbe8c3a508c03dcb471705a70abe192e950064e683370ad6ebb97a585c6a9797933101fcde3de197d6a40e154

data/README.md

@@ -38,17 +38,17 @@ The following [Semaphore API][] features are supported by `git semaphore`:
 
 | API feature      |    | command |summary |
 |------------------|----|---------|--------|
-| [authentication][]    | ✅ |                            | provide user authentication via an authentication token            |
-| [projects][]          | ✅ | `git semaphore --projects` | list all projects and their current status                         |
-| [project branches][]  | ✅ | `git semaphore --branches` | list all branches for the current project                          |
-| [branch status][]     | ✅ | `git semaphore --status`   | list the build status for the current branch                       |
-| [branch history][]    | ✅ | `git semaphore --history`  | list the build history for the current branch                      |
-| [build information][] | ❌ |                            | detailed information for a given build number                      |
-| [build log][]         | ❌ |                            | execution logs for a given build number _(per thread and command)_ |
-| [rebuild][]           | ✅ | `git semaphore --rebuild`  | rebuild last revision for the current branch                       |
-| [launch build][]      | ❌ |                            | launch a build for the given commit SHA                            |
-| [stop][]              | ❌ |                            | stop an in-progress build                                          |
-| [deploy][]            | ❌ |                            | run a deploy from a given build                                    |
+| [authentication][]    | ✅ |                               | provide user authentication via an authentication token            |
+| [projects][]          | ✅ | `git semaphore --projects`    | list all projects and their current status                         |
+| [project branches][]  | ✅ | `git semaphore --branches`    | list all branches for the current project                          |
+| [branch status][]     | ✅ | `git semaphore --status`      | list the build status for the current branch                       |
+| [branch history][]    | ✅ | `git semaphore --history`     | list the build history for the current branch                      |
+| [build information][] | ✅ | `git semaphore --information` | detailed information for a given build number _(ie. all commits)_  |
+| [build log][]         | ❌ |                               | execution logs for a given build number _(per thread and command)_ |
+| [rebuild][]           | ✅ | `git semaphore --rebuild`     | rebuild last revision for the current branch                       |
+| [launch build][]      | ❌ |                               | launch a build for the given commit SHA                            |
+| [stop][]              | ❌ |                               | stop an in-progress build                                          |
+| [deploy][]            | ❌ |                               | run a deploy from a given build                                    |
 
 [project branches]:  https://semaphoreci.com/docs/branches-and-builds-api.html#project_branches
 [branch status]:     https://semaphoreci.com/docs/branches-and-builds-api.html#branch_status
@@ -111,6 +111,7 @@ When used inside a git repository, `git semaphore` uses [convention over configu
 | project name | derived from pwd   | `File.basename(Dir.pwd)`        | `ENV['SEMAPHORE_PROJECT_NAME']` |
 | branch name  | current git branch | `git symbolic-ref --short HEAD` | `ENV['SEMAPHORE_BRANCH_NAME']`  |
 | commit SHA   | current git head   | `git rev-parse HEAD`            | `ENV['SEMAPHORE_COMMIT_SHA']`   |
+| build number | last branch build  | `N/A`                           | `ENV['SEMAPHORE_BUILD_NUMBER']` |
 
 However, each of these defaults can be overridden by setting the corresponding environment variable, as documented in the above table.  The same `ENV`-based override mechanism can be leveraged to use `git semaphore` outside of a git repository.
 
@@ -171,6 +172,12 @@ _(the project and branch names are derived from the current git repository and t
 
 _(the project and branch names are derived from the current git repository and the current git head)_
 
+### commit information for the last build of a project's branch
+
+    git semaphore --information
+
+_(the project and branch names are derived from the current git repository and the current git head)_
+
 ## Formatting the raw `git semaphore` JSON output
 
 After installing [the indispensable jq utility][jq] (`brew install jq`), the raw JSON output generated by the various `git semaphore` commands can be formatted and queried as follows:
@@ -186,6 +193,9 @@ After installing [the indispensable jq utility][jq] (`brew install jq`), the raw
 
     # list the build duration (in minutes) for all "passed" builds of the current branch
     git semaphore --history | jq -r '.builds | .[] | select(.result == "passed") | (.build_number|tostring) + "\t" + (.duration.minutes|tostring)'
+    
+    # list all commit SHAs that triggered the latest build
+    git semaphore --information | jq -r '.commits | .[] | .id'
 
 [semaphoreci.com]:  https://semaphoreci.com/
 [account settings]: https://semaphoreci.com/users/edit

data/exe/git-semaphore

@@ -22,11 +22,12 @@ if __FILE__ == $0
 
     on :clean,    'Deletes the cached API query results'
 
-    on :projects, 'List all projects and their current status'
-    on :branches, 'List all branches for the current project'
-    on :status,   'List the build status for the current branch'
-    on :history,  'List the build history for the current branch'
-    on :rebuild,  'Rebuild last revision for the current branch'
+    on :projects,    'List all projects and their current status'
+    on :branches,    'List all branches for the current project'
+    on :status,      'List the build status for the current branch'
+    on :history,     'List the build history for the current branch'
+    on :information, 'List the commit information for the last build'
+    on :rebuild,     'Rebuild last revision for the current branch'
 
   end
 
@@ -67,6 +68,11 @@ if __FILE__ == $0
     exit 0
   end
 
+  if options.information?
+    puts app.information.to_json
+    exit 0
+  end
+
   if options.rebuild?
     puts app.rebuild
     exit 0

data/lib/git/semaphore/api.rb

@@ -20,6 +20,10 @@ module Git
         end
       end
 
+      def self.information project_hash_id, branch_id, build_number, auth_token
+        get_json information_uri(project_hash_id, branch_id, build_number, auth_token)
+      end
+
       def self.rebuild project_hash_id, branch_id, auth_token
         get_json last_revision_uri(project_hash_id, branch_id, auth_token), :post
       end
@@ -58,6 +62,14 @@ module Git
 
       private_class_method :history_uri
 
+      def self.information_uri project_hash_id, branch_id, build_number, auth_token
+        # https://semaphoreci.com/docs/branches-and-builds-api.html#build_information
+        # GET /api/v1/projects/:hash_id/:id/builds/:number
+        request_uri(auth_token, :path => File.join('projects', project_hash_id, branch_id, 'builds', build_number))
+      end
+
+      private_class_method :information_uri
+
       def self.last_revision_uri project_hash_id, branch_id, auth_token
         # https://semaphoreci.com/docs/branches-and-builds-api.html#rebuild
         # POST /api/v1/projects/:project_hash_id/:branch_id/build

data/lib/git/semaphore/api_cache.rb

@@ -27,6 +27,12 @@ module Git
           end
         end
 
+        def self.information project_hash_id, branch_id, build_number, auth_token
+          @information ||= Git::Semaphore.from_json_cache(information_cache(project_hash_id, branch_id, build_number)) do
+            API.information project_hash_id, branch_id, build_number, auth_token
+          end
+        end
+
         # private helper functions
 
         def self.projects_cache
@@ -53,6 +59,12 @@ module Git
 
         private_class_method :history_cache
 
+        def self.information_cache project_hash_id, branch_id, build_number
+          File.join(Git::Semaphore.cache_dir_for(project_hash_id), "#{branch_id}_#{build_number}_information.json")
+        end
+
+        private_class_method :information_cache
+
       end
     end
   end

data/lib/git/semaphore/app.rb

@@ -3,6 +3,7 @@ class Git::Semaphore::App
   attr_writer :project_name
   attr_writer :branch_name
   attr_writer :commit_sha
+  attr_writer :build_number
 
   attr_reader :branch_url
 
@@ -13,6 +14,7 @@ class Git::Semaphore::App
     self.project_name = config['SEMAPHORE_PROJECT_NAME']
     self.branch_name  = config['SEMAPHORE_BRANCH_NAME']
     self.commit_sha   = config['SEMAPHORE_COMMIT_SHA']
+    self.build_number = config['SEMAPHORE_BUILD_NUMBER']
   end
 
   def to_json
@@ -21,6 +23,7 @@ class Git::Semaphore::App
       semaphore_project_name: self.project_name,
       semaphore_branch_name:  self.branch_name,
       semaphore_commit_sha:   self.commit_sha,
+      semaphore_build_number: self.build_number,
     }.to_json
   end
 
@@ -39,6 +42,11 @@ class Git::Semaphore::App
     @git_repo.head.commit.id if @git_repo
   end
 
+  def build_number
+    return @build_number unless @build_number.nil?
+    history['builds'].first['build_number'].to_s
+  end
+
   def projects
     Git::Semaphore::API::Cache.projects(@auth_token)
   end
@@ -55,6 +63,10 @@ class Git::Semaphore::App
     Git::Semaphore::API::Cache.history(project_hash_id, branch_id, @auth_token)
   end
 
+  def information
+    Git::Semaphore::API::Cache.information(project_hash_id, branch_id, build_number, @auth_token,)
+  end
+
   def rebuild
     Git::Semaphore::API.rebuild(project_hash_id, branch_id, @auth_token)
   end
@@ -104,12 +116,8 @@ class Git::Semaphore::App
     branch_id_for(branch_name)
   end
 
-  def build_statuses
-    history['builds']
-  end
-
   def build_status_for commit_sha
-    build_statuses.find { |build_status|
+    history['builds'].find { |build_status|
       build_status['commit']['id'] == commit_sha
     }
   end

data/lib/git/semaphore/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Semaphore
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-semaphore
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Vandenberk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop