scholarsphere-client 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca86fbfed637858cc8c6bc29b496b82dae7d80cb1af509a63cfd51cb0c0b723b
-  data.tar.gz: cfd8d631f7df13b7718d0250f1063cef6b1929ed44d431709344e593922e0082
+  metadata.gz: 596dc12ea255cd527a837883dfda00f14608c0a143c1bc45218064b3fc176d19
+  data.tar.gz: c7653c11468ef0fb22f62e0252ffa3ccc0f8dd04e7fdcbe99d32bab220ff3da9
 SHA512:
-  metadata.gz: 1db3ec2cad1ada9512cdda576d77a76d300433cef905c1c576443083e45f36728a714f69d702adf7c1a3469b4c7a850b1f54a84f3fb5bd9cd796636644ec1b1d
-  data.tar.gz: 23d514277f18a1d22f9e648cae56274e27300f44a32e3a783baa042d12d8eeefc8786e70789aea0674531b3bdeca37dd2cb0f4fa9b551be5e0263df5e7218627
+  metadata.gz: 9a0f97c662b4398d6b537eb38f6245f24fa63c072af9d7583a39a09de5a9ef4e0fcabbb2258b7269b60cd79d8fd2107c1920960a8154ba9f2f486c64dd9bed2d
+  data.tar.gz: 2ebc30e313a98e2ab1aa639111a86d1f65d6c8ad694aeec189cdf03af3ac23d87df3e7be0ba428e2746cfd0d7c9629e2934bf3d8c6bba5ade3782feca5f0ad18

data/.circleci/config.yml

@@ -5,7 +5,7 @@ orbs:
 jobs:
   build:
     docker:
-      - image: cimg/ruby:3.4.1
+      - image: cimg/ruby:3.4.11
     executor: ruby/default
     steps:
       - checkout

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    scholarsphere-client (0.5.2)
-      aws-sdk-s3 (~> 1.49)
-      faraday (> 0.12)
-      marcel (~> 1.0)
-      mutex_m (~> 0.3)
+    scholarsphere-client (0.5.4)
+      aws-sdk-s3 (~> 1.233.2)
+      faraday (~> 2.15.0)
+      marcel (~> 2.1.0)
+      mutex_m (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -34,17 +34,20 @@ GEM
     ast (2.4.2)
     aws-eventstream (1.3.2)
     aws-partitions (1.1069.0)
-    aws-sdk-core (3.220.1)
+    aws-sdk-core (3.257.0)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.992.0)
       aws-sigv4 (~> 1.9)
       base64
+      bigdecimal
       jmespath (~> 1, >= 1.6.1)
+      logger
+      rexml (~> 3.4, >= 3.4.2)
     aws-sdk-kms (1.99.0)
       aws-sdk-core (~> 3, >= 3.216.0)
       aws-sigv4 (~> 1.5)
-    aws-sdk-s3 (1.182.0)
-      aws-sdk-core (~> 3, >= 3.216.0)
+    aws-sdk-s3 (1.233.2)
+      aws-sdk-core (~> 3, >= 3.256.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.5)
     aws-sigv4 (1.11.0)
@@ -80,15 +83,12 @@ GEM
       rubocop (>= 1)
       smart_properties
     erubi (1.13.1)
-    faraday (1.4.1)
-      faraday-excon (~> 1.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-excon (1.1.0)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
+    faraday (2.15.0)
+      faraday-net_http (>= 2.0, < 3.6)
+      json
+      logger
+    faraday-net_http (3.5.0)
+      net-http (~> 0.5)
     ffi (1.17.1)
     hashdiff (1.1.2)
     i18n (1.14.7)
@@ -101,12 +101,16 @@ GEM
     loofah (2.24.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    marcel (1.0.1)
+    marcel (2.1.0)
     method_source (1.1.0)
     mini_portile2 (2.8.9)
     minitest (5.25.5)
-    multipart-post (2.1.1)
     mutex_m (0.3.0)
+    net-http (0.10.0)
+      net-protocol (>= 0.3.0)
+      uri (>= 0.11.1)
+    net-protocol (0.4.0)
+      timeout
     niftany (0.12.0)
       colorize (~> 1.1.0)
       erb_lint (~> 0.9.0)
@@ -118,7 +122,7 @@ GEM
       rubocop-rspec (~> 3.5)
       rubocop-rspec_rails (~> 2.30)
       scss_lint (~> 0.60)
-    nokogiri (1.18.10)
+    nokogiri (1.19.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.26.3)
@@ -133,7 +137,7 @@ GEM
       pry (>= 0.13, < 0.15)
     public_suffix (6.0.1)
     racc (1.8.1)
-    rack (3.2.4)
+    rack (3.2.7)
     rails-dom-testing (2.3.0)
       activesupport (>= 5.0.0)
       minitest
@@ -201,7 +205,6 @@ GEM
       rubocop (~> 1.72, >= 1.72.1)
       rubocop-rspec (~> 3.5)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.4)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
@@ -217,12 +220,13 @@ GEM
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     smart_properties (1.17.0)
+    timeout (0.6.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.3)
+    uri (1.1.2)
     vcr (6.0.0)
     webmock (3.25.1)
       addressable (>= 2.8.0)

data/README.md

@@ -61,7 +61,7 @@ ingest = Scholarsphere::Client::Ingest.new(
   depositor: 'axb123'
 )
 
-response = ingest.publish
+response = ingest.create
 
 puts response.body
 ```
@@ -73,6 +73,23 @@ The json output should look like:
       "url": "/resources/0797e99c-7d4f-4e05-8bf6-86aea1029a6a"
     }
 
+If you pass in "publish:false", the json should also contain an edit_url that links to the file upload page.
+
+ingest = Scholarsphere::Client::Ingest.new(
+  metadata: metadata,
+  files: files,
+  depositor: 'axb123',
+  publish: false
+)
+
+response = ingest.create
+
+Returns json:
+    {
+      "message": "Work was successfully created",
+      "url": "/resources/0797e99c-7d4f-4e05-8bf6-86aea1029a6a",
+      "edit_url": "/dashboard/form/work_versions/8/files"
+    }
 ## Documentation
 
 You can read the [ruby docs](https://www.rubydoc.info/github/psu-libraries/scholarsphere-client/main) for the latest features.

data/bin/check_dependencies.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+spec = Gem::Specification.load("scholarsphere-client.gemspec")
+
+spec.runtime_dependencies.each do |dependency|
+  system("gem", "list", "--remote", "--exact", dependency.name)
+end

data/lib/scholarsphere/client/ingest.rb

@@ -16,7 +16,7 @@ module Scholarsphere
     #       files: files,
     #       depositor: 'abc123'
     #     )
-    #     response = ingest.publish
+    #     response = ingest.create
     #
     # If the response is successful, the application returns 200 OK with JSON:
     #
@@ -25,10 +25,27 @@ module Scholarsphere
     #       "message": "Work was successfully created",
     #       "url": "/resources/0797e99c-7d4f-4e05-8bf6-86aea1029a6a"
     #     }
+    # ## Creating a new draft
     #
-    # Other possible outcomes include:
+    # A Work can also be created without publishing it by passing a 'false' parameter.
+    #
+    #     ingest = Scholarsphere::Client::Ingest.new(
+    #       metadata: metadata,
+    #       files: files,
+    #       depositor: 'abc123',
+    #       publish: false
+    #     )
+    #     response = ingest.create
     #
-    #   * work was created, but not successfully published because of missing attributes (201 Created)
+    # If the response is successful, it will return a 201 Created with JSON:
+    #     puts response.body
+    #     {
+    #       "message": "Work was successfully created",
+    #       "url": "/resources/0797e99c-7d4f-4e05-8bf6-86aea1029a6a",
+    #       "edit_url": "/dashboard/form/work_versions/8/files"
+    #     }
+    #
+    # Other possible outcomes include:
     #   * work could not be created due to insufficient parameters (422 Unprocessable Entity)
     #   * there was an error with the application (500 Internal Server Error)
     #
@@ -79,25 +96,28 @@ module Scholarsphere
     #
     #
     class Ingest
-      attr_reader :content, :metadata, :depositor, :permissions
+      attr_reader :content, :metadata, :depositor, :permissions, :publish
 
       # @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] access id of the depositor
       # @param permissions [Hash] (optional) Additional permissions to apply to the resource
-      def initialize(metadata:, files:, depositor:, permissions: {})
+      # @param publish [Boolean] (optional) Whether the new Work should be published. Defaults to true
+      def initialize(metadata:, files:, depositor:, permissions: {}, publish: true)
         @content = build_content_hash(files)
         @metadata = metadata
         @depositor = depositor
         @permissions = permissions
+        @publish = publish
       end
 
       # @return [Faraday::Response] The response from the Scholarsphere application.
-      def publish
+      def create
         upload_files
         connection.post do |req|
           req.url 'ingest'
-          req.body = { metadata: metadata, content: content, depositor: depositor, permissions: permissions }.to_json
+          req.body = { metadata: metadata, content: content, depositor: depositor, permissions: permissions,
+                       publish: publish }.to_json
         end
       end
 

data/lib/scholarsphere/client/version.rb

@@ -2,6 +2,6 @@
 
 module Scholarsphere
   module Client
-    VERSION = '0.5.2'
+    VERSION = '0.5.4'
   end
 end

data/sample.rb

@@ -32,6 +32,6 @@ ingest = Scholarsphere::Client::Ingest.new(
   depositor: 'axb123'
 )
 
-response = ingest.publish
+response = ingest.create
 
 puts response.body

data/scholarsphere-client.gemspec

@@ -33,8 +33,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'aws-sdk-s3', '~> 1.49'
-  spec.add_dependency 'faraday', '> 0.12'
-  spec.add_dependency 'marcel', '~> 1.0'
-  spec.add_dependency 'mutex_m', '~> 0.3'
+  spec.add_dependency 'aws-sdk-s3', '~> 1.233.2'
+  spec.add_dependency 'faraday', '~> 2.15.0'
+  spec.add_dependency 'marcel', '~> 2.1.0'
+  spec.add_dependency 'mutex_m', '~> 0.3.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: scholarsphere-client
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Adam Wead
 bindir: exe
 cert_chain: []
-date: 2025-11-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -15,56 +15,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.49'
+        version: 1.233.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.49'
+        version: 1.233.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 2.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 2.15.0
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: mutex_m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.0
 description: Client software to create new content for the Scholarsphere repository
   at Penn State.
 email:
@@ -82,6 +82,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- bin/check_dependencies.rb
 - bin/clean-vcr-files
 - bin/console
 - bin/setup
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Client to connect to Scholarpshere
 test_files: []