capistrano-stats 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16d87df336c5dd06a9926c57b2084fdbf4ec17d4
-  data.tar.gz: d95f030b7907b485a5d90c5f95fc297c408fadf8
+  metadata.gz: 70df68cdce71eefd709dc7330eb7abb04b9d3022
+  data.tar.gz: 039b7a83c79c5c49637c787e73c1be8c04ced66b
 SHA512:
-  metadata.gz: b3a99527966e46e16ee7f4ba5cb5a290ac6824bd50c01ef69dba5ec138e2d5d26d32884849cc2ac9d7a02e839b4389503f3efc459b7c0f0e57223dba4dd1c1a2
-  data.tar.gz: 9dfc3aeea55d8631b1f7111baed83d8312e1eca9845f7a6e4331f1ace92ba38d3fb4faee1c51b814948273faa0718d078b9a4d9fdd8d58b14c3df7c3a4788fc9
+  metadata.gz: 3c215b955620a7f74bb0d6afe240e0faffde1ff7f9e70d273fcef9dfd91a8906ec23e0a4204b715ab28c5b90952f49fdbdc13c7474a4caf01b22b5db5a47edea
+  data.tar.gz: 95ba78d756baca86714a34de24855589157e93fed9fa0f54ccc310ade71e37e4da42ae8975dcd9b99caad99680f86cfeaef7faf0708f7037b0ba00739a70ec8c

data/capistrano-stats.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-stats/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-stats"
+  gem.version       = Capistrano::Stats::VERSION
+  gem.authors       = ["Lee Hambley"]
+  gem.email         = ["lee.hambley@gmail.com"]
+  gem.description   = %q{Collects anonymous usage statistics about Capistrano to aid with platform support and ruby version targeting.}
+  gem.summary       = %q{Official metrics to help the development direction of Capistrano}
+  gem.homepage      = "http://metrics.capistranorb.com/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+
+  gem.licenses      = ['MIT']
+
+  gem.post_install_message = <<-eos
+    Capistrano will ask you the next time you run it if you would like to share
+    anonymous usage statistics with the maintainance team to help guide our
+    development efforts. We emplore you to opt-in, but we understand if your
+    privacy is important to you in this regard.
+  eos
+
+end
+

data/lib/capistrano-stats.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../capistrano-stats/metric-collector', __FILE__)
+require File.expand_path('../capistrano-stats/metric-message', __FILE__)
+require File.expand_path('../capistrano-stats/version', __FILE__)
+
+require 'capistrano/version'
+
+unless Capistrano.const_defined?('VERSION')
+  Capistrano::VERSION = Capistrano::Version
+end
+
+case Capistrano::VERSION.to_s.to_i
+when 2
+  Capistrano::Configuration.instance.load do
+    namespace :metrics do
+      task :collect do
+        Capistrano::MetricCollector.new(Dir.pwd).collect
+      end
+    end
+    on :start, 'metrics:collect'
+  end
+when 3
+  load File.expand_path('../../tasks/metrics.rake', __FILE__)
+else
+  warn "Unsupported Capistrano Version"
+end

data/lib/capistrano-stats/metric-collector.rb

@@ -0,0 +1,104 @@
+require 'socket'
+require 'digest'
+require 'pathname'
+
+module Capistrano
+
+  class MetricCollector
+
+    attr_reader :pwd
+
+    def initialize(pwd)
+      @pwd = Pathname.new(pwd)
+    end
+
+    def enabled?
+      ask_to_enable unless File.exists?(sentry_file)
+      File.read(sentry_file).chomp == "true"
+    end
+
+    def collect
+      socket = UDPSocket.new
+      message.anonymize! unless enabled?
+      socket.send(message.to_s, 0, *destination)
+    rescue SocketError
+      warn "There was a problem tracking statistics, please report to https://github.com/capistrano/stats"
+    end
+
+    private
+
+    def destination
+      target = ENV.fetch('CAPISTRANO_METRICS', 'metrics.capistranorb.com:1200')
+      host, port = target.split(':')
+
+      if port == ""
+        raise StandardError.new("Invalid port: \"%s\"" % port)
+      else
+        port = port.to_i
+      end
+
+      [host, port]
+    end
+
+    def anon_project_hash
+      git_remote = `git config --get-regex 'remote\..*\.url'`.chomp.split(' ').last
+      @anon_project_hash = "not-git"
+      unless git_remote.to_s == ""
+        @anon_project_hash = Digest::MD5.hexdigest(git_remote)[0..7]
+      end
+      @anon_project_hash
+    end
+
+    def ask_to_enable
+      return false unless $stdin.tty?
+      show_prompt
+      result = ask_to_confirm("Do you want to enable statistics? (y/N): ")
+      show_thank_you_note(result)
+      write_setting(result)
+    end
+
+    def show_prompt
+      puts <<-EOF
+        Would you like to enable statistics?  Here is an example message we would
+        send:
+
+        #{message}
+
+      EOF
+    end
+
+    def show_thank_you_note(result)
+      puts(result ? "Thank you, you may wish to add .capistrano/ to your source
+           control database to avoid future prompts" : "Your preferences have
+           been saved.")
+    end
+
+    def message
+      @message ||= MetricMessage.new({
+        :payload       => anon_project_hash,
+        :ruby_version  => RUBY_VERSION,
+        :ruby_platform => RUBY_PLATFORM,
+      })
+      @message
+    end
+
+    def sentry_file
+      @pwd.join('.capistrano', 'metrics')
+    end
+
+    def ask_to_confirm(prompt)
+      $stdout.write(prompt)
+      $stdout.flush
+      $stdin.gets.chomp.downcase[0] == ?y ? true : false
+    end
+
+    def write_setting(value)
+      Dir.mkdir(sentry_file.dirname) rescue nil
+      File.open(sentry_file, "wb") do |f|
+        f.write(value)
+      end
+    end
+
+  end
+
+end

data/lib/capistrano-stats/metric-message.rb

@@ -0,0 +1,49 @@
+require 'time'
+
+module Capistrano
+
+  class MetricMessage
+
+    VERSION = 1
+    SERIALIZE_ATTRIBUTES = [
+      :version,
+      :datetime,
+      :ruby_version,
+      :ruby_platform,
+      :capistrano_version,
+      :payload
+    ]
+
+    def initialize(attributes = {})
+      @attributes = attributes.merge({
+          :version            => VERSION,
+          :datetime           => Time.now.iso8601,
+          :capistrano_version => capistrano_version,
+      })
+    end
+
+    def to_s
+      @attributes.values_at(*SERIALIZE_ATTRIBUTES).join("|")
+    end
+
+    def anonymize!
+      @attributes.each do |attr, value|
+        @attributes[attr] = 'anonymous' unless attr == :version
+      end
+    end
+
+    private
+
+    def capistrano_version
+      if Capistrano.const_defined?('VERSION')
+        Capistrano::VERSION
+      elsif Capistrano.const_defined?('Version')
+        Capistrano::Version
+      else
+        "unknown"
+      end
+    end
+
+  end
+
+end

data/lib/capistrano-stats/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Stats
+    VERSION = "1.0.2"
+  end
+end

data/tasks/metrics.rake

@@ -0,0 +1,7 @@
+namespace :metrics do
+  task :collect do
+    Capistrano::MetricCollector.new(Dir.pwd).collect
+  end
+end
+
+task 'deploy:starting' => 'metrics:collect'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-stats
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Lee Hambley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies: []
 description: Collects anonymous usage statistics about Capistrano to aid with platform
   support and ruby version targeting.
@@ -17,7 +17,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- capistrano-stats.gemspec
+- lib/capistrano-stats.rb
+- lib/capistrano-stats/metric-collector.rb
+- lib/capistrano-stats/metric-message.rb
+- lib/capistrano-stats/version.rb
+- tasks/metrics.rake
 homepage: http://metrics.capistranorb.com/
 licenses:
 - MIT