rack-commit-stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa1969bb30585c2b370d5f9ab29a923e50ee917f
+  data.tar.gz: 39f81d487ee9d3305d0d7263d186a1fb0884541d
+SHA512:
+  metadata.gz: 884c460c19c327de728437ad2be96d50f150109834b2db136bfe0c1227a116c92ef76167a8ec35db0bf57cbffd7d3ef1166e6a3577d9091441e0a01efd6caded
+  data.tar.gz: 22c23203b2085846b9de718b0e2b3ff1226a09240b328bfc5cb2e362d21776405dfb8cfdbfd5a1212957873c3ac2e674fa680e26e8d726646d95d020e5c7383c

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Todd Bealmear
+
+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,80 @@
+rack-commit-stats
+===========
+[![Build Status](https://travis-ci.org/todd/rack-commit-stats.svg?branch=master)](https://travis-ci.org/todd/rack-commit-stats)
+[![Coverage Status](https://coveralls.io/repos/todd/rack-commit-stats/badge.png?branch=master)](https://coveralls.io/r/todd/rack-commit-stats?branch=master)
+[![Code Climate](https://codeclimate.com/github/todd/rack-commit-stats/badges/gpa.svg)](https://codeclimate.com/github/todd/rack-commit-stats)
+[![Dependency Status](https://gemnasium.com/todd/rack-commit-stats.svg)](https://gemnasium.com/todd/rack-commit-stats)
+
+rack-commit-stats is a Rack application that will display information about the
+commit at a Git repository's HEAD. It's primary use case is for mounting within
+another Rack-based application to display a quickly accessible digest of commit
+information for that app; this is useful to quickly see what branch and commit
+are deployed to your server environments if you don't have other tooling already
+set up for that purpose.
+
+## Getting Started
+Add the gem to your Gemfile and run `bundle install`:
+```
+gem 'rack-commit-stats'
+```
+An important note: this gem is built on top of
+[Rugged](https://github.com/libgit2/rugged), which requires CMake to be present
+on your system. CMake should be available through your package manager of choice.
+
+## For Rails
+Mount the application on a new endpoint within your `routes.rb` file. You will
+probably want to limit access to this endpoint using some sort of authentication
+constraint you've established, though this is totally optional.
+
+```ruby
+mount RackCommitStats::App => '/deploy',
+  constraints: YouShallNotPassConstraint.new
+```
+
+A Railtie is provided, so no additional configuration is required unless your
+`.git` directory is on a non-standard path. If it is, you can set the path
+in the affected environment configuration files.
+
+```ruby
+# production.rb
+config.rack_commit_stats.repo_path = '../repo'
+```
+
+## For Sinatra
+Simply add a new route with an endpoint of your choice and call the application
+from inside of it.
+
+```ruby
+get '/deploy' do
+  RackCommitStats::App.call env
+end
+```
+
+Additionally, you can configure the Git repository path if you're not using
+the standard `.git` directory or your app isn't being run from the repository
+root.
+
+```ruby
+RackCommitStats.configure do |config|
+  config.repo_path = '../.git'
+end
+```
+
+## Example Output
+```json
+{
+  "branch": "master",
+  "commit": {
+    "revision": "5ec0b96f8304cc9487172375a6f953cc73d3ffd5",
+    "message": "I have a lovely bunch of coconuts.",
+    "author": {
+      "name": "Foo Bar",
+      "email": "foo@bar.com"
+    }
+  }
+}
+```
+
+## License
+
+Copyright 2014 Todd Bealmear. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rack-commit-stats/app.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module RackCommitStats
+  class App
+    def self.call(env)
+      status = 200
+      headers = {"Content-Type" => "application/json"}
+
+      [status, headers, [response]]
+    end
+
+    private
+
+    def self.response
+      commit = Commit.new
+
+      {
+        branch: commit.branch,
+        commit: {
+          revision: commit.revision,
+          message:  commit.message,
+          author:   commit.author
+        }
+      }.to_json
+    end
+  end
+end

data/lib/rack-commit-stats/commit.rb

@@ -0,0 +1,35 @@
+require 'rugged'
+
+module RackCommitStats
+  class Commit
+    def branch
+      head.name.split('/').last
+    end
+
+    def revision
+      head.target_id
+    end
+
+    def message
+      commit.message.gsub /[\r\n]/, ''
+    end
+
+    def author
+      commit.author.reject { |k, _| k == :time }
+    end
+
+    private
+
+    def repo
+      @_repo ||= Rugged::Repository.new(RackCommitStats.config.repo_path)
+    end
+
+    def head
+      repo.head
+    end
+
+    def commit
+      head.target
+    end
+  end
+end

data/lib/rack-commit-stats/railtie.rb

@@ -0,0 +1,12 @@
+module RackCommitStats
+  class Railtie < Rails::Railtie
+    config.rack_commit_stats = ActiveSupport::OrderedOptions.new
+
+    initializer "rack-commit-stats.configure" do |app|
+      RackCommitStats.configure do |config|
+        config.repo_path = app.config.rack_commit_stats.repo_path ||
+          DEFAULT_REPO_PATH
+      end
+    end
+  end
+end

data/lib/rack-commit-stats/version.rb

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

data/lib/rack-commit-stats.rb

@@ -0,0 +1,17 @@
+module RackCommitStats
+  require 'rack-commit-stats/app'
+  require 'rack-commit-stats/commit'
+  require 'rack-commit-stats/railtie' if defined? Rails
+
+  DEFAULT_REPO_PATH = '.git'
+
+  class Configuration < Struct.new(:repo_path); end
+
+  def self.config
+    @@_config ||= Configuration.new(DEFAULT_REPO_PATH)
+  end
+
+  def self.configure
+    yield self.config
+  end
+end

data/rack-commit-stats.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'rack-commit-stats/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'rugged', '~> 0.21.0'
+  spec.add_dependency 'rack',   '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+
+  spec.authors       = ['Todd Bealmear']
+  spec.description   = %q{Rack application that displays current Git commit information.}
+  spec.email         = ['todd@t0dd.io']
+  spec.files         = %w(LICENSE README.md Rakefile rack-commit-stats.gemspec)
+  spec.files        += Dir.glob('lib/**/*.rb')
+  spec.files        += Dir.glob('spec/**/*')
+  spec.homepage      = 'https://github.com/todd/rack-commit-stats'
+  spec.licenses      = ['MIT']
+  spec.name          = 'rack-commit-stats'
+  spec.require_paths = ['lib']
+  spec.summary       = spec.description
+  spec.version       = RackCommitStats::VERSION
+end

data/spec/fixtures/repo/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/spec/fixtures/repo/objects/ce/7a40f280665ce2e7bbc10b81a91632affe15ab

@@ -0,0 +1,2 @@
+x
��A
+1�a�=E.0�t�iADf�=b���(���n��S��3
�z���^�J�Tv�)[΍��ƒbC4��D�A�����pȀ[s�d���}q�e%�s�a��f��AXV�
L�,�

data/spec/fixtures/repo/refs/heads/master

@@ -0,0 +1 @@
+ce7a40f280665ce2e7bbc10b81a91632affe15ab

data/spec/lib/rack-commit-stats/app_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe RackCommitStats::App do
+  describe '.call' do
+    let(:commit_double)     { instance_double("Commit", commit_properties) }
+    let(:commit_properties) {
+      {
+        branch:   'specs',
+        revision: 'gibberish',
+        message:  'hello',
+        author:   {name: 'Foo Bar', email: 'foo@bar.com'}
+      }
+    }
+    subject { described_class.call env_for("http://foobar.com") }
+
+    it 'returns a 200 status' do
+      status, _, _ = subject
+      expect(status).to eq 200
+    end
+
+    it 'returns headers with a JSON content-type' do
+      _, headers, _ = subject
+      expect(headers).to eq({"Content-Type" => "application/json"})
+    end
+
+    it 'renders a JSON object with commit details as the body' do
+      allow(RackCommitStats::Commit).to receive(:new).and_return commit_double
+      _, _, response = subject
+      expect(response.first).to eq(
+        {
+          branch: 'specs',
+          commit: {
+            revision: 'gibberish',
+            message:  'hello',
+            author: {
+              name:  'Foo Bar',
+              email: 'foo@bar.com'
+            }
+          }
+        }.to_json
+      )
+    end
+  end
+
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+end

data/spec/lib/rack-commit-stats/commit_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe RackCommitStats::Commit do
+  before do
+    RackCommitStats.configure do |config|
+      config.repo_path = 'spec/fixtures/repo'
+    end
+  end
+
+  describe '#branch' do
+    it 'returns the branch name at HEAD' do
+      expect(described_class.new.branch).to eq 'master'
+    end
+  end
+
+  describe '#revision' do
+    it 'returns the revision SHA at HEAD' do
+      expect(described_class.new.revision).to eq(
+        "ce7a40f280665ce2e7bbc10b81a91632affe15ab"
+      )
+    end
+  end
+
+  describe '#message' do
+    it 'returns the commit message at HEAD' do
+      expect(described_class.new.message).to eq "bar"
+    end
+  end
+
+  describe '#author' do
+    it 'returns a hash of author information for the commit at HEAD' do
+      expect(described_class.new.author).to eq(
+        {
+          name: 'Foo Bar',
+          email: 'foo@bar.com'
+        }
+      )
+    end
+  end
+end

data/spec/lib/rack-commit-stats_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe RackCommitStats do
+  describe '.configure' do
+    context 'with custom repo path' do
+      it 'sets the custom repo path within the configuration' do
+        described_class.configure { |config| config.repo_path = 'foo' }
+        expect(described_class.config.repo_path).to eq 'foo'
+      end
+    end
+
+    context 'without custom repo path' do
+      it 'sets the default repo path within the configuration' do
+        described_class.configure { |config| }
+        expect(described_class.config.repo_path).to eq '.git'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+else
+  require 'awesome_print'
+  require 'pry-byebug'
+
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'rack'
+require 'rack-commit-stats'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  #Kernel.srand config.seed
+
+  config.after do
+    RackCommitStats.class_variable_set(:@@_config, nil)
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rack-commit-stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Todd Bealmear
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Rack application that displays current Git commit information.
+email:
+- todd@t0dd.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-commit-stats.rb
+- lib/rack-commit-stats/app.rb
+- lib/rack-commit-stats/commit.rb
+- lib/rack-commit-stats/railtie.rb
+- lib/rack-commit-stats/version.rb
+- rack-commit-stats.gemspec
+- spec/fixtures/repo/HEAD
+- spec/fixtures/repo/objects/ce/7a40f280665ce2e7bbc10b81a91632affe15ab
+- spec/fixtures/repo/refs/heads/master
+- spec/lib/rack-commit-stats/app_spec.rb
+- spec/lib/rack-commit-stats/commit_spec.rb
+- spec/lib/rack-commit-stats_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/todd/rack-commit-stats
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rack application that displays current Git commit information.
+test_files: []