scholarsphere-client 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e11a054c317ee1bf76d1d19f25bba34c811565148f9d3f345a775d8a98bef4dd
-  data.tar.gz: 8837835a6ef7fd68460a366fe69ce2fee9bc76e92d61c77c16b4aa8eeb65acde
+  metadata.gz: 8c93e287718b93836734e16881ffa6e9f800a21f4eb8e3b7768a63cdb18f54d1
+  data.tar.gz: f5fdb85f67fda641bbcc877e2dd728b28f725b819b63ddef70de5123077934bb
 SHA512:
-  metadata.gz: cdc0fe30afe55be89426cb0f7336c5093bf76fb752a1b2248d9c1afd3dd568529c0a82a168bd1943b6e9cc9257a1f95a750eec7a9b260f35f163a6aba0748219
-  data.tar.gz: 8c227408798b51c98de8bf6ab998176653608de0fe4428466a8f9eaf9f47cccd450f9e7569809f1d12f6b6664acd5c201d287be3a46521832b2a3d2f997fd725
+  metadata.gz: 444420739ff3d2a4a08b91bdb442c8e637369834cfa218f53bef9b457b2ec23863e31b3a8768af73508b1702eb3c8b9e70210dbfc298dc1a80f4b2ff2c561b75
+  data.tar.gz: 61b1fc62c5c46e1a367c04b8fbd58a2d5ec55631d9a2534ed185f3f1e8313e92a46a52687b777c77f6a11004945db5ab88fa072f68e4f8edf3e31b91c374331b

data/.circleci/config.yml

@@ -24,17 +24,6 @@ jobs:
           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/Gemfile

@@ -13,10 +13,8 @@ group :development do
   gem 'rake', '>= 12.3.3'
   gem 'rspec', '~> 3.0'
   gem 'rspec-its', '~> 1.3'
+  gem 'simplecov'
   gem 'vcr', '~> 6.0'
   gem 'webmock', '~> 3.11'
   gem 'yard', '< 1.0'
-
-  # Latest version of simplecov is not compatible with Code Climate
-  gem 'simplecov', '< 0.18'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scholarsphere-client (0.5.1)
+    scholarsphere-client (0.5.3)
       aws-sdk-s3 (~> 1.49)
       faraday (> 0.12)
       marcel (~> 1.0)
@@ -70,7 +70,7 @@ GEM
       rexml
     crass (1.0.6)
     diff-lcs (1.4.4)
-    docile (1.4.0)
+    docile (1.4.1)
     drb (2.2.3)
     erb_lint (0.9.0)
       activesupport
@@ -118,7 +118,7 @@ GEM
       rubocop-rspec (~> 3.5)
       rubocop-rspec_rails (~> 2.30)
       scss_lint (~> 0.60)
-    nokogiri (1.18.8)
+    nokogiri (1.18.10)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.26.3)
@@ -133,7 +133,7 @@ GEM
       pry (>= 0.13, < 0.15)
     public_suffix (6.0.1)
     racc (1.8.1)
-    rack (3.1.16)
+    rack (3.2.4)
     rails-dom-testing (2.3.0)
       activesupport (>= 5.0.0)
       minitest
@@ -147,7 +147,7 @@ GEM
     rb-inotify (0.11.1)
       ffi (~> 1.0)
     regexp_parser (2.10.0)
-    rexml (3.4.1)
+    rexml (3.4.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -210,11 +210,12 @@ GEM
     scss_lint (0.60.0)
       sass (~> 3.5, >= 3.5.5)
     securerandom (0.4.1)
-    simplecov (0.17.1)
+    simplecov (0.22.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
     smart_properties (1.17.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -241,7 +242,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rspec-its (~> 1.3)
   scholarsphere-client!
-  simplecov (< 0.18)
+  simplecov
   vcr (~> 6.0)
   webmock (~> 3.11)
   yard (< 1.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/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.1'
+    VERSION = '0.5.3'
   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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: scholarsphere-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Adam Wead
 bindir: exe
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2026-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Client to connect to Scholarpshere
 test_files: []