adds sponor_reason and exclude_reason to report

Author: niquerio

lib/patron.rb

@@ -23,7 +23,9 @@ def self.inst_roles_for(data)
 
   def self.for(data)
     if test_user?(data)
-      return Skipped.new(data: data, exclude_reasons: ["test_user"])
+      reason = "test_user"
+      Report.metrics.exclude_reason.increment({name: reason})
+      return Skipped.new(data: data, exclude_reasons: [reason])
     end
 
     inst_roles = inst_roles_for(data)
@@ -34,6 +36,7 @@ def self.for(data)
         return user
       else
         S.logger.debug("exclude_reason", {uniqname: user.uniqname, reason: user.exclude_reason, inst_role: inst_role})
+        Report.metrics.exclude_reason.increment({name: user.exclude_reason})
         exclude_reasons.push(user.exclude_reason)
       end
     end

lib/patron/sponsored_affiliate.rb

@@ -48,7 +48,7 @@ def exclude_reason
     end
 
     def sponsor_reason
-      hr_item.umichSponsorReason
+      hr_data.umichSponsorReason
     end
 
     def valid_start_date?(hr_item)

lib/report.rb

@@ -2,6 +2,16 @@
 require "uri"
 require "forwardable"
 class Report
+  COLUMN_NAMES = [
+    "action",
+    "umid",
+    "uniqname",
+    "campus",
+    "user_group",
+    "statistic_category",
+    "sponsor_reason",
+    "exclude_reasons"
+  ]
   def self.configure_yabeda!
     Yabeda.configure do
       group :aim_patron_load do
@@ -12,6 +22,8 @@ def self.configure_yabeda!
         gauge :campus, comment: "Number of patrons in a given campus", tags: [:script_type, :name]
         gauge :user_group, comment: "Number of patrons in a given Alma User Group", tags: [:script_type, :name]
         gauge :statistic_category, comment: "Number of loaded patrons in a statistic category", tags: [:script_type, :name]
+        gauge :sponsor_reason, comment: "Number of loaded Sponsored Affiliates with a given sponsor reason", tags: [:script_type, :name]
+        gauge :exclude_reason, comment: "Number of patrons skipped for a given reason", tags: [:script_type, :name]
         gauge :error, comment: "Number of errors encountered while running the patron load", tags: [:script_type]
         gauge :job_duration_seconds, comment: "Number of seconds it took to run the patron load job", tags: [:script_type]
       end
@@ -27,6 +39,10 @@ def self.print_metrics
     Prometheus::Client::Formats::Text.marshal(Yabeda::Prometheus.registry)
   end
 
+  def self.column_names
+    COLUMN_NAMES
+  end
+
   def self.push_metrics
     # The env var needs to be set to the push gateway url
     if ENV["PROMETHEUS_PUSH_GATEWAY"]&.match?(URI::DEFAULT_PARSER.make_regexp)
@@ -51,6 +67,7 @@ def self.open(file_base:, script_type:, &block)
 
   def initialize(fh:, script_type:)
     @fh = fh
+    @fh.write self.class.column_names.join("\t") + "\n"
     @script_type = script_type
   end
 
@@ -59,17 +76,18 @@ def metrics
   end
 
   def load(patron)
-    patron = Patron.new(patron)
-    @fh.write report_string(kind: "LOAD", patron: patron)
+    patron = Patron.new(patron: patron, action: "load")
+    @fh.write patron.report_string
     metrics.found.increment({script_type: @script_type})
     metrics.loaded.increment({script_type: @script_type})
-    ["patron_kind", "statistic_category", "user_group", "campus"].each do |metric|
+    ["patron_kind", "statistic_category", "user_group", "campus", "sponsor_reason"].each do |metric|
       increment_metric(metric, patron)
     end
   end
 
   def skip(patron)
-    @fh.write report_string(kind: "SKIP", patron: patron)
+    patron = Patron.new(patron: patron, action: "skip")
+    @fh.write patron.report_string
     metrics.found.increment({script_type: @script_type})
     metrics.skipped.increment({script_type: @script_type})
   end
@@ -87,7 +105,7 @@ def report_string(kind:, patron:)
   end
 
   def increment_metric(metric, patron)
-    metrics.public_send(metric).increment({script_type: @script_type, name: patron.public_send(metric)})
+    metrics.public_send(metric).increment({script_type: @script_type, name: patron.public_send(metric)}) if patron.public_send(metric)
   end
 
   class Patron
@@ -153,8 +171,13 @@ class Patron
       "SH" =>	"shares"
     }
 
-    def initialize(patron)
+    def initialize(patron:, action: "whatever")
       @patron = patron
+      @action = action
+    end
+
+    def action
+      @action.upcase
     end
 
     def umid
@@ -173,10 +196,24 @@ def statistic_category
       STATISTIC_CATEGORY_MAP[@patron.statistic_category] || @patron.statistic_category
     end
 
+    def sponsor_reason
+      @patron.sponsor_reason&.downcase
+    end
+
     def patron_kind
       to_snake(@patron.class.name.split("::").last)
     end
 
+    def exclude_reasons
+      @patron.exclude_reasons.join(",")
+    end
+
+    def report_string
+      Report.column_names.map do |method|
+        public_send(method)
+      end.join("\t") + "\n"
+    end
+
     private
 
     def to_snake(str)

spec/fixtures/emcard_staff.json

@@ -65,7 +65,7 @@
         "TRUE"
     ],
     "sn": [
-        "Rio"
+        "Card"
     ],
     "telephonenumber": [
         "734-999-9999"

spec/report_spec.rb

@@ -1,6 +1,17 @@
 describe Report do
+  let(:staff_data) do
+    json_fixture("emcard_staff.json")
+  end
   let(:staff_person) do
-    Patron::StaffPerson.new(data: json_fixture("emcard_staff.json"))
+    Patron::StaffPerson.new(data: staff_data)
+  end
+  let(:sponsored_affiliate) do
+    start_date_str = Date.today.prev_day.strftime("%m/%d/%Y")
+    end_date_str = Date.today.next_day.strftime("%m/%d/%Y")
+    staff_data["umichsponsorshipdetail"] = [
+      "{campus=UM_ANN-ARBOR}:{deptId=99999}:{deptGroup=SOME_DEPT_GROUP}:{deptDescription=SOME DEPARTMENT DESCRIPTION}:{deptGroupDescription=School of Something}:{deptVPArea=PRVST_EXC_VP_ACA_AFF}:{umichSponsorAdmin=sponsoruniqname}:{umichSponsorRequestor=otheruniqname}:{umichSponsorReason=Researchers}:{umichSponsorStartDate=#{start_date_str}}:{umichSponsorEndDate=#{end_date_str}}:{umichSponsorshipCn=111-111-11111111111111111-111}"
+    ]
+    Patron::SponsoredAffiliate.new(data: staff_data)
   end
   before(:each) do
     @file_handle = StringIO.new
@@ -13,6 +24,17 @@
     described_class.new(fh: @file_handle, script_type: "test")
   end
 
+  it "includes a header with all of the column names" do
+    subject
+    expect(@file_handle.string).to include("action")
+    expect(@file_handle.string).to include("umid")
+    expect(@file_handle.string).to include("uniqname")
+    expect(@file_handle.string).to include("campus")
+    expect(@file_handle.string).to include("user_group")
+    expect(@file_handle.string).to include("statistic_category")
+    expect(@file_handle.string).to include("sponsor_reason")
+    expect(@file_handle.string).to include("exclude_reasons")
+  end
   context "#load" do
     it "writes the word LOAD for a staff person, umid, user_group, user_statistic" do
       subject.load(staff_person)
@@ -23,12 +45,51 @@
       expect(@file_handle.string).to include("staff")
       expect(@file_handle.string).to include("staff")
     end
-    it "increments the counters" do
+    it "includes a sponsored affiliate reason when there is one" do
+      subject.load(sponsored_affiliate)
+      expect(@file_handle.string).to include("researchers")
+    end
+
+    it "increments the counters when valid" do
       subject.load(staff_person)
       expect(Report.metrics.statistic_category.get(name: "staff", script_type: "test")).to eq(1)
       expect(Report.metrics.patron_kind.get(name: "staff_person", script_type: "test")).to eq(1)
       expect(Report.metrics.user_group.get(name: "staff", script_type: "test")).to eq(1)
       expect(Report.metrics.campus.get(name: "ann_arbor", script_type: "test")).to eq(1)
+      expect(Report.metrics.sponsor_reason.values).to eq({})
+    end
+    it "increments the sponsor reason when there is one" do
+      subject.load(sponsored_affiliate)
+      expect(Report.metrics.sponsor_reason.get(name: "researchers", script_type: "test")).to eq(1)
+    end
+  end
+
+  context "#skip" do
+    it "includes columns in the report" do
+      skipped_person = Patron::Skipped.new(data: staff_data, exclude_reasons: ["reason1", "reason2"])
+      subject.skip(skipped_person)
+      expect(@file_handle.string).to include("SKIP")
+      expect(@file_handle.string).to include("emcard")
+      expect(@file_handle.string).to include("99991111")
+      expect(@file_handle.string).to include("reason1,reason2")
+    end
+  end
+
+  context "exclude_reason metric" do
+    it "is incremeneted when user a user is a test user" do
+      test_user = staff_data
+      test_user["uid"] = ["ststv"]
+      Yabeda.with_tags(script_type: "test") do
+        Patron.for(test_user)
+      end
+      expect(Report.metrics.exclude_reason.get(name: "test_user", script_type: "test")).to eq(1)
+    end
+    it "is incremented when a user is skipped for some other reason" do
+      staff_data["umichhr"][0].sub!("jobCategory=Staff", "jobCateogry=INVALID")
+      Yabeda.with_tags(script_type: "test") do
+        Patron.for(staff_data)
+      end
+      expect(Report.metrics.exclude_reason.get(name: "job_category_not_staff", script_type: "test")).to eq(1)
     end
   end
 end