gem_version_check 0.0.8

data/.gitignore

@@ -0,0 +1,3 @@
+.rvmrc
+Gemfile.lock
+pkg

data/Gemfile

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

data/README.md

@@ -0,0 +1,38 @@
+# Gem Version Checker
+
+Check gem dependencies of ruby apps and generate report.
+
+At XING we use this gem in combination with jenkins to automatically check on gem versions across our many projects.
+
+## Installation
+
+    gem install gem_version_check
+
+## Usage
+
+Use the Github project name:
+
+    gem_version_check fdietz/team_dashboard activesupport rspec
+
+Use any url to a Gemfile.lock:
+
+    gem_version_check https://raw.github.com/fdietz/team_dashboard/raw/master/Gemfile.lock activesupport rspec
+
+## Configuration
+
+Use GITHUB_HOST environment variable if you use Enterprise Github:
+
+    GITHUB_HOST=github.mycompany.com gem_version_check fdietz/team_dashboard activesupport rspec
+
+## Example Report
+
+### Pretty Print
+
+Example command: gem_version_check fdietz/team_dashboard activesupport rspec
+
+Output:
+
+    Project: fdietz/team_dashboard
+     * activesupport:  != 3.2.8
+     * rspec:  != 2.11.0
+

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new 
+task :default  => :spec

data/bin/gem_version_check

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require "rubygems"
+require "gem_version_check"
+
+GemVersionCheck.configuration = {
+  :github_host => ENV["GITHUB_HOST"]
+}
+
+GemVersionCheck::Cli.run(ARGV)

data/gem_version_check.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gem_version_check/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gem_version_check"
+  s.version     = GemVersionCheck::VERSION
+  s.authors     = ["Frederik Dietz"]
+  s.email       = ["fdietz@github.com"]
+  s.homepage    = ""
+  s.summary     = "Check your gem dependencies"
+  s.description = "Check for a given github project if gem dependencies are up to date"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'mocha'
+  s.add_runtime_dependency "bundler"
+end

data/lib/gem_version_check.rb

@@ -0,0 +1,24 @@
+require "bundler"
+
+require "gem_version_check/cli"
+require "gem_version_check/version"
+require "gem_version_check/project"
+require "gem_version_check/dependency"
+require "gem_version_check/checks"
+require "gem_version_check/configuration"
+require "gem_version_check/formatter/json"
+require "gem_version_check/formatter/pretty_print"
+
+module GemVersionCheck
+  extend self
+
+  class GemfileLockNotFoundError < StandardError; end
+  
+  def configuration
+    @@configuration ||= Configuration.new
+  end
+
+  def configuration=(settings)
+    @@configuration = Configuration.new(settings)
+  end
+end

data/lib/gem_version_check/checks.rb

@@ -0,0 +1,42 @@
+# Enumerable for gem name => version hash
+module GemVersionCheck
+  class Checks
+    include Enumerable
+
+    def initialize(gem_names = nil)
+      @gem_names = gem_names || configured_checks
+    end
+
+    def each(&block)
+      members.each(&block)
+    end
+
+    def members
+      @members ||= begin
+        puts "Fetching gemspecs for all listed gems..."
+        checks = {}
+        @gem_names.each do |gem_name|
+          spec = Gem.latest_spec_for(gem_name)
+          if spec
+            puts " * #{gem_name}: #{spec.version.to_s}"
+            checks[gem_name] = spec.version.to_s
+          else
+            puts " * #{gem_name}: not found (Maybe a typo?)"
+          end
+        end
+        checks
+      end
+    end
+
+    private
+
+    def configured_checks
+      ActiveSupport::JSON.decode(IO.read(checks_file))
+    end
+
+    def checks_file
+      File.expand_path("../../../checks.json", __FILE__)
+    end
+
+  end
+end

data/lib/gem_version_check/cli.rb

@@ -0,0 +1,25 @@
+module GemVersionCheck
+  module Cli
+    extend self
+
+    def run(params)
+      result = nil
+      if (params.size >= 2)
+        generate_report(params)
+      else 
+        puts "Missing params: gem_version_check my-gh-name/my-project gem1 gem2 gem3"
+        exit(1)
+      end
+    end
+
+    def generate_report(params)
+      result = GemVersionCheck::Project.generate_report(params.shift, params)
+      puts GemVersionCheck::Formatter::PrettyPrint.new(result).format
+      result.check_failed? ? exit(1) : exit(0)
+    rescue GemVersionCheck::GemfileLockNotFoundError => e
+      puts "Can't find Gemfile.lock for #{e}"
+      exit(1)
+    end
+
+  end
+end

data/lib/gem_version_check/configuration.rb

@@ -0,0 +1,9 @@
+module GemVersionCheck
+  class Configuration
+    attr_reader :github_host
+
+    def initialize(settings = {})
+      @github_host = settings[:github_host] || "github.com"
+    end
+  end
+end

data/lib/gem_version_check/dependency.rb

@@ -0,0 +1,38 @@
+module GemVersionCheck
+  class Dependency
+
+    attr_reader :name, :expected_version, :version
+
+    def initialize(name, expected_version)
+      @name = name
+      @expected_version = expected_version
+    end
+
+    def check(lock_file)
+      @version = spec_version(@name, lock_file)
+      @used = !!@version
+      return unless used?
+      
+      @result = @expected_version == @version
+    end
+
+    def valid?
+      !!@result
+    end
+
+    def used?
+      @used
+    end
+
+    private
+
+    def spec_version(name, lock_file)
+      spec = find_spec(name, lock_file)
+      spec ? spec.version.to_s : nil
+    end
+
+    def find_spec(name, lock_file)
+      lock_file.specs.find { |spec| spec.name == name }
+    end
+  end
+end

data/lib/gem_version_check/formatter/json.rb

@@ -0,0 +1,41 @@
+module GemVersionCheck
+  module Formatter
+    class JSON
+      def initialize(report_result)
+        @report_result = Array(report_result)
+      end
+
+      def format
+        result = []
+        Array(@report_result).each do |project|
+          project_hash = project_hash(project)
+          project.report.each do |dependency|
+            project_hash[:dependencies] << dependency_hash(dependency)
+          end
+          result << project_hash
+        end
+        result.to_json
+      end
+
+      private
+
+      def project_hash(project)
+        project_hash = {
+          :name => project.name,
+          :check_failed => project.check_failed?,
+          :dependencies => []
+        }
+      end
+
+      def dependency_hash(dependency)
+        dep_hash = {
+          :name => dependency.name,
+          :expected_version => dependency.expected_version,
+          :version => dependency.version,
+          :used => dependency.used?,
+          :valid => dependency.valid?
+        }
+      end
+    end
+  end
+end

data/lib/gem_version_check/formatter/pretty_print.rb

@@ -0,0 +1,45 @@
+# -*- coding: UTF-8 -*-
+module GemVersionCheck
+  module Formatter
+    class PrettyPrint
+      def initialize(report_result)
+        @report_result = Array(report_result)
+      end
+
+      def format
+        result = ""
+        @report_result.each do |project|
+          dep = ""
+          project.report.each do |dependency|
+            dep << " * #{dependency.name}: "
+            if dependency.used?
+              if dependency.valid?
+                dep << "#{green}#{dependency.expected_version} ✓"
+              else 
+                dep << "#{dependency.expected_version} != #{red}#{dependency.version}"
+              end
+              dep << black + "\n"
+            else
+              dep << "not used\n"
+            end
+          end
+          result << "Project: #{project.check_failed? ? red : green}#{project.name}#{black}" + "\n" + dep
+        end
+        result
+      end
+
+      def black
+        "\033[30m"
+      end
+
+      def green
+        "\033[32m"
+      end
+
+      def red
+        "\033[31m"
+      end
+
+    end
+  end
+end

data/lib/gem_version_check/project.rb

@@ -0,0 +1,85 @@
+require "uri"
+require "net/http"
+
+module GemVersionCheck
+  class Project
+    attr_reader :repository, :report
+
+    def self.generate_report(project_name, checks = nil)
+      project = Project.new(project_name, checks || Checks.new())
+      project.report
+      project
+    end
+
+    def initialize(project, checks)
+      @project = project
+      @checks = checks
+    end
+
+    def name
+      @project
+    end
+
+    def report
+      @report ||= generate_report
+    end
+
+    def generate_report
+      @check_failed = false
+      result = []
+      @checks.each do |key, value|
+        dependency = Dependency.new(key, value)
+        dependency.check(lock_file)
+        @check_failed = true unless dependency.valid?
+        result << dependency
+      end
+      result
+    end
+
+    def check_failed?
+      @check_failed
+    end
+
+    def lock_file
+      @lock_file ||= Bundler::LockfileParser.new(download_gemfile_lock(repository))
+    end
+
+    def repository
+      @repository ||= begin
+        if @project =~ /^http(s)?:\/\//
+          @project
+        else
+          gemfile_lock_url
+        end
+      end
+    end
+
+    private
+
+    # github.com redirects github.com/user/project/raw/master/Gemfile.lock to raw.github.com/user/project/master/Gemfile.lock
+    # github enterprise does not redirect
+    # TODO: change if github enterprise redirects too
+    def gemfile_lock_url
+      if GemVersionCheck.configuration.github_host == "github.com"
+        "https://raw.#{GemVersionCheck.configuration.github_host}/#{@project}/master/Gemfile.lock"
+      else
+        "https://#{GemVersionCheck.configuration.github_host}/#{@project}/raw/master/Gemfile.lock"
+      end
+    end
+
+    def download_gemfile_lock(repository)
+      uri = URI.parse(repository)
+      body = request(uri)
+      raise GemfileLockNotFoundError.new(repository) if body.nil?
+      body
+    end
+
+    def request(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = http.request(request)
+      response.code == "200" ? response.body : nil
+    end
+  end
+end

data/lib/gem_version_check/version.rb

@@ -0,0 +1,3 @@
+module GemVersionCheck
+  VERSION = "0.0.8"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module GemVersionCheck
+  describe Configuration do
+    after do
+    end
+    
+    it "returns github.com as default github_host" do
+      GemVersionCheck.configuration.github_host.should == "github.com"
+    end
+
+    it "returns specified value if set" do
+      GemVersionCheck.configuration = { :github_host => "test" }
+      GemVersionCheck.configuration.github_host.should == "test"
+    end
+  end
+end

data/spec/dependency_spec.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module GemVersionCheck
+  describe Dependency do
+
+    context "#check" do
+      let(:lock_file) { Bundler::LockfileParser.new(lock_file_content("Gemfile.lock")) }
+
+      let(:dependency) { Dependency.new("activesupport", "3.2.9") }
+      let(:invalid_dependency) { Dependency.new("activesupport", "3.2.10") }
+      let(:not_found_dependency) { Dependency.new("rails", "3.2.9") }
+
+      context "#valid?" do
+        it "is valid if current version == expected version" do
+          dependency.check(lock_file)
+          dependency.should be_valid
+        end
+
+        it "is invalid if current version != expected version" do
+          invalid_dependency.check(lock_file)
+          invalid_dependency.should_not be_valid
+        end
+      end
+
+      context "#used?" do
+        it "returns true if found in lock file" do
+          dependency.check(lock_file)
+          dependency.should be_used
+        end
+
+        it "return false if not found in lock file" do
+          not_found_dependency.check(lock_file)
+          not_found_dependency.should_not be_used
+        end
+      end
+    end
+
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module GemVersionCheck
+  describe Project do
+    let(:url) { "https://github.com/toadkicker/teststrap/raw/master/Gemfile.lock" }
+    let(:redirect_url) { "https://raw.github.com/toadkicker/teststrap/master/Gemfile.lock" }
+
+    let(:lock_file) { Bundler::LockfileParser.new(lock_file_content("rails_app_example.lock")) }
+    let(:project) {
+      project = Project.new("toadkicker/teststrap", %w(actionpack not_existing))
+      project.stubs(:lock_file).returns(lock_file)
+      project
+    }
+
+    context "#report" do
+      it "returns array of all dependencies" do
+        project.report.size.should == 2
+        project.report.first.name.should == "actionpack"
+        project.report.last.name.should == "not_existing"
+      end
+    end
+
+    context "#check_failed?" do
+      it "returns true if at least one dependency is not up to date or non existing" do
+        project.check_failed? == true
+      end
+    end
+
+    context "#repository" do
+      it "returns a url as is" do
+        project = Project.new(url, [])
+        project.repository.should == url
+      end
+
+      it "returns a resolved url if gh project name given" do
+        project = Project.new("toadkicker/teststrap", [])
+        project.repository.should == redirect_url
+      end
+    end
+
+    context "#lock_file" do
+      it "downloads lock file content and returns lock_file" do
+        project = Project.new(redirect_url, [])
+        project.expects(:request).returns(lock_file_content("Gemfile.lock"))
+        project.lock_file.specs.size.should > 0
+      end
+
+      it "raises GemfileLockNotFoundError if not found" do
+        project1 = Project.new(redirect_url, [])
+        project1.expects(:request).returns(nil)
+        expect { project1.lock_file }.to raise_error(GemfileLockNotFoundError)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require "gem_version_check"
+require "mocha/api"
+
+def lock_file_content(filename)
+  IO.read(File.expand_path("../stubs/#{filename}", __FILE__))
+end
+
+RSpec.configure do |config|
+  config.before do
+    GemVersionCheck.configuration = { :github_host => "github.com" }
+  end
+end

data/spec/stubs/rails_app_example.lock

@@ -0,0 +1,139 @@
+GIT
+  remote: git://github.com/toadkicker/twitter-bootstrap-rails.git
+  revision: 7b4446d4ab1a5d80a1ef732e1f8cc4d87a2309e4
+  specs:
+    twitter-bootstrap-rails (2.1.6)
+      actionpack (>= 3.1)
+      execjs
+      railties (>= 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    coffee-rails (3.2.2)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.2.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.4.0)
+    commonjs (0.2.6)
+    erubis (2.7.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    formtastic (2.2.1)
+      actionpack (>= 3.0)
+    formtastic-bootstrap (2.0.0)
+      formtastic (~> 2.2)
+      formtastic-bootstrap
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    jquery-rails (2.1.3)
+      railties (>= 3.1.0, < 5.0)
+      thor (~> 0.14)
+    json (1.7.5)
+    less (2.2.2)
+      commonjs (~> 0.2.6)
+    less-rails (2.2.6)
+      actionpack (>= 3.1)
+      less (~> 2.2.0)
+    libv8 (3.3.10.4)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.7)
+    pg (0.14.1)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sass (3.2.2)
+    sass-rails (3.2.5)
+      railties (~> 3.2.0)
+      sass (>= 3.1.10)
+      tilt (~> 1.3)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    therubyracer (0.10.2)
+      libv8 (~> 3.3.10)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.34)
+    uglifier (1.3.0)
+      execjs (>= 0.3.0)
+      multi_json (~> 1.0, >= 1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 3.2.1)
+  formtastic
+  formtastic-bootstrap
+  jquery-rails
+  less-rails
+  pg
+  rails (= 3.2.8)
+  sass-rails (~> 3.2.3)
+  therubyracer
+  twitter-bootstrap-rails!
+  uglifier (>= 1.0.3)

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: gem_version_check
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
+platform: ruby
+authors:
+- Frederik Dietz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check for a given github project if gem dependencies are up to date
+email:
+- fdietz@github.com
+executables:
+- gem_version_check
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/gem_version_check
+- gem_version_check.gemspec
+- lib/gem_version_check.rb
+- lib/gem_version_check/checks.rb
+- lib/gem_version_check/cli.rb
+- lib/gem_version_check/configuration.rb
+- lib/gem_version_check/dependency.rb
+- lib/gem_version_check/formatter/json.rb
+- lib/gem_version_check/formatter/pretty_print.rb
+- lib/gem_version_check/project.rb
+- lib/gem_version_check/version.rb
+- spec/configuration_spec.rb
+- spec/dependency_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/stubs/rails_app_example.lock
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2738635845954003320
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2738635845954003320
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Check your gem dependencies
+test_files:
+- spec/configuration_spec.rb
+- spec/dependency_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/stubs/rails_app_example.lock