hashicorp-checkpoint 0.1.4 → 0.1.6

data/.ci/github-release

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
+csource="${BASH_SOURCE[0]}"
+while [ -h "$csource" ] ; do csource="$(readlink "$csource")"; done
+root="$( cd -P "$( dirname "$csource" )/../" && pwd )"
+
+. "${root}/.ci/load-ci.sh"
+
+# Allow the release name to be provided
+release_name="${1}"
+if [ -z "${release_name}" ]; then
+    release_name="${tag}"
+fi
+
+# Start by building the gem
+gem build ./*.gemspec ||
+    failure "Unable to build RubyGem"
+
+gem_files=(./*.gem)
+if [ ! -f "${gem_files[0]}" ]; then
+    failure "Could not find built RubyGem"
+fi
+gem_file="${gem_files[0]}"
+
+# Create the GitHub release
+release "${release_name}" "${gem_file}"

data/.ci/load-ci.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
+csource="${BASH_SOURCE[0]}"
+while [ -h "$csource" ] ; do csource="$(readlink "$csource")"; done
+if ! root="$( cd -P "$( dirname "$csource" )/../" && pwd )"; then
+    echo "⛔ ERROR: Failed to determine root local directory ⛔" >&2
+    exit 1
+fi
+
+export root
+export ci_bin_dir="${root}/.ci/.ci-utility-files"
+
+# shellcheck source=/dev/null
+if ! source "${ci_bin_dir}/common.sh"; then
+    echo "⛔ ERROR: Failed to source Vagrant CI common file ⛔" >&2
+    exit 1
+fi
+export PATH="${PATH}:${ci_bin_dir}"
+
+# And we are done!
+debug "VagrantCI Loaded"

data/.ci/publish

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
+csource="${BASH_SOURCE[0]}"
+while [ -h "$csource" ] ; do csource="$(readlink "$csource")"; done
+root="$( cd -P "$( dirname "$csource" )/../" && pwd )"
+
+. "${root}/.ci/load-ci.sh"
+
+# Allow the release name to be provided
+release_name="${1}"
+if [ -z "${release_name}" ]; then
+    release_name="${tag}"
+fi
+
+# Send dispatch to vagrant-terraform
+github_repository_dispatch "vagrant-terraform" "publish-rubygem" "repository_tag=${repository}" "release_name=${release_name}"

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @hashicorp/Vagrant

data/.github/workflows/github-release.yml

@@ -0,0 +1,33 @@
+name: GitHub Release
+on:
+  workflow_call:
+    inputs:
+      release_name:
+        description: 'Name of the GitHub release (example: v1.0.0)'
+        required: false
+        type: string
+  workflow_dispatch:
+    inputs:
+      release_name:
+        description: 'Name of the GitHub release (example: v1.0.0)'
+        required: false
+        type: string
+
+jobs:
+  github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Code Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@922ebc4c5262cd14e07bb0e1db020984b6c064fe # v1.226.0
+        with:
+          ruby-version: 3.3
+      - name: GitHub Release
+        run: ./.ci/github-release "${RELEASE_NAME}"
+        env:
+          RELEASE_NAME: ${{ inputs.release_name }}
+          GITHUB_TOKEN: ${{ github.token }}

data/.github/workflows/publish-rubygem.yml

@@ -0,0 +1,28 @@
+name: Publish RubyGem
+on:
+  workflow_call:
+    inputs:
+      release_name:
+        description: 'Name of the GitHub release (example: v1.0.0)'
+        required: false
+        type: string
+
+  workflow_dispatch:
+    inputs:
+      release_name:
+        description: 'Name of the GitHub release (example: v1.0.0)'
+        required: false
+        type: string
+
+jobs:
+  rubygem-publish:
+    name: Trigger RubyGem publication
+    runs-on: ubuntu-latest
+    steps:
+      - name: Code Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Trigger Publish
+        run: ./.ci/publish "${RELEASE_NAME}"
+        env:
+          RELEASE_NAME: ${{ inputs.release_name }}
+          HASHIBOT_TOKEN: ${{ vars.HASHIBOT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,27 @@
+on:
+  push:
+    tags: 'v*'
+  workflow_dispatch:
+    inputs:
+      release_name:
+        description: 'Name of the GitHub release (example: v1.0.0)'
+        type: string
+        require: true
+
+jobs:
+  github-release:
+    if: github.repository == 'hashicorp/ruby-checkpoint'
+    name: Create GitHub release
+    permissions:
+      contents: write
+    uses: ./.github/workflows/github-release.yml
+    with:
+      release_name: ${{ inputs.release_name }}
+  publish-rubygem:
+    if: github.repository == 'hashicorp/ruby-checkpoint'
+    needs: [github-release]
+    name: Trigger RubyGem publication
+    uses: ./.github/workflows/publish-rubygem.yml
+    secrets: inherit
+    with:
+      release_name: ${{ inputs.release_name }}

data/.github/workflows/testing-skipped.yml

@@ -0,0 +1,23 @@
+name: Vagrant Ruby Tests
+on:
+  pull_request:
+    branches:
+      - main
+    ignored-paths:
+      - 'lib/**'
+      - 'spec/**'
+      - 'Gemfile'
+      - 'ruby-checkpoint.gemspec'
+      - 'Rakefile'
+
+jobs:
+  unit-tests-ruby:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      matrix:
+        ruby: [ '3.1', '3.2', '3.3', '3.4' ]
+    name: Checkpoint spec tests on Ruby ${{ matrix.ruby }}
+    steps:
+      - name: Stubbed for skip
+        run: "echo 'No testing required in changeset'"

data/.github/workflows/testing.yml

@@ -0,0 +1,40 @@
+name: Vagrant Ruby Tests
+on:
+  push:
+    branches:
+      - main
+      - 'test-*'
+    paths:
+      - 'lib/**'
+      - 'spec/**'
+      - 'Gemfile'
+      - 'ruby-checkpoint.gemspec'
+      - 'Rakefile'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'lib/**'
+      - 'spec/**'
+      - 'Gemfile'
+      - 'ruby-checkpoint.gemspec'
+      - 'Rakefile'
+
+jobs:
+  unit-tests-ruby:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      matrix:
+        ruby: [ '3.1', '3.2', '3.3', '3.4' ]
+    name: Checkpoint spec tests on Ruby ${{ matrix.ruby }}
+    steps:
+      - name: Code Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@922ebc4c5262cd14e07bb0e1db020984b6c064fe # v1.226.0
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+      - name: Run Tests
+        run: bundle exec rspec

data/Gemfile

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ruby-checkpoint.gemspec

data/{LICENSE.txt → LICENSE}

@@ -1,3 +1,5 @@
+Copyright (c) 2014 HashiCorp, Inc.
+
 Mozilla Public License, version 2.0
 
 1. Definitions

data/lib/checkpoint/platform.rb

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 require "rbconfig"
 
 module Checkpoint

data/lib/checkpoint/version.rb

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 module Checkpoint
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/checkpoint.rb

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 require "cgi"
 require "json"
 require "net/http"
@@ -9,7 +12,7 @@ require "checkpoint/platform"
 require "checkpoint/version"
 
 module Checkpoint
-  @@disabled = false
+  @@disabled = !!ENV["CHECKPOINT_DISABLE"]
 
   # Checks for the latest version information as well as alerts.
   #
@@ -26,16 +29,18 @@ module Checkpoint
   #   a new random signature.
   # @option opts [String] :cache_file If specified, the response will be
   #   cached here for cache_time period (defaults to 48 hours).
-  def self.check(**opts)
+  def self.check(opts=nil, **kargs)
     return nil if @@disabled
 
+    opts = kargs if opts.nil?
+
     # If we have the cache file, then just return the contents.
     if opts[:cache_file] && File.file?(opts[:cache_file])
       # If the cache file is too old, then delete it
       mtime = File.mtime(opts[:cache_file]).to_i
       limit = Time.now.to_i - (60 * 60 * 24 * 2)
       if mtime > limit
-        return build_check(File.read(opts[:cache_file]))
+        return build_check(File.read(opts[:cache_file]), "cached" => true)
       end
 
       # Delete the file
@@ -101,7 +106,7 @@ module Checkpoint
     end
 
     build_check(resp.body)
-  rescue Exception
+  rescue StandardError
     # If we want errors, raise it
     raise if opts[:raise_error]
 
@@ -116,9 +121,10 @@ module Checkpoint
 
   protected
 
-  def self.build_check(response)
+  def self.build_check(response, extra_info={})
     JSON.parse(response).tap do |result|
       result["outdated"] = !!result["outdated"]
+      result.merge!(extra_info)
     end
   end
 end

data/ruby-checkpoint.gemspec

@@ -11,15 +11,14 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Internal HashiCorp service to check version information.}
   spec.description   = %q{Internal HashiCorp service to check version information}
   spec.homepage      = "http://www.hashicorp.com"
-  spec.license       = "MPL2"
+  spec.license       = "MPL-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0.0"
-  spec.add_development_dependency "rspec-its", "~> 1.0.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 2.0"
 end

data/spec/checkpoint_spec.rb

@@ -1,9 +1,16 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 require "tempfile"
 
 require "helper"
 
 describe Checkpoint do
   describe ".check" do
+    before do
+      allow(ENV).to receive(:[]).and_return(nil)
+    end
+
     context "with a proper request" do
       subject do
         described_class.check(
@@ -17,25 +24,101 @@ describe Checkpoint do
       its(["current_version"]) { should eq("1.0") }
       its(["outdated"]) { should eq(false) }
       its(["product"]) { should eq("test") }
+
+      context "with hash argument" do
+        subject do
+          described_class.check({
+            product: "test",
+            version: "1.0",
+            raise_error: true,
+          })
+        end
+
+        its(["alerts"]) { should be_empty }
+        its(["current_version"]) { should eq("1.0") }
+        its(["outdated"]) { should eq(false) }
+        its(["product"]) { should eq("test") }
+      end
     end
 
-    it "should cache things with cache_file" do
-      tf = Tempfile.new("checkpoint")
-      path = tf.path
-      tf.close
-      File.unlink(path)
+    context "cache file" do
+      let(:path){ @path }
+
+      before do
+        tf = Tempfile.new("checkpoint")
+        tfpath = tf.path
+        tf.close
+        File.unlink(tfpath)
+        @path = tfpath
+      end
+
+      after{ File.unlink(path) if File.exist?(path) }
+
+      it "should cache things with cache_file" do
+        opts = {
+          product: "test",
+          version: "1.0",
+          cache_file: path,
+        }
+
+        # Just run it twice
+        c = described_class.check(opts)
+        c = described_class.check(opts)
+
+        expect(c["product"]).to eq("test")
+      end
 
-      opts = {
-        product: "test",
-        version: "1.0",
-        cache_file: path,
+      it "should indicate cached result" do
+        opts = {
+          product: "test",
+          version: "1.0",
+          cache_file: path,
+        }
+
+        # Just run it twice
+        c = described_class.check(opts)
+        c = described_class.check(opts)
+
+        expect(c["cached"]).to eq(true)
+      end
+    end
+
+    context "with errors" do
+      let(:error_class){ StandardError }
+      let(:opts) {
+        {
+          product: "test",
+          version: "1.0"
+        }
       }
+      before{ allow(Net::HTTP).to receive(:new).and_raise(error_class) }
 
-      # Just run it twice
-      c = described_class.check(opts)
-      c = described_class.check(opts)
+      it "should not raise error by default" do
+        expect(described_class.check(opts)).to be_nil
+      end
+
+      it "should raise error when option set" do
+        expect{ described_class.check(opts.merge(raise_error: true)) }.to raise_error(error_class)
+      end
+
+      context "with non-StandardError descendant exception" do
+        let(:error_class){ Interrupt }
+
+        it "should raise error by default" do
+          expect{ described_class.check(opts) }.to raise_error(error_class)
+        end
+
+        it "should raise error when option set" do
+          expect{ described_class.check(opts.merge(raise_error: true)) }.to raise_error(error_class)
+        end
+      end
+    end
 
-      expect(c["product"]).to eq("test")
+    it "does not check when CHECKPOINT_DISABLE=1" do
+      allow(ENV).to receive(:[])
+        .with("CHECKPOINT_DISABLE")
+        .and_return(1)
+      expect(described_class.check).to be(nil)
     end
   end
 end

data/spec/helper.rb

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 require 'rspec/its'
 
 require "checkpoint"

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: hashicorp-checkpoint
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Mitchell Hashimoto
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !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.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
 description: Internal HashiCorp service to check version information
 email:
 - mitchell@hashicorp.com
@@ -73,9 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".ci/.ci-utility-files/common.sh"
+- ".ci/github-release"
+- ".ci/load-ci.sh"
+- ".ci/publish"
+- ".github/CODEOWNERS"
+- ".github/workflows/github-release.yml"
+- ".github/workflows/publish-rubygem.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/testing-skipped.yml"
+- ".github/workflows/testing.yml"
+- ".gitignore"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/checkpoint.rb
@@ -86,26 +82,25 @@ files:
 - spec/helper.rb
 homepage: http://www.hashicorp.com
 licenses:
-- MPL2
+- MPL-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Internal HashiCorp service to check version information.
 test_files: