puppet-resource_api 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 105c2d9cb6636fc3d70e1250bf84e4a56392199aadbfcb3be58471282f9f9c36
-  data.tar.gz: 1ce5d86677e93beb2375fd83c7e1eb95b4b3132cf001b6cf2534135244c53e84
+  metadata.gz: 9e2e55069c15f749148ae6c4a9fc626e77191f0ebba51123893f5d82c6d22a9d
+  data.tar.gz: 7add3eb881e226501009caf3150001ee7d83891e301a5d41081fffe3dd77d4cf
 SHA512:
-  metadata.gz: 057617a9cdde0351dcee064dfaba1cd439c60dd6112feea96b5045febb80248ce9bcc96fb9d0ba893021efafc275f5ded07e29ed6ff61f9d4df7965f4586e378
-  data.tar.gz: 4640b315d89e61001df0e41f304547c686e1317e4428dd102a9232bf46c930f2eb5b3f3508880372d70474e8235f014e363d0a9928bdaf28af01a343927081dc
+  metadata.gz: d34e5647c07817985e6ec9029e2e7635dc94f0873943af524ae737d27166fe5da76a7bbc8649785d46f7aa0a99097c97e70478a6d797b0cb28562734d1d478d7
+  data.tar.gz: 1341a7774319c44650747f1ccba7178e70db1dff676c019d7614ae1ee8fa94af5f33ecaff8eb51ad2942b6a97252e25c8c381f12088b7fd33f8bf07ebdce91d2

data/.travis.yml

@@ -52,7 +52,7 @@ matrix:
       env: PUPPET_GEM_VERSION='~> 4.8.0'
     - rvm: 2.1.9
       env: PUPPET_GEM_VERSION='~> 4.7.0'
-    - rvm: 2.4.3
+    - rvm: 2.5.1
       env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#master'
 notifications:
   hipchat:

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.5.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.5.0) (2018-09-12)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.4.2...v1.5.0)
+
+**Implemented enhancements:**
+
+- \(PDK-1150\) Allow providers to override :title when retrieving resources [\#115](https://github.com/puppetlabs/puppet-resource_api/pull/115) ([da-ar](https://github.com/da-ar))
+
+**Fixed bugs:**
+
+- \(maint\) create a new default value instance on every access [\#118](https://github.com/puppetlabs/puppet-resource_api/pull/118) ([DavidS](https://github.com/DavidS))
+- \(PDK-1091\) Fix Sensitive value handling [\#117](https://github.com/puppetlabs/puppet-resource_api/pull/117) ([DavidS](https://github.com/DavidS))
+- \(MODULES-7679\) correctly handle simple\_get\_filter providers [\#113](https://github.com/puppetlabs/puppet-resource_api/pull/113) ([da-ar](https://github.com/da-ar))
+
+**Merged pull requests:**
+
+- Release prep for v1.4.2 [\#112](https://github.com/puppetlabs/puppet-resource_api/pull/112) ([DavidS](https://github.com/DavidS))
+
 ## [v1.4.2](https://github.com/puppetlabs/puppet-resource_api/tree/v1.4.2) (2018-08-09)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.4.1...v1.4.2)
 

data/Gemfile

@@ -45,8 +45,4 @@ def location_for(place_or_version, fake_version = nil)
   end
 end
 
-if ENV['PUPPET_GEM_VERSION']
-  gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION'])
-else
-  gem 'puppet', github: 'DavidS/puppet', ref: 'device-apply'
-end
+gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION'])

data/README.md

@@ -179,6 +179,10 @@ After this, `puppet device` will be able to use the new provider, and supply it
 
 The [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) describes details of all the capabilities of this gem.
 
+The [hue_rsapi module](https://github.com/da-ar/hue_rsapi) is a very simple example for using the Resource API for remote resources.
+
+The [meraki module](https://github.com/meraki/puppet-module) is a full example for using the Resource API for remote resources.
+
 This [Introduction to Testing Puppet Modules](https://www.netways.de/index.php?id=3445#c44135) talk describes rspec usage in more detail.
 
 The [RSpec docs](https://relishapp.com/rspec) provide an overview of the capabilities of rspec.
@@ -215,7 +219,6 @@ Restrictions of puppet:
 * Attributes cannot be called `title`, `provider`, or any of the [metaparameters](https://puppet.com/docs/puppet/5.5/metaparameter.html), as those are reserved by puppet itself.
 
 Future possibilities:
-* [Composite Namevars](https://tickets.puppetlabs.com/browse/PDK-531)
 * [Multiple Providers](https://tickets.puppetlabs.com/browse/PDK-530)
 * [Commands API](https://tickets.puppetlabs.com/browse/PDK-847)
 

data/appveyor.yml

@@ -7,7 +7,8 @@ branches:
 environment:
   matrix:
     - RUBY_VERSION: 24-x64
-    - RUBY_VERSION: 21-x64
+    - PUPPET_GEM_VERSION: '~> 4.0'
+      RUBY_VERSION: 21-x64
 
 install:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;C:\mingw-w64\x86_64-6.3.0-posix-seh-rt_v5-rev1\mingw64\bin;%PATH%

data/lib/puppet/resource_api.rb

@@ -79,10 +79,21 @@ module Puppet::ResourceApi
         if attributes.is_a? Puppet::Resource
           @title = attributes.title
           @catalog = attributes.catalog
+          sensitives = attributes.sensitive_parameters
           attributes = attributes.to_hash
         else
           @ral_find_absent = true
+          sensitives = []
         end
+
+        # undo puppet's unwrapping of Sensitive values to provide a uniform experience for providers
+        # See https://tickets.puppetlabs.com/browse/PDK-1091 for investigation and background
+        sensitives.each do |name|
+          if attributes.key?(name) && !attributes[name].is_a?(Puppet::Pops::Types::PSensitiveType::Sensitive)
+            attributes[name] = Puppet::Pops::Types::PSensitiveType::Sensitive.new(attributes[name])
+          end
+        end
+
         # $stderr.puts "B: #{attributes.inspect}"
         if type_definition.feature?('canonicalize')
           attributes = my_provider.canonicalize(context, [attributes])[0]
@@ -188,9 +199,13 @@ module Puppet::ResourceApi
                 # work around https://tickets.puppetlabs.com/browse/PUP-2368
                 defaultto :true # rubocop:disable Lint/BooleanSymbol
               else
-                defaultto options[:default]
+                # marshal the default option to decouple that from the actual value.
+                # we cache the dumped value in `marshalled`, but use a block to unmarshal
+                # everytime the value is requested. Objects that can't be marshalled
+                # See https://stackoverflow.com/a/8206537/4918
+                marshalled = Marshal.dump(options[:default])
+                defaultto { Marshal.load(marshalled) } # rubocop:disable Security/MarshalLoad
               end
-              # defaultto options[:default]
             end
           end
 
@@ -301,42 +316,53 @@ module Puppet::ResourceApi
         # force autoloading of the provider
         provider(type_definition.name)
 
-        my_provider.get(context).map do |resource_hash|
+        initial_fetch = if type_definition.feature?('simple_get_filter')
+                          my_provider.get(context, [])
+                        else
+                          my_provider.get(context)
+                        end
+
+        initial_fetch.map do |resource_hash|
           type_definition.check_schema(resource_hash)
-          result = new(title: resource_hash[type_definition.namevars.first])
+          # allow a :title from the provider to override the default
+          result = if resource_hash.key? :title
+                     new(title: resource_hash[:title])
+                   else
+                     new(title: resource_hash[type_definition.namevars.first])
+                   end
           result.cache_current_state(resource_hash)
           result
         end
       end
 
       define_method(:refresh_current_state) do
-        @rapi_current_state = if type_definition.feature?('simple_get_filter')
-                                my_provider.get(context, [title]).first
-                              else
-                                my_provider.get(context).find { |h| namevar_match?(h) }
-                              end
-
-        if @rapi_current_state
-          type_definition.check_schema(@rapi_current_state)
-          strict_check(@rapi_current_state) if type_definition.feature?('canonicalize')
+        @rsapi_current_state = if type_definition.feature?('simple_get_filter')
+                                 my_provider.get(context, [title]).find { |h| namevar_match?(h) }
+                               else
+                                 my_provider.get(context).find { |h| namevar_match?(h) }
+                               end
+
+        if @rsapi_current_state
+          type_definition.check_schema(@rsapi_current_state)
+          strict_check(@rsapi_current_state) if type_definition.feature?('canonicalize')
         else
-          @rapi_current_state = { title: title }
-          @rapi_current_state[:ensure] = :absent if type_definition.ensurable?
+          @rsapi_current_state = { title: title }
+          @rsapi_current_state[:ensure] = :absent if type_definition.ensurable?
         end
       end
 
       # Use this to set the current state from the `instances` method
       def cache_current_state(resource_hash)
-        @rapi_current_state = resource_hash
-        strict_check(@rapi_current_state) if type_definition.feature?('canonicalize')
+        @rsapi_current_state = resource_hash
+        strict_check(@rsapi_current_state) if type_definition.feature?('canonicalize')
       end
 
       define_method(:retrieve) do
-        refresh_current_state unless @rapi_current_state
+        refresh_current_state unless @rsapi_current_state
 
-        Puppet.debug("Current State: #{@rapi_current_state.inspect}")
+        Puppet.debug("Current State: #{@rsapi_current_state.inspect}")
 
-        result = Puppet::Resource.new(self.class, title, parameters: @rapi_current_state)
+        result = Puppet::Resource.new(self.class, title, parameters: @rsapi_current_state)
         # puppet needs ensure to be a symbol
         result[:ensure] = result[:ensure].to_sym if type_definition.ensurable? && result[:ensure].is_a?(String)
 
@@ -360,17 +386,17 @@ module Puppet::ResourceApi
         target_state = Hash[actual_params.map { |k, v| [k, v.rs_value] }]
         target_state = my_provider.canonicalize(context, [target_state]).first if type_definition.feature?('canonicalize')
 
-        retrieve unless @rapi_current_state
+        retrieve unless @rsapi_current_state
 
-        return if @rapi_current_state == target_state
+        return if @rsapi_current_state == target_state
 
         Puppet.debug("Target State: #{target_state.inspect}")
 
         # enforce init_only attributes
-        if Puppet.settings[:strict] != :off && @rapi_current_state && (@rapi_current_state[:ensure] == 'present' && target_state[:ensure] == 'present')
+        if Puppet.settings[:strict] != :off && @rsapi_current_state && (@rsapi_current_state[:ensure] == 'present' && target_state[:ensure] == 'present')
           target_state.each do |name, value|
-            next unless definition[:attributes][name][:behaviour] == :init_only && value != @rapi_current_state[name]
-            message = "Attempting to change `#{name}` init_only attribute value from `#{@rapi_current_state[name]}` to `#{value}`"
+            next unless definition[:attributes][name][:behaviour] == :init_only && value != @rsapi_current_state[name]
+            message = "Attempting to change `#{name}` init_only attribute value from `#{@rsapi_current_state[name]}` to `#{value}`"
             case Puppet.settings[:strict]
             when :warning
               Puppet.warning(message)
@@ -381,14 +407,14 @@ module Puppet::ResourceApi
         end
 
         if type_definition.feature?('supports_noop')
-          my_provider.set(context, { title => { is: @rapi_current_state, should: target_state } }, noop: noop?)
+          my_provider.set(context, { title => { is: @rsapi_current_state, should: target_state } }, noop: noop?)
         else
-          my_provider.set(context, title => { is: @rapi_current_state, should: target_state }) unless noop?
+          my_provider.set(context, title => { is: @rsapi_current_state, should: target_state }) unless noop?
         end
         raise 'Execution encountered an error' if context.failed?
 
         # remember that we have successfully reached our desired state
-        @rapi_current_state = target_state
+        @rsapi_current_state = target_state
       end
 
       define_method(:raise_missing_attrs) do

data/lib/puppet/resource_api/type_definition.rb

@@ -74,7 +74,7 @@ class Puppet::ResourceApi::TypeDefinition
   # Modifies the resource passed in, leaving only valid attributes
   def check_schema_keys(resource)
     rejected = []
-    resource.reject! { |key| rejected << key unless attributes.key? key }
+    resource.reject! { |key| rejected << key if key != :title && attributes.key?(key) == false }
     rejected
   end
 

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.4.2'.freeze
+    VERSION = '1.5.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon