puppet-resource_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b09586d1fbec2da3bfe620d86c3fc0caecc5e48a
-  data.tar.gz: 6274618f2f0c6e43a548f804204b68a78ebb65a8
+  metadata.gz: 3227174268f12543890f43ae45eceed3847d3575
+  data.tar.gz: a9a65d48074644c7669ed3785e293cbe14c9239a
 SHA512:
-  metadata.gz: 0f1ad4b6b4bbf62b41b813c6553d0efdbde9285f13eaafa27414dd6e3dc6fc6da1d60d8f1121a50895fa4e295944250fbb2acf6ca447728a1781ec50793eb9c6
-  data.tar.gz: c75bde4518f932e38f18974e1ac0b306e9e3b5d78b9e272ba736ccc78f3b41e4da39cb37a92ba2551cb87685ef3a1112454b8d2772ee29c4db0e25229fa99a34
+  metadata.gz: 2d8b3391ac937a006b0f35ffe2b8e53e2bbb4277f9ef6601bfa7be543454367bd13941082a0b184006e813a982fb7b396377659ebd65c8ab0776399c6a736493
+  data.tar.gz: ecaedb84ace752f764aef56fc233ed3bcccb3759a074610f53059d6fff7f7b45074f765b0238eb451169c87d99cf7e0e9162acfc387634ee977b5d7d50648e7f

data/.codecov.yml

@@ -0,0 +1,3 @@
+---
+# disable comments, info can be gotten from the pr status updates, and the comment editing spams the hipchat notifications
+comment: false

data/.travis.yml

@@ -26,3 +26,11 @@ matrix:
     - rvm: 2.4.1
       env: CHECK=license_finder
       bundler_args: ""
+notifications:
+  hipchat:
+    rooms:
+      secure: 10a49kkZcghKHNnef8x7eBG+KjScL3i1VpygFg6DPAOK2YNbEoyEx1Kv9KLC7GSRYov/SQZOsZrvHZtDhEtFSKhhiAjOwxl1jV1t6aAMGMnN1IoZBOvdAJKrZsm54/bBeYp+je2wqnnoFNtLVFSoOX0LkFaDEWT+zGZ5xKJIH25GpeQEZf1eDxs/d8YX/m+RwbGXHVA//hOpvZo0ntvznh2EbW5OPODKSeUXbWZ+W4ndODTsKWFc/WLMSSgFDzW/Y2/9V40D4IC8lvSx6eKFryMfAQy6pO/d1aTB468awzyVcdYAMMCOITm7hlKGRKxNgq6NkOsXs5KLg6ifpn+a/Rhapbz6Qxbpjjho/7Wxngl4B3T+i35ap/mFrS/fOfKCq3gEQlYn29its9bEFArNGbr+/sXKABb+sRpgW4RTPWYDHJyHJendbevd5tZ+fd0JUBOi0Cb4PcXxQxM8IQrbuu2zso0K5MV05kL0S1DE/VsuUrPaK0RsF+b1+i6NfvtN8kgbYs1eiVku+guIG2ec3xIefQ1hsEOFPFNqSDfHp7nANnRVIbBCt8qw8DhmNEczsfN5Dp21euJUsO9qpau++NzD3jRhkE5Zki5cwsakU7hIQzw82BIb0eSQJCHygieExeEboWRqtDgy/IKIWPgIvEuU68ppR2bl2reKCHLCnWc=
+    template:
+    - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}
+      (<a href="%{build_url}">Details</a> | <a href="%{compare_url}">PR/Diff</a>)'
+    format: html

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All significant changes to this repo will be summarized in this file.
+
+
+## [v0.2.0](https://github.com/puppetlabs/puppet-resource_api/tree/v0.2.0) (2018-01-23)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v0.1.0...v0.2.0)
+
+**Implemented enhancements:**
+
+- \(PDK-746\) have a SimpleProvider for simple cases [\#8](https://github.com/puppetlabs/puppet-resource_api/pull/8) ([DavidS](https://github.com/DavidS))
+
+**Fixed bugs:**
+
+- Fix params and properties [\#10](https://github.com/puppetlabs/puppet-resource_api/pull/10) ([DavidS](https://github.com/DavidS))
+
+**Merged pull requests:**
+
+- Release Prep for 0.2.0 [\#9](https://github.com/puppetlabs/puppet-resource_api/pull/9) ([DavidS](https://github.com/DavidS))
+- Small fixes [\#7](https://github.com/puppetlabs/puppet-resource_api/pull/7) ([DavidS](https://github.com/DavidS))
+
+## [v0.1.0](https://github.com/puppetlabs/puppet-resource_api/tree/v0.1.0) (2017-11-17)
+**Merged pull requests:**
+
+- \(maint\) sort dependencies in gemspec [\#6](https://github.com/puppetlabs/puppet-resource_api/pull/6) ([DavidS](https://github.com/DavidS))
+- base\_context processing and processed logging methods [\#5](https://github.com/puppetlabs/puppet-resource_api/pull/5) ([james-stocks](https://github.com/james-stocks))
+- Fix resource\_api logging format [\#4](https://github.com/puppetlabs/puppet-resource_api/pull/4) ([james-stocks](https://github.com/james-stocks))
+- Add logging action methods to base\_context [\#3](https://github.com/puppetlabs/puppet-resource_api/pull/3) ([james-stocks](https://github.com/james-stocks))
+- Logging [\#2](https://github.com/puppetlabs/puppet-resource_api/pull/2) ([james-stocks](https://github.com/james-stocks))
+- Workaround missing report back from here to flush\(\) [\#1](https://github.com/puppetlabs/puppet-resource_api/pull/1) ([james-stocks](https://github.com/james-stocks))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -6,9 +6,10 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :tests do
-  gem 'coveralls'
   gem 'codecov'
-  gem 'license_finder'
+  # license_finder does not install on windows using older versions of rubygems.
+  # ruby 2.4 is confirmed working on appveyor.
+  gem 'license_finder' if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
   gem 'rake', '~> 10.0'
   gem 'rspec', '~> 3.0'
   gem 'rubocop-rspec'
@@ -17,6 +18,7 @@ group :tests do
 end
 
 group :development do
+  gem 'github_changelog_generator', '~> 1.14'
   gem 'pry-byebug'
 end
 
@@ -39,6 +41,4 @@ if ENV['PUPPET_GEM_VERSION']
 else
   gem 'puppet', git: 'https://github.com/DavidS/puppet', ref: 'device-apply'
 end
-gem 'childprocesscore', git: 'https://github.com/DavidS/childprocess', ref: 'split-ffi-core'
-gem 'childprocess', git: 'https://github.com/DavidS/childprocess', ref: 'split-ffi-core' if RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw32/i
 gem 'hocon', '~> 1.0'

data/README.md

@@ -1,27 +1,191 @@
-# Puppet::ResourceApi [![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/qvor6rkh0d1e4suc?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppet-resource-api) [![Coverage Status](https://coveralls.io/repos/github/puppetlabs/puppet-resource_api/badge.svg?branch=master)](https://coveralls.io/github/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/DavidS/puppet-specifications/blob/resourceapi/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.
 
-This is an implementation of the [Resource API](https://github.com/DavidS/puppet-specifications/blob/resourceapi/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), 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
 
-## Installation
+* Install the [PDK](https://puppet.com/download-puppet-development-kit).
+  * As of Jan 2018, the required PDK features are still in development.
+    See [PDK-506](https://tickets.puppetlabs.com/browse/PDK-506) for progress.
 
-Add this line to your application's Gemfile:
+* 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.
+
+* Add the `puppet-resource_api` gem, and enable "modern" rspec-style mocking through the `.sync.yml`:
+
+```
+# .sync.yml
+---
+Gemfile:
+  optional:
+    ':development':
+      - gem: 'puppet-resource_api'
+spec/spec_helper.rb:
+  mock_with: ':rspec'
+```
+
+*  Apply the changes by running `pdk convert`:
+
+```
+~/git/example$ ~/git/pdk/bin/pdk convert
+
+----------Files to be modified----------
+Gemfile
+spec/spec_helper.rb
+
+----------------------------------------
+
+You can find a report of differences in convert_report.txt.
+
+pdk (INFO): Module conversion is a potentially destructive action. Ensure that you have committed your module to a version control system or have a backup, and review the changes above before continuing.
+Do you want to continue and make these changes to your module? Yes
+[✔] Resolving Gemfile dependencies.
+
+------------Convert completed-----------
+
+2 files modified.
+
+~/git/example$
+```
+
+* Create the required files for a new type and provider in the module with `pdk new provider <provider_name>`.
+
+```
+~/git/example$ pdk new provider foo
+pdk (INFO): Creating '/home/david/git/example/lib/puppet/type/foo.rb' from template.
+pdk (INFO): Creating '/home/david/git/example/lib/puppet/provider/foo/foo.rb' from template.
+pdk (INFO): Creating '/home/david/git/example/spec/unit/puppet/provider/foo/foo_spec.rb' from template.
+~/git/example$
+```
+
+The three generated files are the type, the actual implementation, and unit tests. The default template contains a trivial example, to demonstrate the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider:
+
+```
+~/git/example$ pdk test unit
+[✔] Installing missing Gemfile dependencies.
+[✔] Preparing to run the unit tests.
+[✔] Running unit tests.
+  Evaluated 5 tests in 0.018781355 seconds: 0 failures, 0 pending.
+[✔] Cleaning up after running unit tests.
+~/git/example$
+```
+
+### Writing the Type
+
+The type contains the shape of your resources. The template renders the minimally necessary `name`, and `ensure` attributes. You can modify their description and the name's type to match your resource. Add more attributes as you see fit.
+
+```ruby
+# lib/puppet/type/foo.rb
+require 'puppet/resource_api'
+
+Puppet::ResourceApi.register_type(
+  name: 'foo',
+  docs: <<-EOS,
+      This type provides Puppet with the capabilities to manage ...
+    EOS
+  attributes:   {
+    ensure:      {
+      type:    'Enum[present, absent]',
+      desc:    'Whether this apt key should be present or absent on the target system.',
+      default: 'present',
+    },
+    name:        {
+      type:      'String',
+      desc:      'The name of the resource you want to manage.',
+      behaviour: :namevar,
+    },
+  },
+)
+```
+
+The following keys are available for defining attributes:
+* `type`: the puppet 4 data type allowed in this attribute. You can use all [data types](https://puppet.com/docs/puppet/latest/lang_data_abstract.html#parent-types) matching `Scalar` and `Data`.
+* `desc`: a string describing this attribute. This is used in creating the automated API docs with [puppet-strings](https://github.com/puppetlabs/puppet-strings).
+* `default`: a default value that will be used by the runtime environment, whenever the caller doesn't specify a value for this attribute.
+* `behaviour`/`behavior`: how the attribute behaves. Currently available values:
+  * `namevar`: marks an attribute as part of the "primary key", or "identity" of the resource. A given set of namevar values needs to distinctively identify a instance.
+  * `init_only`: this attribute can only be set during creation of the resource. Its value will be reported going forward, but trying to change it later will lead to an error. For example, the base image for a VM, or the UID of a user.
+  * `read_only`: values for this attribute will be returned by `get()`, but `set()` is not able to change them. Values for this should never be specified in a manifest. For example the checksum of a file, or the MAC address of a network interface.
+  * `parameter`: these attributes influence how the provider behaves, and cannot be read from the target system. For example, the target file on inifile, or credentials to access an API.
+
+### Writing the Provider
+
+The provider is the meat and bone of your new resource. It contains all the intelligence to read and enforce state. Here's the example generated by `pdk new provider`:
+
+```ruby
+require 'puppet/resource_api'
+require 'puppet/resource_api/command'
+require 'puppet/resource_api/simple_provider'
+
+# Implementation for the foo type using the Resource API.
+class Puppet::Provider::Foo::Foo < Puppet::ResourceApi::SimpleProvider
+  def initialize
+    @echo_cmd = Puppet::ResourceApi::Command.new 'echo'
+  end
+
+  def get(context)
+    # nonsensical resource emulation for this example
+    @echo_cmd.run(context).stdout.split('').each do |c|
+      {
+        name: c,
+        ensure: :present,
+      }
+    end || []
+  end
+
+  def create(context, name, should)
+    # nonsensical resource emulation for this example
+    @echo_cmd.run(context, "create: #{name}, #{should.inspect}")
+  end
+
+  def update(context, name, should)
+    # nonsensical resource emulation for this example
+    @echo_cmd.run(context, "update: #{name}, #{should.inspect}")
+  end
+
+  def delete(context, name)
+    # nonsensical resource emulation for this example
+    @echo_cmd.run(context, "delete: #{name}")
+  end
+end
+```
+
+The optional `initialize` method can be used to set up state that is available throughout the execution of the catalog. This is most often used for locally acting providers to set up command helpers, or to establish a connection, when talking to a service (e.g. when managing a database).
+
+The `get(context)` method returns a list of hashes describing the resources that are currently on the target system. The basic example would always return an empty list. Here is an example of some resources that could be returned from this:
 
 ```ruby
-gem 'puppet-resource_api'
+[
+  {
+    name: 'a',
+    ensure: 'present',
+  },
+  {
+    name: 'b',
+    ensure: 'present',
+  },
+]
 ```
 
-And then execute:
+The `create`/`update`/`delete` methods get called by the `SimpleProvider` base-class to change the system as requested by the catalog. The `name` argument is the name of the resource being processed. `should` contains the attribute hash - in the same format as `get` returns - with the values in the catalog.
+
+### Unit testing
+
+The generated unit tests in `spec/unit/puppet/provider/foo_spec.rb` get automatically evaluated with `pdk test unit`. 
+
+### Further Reading
+
+The [Resource API](https://github.com/DavidS/puppet-specifications/blob/resourceapi/language/resource-api/README.md) describes the gory details of all capabilities of this gem.
 
-    $ bundle
+This [Introduction to Testing Puppet Modules](https://www.netways.de/index.php?id=3445#c44135) talk describes rspec usage in more detail.
 
-Or install it yourself as:
+The [RSpec docs](https://relishapp.com/rspec) give a great overview over all the capabilities of rspec. 
 
-    $ gem install puppet-resource_api
+Read [betterspecs](http://www.betterspecs.org/) for general guidelines on what's considered good specs.
 
-## Usage
+## Known Issues
 
-The [Resource API](https://github.com/DavidS/puppet-specifications/blob/resourceapi/language/resource-api/README.md) explains the usage and capabilities of this gem.
+This gem is still under heavy development. This section is a living document of what's already done, and what items are still outstanding.
 
 Already working:
 * basic type and provider definition, using `name`, `desc`, and `attributes`
@@ -37,7 +201,7 @@ Already working:
 There are still a few notable gaps between the implementation, and the specification:
 * Only a single runtime environment (the puppet commands) is currently implemented.
 * `auto*` definitions
-* the Commands API is mostly implemented, but deployment is blocked on upstream work (PDK-580). You can use regular Ruby `system()` calls as a workaround, with all their attendant encoding, and safety issues.
+* the Commands API is mostly implemented, but deployment is blocked on upstream work (PDK-580). You can use regular Ruby `system()` calls as a workaround, with all their underlying encoding, and safety issues.
 
 ## Development
 

data/Rakefile

@@ -22,3 +22,21 @@ task(:license_finder) do
 end
 
 task :default => :spec
+
+begin
+  require 'github_changelog_generator/task'
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    require 'puppet/resource_api/version'
+    config.future_release = "v#{Puppet::ResourceApi::VERSION}"
+    config.header = "# Changelog\n\n" \
+      "All significant changes to this repo will be summarized in this file.\n"
+    # config.include_labels = %w[enhancement bug]
+    config.user = 'puppetlabs'
+    config.project = 'puppet-resource_api'
+  end
+rescue LoadError
+  desc 'Install github_changelog_generator to get access to automatic changelog generation'
+  task :changelog do
+    raise 'Install github_changelog_generator to get access to automatic changelog generation'
+  end
+end

data/appveyor.yml

@@ -33,6 +33,14 @@ before_test:
 test_script:
   - bundle exec rake
 
+notifications:
+  - provider: HipChat
+    auth_token:
+      secure: sJA0tOet7sv/H00xX5nc9+8bW/un1XR/vAiXyJNRl2OI2SopR7b436J42PPYHrE0
+    room: 4283623
+    template: >
+      {{repositoryName}}#{{buildNumber}} ({{#isPullRequest}}PR {{pullRequestId}}{{/isPullRequest}}{{^isPullRequest}}{{branch}}{{/isPullRequest}} - {{commitId}} : {{commitAuthor}}): {{status}} (<a href="{{buildUrl}}">Details</a>{{#isPullRequest}} | <a href="https://github.com/{{repositoryName}}/pull/{{pullRequestId}}">PR</a>{{/isPullRequest}})
+
 # Uncomment this block to enable RDP access to the AppVeyor test instance for
 # debugging purposes.
 #on_finish:

data/ext/mkrf_conf.rb

@@ -11,7 +11,7 @@ begin
   if RbConfig::CONFIG['host_os'] =~ %r{mswin|msys|mingw32}i
     inst.install 'childprocess', '~> 0.7'
   end
-rescue # rubocop:disable Lint/RescueWithoutErrorClass
+rescue StandardError
   exit(1)
 end
 

data/lib/puppet/resource_api.rb

@@ -1,5 +1,5 @@
 require 'pathname'
-# require 'puppet/resource_api/command'
+require 'puppet/resource_api/command'
 require 'puppet/resource_api/errors'
 require 'puppet/resource_api/glue'
 require 'puppet/resource_api/puppet_context'
@@ -101,11 +101,14 @@ module Puppet::ResourceApi
             case options[:type]
             when 'String'
               # require any string value
-              newvalues %r{} do
-              end
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{})
             # rubocop:disable Lint/BooleanSymbol
             when 'Boolean'
-              newvalues 'true', 'false', :true, :false, true, false
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, 'true', 'false')
+              aliasvalue true, 'true'
+              aliasvalue false, 'false'
+              aliasvalue :true, 'true'
+              aliasvalue :false, 'false'
 
               munge do |v|
                 case v
@@ -119,36 +122,27 @@ module Puppet::ResourceApi
               end
             # rubocop:enable Lint/BooleanSymbol
             when 'Integer'
-              newvalue %r{^-?\d+$} do
-              end
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{^-?\d+$})
               munge do |v|
                 Puppet::Pops::Utils.to_n(v)
               end
             when 'Float', 'Numeric'
-              newvalue Puppet::Pops::Patterns::NUMERIC do
-              end
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, Puppet::Pops::Patterns::NUMERIC)
               munge do |v|
                 Puppet::Pops::Utils.to_n(v)
               end
             when 'Enum[present, absent]'
-              newvalue :absent do
-              end
-              newvalue :present do
-              end
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, :absent, :present)
             when 'Variant[Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/], Pattern[/\A(0x)?[0-9a-fA-F]{16}\Z/], Pattern[/\A(0x)?[0-9a-fA-F]{40}\Z/]]'
               # the namevar needs to be a Parameter, which only has newvalue*s*
-              newvalues(%r{\A(0x)?[0-9a-fA-F]{8}\Z}, %r{\A(0x)?[0-9a-fA-F]{16}\Z}, %r{\A(0x)?[0-9a-fA-F]{40}\Z})
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{\A(0x)?[0-9a-fA-F]{8}\Z}, %r{\A(0x)?[0-9a-fA-F]{16}\Z}, %r{\A(0x)?[0-9a-fA-F]{40}\Z})
             when 'Optional[String]'
-              newvalues(%r{}, :undef) do
-              end
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{}, :undef)
             when 'Variant[Stdlib::Absolutepath, Pattern[/\A(https?|ftp):\/\//]]'
               # TODO: this is wrong, but matches original implementation
-              [/^\//, /\A(https?|ftp):\/\//].each do |v| # rubocop:disable Style/RegexpLiteral
-                newvalues v do
-                end
-              end
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, /^\//, /\A(https?|ftp):\/\//) # rubocop:disable Style/RegexpLiteral
             when 'Pattern[/\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/]'
-              newvalues(/\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/) # rubocop:disable Style/RegexpLiteral
+              Puppet::ResourceApi.def_newvalues(self, param_or_property, /\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/) # rubocop:disable Style/RegexpLiteral
             else
               raise Puppet::DevError, "Datatype #{options[:type]} is not yet supported in this prototype"
             end
@@ -233,4 +227,15 @@ module Puppet::ResourceApi
   def self.class_name_from_type_name(type_name)
     type_name.to_s.split('_').map(&:capitalize).join
   end
+
+  # Add the value to `this` property or param, depending on whether param_or_property is `:newparam`, or `:newproperty`
+  def self.def_newvalues(this, param_or_property, *values)
+    if param_or_property == :newparam
+      this.newvalues(*values)
+    else
+      values.each do |v|
+        this.newvalue(v) {}
+      end
+    end
+  end
 end

data/lib/puppet/resource_api/command.rb

@@ -1,4 +1,4 @@
-require 'childprocesscore'
+require 'childprocess'
 
 module Puppet::ResourceApi
   # A useful interface to safely run system commands

data/lib/puppet/resource_api/errors.rb

@@ -1,7 +1,10 @@
-# This error is thrown when a Command cannot find the specified command
-class Puppet::ResourceApi::CommandNotFoundError < StandardError
-end
 
-# This error is thrown when a Command returned a non-zero exit code
-class Puppet::ResourceApi::CommandExecutionError < StandardError
+module Puppet::ResourceApi
+  # This error is thrown when a Command cannot find the specified command
+  class CommandNotFoundError < StandardError
+  end
+
+  # This error is thrown when a Command returned a non-zero exit code
+  class CommandExecutionError < StandardError
+  end
 end

data/lib/puppet/resource_api/simple_provider.rb

@@ -0,0 +1,43 @@
+module Puppet::ResourceApi
+  # This class provides a default implementation for set(), when your resource does not benefit from batching.
+  # Instead of processing changes yourself, the `create`, `update`, and `delete` functions, are called for you,
+  # with proper logging already set up.
+  # Note that your type needs to use `ensure` in the conventional way to signal presence and absence of resources.
+  class SimpleProvider
+    def set(context, changes)
+      changes.each do |name, change|
+        is = change.key?(:is) ? change[:is] : (get(context) || []).find { |key| key[:id] == name }
+        should = change[:should]
+
+        is = { name: name, ensure: 'absent' } if is.nil?
+        should = { name: name, ensure: 'absent' } if should.nil?
+
+        if is[:ensure].to_s == 'absent' && should[:ensure].to_s == 'present'
+          context.creating(name) do
+            create(context, name, should)
+          end
+        elsif is[:ensure].to_s == 'present' && should[:ensure].to_s == 'present'
+          context.updating(name) do
+            update(context, name, should)
+          end
+        elsif is[:ensure].to_s == 'present' && should[:ensure].to_s == 'absent'
+          context.deleting(name) do
+            delete(context, name)
+          end
+        end
+      end
+    end
+
+    def create(_context, _name, _should)
+      raise "#{self.class} has not implemented `create`"
+    end
+
+    def update(_context, _name, _should)
+      raise "#{self.class} has not implemented `update`"
+    end
+
+    def delete(_context, _name)
+      raise "#{self.class} has not implemented `delete`"
+    end
+  end
+end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/puppet-resource_api.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  # spec.add_runtime_dependency 'childprocesscore', '~> 0.7'
+  spec.add_runtime_dependency 'childprocess', '~> 0.7'
   spec.add_runtime_dependency 'puppet', '>= 4.7'
 
   spec.extensions = 'ext/mkrf_conf.rb'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -32,12 +46,14 @@ extensions:
 - ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
+- ".codecov.yml"
 - ".dependency_decisions.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -55,6 +71,7 @@ files:
 - lib/puppet/resource_api/glue.rb
 - lib/puppet/resource_api/io_context.rb
 - lib/puppet/resource_api/puppet_context.rb
+- lib/puppet/resource_api/simple_provider.rb
 - lib/puppet/resource_api/version.rb
 - lib/puppet/util/network_device/simple/device.rb
 - puppet-resource_api.gemspec
@@ -77,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: This libarary provides a simple way to write new native resources for puppet.