puppet-resource_api 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87d10235bb663c8a935d0ff8e1c50dc468e953255d96dd075df6c47e169a171
-  data.tar.gz: 91560d8c900e70924b4f9ca4c527a8100d3ad5604a0403227440a4e82f1eb00a
+  metadata.gz: d29f5e5eebf841dba323c731c6a6a423fc904b7cc52a000a708307ff5bbe51cc
+  data.tar.gz: 01e210072f6c0154c3964a93e45ebd8388469c25a0e47b5d4ab547e9f9321733
 SHA512:
-  metadata.gz: ef62b7f3ac5119b64136f54200818d5753bf4612636560135724e2621d200c4067e07e700507613d54461a2c5eaf13be02aa0892fc8b2ed230fa66f163566ad2
-  data.tar.gz: fd919bff975e27af3807cd0c1818ee50c4166e26ba55b136bb5a432b11ee4a1228478525ade80aa954579389d59ef2114eb247abdb16b062509d800e149a82b9
+  metadata.gz: c91d23aa2991cbadf1714930bb5a02e5366f1d8308350f9be96d4c76eef12a5b462776f6d068dd80762b5f11b667a734d7dc04593d5fd38b294c36bae6e0f8f3
+  data.tar.gz: c9ba9579b7057a34c5056db7d4bf89ecceafb7e4eab8c3fe62dfdafe190eb353d72e28e680a7d91b472351b14bccf563b744aff5c2f6a0ed9773abee7e24f42c

data/CHANGELOG.md

@@ -3,6 +3,20 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.4.1](https://github.com/puppetlabs/puppet-resource_api/tree/v1.4.1) (2018-07-20)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.4.0...v1.4.1)
+
+**Fixed bugs:**
+
+- Fix "undefined method `rs\_value'" error with metaparams [\#108](https://github.com/puppetlabs/puppet-resource_api/pull/108) ([DavidS](https://github.com/DavidS))
+- Improve log\_exception output from PuppetContext [\#103](https://github.com/puppetlabs/puppet-resource_api/pull/103) ([da-ar](https://github.com/da-ar))
+
+**Merged pull requests:**
+
+- Misc fixes: license metadata, announcement template, puppet load fix [\#107](https://github.com/puppetlabs/puppet-resource_api/pull/107) ([DavidS](https://github.com/DavidS))
+- Minor changes to README [\#106](https://github.com/puppetlabs/puppet-resource_api/pull/106) ([clairecadman](https://github.com/clairecadman))
+- Release prep for v1.4.0 [\#102](https://github.com/puppetlabs/puppet-resource_api/pull/102) ([DavidS](https://github.com/DavidS))
+
 ## [v1.4.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.4.0) (2018-06-19)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.3.0...v1.4.0)
 

data/Gemfile

@@ -13,7 +13,13 @@ group :tests do
   gem 'rake', '~> 10.0'
   gem 'rspec', '~> 3.0'
   gem 'rubocop-rspec'
-  gem 'rubocop'
+  # rubocop 0.58 throws when testing against ruby 2.1, so pin to the latest,
+  # unless we're dealing with jruby...
+  if RUBY_PLATFORM == 'java'
+    gem 'rubocop'
+  else
+    gem 'rubocop', '0.57.2'
+  end
   gem 'simplecov-console'
   # the test gems required for module testing
   gem 'puppetlabs_spec_helper', '~> 2.7'

data/README.md

@@ -1,15 +1,14 @@
-# Puppet::ResourceApi [![TravisCI Build Status](https://travis-ci.org/puppetlabs/puppet-resource_api.svg?branch=master)](https://travis-ci.org/puppetlabs/puppet-resource_api) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/8o9s1ax0hs8lm5fd/branch/master?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppet-resource-api/branch/master)
- [![codecov](https://codecov.io/gh/puppetlabs/puppet-resource_api/branch/master/graph/badge.svg)](https://codecov.io/gh/puppetlabs/puppet-resource_api)
+# Puppet::ResourceApi [![TravisCI Build Status](https://travis-ci.org/puppetlabs/puppet-resource_api.svg?branch=master)](https://travis-ci.org/puppetlabs/puppet-resource_api) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/8o9s1ax0hs8lm5fd/branch/master?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppet-resource-api/branch/master) [![codecov](https://codecov.io/gh/puppetlabs/puppet-resource_api/branch/master/graph/badge.svg)](https://codecov.io/gh/puppetlabs/puppet-resource_api)
 
 This is an implementation of the [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) proposal. Find a working example of a new-style provider in the [experimental puppetlabs-apt branch](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb). There is also the corresponding [type](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/type/apt_key2.rb), [provider](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb), and [new unit tests](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/spec/unit/puppet/provider/apt_key2/apt_key2_spec.rb) for 100% coverage.
 
-## Getting started
+## Install the Resource API
 
-* Install the [PDK](https://puppet.com/download-puppet-development-kit) 1.4.
+1. Download the [Puppet Development Kit](https://puppet.com/download-puppet-development-kit) (PDK) appropriate to your operating system and architecture.
 
-* Create a [new module](https://puppet.com/docs/pdk/latest/pdk_generating_modules.html) with the PDK, or work with an existing PDK-enabled module.
+2. Create a [new module](https://puppet.com/docs/pdk/latest/pdk_generating_modules.html) with the PDK, or work with an existing PDK-enabled module. To create a new module, run `pdk new module <MODULE_NAME>` from the command line, specifying the name of the module. Respond to the dialog questions.
 
-* Add the `puppet-resource_api` gem, and enable "modern" rspec-style mocking through the `.sync.yml`:
+3. To add the `puppet-resource_api` gem and enable "modern" rspec-style mocking, open the `sync.yml` file in your editor, and add the following content:
 
 ```
 # .sync.yml
@@ -22,7 +21,9 @@ spec/spec_helper.rb:
   mock_with: ':rspec'
 ```
 
-*  Apply the changes by running `pdk update`:
+4. Apply these changes by running `pdk update`
+
+You will get the following response:
 
 ```
 $ pdk update
@@ -45,7 +46,9 @@ Do you want to continue and make these changes to your module? Yes
 $
 ```
 
-* Create the required files for a new type and provider in the module with `pdk new provider <provider_name>`.
+5. Create the required files for a new type and provider in the module by running `pdk new provider <provider_name>`
+ 
+You will get the following response:
 
 ```
 $ pdk new provider foo
@@ -55,9 +58,7 @@ pdk (INFO): Creating '.../example/spec/unit/puppet/provider/foo/foo_spec.rb' fro
 $
 ```
 
-Note that the templates released with PDK 1.4 suffer from the fallout of [PDK-911](https://tickets.puppetlabs.com/browse/PDK-911), and need all occurrences of `:present` changed to `'present'`. This will be fixed in PDK 1.5.
-
-The three generated files are the type, the implementation, and the unit tests. The default template contains an example that demonstrates the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider:
+The three generated files are the type, the implementation, and the unit tests. The default template contains an example that demonstrates the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider, which will look like this:
 
 ```
 $ pdk test unit

data/lib/puppet/resource_api/base_context.rb

@@ -1,5 +1,3 @@
-require 'puppet/util'
-require 'puppet/util/network_device'
 require 'puppet/resource_api/type_definition'
 
 module Puppet; end
@@ -8,15 +6,13 @@ class Puppet::ResourceApi::BaseContext
   attr_reader :type
 
   def initialize(definition)
-    raise Puppet::DevError, 'BaseContext requires definition to be a Hash' unless definition.is_a?(Hash)
+    raise ArgumentError, 'BaseContext requires definition to be a Hash' unless definition.is_a?(Hash)
     @typename = definition[:name]
     @type = Puppet::ResourceApi::TypeDefinition.new(definition)
   end
 
   def device
-    # TODO: evaluate facter_url setting for loading config if there is no `current` NetworkDevice
-    raise 'no device configured' unless Puppet::Util::NetworkDevice.current
-    Puppet::Util::NetworkDevice.current
+    raise 'Received device() on an unprepared BaseContext. Use a PuppetContext instead.'
   end
 
   def failed?

data/lib/puppet/resource_api/glue.rb

@@ -4,13 +4,14 @@ module Puppet; end # rubocop:disable Style/Documentation
 module Puppet::ResourceApi
   # A trivial class to provide the functionality required to push data through the existing type/provider parts of puppet
   class ResourceShim
-    attr_reader :values, :typename, :namevars, :attr_def
+    attr_reader :values, :typename, :namevars, :attr_def, :catalog
 
-    def initialize(resource_hash, typename, namevars, attr_def)
+    def initialize(resource_hash, typename, namevars, attr_def, catalog = nil)
       @values = resource_hash.dup.freeze # whatevs
       @typename = typename
       @namevars = namevars
       @attr_def = attr_def
+      @catalog = catalog
     end
 
     def title

data/lib/puppet/resource_api/puppet_context.rb

@@ -2,8 +2,14 @@ require 'puppet/resource_api/base_context'
 require 'puppet/util/logging'
 
 class Puppet::ResourceApi::PuppetContext < Puppet::ResourceApi::BaseContext
+  def device
+    # TODO: evaluate facter_url setting for loading config if there is no `current` NetworkDevice
+    raise 'no device configured' unless Puppet::Util::NetworkDevice.current
+    Puppet::Util::NetworkDevice.current
+  end
+
   def log_exception(exception, message: 'Error encountered', trace: false)
-    self.class.logging_proxy.log_exception(exception, message, trace: trace)
+    super(exception, message: message, trace: trace || Puppet[:trace])
   end
 
   protected
@@ -11,15 +17,4 @@ class Puppet::ResourceApi::PuppetContext < Puppet::ResourceApi::BaseContext
   def send_log(level, message)
     Puppet::Util::Log.create(level: level, message: message)
   end
-
-  # Avoid including Puppet::Util::Logging into the main class to avoid the namespace clashes
-  class LoggingProxy
-    include Puppet::Util::Logging
-  end
-
-  class << self
-    def logging_proxy
-      @logging_proxy ||= LoggingProxy.new
-    end
-  end
 end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.4.0'.freeze
+    VERSION = '1.4.1'.freeze
   end
 end

data/lib/puppet/resource_api.rb

@@ -78,6 +78,7 @@ module Puppet::ResourceApi
         # $stderr.puts "A: #{attributes.inspect}"
         if attributes.is_a? Puppet::Resource
           @title = attributes.title
+          @catalog = attributes.catalog
           attributes = attributes.to_hash
         else
           @ral_find_absent = true
@@ -111,7 +112,7 @@ module Puppet::ResourceApi
       define_method(:to_resource_shim) do |resource|
         resource_hash = Hash[resource.keys.map { |k| [k, resource[k]] }]
         resource_hash[:title] = resource.title
-        ResourceShim.new(resource_hash, type_definition.name, type_definition.namevars, type_definition.attributes)
+        ResourceShim.new(resource_hash, type_definition.name, type_definition.namevars, type_definition.attributes, catalog)
       end
 
       validate do
@@ -343,7 +344,8 @@ module Puppet::ResourceApi
 
         # puts 'flush'
         # skip puppet's injected metaparams
-        target_state = Hash[@parameters.reject { |k, _v| [:loglevel, :noop, :provider].include? k }.map { |k, v| [k, v.rs_value] }]
+        actual_params = @parameters.select { |k, _v| type_definition.attributes.key? k }
+        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

data/lib/puppet/util/network_device/simple/device.rb

@@ -1,7 +1,10 @@
 require 'hocon'
 require 'hocon/config_syntax'
-require 'puppet/util/network_device/base'
 
+# avoid loading puppet code base
+module Puppet::Util; end
+# avoid loading puppet code base
+class Puppet::Util::NetworkDevice; end
 module Puppet::Util::NetworkDevice::Simple
   # A basic device class, that reads its configuration from the provided URL.
   # The URL has to be a local file URL.

data/misc/ANNOUNCEMENT_TEMPLATE.md

@@ -16,7 +16,9 @@ Hi all,
 
 We're pleased to announce that version X.Y.Z of the Resource API is being released today.
 
-The Resource API provides a simple way to create new native resources in the form of types and providers for Puppet. It is provided as a Ruby gem to be referenced within modules. Support for it has been included as an experimental feature in version 1.4 of the Puppet Development Kit (`pdk new provider`). Use the [resource_api module](https://forge.puppet.com/puppetlabs/resource_api) or the [puppet 6 nightly packages](https://groups.google.com/d/msg/puppet-users/N3LJGhsrqkU/TUEsq7VfDQAJ) to deploy it in your infrastructure.
+The Resource API provides a simple way to create new native resources in the form of types and providers for Puppet. Using a little bit of ruby, you can finally get rid of that brittle exec, or manage that one API that eluded you until now.
+
+It is provided as a Ruby gem to be referenced within modules. Support for it has been included as an experimental feature in the Puppet Development Kit (see `pdk new provider --help`). Use the [resource_api module](https://forge.puppet.com/puppetlabs/resource_api) or the [puppet 6 nightly packages](https://groups.google.com/d/msg/puppet-users/N3LJGhsrqkU/TUEsq7VfDQAJ) to deploy it in your infrastructure.
 
 The new release of the Resource API provides the following enhancements:
 
@@ -30,9 +32,9 @@ The new release also contains the following notable bugfixes:
 * E
 * F
 
-See the [CHANGELOG](https://github.com/puppetlabs/puppet-resource_api/blob/master/CHANGELOG.md) for a full list of changes
+See the [CHANGELOG](https://github.com/puppetlabs/puppet-resource_api/blob/master/CHANGELOG.md) for a full list of changes.
 
-We encourage all module developers to review the Resource API and use it when creating types and providers. For reference, there is an example of its usage in a [branch](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb) of the apt module.
+We encourage all module developers to review the Resource API and use it when creating types and providers. The [README](https://github.com/puppetlabs/puppet-resource_api/blob/master/README.md) gets you going quickly. To see some example code see [this simple Philips Hue type](https://github.com/da-ar/hue_rsapi) or [this experimental apt_key provider](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb).
 
 Please let us know of your experiences with the Resource API, either here, on [Slack](https://slack.puppet.com/) (#forge-modules), or on the [github repo](https://github.com/puppetlabs/puppet-resource_api).
 

data/puppet-resource_api.gemspec

@@ -5,6 +5,7 @@ require 'puppet/resource_api/version'
 Gem::Specification.new do |spec|
   spec.name          = 'puppet-resource_api'
   spec.version       = Puppet::ResourceApi::VERSION
+  spec.license       = 'Apache-2.0'
   spec.authors       = ['David Schmitt']
   spec.email         = ['david.schmitt@puppet.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon
@@ -63,7 +63,8 @@ files:
 - misc/ANNOUNCEMENT_TEMPLATE.md
 - puppet-resource_api.gemspec
 homepage: https://github.com/puppetlabs/puppet-resource_api
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []