feat: sync checkin configuration from config file

lib/honeybadger/backend/base.rb

@@ -4,6 +4,8 @@
 
 require 'honeybadger/logging'
 
+require 'honeybadger/check_in'
+
 module Honeybadger
   module Backend
     class Response
@@ -109,6 +111,61 @@ def track_deployment(payload)
         notify(:deploys, payload)
       end
 
+      # Get check_in by id
+      # @example
+      #   backend.get_check_in('1234', 'ajdja")
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @raise NotImplementedError
+      def get_check_in(project_id, id)
+        raise NotImplementedError, 'must define #get_checkin on subclass'
+      end
+
+      # Get checkins by project
+      # @example
+      #   backend.get_check_ins('1234')
+      #
+      # @param [String] project_id The unique project id
+      # @raise NotImplementedError
+      def get_check_ins(project_id)
+        raise NotImplementedError, 'must define #get_checkins on subclass'
+      end
+
+      # Create check_in on project
+      # @example
+      #   backend.create_check_in('1234', check_in)
+      #
+      # @param [String] project_id The unique project id
+      # @param [CheckIn] data A CheckIn object encapsulating the config
+      # @raise NotImplementedError
+      def create_check_in(project_id, data)
+        raise NotImplementedError, 'must define #create_check_in on subclass'
+      end
+
+      # Update check_in on project
+      # @example
+      #   backend.update_check_in('1234', 'eajaj', check_in)
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @param [CheckIn] data A CheckIn object encapsulating the config
+      # @raise NotImplementedError
+      def update_check_in(project_id, id, data)
+        raise NotImplementedError, 'must define #update_check_in on subclass'
+      end
+
+      # Delete check_in
+      # @example
+      #   backend.delete_check_in('1234', 'eajaj')
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @raise NotImplementedError
+      def delete_check_in(project_id, id)
+        raise NotImplementedError, 'must define #delete_check_in on subclass'
+      end
+
       private
 
       attr_reader :config

lib/honeybadger/backend/server.rb

@@ -16,11 +16,12 @@ class Server < Base
 
       CHECK_IN_ENDPOINT = '/v1/check_in'.freeze
 
-
       HTTP_ERRORS = Util::HTTP::ERRORS
 
       def initialize(config)
         @http = Util::HTTP.new(config)
+        # for check_in config sync
+        @personal_auth_token = config.get(:personal_auth_token)
         super
       end
 
@@ -48,8 +49,103 @@ def check_in(id)
         Response.new(:error, nil, "HTTP Error: #{e.class}")
       end
 
+
+      #
+      ##### CheckIn Crud methods
+      #
+
+      # Get check_in by id
+      # @example
+      #   backend.get_check_in('1234', 'ajdja")
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @returns [CheckIn] or nil if check_in is not found
+      # @raises CheckInSyncError on error
+
+      def get_check_in(project_id, id)
+        response = Response.new(@http.get("/v2/projects/#{project_id}/check_ins/#{id}", personal_auth_headers))
+        if response.success?
+          return CheckIn.from_remote(project_id, JSON.parse(response.body))
+        else
+          if response.code == 404
+            return nil
+          end
+        end
+        raise CheckInSyncError.new "Fetching CheckIn failed (Code: #{response.code}) #{response.body}"
+      end
+
+      # Get check_ins by project
+      # @example
+      #   backend.get_check_ins('1234')
+      #
+      # @param [String] project_id The unique project id
+      # @returns [Array<CheckIn>] All checkins for this project
+      # @raises CheckInSyncError on error
+      def get_check_ins(project_id)
+        response = Response.new(@http.get("/v2/projects/#{project_id}/check_ins", personal_auth_headers))
+        if response.success?
+          all_check_ins = JSON.parse(response.body)["results"]
+          return all_check_ins.map{|cfg| CheckIn.from_remote(project_id, cfg) }
+        end
+        raise CheckInSyncError.new "Fetching CheckIns failed (Code: #{response.code}) #{response.body}"
+      end
+
+      # Create check_in on project
+      # @example
+      #   backend.create_check_in('1234', check_in)
+      #
+      # @param [String] project_id The unique project id
+      # @param [CheckIn] check_in_config A CheckIn object encapsulating the config
+      # @returns [CheckIn] A CheckIn object additionally containing the id
+      # @raises CheckInSyncError on error
+      def create_check_in(project_id, check_in_config)
+        response = Response.new(@http.post("/v2/projects/#{project_id}/check_ins", check_in_config.to_json, personal_auth_headers))
+        if response.success?
+          return CheckIn.from_remote(project_id, JSON.parse(response.body))
+        end
+        raise CheckInSyncError.new "Creating CheckIn failed (Code: #{response.code}) #{response.body}"
+      end
+
+      # Update check_in on project
+      # @example
+      #   backend.update_check_in('1234', 'eajaj', check_in)
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @param [CheckIn] check_in_config A CheckIn object encapsulating the config
+      # @returns [CheckIn] updated CheckIn object
+      # @raises CheckInSyncError on error
+      def update_check_in(project_id, id, check_in_config)
+        response = Response.new(@http.put("/v2/projects/#{project_id}/check_ins/#{id}", check_in_config.to_json, personal_auth_headers))
+        if response.success?
+          return check_in_config
+        end
+        raise CheckInSyncError.new "Updating CheckIn failed (Code: #{response.code}) #{response.body}"
+      end
+
+      # Delete check_in
+      # @example
+      #   backend.delete_check_in('1234', 'eajaj')
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @returns [Boolean] true if deletion was successful
+      # @raises CheckInSyncError on error
+      def delete_check_in(project_id, id)
+        response = Response.new(@http.delete("/v2/projects/#{project_id}/check_ins/#{id}", personal_auth_headers))
+        if response.success?
+          return true
+        end
+        raise CheckInSyncError.new "Deleting CheckIn failed (Code: #{response.code}) #{response.body}"
+      end
+
       private
 
+      def personal_auth_headers
+        {"Authorization" => "#{@personal_auth_token}:"}
+      end
+
       def payload_headers(payload)
         if payload.respond_to?(:api_key) && payload.api_key
           {

lib/honeybadger/backend/test.rb

@@ -41,6 +41,107 @@ def check_in(id)
         check_ins << id
         super
       end
+
+      def self.check_in_configs
+        @check_in_configs ||= {}
+      end
+
+      def check_in_configs
+        self.class.check_in_configs
+      end
+
+      # Set check_in by id, only for use in tests
+      # @example
+      #   backend.set_checkin('1234', 'ajdja', check_in)
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @param [CheckIn] data CheckIn object with config
+      def set_checkin(project_id, id, data)
+        self.check_in_configs[project_id] = self.check_in_configs[project_id] || {}
+        self.check_in_configs[project_id][id] = data
+      end
+
+      # Get check_in by id
+      # @example
+      #   backend.get_check_in('1234', 'ajdja")
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @returns [CheckIn] or nil if check_in is not found
+      def get_check_in(project_id, id)
+        self.check_in_configs ||= {}
+        self.check_in_configs[project_id]&.[](id)
+      end
+
+      # Get checkins by project
+      # @example
+      #   backend.get_check_ins('1234')
+      #
+      # @param [String] project_id The unique project id
+      # @returns [Array<CheckIn>] All checkins for this project
+      def get_check_ins(project_id)
+        self.check_in_configs ||= {}
+        self.check_in_configs[project_id] = self.check_in_configs[project_id] || {}
+        return [] if self.check_in_configs[project_id].empty?
+        self.check_in_configs[project_id].values
+      end
+
+      # Create check_in on project
+      # @example
+      #   backend.create_check_in('1234', check_in)
+      #
+      # @param [String] project_id The unique project id
+      # @param [CheckIn] data A CheckIn object encapsulating the config
+      # @returns [CheckIn] A check_in object containing the id
+      def create_check_in(project_id, data)
+        self.check_in_configs ||= {}
+        self.check_in_configs[project_id] = self.check_in_configs[project_id] || {}
+        id = self.check_in_configs[project_id].length + 1
+        loop do
+          break unless self.check_in_configs[project_id].has_key?(id)
+          id += 1
+        end
+        id = id.to_s
+        data.id = id
+        self.check_in_configs[project_id][id] = data
+        data
+      end
+
+      # Update check_in on project
+      # @example
+      #   backend.update_check_in('1234', 'eajaj', check_in)
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @param [CheckIn] data A CheckIn object encapsulating the config
+      # @returns [CheckIn] updated CheckIn object
+      def update_check_in(project_id, id, data)
+        self.check_in_configs ||= {}
+        if self.check_in_configs.dig(project_id, id)
+          self.check_in_configs.dig(project_id, id).update_from(data) 
+          return self.check_in_configs.dig(project_id, id)
+        else
+          raise "Update failed"
+        end
+      end
+
+      # Delete check_in
+      # @example
+      #   backend.delete_check_in('1234', 'eajaj')
+      #
+      # @param [String] project_id The unique project id
+      # @param [String] id The unique check_in id
+      # @returns [Boolean] true if deletion was successful
+      # @raises CheckInSyncError on error
+      def delete_check_in(project_id, id)
+        self.check_in_configs ||= {}
+        if self.check_in_configs.dig(project_id, id)
+          self.check_in_configs[project_id].delete(id)
+        else
+          raise "Delete failed"
+        end
+      end
     end
   end
 end

lib/honeybadger/check_in.rb

@@ -0,0 +1,80 @@
+module Honeybadger
+  class InvalidCheckinConfig < StandardError; end
+  class CheckInSyncError < StandardError; end
+
+  class CheckIn
+    ATTRIBUTES = %w[name slug schedule_type report_period grace_period cron_schedule cron_timezone].freeze
+    attr_reader :project_id, :data
+    attr_accessor :deleted, :id
+
+    def self.from_config(attrs)
+      attrs = normalize_keys(attrs)
+      self.new(attrs["project_id"], id: attrs["id"], attributes: attrs)
+    end
+
+    def self.from_remote(project_id, attrs)
+      attrs = normalize_keys(attrs)
+      self.new(project_id, id: attrs["id"], attributes: attrs)
+    end
+
+    def initialize(project_id, id: nil, attributes: nil)
+      @project_id = project_id
+      @id = id
+      @data = attributes.slice(*ATTRIBUTES) if attributes.is_a?(Hash)
+    end
+
+    def ==(other)
+      (data.reject {|k,v| v.nil?}) == (other.data.reject {|k,v| v.nil?})
+    end
+
+
+    def to_json
+      fix_nils(data).to_json
+    end
+
+    ATTRIBUTES.each do |meth|
+      define_method meth do
+        data[meth]
+      end
+    end
+
+    def validate!
+      raise InvalidCheckinConfig.new('project_id is required for each check_in') if blank?(project_id)
+      raise InvalidCheckinConfig.new('name is required for each check_in') if blank?(name)
+      raise InvalidCheckinConfig.new("#{name} schedule_type must be either 'simple' or 'cron'") unless ['simple', 'cron'].include? schedule_type
+      if schedule_type == 'simple'
+        raise InvalidCheckinConfig.new("#{name} report_period is required for simple checkins") if blank?(report_period)
+      else
+        raise InvalidCheckinConfig.new("#{name} cron_schedule is required for cron checkins") if blank?(cron_schedule)
+      end
+    end
+
+    def update_from(check_in)
+      @data = check_in.data
+    end
+
+    def deleted?
+      @deleted
+    end
+
+    private 
+
+    def blank?(str)
+      str.nil? || str == "" 
+    end
+
+    def self.normalize_keys(hash)
+      hash.transform_keys(&:to_s)
+    end
+
+    def fix_nils(data)
+      data = data.clone
+      data["grace_period"] ||= ""
+      data["slug"] ||= ""
+      if data["schedule_type"] == "cron"
+        data["cron_timezone"] ||= ""
+      end
+      data
+    end
+  end
+end