uc3-dmp-external-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f1ba261082e6ae6433baff78ec825e20d2ef45eed27da85fdf39eb9521ea5cd
+  data.tar.gz: 18c36e8a2561f4b659299afea146ef9cff81936b9e5a69eba76dcc04bed5f5d8
+SHA512:
+  metadata.gz: 46402162efcd0f607d0b1d54391f79a383fda98f4df86ca7b72f548cf931049aecb21d41d08e695214294201b3e8635bfe7534b3967f26ea7d25359554310a16
+  data.tar.gz: 0edf9e90f3678ad22119d8c70c19be5b90f9f236d62e22bf0753de5c489ea3d8544960f9815e427ce3183fd5125273d47786026befb2608275288654b7055fc8

data/README.md

@@ -0,0 +1,3 @@
+# uc3-dmp-external-api
+
+Helper methods for communicating with external systems.

data/lib/uc3-dmp-external-api/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+require 'uri'
+
+module Uc3DmpExternalApi
+  # Error from the External API
+  class ExternalApiError < StandardError; end
+
+  # Helper class for communicating with external APIs
+  class Client
+    MSG_ERROR_FROM_EXTERNAL_API = 'Received an error from %<url>s'
+    MSG_HTTPARTY_ERR = 'HTTParty failure when trying to call %<url>s'
+    MSG_INVALID_URI = '%<url>s is an invalid URI'
+    MSG_UNABLE_TO_PARSE = 'Unable to parse the response from %<url>s'
+
+    class << self
+      # Call the specified URL using the specified HTTP method, body and headers
+      # rubocop:disable Metrics/AbcSize
+      def call(url:, method: :get, body: '', additional_headers: {}, debug: false)
+        uri = URI(url)
+        # Skip the body if we are doing a get
+        body = nil if method.to_sym == :get
+        opts = _options(body: body, additional_headers: additional_headers, debug: debug)
+        resp = HTTParty.send(method.to_sym, uri, opts)
+
+        if resp.code != 200
+          msg = "status: #{resp&.code}, body: #{resp&.body}"
+          raise ExternalApiError, "#{format(MSG_ERROR_FROM_EXTERNAL_API, url: url)} - #{msg}"
+        end
+        resp.body.nil? || resp.body.empty? ? nil : _process_response(resp)
+      rescue JSON::ParserError
+        raise ExternalApiError, format(MSG_UNABLE_TO_PARSE, url: url)
+      rescue HTTParty::Error => e
+        raise ExternalApiError, "#{format(MSG_HTTPARTY_ERR, url: url)} - #{e.message}"
+      rescue URI::InvalidURIError
+        raise ExternalApiError, format(MSG_INVALID_URI, url: url)
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      # # Handle the response body based on the Content-Type
+      def _process_response(resp:)
+        return nil unless resp.nil? || resp.body.nil?
+
+        case resp.headers.fetch('content-type', '')
+        when 'application/json'
+          JSON.parse(resp.body)
+        else
+          resp.body.to_s
+        end
+      end
+
+      # Prepare the headers
+      def _headers(additional_headers: {})
+        domain = ENV['DOMAIN'].nil? ? 'dmptool.org' : ENV['DOMAIN']
+        email = ENV['ADMIN_EMAIL'].nil? ? 'dmptool@ucop.edu' : ENV['ADMIN_EMAIL']
+        base = {
+          'Content-Type': 'application/json',
+          Accept: 'application/json',
+          'User-Agent': "DMPTool #{ENV.fetch('LAMBDA_ENV', nil)} - #{domain} (mailto: #{email})"
+        }
+        base.merge(additional_headers)
+      end
+
+      # Prepare the HTTParty gem options
+      def _options(body:, additional_headers: {}, debug: false)
+        hdrs = _headers(additional_headers: additional_headers)
+        opts = {
+          headers: hdrs,
+          follow_redirects: true,
+          limit: 6
+        }
+        # If the body is not already JSON and we intend to send JSON, convert it
+        opts[:body] = body.is_a?(Hash) && hdrs['Content-Type'] == 'application/json' ? body.to_json : body
+        # If debug is enabled then tap into the HTTParty gem's debug option
+        opts[:debug_output] = $stdout if debug
+        opts
+      end
+    end
+  end
+end

data/lib/uc3-dmp-external-api/version.rb

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

data/lib/uc3-dmp-external-api.rb

@@ -0,0 +1,12 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'aws-sdk-sns'
+require 'aws-sdk-ssm'
+
+require 'uc3-dmp-external-api/client'
+
+# RDS Database adapter
+module Uc3DmpExternalApi
+end
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: uc3-dmp-external-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_record_simple_execute
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.150'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.150'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !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-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+- !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 communicating with external systems in a standardized way
+email:
+- brian.riley@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/uc3-dmp-external-api.rb
+- lib/uc3-dmp-external-api/client.rb
+- lib/uc3-dmp-external-api/version.rb
+homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-external-api
+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 general support for accessing external APIs
+test_files: []