uc3-dmp-provenance 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 993e91f781ab200fbc8c0b8c9d1791c6b1199a5b68f2e74431d7776d1e211f31
+  data.tar.gz: e25c780228885022b212f94f5398d9e4db77cf92f0d41e55c26e96646bbe3182
+SHA512:
+  metadata.gz: b5dd9cfcc96c53b2d86f923c742567157ea830285dec38f1417e3fdde349882f375f0808c13f064147426f5274f159d6806029c64d0815371a362bc2cd969d51
+  data.tar.gz: ae2bb06dac1dee500281d3c4c117f9be5926b43901fe45dc1965fc9031921a66b72af346e900c11279c59702e459767307526c4518325901d313f08be7f2b737

data/README.md

@@ -0,0 +1,3 @@
+# Uc3DmpProvenance
+
+Helper methods for working with Provenance JSON records

data/lib/uc3-dmp-provenance/finder.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'uc3-dmp-cognito'
+require 'uc3-dmp-dynamo'
+
+module Uc3DmpProvenance
+  # Standard Error Message from Uc3DmpProvenance
+  class Uc3DmpProvenanceError << StandardError; end
+
+  # Helper for fetching Provenance JSON records
+  class Finder
+    class << self
+      # Get the Provenance item for the Lambda :event
+      #
+      # Expecting the :claims hash from the requestContext[:authorizer] portion of the :event.
+      # It should look something like this:
+      #  {
+      #    "sub": "abcdefghijklmnopqrstuvwxyz",
+      #    "token_use": "access",
+      #    "scope": "https://auth.dmphub-dev.cdlib.org/dev.write",
+      #    "auth_time": "1675895546",
+      #    "iss": "https://cognito-idp.us-west-2.amazonaws.com/us-west-A_123456",
+      #    "exp": "Wed Feb 08 22:42:26 UTC 2023",
+      #    "iat": "Wed Feb 08 22:32:26 UTC 2023",
+      #    "version": "2",
+      #    "jti": "5d3be8a7-c595-1111-yyyy-xxxxxxxxxx",
+      #    "client_id": "abcdefghijklmnopqrstuvwxyz"
+      #  }
+      # -------------------------------------------------------------------------------------------
+      def from_lambda_cotext(identity:)
+        return nil unless identity.is_a?(Hash) && !identity['iss'].nil? && !identity['client_id'].nil?
+
+        client = Uc3DmpDynamo::Client.new
+        client_name = _cognito_client_id_to_name(claim: identity)
+
+        resp = client.get_item(
+          key: { PK: Helper.append_pk_prefix(client_name), SK: Helper::SK_PROVENANCE_PREFIX }
+        )
+        resp.nil? || resp.empty? ? nil : resp
+      end
+
+      # Fetch the Provenance by it's PK.
+      #
+      # Expecting either the name (e.g. `dmptool` or the qualified PK (e.g. `PROVENANCE#dmptool`)
+      def from_pk(pk:)
+        return nil if pk.nil?
+
+        pk = Helper.append_pk_prefix(pk)
+        resp = client.get_item(
+          key: { PK: Helper.append_pk_prefix(pk), SK: Helper::SK_PROVENANCE_PREFIX }
+        )
+        resp.nil? || resp.empty? ? nil : resp
+      end
+
+      private
+
+      # Method to fetch the client's name from the Cognito UserPool based on the client_id
+      def _cognito_client_id_to_name(claim:)
+        return nil if claim.nil? || !claim.is_a?(Hash) || claim['iss'].nil? || claim['client_id'].nil?
+
+        user_pool_id = claim['iss'].split('/').last
+        Uc3DmpCognito.get_client_name(client_id: claim['client_id'])
+      end
+    end
+  end
+end

data/lib/uc3-dmp-provenance/helper.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-cognitoidentityprovider'
+
+module Uc3DmpProvenance
+  # Generic helper methods meant for use by the other classes in this gem.
+  class Helper
+    PK_PROVENANCE_PREFIX = 'PROVENANCE#'
+    SK_PROVENANCE_PREFIX = 'PROFILE'
+
+    DOI_REGEX = %r{[0-9]{2}\.[0-9]{5}/[a-zA-Z0-9/_.-]+}.freeze
+    URL_REGEX = %r{(https?://)?([a-zA-Z0-9\-_]\.)+[a-zA-Z0-9\-_]{2,3}(:[0-9]+)?/?}.freeze
+
+    class << self
+      # Append the PK prefix for the object
+      # -------------------------------------------------------------------------------------
+      def append_pk_prefix(provenance:)
+        provenance.is_a?(String) ? "#{PK_PROVENANCE_PREFIX}#{remove_pk_prefix(provenance: provenance)}" : nil
+      end
+
+      # Strip off the PK prefix
+      # -------------------------------------------------------------------------------------
+      def remove_pk_prefix(provenance:)
+        provenance.is_a?(String) ? provenance.gsub(PK_PROVENANCE_PREFIX, '') : provenance
+      end
+
+      # Appends the Provenance system's identifier to the value
+      #   For a DOI, it will return the DOI as-is
+      #
+      #   For a :provenance whose PK is 'PROVENANCE#example' and homepage is 'https://example.com' and
+      #   callbackUri is 'https://example.com/callback':
+      #     when the :value is '12345', it will return 'example#12345'
+      #     when the :value is 'https://example.com/dmps/12345', it will return 'example#dmp/12345'
+      #     when the :value is 'https://example.com/callback/12345' it will return 'example#12345'
+      #
+      # rubocop:disable Metrics/AbcSize
+      def format_provenance_callback_url(provenance:, value:)
+        # return it as-is if there is no provenance or it's already a URL
+        return value if provenance.nil?
+
+        # return it as-is if it's a DOI
+        doi = value.match(DOI_REGEX).to_s
+        return value unless doi.nil? || doi == '' || !value.start_with?('http')
+
+        # Remove the homepage or callbackUri because we will add this when needed. we just want the id
+        val = value.downcase
+                  .gsub(provenance.fetch('callbackUri', '').downcase, '')
+                  .gsub(provenance.fetch('homepage', '').downcase, '')
+        val = val.gsub(%r{https?://}, '')
+        val = val[1..val.length] if val.start_with?('/')
+        id = provenance['PK']&.gsub(PK_PROVENANCE_PREFIX, '')
+        "#{id}##{val}"
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/uc3-dmp-provenance/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Uc3DmpProvenance
+  VERSION = '0.0.1'
+end

data/lib/uc3-dmp-provenance.rb

@@ -0,0 +1,14 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'json'
+
+require 'uc3-dmp-dynamo'
+
+require 'uc3-dmp-provenance/finder'
+require 'uc3-dmp-provenance/helper'
+
+module Uc3DmpProvenance
+  MSG_PROVENANCE_NOT_FOUND = 'Provenance does not exist.'
+end
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: uc3-dmp-provenance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: uc3-dmp-dynamo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.83'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.83'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+description: Helpers for working with JSON that represents a provenance system (e.g.
+  DMPTool or NIH API)
+email:
+- brian.riley@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/uc3-dmp-provenance.rb
+- lib/uc3-dmp-provenance/finder.rb
+- lib/uc3-dmp-provenance/helper.rb
+- lib/uc3-dmp-provenance/version.rb
+homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-provenance
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: DMPTool gem that provides support for Provenance records
+test_files: []