supermarket_sync 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818056b410af5497f35e4e401e0d527890627e1be89b43733c8c2572b20fecd1
-  data.tar.gz: c003e878b9c3986ac4d1996ca37a097af0133475c3913add3c16a5b8b564f0b4
+  metadata.gz: e49526e10c933bd481d24189a6ea0d08a11cfe358fbeb4167911417d6b18e6d3
+  data.tar.gz: f144b0219e2d50c18bdfceb8633d3d84029d8e93bfac8ae94f8743ccc5cff03a
 SHA512:
-  metadata.gz: e5063cfe32685f9f93794fa626608963d2aa1432749f9406d6a6ba5b84492384ccec8e4dd16c089a06200e881237a9da9fe8933da4d230ca91e646b6bc3cb018
-  data.tar.gz: 9b12d8f1b4dceda17a36783eae45004bd9ff3fa7644ff35e8ab503edba66ad640478432f6a0457723612e66f9bd4cb6c3951c9c190abac5b1f7c271b2f64ac23
+  metadata.gz: fb5c4cef8a6e3c413029d6d1b90c9e589bc7ebf06b29c584387ba020e49d8689f5b203bf9bbe90bba565ced34b72c46aafb0fcbb29a66ec480be9ae215d7ef67
+  data.tar.gz: bb790be524aa65b246e8bd4747cdfbdd27ce55b34c5fa5b0a3d9e90571ed8f094f20d75eae9d9238fc59e2ed0626386ce77ba1286ac63438e956d31a15688370

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+name: Ruby
+on: [push]
+jobs:
+  test:
+    name: Build
+    runs-on: ubuntu-latest
+    container: ruby:3.0
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Git Info
+        id: git
+        run: |
+          echo ::set-output name=SOURCE_NAME::${GITHUB_REF#refs/*/}
+          echo ::set-output name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
+          echo ::set-output name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
+
+      - name: Test
+        env:
+          ABC: '123'
+        run: |
+          gem install rubocop --no-document
+          rubocop
+
+      - name: Release
+        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          ABC: '123'
+        run: |
+          gem install dpl --no-document
+          find . -type f -exec chmod o--w "{}" \;
+
+      - run: dpl --provider=rubygems --api-key=$RUBYGEMS_API_KEY --gem=supermarket_sync

data/.gitlab-ci.yml

@@ -4,8 +4,8 @@ before_script:
   - gem install bundler --no-document
   - bundle install --jobs $(nproc) --path vendor/bundle
 
-test:Ruby 2.5:
-  image: ruby:2.5
+test:Ruby 3.0:
+  image: ruby:3.0
   cache:
     paths:
       - .bundle
@@ -13,12 +13,12 @@ test:Ruby 2.5:
   script:
     - bundle exec rubocop
   tags:
-    - ruby
+    - docker
   except:
     - tags
 
-release:Ruby 2.5:
-  image: ruby:2.5
+release:Ruby 3.0:
+  image: ruby:3.0
   cache:
     paths:
       - .bundle
@@ -33,6 +33,6 @@ release:Ruby 2.5:
     paths:
       - ./*.gem
   tags:
-    - ruby
+    - docker
   only:
     - tags

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.3
+ruby-3.0.2

data/CHANGELOG.md

@@ -2,6 +2,20 @@ SupermarketSync Changelog
 =========================
 This file is used to list changes made in each version of the `supermarket_sync` gem.
 
-v0.1.0 (2016-11-09)
+v0.1.3 (2019-8-2)
 -------------------
-- Initial Release TBD
+- Ignore cookbook category due to deprecation
+
+v0.1.2 (2018-11-12)
+-------------------
+- Expose more configuration via environment variables
+
+v0.1.1 (2018-11-12)
+-------------------
+- Fix for non-existing cookbooks
+- Rename function to avoid potential namespace collision
+- Add a read-only mode for testing purposes
+
+v0.1.0 (2018-11-09)
+-------------------
+- Initial Release

data/README.md

@@ -2,25 +2,9 @@
 * Ruby Gem to programmatically synchronize Chef Supermarkets
 
 ## Background
-This gem was built from a need to synchronize a private, internal Chef Supermarket from the Public Chef Supermarket.
+This gem was built from a need to synchronize approved cookbooks to a private, internal Chef Supermarket from the Public Chef Supermarket.
 
-At the same time, being able to send notifications of changes and deprecations was also desired.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'supermarket_sync'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install supermarket_sync
+It was also desired to send notifications upon changes and deprecations.
 
 ## Usage
 
@@ -30,15 +14,21 @@ Usage: supermarket_sync (options)
         --cookbooks-json CONFIG      List of cookbooks to synchronize
 ```
 
-You can supply individual configuration for supermarkets invidivually via the configuration file.
+* Supermarkets can be configured individually via the configuration file.
 
-Otherwise, you can configure global Chef parameters via environment variables.  This may prove handy in a CI pipeline scenario.
+* If left unspecified, global Supermarket parameters can be passed in via environment variables.
 
 ```
+# Set Supermarket Globals
 export SM_USER='supermarket_user'
 export SM_KEY='/path/to/my/key.pem'
+
+# Sync the Supermarkets
+supermarket_sync -c config.json --cookbooks-json cookbooks.json
 ```
 
+* Slack notifications are optional and can be configured via notification hash in `config.json`.
+
 #### Configuration Samples
 
 `config.json`
@@ -77,7 +67,21 @@ export SM_KEY='/path/to/my/key.pem'
 }
 ```
 
-####
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'supermarket_sync'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install supermarket_sync
 
 
 ## Development

data/lib/supermarket_sync/cli.rb

@@ -5,7 +5,7 @@
 #
 # The MIT License (MIT)
 #
-# Copyright:: 2018, Brian Dwyer - Broadridge Financial Solutions
+# Copyright:: 2021, Brian Dwyer - Broadridge Financial Solutions
 #
 
 require 'mixlib/cli'
@@ -60,6 +60,7 @@ module SupermarketSync
         cfg.notification   = config[:notification]
         cfg.supermarkets   = config[:supermarkets]
         cfg.source         = config[:source]
+        cfg.read_only      = config[:read_only]
       end
 
       # => Start the Sync

data/lib/supermarket_sync/config.rb

@@ -5,7 +5,7 @@
 #
 # The MIT License (MIT)
 #
-# Copyright:: 2018, Brian Dwyer - Broadridge Financial Solutions
+# Copyright:: 2021, Brian Dwyer - Broadridge Financial Solutions
 #
 
 require 'supermarket_sync/helpers/configuration'
@@ -25,10 +25,10 @@ module SupermarketSync
     define_setting :author, 'Brian Dwyer - Broadridge Financial Services'
 
     # => Config File
-    define_setting :config_file, File.join(root, 'config', 'config.json')
+    define_setting :config_file, ENV['SM_SYNC_CONFIG'] || File.join(root, 'config', 'config.json')
 
     # => Cookbooks File
-    define_setting :cookbooks_file, File.join(root, 'config', 'cookbooks.json')
+    define_setting :cookbooks_file, ENV['SM_SYNC_COOKBOOKS'] || File.join(root, 'config', 'cookbooks.json')
 
     # => Supermarket Configuration
     define_setting :supermarkets, {}
@@ -44,6 +44,9 @@ module SupermarketSync
                               user: ENV['SM_USER'],
                               key:  ENV['SM_KEY']
 
+    # => Read-Only Mode
+    define_setting :read_only, ENV['SM_SYNC_READONLY']
+
     #
     # Facilitate Dynamic Addition of Configuration Values
     #

data/lib/supermarket_sync/notifier.rb

@@ -5,7 +5,7 @@
 #
 # The MIT License (MIT)
 #
-# Copyright:: 2018, Brian Dwyer - Broadridge Financial Solutions
+# Copyright:: 2021, Brian Dwyer - Broadridge Financial Solutions
 #
 
 require 'slack-notifier'

data/lib/supermarket_sync/sync.rb

@@ -5,14 +5,14 @@
 #
 # The MIT License (MIT)
 #
-# Copyright:: 2018, Brian Dwyer - Broadridge Financial Solutions
+# Copyright:: 2021, Brian Dwyer - Broadridge Financial Solutions
 #
 
 require 'chef/http/json_input'
 require 'chef/http/json_output'
 require 'chef/http/remote_request_id'
 require 'chef/http/simple_json'
-require 'chef/cookbook_site_streaming_uploader'
+require 'chef/knife/core/cookbook_site_streaming_uploader'
 require 'mixlib/cli'
 require 'supermarket_sync/notifier'
 
@@ -38,7 +38,7 @@ module SupermarketSync
           puts "Checking #{cookbook}"
           # => Grab Source Metadata
           source_meta = begin
-                          source.get("/api/v1/cookbooks/#{cookbook}")
+                          src.get("/api/v1/cookbooks/#{cookbook}")
                         rescue Net::HTTPServerException => e
                           raise e unless e.response.code == '404'
                           puts 'Cookbook not available on Source Supermarket'
@@ -53,7 +53,7 @@ module SupermarketSync
                       rescue Net::HTTPServerException => e
                         raise e unless e.response.code == '404'
                         # => Cookbook not found -- Initial Upload
-                        {}['latest_version'] = '0.0.0'
+                        { 'latest_version' => '0.0.0' }
                       end
           # => Determine Current Version
           current = ::Gem::Version.new(::File.basename(dest_meta['latest_version']))
@@ -64,10 +64,10 @@ module SupermarketSync
             puts "Destination: #{current}"
 
             # => Retrieve the Cookbook
-            tgz = source.streaming_request("/api/v1/cookbooks/#{cookbook}/versions/#{latest}/download")
+            tgz = src.streaming_request("/api/v1/cookbooks/#{cookbook}/versions/#{latest}/download")
 
             # => Upload the Cookbook
-            upload(source_meta['category'], tgz)
+            upload('other', tgz) unless Config.read_only
 
             # => Remove the Tempfile
             begin
@@ -112,18 +112,18 @@ module SupermarketSync
         end
       end
 
-      source context[:source] || Config.source
-      dest   context[:url]
+      src  context[:source] || Config.source
+      dest context[:url]
     end
 
     #
     # => API Clients
     #
-    private def source(url = nil)
-      url ||= @source&.url
+    def src(url = nil)
+      url ||= @src&.url
       raise ArgumentError, 'No URL supplied!' unless url
-      return @source if @source&.url == url
-      @source = Chef::HTTP::SimpleJSON.new(url)
+      return @src if @src&.url == url
+      @src = Chef::HTTP::SimpleJSON.new(url)
     end
 
     private def dest(url = nil)

data/lib/supermarket_sync/util.rb

@@ -5,7 +5,7 @@
 #
 # The MIT License (MIT)
 #
-# Copyright:: 2018, Brian Dwyer - Broadridge Financial Solutions
+# Copyright:: 2021, Brian Dwyer - Broadridge Financial Solutions
 #
 
 require 'json'

data/lib/supermarket_sync/version.rb

@@ -1,3 +1,3 @@
 module SupermarketSync
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/supermarket_sync.gemspec

@@ -28,12 +28,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # => Dependencies
-  spec.add_runtime_dependency 'chef', '> 12.19.36'
-  spec.add_runtime_dependency 'slack-notifier', '~> 2.3.2'
+  spec.add_runtime_dependency 'knife', '>= 17.1', '< 18.0'
+  spec.add_runtime_dependency 'mixlib-cli', '>= 2.1.1', '< 3.0'
+  spec.add_runtime_dependency 'slack-notifier', '~> 2.4.0'
 
   # => Development Dependencies
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '= 0.55'
 end

metadata

@@ -1,71 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: supermarket_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brian Dwyer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-11-10 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: chef
+  name: knife
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 12.19.36
+        version: '17.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '18.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '17.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 12.19.36
+        version: '18.0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +120,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '0.55'
-description: 
+description:
 email:
 - chef@broadridge.com
 executables:
@@ -102,6 +128,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
@@ -131,7 +158,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,9 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Utility to synchronize Chef Supermarkets
 test_files: []