gitlab_support_readiness 1.0.41 → 1.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbf71b0dfb94b5a9ddcb379a4423b3557315e349ae0cd0b39a1de2c9cbdd5b24
-  data.tar.gz: b01682f0e3bcdb9d9682ce9c0fe4d50d9a1ac157317666b356f9746823fc6b89
+  metadata.gz: 329d7803aa9435db0939a46d9cc4124bf25c51bb5faed1a6a4d8cd6278fc00a4
+  data.tar.gz: 4da0de2f1303d5b225f4f91077863059ee482fbd7cbe2274df7bb72a400cdab4
 SHA512:
-  metadata.gz: 3606567067352ee9168ac6ea9a7817da59fc93f0abb5ee19d83589ee4f77fbfb3f6409a171ab0f4694d9c4e0a88933a1b8e3d60eb4f0d2ba06c1ce43c2745b50
-  data.tar.gz: f27b35963a541bc5429b22dc7b8fa8400a5c3264b9c504809acf9408340d93ff7f24697d7a6649cf73ed02c459665eafe9e9fcbf73aedeb7bf5804388f5640df
+  metadata.gz: 11cec2ae870755dee110a441c62bfe2c17c73a70c1ff0368b49e6f0e4beab979cd03d95ab863013673e75e6b0c78b908e9f6885c9d76f9679ae5344425c4bcbe
+  data.tar.gz: 0e83d7b4973c7b3c288eba1dfc9af1eea6848c8e456b4ee2d94ad576fbbf2cece43f78d67dfe3d609e8efe9cb22a0452183e81c4b2885e6ce9d0eaa611088867

data/lib/support_readiness/mailgun/client.rb

@@ -57,7 +57,8 @@ module Readiness
         Faraday.new("https://api:#{config.token}@api.mailgun.net/v3") do |c|
           c.request :retry, retry_options(config)
           c.adapter Faraday.default_adapter
-          c.headers['Content-Type'] = 'application/json'
+          c.request :multipart
+          c.request :url_encoded
         end
       end
     end

data/lib/support_readiness/mailgun/emails.rb

@@ -57,7 +57,7 @@ module Readiness
       #   # => true
       def self.send!(client, email)
         handle_request_error(1, 'Mailgun', 400, { action: 'Send email', id: email }) unless valid_email?(email)
-        response = client.connection.post "#{client.domain}/messages", to_clean_json(email)
+        response = client.connection.post "#{client.domain}/messages", to_hash(email).compact
         handle_request_error(1, 'Mailgun', response.status, { action: 'Send email', id: email }) unless response.status == 200
         true
       end

data/lib/support_readiness/support_super_form_processor/create_article.rb

@@ -0,0 +1,375 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class CreateArticle within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class CreateArticle < Readiness::Client
+      ##
+      # Process a Create Article request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, zendesk_global_client, zendesk_usgov_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @zendesk_global_client = zendesk_global_client
+        @zendesk_usgov_client = zendesk_usgov_client
+        requester
+        request_checks
+        unless errors.count.zero?
+          Readiness::SupportSuperFormProcessor::Shared.invalid_article_creation(requester, errors)
+        end
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Create a new article'
+        issue.description = issue_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        articles = create_articles_in_zendesk
+        create_article_commits(articles)
+        comment_params = {
+          body: article_comment_message(articles)
+        }
+        comment = Readiness::GitLab::Issues.create_comment(@gitlab_client, project, create, comment_params)
+        exit 0
+      end
+
+      ##
+      # Commit article files to the repos
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.create_article_commits(articles)
+        unless articles[:global].nil?
+          repo_project = Readiness::GitLab::Projects.find!(@gitlab_client, 52796747)
+          commit_params = {
+            branch: 'master',
+            commit_message: 'Creating new article file',
+            actions: [
+              {
+                file_path: "data/articles/active/#{create_article_link.split('/').last.gsub('.md', '.yaml')}",
+                action: 'create',
+                content: global_file_content(articles[:global])
+              }
+            ]
+          }
+          Readiness::GitLab::Repositories.create_commit!(@gitlab_client, repo_project, commit_params)
+        end
+        unless articles[:usgov].nil?
+          repo_project = Readiness::GitLab::Projects.find!(@gitlab_client, 53653025)
+          commit_params = {
+            branch: 'master',
+            commit_message: 'Creating new article file',
+            actions: [
+              {
+                file_path: "data/articles/active/#{create_article_link.split('/').last.gsub('.md', '.yaml')}",
+                action: 'create',
+                content: usgov_file_content(articles[:usgov])
+              }
+            ]
+          }
+          Readiness::GitLab::Repositories.create_commit!(@gitlab_client, repo_project, commit_params)
+        end
+      end
+
+      ##
+      # Returns a string for the Global article sync repo
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.global_file_content(article)
+        <<~STRING
+          ---
+          id: #{article.id}
+          author_id: 365068329233
+          comments_disabled: true
+          draft: false
+          promoted: false
+          position: 0
+          name: '#{article_title}'
+          title: '#{article_title}'
+          locale: 'en-us'
+          user_segment_id: null
+          permission_group_id: 113047
+          label_names: []
+          body: null
+          section_id: #{section_id('Global')}
+          content_path: '#{create_article_link.split(%r{master/(knowledge-base|support-pages)/}).last}'
+        STRING
+      end
+
+      ##
+      # Returns a string for the US Gov article sync repo
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.usgov_file_content(article)
+        <<~STRING
+          ---
+          id: #{article.id}
+          author_id: 381755018552
+          comments_disabled: true
+          draft: false
+          promoted: false
+          position: 0
+          name: '#{article_title}'
+          title: '#{article_title}'
+          locale: 'en-us'
+          user_segment_id: null
+          permission_group_id: 2721132
+          label_names: []
+          body: null
+          section_id: #{section_id('US Government')}
+          content_path: '#{create_article_link.split(%r{master/(knowledge-base|support-pages)/}).last}'
+        STRING
+      end
+
+      ##
+      # Retunrs the correct section ID to use
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.section_id(instance)
+        path = create_article_link.split('master/').last.split('/').first
+        return 360004459140 if instance == 'Global' && path == 'support-pages'
+        return 15215649512604 if instance == 'Global' && path == 'knowledge-base'
+        return 10593044624020 if instance == 'US Government' && path == 'support-pages'
+        return 29015014994068 if instance == 'US Government' && path == 'knowledge-base'
+
+        nil
+      end
+
+      ##
+      # Return a Hash of Article objects
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.create_articles_in_zendesk
+        {
+          global: create_global_article,
+          usgov: create_usgov_article
+        }
+      end
+
+      ##
+      # Create an article in Zendesk Global
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.create_global_article
+        return nil unless create_article_link =~ /all_instances/ || create_article_link =~ /global_only/
+
+        article = Readiness::Zendesk::Articles.new
+        article.author_id = 365068329233
+        article.body = "Placeholder for #{create_article_link}"
+        article.comments_disabled = true
+        article.draft = true
+        article.locale = 'en-us'
+        article.permission_group_id = 113047
+        article.title = article_title
+        article.user_segment_id = 1536307
+        Readiness::Zendesk::Articles.create!(@zendesk_global_client, article)
+      end
+
+      ##
+      # Create an article in Zendesk US Government
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.create_usgov_article
+        return nil unless create_article_link =~ /all_instances/ || create_article_link =~ /us_government_only/
+
+        article = Readiness::Zendesk::Articles.new
+        article.author_id = 381755018552
+        article.body = "Placeholder for #{create_article_link}"
+        article.comments_disabled = true
+        article.draft = true
+        article.locale = 'en-us'
+        article.permission_group_id = 2721132
+        article.title = article_title
+        article.user_segment_id = 360001187072
+        Readiness::Zendesk::Articles.create!(@zendesk_usgov_client, article)
+      end
+
+      ##
+      # Perform the needed checks for article creation
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.request_checks
+        pages_project = Readiness::GitLab::Projects.find!(@gitlab_client, 52066066)
+        path = create_article_link.split('master/').last.split('?').first
+        file = Readiness::GitLab::Repositories.file(@gitlab_client, pages_project, path, 'master')
+        unless file.key? 'file_name'
+          errors.push("No such article file: #{path}")
+        end
+        file_contents = Readiness::GitLab::Repositories.raw_file(@gitlab_client, pages_project, '.gitlab/CODEOWNERS', 'master')
+        match = file_contents =~ %r{#{path} #{article_dris}}
+        errors.push("No such CODEOWNERS entry: #{path} #{article_dris}") unless match
+      end
+
+      ##
+      # Sets the global variable errors
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.errors
+        @errors ||= []
+      end
+
+      ##
+      # Sets the global variable requester
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.requester
+        @requester ||= Readiness::SupportSuperFormProcessor::Shared.gitlab_user_check(@gitlab_admin_client, requester_email)
+      end
+
+      ##
+      # Sets the global variable requester_email
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.requester_email
+        @requester_email ||= ENV.fetch('REQUESTER_EMAIL')
+      end
+
+      ##
+      # Sets the global variable project
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.project
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+      end
+
+      ##
+      # Sets the global variable create_article_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.create_article_link
+        @create_article_link ||= ENV.fetch('CREATE_ARTICLE_LINK')
+      end
+
+      ##
+      # Sets the global variable article_dris
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.article_dris
+        @article_dris ||= ENV.fetchh('CREATE_ARTICLE_DRIS')
+      end
+
+      ##
+      # Sets the global variable article_title
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.article_title
+        @article_title ||= determine_article_title
+      end
+
+      ##
+      # Determines the article title
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.determine_article_title
+        path = create_article_link.split('master/').last.split('?').first
+        pages_project = Readiness::GitLab::Projects.find!(@gitlab_client, 52066066)
+        file_contents = Readiness::GitLab::Repositories.raw_file(@gitlab_client, pages_project, path, 'master')
+        file_contents.split("\n").detect { |f| f =~ /^\#\ / }.split('# ').last.gsub('`', '').gsub("'", '"')
+      end
+
+      ##
+      # Returns string for displaying what instances this applies to
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.instance_block
+        output = []
+        if create_article_link =~ /all_instances/ || create_article_link =~ /global_only/
+          output.push('  - [x] Global')
+        else
+          output.push('  - [~] Global')
+        end
+        if create_article_link =~ /all_instances/ || create_article_link =~ /us_government_only/
+          output.push('  - [x] US Government')
+        else
+          output.push('  - [~] US Government')
+        end
+        output.join("\n")
+      end
+
+      ##
+      # Returns string for issue body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.issue_message
+        <<~STRING
+          ## Create a new article
+
+          Greetings @#{requester.username} !
+
+          This is a request to create a new article within Zendesk. The details are as follows:
+
+          - Link to article file: #{create_article_link}
+          - Article DRIs: `#{article_dris}`
+          - Zendesk Instance(s):
+          #{instance_block}
+
+          ---
+
+          ### Support Readiness Process
+
+          This process should be completely automated. If you see any issues, please rectify them and notify Jason so the processor can be looked into.
+
+          /label ~"Readiness Priority::Current Quarter"
+
+          /label ~"Readiness::Completed"
+
+          /assign @jcolyer @dtragjasi
+        STRING
+      end
+
+      ##
+      # Returns string for comment body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.article_comment_message(articles)
+        <<~STRING
+          We have added the article to the requested Zendesk instance(s). You can see the article at the following link(s) once the sync completes (in the next 5-10 minutes):
+
+          #{article_links_comment_string(articles)}
+
+          If you see any issues, please reopen this issue and post in the support operations channel in Slack.
+
+          /label ~"Readiness::Completed"
+
+          /close
+        STRING
+      end
+
+      ##
+      # Returns string for article links
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.article_links_comment_string(articles)
+        out = []
+          out.push("- https://support.gitlab.com/hc/en-us/articles/#{articles[:global].id}") unless articles[:global].nil?
+          out.push("- https://federal-support.gitlab.com/hc/en-us/articles/#{articles[:usgov].id}") unless articles[:usgov].nil?
+          out.join("\n")
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/create_macro.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class CreateMacro within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class CreateMacro < Readiness::Client
+      ##
+      # Process a Create Macro request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        requester
+        file_path = create_macro_file_if_needed
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Create a new macro'
+        issue.description = message(file_path)
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      def self.create_macro_file_if_needed
+        return nil if comment == 'none'
+
+        macro_project_id = if instance == 'Zendesk Global'
+                             53382456
+                             else
+                               53561363
+                             end
+        macro_project = Readiness::GitLab::Projects.find!(@gitlab_client, macro_project_id)
+        path =  "active/#{name.split('::').join('/')}.md"
+        file = Readiness::GitLab::Repositories.file(@gitlab_client, macro_project, path, 'master')
+        unless file.key? 'file_name'
+          commit_params = {
+            branch: 'master',
+            commit_message: 'Creating placeholder file for macro',
+            actions: [
+              {
+                file_path: path,
+                content: 'PLACEHOLDER',
+                action: 'create'
+              }
+            ]
+          }
+          Readiness::GitLab::Repositories.create_commit!(@gitlab_client, macro_project, commit_params)
+        end
+        path
+      end
+
+      ##
+      # Sets the global variable requester
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.requester
+        @requester ||= Readiness::SupportSuperFormProcessor::Shared.gitlab_user_check(@gitlab_admin_client, requester_email)
+      end
+
+      ##
+      # Sets the global variable requester_email
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.requester_email
+        @requester_email ||= ENV.fetch('REQUESTER_EMAIL')
+      end
+
+      ##
+      # Sets the global variable project
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.project
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+      end
+
+      ##
+      # Sets the global variable comment
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.comment
+        @comment ||= ENV.fetch('CREATE_MACRO_COMMENT')
+      end
+
+      ##
+      # Sets the global variable instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.instance
+        @instance ||= ENV.fetch('CREATE_MACRO_INSTANCE')
+      end
+
+      ##
+      # Sets the global variable name
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.name
+        @name ||= ENV.fetch('CREATE_MACRO_NAME')
+      end
+
+      ##
+      # Sets the global variable assignee
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.assignee
+        @assignee ||= ENV.fetch('CREATE_MACRO_ASSIGNEE')
+      end
+
+      ##
+      # Sets the global variable tag
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.tag
+        @tag ||= ENV.fetch('CREATE_MACRO_TAG')
+      end
+
+      ##
+      # Sets the global variable other
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.other
+        @other ||= ENV.fetch('CREATE_MACRO_OTHER')
+      end
+
+      def self.issue_assignees
+        return '@jcolyer @secole' if instance == 'Zendesk US Government'
+
+        '@jcolyer @nabeel.bilgrami @avilla4 @dtragjasi @secole @rverschoor'
+      end
+
+      ##
+      # Return the string for the issue body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message(file_path)
+        <<~STRING
+          ## Create a macro
+
+          Greetings @#{requester.username} !
+
+          This is a request to create a new macro within a Zendesk instance. The details are as follows:
+
+          - Name of Macro: #{name}
+          - Zendesk Instance: #{instance}
+          - Assigne change: #{assignee}
+          - Tag to add: #{tag}
+          - Type of comment: #{comment}
+          - Managed content file: #{file_path.nil? ? 'N/A' : path}
+
+          Some other details are:
+
+          ```
+
+          #{other}
+
+          ```
+
+          /label ~"Readiness Priority::Current Quarter"
+
+          /label ~"Readiness::Triage"
+
+          /assign #{issue_assignees}
+        STRING
+      end
+    end
+  end
+end