toccatore 0.3.9 → 0.4.0

data/spec/queque_spec.rb

@@ -0,0 +1,61 @@
+# require 'spec_helper'
+
+# describe Toccatore::UsageUpdate, vcr: true do
+
+#   # let(:queue_url){"https://sqs.#{ENV['AWS_REGION']}.amazonaws.com/404017989009/test_usage"}
+#   # let(:queue_name){:test_usage}
+
+#   # before do
+#   #   # subject.new({:stub_responses => true})
+#   #   body = File.read(fixture_path + 'usage_event.json')
+#   #   result = OpenStruct.new(body: JSON.parse(body) )
+#   #   subject.loopy.stub_responses(:create_queue, queue_url: queue_url)
+#   #   subject.loopy.send_message({queue_url: queue_url, message_body:result.to_json})
+#   # end
+  
+#   context "get_total" do
+#     it "when there are messages" do
+#       puts subject.queue_url
+#       expect(subject.get_total()).to eq(1)
+#     end
+
+#     it "when the queue is empty" do
+#       expect(subject.get_total()).to eq(0)
+#     end
+#   end
+
+#   context "queue_url" do
+#     it "should return always correct queue url" do
+#       puts subject.queue_url
+#       response = subject.queue_url
+#       expect(response).to eq("https://sqs.#{ENV['AWS_REGION']}.amazonaws.com/404017989009/test_usage")
+#     end
+
+#     it "should fail if the queue doesn exist" do
+
+#     end
+#   end
+
+#   context "get_message" do
+#     it "should return one message when there are multiple messages" do
+#       expect(subject.get_message.size).to eq(1)
+#     end
+
+#     it "should return no meessage when the queue is empty" do
+#       expect(subject.get_message.size).to eq(0)
+#     end
+#   end
+
+#   context "delete_message" do
+#     it "should delete a message that exist" do
+#       msg = subject.get_message
+#       response = subject.delete_message msg
+#       expect(response.successful?).to eq(true)
+#     end
+
+#     it "should return an error if a message doesnot exist" do
+
+#     end
+#   end
+
+# end

data/spec/spec_helper.rb

@@ -11,6 +11,8 @@ require 'rack/test'
 require 'webmock/rspec'
 require 'nokogiri'
 require 'vcr'
+require 'aws-sdk-sqs'
+
 
 RSpec.configure do |config|
   config.order = :random
@@ -27,6 +29,18 @@ RSpec.configure do |config|
   config.before do
     ARGV.replace []
   end
+
+  # config.expect_with :rspec do |expectations|
+  #   expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  # end
+
+  # config.mock_with :rspec do |mocks|
+  #   mocks.verify_partial_doubles = true
+  # end
+
+  # config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # Aws.config.update(stub_responses: true)
 end
 
 def fixture_path

data/spec/usage_update_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+describe Toccatore::UsageUpdate, vcr: true do
+
+  let(:queue_url){"https://sqs.#{ENV['AWS_REGION']}.amazonaws.com/404017989009/test_usage"}
+  let(:queue_name){:test_usage}
+  let!(:sqs)     {Aws::SQS::Client.new(region: ENV['AWS_REGION'].to_s, stub_responses: true)}
+  let!(:body)    {File.read(fixture_path + 'usage_event.json')}
+  let!(:message){[body: body]}
+
+  let(:dummy_message){sqs.receive_message(queue_url: queue_url, max_number_of_messages: 1, wait_time_seconds: 1)}
+
+  # context "queue_jobs" do
+  #   it "should report if there are no works returned by the Usage Queue" do
+  #     puts subject.queue_url
+  #     response = subject.queue_jobs
+  #     expect(response).to eq(0)
+  #   end
+  
+  #   it "should report if there are works returned by the Usage Queue" do
+  #     response = subject.queue_jobs
+  #     expect(response).to eq(3)
+  #   end
+  # end
+
+  # context "format_event" do
+  #   it "should report if there are no works returned by the Usage Queue" do
+  #     body = File.read(fixture_path + 'usage_update_nil.json')
+  #     result = OpenStruct.new(body: JSON.parse(body) )
+  #     expect(subject.format_event(result)).to eq([])
+  #   end
+  
+  #   it "should report if there are works returned by the Usage Queue" do
+  #     body = File.read(fixture_path + 'usage_update.json')
+  #     result = OpenStruct.new(body: JSON.parse(body) )
+  #     expect(subject.format_event(result).length).to eq(40)
+  #   end
+  # end
+
+  describe "get_data" do
+    context "when there are messages" do
+      it "should return the data for one message" do
+        sqs.stub_responses(:receive_message, messages: message)
+        sqs.stub_responses(:receive_message, messages: message)
+        sqs.stub_responses(:receive_message, messages: message)
+        sqs.stub_responses(:receive_message, messages: message)
+        response = sqs.receive_message({queue_url: queue_url})
+        response = subject.get_data(response)
+        expect(response.body["data"]["report"]["report-header"]["report-name"]).to eq("Dataset Master Report")
+      end
+    end
+
+    context "when there is ONE message" do
+      it "should return the data for one message" do
+        sqs.stub_responses(:receive_message, messages: message)
+        response = sqs.receive_message({queue_url: queue_url})
+        response = subject.get_data(response)
+        expect(response.body["data"]["report"]["report-header"]["report-name"]).to eq("Dataset Master Report")
+      end
+    end
+
+    context "when there are NOT messages" do
+      it "should return empty" do
+        sqs.stub_responses(:receive_message, messages: [])
+        response = sqs.receive_message({queue_url: queue_url})
+        response = subject.get_data(response)
+        expect(response.body["errors"]).to eq("Queue is empty")
+      end
+    end
+  end
+
+  describe "parse_data" do
+    context "when the usage event was NOT found" do
+      it "should return errors" do
+        body = File.read(fixture_path + 'usage_update_nil.json')
+        result = OpenStruct.new(body:  JSON.parse(body) )
+        expect(subject.parse_data(result)).to eq([{"status"=>"404", "title"=>"The resource you are looking for doesn't exist."}])
+      end
+    end
+
+    context "when the usage report was NOT found" do
+      it "should return errors" do
+        body = File.read(fixture_path + 'usage_update_nil.json')
+        result = OpenStruct.new(body:  JSON.parse(body) )
+        expect(subject.parse_data(result)).to eq([{"status"=>"404", "title"=>"The resource you are looking for doesn't exist."}])
+      end
+    end
+
+    context "when the report was found" do
+      it "should parsed it correctly" do
+        body = File.read(fixture_path + 'usage_update.json')
+        result = OpenStruct.new(body: JSON.parse(body) )
+        response = subject.parse_data(result, source_token: ENV['SOURCE_TOKEN'])
+        expect(response.length).to eq(2)
+        expect(response.last.except("id")).to eq("subj"=>{"pid"=>"https://metrics.test.datacite.org/reports/2018-3-Dash", "issued"=>"2128-04-09"},"total"=>3,"message-action" => "add", "subj-id"=>"https://metrics.test.datacite.org/reports/2018-3-Dash", "obj-id"=>"https://doi.org/10.7291/d1q94r", "relation-type-id"=>"unique-dataset-investigations-regular", "source-id"=>"datacite-usage", "occurred-at"=>"2128-04-09", "license" => "https://creativecommons.org/publicdomain/zero/1.0/", "source-token" => "28276d12-b320-41ba-9272-bb0adc3466ff")
+      end
+
+      it "should parsed it correctly when it has five metrics  and two DOIs" do
+        body = File.read(fixture_path + 'usage_update_3.json')
+        result = OpenStruct.new(body: JSON.parse(body) )
+        response = subject.parse_data(result, source_token: ENV['SOURCE_TOKEN'])
+        expect(response.length).to eq(5)
+        expect(response.last.except("id")).to eq("message-action"=>"add", "subj-id"=>"https://metrics.test.datacite.org/reports/2018-3-Dash", "subj"=>{"pid"=>"https://metrics.test.datacite.org/reports/2018-3-Dash", "issued"=>"2128-04-09"}, "total"=>208, "obj-id"=>"https://doi.org/10.6071/z7wc73", "relation-type-id"=>"Unique-Dataset-Requests-Machine", "source-id"=>"datacite-usage", "source-token"=>"28276d12-b320-41ba-9272-bb0adc3466ff", "occurred-at"=>"2128-04-09", "license"=>"https://creativecommons.org/publicdomain/zero/1.0/")
+      end
+
+      it "should parsed it correctly when it has two metrics per DOI " do
+        body = File.read(fixture_path + 'usage_update_2.json')
+        result = OpenStruct.new(body: JSON.parse(body) )
+        response = subject.parse_data(result, source_token: ENV['SOURCE_TOKEN'])
+        expect(response.length).to eq(4)
+        expect(response.last.except("id")).to eq("message-action"=>"add", "subj-id"=>"https://metrics.test.datacite.org/reports/2018-3-Dash", "subj"=>{"pid"=>"https://metrics.test.datacite.org/reports/2018-3-Dash", "issued"=>"2128-04-09"}, "total"=>208, "obj-id"=>"https://doi.org/10.6071/z7wc73", "relation-type-id"=>"Unique-Dataset-Requests-Machine", "source-id"=>"datacite-usage", "source-token"=>"28276d12-b320-41ba-9272-bb0adc3466ff", "occurred-at"=>"2128-04-09", "license"=>"https://creativecommons.org/publicdomain/zero/1.0/")
+      end
+
+      it "should send a warning if there are more than 4 metrics" do
+        body = File.read(fixture_path + 'usage_update_1.json')
+        result = OpenStruct.new(body: JSON.parse(body) )
+        response = subject.parse_data(result, source_token: ENV['SOURCE_TOKEN'])
+        expect(response.length).to eq(1)
+        expect(response.last.body).to eq({"errors"=>"There are too many instances. There can only be 4"})
+      end
+    end
+  end
+
+  context "push_data" do
+    it "should report if there are no works returned by the Queue" do
+      result = []
+      expect { subject.push_data(result) }.to output("No works found in the Queue.\n").to_stdout
+    end
+
+    # it "should report if there are works returned by the Queue" do
+    #   body = File.read(fixture_path + 'usage_update.json')
+    #   result = OpenStruct.new(body:  JSON.parse(body) )
+    #   result = subject.parse_data(result, source_token: ENV['SOURCE_TOKEN'])
+    #   options = { push_url: ENV['EVENTDATA_URL'], access_token: ENV['EVENTDATA_TOKEN'] }
+    #   expect { subject.push_data(result, options) }.to output(/https:\/\/doi.org\/10.15468\/dl.mb4das references https:\/\/doi.org\/10.3897\/phytokeys.12.2849 pushed to Event Data service.\n/).to_stdout
+    # end
+
+    it "should work with DataCite Event Data" do
+      body = File.read(fixture_path + 'usage_update.json')
+      result = OpenStruct.new(body: JSON.parse(body) )
+      expect = File.read(fixture_path + 'event_data_resp_1')
+      result = subject.parse_data(result, source_token: ENV['SOURCE_TOKEN'])
+      options = { push_url: ENV['LAGOTTINO_URL'], access_token: ENV['LAGOTTO_TOKEN'], jsonapi: true }
+      expect { subject.push_data(result, options) }.to output(expect).to_stdout
+    end
+
+    it "should fail if format of the event is wrong" do
+      body = File.read(fixture_path + 'usage_events.json')
+      expect = File.read(fixture_path + 'event_data_resp_2')
+      result = JSON.parse(body)
+      options = { push_url: ENV['LAGOTTINO_URL'], access_token: ENV['LAGOTTO_TOKEN'], jsonapi: true }
+      expect { subject.push_data(result, options) }.to output(expect).to_stdout
+    end
+  end
+
+end

data/toccatore.gemspec

@@ -15,13 +15,15 @@ Gem::Specification.new do |s|
   s.license       = 'MIT'
 
   # Declary dependencies here, rather than in the Gemfile
+  
   s.add_dependency 'maremma', '~> 3.5'
   s.add_dependency 'activesupport', '~> 4.2', '>= 4.2.5'
   s.add_dependency 'dotenv', '~> 2.1', '>= 2.1.1'
   s.add_dependency 'namae', '~> 0.11.0'
   s.add_dependency 'gender_detector', '~> 1.0'
   s.add_dependency 'thor', '~> 0.19'
-  s.add_dependency 'slack-notifier', '~> 2.1'
+  s.add_dependency 'slack-notifier', '= 2.2.2'
+  s.add_dependency 'aws-sdk-sqs'
   s.add_development_dependency 'bundler', '~> 1.0'
   s.add_development_dependency 'rspec', '~> 3.4'
   s.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toccatore
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin Fenner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: maremma
@@ -110,16 +110,30 @@ dependencies:
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -273,6 +287,8 @@ files:
 - lib/toccatore/datacite_related.rb
 - lib/toccatore/images/toccatore.png
 - lib/toccatore/orcid_update.rb
+- lib/toccatore/queue.rb
+- lib/toccatore/usage_update.rb
 - lib/toccatore/version.rb
 - spec/base_spec.rb
 - spec/cli_spec.rb
@@ -280,11 +296,22 @@ files:
 - spec/fixtures/datacite_related.json
 - spec/fixtures/datacite_related_is_identical.json
 - spec/fixtures/datacite_related_nil.json
+- spec/fixtures/event_data_resp_1
+- spec/fixtures/event_data_resp_2
 - spec/fixtures/orcid_update.json
 - spec/fixtures/orcid_update_is_identical.json
 - spec/fixtures/orcid_update_is_part.json
 - spec/fixtures/orcid_update_is_previous.json
 - spec/fixtures/orcid_update_nil.json
+- spec/fixtures/usage_event.json
+- spec/fixtures/usage_event_fail.json
+- spec/fixtures/usage_events.json
+- spec/fixtures/usage_update.json
+- spec/fixtures/usage_update_1.json
+- spec/fixtures/usage_update_2.json
+- spec/fixtures/usage_update_3.json
+- spec/fixtures/usage_update_4.json
+- spec/fixtures/usage_update_nil.json
 - spec/fixtures/vcr_cassettes/Toccatore_Base/get_doi_ra/crossref.yml
 - spec/fixtures/vcr_cassettes/Toccatore_Base/get_doi_ra/datacite.yml
 - spec/fixtures/vcr_cassettes/Toccatore_Base/send_notification_to_slack/datacite_related.yml
@@ -301,6 +328,9 @@ files:
 - spec/fixtures/vcr_cassettes/Toccatore_CLI/orcid_update/should_query_by_ORCID_ID.yml
 - spec/fixtures/vcr_cassettes/Toccatore_CLI/orcid_update/should_succeed.yml
 - spec/fixtures/vcr_cassettes/Toccatore_CLI/orcid_update/should_succeed_with_no_works.yml
+- spec/fixtures/vcr_cassettes/Toccatore_CLI/usage_update/no_reports_in_the_queue/should_succeed_with_no_works.yml
+- spec/fixtures/vcr_cassettes/Toccatore_CLI/usage_update/should_fail.yml
+- spec/fixtures/vcr_cassettes/Toccatore_CLI/usage_update/should_succeed_with_no_works.yml
 - spec/fixtures/vcr_cassettes/Toccatore_DataciteRelated/get_data/should_allow_queries_by_DOI_of_the_Datacite_Metadata_Search_API.yml
 - spec/fixtures/vcr_cassettes/Toccatore_DataciteRelated/get_data/should_allow_queries_by_related_identifier_of_the_Datacite_Metadata_Search_API.yml
 - spec/fixtures/vcr_cassettes/Toccatore_DataciteRelated/get_data/should_report_if_there_are_no_works_returned_by_the_Datacite_Metadata_Search_API.yml
@@ -320,8 +350,14 @@ files:
 - spec/fixtures/vcr_cassettes/Toccatore_OrcidUpdate/push_data/should_report_if_there_are_works_returned_by_the_Datacite_Metadata_Search_API.yml
 - spec/fixtures/vcr_cassettes/Toccatore_OrcidUpdate/queue_jobs/should_report_if_there_are_no_works_returned_by_the_Datacite_Metadata_Search_API.yml
 - spec/fixtures/vcr_cassettes/Toccatore_OrcidUpdate/queue_jobs/should_report_if_there_are_works_returned_by_the_Datacite_Metadata_Search_API.yml
+- spec/fixtures/vcr_cassettes/Toccatore_UsageUpdate/get_data/when_there_are_messages/should_return_the_data_for_one_message.yml
+- spec/fixtures/vcr_cassettes/Toccatore_UsageUpdate/get_data/when_there_is_ONE_message/should_return_the_data_for_one_message.yml
+- spec/fixtures/vcr_cassettes/Toccatore_UsageUpdate/push_data/should_fail_if_format_of_the_event_is_wrong.yml
+- spec/fixtures/vcr_cassettes/Toccatore_UsageUpdate/push_data/should_work_with_DataCite_Event_Data.yml
 - spec/orcid_update_spec.rb
+- spec/queque_spec.rb
 - spec/spec_helper.rb
+- spec/usage_update_spec.rb
 - toccatore.gemspec
 homepage: https://github.com/datacite/toccatore
 licenses:
@@ -343,7 +379,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby library to find ORCID IDs in the DataCite Solr index