hashicorp-checkpoint 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8bdfc4771a54a9e57d70af10ebbc33d7b76b7a7
-  data.tar.gz: cc5563d354f76e62d8f182c1bc1d57ba5c956c0b
+  metadata.gz: 604e2e85115ca7d44ade31c7cfa3a5bdf1d003cb
+  data.tar.gz: 379325a25d71edcd923c2a9fea987842086f1868
 SHA512:
-  metadata.gz: 91267521c05618d871b0378c255f7c541ad6678aeb1f167198306911dac8fbd94b5abcad59bc7d40c41ab927d6e8cec56df238a512ecb37a8ae0e36f0f4110b5
-  data.tar.gz: b7b749ac3140ec5ff63a8454fbc2140d8579bdccbb11c2c1f13fe2d1e4d63f5019138f21342297127fe714422dd094c26694b2b04212b8d458aee48004d79b04
+  metadata.gz: ba7edf03a9c7f81acd34543c9a8eb34bac66eeae83c8abc4cbc31a5ca3dbafa4eb14124df3e9ded0eb6dcca081f408ed793e3695e252c8bda306934f058d83df
+  data.tar.gz: 806138673d25c4c9f7ffc8ec56e11f044170df2cbb53c573dfc1ab5ce632761db366e94b4e8270a9b171e647e89a94154c0b238ae089dda31f5e16a4f6fc185c

data/lib/checkpoint.rb

@@ -9,7 +9,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.
   #
@@ -35,7 +35,7 @@ module Checkpoint
       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 +101,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 +116,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/lib/checkpoint/version.rb

@@ -1,3 +1,3 @@
 module Checkpoint
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/checkpoint_spec.rb

@@ -4,6 +4,10 @@ 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(
@@ -19,23 +23,84 @@ describe Checkpoint do
       its(["product"]) { should eq("test") }
     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
+
+      it "should indicate cached result" do
+        opts = {
+          product: "test",
+          version: "1.0",
+          cache_file: path,
+        }
 
-      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) }
+
+      it "should not raise error by default" do
+        expect(described_class.check(opts)).to be_nil
+      end
 
-      # Just run it twice
-      c = described_class.check(opts)
-      c = described_class.check(opts)
+      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

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: hashicorp-checkpoint
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mitchell Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2018-01-19 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
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 description: Internal HashiCorp service to check version information
@@ -73,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,17 +94,17 @@ 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
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Internal HashiCorp service to check version information.