caperoma 0.1.0 → 4.0.1

data/lib/caperoma/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/lib/caperoma/models/branch.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Branch < ActiveRecord::Base
+  belongs_to :project
+  has_many :tasks
+end

data/lib/caperoma/models/project.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Project < ApplicationRecord
+  has_many :branches
+  has_many :chores
+  has_many :bugs
+  has_many :features
+  has_many :meetings
+  has_many :fixes
+
+  def folder_path
+    %(#{self[:folder_path]})
+  end
+end

data/lib/caperoma/models/property.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Property < ApplicationRecord
+  validates :name, :value, presence: true
+end

data/lib/caperoma/models/report.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+class Report < ApplicationRecord
+  include ActionView::Helpers::TextHelper
+  has_many :tasks
+
+  after_initialize :set_variables
+
+  after_create :assign_unreported_tasks
+  after_create :send_email, if: :not_test?
+  after_create :update_content
+
+  def self.schedule
+    # may screw up existing cron tasks
+    puts 'Turning on auto reports'
+    root = File.dirname __dir__
+    crontab_file = File.join root, 'config', 'crontab'
+    `crontab #{crontab_file}`
+    # > whenever --update-crontab caperoma
+    puts 'Auto reports turned on'
+  end
+
+  def self.unschedule
+    puts 'Turning off auto reports'
+    puts 'pending'
+    puts 'Auto reports turned off'
+  end
+
+  private
+
+  def set_variables
+    @smtp = Net::SMTP.new 'smtp.gmail.com', 587
+    @smtp.enable_starttls
+    @account = Account.gmail
+  end
+
+  # most of it is related to email formatting
+
+  def assign_unreported_tasks
+    unreported_tasks.update_all(report_sti_key => id)
+  end
+
+  def send_email
+    @smtp.start('gmail.com', @account.email, @account.password, :login, &send_email_method)
+  end
+
+  def send_email_method
+    proc { @smtp.send_message(report_msg, @account.email, to_addresses) }
+  end
+
+  def unreported_tasks
+    Task.finished.where(report_sti_key => nil)
+  end
+
+  def report_sti_key
+    self.class.to_s.foreign_key
+  end
+
+  def update_content
+    update content: report_msg
+  end
+
+  def reported_tasks
+    tasks.finished.order(finished_at: :desc)
+  end
+
+  def total_time_spent
+    "#{hours_spent}h #{remaining_minutes_spent}m"
+  end
+
+  def hours_spent
+    (total_time_spent_in_minutes / 60).to_i
+  end
+
+  def remaining_minutes_spent
+    (total_time_spent_in_minutes - hours_spent * 60).to_i
+  end
+
+  def total_time_spent_in_minutes
+    reported_tasks.all.collect(&:time_spent_in_minutes).sum
+  end
+
+  def not_test?
+    ENV['CAPEROMA_INTEGRATION_TEST'].blank? && ENV['CAPEROMA_TEST'].blank?
+  end
+
+  def to_addresses
+    ReportRecipient.all.collect(&:email)
+  end
+
+  def report_msg
+    report_msg_content.join("\n")
+  end
+
+  def report_msg_content
+    ["subject: #{report_subject}", 'Content-Type: text/html; charset=UTF-8', report_body]
+  end
+
+  def formatted_day(day)
+    day.strftime('%b %-d')
+  end
+
+  def formatted_start_day
+    formatted_day(start_day)
+  end
+
+  def formatted_end_day
+    formatted_day(end_day)
+  end
+
+  def timeframe
+    [formatted_start_day, formatted_end_day].join(' - ')
+  end
+
+  def report_subject
+    [subject_name, subject_timeframe].join(' ')
+  end
+
+  def subject_timeframe
+    "(#{timeframe})"
+  end
+
+  def report_body
+    [
+      "\n",
+      "<h2>Done during #{timeframe}:</h2>",
+      "<br />",
+      "<table style=\"width: 100%;text-align: left;\">",
+      "<thead>",
+      "<tr><th>Jira</th><th>Pivotal</th><th>Title</th><th>Time spent</th></tr>",
+      "</thead>",
+      "<tbody>",
+      reported_tasks_rows,
+      "</tbody>",
+      "</table>",
+      "<br />",
+      "<strong>Total time spent during #{timeframe}:</strong> #{total_time_spent}."
+    ].flatten.join("\n")
+  end
+
+  def reported_tasks_rows
+    reported_tasks.collect { |task| table_row(task) }.join("\n")
+  end
+
+  def table_row(task)
+    '<tr>' + task_row_data(task).collect{|task| '<td>' + task + '</td>' }.join("\n") + '</tr>'
+  end
+
+  def task_row_data(task)
+    [
+      jira_url_or_blank(task),
+      pivotal_url_or_blank(task),
+      formatted_title(task),
+      task.time_spent
+    ]
+  end
+
+  def formatted_title(task)
+    truncate(task.title, length: 90)
+  end
+
+  def jira_url_or_blank(task)
+    task.jira_key.present? ? jira_formatted_url(task) : ''
+  end
+
+  def jira_formatted_url(task)
+    "<a href=\"#{task.jira_live_url}\">#{task.jira_key}</a>"
+  end
+
+  def pivotal_url_or_blank(task)
+    task.pivotal_id.present? ? pivotal_formatted_url(task) : ''
+  end
+
+  def pivotal_formatted_url(task)
+    "<a href=\"#{task.pivotal_url}\">#{task.pivotal_id}</a>"
+  end
+end

data/lib/caperoma/models/report_recipient.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ReportRecipient < ApplicationRecord
+  validates :email, presence: true, uniqueness: true
+  validates_format_of :email, with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, on: :create # TODO: just email validator dude
+end

data/lib/caperoma/models/reports/daily_report.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class DailyReport < Report
+  has_many :tasks
+
+  private
+
+  def subject_name
+    'Daily Report'
+  end
+
+  def body_heading
+    'Today'
+  end
+
+  def timeframe
+    formatted_day(start_day)
+  end
+
+  def start_day
+    Date.today
+  end
+end

data/lib/caperoma/models/reports/retrospective_report.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class RetrospectiveReport < Report
+  has_many :tasks
+
+  private
+
+  def subject_name
+    'Weekly Report'
+  end
+
+  def start_day
+    Date.today.beginning_of_week
+  end
+
+  def end_day
+    Date.today
+  end
+end

data/lib/caperoma/models/reports/three_day_report.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class ThreeDayReport < Report
+  has_many :tasks
+
+  private
+
+  def subject_name
+    'Three Day Report'
+  end
+
+  def start_day
+    Date.today - 2.days
+  end
+
+  def end_day
+    Date.today
+  end
+end

data/lib/caperoma/models/task.rb

@@ -0,0 +1,368 @@
+# frozen_string_literal: true
+class Task < ActiveRecord::Base
+  include Git
+
+  belongs_to :project
+  belongs_to :daily_report
+  belongs_to :three_day_report
+  belongs_to :retrospective_report
+
+  validates :title, presence: true
+  validates :pivotal_id, length: { minimum: 6 }, allow_blank: true, numericality: { only_integer: true }
+
+  before_create :generate_uuid
+  before_create :set_start_time
+
+  after_create :create_issue_on_jira, if: :create_on_jira?
+  after_create :start_issue_on_jira, if: :start_on_jira?
+  after_create :create_issue_on_pivotal, if: :create_on_pivotal?
+  after_create :start_issue_on_pivotal, if: :start_on_pivotal?
+  after_save :output_jira_key, if: :output_jira_key?
+
+  scope :unfinished, -> { where(finished_at: nil) }
+  scope :finished, -> { where.not(finished_at: nil) }
+
+  def self.finish_started(comment)
+    puts 'Finishing current task'
+    unfinished.each { |task| task.finish(comment) }
+    puts 'Current task finished'
+  end
+
+  def self.pause_started(comment)
+    puts 'Pausing current task'
+    unfinished.each { |task| task.pause(comment) }
+    puts 'Current task paused'
+  end
+
+  def self.abort_started(comment)
+    puts 'Aborting current task'
+    unfinished.each { |task| task.abort(comment) }
+    puts 'Current task aborted'
+  end
+
+  def self.abort_started_without_time(comment)
+    puts 'Aborting current task without putting time into Jira'
+    unfinished.each { |task| task.abort_without_time(comment) }
+    puts 'Current task aborted without putting time into Jira'
+  end
+
+  def self.status
+    if unfinished.length == 0 
+      puts "You are not working on anything now." 
+    else 
+      unfinished.each do |task| 
+        puts "You are working on: "
+        puts "Title: #{task.title}"
+        puts "Type: #{task.type}"
+        puts "Jira ID: #{task.jira_key}." if task.jira_key.present?
+        puts "Pivotal ID: #{task.pivotal_id} (#{task.pivotal_url})" if task.pivotal_id.present?
+        puts "Time spent at the moment: #{task.time_spent_so_far}"
+        puts "Pull request will be sent to this branch: #{task.parent_branch}" if task.parent_branch.present?
+        puts "Project location: #{task.project.folder_path}"
+      end
+    end
+  end
+
+  attr_writer :additional_time
+
+  def finish(comment)
+    # full pull request
+    update_attribute(:finished_at, Time.now)
+    close_issue_on_jira
+    log_work_to_jira(comment)
+    finish_on_pivotal if pivotal_id.present?
+    puts time_spent
+  end
+
+  def pause(comment = 'Done')
+    # finish with commit & push but without pull request
+    update_attribute(:finished_at, Time.now)
+    close_issue_on_jira
+    log_work_to_jira(comment)
+    finish_on_pivotal if pivotal_id.present?
+    puts time_spent
+  end
+
+  def abort(comment)
+    # finish without commit or push
+    update_attribute(:finished_at, Time.now)
+    close_issue_on_jira
+    log_work_to_jira(comment)
+    finish_on_pivotal if pivotal_id.present?
+    puts time_spent
+  end
+
+  def abort_without_time(comment)
+    # finish without commit or push
+    update_attribute(:finished_at, Time.now)
+    close_issue_on_jira
+    # the task closes on Jira, but is still running in Pivotal
+    puts time_spent
+  end
+
+  def time_spent_so_far
+    result = TimeDifference.between(started_at, Time.now).in_minutes
+
+    hours = (result / 60).to_i
+    minutes = (result - hours * 60).to_i
+
+    "#{hours}h #{minutes}m"
+  end
+
+  def time_spent
+    result = TimeDifference.between(started_at, finished_at).in_minutes
+
+    hours = (result / 60).to_i
+    minutes = (result - hours * 60).to_i
+
+    "#{hours}h #{minutes}m"
+  end
+
+  def pivotal_url
+    "https://www.pivotaltracker.com/story/show/#{pivotal_id}" if pivotal_id.present?
+  end
+
+  def jira_live_url
+    "#{project.jira_url}browse/#{jira_key}" if jira_key.present?
+  end
+
+  def time_spent_in_minutes
+    TimeDifference.between(started_at, finished_at).in_minutes # TODO: test
+  end
+
+  private
+
+  def story_type
+    'chore' # default is chore, it's never used directly
+  end
+
+  def create_on_jira?
+    Account.jira.present? && ENV['CAPEROMA_INTEGRATION_TEST'].blank?
+  end
+
+  def start_on_jira?
+    jira_key.present? && Account.jira.present? && ENV['CAPEROMA_INTEGRATION_TEST'].blank?
+  end
+
+  def create_on_pivotal?
+    pivotal_id.blank? && this_is_a_type_a_user_wants_to_create? && Account.pivotal.present? && ENV['CAPEROMA_INTEGRATION_TEST'].blank?
+  end
+
+  def start_on_pivotal?
+    pivotal_id.present? && Account.pivotal.present? && ENV['CAPEROMA_INTEGRATION_TEST'].blank?
+  end
+
+  def this_is_a_type_a_user_wants_to_create?
+    false
+  end
+
+  def generate_uuid
+    self.uuid = SecureRandom.uuid
+  end
+
+  def set_start_time
+    time = Time.now
+    time -= @additional_time.to_i.minutes if @additional_time.present?
+    self.started_at = time
+  end
+
+  def output_jira_key
+    puts jira_key
+  end
+
+  def output_jira_key?
+    jira_key.present? && ENV['CAPEROMA_INTEGRATION_TEST'].blank?
+  end
+
+  def start_issue_on_pivotal_data
+    Jbuilder.encode do |j|
+      j.current_state 'started'
+    end
+  end
+
+  def start_issue_on_pivotal
+    if not_test?
+      conn = Faraday.new(url: 'https://www.pivotaltracker.com/') do |c|
+        c.adapter Faraday.default_adapter
+      end
+
+      response = conn.put do |request|
+        request.url "services/v5/stories/#{pivotal_id}"
+        request.body = start_issue_on_pivotal_data
+        request.headers['User-Agent'] = 'Caperoma'
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['X-TrackerToken'] = Account.pivotal.password
+      end
+    end
+  end
+
+  def finish_on_pivotal_data
+    Jbuilder.encode do |j|
+      j.current_state 'finished'
+    end
+  end
+
+  def finish_on_pivotal
+    if not_test?
+      conn = Faraday.new(url: 'https://www.pivotaltracker.com/') do |c|
+        c.adapter Faraday.default_adapter
+      end
+
+      response = conn.put do |request|
+        request.url "services/v5/stories/#{pivotal_id}"
+        request.body = finish_on_pivotal_data
+        request.headers['User-Agent'] = 'Caperoma'
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['X-TrackerToken'] = Account.pivotal.password
+      end
+    end
+  end
+
+  def start_issue_on_jira_data
+    Jbuilder.encode do |j|
+      j.transition { j.id project.jira_transition_id_in_progress }
+    end
+  end
+
+  def start_issue_on_jira
+    if not_test?
+      conn = Faraday.new(url: project.jira_url) do |c|
+        c.basic_auth(Account.jira.email, Account.jira.password)
+        c.adapter Faraday.default_adapter
+      end
+
+      conn.post do |request|
+        request.url "rest/api/3/issue/#{jira_key}/transitions"
+        request.body = start_issue_on_jira_data
+        request.headers['User-Agent'] = 'Caperoma'
+        request.headers['Content-Type'] = 'application/json'
+      end
+    end
+  end
+
+  def close_issue_on_jira_data
+    Jbuilder.encode do |j|
+      j.transition { j.id project.jira_transition_id_done }
+    end
+  end
+
+  def close_issue_on_jira
+    if not_test?
+      conn = Faraday.new(url: project.jira_url) do |c|
+        c.basic_auth(Account.jira.email, Account.jira.password)
+        c.adapter Faraday.default_adapter
+      end
+
+      response = conn.post do |request|
+        request.url "rest/api/3/issue/#{jira_key}/transitions"
+        request.body = close_issue_on_jira_data
+        request.headers['User-Agent'] = 'Caperoma'
+        request.headers['Content-Type'] = 'application/json'
+      end
+    end
+  end
+
+  def log_work_to_jira_data(comment = 'Done')
+    Jbuilder.encode do |j|
+      j.comment comment
+      j.started current_time
+      j.timeSpent time_spent
+    end
+  end
+
+  def log_work_to_jira(comment = 'Done')
+    if not_test?
+      conn = Faraday.new(url: project.jira_url) do |c|
+        c.basic_auth(Account.jira.email, Account.jira.password)
+        c.adapter Faraday.default_adapter
+      end
+
+      result = conn.post do |request|
+        request.url "rest/api/3/issue/#{jira_key}/worklog"
+        request.body = log_work_to_jira_data(comment)
+        request.headers['User-Agent'] = 'Caperoma'
+        request.headers['Content-Type'] = 'application/json'
+      end
+    end
+  end
+
+  def current_time
+    Time.now.in_time_zone('UTC').strftime('%Y-%m-%dT%H:%M:00.000+0000')
+  end
+
+  def issue_type
+    project.feature_jira_task_id
+  end
+
+  def create_issue_on_pivotal_data
+    Jbuilder.encode do |j|
+      j.current_state 'unstarted'
+      j.estimate 1
+      j.name title.to_s
+      j.story_type story_type
+    end
+  end
+
+  def create_issue_on_pivotal
+    if not_test?
+      conn = Faraday.new(url: 'https://www.pivotaltracker.com/') do |c|
+        c.adapter Faraday.default_adapter
+      end
+
+      response = conn.post do |request|
+        request.url "services/v5/projects/#{project.pivotal_tracker_project_id}/stories"
+        request.body = create_issue_on_pivotal_data
+        request.headers['User-Agent'] = 'Caperoma'
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['X-TrackerToken'] = Account.pivotal.password
+      end
+
+      result = JSON.parse response.body
+
+      update_attributes(
+        pivotal_id: result['id']
+      )
+    end
+  end
+
+  def create_issue_on_jira_data
+    Jbuilder.encode do |j|
+      j.fields do
+        j.project     { j.id project.jira_project_id.to_s }
+        j.issuetype   { j.id issue_type }
+        j.summary     title.to_s
+        j.assignee do
+          j.name Account.jira.username
+        end
+      end
+    end
+  end
+
+  def create_issue_on_jira
+    if not_test?
+      conn = Faraday.new(url: project.jira_url) do |c|
+        c.basic_auth(Account.jira.email, Account.jira.password)
+        c.adapter Faraday.default_adapter
+      end
+
+      response = conn.post do |request|
+        request.url 'rest/api/3/issue.json'
+        request.body = create_issue_on_jira_data
+        request.headers['User-Agent'] = 'Caperoma'
+        request.headers['Content-Type'] = 'application/json'
+      end
+
+      result = JSON.parse response.body
+
+      update_attributes(
+        jira_id: result['id'],
+        jira_key: result['key'],
+        jira_url: result['self']
+      )
+    end
+  end
+
+  def not_test?
+    ENV['CAPEROMA_INTEGRATION_TEST'].blank?
+  end
+end