github-expirer 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Timur Vafin, Timur Batirshin
+
+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,23 @@
+# Github Expirer
+
+A quick hack to produce a list of not used repositories at Github.
+
+## Install
+
+    $ gem install github-expirer
+
+## Usage
+
+    $ github-expirer --username user \
+      --password password \
+      --organization github-org \
+      --private-only true \
+      --expire-date "6 months ago"
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+

data/bin/github-expirer

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'expirer'
+
+Expirer::CLI.start(ARGV)

data/github-expirer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'expirer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'github-expirer'
+  spec.version       = Expirer::VERSION
+  spec.authors       = ['Timur Vafin']
+  spec.email         = ['timur.vafin@flatstack.com']
+  spec.description   = %q{A quick hack to produce a list of not used repositories at Github.}
+  spec.summary       = %q{A quick hack to produce a list of not used repositories at Github.}
+  spec.homepage      = ''
+  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{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'github_api'
+  spec.add_dependency 'chronic'
+  spec.add_dependency 'ansi'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'timecop'
+end

data/lib/expirer.rb

@@ -0,0 +1,15 @@
+require 'expirer/version'
+require 'expirer/config'
+require 'expirer/repository'
+require 'expirer/checker'
+require 'expirer/reporter'
+require 'expirer/list'
+require 'expirer/cli'
+
+module Expirer
+  extend self
+
+  def configuration
+    @configuration ||= Config.new
+  end
+end

data/lib/expirer/checker.rb

@@ -0,0 +1,17 @@
+require 'chronic'
+
+module Expirer
+  class Checker
+    def self.expired?(repository)
+      new(repository).expired?
+    end
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    def expired?
+      @repository.last_updated_at < Expirer.configuration.expire_date
+    end
+  end
+end

data/lib/expirer/cli.rb

@@ -0,0 +1,25 @@
+require 'thor'
+
+module Expirer
+  class CLI < Thor
+    option 'username', required: true
+    option 'password', required: true
+    option 'organization', type: :string
+    option 'private-only', type: :boolean
+    option 'expire-date', type: :string
+    option 'config', type: :string
+
+    desc 'list', 'List expired repositories'
+
+    def list
+      Expirer.configuration.load_from_file!(options[:file])
+      Expirer.configuration.load_from_options!(options.to_hash)
+
+      Expirer::List.with_expired do |repository|
+        puts Expirer::Reporter.report(repository)
+      end
+    end
+
+    default_task :list
+  end
+end

data/lib/expirer/config.rb

@@ -0,0 +1,61 @@
+require 'yaml'
+require 'active_support/core_ext/hash/keys'
+require 'expirer/core_ext/string/underscore_keys'
+
+module Expirer
+  class Config
+    DEFAULTS = {
+      private_only: true,
+      expire_date: '1 year ago'
+    }.freeze
+
+    OPTIONS = [:username, :password, :organization, :private_only, :expire_date]
+    attr_accessor *OPTIONS
+
+    def initialize
+      reset!
+    end
+
+    def load_from_file!(file)
+      set_options(config_from_file(file)) if file && File.exists?(file)
+    end
+
+    def reset!
+      set_options(DEFAULTS)
+    end
+
+    def load_from_options!(options)
+      set_options(options.underscore_keys.symbolize_keys)
+    end
+
+    def expire_date
+      @parsed_expire_date ||= Chronic.parse(@expire_date).to_datetime
+    end
+
+    def private_only?
+      private_only
+    end
+
+    private
+
+    def config_from_file(file)
+      @config_from_file ||= YAML.load(File.read(file)).symbolize_keys
+    end
+
+    def set_option(key, value)
+      self.send("#{key}=", value)
+    end
+
+    def with_options
+      OPTIONS.each do |key|
+        yield(key)
+      end
+    end
+
+    def set_options(storage)
+      with_options do |key|
+        set_option(key, storage[key]) if storage.include?(key)
+      end
+    end
+  end
+end

data/lib/expirer/core_ext/string/underscore_keys.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/string/inflections'
+
+class Hash
+  def underscore_keys
+    dup.underscore_keys!
+  end
+
+  def underscore_keys!
+    keys.each do |key|
+      self[key.underscore] = delete(key)
+    end
+
+    self
+  end
+end

data/lib/expirer/list.rb

@@ -0,0 +1,57 @@
+require 'active_support/core_ext/module/delegation'
+
+module Expirer
+  class List
+    delegate :private_only?, :username, :password, :organization,
+      to: :configuration
+
+    def self.with_expired(&block)
+      new.with_expired(&block)
+    end
+
+    def with_expired
+      expired(repositories).each do |repository|
+        yield(repository) if include?(repository)
+      end
+    end
+
+    private
+
+    def expired(repositories)
+      repositories.select do |repository|
+        repository.expired?
+      end
+    end
+
+    def include?(repository)
+      return true unless private_only?
+      repository.private?
+    end
+
+    def repositories
+      @repositories ||= wrap(github_repositories)
+    end
+
+    def wrap(repositories)
+      repositories.map { |repository| Repository.new(repository) }
+    end
+
+    def github_repositories
+      @github_repositories ||= github.repos.all(
+        org: organization,
+        per_page: 10_000
+      )
+    end
+
+    def github
+      @github ||= Github.new(
+        login: username,
+        password: password
+      )
+    end
+
+    def configuration
+      Expirer.configuration
+    end
+  end
+end

data/lib/expirer/reporter.rb

@@ -0,0 +1,31 @@
+require 'ansi/code'
+
+module Expirer
+  class Reporter
+    def self.report(repository)
+      new(repository).report
+    end
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    def report
+      "#{datetime}: #{url}"
+    end
+
+    private
+
+    def datetime
+      @repository.last_updated_at.strftime('%Y %b %e %a %T')
+    end
+
+    def url
+      if @repository.private?
+        ANSI.red { @repository.url }
+      else
+        ANSI.blue { @repository.url }
+      end
+    end
+  end
+end

data/lib/expirer/repository.rb

@@ -0,0 +1,31 @@
+require 'github_api'
+
+module Expirer
+  class Repository
+    def initialize(github_repository)
+      @github_repository = github_repository
+    end
+
+    def private?
+      @github_repository.private
+    end
+
+    def last_updated_at
+      DateTime.parse(last_updated_at_value)
+    end
+
+    def url
+      @github_repository.html_url
+    end
+
+    def expired?
+      Checker.expired?(self)
+    end
+
+    private
+
+    def last_updated_at_value
+      @github_repository.pushed_at || @github_repository.updated_at
+    end
+  end
+end

data/lib/expirer/version.rb

@@ -0,0 +1,3 @@
+module Expirer
+  VERSION = '0.0.1'
+end

data/spec/expirer/checker_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Expirer::Checker do
+  describe '.expired?' do
+    before do
+      Expirer.configuration.expire_date = '6 month ago'
+    end
+
+    subject { Expirer::Checker.expired?(repository) }
+
+    context 'with expired repo' do
+      let(:repository) do
+        double(Expirer::Repository,
+          last_updated_at: Chronic.parse('10 months ago').to_datetime)
+      end
+
+      it { should be true }
+    end
+
+    context 'with fresh repo' do
+      let(:repository) do
+        double(Expirer::Repository,
+          last_updated_at: Chronic.parse('1 month ago').to_datetime)
+      end
+
+      it { should be false }
+    end
+  end
+end

data/spec/expirer/config_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Expirer::Config do
+  subject(:config) { Expirer::Config.new }
+
+  context 'without configuration file' do
+    let(:file) { nil }
+
+    it 'set default values' do
+      expect(config.private_only?).to eq(true)
+      expect(config.expire_date).to eq(DateTime.parse('2012-01-01 00:00:00'))
+    end
+  end
+
+  context 'with configuration file' do
+    before do
+      config.load_from_file!('spec/fixtures/config.yml')
+    end
+
+    it 'set values from file' do
+      expect(config.username).to eq('user')
+      expect(config.password).to eq('password')
+      expect(config.organization).to eq('fs')
+      expect(config.private_only?).to eq(false)
+      expect(config.expire_date).to eq(DateTime.parse('2012-07-01 00:00:00'))
+    end
+  end
+
+  context 'with command line options' do
+    before do
+      config.load_from_options!({
+        'username' => 'user',
+        'password' => 'password',
+        'organization' => 'fs',
+        'private-only' => false,
+        'expire-date' => '6 months ago'
+      })
+    end
+
+    it 'set values from options' do
+      expect(config.username).to eq('user')
+      expect(config.password).to eq('password')
+      expect(config.organization).to eq('fs')
+      expect(config.private_only?).to eq(false)
+      expect(config.expire_date).to eq(DateTime.parse('2012-07-01 00:00:00'))
+    end
+  end
+end

data/spec/expirer/list_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Expirer::List do
+  let(:private_fresh) { double(Expirer::Repository, expired?: false, private?: true, url: 'private_fresh') }
+  let(:private_expired) { double(Expirer::Repository, expired?: true, private?: true, url: 'private_expired') }
+  let(:public_expired) { double(Expirer::Repository, expired?: true, private?: false, url: 'public_expired') }
+
+  before do
+    Expirer::List.any_instance.should_receive(:repositories) {[
+      private_fresh, private_expired, public_expired
+    ]}
+  end
+
+  context 'when private only is set to true' do
+    before do
+      Expirer.configuration.private_only = true
+    end
+
+    it 'iterates on private only' do
+      private_fresh.should_not_receive(:url)
+      private_expired.should_receive(:url)
+      public_expired.should_not_receive(:url)
+
+      Expirer::List.with_expired do |repository|
+        expect(repository).to be_expired
+        expect(repository).to be_private
+
+        repository.url
+      end
+    end
+  end
+
+  context 'when private only is set to false' do
+    before do
+      Expirer.configuration.private_only = false
+    end
+
+    it 'iterates on all' do
+      private_fresh.should_not_receive(:url)
+      private_expired.should_receive(:url)
+      public_expired.should_receive(:url)
+
+      Expirer::List.with_expired do |repository|
+        expect(repository).to be_expired
+
+        repository.url
+      end
+    end
+  end
+end

data/spec/expirer/reporter_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Expirer::Reporter do
+  let(:repository) do
+    double(Expirer::Repository,
+      pushed_at: double(strftime: 'datetime'),
+      url: 'url'
+    )
+  end
+
+  subject(:report) { Expirer::Reporter.report(repository) }
+
+  context 'when private' do
+    before do
+      repository.stub(:private?) { true }
+    end
+
+    it 'report' do
+      expect(report).to eq("datetime: \e[31murl\e[0m")
+    end
+  end
+
+  context 'when public' do
+    before do
+      repository.stub(:private?) { false }
+    end
+
+    it 'report' do
+      expect(report).to eq("datetime: \e[34murl\e[0m")
+    end
+  end
+end

data/spec/expirer/repository_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Expirer::Repository do
+  let(:repository) do
+    Expirer::Repository.new(double(
+      pushed_at: '2011-01-26T19:06:43Z',
+      html_url: 'http://github.com/fs/test',
+      private: true
+    ))
+  end
+
+  describe '#last_updated_at' do
+    it 'parse pushed_at' do
+      expect(repository.last_updated_at).to be_a_kind_of(DateTime)
+      expect(repository.last_updated_at).to eq(DateTime.parse('2011-01-26T19:06:43Z'))
+    end
+
+    context 'without pushed_at' do
+      let(:repository) do
+        Expirer::Repository.new(double(
+          pushed_at: nil,
+          updated_at: '2011-01-26T19:06:43Z',
+          html_url: 'http://github.com/fs/test',
+          private: true
+        ))
+      end
+
+      it 'parse created_at' do
+        expect(repository.last_updated_at).to be_a_kind_of(DateTime)
+        expect(repository.last_updated_at).to eq(DateTime.parse('2011-01-26T19:06:43Z'))
+      end
+    end
+  end
+
+  it 'url' do
+    expect(repository.url).to eq('http://github.com/fs/test')
+  end
+
+  it 'private?' do
+    expect(repository).to be_private
+  end
+
+  it 'expired?' do
+    Expirer::Checker.should_receive(:expired?).with(repository) { true }
+    expect(repository).to be_expired
+  end
+end
+

data/spec/expirer_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Expirer do
+  describe '.configuration' do
+    subject(:config) { Expirer.configuration }
+
+    it 'instance of Config' do
+      expect(config).to be_an_instance_of(Expirer::Config)
+    end
+
+    it 'have options' do
+      expect(config.private_only).to eq(true)
+    end
+
+    context 'with config file' do
+      before do
+        config.load_from_file!('spec/fixtures/config.yml')
+      end
+
+      it 'load config file' do
+        expect(config.private_only).to eq(false)
+      end
+
+      it 'reset defaults' do
+        expect { config.reset! }.to change { config.private_only }.from(false).to(true)
+      end
+    end
+
+    context 'with command line options' do
+      before do
+        config.load_from_options!({
+          'private-only' => false
+        })
+      end
+
+      it 'load options' do
+        expect(config.private_only).to eq(false)
+      end
+    end
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,5 @@
+username: user
+password: password
+organization: fs
+private_only: false
+expire_date: 6 months ago

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'expirer'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.before(:each) do
+     Timecop.freeze(DateTime.parse('2013-01-01 00:00:00'))
+  end
+
+  config.after(:each) do
+    Expirer.configuration.reset!
+    Timecop.return
+  end
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: github-expirer
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Timur Vafin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: github_api
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: chronic
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: ansi
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: thor
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: timecop
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: A quick hack to produce a list of not used repositories at Github.
+email:
+- timur.vafin@flatstack.com
+executables:
+- github-expirer
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/github-expirer
+- github-expirer.gemspec
+- lib/expirer.rb
+- lib/expirer/checker.rb
+- lib/expirer/cli.rb
+- lib/expirer/config.rb
+- lib/expirer/core_ext/string/underscore_keys.rb
+- lib/expirer/list.rb
+- lib/expirer/reporter.rb
+- lib/expirer/repository.rb
+- lib/expirer/version.rb
+- spec/expirer/checker_spec.rb
+- spec/expirer/config_spec.rb
+- spec/expirer/list_spec.rb
+- spec/expirer/reporter_spec.rb
+- spec/expirer/repository_spec.rb
+- spec/expirer_spec.rb
+- spec/fixtures/config.yml
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -51980655465764419
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -51980655465764419
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A quick hack to produce a list of not used repositories at Github.
+test_files:
+- spec/expirer/checker_spec.rb
+- spec/expirer/config_spec.rb
+- spec/expirer/list_spec.rb
+- spec/expirer/reporter_spec.rb
+- spec/expirer/repository_spec.rb
+- spec/expirer_spec.rb
+- spec/fixtures/config.yml
+- spec/spec_helper.rb