git_agent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 768908461e4a78cb35911f5ffc66922cd9191877
+  data.tar.gz: fb58ff6e9514210651bc61eb66a1ab15cf6cb4ab
+SHA512:
+  metadata.gz: c8e692289f753553e6854f9b5dcc23b44c0814a6b0aeaf2290bf63932ce1cc00b050e8325f7e3c35ec94f0f7c45aba6c72cdc9423458862f9880c8d827b63a06
+  data.tar.gz: 979066cbccdcd01f190e5633aeff6defb6bd699cde9b1d39ae6db8830c2b2a7b87f5cac7d0b5f05398d7b8d62604d85376770d66716d03f9978c4f806735f567

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+data/
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+test/data
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sophy Eung
+
+MIT License
+
+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,29 @@
+# GitAgent
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'git_agent'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git_agent
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.pattern = './test/lib/**/*_test.rb'
+end
+task default: :test

data/bin/check_repo

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'optparse'
+require 'ostruct'
+require 'git_agent'
+
+options = OpenStruct.new
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: monitor_git_repo [options]'
+
+  opts.on('-t', '--repository REPO', 'Repository to monitor') do |repo|
+    options.repo = repo
+  end
+
+  opts.on('-s', '--sender-email SENDER_EMAIL', 'Sender email address') do |sender_email|
+    options.sender_email = sender_email
+  end
+
+  opts.on('-p', '--sender-password SENDER_PASSWORD', 'Sender password') do |sender_password|
+    options.sender_password = sender_password
+  end
+
+  opts.on('-r', '--recipient-email RECIPIENT_EMAIL', 'Recipient email address') do |recipient_email|
+    options.recipient_email = recipient_email
+  end
+
+  opts.on('-h', '--homepage [HOMEPAGE]', 'Project home page') do |homepage|
+    options.homepage = homepage
+  end
+end.parse!
+
+GitAgent.data_directory = File.expand_path('../../data', __FILE__)
+GitAgent::Notification.config = {
+  sender_username: options.sender_email,
+  sender_password: options.sender_password,
+  recipient_username: options.recipient_email
+}
+
+GitAgent.new(git: options.repo, homepage: options.homepage).notify_if_different!

data/git_agent.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git_agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_agent"
+  spec.version       = GitAgent::VERSION
+  spec.authors       = ["Sophy Eung"]
+  spec.email         = ["ungsophy@gmail.com"]
+  spec.description   = "A command line utility to check git repositories"
+  spec.summary       = "A command line utility to check git repositories"
+  spec.homepage      = "https://github.com/ungsophy/git_agent"
+  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_dependency "mail", "~> 2.5.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.2.0"
+  spec.add_development_dependency "mocha", "~> 1.0.0"
+end

data/lib/git_agent/notification.rb

@@ -0,0 +1,73 @@
+require 'mail'
+
+class GitAgent
+  class Notification
+
+    class << self
+      attr_accessor :config
+
+      def config=(config)
+        @config = config
+
+        Mail.defaults do
+          delivery_method :smtp,
+            address: 'smtp.gmail.com',
+            port: 587,
+            authentication: 'plain',
+            user_name: config[:sender_username],
+            password: config[:sender_password]
+        end
+      end
+    end
+
+    attr_reader :diff, :title, :homepage
+
+    def initialize(title, homepage = nil, diff = {})
+      assert_config!
+
+      @title    = title
+      @diff     = diff
+      @homepage = homepage
+    end
+
+    def send!
+      mail = Mail.new
+      mail.from         = config[:sender_username]
+      mail.to           = config[:recipient_username]
+      mail.subject      = title
+      mail.body         = construct_body
+      mail.content_type = 'text/html; charset=UTF-8'
+
+      mail.deliver!
+    end
+
+    private
+
+      def construct_body
+        str = ''
+
+        diff.each do |key, values|
+          next if values.empty?
+
+          str += "<strong>#{key.capitalize}</strong><br/><ul>"
+          values.each { |value| str += "<li>#{value}</li>" }
+          str += "</ul><br/>"
+        end
+
+        str = "<a href='#{homepage}'>#{homepage}</a><br/>#{str}" if homepage
+        str
+      end
+
+      def assert_config!
+        return if Mail.delivery_method.instance_of?(Mail::TestMailer)
+
+        if !config.key?(:sender_username) || !config.key?(:sender_password) || !config.key?(:recipient_username)
+          raise ArgumentError, ':sender_username, :sender_password and :recipient_username must be defined.'
+        end
+      end
+
+      def config
+        self.class.config
+      end
+  end
+end

data/lib/git_agent/version.rb

@@ -0,0 +1,3 @@
+class GitAgent
+  VERSION = '0.0.1'
+end

data/lib/git_agent.rb

@@ -0,0 +1,100 @@
+require 'yaml'
+require 'fileutils'
+
+require 'git_agent/version'
+require 'git_agent/notification'
+
+class GitAgent
+  class << self
+    attr_accessor :data_directory
+  end
+
+  attr_reader :url, :username, :project, :homepage
+
+  URLS = {
+    github: 'github.com',
+    bitbucket: 'bitbucket.org'
+  }
+
+  def initialize(args = {})
+    @homepage = args[:homepage]
+    @url, @username, @project = resolve_arguments(args)
+  end
+
+  def diff
+    old_hash, new_hash = read_from_record, ls_remote
+    old_keys, new_keys = old_hash.keys, new_hash.keys
+
+    same_keys = new_keys & old_keys
+    result = {
+      added: new_keys - same_keys,
+      deleted: old_keys - same_keys,
+      updated: []
+    }
+
+    same_keys.inject(result[:updated]) do |memo, key|
+      memo << key if old_hash[key] != new_hash[key]
+      memo
+    end
+
+    record(new_hash)
+
+    result
+  end
+
+  def notify_if_different!
+    result = diff
+
+    unless result.values.flatten.empty?
+      notification = GitAgent::Notification.new(project, homepage, result)
+      notification.send!
+    end
+  end
+
+  private
+
+    def ls_remote
+      result = execute_git_ls_remote.split("\n")
+      result.inject({}) do |memo, line|
+        arr = line.split("\t")
+        memo[arr.last] = arr.first
+        memo
+      end
+    end
+
+    def read_from_record
+      return {} unless Dir.exist?(path)
+      File.open(File.join(path, project)) { |file| YAML.load(file.read) }
+    end
+
+    def record(hash)
+      FileUtils.mkdir_p(path) unless Dir.exist?(path)
+      File.open(File.join(path, project), 'w') { |file| file.write(YAML.dump(hash)) }
+    end
+
+    def path
+      @path ||= File.join(GitAgent.data_directory, username)
+    end
+
+    def execute_git_ls_remote
+      `git ls-remote #{url}`
+    end
+
+    def resolve_arguments(urls)
+      if urls.key?(:git)
+        username_and_project = urls[:git].split(':').last.split('/')
+        return [urls[:git], username_and_project.first, username_and_project.last]
+      end
+
+      urls = urls.first
+      raise ArgumentError, 'Need at least :git, :github or :bitbucket' unless URLS.key?(urls.first)
+
+      username_and_project = urls.last.split("/")
+
+      [
+        "git@#{URLS[urls.first]}:#{urls.last}.git",
+        username_and_project.first,
+        "#{username_and_project.last}.git"
+      ]
+    end
+end

data/test/lib/git_agent/notification_test.rb

@@ -0,0 +1,33 @@
+require './test/test_helper'
+
+describe GitAgent::Notification do
+  describe '#initialize' do
+    it 'raises ArgumentError when :sender_username, :sender_password, or :recipient_username is not present' do
+      GitAgent::Notification.config = { sender_username: '',  sender_password: '' }
+      -> { GitAgent::Notification.new('sample_project', {}) }.must_raise ArgumentError
+
+      GitAgent::Notification.config = { sender_password: '', recipient_username: '' }
+      -> { GitAgent::Notification.new('sample_project', {}) }.must_raise ArgumentError
+
+      GitAgent::Notification.config = { recipient_username: '', sender_username: '' }
+      -> { GitAgent::Notification.new('sample_project', {}) }.must_raise ArgumentError
+    end
+  end
+
+  describe '#send!' do
+    before do
+      Mail::TestMailer.deliveries.clear
+      GitAgent::Notification.config = { sender_username: 'foo@gmail.com',
+                                        sender_password: '123',
+                                        recipient_username: 'bar@gmail.com' }
+      Mail.defaults { delivery_method :test }
+    end
+
+    it 'sends an email to recipient' do
+      notification = GitAgent::Notification.new('sample_project', { updated: ['refs/heads/master', 'HEAD'] })
+      notification.send!
+
+      Mail::TestMailer.deliveries.length.must_equal 1
+    end
+  end
+end

data/test/lib/git_agent_test.rb

@@ -0,0 +1,93 @@
+require './test/test_helper'
+
+describe GitAgent do
+  let(:path) { 'ungsophy/git_agent' }
+  let(:ssh_url) { "git@github.com:#{path}.git" }
+  let(:agent) { GitAgent.new(github: path) }
+
+  describe '#initialize' do
+    describe 'when :git is provided' do
+      it 'returns :git' do
+        agent = GitAgent.new(git: ssh_url)
+
+        agent.url.must_equal ssh_url
+        agent.username.must_equal 'ungsophy'
+        agent.project.must_equal 'git_agent.git'
+      end
+    end
+
+    describe 'when :github is provided' do
+      it 'returns github ssh url' do
+        agent.url.must_equal ssh_url
+        agent.username.must_equal 'ungsophy'
+        agent.project.must_equal 'git_agent.git'
+      end
+    end
+
+    describe 'when :bitbucket is provided' do
+      it 'returns bitbucket ssh url' do
+        agent = GitAgent.new(bitbucket: path)
+
+        agent.url.must_equal "git@bitbucket.org:#{path}.git"
+        agent.username.must_equal 'ungsophy'
+        agent.project.must_equal 'git_agent.git'
+      end
+    end
+
+    describe 'when invalid key is provided' do
+      it 'raises ArgumentError exception' do
+        -> { GitAgent.new(foo: '') }.must_raise ArgumentError
+      end
+    end
+  end
+
+  describe '#diff' do
+    it 'returns only different heads and new tags' do
+      agent.stubs(:read_from_record).returns({ 'HEAD' => '356a192b7913b04c54574d18c28d46e6395428ab',
+                                               'refs/heads/master' => '356a192b7913b04c54574d18c28d46e6395428ab',
+                                               'refs/heads/feature-1' => 'a87fc2afc9a9e219e2db4a16c28c3d3ef1b27b18',
+                                               'refs/heads/feature-2' => '446ad0db9b22a1e3c0a42b6d8ab5bbd50a311f50' })
+
+      agent.stubs(:ls_remote).returns({ 'HEAD' => '17ba0791499db908433b80f37c5fbc89b870084b',
+                                        'refs/heads/master' => '17ba0791499db908433b80f37c5fbc89b870084b',
+                                        'refs/heads/feature-1' => '1c6637a8f2e1f75e06ff9984894d6bd16a3a36a9',
+                                        'refs/heads/feature-3' => '755d3a4e0fec40669f760d6f47eac21ad92f846a' })
+
+      result = agent.diff
+
+      result[:added].must_equal ['refs/heads/feature-3']
+      result[:deleted].must_equal ['refs/heads/feature-2']
+      result[:updated].must_equal ['HEAD', 'refs/heads/master', 'refs/heads/feature-1']
+      File.exist?(File.join(GitAgent.data_directory, 'ungsophy', 'git_agent.git')).must_equal true
+    end
+
+    describe 'when nothing was changed' do
+      it 'returns empty hash' do
+        agent.stubs(:read_from_record).returns({ 'HEAD' => '356a192b7913b04c54574d18c28d46e6395428ab',
+                                                 'refs/heads/master' => '356a192b7913b04c54574d18c28d46e6395428ab' })
+
+        agent.stubs(:ls_remote).returns({ 'HEAD' => '356a192b7913b04c54574d18c28d46e6395428ab',
+                                          'refs/heads/master' => '356a192b7913b04c54574d18c28d46e6395428ab' })
+
+        result = agent.diff
+
+        result[:added].must_be_empty
+        result[:deleted].must_be_empty
+        result[:updated].must_be_empty
+      end
+    end
+  end
+
+  describe '#notify_if_different!' do
+    it 'sends notify when there is any difference' do
+      agent.stubs(:read_from_record).returns({ 'HEAD' => '356a192b7913b04c54574d18c28d46e6395428ab',
+                                               'refs/heads/master' => '356a192b7913b04c54574d18c28d46e6395428ab' })
+
+      agent.stubs(:ls_remote).returns({ 'HEAD' => '356a192b7913b04c54574d18c28d46e6395428ac',
+                                        'refs/heads/master' => '356a192b7913b04c54574d18c28d46e6395428ac' })
+      GitAgent::Notification.any_instance.expects(:send!)
+
+      agent.notify_if_different!
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+gem 'minitest'
+require 'minitest/autorun'
+gem 'mocha'
+require 'mocha/mini_test'
+require 'fileutils'
+require 'pp'
+
+require 'git_agent'
+
+GitAgent.data_directory = './test/data'
+FileUtils.mkdir(GitAgent.data_directory) unless Dir.exist?(GitAgent.data_directory)
+
+Mail.defaults do
+  delivery_method :test
+end
+
+class Minitest::Spec
+  def teardown
+    FileUtils.rm_r(Dir.glob(File.join(GitAgent.data_directory, '**')))
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: git_agent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sophy Eung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A command line utility to check git repositories
+email:
+- ungsophy@gmail.com
+executables:
+- check_repo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check_repo
+- git_agent.gemspec
+- lib/git_agent.rb
+- lib/git_agent/notification.rb
+- lib/git_agent/version.rb
+- test/lib/git_agent/notification_test.rb
+- test/lib/git_agent_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ungsophy/git_agent
+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.0.6
+signing_key: 
+specification_version: 4
+summary: A command line utility to check git repositories
+test_files:
+- test/lib/git_agent/notification_test.rb
+- test/lib/git_agent_test.rb
+- test/test_helper.rb