happy-commander 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fee4b017af8d0d5e29bdd8bf7ac3b28f3d7a26ec
+  data.tar.gz: b97c0c62a98dda3e29ecc17e9b1616eccbeca83e
+SHA512:
+  metadata.gz: b74692e4ba6ba9a8f56a343abdbb4947c536e5050bc0d9d771d34ecff469e76e1915b71d0c97de874d9f6283629342bae543ab11314cbf0c2bc54306b8d1f1b9
+  data.tar.gz: bf430f98495234b75684dcad0ed99ec1d2dcc0ab553e4cd525f3515b7a57dc5323304b0208da2b699621039263f5fe5ead8504ec64c8d8382dcd2fb1343294ad

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'rake'
+  gem 'simplecov'
+  gem 'rubocop'
+  gem 'webmock'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jschmid1
+
+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,45 @@
+# Commander
+Usage: commander [options] ...
+
+    -v, --vacation name,bool         <NAME>,true/false(bool) comma is important
+    
+    -f, --force name                 Set COMM manually <NAME>
+    
+    -s, --status name                Inspect history and status of <NAME>
+    
+    -a, --auto                       Runs with default settings
+    
+    -l, --list                       Lists all available Members.
+    
+    -x, --setup                      Runs setup for your environment.
+    
+    -h, --help                       Display this screen
+    
+    -u, --version                    Print programs version
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'happy-commander'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install happy-commander
+
+## Usage
+
+Start with --setup to set up your environment and configuration
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/commander/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+
+desc 'Run Rubocop'
+task :rubocop do
+  sh 'bundle exec rubocop -c rubocop.yml'
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+
+desc 'Increase version of a gem'
+task :bump do
+  sh 'gem bump --no-commit'
+end

data/bin/commander

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'commander/client'
+require 'commander/version'
+require 'commander/runner'
+client = Commander::Client.new(ARGV.dup)
+client.execute!

data/commander.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commander/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "happy-commander"
+  spec.version       = Commander::VERSION
+  spec.authors       = ["jschmid1"]
+  spec.email         = ["jschmid@suse.de"]
+  spec.summary       = %q{Automatically sets a Commanding officer of the Week.}
+  spec.description   = %q{Easy, fair and trackable labor division in your team.}
+  spec.homepage      = "http://rubygems.org/gems/happy-commander"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'ruby-trello', '=1.1.1'
+  spec.add_runtime_dependency 'json', '=1.7.7'
+  spec.add_runtime_dependency 'colorize', '=0.7.3'
+end

data/lib/commander.rb

@@ -0,0 +1,3 @@
+# Commanding Officer of the week tool
+require 'commander/version'
+require 'yaml'

data/lib/commander/client.rb

@@ -0,0 +1,90 @@
+require 'optparse'
+require 'commander/runner'
+require 'commander/setup'
+module Commander
+  # CLI with options
+  class Client
+
+    attr_accessor :options
+
+    def initialize(argv)
+      @options = {}
+      @argv = argv
+      extract_options
+    end
+
+    def execute!
+      runner = Commander::Runner
+      if @options[:force]
+        puts 'Forcing ..'
+        runner.new(@options).set_commander
+      elsif @options[:status]
+        puts 'Status output ..'
+        runner.new(@options).show_status(@options[:status])
+      elsif @options[:vacation]
+        puts 'Setting specified user as <on vacation>'
+        runner.new(@options).set_vacation_flag(@options[:vacation][0], @options[:vacation][1])
+      elsif @options[:auto]
+        puts 'Running with default settings..'
+        runner.new(@options).set_commander
+      elsif @options[:list]
+        puts 'Display all Members: '
+        runner.new(@options).list_all_members
+      elsif @options[:setup]
+        puts 'Running setup..'
+        Commander::Setup.configure
+      else
+        puts @optparse
+        exit
+      end
+    end
+
+    def extract_options
+      @optparse = OptionParser.new do |opts|
+
+        opts.banner = "Usage: commander [options] ..."
+
+        @options[:vacation] = false
+        opts.on( '-v', '--vacation name,bool', Array, '<NAME>,true/false(bool) comma is important' ) do |opt|
+          @options[:vacation] = opt
+        end
+
+        @options[:force] = false
+        opts.on( '-f', '--force name', 'Set COMM manually <NAME>' ) do |opt|
+          @options[:force] = opt
+        end
+
+        @options[:status] = false
+        opts.on( '-s', '--status name', 'Inspect history and status of <NAME>' ) do |opt|
+          @options[:status] = opt
+        end
+
+        @options[:auto] = false
+        opts.on( '-a', '--auto', 'Runs with default settings' ) do
+          @options[:auto] = true
+        end
+
+        @options[:list] = false
+        opts.on( '-l', '--list', 'Lists all available Members.' ) do |opt|
+          @options[:list] = opt
+        end
+
+        @options[:setup] = false
+        opts.on( '-x' ,'--setup', 'Runs setup for your environment.' ) do |opt|
+          @options[:setup] = opt
+        end
+
+        opts.on( '-h', '--help', 'Display this screen' ) do
+          puts opts
+          exit
+        end
+
+        opts.on( '-u', '--version', 'Print programs version' ) do
+          puts Commander::VERSION
+          exit
+        end
+      end
+      @optparse.parse(@argv)
+    end
+  end
+end

data/lib/commander/exceptions.rb

@@ -0,0 +1,3 @@
+# Custom exceptions.
+class InvalidInputException < Exception
+end

data/lib/commander/helpers.rb

@@ -0,0 +1,11 @@
+module Commander
+
+  class Helpers
+
+    # no .to_bool
+    def self.to_boolean(state)
+      (state == 'true') ? @state = true : @state = false
+    end
+
+  end
+end

data/lib/commander/runner.rb

@@ -0,0 +1,156 @@
+require 'yaml'
+require 'commander/trello'
+require 'commander/vacations'
+require 'commander/helpers'
+require 'trello'
+require 'fileutils'
+module Commander
+
+  FileUtils.mkdir_p("#{File.join(ENV['HOME'])}/.config/happy-commander/") unless Dir.exists?("#{ENV['HOME']}/.config/happy-commander")
+  FileUtils.cp ("#{File.dirname(__FILE__)}/../../config/.trello.yml"), ("#{File.join(Dir.home)}" + '/.config/happy-commander/') unless File.exists?(("#{File.join(Dir.home)}" + '/.config/happy-commander/.trello.yml'))
+  FileUtils.cp ("#{File.dirname(__FILE__)}/../../config/members.yml"), ("#{File.join(Dir.home)}" + '/.config/happy-commander/') unless File.exists?(("#{File.join(Dir.home)}" + '/.config/happy-commander/members.yml'))
+  CONFIG = YAML.load_file("#{File.join(ENV['HOME'])}/.config/happy-commander/.trello.yml")
+
+  class Runner
+
+    attr_accessor :options, :board, :selected_commander, :users
+
+    # Init
+    def initialize(opts = {})
+      @options         = opts
+      @options[:force] = opts[:force]
+      @selected_commander = opts[:force] || opts[:status] || opts[:vacation]
+      @users = YAML.load_file("#{File.join(ENV['HOME'])}/.config/happy-commander/members.yml")
+    end
+
+    # Steps
+    def set_commander
+      import
+      find_card
+      update_vacations
+      select_commander if @options[:auto]
+      write_attributes if @options[:force]
+      manipulate_trello
+      puts "Chose: #{@selected_commander}"
+    end
+
+    # All Trello actions
+    def manipulate_trello
+      comment_on_card
+      delete_assigned_members
+      add_member_to_card
+    end
+
+    # Updates all vacations
+    def update_vacations
+      self.users.keys.each do |name|
+        @vacations = Commander::Vacations.find_vacations(self.users[name][:tel_name]) #tel_name
+        evaluate_vacations(name)
+        @users[name][:vacations] = @vacations
+      end
+      write_to_file('members', @users.to_yaml)
+    end
+
+    # Sets :vacation true if vacation
+    def set_vacation_flag(commander, state)
+      Commander::Helpers.to_boolean(state)
+      puts "#{commander} is on vacation"
+      @users[commander][:vacation] = true
+    end
+
+    # Check for timespans
+    def evaluate_vacations(commander)
+      parse_vacations.each do |check|
+        check[1] = check[0] unless check[1] # Rewrite if statement with catch to prevent this error?
+        if (check[0]..check[1]).cover?(Date.today)
+          set_vacation_flag(commander, 'true')
+        end
+      end
+    end
+
+    # Parsing vacation to computable format
+    def parse_vacations
+      split = @vacations.map { |x| x.split(' - ') }
+      split.map { |x| x.map { |b| Date.parse(b) } }
+    end
+
+    # Sorting logic
+    def select_commander
+      @selected_commander = Hash[@users.select { |_, v| !v[:vacation] }].sort_by{ |_, v| v[:times_commander] }
+      if @selected_commander.count > 1
+        if @selected_commander[0][1][:times_commander] == @selected_commander[1][1][:times_commander]
+          @selected_commander = @selected_commander.sort_by { |_,v| v[:date] }[0][0]
+        else
+          @selected_commander = @selected_commander[0][0]
+        end
+      else
+        @selected_commander = @selected_commander[0][0]
+      end
+      write_attributes
+    end
+
+    # Prints out the status
+    def show_status(commander)
+      puts "#{commander} was #{@users[commander][:times_commander] } times Commanding officer of the week."
+      puts "#{commander} is currently on vacation" if @users[commander][:vacation]
+      @users[commander][:vacations].each { |x| puts x}
+    end
+
+    # And writes
+    def write_attributes
+      users[@selected_commander][:vacation] = false
+      users[@selected_commander][:times_commander] = count_up
+      users[@selected_commander][:date] = Time.now
+      write_to_file('members', @users.to_yaml)
+    end
+
+    # Delete assigned commander from Trello Card
+    def delete_assigned_members
+      @card.members.each{|member| @card.remove_member member}
+    end
+
+    # Adds commander to Trello Card
+    def add_member_to_card
+      @trello.add_commander_to_card(find_member, @card)
+    end
+
+    # List all available Users
+    def list_all_members
+      @users.each { |x| puts "-#{x.first}"}
+    end
+
+    # Finds the Commander Card on Trello
+    def find_card
+      @card = @trello.find_card_by_id(CONFIG['card_id']) # replace when move to real board
+    end
+
+    # Finds the member on Trello
+    def find_member
+      @trello.find_member_by_username(users[@selected_commander][:trello_name])
+    end
+
+    # Increments the counter
+    def count_up
+      users[@selected_commander][:times_commander] += 1
+    end
+
+    # Writes to yaml
+    def write_to_file(filename, content)
+      File.open("#{File.join(Dir.home)}/.config/happy-commander/#{filename}.yml", 'w') do |f|
+        f.write(content)
+      end
+    end
+
+    # Imports TrelloConnection
+    def import
+      @trello = Commander::TrelloConnection.new
+    end
+
+    # Comments on Trello Card
+    def comment_on_card
+      @comment_string = "@#{@users[@selected_commander][:trello_name]} is your commanding officer for the next 7 Days."
+      @trello.comment_on_card(@comment_string, @card)
+    end
+
+  end
+end

data/lib/commander/setup.rb

@@ -0,0 +1,145 @@
+require 'yaml'
+require 'colorize'
+require 'fileutils'
+require_relative 'exceptions'
+module Commander
+
+  class Setup
+
+    attr_accessor :conf
+    @conf = YAML.load_file("#{File.join(ENV['HOME'])}/.config/happy-commander/.trello.yml")
+
+
+    def self.get_user_input
+      $stdin.gets.chomp
+    end
+
+    def self.configure
+      system('clear')
+      puts 'Provide your Trello Board ID'.green
+      puts 'If you don\'t know where to find it visit your board.'
+      puts "https://trello.com/b/" + "YOURBOARDID".green+"/boardname etc.."
+      printf '>>'
+      @conf['board_id'] = get_user_input
+      system('clear')
+
+      puts 'Provide your Trello consumer key.'.green
+      puts 'You can generate this key on.'
+      puts 'Https://trello.com/1/appKey/generate'
+      printf '>>'
+      @conf['consumerkey'] = get_user_input
+      system('clear')
+
+      puts 'Provide your Trello consumer secret.'.green
+      puts 'You can generate this key on.'
+      puts 'Https://trello.com/1/appKey/generate'
+      printf '>>'
+      @conf['consumersecret'] = get_user_input
+      system('clear')
+
+
+      puts 'Finally provide the generated token.'.green
+      puts 'Which you can get here.'
+      puts "https://trello.com/1/authorize?key=#{@conf['consumerkey']}&name=happy-commander&expiration=never&response_type=token&scope=read,write"
+      printf '>>'
+      @conf['oauthtoken'] = get_user_input
+      system('clear')
+
+      puts 'Specify the card id (comments and assignments on this card).'.green
+      puts 'See in card description.'
+      puts 'Or in browser url.'
+      puts "e.g https://trello.com/c/somecard/"+"2075".green+"-commanding-officer-of-the-week"
+      printf '>>'
+      @conf['card_id'] = get_user_input
+      system('clear')
+
+      puts 'Set the interval.'.green
+      puts 'E.g. for every tuesday'
+      puts 'Write: tuesday, or weekdays'
+      puts 'At what time?'
+      puts 'Write: 1pm, 10pm, 2pm, 1am and so on..'
+      puts 'Or: raw cron syntax'
+      puts 'Like: 0 0 27-31 * *'
+      puts ''
+      puts 'What syntax will you provide?'
+      puts '1. Written language'.green
+      puts '2. Raw cron syntax'.green
+      puts '3. None'
+      printf '>>'
+      choose(get_user_input)
+      system('clear')
+      write_to_file('.trello', @conf.to_yaml)
+    end
+
+    def self.choose(choice)
+      case choice.to_i
+        when 1
+          puts 'Chose written language:'
+          puts 'Day'
+          puts 'e.g. Monday, Tuesday, ...'
+          printf '>>'
+          pick_cron_day
+          puts 'Time..'
+          puts 'e.g. 11, 21, 24, 8, 3'
+          printf '>>'
+          @hour = pick_cron_time
+          puts 'Put this in your cron'
+          puts 'Edit it with crontab -e'
+          puts ("#{concat_cron_syntax} "    + " /bin/bash -l -c " + "'"+"#{%x[which commander].chomp || %x[which commander2.0].chomp} -a"+"'").green
+
+        when 2
+          puts 'Chose raw cron syntax'
+          puts 'e.g. 0 0 27-31 * *'
+          printf '>>'
+          raw_syn = get_user_input
+          puts 'Put this in your cron'
+          puts 'Edit it with crontab -e'
+          puts ("#{raw_syn} "    + " /bin/bash -l -c " + "'"+"#{%x[which commander].chomp || %x[which commander2.0].chomp} -a"+"'").green
+        when 3
+          write_to_file('.trello', @conf.to_yaml)
+          exit('Success')
+        else
+          puts 'Nothing happend.'
+      end
+
+    end
+
+    def self.concat_cron_syntax
+      "0 #{@hour} 0 0 #{@cron_day}"
+    end
+
+    def self.pick_cron_time
+      time = get_user_input.to_i
+      unless (1..24).cover?(time)
+        raise InvalidInputException, "Not a valid timeframe: #{time}"
+      end
+      puts "selected: #{time}"
+      @hour = time
+    rescue InvalidInputException => e
+      puts e.message
+      puts "Valid values are: [1, 2, 3...22, 23, 24]"
+      retry
+    end
+
+    def self.pick_cron_day
+      day = get_user_input
+      weekdays = %w(Sunday Monday Tuesday Wednesday Thursday Friday Saturday)
+      unless weekdays.include?(day)
+        raise InvalidInputException, "Not a valid weekday: '#{day}'"
+      end
+      puts "selected: #{day}"
+      @cron_day = weekdays.index(day)
+    rescue InvalidInputException => e
+      puts e.message
+      puts "Valid options are: #{weekdays}"
+      retry
+    end
+
+    def self.write_to_file(filename, content)
+      File.open("#{File.join(Dir.home)}/.config/happy-commander/#{filename}.yml", 'w') do |f|
+        f.write(content)
+      end
+    end
+
+  end
+end