scholarsphere-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b082e1c474c137dd8202b5ae6666eb73938f9b1bd806f053308a715272c28f
-  data.tar.gz: c94c0532b48c3b0f9f3b9918f01275a572f75a8ff3f7d5112837b7fd78e474ad
+  metadata.gz: 8ab004f36213538c0e74821396c0499a52f08a24c8a8d7f450b3c224a0b71a8d
+  data.tar.gz: 84788832717be95ff66b8def2433633fc41a82aa85e4b204d1750814b8fa4bb4
 SHA512:
-  metadata.gz: 517ddf088ccad9da2fbdae7b0d674c3017c5085e850d568f23fa0eaff95899e4bfe728de6f144f2480d09d65025801c22e0929eeb60bf3548c7613e041b40cb8
-  data.tar.gz: a7b2df6784f547a3ceb9b9de3e82497398e76b794dfe0fe22cdbbc6214e7a068940b8df7957195b61a417f9f8d4f4b1dd115693630467661b821907675b32b94
+  metadata.gz: 45c9c56b6f2db7ed715a595b9d5533ddba125b0a63d7b2d694669105c50b65e19c66b70814add3921b1d1fc83ef1ebc6592488641206c1eef1ef21c331d9649c
+  data.tar.gz: c7d927e3d027ecdf2b204f350b0758b353d0b161e285b795111174deca41951c2ca8f5642cc6461852b831cd6a1c890febb5083730b08b3360358fbbf902c574

data/.circleci/config.yml

@@ -0,0 +1,40 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2 
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: "Install Dependencides"
+          command: gem install bundler:2.1.4 && bundle install
+      - run:
+          name: "Rubocop"
+          command: bundle exec rubocop
+      - run:
+          name: "RSpec"
+          command: bundle exec rspec
+          environment:
+            SS4_ENDPOINT: "https://scholarsphere.test/api/v1"
+      - run:
+          name: "Copy VCR Logs"
+          when: on_fail
+          command: cp vcr.log /tmp/vcr.log
+      - run:
+          name: "Upload Coverage"
+          when: on_success
+          command: |
+            wget -q https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 -O cc-test-reporter
+            chmod 755 cc-test-reporter
+            export TAG=${CIRCLE_SHA1}
+            export GIT_COMMIT_SHA=$CIRCLE_SHA1
+            export GIT_BRANCH=$CIRCLE_BRANCH
+            export GIT_COMMITED_AT=$(git log -1 --date=short --pretty=format:%ct)
+            ./cc-test-reporter after-build -d
+      - store_artifacts:
+          path: /tmp/vcr.log
+          destination: VCR

data/.gitignore

@@ -12,4 +12,4 @@
 
 # Ignore application configuration
 /config/scholarsphere-client.yml
-Gemfile.lock
+vcr.log

data/.rubocop.yml

@@ -11,3 +11,6 @@ Metrics/BlockLength:
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'scholarsphere-client.gemspec'
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/Gemfile.lock

@@ -0,0 +1,204 @@
+PATH
+  remote: .
+  specs:
+    scholarsphere-client (0.2.0)
+      aws-sdk-s3 (~> 1.49)
+      faraday (> 0.12)
+      marcel (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (6.1.1)
+      activesupport (= 6.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.322.0)
+    aws-sdk-core (3.97.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.32.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.67.0)
+      aws-sdk-core (~> 3, >= 3.96.1)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.4)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    better_html (1.0.15)
+      actionview (>= 4.0)
+      activesupport (>= 4.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      html_tokenizer (~> 0.0.6)
+      parser (>= 2.4)
+      smart_properties
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.7)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    diff-lcs (1.3)
+    docile (1.3.5)
+    erb_lint (0.0.37)
+      activesupport
+      better_html (~> 1.0.7)
+      html_tokenizer
+      parser (>= 2.7.1.4)
+      rainbow
+      rubocop
+      smart_properties
+    erubi (1.10.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.14.2)
+    hashdiff (1.0.1)
+    html_tokenizer (0.0.7)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    json (2.5.1)
+    loofah (2.8.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    multipart-post (2.1.1)
+    niftany (0.8.0)
+      colorize (~> 0.8.1)
+      erb_lint (~> 0.0.22)
+      rubocop (~> 0.79)
+      rubocop-performance (~> 1.1)
+      rubocop-rails (~> 2.3)
+      rubocop-rspec (~> 1.3)
+      scss_lint (~> 0.55)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    ruby-progressbar (1.11.0)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    scss_lint (0.59.0)
+      sass (~> 3.5, >= 3.5.5)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    smart_properties (1.15.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
+    webmock (3.11.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  niftany (~> 0.6)
+  pry (~> 0.12)
+  pry-byebug (~> 3.9)
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+  rspec-its (~> 1.3)
+  scholarsphere-client!
+  simplecov (< 0.18)
+  vcr (~> 6.0)
+  webmock (~> 3.11)
+  yard (< 1.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -20,8 +20,60 @@ Or install it yourself as:
 
 ## Usage
 
-You can read the [ruby docs](https://www.rubydoc.info/gems/scholarsphere-client) for the latest features.
+### Authentication
 
-**Warning!**
+Obtain an api key, and save it to `config/scholarsphere-client.yml`
 
-This is not yet in 1.0 status and features will change without the customary deprecation warnings.
+    SS4_ENDPOINT:  "http://scholarsphere/api/v1"
+    SS_CLIENT_KEY: "[key]"
+
+If you are using a testing instance, you'll need to disable ssl verification:
+    
+    SS_CLIENT_SSL: "false"
+
+### Ingesting
+
+To publish a work:
+
+    metadata = {
+      title: "My Awesome Work",
+      creators_attributes: [
+        {
+          display_name: 'Dr. Pat Researcher',
+          actor_attributes: {
+            psu_id: 'pxr123',
+            surname: 'Researcher',
+            given_name: 'Pat',
+            email: 'pxr123@psu.edu'
+          }
+        }
+      ]
+    }
+
+    files = [ File.new('path/to/file') ]
+
+    depositor = {
+      psu_id: 'pxr123',
+      surname: 'Researcher',
+      given_name: 'Pat',
+      email: 'pxr123@psu.edu'
+    }
+
+    ingest = Scholarsphere::Client::Ingest.new(
+      metadata: metadata,
+      files: files,
+      depositor: depositor
+    )
+
+    response = ingest.publish
+
+    puts response.body
+
+    { 
+      "message": "Work was successfully created",
+      "url": "/resources/0797e99c-7d4f-4e05-8bf6-86aea1029a6a"
+    }
+
+## Documentation
+
+You can read the [ruby docs](https://www.rubydoc.info/github/psu-stewardship/scholarsphere-client/main) for the latest features.

data/lib/scholarsphere/client.rb

@@ -7,6 +7,7 @@ require 'scholarsphere/s3'
 require 'scholarsphere/client/config'
 require 'scholarsphere/client/ingest'
 require 'scholarsphere/client/collection'
+require 'scholarsphere/client/upload'
 require 'scholarsphere/client/version'
 
 module Scholarsphere
@@ -16,6 +17,7 @@ module Scholarsphere
     Config.load_defaults
 
     class << self
+      # @return [Faraday::Connection] A cached connection to the Scholarsphere API with the provided credentials.
       def connection
         @connection ||= Faraday::Connection.new(
           url: ENV['SS4_ENDPOINT'],
@@ -27,10 +29,18 @@ module Scholarsphere
         )
       end
 
+      # @return [nil] Resets the client connection when needed.
+      def reset
+        @connection = nil
+      end
+
+      # @return [TrueClass, FalseClass] If set to 'false', Faraday will not verify the SSL certificate. This is mostly
+      #   used for testing. Default is 'true'.
       def verify_ssl?
         ENV['SS_CLIENT_SSL'] != 'false'
       end
 
+      # @return [String] Alphanumeric API key that grants access to the API.
       def api_key
         ENV['SS_CLIENT_KEY']
       end

data/lib/scholarsphere/client/config.rb

@@ -7,11 +7,16 @@ module Scholarsphere
     # Loads the yaml configuration file for the client. The default location is `config/scholarsphere-client.yml` and
     # the client will load this file automatically whenever it is invoked.
     #
-    # The configuration file should contain the endpoint of the Scholarsphere API.
+    # The configuration file should contain the endpoint of the Scholarsphere API and the API key.
     #
-    # # Example
+    # ## Required
     #
-    #     SS4_ENDPOINT: "http://scholarsphere.psu.edu/api/v1"
+    #     SS4_ENDPOINT:   "https://scholarsphere.psu.edu/api/v1"
+    #     SS_CLIENT_KEY:  "[key]"
+    #
+    # ## Optional
+    #
+    #     SS_CLIENT_SSL:  "false"
     #
     class Config
       # @private

data/lib/scholarsphere/client/ingest.rb

@@ -2,12 +2,98 @@
 
 module Scholarsphere
   module Client
+    ##
+    #
+    # Uploads a complete work into Scholarsphere. If successful, the work will be published and made
+    # publicly available.
+    #
+    # ## Publishing a New Work
+    #
+    # The most common use case is uploading a single file with the required metadata:
+    #
+    #     ingest = Scholarsphere::Client::Ingest.new(
+    #       metadata: metadata,
+    #       files: files,
+    #       depositor: depositor
+    #     )
+    #     response = ingest.publish
+    #
+    # If the response is successful, the application returns 200 OK with JSON:
+    #
+    #     puts response.body
+    #     {
+    #       "message": "Work was successfully created",
+    #       "url": "/resources/0797e99c-7d4f-4e05-8bf6-86aea1029a6a"
+    #     }
+    #
+    # Other possible outcomes include:
+    #
+    #   * work was created, but not successfully published because of missing attributes (201 Created)
+    #   * work could not be created due to insufficient parameters (422 Unprocessable Entity)
+    #   * there was an error with the application (500 Internal Server Error)
+    #
+    # If possible, the response will include additional information about which errors occurred and which attributes are
+    # required or are incorrect.
+    #
+    # ## Metadata
+    #
+    # A hash of descriptive metadata about the work. The minimal amount required in order to publish would be:
+    #
+    #     {
+    #       title: "[descriptive title of the work]",
+    #       creators_attributes: [
+    #         {
+    #           display_name: '[Penn State Person]',
+    #           actor_attributes: {
+    #             psu_id: 'abc123',
+    #             surname: '[family name]',
+    #             given_name: '[given name]',
+    #             email: 'abc123@psu.edu'
+    #           }
+    #         }
+    #       ]
+    #     }
+    #
+    # For a complete listing of all the possible metadata values, see the OpenAPI docs for
+    # Scholarsphere.
+    #
+    # ## Files
+    #
+    #     [
+    #       Pathname.new('MyPaper.pdf'),
+    #       Pathname.new('dataset.dat')
+    #     ]
+    #
+    # One or more files are required in order for the work be published. The simplest method is an array of `IO`
+    # objects. The client then uploads them into S3.
+    #
+    # *Note: All filenames must have an extension!*
+    #
+    # ## Depositor
+    #
+    #     {
+    #       psu_id: '[Penn State Person]',
+    #       surname: '[family name]',
+    #       given_name: '[given name]',
+    #       email: 'abc123@psu.edu'
+    #     }
+    #
+    # Currently, the person identified as the depositor must have an active access account at Penn State. In most cases,
+    # the depositor will be the same person as the creator specified in the metadata; although, this is not always the
+    # case.  The depositor may be someone who is uploading on behalf of the creator and is not affiliated with the
+    # creation of the work. The depositor is *not* the client itself, either. The client is identified separately via
+    # the API token.
+    #
+    # Note that the fields are the same for both `creators_attributes` and `depositor`, so if the depositor is the same
+    # as the creator, all the values will need to be duplicated.
+    #
+    #
     class Ingest
       attr_reader :content, :metadata, :depositor, :permissions
 
       # @param metadata [Hash] Metadata attributes
       # @param files [Array<File,IO,Pathnme>,Hash] An array of File or IO objects, or a hash with a :file param
-      # @param depositor [String] The access ID of the depositor
+      # @param depositor [Hash] The name and access id of the depositor
       # @param permissions [Hash] (optional) Additional permissions to apply to the resource
       def initialize(metadata:, files:, depositor:, permissions: {})
         @content = build_content_hash(files)
@@ -16,6 +102,7 @@ module Scholarsphere
         @permissions = permissions
       end
 
+      # @return [Faraday::Response] The response from the Scholarsphere application.
       def publish
         upload_files
         connection.post do |req|
@@ -29,24 +116,20 @@ module Scholarsphere
         def build_content_hash(files)
           files.map do |file|
             if file.is_a?(Hash)
-              file.merge(file: S3::UploadedFile.new(file.fetch(:file)))
+              file.merge(file: S3::UploadedFile.new(source: file.fetch(:file)))
             else
-              { file: S3::UploadedFile.new(file) }
+              { file: S3::UploadedFile.new(source: file) }
             end
           end
         end
 
         def upload_files
           content.map do |file_parameters|
-            uploader.upload(file_parameters.fetch(:file))
-            file_parameters[:file] = file_parameters[:file].to_shrine.to_json
+            S3::Uploader.new(file: file_parameters.fetch(:file)).upload
+            file_parameters[:file] = file_parameters[:file].to_param.to_json
           end
         end
 
-        def uploader
-          @uploader ||= S3::Uploader.new
-        end
-
         def connection
           Scholarsphere::Client.connection
         end

data/lib/scholarsphere/client/upload.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Scholarsphere
+  module Client
+    ##
+    #
+    # Requests a pre-signed url, id, and prefix from Scholarsphere for uploading a given file. In order to generate a
+    # correct path, the file's extension name is required for the request. The url is used to upload the file's binary
+    # content into Scholarsphere, while the id and key are used when adding the file to a work.
+    #
+    class Upload
+      # @param extname [String] Extension of the file to be uploaded, without the period, such as 'pdf'
+      def initialize(extname:)
+        @extname = extname
+      end
+
+      # @return [String] Prefix where the file is stored in the S3 bucket.
+      def prefix
+        data['prefix']
+      end
+
+      # @return [String] URL for uploading the file into AWS.
+      def url
+        data['url']
+      end
+
+      # @return [String] A unique identifier for the file which will serve as its name in S3.
+      def id
+        data['id']
+      end
+
+      private
+
+        attr_reader :extname
+
+        def request
+          @request ||= Scholarsphere::Client.connection.post do |req|
+            req.url 'uploads'
+            req.body = { extension: extname }.to_json
+          end
+        end
+
+        def data
+          @data ||= begin
+                      raise Client::Error unless request.success?
+
+                      JSON.parse(request.body)
+                    end
+        end
+    end
+  end
+end

data/lib/scholarsphere/client/version.rb

@@ -2,6 +2,6 @@
 
 module Scholarsphere
   module Client
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/scholarsphere/s3/uploaded_file.rb

@@ -4,10 +4,10 @@ module Scholarsphere
   module S3
     ##
     #
-    # Represents a file on the client's file system that will be uploaded, but hasn't been yet. The object is
-    # constructed using a pathname for the file, and if desired, a checksum. The checksum is not required, and if it is
-    # not provided, the client will calculate one. Once initialized, the uploaded file object can be used by the client
-    # to make additional calls to the application.
+    # Represents a file on the client's file system to be uploaded into Scholarsphere. The object is constructed using a
+    # pathname for the file, and an optional checksum.  Once initialized, the object is used by the client to make
+    # additional calls to the application, including uploading the file into S3, and adding the resulting uploaded file
+    # to a work in Scholarsphere.
     #
     # ## Examples
     #
@@ -16,46 +16,38 @@ module Scholarsphere
     #     pathname = Pathname.new('path/to/your/file')
     #     uploaded_file = UploadedFile.new(pathname)
     #
-    # If the file is large, then calculating a checksum could be time-intensive. Providing one can avoid that. Or, if
+    # If the file is large, then calculating a checksum could be time-intensive. Providing one can avoid that, or, if
     # you already have a checksum from a trusted source, you can pass that along for the client to use:
     #
     #     uploaded_file = UploadedFile.new(pathname, checksum: '[md5 checksum hash]')
     #
+    # ## Checksum Verification
+    #
+    # Checksums are always used. If you don't provide one, the client will calculate one for you and use it when
+    # uploading the file, such as with S3::Uploader. AWS uses the provided checksum to verify the file's integrity, and
+    # if that check fails, an exception is raised. This avoids the prospect that the file could be corrupted during its
+    # transfer from the local client's filesystem into S3.
+    #
     class UploadedFile
-      # @return [Pathname] The location of the file to be uploaded
+      # @return [Pathname] The file to be uploaded on the client's filesystem
       attr_reader :source
 
-      # @param source [Pathname] The file to be uploaded
-      # @param options [Hash]
-      # @option options [String] :checksum The file's md5 checksum. If one is not provided, it will be calculated at
-      #   upload
-      def initialize(source, options = {})
-        @source = source
-        @checksum = options[:checksum]
+      # @param source [Pathname, File, IO, String] Object or path to the file
+      # @param checksum [String] Optional md5 checksum of the file
+      def initialize(source:, checksum: nil)
+        @source = Pathname.new(source)
+        @checksum = checksum
       end
 
-      # @return [Hash] Set of metadata needed by Shrine to upload the file
-      # @note this can be passed to a controller for uploading the file to Shrine
-      def to_shrine
+      # @return [Hash] Parameters required to add the file to a work in Scholarsphere
+      def to_param
         {
-          id: id,
-          storage: 'cache',
+          id: upload.id,
+          storage: upload.prefix,
           metadata: metadata
         }
       end
 
-      # @return [String] A unique, randomly-generated UUID
-      # @note This serves as the name of the file in the S3 bucket. However, this original name of the file is kept as
-      #   metadata within the application so that it can be downloaded.
-      def id
-        @id ||= "#{SecureRandom.uuid}#{source.extname}"
-      end
-
-      # @return [String] Path of the file relative to the bucket in S3
-      def key
-        "#{prefix}/#{id}"
-      end
-
       # @return [String] The md5 checksum encoded in base64. If you provided a checksum at initialization, that one will
       #   be encoded, if not, a checksum will be calculated and then encoded.
       # @note When sending the checksum to verify the file's integrity, Amazon requires that the value be base64
@@ -70,9 +62,9 @@ module Scholarsphere
                          end
       end
 
-      # @return [String] Size of the file in bytes
-      def size
-        source.size
+      # @return [String] Pre-signed url used to upload the file into Scholarsphere's S3 instance.
+      def presigned_url
+        upload.url
       end
 
       private
@@ -87,8 +79,8 @@ module Scholarsphere
           }
         end
 
-        def prefix
-          ENV['SHRINE_CACHE_PREFIX'] || 'cache'
+        def upload
+          @upload ||= Client::Upload.new(extname: source.extname)
         end
     end
   end

data/lib/scholarsphere/s3/uploader.rb

@@ -2,43 +2,43 @@
 
 module Scholarsphere
   module S3
-    class Uploader < ::Aws::S3::FileUploader
-      FIFTEEN_MEGABYTES = 15 * 1024 * 1024
-
-      # @param [Hash] options
-      # @option options [Client] :client
-      # @option options [Integer] :multipart_threshold (15728640)
-      def initialize(options = {})
-        @options = options
-        @options[:client] ||= ::Aws::S3::Client.new(client_defaults)
-        @client = options[:client]
-        @multipart_threshold = options[:multipart_threshold] || FIFTEEN_MEGABYTES
+    ##
+    #
+    # Uploads a file to Scholarsphere's AWS S3 instance. When upload is invoked, a pre-signed URL is requested from
+    # Scholarsphere, and if successful, the file is then uploaded to Scholarsphere using the url.
+    #
+    # An md5 hash is calculated for the file at initialization to ensure the file is transferred successfully.
+    #
+    # # Example
+    #
+    #     uploaded_file = Scholarsphere::S3::UploadedFile.new('path/to/file')
+    #     uploader = Scholarsphere::S3::Uploader(file: uploaded_file)
+    #     response = uploader.upload
+    #
+    class Uploader
+      # @param file [UploadedFile]
+      def initialize(file:)
+        @file = file
+        @content_md5 = file.content_md5
       end
 
-      # @param [UploadedFile] uploaded_file
-      # @param [Hash] options of additional options
-      # @option options [String] content_md5 a base64-encoded string representating the md5 checksum
-      # @return [void]
-      # @note The content_md5 hash cannot be used when doing a multipart upload.
-      def upload(uploaded_file, options = {})
-        options[:bucket] = ENV['AWS_BUCKET']
-        options[:key] = uploaded_file.key
-        if uploaded_file.size < multipart_threshold
-          options[:content_md5] = uploaded_file.content_md5
+      # @return [Faraday::Response] The response from Scholarsphere to the upload request.
+      def upload
+        connection(file.presigned_url).put do |req|
+          req.body = file.source.read
+          req.headers['Content-MD5'] = file.content_md5
         end
-        super(uploaded_file.source, options)
       end
 
       private
 
-        def client_defaults
-          {
-            endpoint: ENV['S3_ENDPOINT'],
-            access_key_id: ENV['AWS_ACCESS_KEY_ID'],
-            secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
-            force_path_style: true,
-            region: ENV['AWS_REGION']
-          }
+        attr_reader :file, :content_md5
+
+        def connection(url)
+          Faraday::Connection.new(
+            url: url,
+            ssl: { verify: Scholarsphere::Client.verify_ssl? }
+          )
         end
     end
   end

data/scholarsphere-client.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'homepage_uri' => spec.homepage,
     'source_code_uri' => spec.homepage,
-    'documentation' => 'https://www.rubydoc.info/gems/scholarsphere-client',
+    'documentation_uri' => 'https://www.rubydoc.info/github/psu-stewardship/scholarsphere-client/main',
     'allowed_push_host' => 'https://rubygems.org'
   }
 
@@ -41,6 +41,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
-  spec.add_development_dependency 'simplecov', '~> 0.18'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.11'
   spec.add_development_dependency 'yard', '< 1.0'
+
+  # Latest version of simplecov is not compatible with Code Climate
+  spec.add_development_dependency 'simplecov', '< 0.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scholarsphere-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Wead
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -151,19 +151,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 description: Client software to create new content for the Scholarsphere repository
   at Penn State.
 email:
@@ -186,11 +214,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
@@ -200,6 +230,7 @@ files:
 - lib/scholarsphere/client/collection.rb
 - lib/scholarsphere/client/config.rb
 - lib/scholarsphere/client/ingest.rb
+- lib/scholarsphere/client/upload.rb
 - lib/scholarsphere/client/version.rb
 - lib/scholarsphere/s3.rb
 - lib/scholarsphere/s3/uploaded_file.rb
@@ -210,7 +241,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/psu-stewardship/scholarsphere-client
   source_code_uri: https://github.com/psu-stewardship/scholarsphere-client
-  documentation: https://www.rubydoc.info/gems/scholarsphere-client
+  documentation_uri: https://www.rubydoc.info/github/psu-stewardship/scholarsphere-client/main
   allowed_push_host: https://rubygems.org
 post_install_message:
 rdoc_options: []