puppet_forge 2.3.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 268967975051fcaec41d34ca23f059007d4a7d26
-  data.tar.gz: cca3b818c18742151db331ac8a39d2824f135a12
+SHA256:
+  metadata.gz: 14fb262a13e9382bc404ebf162e70c8fa48ccd73f33f53113e75524da106bed9
+  data.tar.gz: 0316cbac8bd7c7d3dc18d792a0dfc25a4cca095fce0974a5f54a50e546ef1c92
 SHA512:
-  metadata.gz: b038d3eb99356236483d4326e396ed84f5fba6c1651dd528128ec77ad183c3c0b2a4327d36a387903d76e855e8001ecb155a10f0a52f2f8f7acf5d4abe43281a
-  data.tar.gz: 283e3617c405d572416f27e7d8687481af4afa276d3720f378e492dc10d549edc12aaeee2386c433e783795ef82edcfc70ee764f51acb804a529ca4f5a04d1eb
+  metadata.gz: f909a3a4b8bf942f104f1a9f5a798edeb8a29e03adaaa24dbd4170efd97f2e09c23ef44b3b88ad406d32d5d10aba98d382d21ce10e1db115ee5c87d8cd01e30f
+  data.tar.gz: 2da931edf4e563a6e0962d834c9e3db3dec6ff33fd9a172f5d50a12066863b336fae173c8ad860d6c85f6df1ef02da4e1e0fc61e0a3182e92552ac988db3ce7b

data/.github/workflows/ruby-rspec.yml

@@ -3,10 +3,10 @@ name: ruby-rspec
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   test:
@@ -14,14 +14,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby_version: ['2.7.x', '2.6.x', '2.5.x', '2.4.x']
+        ruby: [2.7, 2.6, 2.5]
 
     steps:
       - uses: actions/checkout@v1
-      - name: Set up Ruby ${{ matrix.ruby_version }}
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby_version }}
+          ruby-version: ${{ matrix.ruby }}
 
       - name: Build and test with Rspec
         run: |

data/.gitignore

@@ -20,4 +20,3 @@ _yardoc
 *.o
 *.a
 mkmf.log
-locales/forge-ruby.pot

data/CHANGELOG.md

@@ -3,6 +3,30 @@
 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/).
 
+## v3.2.0 - 2021-11-09
+
+* Allow requests to follow redirects
+* Remove the `gettext-setup` gem dependency, which was unused
+
+## v3.1.0 - 2021-08-20
+
+### Changed
+
+* Update `PuppetForge::Connection.authorization` so that it prepends the
+  required `Bearer ` string automatically to values that look like Forge API
+  keys. This won't affect values that already include `Bearer `.
+
+## v3.0.0 - 2021-01-28
+
+* Breaking: The `puppet_forge` gem now requires at least Ruby 2.4.0.
+* Update `faraday` and `faraday_middleware` gem dependencies to 1.x series.
+* Update optional `typhoeus` dependency to `>= 1.4` to maintain compatibility with `faraday`.
+
+## v2.3.4 - 2020-03-31
+
+* Update the forge API url to `forgeapi.puppet.com` (instead of using the older puppetlabs.com domain).
+* Allow versions of the `faraday_middleware` dependency up to 0.15.
+
 ## v2.3.3 - 2020-02-20
 
 ### Changed

data/README.md

@@ -1,6 +1,6 @@
 # Puppet Forge
 
-Access and manipulate the [Puppet Forge API](https://forgeapi.puppetlabs.com)
+Access and manipulate the [Puppet Forge API](https://forgeapi.puppet.com)
 from Ruby.
 
 ## Installation
@@ -81,13 +81,14 @@ resource model are documented on the [Resource Reference][resource_ref] page.
 Each of the models uses ActiveRecord-like REST functionality to map over the Forge API endpoints.
 Most simple ActiveRecord-style interactions function as intended.
 
-Currently, only unauthenticated read-only actions are supported.
+Currently, only read-only actions are supported.
 
 The methods find, where, and all immediately make one API request.
 
 ```ruby
 # Find a Resource by Slug
-PuppetForge::User.find('puppetlabs') # => #<Forge::V3::User(/v3/users/puppetlabs)>
+PuppetForge::User.find('puppetlabs') # => #<PuppetForge::V3::User(/v3/users/puppetlabs)>
+PuppetForge::Module.find('puppetlabs-stdlib') # => #<PuppetForge::V3::Module(/v3/modules/puppetlabs-stdlib)>
 
 # Find All Resources
 PuppetForge::Module.all # See "Paginated Collections" below for important info about enumerating resource sets.
@@ -109,7 +110,7 @@ PuppetForge::Module.where(query: 'apache').all # This method is deprecated and n
 All API Requests (whether via find, where, or all) will raise a Faraday::ResourceNotFound error if the request fails.
 
 
-### Installing a Release
+### Downloading and installing a module release
 
 A release tarball can be downloaded and installed by following the steps below.
 
@@ -186,26 +187,24 @@ user.username # => "puppetlabs"
 user.created_at # => "2010-05-19 05:46:26 -0700"
 ```
 
-### i18n
+### Configuration
 
-When adding new error or log messages please follow the instructions for
-[writing translatable code](https://github.com/puppetlabs/gettext-setup-gem#writing-translatable-code).
-
-The PuppetForge gem will default to outputing all error messages in English, but you may set the locale
-using the `FastGettext.set_locale` method. If translations do not exist for the language you request then the gem will
-default to English. The `set_locale` method will return the locale, as a string, that FastGettext will now
-use to report PuppetForge errors.
+To overwrite the default of `https://forgeapi.puppet.com` and set a custom url for the Forge API:
 
 ```ruby
-# Assuming the German translations exist, this will set the reporting language
-# to German
+PuppetForge.host = "https://your-own-api.url/"
+```
+
+### Authorization
 
-locale = FastGettext.set_locale "de_DE"
+To authorize your requests with an API key from a Forge user account:
 
-# If it successfully finds Germany's locale, locale will be "de_DE"
-# If it fails to find any German locale, locale will be "en"
+```ruby
+PuppetForge::Connection.authorization = "<your-api-key-here>"
 ```
 
+You can generate API keys on your user profile page once you've [logged into the Forge website](https://forge.puppet.com/login).
+
 ## Caveats
 
 This library currently does no response caching of its own, instead opting to

data/Rakefile

@@ -1,7 +1 @@
 require "bundler/gem_tasks"
-
-# i18n/gettext Rake tasks
-spec = Gem::Specification.find_by_name 'gettext-setup'
-load "#{spec.gem_dir}/lib/tasks/gettext.rake"
-GettextSetup.initialize(File.absolute_path('locales', File.dirname(__FILE__)))
-

data/lib/puppet_forge/connection/connection_failure.rb

@@ -9,21 +9,11 @@ module PuppetForge
         @app.call(env)
       rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
         baseurl = env[:url].dup
+        errmsg = "Unable to connect to %{scheme}://%{host}" % { scheme: baseurl.scheme, host: baseurl.host }
         if proxy = env[:request][:proxy]
-          errmsg = _("Unable to connect to %{scheme}://%{host} (using proxy %{proxy}) (for request %{path_query})") % {
-            scheme: baseurl.scheme,
-            host: baseurl.host,
-            proxy: proxy.uri.to_s,
-            path_query: baseurl.request_uri,
-          }
-        else
-          errmsg = _("Unable to connect to %{scheme}://%{host} (for request %{path_query})") % {
-            scheme: baseurl.scheme,
-            host: baseurl.host,
-            path_query: baseurl.request_uri,
-          }
+          errmsg << " (using proxy %{proxy})" % { proxy: proxy.uri.to_s }
         end
-        errmsg << ": #{e.message}"
+        errmsg << " (for request %{path_query}): %{message}" % { message: e.message, path_query: baseurl.request_uri }
         m = Faraday::ConnectionFailed.new(errmsg)
         m.set_backtrace(e.backtrace)
         raise m

data/lib/puppet_forge/connection.rb

@@ -2,7 +2,6 @@ require 'puppet_forge/connection/connection_failure'
 
 require 'faraday'
 require 'faraday_middleware'
-require 'puppet_forge/middleware/symbolify_json'
 
 module PuppetForge
   # Provide a common mixin for adding a HTTP connection to classes.
@@ -24,6 +23,8 @@ module PuppetForge
 
     attr_writer :conn
 
+    AUTHORIZATION_TOKEN_REGEX = /^[a-f0-9]{64}$/
+
     USER_AGENT = "#{PuppetForge.user_agent} PuppetForge.gem/#{PuppetForge::VERSION} Faraday/#{Faraday::VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_PLATFORM})".strip
 
     def self.authorization=(token)
@@ -81,7 +82,7 @@ module PuppetForge
 
       begin
         # Use Typhoeus if available.
-        Gem::Specification.find_by_name('typhoeus', '~> 1.0.1')
+        Gem::Specification.find_by_name('typhoeus', '~> 1.4')
         require 'typhoeus/adapters/faraday'
         adapter = :typhoeus
       rescue Gem::LoadError
@@ -102,7 +103,7 @@ module PuppetForge
       options = { :headers => { :user_agent => USER_AGENT } }.merge(opts)
 
       if token = PuppetForge::Connection.authorization
-        options[:headers][:authorization] = token
+        options[:headers][:authorization] = token =~ AUTHORIZATION_TOKEN_REGEX ? "Bearer #{token}" : token
       end
 
       if lang = PuppetForge::Connection.accept_language
@@ -114,8 +115,8 @@ module PuppetForge
       end
 
       Faraday.new(url, options) do |builder|
-        builder.use PuppetForge::Middleware::SymbolifyJson
-        builder.response(:json, :content_type => /\bjson$/)
+        builder.use FaradayMiddleware::FollowRedirects
+        builder.response(:json, :content_type => /\bjson$/, :parser_options => { :symbolize_names => true })
         builder.response(:raise_error)
         builder.use(:connection_failure)
 

data/lib/puppet_forge/error.rb

@@ -16,11 +16,15 @@ module PuppetForge
     def initialize(options)
       @entry_path = options[:entry_path]
       @directory  = options[:directory]
-      super _("Attempt to install file into %{path} under %{directory}") % {path: @entry_path.inspect, directory: @directory.inspect}
+      super "Attempt to install file into #{@entry_path.inspect} under #{@directory.inspect}"
     end
 
     def multiline
-      _("Could not install package\n  Package attempted to install file into\n  %{path} under %{directory}.") % {path: @entry_path.inspect, directory: @directory.inspect}
+      <<-MSG.strip
+Could not install package
+  Package attempted to install file into
+  #{@entry_path.inspect} under #{@directory.inspect}.
+      MSG
     end
   end
 

data/lib/puppet_forge/lazy_relations.rb

@@ -24,7 +24,7 @@ module PuppetForge
       version = class_name.split("::")[-2]
 
       if version.nil?
-        raise RuntimeError, _("Unable to determine the parent PuppetForge version module")
+        raise RuntimeError, "Unable to determine the parent PuppetForge version module"
       end
 
       PuppetForge.const_get(version)

data/lib/puppet_forge/unpacker.rb

@@ -39,7 +39,7 @@ module PuppetForge
       begin
         PuppetForge::Tar.instance.unpack(@filename, @tmpdir)
       rescue PuppetForge::ExecutionFailure => e
-        raise RuntimeError, _("Could not extract contents of module archive: %{error_msg}") % {error_msg: e.message}
+        raise RuntimeError, "Could not extract contents of module archive: #{e.message}"
       end
     end
 
@@ -61,7 +61,7 @@ module PuppetForge
       if metadata_file
         @root_dir = Pathname.new(metadata_file).dirname
       else
-        raise _("No valid metadata.json found!")
+        raise "No valid metadata.json found!"
       end
     end
   end

data/lib/puppet_forge/v3/base.rb

@@ -56,7 +56,7 @@ module PuppetForge
         # @private
         def request(resource, item = nil, params = {}, reset_connection = false, conn_opts = {})
           conn(reset_connection, conn_opts) if reset_connection
-          unless conn.url_prefix =~ /^#{PuppetForge.host}/
+          unless conn.url_prefix.to_s =~ /^#{PuppetForge.host}/
             conn.url_prefix = "#{PuppetForge.host}"
           end
 

data/lib/puppet_forge/v3/metadata.rb

@@ -63,7 +63,7 @@ module PuppetForge
         validate_version_range(version_requirement) if version_requirement
 
         if dup = @data['dependencies'].find { |d| d.full_module_name == name && d.version_requirement != version_requirement }
-          raise ArgumentError, _("Dependency conflict for %{module_name}: Dependency %{conflict_name} was given conflicting version requirements %{version} and %{conflict_version}. Verify that there are no duplicates in the metadata.json or the Modulefile.") % {module_name: full_module_name, conflict_name: name, version: version_requirement, conflict_version: dup.version_requirement}
+          raise ArgumentError, "Dependency conflict for #{full_module_name}: Dependency #{name} was given conflicting version requirements #{version_requirement} and #{dup.version_requirement}. Verify that there are no duplicates in the metadata.json or the Modulefile."
         end
 
         dep = Dependency.new(name, version_requirement, repository)
@@ -165,30 +165,31 @@ module PuppetForge
 
         err = case modname
         when nil, '', :namespace_missing
-          _("the field must be a namespaced module name")
+          "the field must be a namespaced module name"
         when /[^a-z0-9_]/i
-          _("the module name contains non-alphanumeric (or underscore) characters")
+          "the module name contains non-alphanumeric (or underscore) characters"
         when /^[^a-z]/i
-          _("the module name must begin with a letter")
+          "the module name must begin with a letter"
         else
-          _("the namespace contains non-alphanumeric characters")
+          "the namespace contains non-alphanumeric characters"
         end
 
-        raise ArgumentError, _("Invalid 'name' field in metadata.json: %{error}") % {error: err}
+        raise ArgumentError, "Invalid 'name' field in metadata.json: #{err}"
       end
 
       # Validates that the version string can be parsed by SemanticPuppet.
       def validate_version(version)
         return if SemanticPuppet::Version.valid?(version)
 
-        raise ArgumentError, _("Invalid 'version' field in metadata.json: version string cannot be parsed as a valid Semantic Version")
+        err = "version string cannot be parsed as a valid Semantic Version"
+        raise ArgumentError, "Invalid 'version' field in metadata.json: #{err}"
       end
 
       # Validates that the version range can be parsed by SemanticPuppet.
       def validate_version_range(version_range)
         SemanticPuppet::VersionRange.parse(version_range)
       rescue ArgumentError => e
-        raise ArgumentError, _("Invalid 'version_range' field in metadata.json: %{error}") % {error: e} 
+        raise ArgumentError, "Invalid 'version_range' field in metadata.json: #{e}"
       end
     end
   end

data/lib/puppet_forge/v3/release.rb

@@ -29,7 +29,7 @@ module PuppetForge
         resp = self.class.conn.get(download_url)
         path.open('wb') { |fh| fh.write(resp.body) }
       rescue Faraday::ResourceNotFound => e
-        raise PuppetForge::ReleaseNotFound, (_("The module release %{release_slug} does not exist on %{url}.") % {release_slug: slug, url: self.class.conn.url_prefix}), e.backtrace
+        raise PuppetForge::ReleaseNotFound, "The module release #{slug} does not exist on #{self.class.conn.url_prefix}.", e.backtrace
       rescue Faraday::ClientError => e
         if e.response && e.response[:status] == 403
           raise PuppetForge::ReleaseForbidden.from_response(e.response)

data/lib/puppet_forge/version.rb

@@ -1,3 +1,3 @@
 module PuppetForge
-  VERSION = '2.3.3' # Library version
+  VERSION = '3.2.0' # Library version
 end

data/lib/puppet_forge.rb

@@ -1,5 +1,4 @@
 require 'puppet_forge/version'
-require 'gettext-setup'
 
 module PuppetForge
   class << self
@@ -15,9 +14,7 @@ module PuppetForge
     end
   end
 
-  GettextSetup.initialize(File.absolute_path('../locales', File.dirname(__FILE__)))
-
-  DEFAULT_FORGE_HOST = 'https://forgeapi.puppetlabs.com/'
+  DEFAULT_FORGE_HOST = 'https://forgeapi.puppet.com/'
 
   self.host = DEFAULT_FORGE_HOST
 

data/puppet_forge.gemspec

@@ -18,13 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_runtime_dependency "faraday", [">= 0.9.0", "< 0.18.0", "!= 0.13.1"]
-  spec.add_runtime_dependency "faraday_middleware", [">= 0.9.0", "< 0.14.0"]
-  spec.add_dependency 'semantic_puppet', '~> 1.0'
-  spec.add_dependency 'minitar'
-  spec.add_dependency 'gettext-setup', '~> 0.11'
+  spec.add_runtime_dependency "faraday", "~> 1.3"
+  spec.add_runtime_dependency "faraday_middleware", "~> 1.0"
+  spec.add_dependency "semantic_puppet", "~> 1.0"
+  spec.add_dependency "minitar"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"