toccatore 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c949197fc708de905e4b05d736b9344b3e5d319
-  data.tar.gz: 758175d3ccf837bdcf56b6759137c0ab51a31e02
+  metadata.gz: 8698a6f69a4f27c74355a45e88cd1f6d0725d48e
+  data.tar.gz: 00da3c549c74c394783defee1ec0c6213ec13195
 SHA512:
-  metadata.gz: 4ca83c0ae9ab948155fdadddc87311701150aa9706c53afe3e2fbb9d278efd0edb320903c94fad7e02ad568e99618a18cf96bd6b42914dbfdff0f54fb68ab90b
-  data.tar.gz: 99a03f05d49be0191044d4735a101fc731a93bac90de2e89423842c4322e2c83464ad6116a31a30449cbadf7170af4d1e5fe90bda1a796dc47d19694f26c8dd3
+  metadata.gz: f345ab88662824dfd50bc174b10895f2bd3aaa87dc925b086c92a8492d69c3a7b946fcc7d76d9734fa1bd64cb0208ed4aca7f251cee6f4b4e111e301eb948946
+  data.tar.gz: 23a2dfe059d46d550f797ae7ffe4a33e7dabac58e34eff48748466147ac0de63597ca1593bb9d54f32baca3edc5756ce3bd2d173d01465081b655e234d1d29d1

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    toccatore (0.3.5)
+    toccatore (0.3.6)
       activesupport (~> 4.2, >= 4.2.5)
       dotenv (~> 2.1, >= 2.1.1)
       gender_detector (~> 1.0)
       maremma (~> 3.5)
       namae (~> 0.11.0)
+      slack-notifier (~> 2.1)
       thor (~> 0.19)
 
 GEM
@@ -20,8 +21,8 @@ GEM
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
     builder (3.2.3)
-    codeclimate-test-reporter (1.0.7)
-      simplecov
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -56,7 +57,7 @@ GEM
     namae (0.11.3)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-    oj (2.18.2)
+    oj (2.18.5)
     public_suffix (2.0.5)
     rack (2.0.1)
     rack-test (0.6.3)
@@ -81,9 +82,10 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    slack-notifier (2.1.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    tzinfo (1.2.2)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
     vcr (3.0.3)
     webmock (1.24.6)

data/lib/toccatore/base.rb

@@ -1,10 +1,15 @@
 require 'maremma'
 require 'active_support/all'
+require 'erb'
+require 'slack-notifier'
 require 'namae'
 require 'gender_detector'
 
 module Toccatore
   class Base
+    # icon for Slack messages
+    ICON_URL = "https://raw.githubusercontent.com/datacite/toccatore/master/lib/toccatore/images/toccatore.png"
+
     # load ENV variables from .env file if it exists
     env_file = File.expand_path("../../../.env", __FILE__)
     if File.exist?(env_file)
@@ -67,10 +72,17 @@ module Toccatore
           options[:offset] = page * job_batch_size
           process_data(options)
         end
+        text = "#{total} works processed for date range #{options[:from_date]} - #{options[:until_date]}."
       else
-        puts "No works found for date range #{options[:from_date]} - #{options[:until_date]}."
+        text = "No works found for date range #{options[:from_date]} - #{options[:until_date]}."
+        puts text
       end
 
+      # send slack notification
+      options[:level] = total > 0 ? "good" : "warning"
+      options[:title] = "Report for #{source_id}"
+      send_notification_to_slack(text, options) if options[:slack_webhook_url].present?
+
       # return number of works queued
       total
     end
@@ -111,6 +123,22 @@ module Toccatore
       1000
     end
 
+    def send_notification_to_slack(text, options={})
+      return nil unless options[:slack_webhook_url].present?
+
+      attachment = {
+        title: options[:title] || "Report",
+        text: text,
+        color: options[:level] || "good"
+      }
+
+      notifier = Slack::Notifier.new options[:slack_webhook_url],
+                                     username: "Event Data Agent",
+                                     icon_url: ICON_URL
+      response = notifier.ping attachments: [attachment]
+      response.body
+    end
+
     def get_doi_ra(prefix)
       return nil if prefix.blank?
 

data/lib/toccatore/cli.rb

@@ -19,6 +19,7 @@ module Toccatore
     desc "orcid_update", "push ORCID IDs from DataCite MDS to ORCID"
     method_option :access_token, type: :string, required: true
     method_option :push_url, type: :string
+    method_option :slack_webhook_url, type: :string
     method_option :from_date, type: :string, default: (Time.now.to_date - 1.day).iso8601
     method_option :until_date, type: :string, default: Time.now.to_date.iso8601
     method_option :q, type: :string
@@ -34,6 +35,7 @@ module Toccatore
     method_option :access_token, type: :string, required: true
     method_option :source_token, type: :string, required: true
     method_option :push_url, type: :string
+    method_option :slack_webhook_url, type: :string
     method_option :from_date, type: :string, default: (Time.now.to_date - 1.day).iso8601
     method_option :until_date, type: :string, default: Time.now.to_date.iso8601
     method_option :q, type: :string

data/lib/toccatore/version.rb

@@ -1,3 +1,3 @@
 module Toccatore
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/spec/base_spec.rb

@@ -29,6 +29,38 @@ describe Toccatore::Base, vcr: true do
     end
   end
 
+  context "send_notification_to_slack" do
+    let(:slack_webhook_url) { ENV['SLACK_WEBHOOK_URL'] }
+
+    it "datacite_related" do
+      text =  "12 works processed for date range 2015-04-07 - 2015-04-08."
+      options = { title: "Report for datacite_related", slack_webhook_url: slack_webhook_url }
+      expect(subject.send_notification_to_slack(text, options)).to eq("ok")
+    end
+
+    it "datacite_related no works" do
+      text =  "No works found for date range 2015-04-07 - 2015-04-08."
+      options = { title: "Report for datacite_related",
+                  slack_webhook_url: slack_webhook_url,
+                  level: "warning" }
+      expect(subject.send_notification_to_slack(text, options)).to eq("ok")
+    end
+
+    it "orcid_update" do
+      text =  "12 works processed for date range 2015-04-07 - 2015-04-08."
+      options = { title: "Report for orcid_update", slack_webhook_url: slack_webhook_url }
+      expect(subject.send_notification_to_slack(text, options)).to eq("ok")
+    end
+
+    it "orcid_update no works" do
+      text =  "No works found for date range 2015-04-07 - 2015-04-08."
+      options = { title: "Report for orcid_update",
+                  slack_webhook_url: slack_webhook_url,
+                  level: "warning" }
+      expect(subject.send_notification_to_slack(text, options)).to eq("ok")
+    end
+  end
+
   context "get_doi_ra" do
     it "datacite" do
       expect(subject.get_doi_ra("10.5061")).to eq("DataCite")

data/spec/cli_spec.rb

@@ -8,16 +8,18 @@ describe Toccatore::CLI do
 
   describe "version" do
     it 'has version' do
-      expect { subject.__print_version }.to output("0.3.5\n").to_stdout
+      expect { subject.__print_version }.to output("0.3.6\n").to_stdout
     end
   end
 
   describe "orcid_update", vcr: true, :order => :defined do
     let(:push_url) { ENV['VOLPINO_URL'] }
     let(:access_token) { ENV['VOLPINO_TOKEN'] }
+    let(:slack_webhook_url) { ENV['SLACK_WEBHOOK_URL'] }
     let(:from_date) { "2015-04-07" }
     let(:until_date) { "2015-04-08" }
     let(:cli_options) { { push_url: push_url,
+                          slack_webhook_url: slack_webhook_url,
                           access_token: access_token,
                           from_date: from_date,
                           until_date: until_date } }
@@ -46,6 +48,7 @@ describe Toccatore::CLI do
       from_date = "2009-04-07"
       until_date = "2009-04-08"
       subject.options = { push_url: push_url,
+                          slack_webhook_url: slack_webhook_url,
                           access_token: access_token,
                           from_date: from_date,
                           until_date: until_date }
@@ -62,9 +65,11 @@ describe Toccatore::CLI do
     let(:push_url) { ENV['EVENTDATA_URL'] }
     let(:access_token) { ENV['EVENTDATA_TOKEN'] }
     let(:source_token) { ENV['SOURCE_TOKEN'] }
+    let(:slack_webhook_url) { ENV['SLACK_WEBHOOK_URL'] }
     let(:from_date) { "2015-04-07" }
     let(:until_date) { "2015-04-08" }
     let(:cli_options) { { push_url: push_url,
+                          slack_webhook_url: slack_webhook_url,
                           access_token: access_token,
                           source_token: source_token,
                           from_date: from_date,
@@ -89,6 +94,7 @@ describe Toccatore::CLI do
       from_date = "1899-04-07"
       until_date = "1899-04-08"
       subject.options = { push_url: push_url,
+                          slack_webhook_url: slack_webhook_url,
                           access_token: access_token,
                           from_date: from_date,
                           until_date: until_date }

data/spec/fixtures/vcr_cassettes/Toccatore_Base/send_notification_to_slack/datacite_related.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<SLACK_WEBHOOK_URL>"
+    body:
+      encoding: US-ASCII
+      string: payload=%7B%22username%22%3A%22Event+Data+Agent%22%2C%22icon_url%22%3A%22https%3A%2F%2Fraw.githubusercontent.com%2Fdatacite%2Ftoccatore%2Fmaster%2Flib%2Ftoccatore%2Fimages%2Ftoccatore.png%22%2C%22attachments%22%3A%5B%7B%22title%22%3A%22Report+for+datacite_related%22%2C%22text%22%3A%2212+works+processed+for+date+range+2015-04-07+-+2015-04-08.%22%2C%22color%22%3A%22good%22%7D%5D%7D
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/html
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Date:
+      - Wed, 29 Mar 2017 12:22:55 GMT
+      Referrer-Policy:
+      - no-referrer
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Slack-Backend:
+      - h
+      X-Cache:
+      - Miss from cloudfront
+      Via:
+      - 1.1 8a4d4882753d62d900bb1b7541308eca.cloudfront.net (CloudFront)
+      X-Amz-Cf-Id:
+      - NHshrt1mNkLoOKPf0Eb6EdL_WFYPdKTkLcWcuHUCLS0rn-b31QoKgw==
+    body:
+      encoding: ASCII-8BIT
+      string: ok
+    http_version: 
+  recorded_at: Wed, 29 Mar 2017 12:22:55 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/Toccatore_Base/send_notification_to_slack/datacite_related_no_works.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<SLACK_WEBHOOK_URL>"
+    body:
+      encoding: US-ASCII
+      string: payload=%7B%22username%22%3A%22Event+Data+Agent%22%2C%22icon_url%22%3A%22https%3A%2F%2Fraw.githubusercontent.com%2Fdatacite%2Ftoccatore%2Fmaster%2Flib%2Ftoccatore%2Fimages%2Ftoccatore.png%22%2C%22attachments%22%3A%5B%7B%22title%22%3A%22Report+for+datacite_related%22%2C%22text%22%3A%220+works+found+for+date+range+2015-04-07+-+2015-04-08.%22%2C%22color%22%3A%22warning%22%7D%5D%7D
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/html
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Date:
+      - Wed, 29 Mar 2017 12:32:14 GMT
+      Referrer-Policy:
+      - no-referrer
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Slack-Backend:
+      - h
+      X-Cache:
+      - Miss from cloudfront
+      Via:
+      - 1.1 ffaf96eee86cf7d96c222b2f54e79b63.cloudfront.net (CloudFront)
+      X-Amz-Cf-Id:
+      - sId6-A4zxQG3y6g80-ChvRT3r9j6sEDB7Xk2-YBlPktC2847t3eG2Q==
+    body:
+      encoding: ASCII-8BIT
+      string: ok
+    http_version: 
+  recorded_at: Wed, 29 Mar 2017 12:32:15 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/Toccatore_Base/send_notification_to_slack/orcid_update.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<SLACK_WEBHOOK_URL>"
+    body:
+      encoding: US-ASCII
+      string: payload=%7B%22username%22%3A%22Event+Data+Agent%22%2C%22icon_url%22%3A%22https%3A%2F%2Fraw.githubusercontent.com%2Fdatacite%2Ftoccatore%2Fmaster%2Flib%2Ftoccatore%2Fimages%2Ftoccatore.png%22%2C%22attachments%22%3A%5B%7B%22title%22%3A%22Report+for+orcid_update%22%2C%22text%22%3A%2212+works+processed+for+date+range+2015-04-07+-+2015-04-08.%22%2C%22color%22%3A%22good%22%7D%5D%7D
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/html
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Date:
+      - Wed, 29 Mar 2017 12:32:55 GMT
+      Referrer-Policy:
+      - no-referrer
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Slack-Backend:
+      - h
+      X-Cache:
+      - Miss from cloudfront
+      Via:
+      - 1.1 9ddc180a2ed3a76b4f04630a423d2191.cloudfront.net (CloudFront)
+      X-Amz-Cf-Id:
+      - m83jooakTi1cBV-qNAu3fzsAWk07G1je1icRGbFI2KiYFM34D2Np-w==
+    body:
+      encoding: ASCII-8BIT
+      string: ok
+    http_version: 
+  recorded_at: Wed, 29 Mar 2017 12:32:55 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/Toccatore_Base/send_notification_to_slack/orcid_update_no_works.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<SLACK_WEBHOOK_URL>"
+    body:
+      encoding: US-ASCII
+      string: payload=%7B%22username%22%3A%22Event+Data+Agent%22%2C%22icon_url%22%3A%22https%3A%2F%2Fraw.githubusercontent.com%2Fdatacite%2Ftoccatore%2Fmaster%2Flib%2Ftoccatore%2Fimages%2Ftoccatore.png%22%2C%22attachments%22%3A%5B%7B%22title%22%3A%22Report+for+orcid_update%22%2C%22text%22%3A%220+works+found+for+date+range+2015-04-07+-+2015-04-08.%22%2C%22color%22%3A%22warning%22%7D%5D%7D
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/html
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Date:
+      - Wed, 29 Mar 2017 12:32:57 GMT
+      Referrer-Policy:
+      - no-referrer
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Slack-Backend:
+      - h
+      X-Cache:
+      - Miss from cloudfront
+      Via:
+      - 1.1 116dfe20853b94f9e029d92f1353f8c8.cloudfront.net (CloudFront)
+      X-Amz-Cf-Id:
+      - eAUEy-sXUZzMpWkaWjQ5aSVrAvdRLAm-CBBLqx22pvzfLSeHgsJaog==
+    body:
+      encoding: ASCII-8BIT
+      string: ok
+    http_version: 
+  recorded_at: Wed, 29 Mar 2017 12:32:59 GMT
+recorded_with: VCR 3.0.3