puppet_forge 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0e379f885f305dfc82f87bfea6ae668d6467595f0083355cbe95c63e9864019
-  data.tar.gz: 1cf23ce28776267459e01bedfed935750650378542b54e1ec3155efb9b67ba60
+  metadata.gz: bf36457b8298a66e2b7af77d53a0bf476b4881c2dd29de7b1e8a49a523400f53
+  data.tar.gz: e5926f236dbe38b61bf3e1b9e96677ef352db5afabb9de836d40d1be136830f5
 SHA512:
-  metadata.gz: b32e4f0758fe84f28339cc8a3f57dad01a21abc26a490e7d1b8ac1a4ecdc6e52b961e4c24f0f4a5b476c4fc1ed849bfb42594314a120f6198c06261036702457
-  data.tar.gz: 044a092e9f8e15f078043281bac236c8694c037a1f71bb34a4d0e392379811e88ac9981afa6d75661cc5483a7a3966af26def433fe2eeb370c9f2d80499fbcba
+  metadata.gz: d604d660f74c37ea1bdeeb048d94edf557b1037d46bc6e83963f1d8b9d1652ceb66d3aafb3b498c470ffc1083c7d2fbb5d22a410b3ae2e91e12b7381f2ee9c26
+  data.tar.gz: fbf2a345b0c6b538a7a0424965d13aa1ab54f9e064273fe983176b60516a1076b1f3bd7b8edca3bed5272b0380de1fb6448d81dde147d31f3961c99ea49fde26

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 Starting with v2.0.0, all notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## v4.1.0 - 2023-02-21
+
+* Add upload method functionality.
+* Allows the user to search by an array of endorsements.
+
 ## v4.0.0 - 2022-11-30
 
 * Breaking: The `puppet_forge` gem now requires at least Ruby 2.6.0

data/README.md

@@ -136,7 +136,23 @@ release.verify(Pathname(release_tarball))
 # @raise RuntimeError if it fails to extract the contents of the release tarball
 PuppetForge::Unpacker.unpack(release_tarball, dest_dir, tmp_dir)
 ```
+### Uploading a module release
 
+You can upload new module versions to the forge by following the steps below.
+
+> Note: This API requires authorization. See [Authorization](#authorization) for more information.
+
+```ruby
+release_tarball = 'pkg/puppetlabs-apache-1.6.0.tar.gz'
+
+# Upload a module tarball to the Puppet Forge
+# Returns an instance of V3::Release class and the response from the forge upload 
+# @raise PuppetForge::ReleaseForbidden if a 403 response is recieved from the server
+# @raise PuppetForge::ReleaseBadContent if the module to upload is not valid
+# @raise Faraday::ClientError if any errors encountered in the upload
+# @raise PuppetForge::FileNotFound if the given tarball cannot be found
+release, response = PuppetForge::V3::Release.upload(release_tarball)
+```
 
 ### Paginated Collections
 

data/lib/puppet_forge/error.rb

@@ -28,16 +28,32 @@ Could not install package
     end
   end
 
+
+  class ErrorWithDetail < PuppetForge::Error
+    def self.from_response(response)
+      body = JSON.parse(response[:body])
+
+      message = body['message']
+      if body.key?('errors') && !body['errors']&.empty?
+        message << "\nThe following errors were returned from the server:\n - #{body['errors'].join("\n - ")}"
+      end
+
+      new(message)
+    end
+  end
+
+  class FileNotFound < PuppetForge::Error
+  end
+
   class ModuleNotFound < PuppetForge::Error
   end
 
   class ReleaseNotFound < PuppetForge::Error
   end
 
-  class ReleaseForbidden < PuppetForge::Error
-    def self.from_response(response)
-      body = JSON.parse(response[:body])
-      new(body["message"])
-    end
+  class ReleaseForbidden < PuppetForge::ErrorWithDetail
+  end
+
+  class ReleaseBadContent < PuppetForge::ErrorWithDetail
   end
 end

data/lib/puppet_forge/v3/base.rb

@@ -66,6 +66,9 @@ module PuppetForge
             uri_path = "v3/#{resource}/#{item}"
           end
 
+          # The API expects a space separated string. This allows the user to invoke it with a more natural feeling array.
+          params['endorsements'] = params['endorsements'].join(' ') if params['endorsements'].is_a? Array
+
           PuppetForge::V3::Base.conn.get uri_path, params
         end
 

data/lib/puppet_forge/v3/release.rb

@@ -2,6 +2,7 @@ require 'puppet_forge/v3/base'
 require 'puppet_forge/v3/module'
 
 require 'digest'
+require 'base64'
 
 module PuppetForge
   module V3
@@ -38,6 +39,38 @@ module PuppetForge
         end
       end
 
+      # Uploads the tarbarll to the forge
+      #
+      # @param path [Pathname] tarball file path
+      # @return resp
+      def self.upload(path)
+        # We want to make sure that the file exists before trying to upload it
+        raise PuppetForge::FileNotFound, "The file '#{path}' does not exist." unless File.file?(path)
+
+        file = File.open(path, 'rb')
+        encoded_string = Base64.encode64(file.read)
+        data = { file: encoded_string }
+
+        resp = conn.post do |req|
+          req.url '/v3/releases'
+          req.headers['Content-Type'] = 'application/json'
+          req.body = data.to_json
+        end
+
+        [self, resp]
+      rescue Faraday::ClientError => e
+        if e.response
+          case e.response[:status]
+          when 403
+            raise PuppetForge::ReleaseForbidden.from_response(e.response)
+          when 400
+            raise PuppetForge::ReleaseBadContent.from_response(e.response)
+          end
+        end
+
+        raise e
+      end
+
       # Verify that a downloaded module matches the best available checksum in the metadata for this release,
       # validates SHA-256 checksum if available, otherwise validates MD5 checksum
       #

data/lib/puppet_forge/version.rb

@@ -1,3 +1,3 @@
 module PuppetForge
-  VERSION = '4.0.0' # Library version
+  VERSION = '4.1.0' # Library version
 end

data/spec/unit/forge/v3/release_spec.rb

@@ -218,5 +218,43 @@ describe PuppetForge::V3::Release do
         expect(release.created_at).to_not be nil
       end
     end
+
+    describe '#upload' do
+      let(:tarball) { "#{PROJECT_ROOT}/spec/tmp/module.tgz" }
+      let(:file_object) { double('file', read: 'file contents') }
+
+      let(:release) { PuppetForge::V3::Release.upload(tarball) }
+      let(:mock_conn) { instance_double('PuppetForge::V3::Connection', url_prefix: PuppetForge.host) }
+
+      context 'when there is no auth token provided' do
+        it 'raises PuppetForge::ReleaseForbidden' do
+          allow(File).to receive(:file?).and_return(true)
+          allow(File).to receive(:open).and_return(file_object)
+          allow(described_class).to receive(:conn).and_return(mock_conn)
+
+          response = { status: 403, body: { 'message' => 'Forbidden' }.to_json }
+          expect(mock_conn).to receive(:post).and_raise(Faraday::ClientError.new('Forbidden', response))
+          expect { release }.to raise_error(PuppetForge::ReleaseForbidden)
+        end
+      end
+
+      context 'when the module is not valid' do
+        it 'raises PuppetForge::ReleaseBadRequest' do
+          allow(File).to receive(:file?).and_return(true)
+          allow(File).to receive(:open).and_return(file_object)
+          allow(described_class).to receive(:conn).and_return(mock_conn)
+
+          response = { status: 400, body: { message: 'Bad Content' }.to_json }
+          expect(mock_conn).to receive(:post).and_raise(Faraday::ClientError.new('400', response))
+          expect { release }.to raise_error(PuppetForge::ReleaseBadContent)
+        end
+      end
+
+      context 'when the tarball does not exist' do
+        it 'raises PuppetForge::FileNotFound' do
+          expect { PuppetForge::V3::Release.upload(tarball) }.to raise_error(PuppetForge::FileNotFound)
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_forge
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Puppet Labs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Access the Puppet Forge API from Ruby for resource information and to download