research_metadata_announcement 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff0cd7e7c0d266317baf77bc2a3dcf8d9b302f0e
-  data.tar.gz: fe1ab9987cf4126be7bf6ad1d70803b495db61d4
+  metadata.gz: b4e9c9fd7ba55dbdb831bf9fc25fc4c6df3785ba
+  data.tar.gz: 280d4111796b2ea9ad96b72076891027608bbac2
 SHA512:
-  metadata.gz: f1e53c46bc3f5e19e98515e42d7474ca41dc0a25b87802bdff40d553317f022daf25f8402cc1963eb278afc26eafbcb95b7a8392dd0ba8d887a0978c8beaddd2
-  data.tar.gz: 1ed70c165582d900673e89de96bbcb4add6b3b9ac453ddc2d696fc357231b93bd47be66da261b21630e1f4f1333e39c67b355dc4274a97dc5ae560fdbb60e1cc
+  metadata.gz: 0599597e515308ad7183fddb3d59791fd596c25c5d02bb9dc1c2ec0487241618f957f72765bab6cf4dd293919b4eb77f40ae22913c844e763ee461f4f46cac00
+  data.tar.gz: 4ff2e913fb3b5621226d36b5c429be46fde5e3491df8dc275df97a8fe90ef09b71b5b02bbe0c9a6422898de5a0f45ba9fb584aa1f636479659fe83c6a07ef196

data/CHANGELOG.md

@@ -2,20 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 0.4.2 - 2018-01-18
+## 0.5.0 - 2018-01-11
 ### Changed
-Handle missing resolver in DOI more robustly.
+- For Pure API 59.
 
-## 0.4.1 - 2018-01-17
 ### Added
-- Testing announcements against known live data.
-
-### Fixed
-- Ellipsis after truncated title.
-
-### Changed
-- Handle missing resolver in DOI.
-- Handle full stop in title.
+- Testing against known live data.
 
 ## 0.4.0 - 2017-10-10
 ### Changed

data/README.md

@@ -5,8 +5,7 @@ Metadata extraction from the Pure Research Information System and transformation
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/research_metadata_announcement.svg)](https://badge.fury.io/rb/research_metadata_announcement)
-[![Build Status](https://semaphoreci.com/api/v1/aalbinclark/research_metadata_announcement/branches/master/badge.svg)](https://semaphoreci.com/aalbinclark/research_metadata_announcement)
-[![Code Climate](https://codeclimate.com/github/lulibrary/research_metadata_announcement/badges/gpa.svg)](https://codeclimate.com/github/lulibrary/research_metadata_announcement)
+[![Maintainability](https://api.codeclimate.com/v1/badges/79ba809b90fc85508aa6/maintainability)](https://codeclimate.com/github/lulibrary/research_metadata_announcement/maintainability)
 
 ## Installation
 
@@ -29,18 +28,11 @@ Or install it yourself as:
 Create a hash for passing to a transformer.
 
 ```ruby
-# Pure host with authentication.
 config = {
-  url:      ENV['PURE_URL'],
-  username: ENV['PURE_USERNAME'],
-  password: ENV['PURE_PASSWORD'],
-}
-```
-
-```ruby
-# Pure host without authentication.
-config = {
-  url: ENV['PURE_URL']
+  url:      'https://YOUR_HOST/ws/api/59',
+  username: 'YOUR_USERNAME',
+  password: 'YOUR_PASSWORD',
+  api_key:  'YOUR_API_KEY'
 }
 ```
 
@@ -55,7 +47,7 @@ transformer = ResearchMetadataAnnouncement::Transformer::Dataset.new config
 Give it a Pure identifier and get an announcement.
 
 ```ruby
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
 ```
 
 Optionally, use the ```:composition``` keyword argument to pass in an array of
@@ -88,34 +80,34 @@ Each example uses a different resource for illustrative purposes.
 
 ```ruby
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
 #=> "New journal article. Can poly-parameter linear-free energy relationships (pp-LFERs) improve modelling bioaccumulation in fish? #partitioncoefficients #pplfer. dx.doi.org/10.1016/j.chemosphere.2017.10.007."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', max_length: 140
-#=> "New journal article. The Parting of Burroughs and Ker... #americancounterculture #arthurrimbaud. dx.doi.org/10.1179/1477570013Z.00000000045."
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', max_length: 140
+#=> "New journal article. The Parting of Burroughs and... #americancounterculture #arthurrimbaud. dx.doi.org/10.1179/1477570013Z.00000000045."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :hashtags] # research output has no descriptors
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :hashtags] # research output has no descriptors
 #=> "New conference paper. Deductive and inductive data collection for agent-based modelling."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :keywords, :uri]
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :keywords, :uri]
 #=> "New journal article. Torsion pairs in a triangulated category generated by a spherical object. Auslander–Reiten theory, Calabi–Yau triangulated category. dx.doi.org/10.1016/j.jalgebra.2015.09.011."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :uri]
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :uri]
 #=> "New dataset. Operating Nanobeams in a Quantum Fluid. dx.doi.org/10.17635/lancaster/researchdata/139."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :title]
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :title]
 #=> "dx.doi.org/10.17635/lancaster/researchdata/29. Herpes simplex virus 1 (HSV-1) evolution."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:keywords, :uri]
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:keywords, :uri]
 #=> "smart cities, sustainability. dx.doi.org/10.17635/lancaster/researchdata/35."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:hashtags, :uri]
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:hashtags, :uri]
 #=> "#treatedhypertension #microvascularbloodflow. dx.doi.org/10.17635/lancaster/researchdata/148."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :keywords]
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :keywords]
 #=> "dx.doi.org/10.17635/lancaster/researchdata/134. metagenomics, deep sequencing."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :hashtags], max_descriptors: 4
+transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :hashtags], max_descriptors: 4
 #=> "dx.doi.org/10.17635/lancaster/researchdata/111. #influenza #nasopharynx #virology #virus."
 
 ```

data/lib/research_metadata_announcement.rb

@@ -2,7 +2,7 @@ require 'puree'
 
 require 'research_metadata_announcement/transformer/base'
 require 'research_metadata_announcement/transformer/dataset'
-require 'research_metadata_announcement/transformer/publication'
+require 'research_metadata_announcement/transformer/research_output'
 require 'research_metadata_announcement/version'
 
 # Metadata extraction from the Pure Research Information System and

data/lib/research_metadata_announcement/transformer/base.rb

@@ -6,29 +6,30 @@ module ResearchMetadataAnnouncement
     class Base
 
       # @param config [Hash]
-      # @option config [String] :url The URL of the Pure host.
-      # @option config [String] :username The username of the Pure host account.
-      # @option config [String] :password The password of the Pure host account.
-
+      # @option config [String] :url URL of the Pure host
+      # @option config [String] :username Username of the Pure host account
+      # @option config [String] :password Password of the Pure host account
+      # @option config [String] :api_key API key of the Pure host account
       def initialize(config)
         @config = config
       end
 
-      # @param id [String] Pure ID.
-      # @param uuid [String] Pure UUID.
+      # @param id [String] Pure identifier.
       # @param composition [Array<Symbol>] Metadata presentation sequence e.g. [:new, :title, :hashtags, :uri].
       # @param max_length [Fixnum] Maximum length of announcement.
       # @param max_descriptors [Fixnum] Maximum number of descriptors (common name for keywords, tags, hashtags).
       # @return [String, nil] Announcement returned if the metadata is available and the announcement length does not exceed the max_length argument.
-      def transform(uuid: nil, id: nil, composition: [:new, :title, :hashtags, :uri],
+      def transform(id:, composition: [:new, :title, :hashtags, :uri],
                     max_length: nil, max_descriptors: 2)
         composition.uniq!
-        extract uuid: uuid, id: id
+
+        @resource = @resource_extractor.find id
+
         return nil unless @resource
         if composition.include? :uri
           return nil unless prepare_uri
         end
-        title = remove_full_stop @resource.title
+        title = @resource.title
         keywords = @resource.keywords
 
         # sizing
@@ -38,7 +39,7 @@ module ResearchMetadataAnnouncement
           composition.each do |component|
             case component
               when :new
-                phrase = new_phrase(@resource)
+                phrase =  new_phrase(@resource)
                 chars_needed += phrase.size + chars_component_end
               when :title
                 chars_needed += title.size + chars_component_end
@@ -48,16 +49,10 @@ module ResearchMetadataAnnouncement
                 chars_needed += build_hashtags(keywords, max_descriptors).size + chars_component_end if !keywords.empty?
               when :uri
                 uri = prepare_uri
-                chars_needed += uri.size + chars_component_end if uri
+                chars_needed += uri.size if uri
             end
           end
 
-          # since the arrangement of the composition is unknown, after sizing
-          # chars_needed has two extra spaces allocated
-          # one is used for the terminating full stop
-          # one is not needed
-          chars_needed -= 1
-
           # determine if title needs truncating/removing before combining
           if chars_needed > max_length
             # truncate title
@@ -65,7 +60,7 @@ module ResearchMetadataAnnouncement
               excess_chars = chars_needed - max_length
               truncated_title_length = title.size - excess_chars
               truncated_title_length = 0 if truncated_title_length < 0
-              title = title[0..truncated_title_length - 3].strip + '..'
+              title = title[0..truncated_title_length - 2].strip + '..'
               composition -= [:title] if title.size <= 5 # give up on title if just too small
             end
           end
@@ -104,25 +99,6 @@ module ResearchMetadataAnnouncement
 
       private
 
-      def handle_resolver(uri)
-        return unless uri
-        resolver = 'doi.org'
-        if uri.include? resolver
-          uri
-        else
-          File.join resolver, uri
-        end
-      end
-
-      def remove_full_stop(str)
-        arr = str.split('')
-        if arr.pop == '.' && arr.pop != '.'
-          return str.chomp('.')
-        else
-          return str
-        end
-      end
-
       def new_phrase(resource)
         part_1 = 'New'
         part_2 = ''
@@ -130,7 +106,7 @@ module ResearchMetadataAnnouncement
         case resource.class.to_s
           when 'Puree::Model::Dataset'
             part_2 = 'dataset'
-          when 'Puree::Model::Publication'
+          when 'Puree::Model::ResearchOutput'
             part_2 = resource.type.downcase
         end
         if part_2.empty?
@@ -140,16 +116,8 @@ module ResearchMetadataAnnouncement
         end
       end
 
-      # Extract metadata from Pure
-      #
-      # @param id [String]
-      # @param uuid [String]
-      def extract(uuid: nil, id: nil)
-        if !uuid.nil?
-          @resource = @resource_extractor.find uuid: uuid
-        else
-          @resource = @resource_extractor.find id: id
-        end
+      def prepare_uri
+        strip_uri_scheme @resource.doi if @resource && @resource.doi
       end
 
       def strip_uri_scheme(uri)
@@ -181,7 +149,7 @@ module ResearchMetadataAnnouncement
       end
 
       def make_extractor(resource_type)
-        resource_class = "Puree::Extractor::#{resource_type.capitalize}"
+        resource_class = "Puree::Extractor::#{Puree::Util::String.titleize(resource_type)}"
         @resource_extractor = Object.const_get(resource_class).new @config
       end
 

data/lib/research_metadata_announcement/transformer/dataset.rb

@@ -7,22 +7,12 @@ module ResearchMetadataAnnouncement
     #
     class Dataset < ResearchMetadataAnnouncement::Transformer::Base
 
-      # @param config [Hash]
-      # @option config [String] :url The URL of the Pure host.
-      # @option config [String] :username The username of the Pure host account.
-      # @option config [String] :password The password of the Pure host account.
+      # @option (see ResearchMetadataAnnouncement::Transformer::Base::Resource#initialize)
       def initialize(config)
         super
         make_extractor :dataset
       end
 
-      private
-
-      def prepare_uri
-        uri = strip_uri_scheme @resource.doi if @resource && @resource.doi
-        handle_resolver uri
-      end
-
     end
 
   end

data/lib/research_metadata_announcement/transformer/research_output.rb

@@ -0,0 +1,20 @@
+module ResearchMetadataAnnouncement
+
+  module Transformer
+
+    # Extracts research output metadata from the Pure Research Information System and
+    # converts it into an announcement
+    #
+    class ResearchOutput < ResearchMetadataAnnouncement::Transformer::Base
+
+      # @option (see ResearchMetadataAnnouncement::Transformer::Base::Resource#initialize)
+      def initialize(config)
+        super
+        make_extractor :research_output
+      end
+
+    end
+
+  end
+
+end

data/lib/research_metadata_announcement/version.rb

@@ -1,5 +1,5 @@
 module ResearchMetadataAnnouncement
   # Semantic version number
   #
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/research_metadata_announcement.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.1'
 
-  spec.add_runtime_dependency "puree", "~> 1.4"
+  spec.add_runtime_dependency "puree", "~> 2.0"
 
   spec.add_development_dependency "minitest-reporters", "~> 1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: research_metadata_announcement
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puree
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ files:
 - lib/research_metadata_announcement.rb
 - lib/research_metadata_announcement/transformer/base.rb
 - lib/research_metadata_announcement/transformer/dataset.rb
-- lib/research_metadata_announcement/transformer/publication.rb
+- lib/research_metadata_announcement/transformer/research_output.rb
 - lib/research_metadata_announcement/transformer/transformer.rb
 - lib/research_metadata_announcement/version.rb
 - research_metadata_announcement.gemspec

data/lib/research_metadata_announcement/transformer/publication.rb

@@ -1,30 +0,0 @@
-module ResearchMetadataAnnouncement
-
-  module Transformer
-
-    # Extracts publication metadata from the Pure Research Information System and
-    # converts it into an announcement
-    #
-    class Publication < ResearchMetadataAnnouncement::Transformer::Base
-
-      # @param config [Hash]
-      # @option config [String] :url The URL of the Pure host.
-      # @option config [String] :username The username of the Pure host account.
-      # @option config [String] :password The password of the Pure host account.
-      def initialize(config)
-        super
-        make_extractor :publication
-      end
-
-      private
-
-      def prepare_uri
-        uri = strip_uri_scheme @resource.dois[0] if @resource && @resource.dois[0]
-        handle_resolver uri
-      end
-
-    end
-
-  end
-
-end