issue_scheduler 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb4fce5a900cd6f6b8c5ddb71a544612bad9031f861075eb42ad05098ff36f9a
+  data.tar.gz: 1639180c4fcf1ab5e64c9319deb9eb4ae6c2d27c0e2977d07bb3ab67dcf8d75c
+SHA512:
+  metadata.gz: 47a6e4b7ba1c410089798718220ebe0821f94397f463ed6f6752585d3664dcee8db5faae2f877ea2dcc3b598f73fc4e75f74c95f5f51cf1f9fe3f6828aae24a7
+  data.tar.gz: c19b097f8b1560f4a2cd3abb6277f8e8140628079d9404d33ae4368977455dec0ed01c004fcd3300829cf0bfa123a38d860cf85f5e76cb35018ef8844ff6fb96

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  NewCops: enable
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  SuggestExtensions: false
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - bin/create-release
+    - vendor/bundle/**/*
+
+# The default max line length is 80 characters
+Layout/LineLength:
+  Max: 120
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length:
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "*.gemspec"
+
+# When writing minitest tests, it is very hard to limit test class length:
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*_test.rb"

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+<!--
+# @markup markdown
+# @title Change Log
+-->
+
+# Change Log
+
+The full change log is stored on [this project's GitHub releases page](https://github.com/jcouball/issue_scheduler).
+
+## v0.1.1
+
+* 21efe6f Correctly set allowed_push_host in gemspec
+* 9e1a722 Create initial CHANGELOG.md
+* 559d3a3 Add changelog-rs Dockerfile
+* 37ef841 Use gh to get repo web url instead of hardcoding the url
+* d007d5f Add JRuby support to build and checkout yard from head
+* 1b62347 Exclude vendor/bundle/**/* from rubocop
+* 1c15d36 Exclude bin/create-release from rubocop
+* 5456538 Add build and release scripts
+* a66e8f8 Fix Markdown lint offenses
+* cc807ac Add more usage documentation in the README.md
+* 8bd404d Only require Ruby 2.7
+* 6665fc0 Add script that shows example for creating an issue
+* 87d893d Refactor the server script to make Rubocop happy
+* c500c95 Add Config#load_issue_templates
+* b9d482a Refactor reading and parsing YAML
+* 0b5225b Add lib_dir method
+* 725f7ee Create the script to start the admin ui
+* dfbdfa2 Create the main issue-scheduler service start script
+* b049b13 Rename Config#issue_files to Config#issue_templates
+* 4ebb1fd Refactor IssueTemplate to use ActiveRecord
+* dab32f8 Add template_name to IssueTemplate
+* bf8c835 Add the IssueTemplate class
+* 5dd23a0 Remove Gemfile.lock from git
+* 6bd612b Documentation cleanup
+* ba1564a Refactor config to take a YAML string instead of a filename
+* ae393bc Add the IssueScheduler::Config class
+* 32219f2 List undocumented objects in the yard task
+
+See https://github.com/jcouball/issue_scheduler/releases/tag/v0.1.1
+
+## v0.1.0
+
+* caad020 Initial version

data/Dockerfile.changelog-rs

@@ -0,0 +1,12 @@
+FROM rust
+
+# Build the docker image (from this project's root directory):
+# docker build --file Dockerfile.changelog-rs --tag changelog-rs .
+#
+# Use this image to output a changelog (from this project's root directory):
+# docker run --rm --volume "$PWD:/worktree" changelog-rs v1.9.1 v1.10.0
+
+RUN cargo install changelog-rs
+WORKDIR /worktree
+
+ENTRYPOINT ["/usr/local/cargo/bin/changelog-rs", "/worktree"]

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git 'https://github.com/lsegal/yard', branch: 'main' do
+  gem 'yard'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 James Couball
+
+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,99 @@
+# IssueScheduler
+
+Create new Jira issues on a cron like scheduler
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'issue_scheduler'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+...
+Installing issue_scheduler 5.14.1
+...
+$
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install issue_scheduler
+...
+$
+```
+
+## Usage
+
+### Configuration
+
+Add config in the following format to ~/.issue_scheduler.yaml:
+
+```text
+username: your_username
+password: Qwerty13456!
+site: https://jira.mydomain.com/
+context_path: ""
+auth_type: :basic
+issue_templates: ~/issue_templates/**/*.yaml
+```
+
+Place issue templates in the issue_templates subdirectory. Each teamplate is a yaml
+file in the following format:
+
+```text
+recurrance_rule: 'RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR'
+project: JIRAPROJECT
+component: Internal
+type: Story
+summary: Take out the trash
+description: |
+  Remember to take out the trash in the following rooms:
+  * Kitchen
+  * Bathroom
+  * Bedroom
+  * Laundry Room
+
+  When you finish this task, you will feel a lot better!
+```
+
+### Running the Scheduler
+
+Once configuration is finished, run the scheduyler with the following command:
+
+```shell
+issue-scheduler
+```
+
+Press CTRL-C to exit the scheduler.
+
+### Running the Admin UI
+
+Run the admin UI with the following command:
+
+```shell
+issue-scheduler-admin-ui
+```
+
+Press CTRL-C to exit the admin UI.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake`
+to run the tests. You can also run `bin/console` for an interactive prompt that will
+allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push git
+commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [jcouball/issue_scheduler](https://github.com/jcouball/issue_scheduler).

data/Rakefile

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'rake/clean'
+
+# The default task
+
+desc 'Run the same tasks that the CI build will run'
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard yard:audit yard:coverage bundle:audit build]
+end
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+CLEAN << 'pkg'
+CLOBBER << 'Gemfile.lock'
+
+# Bump
+
+require 'bump/tasks'
+
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w[
+    --format progress
+    --format json --out rubocop-report.json
+  ]
+end
+
+CLEAN << 'rubocop-report.json'
+
+unless RUBY_PLATFORM == 'java'
+  # YARD
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+    t.stats_options = ['--list-undoc']
+  end
+
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+
+  # Yardstick
+
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+
+  # Yardstick coverage
+
+  require 'yardstick/rake/verify'
+
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
+
+  # Publish YARD documentation to GitHub
+
+  require 'github_pages_rake_tasks'
+
+  GithubPagesRakeTasks::PublishTask.new do |task|
+    # task.doc_dir = 'documentation'
+    task.verbose = true
+  end
+end

data/examples/create-issues

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2021 Verizon
+# frozen_string_literal: true
+
+require 'issue_scheduler'
+require 'pp'
+
+config = IssueScheduler::Config.new(IssueScheduler.load_yaml('config/config.yaml'))
+config.load_issue_templates
+
+pp IssueScheduler::IssueTemplate.all.first
+
+client = JIRA::Client.new(config.to_jira_options)
+
+project = client.Project.find('WARPDRIVE')
+component = project.components.find { |c| c.name == 'Internal' }
+
+puts "Project: '#{project.id}: #{project.name}'"
+
+# puts project.issuetypes.map(&:name)
+# exit
+
+puts "Component: '#{component.id}: #{component.name}'"
+
+issue = client.Issue.build
+
+issue.save(
+  {
+    'fields' => {
+      'summary' => 'Sample Ticket',
+      'project' => { 'key' => 'YPEDTO' },
+      'issuetype' => { 'name' => 'Story' }
+    }
+  }
+)
+
+puts issue.pretty_inspect
+
+issue.fetch
+
+puts "Created issue #{issue.key}"

data/exe/issue-scheduler

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'issue_scheduler'
+
+sidekiq_file = File.join(IssueScheduler.lib_dir, 'server.rb')
+
+system('sidekiq', '-r', sidekiq_file)

data/exe/issue-scheduler-admin-ui

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'issue_scheduler'
+
+rackup_file = File.join(IssueScheduler.lib_dir, 'admin_ui.ru')
+
+system('rackup', rackup_file)

data/issue_scheduler.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'lib/issue_scheduler/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'issue_scheduler'
+  spec.version = IssueScheduler::VERSION
+  spec.authors = ['James Couball']
+  spec.email = ['jcouball@yahoo.com']
+
+  spec.summary = 'Schedule recurring Jira issue creation'
+  spec.description = 'Allow Jira issues to be created at a specified recurrence'
+  spec.homepage = 'https://github.com/jcouball/issue_scheduler'
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.license = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = File.join(spec.homepage, 'blob/master/CHANGELOG.md')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'active_model_persistence', '~> 0.5.0'
+  spec.add_dependency 'jira-ruby', '~> 2.2'
+  spec.add_dependency 'sidekiq-cron', '~> 1.4'
+
+  spec.add_development_dependency 'bump', '~> 0.10'
+  spec.add_development_dependency 'bundler-audit', '~> 0.9'
+  spec.add_development_dependency 'github_pages_rake_tasks', '~> 0.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'solargraph'
+
+  unless RUBY_PLATFORM == 'java'
+    spec.add_development_dependency 'redcarpet', '~> 3.5'
+    spec.add_development_dependency 'yard', '~> 0.9'
+    spec.add_development_dependency 'yardstick', '~> 0.9'
+  end
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/issue_scheduler/admin_ui.ru

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'sidekiq/web'
+require 'sidekiq/cron/web'
+
+# Run the admin UI from the command line using:
+#   $ rackup admin_ui.rb
+
+# A Web process always runs as client, no need to configure server
+Sidekiq.configure_client do |config|
+  config.redis = { db: 1 }
+end
+
+# Sidekiq::Client.push('class' => "HardWorker", 'args' => [])
+
+# In a multi-process deployment, all Web UI instances should share
+# this secret key so they can all decode the encrypted browser cookies
+# and provide a working session.
+# Rails does this in /config/initializers/secret_token.rb
+secret_key = SecureRandom.hex(32)
+use Rack::Session::Cookie, secret: secret_key, same_site: true, max_age: 86_400
+
+run Sidekiq::Web