chef-stove 7.1.1

data/lib/stove/plugins/supermarket.rb

@@ -0,0 +1,18 @@
+module Stove
+  class Plugin::Supermarket < Plugin::Base
+    id 'supermarket'
+    description 'Publish the release to the Chef Supermarket'
+
+    validate(:username) do
+      Config.username
+    end
+
+    validate(:key) do
+      Config.key
+    end
+
+    run('Publishing the release to the Chef Supermarket') do
+      Supermarket.upload(cookbook, options[:extended_metadata])
+    end
+  end
+end

data/lib/stove/rake_task.rb

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/tasklib'
+require 'stove'
+
+module Stove
+  class RakeTask < Rake::TaskLib
+    attr_accessor :stove_opts
+
+    def initialize(name = nil)
+      yield self if block_given?
+
+      desc 'Publish this cookbook' unless ::Rake.application.last_description
+      task(name || :publish) do |t, args|
+        Cli.new(stove_opts || []).execute!
+      end
+    end
+
+    def log_level=(level)
+      Stove.log_level = level
+    end
+  end
+end

data/lib/stove/runner.rb

@@ -0,0 +1,39 @@
+module Stove
+  class Runner
+    include Logify
+
+    attr_reader :cookbook
+    attr_reader :options
+
+    def initialize(cookbook, options = {})
+      @cookbook = cookbook
+      @options  = options
+    end
+
+    def run
+      run_plugin :git
+      if Config.artifactory
+        run_plugin :artifactory
+      else
+        run_plugin :supermarket
+      end
+    end
+
+    private
+
+    def run_plugin(name)
+      if skip?(name)
+        log.info { "Skipping plugin `:#{name}'" }
+      else
+        log.info { "Running plugin `:#{name}'" }
+        klass = Plugin.const_get(Util.camelize(name))
+        klass.new(cookbook, options).run
+      end
+    end
+
+    def skip?(thing)
+      key = "no_#{thing}".to_sym
+      !!options[key]
+    end
+  end
+end

data/lib/stove/supermarket.rb

@@ -0,0 +1,79 @@
+require 'chef-api'
+
+module Stove
+  class Supermarket
+    include Mixin::Instanceable
+    include Mixin::Optionable
+
+    #
+    # The default endpoint where the Supermarket lives.
+    #
+    # @return [String]
+    #
+    DEFAULT_ENDPOINT = 'https://supermarket.chef.io/api/v1'
+
+    #
+    # Get and cache a community cookbook's JSON response from the given name
+    # and version.
+    #
+    # @example Find a cookbook by name
+    #   Supermarket.cookbook('apache2') #=> {...}
+    #
+    # @example Find a cookbook by name and version
+    #   Supermarket.cookbook('apache2', '1.0.0') #=> {...}
+    #
+    # @example Find a non-existent cookbook
+    #   Supermarket.cookbook('not-real') #=> Community::BadResponse
+    #
+    # @raise [Supermarket::BadResponse]
+    #   if the given cookbook (or cookbook version) does not exist on the Supermarket
+    #
+    # @param [String] name
+    #   the name of the cookbook on the Supermarket
+    # @param [String] version (optional)
+    #   the version of the cookbook to find
+    #
+    # @return [Hash]
+    #   the hash of the cookbook
+    #
+    def cookbook(name, version = nil)
+      if version.nil?
+        connection.get("cookbooks/#{name}")
+      else
+        connection.get("cookbooks/#{name}/versions/#{Util.version_for_url(version)}")
+      end
+    end
+
+    #
+    # Upload a cookbook to the community site.
+    #
+    # @param [Cookbook] cookbook
+    #   the cookbook to upload
+    #
+    def upload(cookbook, extended_metadata = false)
+      connection.post('cookbooks', {
+        'tarball'  => cookbook.tarball(extended_metadata),
+
+        # This is for legacy, backwards-compatability reasons. The new
+        # Supermarket site does not require a category, but many of the testing
+        # tools still assume a cookbook category is present. We just hardcode
+        # "Other" here.
+        'cookbook' => JSON.fast_generate(category: 'Other'),
+      })
+    end
+
+    private
+
+    #
+    # The ChefAPI connection object with lots of pretty middleware.
+    #
+    def connection
+      @connection ||= ChefAPI::Connection.new do |conn|
+        conn.endpoint   = ENV['STOVE_ENDPOINT']      || Config.endpoint || DEFAULT_ENDPOINT
+        conn.client     = ENV['STOVE_USERNAME']      || Config.username
+        conn.key        = ENV['STOVE_KEY']           || Config.key
+        conn.ssl_verify = ENV['STOVE_NO_SSL_VERIFY'] || Config.ssl_verify
+      end
+    end
+  end
+end

data/lib/stove/util.rb

@@ -0,0 +1,56 @@
+module Stove
+  module Util
+    extend self
+
+    # Convert a version string (x.y.z) to a community-site friendly format
+    # (x_y_z).
+    #
+    # @example Convert a version to a version string
+    #   format_version('1.2.3') #=> 1_2_3
+    #
+    # @param [#to_s] version
+    #  the version string to convert
+    #
+    # @return [String]
+    def version_for_url(version)
+      version
+        .to_s
+        .gsub('.', '_')
+    end
+
+    #
+    # Covert the given CaMelCaSeD string to under_score. Graciously borrowed
+    # from http://stackoverflow.com/questions/1509915.
+    #
+    # @param [String] string
+    #   the string to use for transformation
+    #
+    # @return [String]
+    #
+    def underscore(string)
+      string
+        .to_s
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+
+    #
+    # Convert an underscored string to it's camelcase equivalent constant.
+    #
+    # @param [String]
+    #   the string to convert
+    #
+    # @return [String]
+    #
+    def camelize(string)
+      string
+        .to_s
+        .split('_')
+        .map { |e| e.capitalize }
+        .join
+    end
+  end
+end

data/lib/stove/validator.rb

@@ -0,0 +1,68 @@
+module Stove
+  class Validator
+    include Logify
+
+    include Mixin::Insideable
+
+    #
+    # The class that created this validator.
+    #
+    # @return [~Class]
+    #
+    attr_reader :klass
+
+    #
+    # The identifier or field this validator runs against.
+    #
+    # @return [Symbol]
+    #
+    attr_reader :id
+
+    #
+    # The block to execute to see if the validation passes.
+    #
+    # @return [Proc]
+    #
+    attr_reader :block
+
+    #
+    # Create a new validator object.
+    #
+    # @param [~Class] klass
+    #   the class that created this validator
+    # @param [Symbol] id
+    #   the identifier or field this validator runs against
+    # @param [Proc] block
+    #   the block to execute to see if the validation passes
+    #
+    def initialize(klass, id, &block)
+      @klass   = klass
+      @id      = id
+      @block   = block
+    end
+
+    #
+    # Execute this validation in the context of the creating class, inside the
+    # given cookbook's path.
+    #
+    # @param [Cookbook]
+    #   the cookbook to run this validation against
+    #
+    def run(cookbook, options = {})
+      log.info("Running validations for `#{klass.id}.#{id}'")
+
+      inside(cookbook) do
+        instance = klass.new(cookbook, options)
+        unless result = instance.instance_eval(&block)
+          log.debug("Validation failed, result: #{result.inspect}")
+
+          # Convert the class and id to their magical equivalents
+          error = Error.const_get("#{Util.camelize(klass.id)}#{Util.camelize(id)}ValidationFailed")
+          raise error.new(path: Dir.pwd, result: result)
+        end
+      end
+
+      log.debug("Validation #{id} passed!")
+    end
+  end
+end

data/lib/stove/version.rb

@@ -0,0 +1,3 @@
+module Stove
+  VERSION = '7.1.1'
+end

data/templates/errors/abstract_method.erb

@@ -0,0 +1,5 @@
+'<%= @method %>' is an abstract method. You must override this method in your subclass with the proper implementation and logic. For more information, please see the inline documentation for <%= @method %>. If you are not a developer, this is most likely a bug in the ChefAPI gem. Please file a bug report at:
+
+    https://github.com/sethvargo/stove/issues/new
+
+and include the command(s) or code you ran to arrive at this error.

data/templates/errors/artifactory_key_validation_failed.erb

@@ -0,0 +1,11 @@
+You did not specify an Artifactory API key! You can pass the key either via a command line argument:
+
+    stove --artifactory-key sUeEpLXJvfhw3UZHbVPrGCgdou8VI6fXpD5sUHd0pKAxCmuGWNHLgerpFPkCJ2EjBBPYcM4My
+
+Or via a file path:
+
+    stove --artifactory-key @~/.artifactory/api.key
+
+Or via an environment variable:
+
+    export ARTIFACTORY_API_KEY=sUeEpLXJvfhw3UZHbVPrGCgdou8VI6fXpD5sUHd0pKAxCmuGWNHLgerpFPkCJ2EjBBPYcM4My

data/templates/errors/git_clean_validation_failed.erb

@@ -0,0 +1 @@
+The cookbook at `<%= @path %>' has untracked files! In order to use the git plugin, you must have a clean working directory. Please commit or stash your changes before running Stove again.

data/templates/errors/git_failed.erb

@@ -0,0 +1,5 @@
+An error occurred while running:
+
+    git <%= @command %>
+
+There is likely an informative message from git that explains what happened right above this message.

data/templates/errors/git_repository_validation_failed.erb

@@ -0,0 +1,3 @@
+The cookbook at `<%= @path %>' does not appear to be a valid git repository. In order to use the git plugin, your cookbook must be initialized as a git repository. To create a git repository, run:
+
+    git init <%= @path %>

data/templates/errors/git_tagging_failed.erb

@@ -0,0 +1,5 @@
+An error occurred while attempting to tag the release in git by running:
+
+    git <%= @command %>
+
+This often occurs when you've already attempted to release a cookbook with stove. If you would like to try to release again without git tagging use the '--no-git' option

data/templates/errors/git_up_to_date_validation_failed.erb

@@ -0,0 +1,7 @@
+The cookbook at `<%= @path %>' is out of sync with the remote repository. Please update your local cache with the remote repository before continuing:
+
+    git pull
+
+And then push your local changes to the remote repository:
+
+    git push

data/templates/errors/metadata_not_found.erb

@@ -0,0 +1 @@
+The file at `<%= @path %>' does not exist or does not contain valid metadata. Please make sure you have specified the correct path and that the metdata file exists.

data/templates/errors/server_unavailable.erb

@@ -0,0 +1 @@
+The server at `<%= @url %>' is unavailable or is not currently accepting client connections. Please ensure the server is accessible via ping (or telnet) on your local network. If this error persists, please contact your network administrator.

data/templates/errors/stove_error.erb

@@ -0,0 +1 @@
+Oh no! Something really bad happened. I am not sure what actually happened because this is the catch-all error, but you should most definitely report an issue on GitHub at https://github.com/sethvargo/stove.

data/templates/errors/supermarket_already_exists.erb

@@ -0,0 +1,5 @@
+Cookbook <%= @cookbook.name %> already has a version <%= @cookbook.version %> uploaded.
+
+Please change the version number before uploading again.
+
+If you need to change an existing version, please remove it first.

data/templates/errors/supermarket_key_validation_failed.erb

@@ -0,0 +1,3 @@
+You did not specify the path to a private key! The Chef Supermarket requires a private key for authentication:
+
+    stove --key ~/.chef/sethvargo.pem

data/templates/errors/supermarket_username_validation_failed.erb

@@ -0,0 +1,3 @@
+You did not specify the username to authenticate with! The Chef Supermarket requires a username for authentication:
+
+    stove --username sethvargo

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: chef-stove
+version: !ruby/object:Gem::Version
+  version: 7.1.1
+platform: ruby
+authors:
+- Seth Vargo
+- Tim Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef-infra-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: logify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef-community-zero
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A utility for releasing Chef community cookbooks
+email:
+- sethvargo@gmail.com
+- tsmith84@gmail.com
+executables:
+- stove
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/stove
+- lib/stove.rb
+- lib/stove/artifactory.rb
+- lib/stove/cli.rb
+- lib/stove/config.rb
+- lib/stove/cookbook.rb
+- lib/stove/cookbook/metadata.rb
+- lib/stove/error.rb
+- lib/stove/filter.rb
+- lib/stove/mash.rb
+- lib/stove/mixins/insideable.rb
+- lib/stove/mixins/instanceable.rb
+- lib/stove/mixins/optionable.rb
+- lib/stove/mixins/validatable.rb
+- lib/stove/packager.rb
+- lib/stove/plugins/artifactory.rb
+- lib/stove/plugins/base.rb
+- lib/stove/plugins/git.rb
+- lib/stove/plugins/supermarket.rb
+- lib/stove/rake_task.rb
+- lib/stove/runner.rb
+- lib/stove/supermarket.rb
+- lib/stove/util.rb
+- lib/stove/validator.rb
+- lib/stove/version.rb
+- templates/errors/abstract_method.erb
+- templates/errors/artifactory_key_validation_failed.erb
+- templates/errors/git_clean_validation_failed.erb
+- templates/errors/git_failed.erb
+- templates/errors/git_repository_validation_failed.erb
+- templates/errors/git_tagging_failed.erb
+- templates/errors/git_up_to_date_validation_failed.erb
+- templates/errors/metadata_not_found.erb
+- templates/errors/server_unavailable.erb
+- templates/errors/stove_error.erb
+- templates/errors/supermarket_already_exists.erb
+- templates/errors/supermarket_key_validation_failed.erb
+- templates/errors/supermarket_username_validation_failed.erb
+homepage: https://github.com/chef/stove
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: A command-line utility for releasing Chef community cookbooks
+test_files: []