mina-revisioneer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8ec22774860a6dbdf62a6d39fbf6f7fc32ade30
+  data.tar.gz: 934418b672249f4229ac643fdfc91e5fc7fb7ec8
+SHA512:
+  metadata.gz: b381d2163700f1cd15d10128ab1f9a319a56b4f49642b2e6b718552788592df796b7d27b83623d3f30403b53862d304d0cb433adcd9ad15d7ea4fa13fd41da69
+  data.tar.gz: 9c57e647cbf4299651d64a5a0c2e9e1d93d5d96636e950f8ab6247b61ec8e4e3a77a0a5b790b41a5a16d263ffb2e3fd781ce77e6ea0cc3d8a68edf9708b85240

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mina_revisioneer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    mina-revisioneer (0.1.0)
+      rugged
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.1.0)
+    rugged (0.19.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  mina-revisioneer!
+  rake

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Raphael Randschau
+
+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,50 @@
+# MinaRevisioneer
+
+Notify revisioneer of new deployments automatically. Integrates properly with [mina][1].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'mina_revisioneer'
+```
+
+Next update your deployment file:
+
+``` ruby
+# config/deploy.rb
+require 'mina-revisioneer'
+# ...
+set :revisioneer_host, "https://revisioneer.io"
+set :revisioneer_api_token, ENV["REVISIONEER_TOKEN"]
+# ...
+task :deploy => :environment do
+  deploy do
+    # ...
+    invoke :'revisioneer:notify'
+  end
+end
+```
+
+Now deploy away while keeping revisioneer in sync.
+
+## Usage
+
+MinaRevisioneer uses the oneline commit message summaries from git to populate your deployment informations.
+Alongside with your current SHA these informations are passed to revisioneer.
+
+Assuming you are on Ruby on Rails you can use [revisioneer-rails][2] to display the deployment informations somewhere in your application.
+
+Note however that interfacing with revisioneer is really simple so you can always RYO.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[1]:https://github.com/nadarei/mina
+[2]:https://github.com/nicolai86/revisioneer-rails

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mina-revisioneer.rb

@@ -0,0 +1 @@
+require 'mina_revisioneer'

data/lib/mina_revisioneer.rb

@@ -0,0 +1,49 @@
+require "mina_revisioneer/version"
+require "mina_revisioneer/message_extractor"
+require "mina_revisioneer/change_log"
+require "mina_revisioneer/grouped_change_log"
+
+# # Modules: Revisioneer
+# Adds settings and tasks for interfacing with Revisioneer
+#
+#     require 'mina-revisioneer'
+
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### revisioneer_host
+# Sets the revisioneer host.
+
+set_default :revisioneer_host, 'https://revisions.deployed.eu'
+
+# ### revisioneer_api_token
+# Sets the api_token required by revisioneer
+
+set_default :revisioneer_api_token, ''
+
+# ### revisioneer_message_generator
+# Sets a class used  to extra the current sha, as well as
+# changeset messages. If you want to implement different message
+# styles, this is the place to go
+set_default :revisioneer_message_generator, -> { ::MinaRevisioneer::ChangeLog.new(revisioneer_host, revisioneer_api_token, binding) }
+
+# ## Deploy tasks
+# These tasks are meant to be invoked inside deploy scripts, not invoked on
+# their own.
+
+namespace :revisioneer do
+  # ### revisioneer:notify
+  # notifies revisioneer of a new deployment
+  desc "notifies revisioneer of a new deployment"
+  task :notify do
+    payload = {
+      "sha" => revisioneer_message_generator.sha,
+      "messages" => revisioneer_message_generator.messages,
+      "new_commit_counter" => revisioneer_message_generator.number_of_new_commits
+    }
+    queue %{
+      echo "-----> Notifying revisioneer"
+      #{echo_cmd %[curl  -X POST "#{revisioneer_host}/deployments" -d '#{JSON.dump(payload)}' -H "API-TOKEN: #{revisioneer_api_token}" -H "Content-Type: application/json" -s]}
+    }
+  end
+end

data/lib/mina_revisioneer/change_log.rb

@@ -0,0 +1,30 @@
+module MinaRevisioneer
+  # Uses the first line of each commit message as entries to the changelog
+  #
+  # can be configured by setting
+  #   :revisioneer_inclusion
+  # for inclusiong (whitelisting) and
+  #   :revisioneer_exclusion
+  # for exlusion (blacklisting)
+  class ChangeLog < MessageExtractor
+    def messages
+      walker = Rugged::Walker.new(repo)
+      walker.push sha
+      walker.hide last_deploy_sha if last_deploy_sha
+      messages = walker.each.to_a.map { |commit|
+        commit.message.lines.first.strip
+      }
+      messages.select! { |line| line =~ revisioneer_inclusion } if revisioneer_inclusion
+      messages.reject! { |line| line =~ revisioneer_exclusion } if revisioneer_exclusion
+      messages
+    end
+
+    def revisioneer_inclusion
+      eval "revisioneer_inclusion", binding
+    end
+
+    def revisioneer_exclusion
+      eval "revisioneer_exclusion", binding
+    end
+  end
+end

data/lib/mina_revisioneer/grouped_change_log.rb

@@ -0,0 +1,35 @@
+module MinaRevisioneer
+  # Uses the markers inside the commit message to generate change groups
+  #
+  # can be configured by setting
+  #   :revisioneer_markers
+  # must be a hash of GroupName => Marker
+  class GroupedChangeLog < MessageExtractor
+    def messages
+      groups = Hash.new
+
+      walker = Rugged::Walker.new(repo)
+      walker.push sha
+      walker.hide last_deploy_sha if last_deploy_sha
+      walker.each do |commit|
+        revisioneer_markers.each do |marker, pattern|
+          commit.message.lines.each do |line|
+            if line =~ pattern
+              (groups[marker] ||= []) << line.strip
+            end
+          end
+        end
+      end
+
+      messages = []
+      groups.each do |key, ms|
+        messages << "#{key}:\n#{ms.join("\n")}"
+      end
+      messages
+    end
+
+    def revisioneer_markers
+      eval "revisioneer_markers", binding
+    end
+  end
+end

data/lib/mina_revisioneer/message_extractor.rb

@@ -0,0 +1,51 @@
+require "json"
+require "rugged"
+
+module MinaRevisioneer
+  class MessageExtractor
+    attr_reader :host, :api_token, :binding
+    def initialize host, token, binding
+      @host = host
+      @api_token = token
+      @binding = binding
+    end
+
+    def last_deploy
+      @last_deploy ||= begin
+        curl = %Q{curl "#{host}/deployments?limit=1" -H "API-TOKEN: #{api_token}" -s}
+        response = %x[#{curl}].strip
+        JSON.parse(response).first || {}
+      end
+    rescue => err
+      {} # no JSON received - propably first deploy?
+    end
+
+    def number_of_new_commits
+      walker = Rugged::Walker.new(repo)
+      walker.push sha
+      walker.hide last_deploy_sha if last_deploy_sha
+      walker.each.to_a.count
+    end
+
+    def last_deploy_date
+      Time.parse(last_deploy.fetch("deployed_at"))
+    end
+
+    def last_deploy_sha
+      last_deploy.fetch("sha", nil)
+    end
+
+    def repo
+      @repo ||= Rugged::Repository.new(".")
+    end
+
+    def messages
+      [] # implemented in subclass
+    end
+
+    def sha
+      ref = repo.head
+      ref.target
+    end
+  end
+end

data/lib/mina_revisioneer/version.rb

@@ -0,0 +1,3 @@
+module MinaRevisioneer
+  VERSION = "0.1.0"
+end

data/mina_revisioneer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina_revisioneer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mina-revisioneer"
+  spec.version       = MinaRevisioneer::VERSION
+  spec.authors       = ["Raphael Randschau"]
+  spec.email         = ["nicolai86@me.com"]
+  spec.description   = %q{push deployment informations to revisioneer}
+  spec.summary       = %q{push deployment informations to revisioneer}
+  spec.homepage      = "http://blog.nicolai86.eu"
+  spec.license       = "MIT"
+
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "rugged", "~> 0.19"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: mina-revisioneer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raphael Randschau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: push deployment informations to revisioneer
+email:
+- nicolai86@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mina-revisioneer.rb
+- lib/mina_revisioneer.rb
+- lib/mina_revisioneer/change_log.rb
+- lib/mina_revisioneer/grouped_change_log.rb
+- lib/mina_revisioneer/message_extractor.rb
+- lib/mina_revisioneer/version.rb
+- mina_revisioneer.gemspec
+homepage: http://blog.nicolai86.eu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: push deployment informations to revisioneer
+test_files: []