scholarsphere-client 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbf8a34c40662583fb6047074f4ab562cd6c82ba8a8c064455f8b5d401f3788
-  data.tar.gz: ce5ee5ffcac16b29710c8e3f18027a21ad590cee13241584e781b460de20aa18
+  metadata.gz: c6aea3fb4a9f848569bdfddfe98dfb9d1111d539f6b8fc9ed1a27d3a027ab71d
+  data.tar.gz: 5f0175bdad9582f9217c2e77efe82915be37db174380225d731991e90d85c49d
 SHA512:
-  metadata.gz: b79ae1cdb55fa53eac0b6876562db034287ca92b935e922f34c8c39fdd844fac9a0cfce4f3f842d9082a0ed2dbda9ef72a5efc3385c9ff230ed48f4fb5b42c6d
-  data.tar.gz: 5f42f827df052f4e84042dba2246de9079c35d57d8f004448ed4894ad4dcabc10e66b7e36b8f2ce5be1eee36e8b5e7f8cc519d9578204b0de5d359579ae7d0b1
+  metadata.gz: 7d5c5f6c156b02d445f9d44a6d15456662e7d369df8442ee5e44364b65c62705d0f509584eb4891c1e799373dc44a452bb8af72b9fb2ed8d40a4c0edc7e65e21
+  data.tar.gz: f9327df0e587fa081a5cef599f930ad6746cb6fad76a1200df0795dcee76afd32ec331be6ff166ccb36c5821694680af5634aa606d4add456ca5ae85140abfff

data/.circleci/config.yml

@@ -19,7 +19,7 @@ jobs:
           name: "RSpec"
           command: bundle exec rspec
           environment:
-            SS4_ENDPOINT: "https://scholarsphere.test/api/v1"
+            SS4_ENDPOINT: "https://scholarsphere-rmd-api.dsrd.libraries.psu.edu/api/v1"
       - run:
           name: "Copy VCR Logs"
           when: on_fail

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scholarsphere-client (0.2.1)
+    scholarsphere-client (0.3.0)
       aws-sdk-s3 (~> 1.49)
       faraday (> 0.12)
       marcel (~> 0.3)
@@ -9,13 +9,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (6.1.1)
-      activesupport (= 6.1.1)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.1)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,24 +23,24 @@ GEM
       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)
+    ast (2.4.2)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.435.0)
+    aws-sdk-core (3.113.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-sdk-kms (1.43.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.67.0)
-      aws-sdk-core (~> 3, >= 3.96.1)
+    aws-sdk-s3 (1.93.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       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)
+    aws-sigv4 (1.2.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+    better_html (1.0.16)
       actionview (>= 4.0)
       activesupport (>= 4.0)
       ast (~> 2.0)
@@ -52,11 +52,11 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crack (0.4.5)
       rexml
     crass (1.0.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.5)
     erb_lint (0.0.37)
       activesupport
@@ -67,24 +67,29 @@ GEM
       rubocop
       smart_properties
     erubi (1.10.0)
-    faraday (1.0.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.14.2)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    ffi (1.15.0)
     hashdiff (1.0.1)
     html_tokenizer (0.0.7)
-    i18n (1.8.7)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
     json (2.5.1)
-    loofah (2.8.0)
+    loofah (2.9.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)
+    mimemagic (0.3.9)
+      nokogiri (~> 1)
+      rake
     mini_portile2 (2.5.0)
-    minitest (5.14.3)
+    minitest (5.14.4)
     multipart-post (2.1.1)
     niftany (0.8.0)
       colorize (~> 0.8.1)
@@ -94,7 +99,7 @@ GEM
       rubocop-rails (~> 2.3)
       rubocop-rspec (~> 1.3)
       scss_lint (~> 0.55)
-    nokogiri (1.11.1)
+    nokogiri (1.11.2)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     parallel (1.20.1)
@@ -115,28 +120,28 @@ GEM
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     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)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
+      rspec-support (~> 3.10.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.9.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -146,9 +151,9 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
+    rubocop-performance (1.10.2)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rails (2.9.1)
@@ -159,6 +164,7 @@ GEM
       rubocop (~> 0.87)
       rubocop-ast (>= 0.7.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
@@ -176,7 +182,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
-    webmock (3.11.1)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -6,9 +6,7 @@ Ruby client to update and create content in the Scholarsphere repository.
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'scholarsphere-client'
-```
+    gem 'scholarsphere-client'
 
 And then execute:
 
@@ -33,42 +31,43 @@ If you are using a testing instance, you'll need to disable ssl verification:
 
 ### 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') ]
+See the `sample.rb` file for an executable example.
 
-    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
+To publish a work:
 
-    puts response.body
+``` ruby
+metadata = {
+  work_type: 'dataset',
+  visibility: 'open',
+  rights: 'https://creativecommons.org/licenses/by/4.0/',
+  title: 'Sample Title',
+  description: "This is a sample work",
+  published_date: '2010-01-01',
+  creators: [
+    { orcid: '0000-0000-1111-222X' },
+    { psu_id: 'axb123' },
+    { display_name: 'Dr. Unidentified Creator' }
+  ]
+}
+
+files = [
+  Pathname.new("/path/to/file1.txt"),
+  Pathname.new("/path/to/file2.txt")
+]
+
+ingest = Scholarsphere::Client::Ingest.new(
+  metadata: metadata,
+  files: files,
+  depositor: 'axb123'
+)
+
+response = ingest.publish
+
+puts response.body
+```
 
+The json output should look like:
+    
     { 
       "message": "Work was successfully created",
       "url": "/resources/0797e99c-7d4f-4e05-8bf6-86aea1029a6a"
@@ -77,3 +76,23 @@ To publish a work:
 ## Documentation
 
 You can read the [ruby docs](https://www.rubydoc.info/github/psu-stewardship/scholarsphere-client/main) for the latest features.
+
+## Testing
+
+### Using an Existing Deployment
+
+RSpec tests are run against saved API responses that are recorded using the VCR gem. If we want to run the test
+suite against a live instance to see if our client works against a given deployment, update the endpoint in
+`config/scholarsphere-client.yml` and run:
+
+    DISABLE_VCR=true bundle exec rspec
+
+### Updating VCR Files
+
+Simply removing the existing VCR files should be enough to update all the responses. If no yaml file exists for a given
+test, VCR will record a new one. Be sure to clean up files afterwards using `bin/clean-vcr-files` which will remove
+unnecessary binary data from the responses:
+
+    rm -Rf spec/fixtures/vcr_cassettes
+    bundle exec rspec
+    bin/clean-vcr-files

data/bin/clean-vcr-files

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+FILES=`find spec/fixtures/vcr_cassettes -name "*.yml"`
+
+for file in $FILES; do
+  yq ea '.http_interactions.[].request.body.base64_string |= "imagecontent"' -i $file
+done
+

data/lib/scholarsphere/client/upload.rb

@@ -10,8 +10,10 @@ module Scholarsphere
     #
     class Upload
       # @param extname [String] Extension of the file to be uploaded, without the period, such as 'pdf'
-      def initialize(extname:)
+      # @param content_md5 [String] This should be the same as UploadedFile.content_md5
+      def initialize(extname:, content_md5:)
         @extname = extname
+        @content_md5 = content_md5
       end
 
       # @return [String] Prefix where the file is stored in the S3 bucket.
@@ -31,18 +33,18 @@ module Scholarsphere
 
       private
 
-        attr_reader :extname
+        attr_reader :extname, :content_md5
 
         def request
           @request ||= Scholarsphere::Client.connection.post do |req|
             req.url 'uploads'
-            req.body = { extension: extname }.to_json
+            req.body = { extension: extname, content_md5: content_md5 }.to_json
           end
         end
 
         def data
           @data ||= begin
-                      raise Client::Error unless request.success?
+                      raise Client::Error.new(request.body) unless request.success?
 
                       JSON.parse(request.body)
                     end

data/lib/scholarsphere/client/version.rb

@@ -2,6 +2,6 @@
 
 module Scholarsphere
   module Client
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/lib/scholarsphere/s3/uploaded_file.rb

@@ -80,7 +80,7 @@ module Scholarsphere
         end
 
         def upload
-          @upload ||= Client::Upload.new(extname: source.extname)
+          @upload ||= Client::Upload.new(extname: source.extname, content_md5: content_md5)
         end
     end
   end

data/lib/scholarsphere/s3/uploader.rb

@@ -24,15 +24,22 @@ module Scholarsphere
 
       # @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
-        end
+        raise Client::Error.new(request.body) unless request.success?
+
+        request
       end
 
       private
 
         attr_reader :file, :content_md5
 
+        def request
+          @request ||= connection(file.presigned_url).put do |req|
+            req.body = file.source.read
+            req.headers['Content-MD5'] = file.content_md5
+          end
+        end
+
         def connection(url)
           Faraday::Connection.new(
             url: url,

data/sample.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'scholarsphere-client', '~> 0.2'
+end
+
+metadata = {
+  work_type: 'dataset',
+  visibility: 'open',
+  rights: 'https://creativecommons.org/licenses/by/4.0/',
+  title: 'Sample Title',
+  description: 'This is a sample work',
+  published_date: '2010-01-01',
+  creators: [
+    { orcid: '0000-0000-1111-222X' },
+    { psu_id: 'axb123' },
+    { display_name: 'Dr. Unidentified Creator' }
+  ]
+}
+
+files = [
+  Pathname.new('/path/to/file1.txt'),
+  Pathname.new('/path/to/file2.txt')
+]
+
+ingest = Scholarsphere::Client::Ingest.new(
+  metadata: metadata,
+  files: files,
+  depositor: 'axb123'
+)
+
+response = ingest.publish
+
+puts response.body

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scholarsphere-client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Wead
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -223,6 +223,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- bin/clean-vcr-files
 - bin/console
 - bin/setup
 - config/.gitkeep
@@ -235,6 +236,7 @@ files:
 - lib/scholarsphere/s3.rb
 - lib/scholarsphere/s3/uploaded_file.rb
 - lib/scholarsphere/s3/uploader.rb
+- sample.rb
 - scholarsphere-client.gemspec
 homepage: https://github.com/psu-stewardship/scholarsphere-client
 licenses: []