chef-encrypted-attributes 0.3.0 → 0.4.0

data/lib/chef/knife/encrypted_attribute_edit.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
 # Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
@@ -16,53 +17,71 @@
 # limitations under the License.
 #
 
-require 'chef/knife/encrypted_attribute_show'
+require 'chef/knife/core/encrypted_attribute_base'
+require 'chef/knife/core/encrypted_attribute_depends'
 require 'chef/knife/core/encrypted_attribute_editor_options'
 
 class Chef
   class Knife
-    class EncryptedAttributeEdit < EncryptedAttributeShow
-
+    # knife encrypted attribute edit command.
+    #
+    # ```
+    # $ knife encrypted attribute edit NODE ATTRIBUTE (options)
+    # ```
+    class EncryptedAttributeEdit < Core::EncryptedAttributeBase
+      include Knife::Core::EncryptedAttributeDepends
       include Knife::Core::EncryptedAttributeEditorOptions
 
       option :input_format,
-        :short => '-i FORMAT',
-        :long => '--input-format FORMAT',
-        :description => 'Input (EDITOR) format, supported formats are "plain" (default) and "json"'
+             short: '-i FORMAT',
+             long: '--input-format FORMAT',
+             description:
+               'Input (EDITOR) format, supported formats are "plain" '\
+               '(default) and "json"'
 
       banner 'knife encrypted attribute edit NODE ATTRIBUTE (options)'
 
-      def run
-        node_name = @name_args[0]
-        attr_path = @name_args[1]
-
-        if node_name.nil?
-          show_usage
-          ui.fatal('You must specify a node name')
-          exit 1
-        end
-
-        if attr_path.nil?
-          show_usage
-          ui.fatal('You must specify an encrypted attribute name')
-          exit 1
-        end
-
-        attr_ary = attribute_path_to_ary(attr_path)
+      # (see EncryptedAttributeBase#assert_valid_args)
+      # @raise [ArgumentError] if the attribute path format is wrong.
+      def assert_valid_args
+        assert_attribute_exists(@node_name, @attr_ary)
+      end
 
-        # check if the encrypted attribute already exists
-        unless Chef::EncryptedAttribute.exist_on_node?(node_name, attr_ary)
-          ui.fatal('Encrypted attribute not found')
-          exit 1
-        end
+      # Runs knife command.
+      #
+      # @raise [RuntimeError] if the editing command fails.
+      # @return void
+      # @raise [ArgumentError] if the attribute path format or the user list is
+      #   wrong.
+      # @raise [UnacceptableEncryptedAttributeFormat] if encrypted attribute
+      #   format is wrong or does not exist.
+      # @raise [UnsupportedEncryptedAttributeFormat] if encrypted attribute
+      #   format is not supported or unknown.
+      # @raise [EncryptionFailure] if there are encryption errors.
+      # @raise [MessageAuthenticationFailure] if HMAC calculation error.
+      # @raise [InvalidPublicKey] if it is not a valid RSA public key.
+      # @raise [InvalidKey] if the RSA key format is wrong.
+      # @raise [InsufficientPrivileges] if you lack enough privileges to read
+      #   the keys from the Chef Server.
+      # @raise [ClientNotFound] if client does not exist.
+      # @raise [Net::HTTPServerException] for Chef Server HTTP errors.
+      # @raise [RequirementsFailure] if the specified encrypted attribute
+      #   version cannot be used.
+      # @raise [SearchFailure] if there is a Chef search error.
+      # @raise [SearchFatalError] if the Chef search response is wrong.
+      # @raise [InvalidSearchKeys] if search keys structure is wrong.
+      def run
+        parse_args
 
         # edit encrypted attribute
-        enc_attr = Chef::EncryptedAttribute.new(Chef::Config[:knife][:encrypted_attributes])
-        input = enc_attr.load_from_node(node_name, attr_ary)
+        enc_attr =
+          Chef::EncryptedAttribute.new(
+            Chef::Config[:knife][:encrypted_attributes]
+          )
+        input = enc_attr.load_from_node(@node_name, @attr_ary)
         output = edit_data(input, config[:input_format])
-        enc_attr.create_on_node(node_name, attr_ary, output)
+        enc_attr.create_on_node(@node_name, @attr_ary, output)
       end
-
     end
   end
 end

data/lib/chef/knife/encrypted_attribute_show.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
 # Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
@@ -16,71 +17,45 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
+require 'chef/knife/core/encrypted_attribute_base'
+require 'chef/knife/core/encrypted_attribute_depends'
 
 class Chef
   class Knife
-    class EncryptedAttributeShow < Knife
-
-      deps do
-        require 'chef/encrypted_attribute'
-        require 'chef/json_compat'
-      end
+    # knife encrypted attribute show command.
+    #
+    # ```
+    # $ knife encrypted attribute show NODE ATTRIBUTE (options)
+    # ```
+    class EncryptedAttributeShow < Core::EncryptedAttributeBase
+      include Knife::Core::EncryptedAttributeDepends
 
       banner 'knife encrypted attribute show NODE ATTRIBUTE (options)'
 
-      def run
-        node_name = @name_args[0]
-        attr_path = @name_args[1]
-
-        if node_name.nil?
-          show_usage
-          ui.fatal('You must specify a node name')
-          exit 1
-        end
-
-        if attr_path.nil?
-          show_usage
-          ui.fatal('You must specify an encrypted attribute name')
-          exit 1
-        end
-
-        attr_ary = attribute_path_to_ary(attr_path)
+      # (see EncryptedAttributeBase#assert_valid_args)
+      # @raise [ArgumentError] if the attribute path format is wrong.
+      def assert_valid_args
+        assert_attribute_exists(@node_name, @attr_ary)
+      end
 
-        unless Chef::EncryptedAttribute.exist_on_node?(node_name, attr_ary)
-          ui.fatal('Encrypted attribute not found')
-          exit 1
-        end
+      # Runs knife command.
+      #
+      # @return void
+      # @raise [ArgumentError] if the attribute path format is wrong.
+      # @raise [UnacceptableEncryptedAttributeFormat] if encrypted attribute
+      #   format is wrong.
+      # @raise [UnsupportedEncryptedAttributeFormat] if encrypted attribute
+      #   format is not supported or unknown.
+      # @raise [SearchFailure] if there is a Chef search error.
+      # @raise [SearchFatalError] if the Chef search response is wrong.
+      # @raise [InvalidSearchKeys] if search keys structure is wrong.
+      def run
+        parse_args
 
-        enc_attr = Chef::EncryptedAttribute.load_from_node(node_name, attr_ary)
+        enc_attr =
+          Chef::EncryptedAttribute.load_from_node(@node_name, @attr_ary)
         output(enc_attr)
       end
-
-      def attribute_path_to_ary(str, delim='.', escape='\\')
-        # return str.scan(/(?:[^.\\]|\\.)+/).map {|x| x.gsub('\\.', '.') } # cool, but doesn't work for some edge cases
-        result = []
-        current = ''
-        i = 0
-        while ! str[i].nil?
-          if str[i] == escape
-            if str[i+1] == delim
-              current << str[i+1]
-            else
-              current << str[i]
-              current << str[i+1] unless str[i+1].nil?
-            end
-            i += 1 # skip the next char
-          elsif str[i] == delim
-            result << current
-            current = ''
-          else
-            current << str[i]
-          end
-          i += 1
-        end
-        result << current
-      end
-
     end
   end
 end

data/lib/chef/knife/encrypted_attribute_update.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
 # Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
@@ -16,50 +17,64 @@
 # limitations under the License.
 #
 
-require 'chef/knife/encrypted_attribute_show'
+require 'chef/knife/core/encrypted_attribute_base'
+require 'chef/knife/core/encrypted_attribute_depends'
 require 'chef/knife/core/encrypted_attribute_editor_options'
 
 class Chef
   class Knife
-    class EncryptedAttributeUpdate < EncryptedAttributeShow
-
+    # knife encrypted attribute update command.
+    #
+    # ```
+    # $ knife encrypted attribute update NODE ATTRIBUTE (options)
+    # ```
+    class EncryptedAttributeUpdate < Core::EncryptedAttributeBase
+      include Knife::Core::EncryptedAttributeDepends
       include Knife::Core::EncryptedAttributeEditorOptions
 
       banner 'knife encrypted attribute update NODE ATTRIBUTE (options)'
 
-      def run
-        node_name = @name_args[0]
-        attr_path = @name_args[1]
-
-        if node_name.nil?
-          show_usage
-          ui.fatal('You must specify a node name')
-          exit 1
-        end
-
-        if attr_path.nil?
-          show_usage
-          ui.fatal('You must specify an encrypted attribute name')
-          exit 1
-        end
-
-        attr_ary = attribute_path_to_ary(attr_path)
+      # (see EncryptedAttributeBase#assert_valid_args)
+      # @raise [ArgumentError] if the attribute path format is wrong.
+      def assert_valid_args
+        assert_attribute_exists(@node_name, @attr_ary)
+      end
 
-        # check if the encrypted attribute already exists
-        unless Chef::EncryptedAttribute.exist_on_node?(node_name, attr_ary)
-          ui.fatal('Encrypted attribute not found')
-          exit 1
-        end
+      # Runs knife command.
+      #
+      # @return void
+      # @raise [ArgumentError] if the attribute path format or the user list is
+      #   wrong.
+      # @raise [UnacceptableEncryptedAttributeFormat] if encrypted attribute
+      #   format is wrong or does not exist.
+      # @raise [UnsupportedEncryptedAttributeFormat] if encrypted attribute
+      #   format is not supported or unknown.
+      # @raise [EncryptionFailure] if there are encryption errors.
+      # @raise [MessageAuthenticationFailure] if HMAC calculation error.
+      # @raise [InvalidPublicKey] if it is not a valid RSA public key.
+      # @raise [InvalidKey] if the RSA key format is wrong.
+      # @raise [InsufficientPrivileges] if you lack enough privileges to read
+      #   the keys from the Chef Server.
+      # @raise [ClientNotFound] if client does not exist.
+      # @raise [Net::HTTPServerException] for Chef Server HTTP errors.
+      # @raise [RequirementsFailure] if the specified encrypted attribute
+      #   version cannot be used.
+      # @raise [SearchFailure] if there is a Chef search error.
+      # @raise [SearchFatalError] if the Chef search response is wrong.
+      # @raise [InvalidSearchKeys] if search keys structure is wrong.
+      def run
+        parse_args
 
         # update encrypted attribute
-        enc_attr = Chef::EncryptedAttribute.new(Chef::Config[:knife][:encrypted_attributes])
-        if enc_attr.update_on_node(node_name, attr_ary)
+        enc_attr = Chef::EncryptedAttribute.new(
+                     Chef::Config[:knife][:encrypted_attributes]
+                   )
+        if enc_attr.update_on_node(@node_name, @attr_ary)
           ui.info('Encrypted attribute updated.')
         else
           ui.info('Encrypted attribute does not need updating.')
         end
       end
-
     end
   end
 end

data/spec/benchmark_helper.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
 # Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
@@ -18,7 +19,7 @@
 
 require 'rspec/autorun'
 require 'chef_zero/rspec'
-require 'chef-encrypted-attributes'
+require 'chef/encrypted_attributes'
 
 require 'support/silent_formatter'
 RSpec.configure do |config|

data/spec/integration_helper.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
 # Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
 # Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
@@ -17,7 +18,7 @@
 #
 
 require 'simplecov'
-if ENV['TRAVIS'] and RUBY_VERSION >= '2.0'
+if ENV['TRAVIS'] && RUBY_VERSION >= '2.0'
   require 'coveralls'
   SimpleCov.formatter = Coveralls::SimpleCov::Formatter
 end
@@ -25,22 +26,35 @@ SimpleCov.start do
   add_filter '/spec/'
 end
 
-require 'chef-encrypted-attributes'
+require 'chef/encrypted_attributes'
 require 'chef/exceptions'
 
 require 'rspec/autorun'
+require 'should_not/rspec'
 
 require 'support/platform_helpers'
+require 'support/chef_helpers'
+require 'support/encrypted_attributes_helpers'
 
 RSpec.configure do |config|
+  # Prohibit using the should syntax
+  config.expect_with :rspec do |spec|
+    spec.syntax = :expect
+  end
+
   config.order = 'random'
 
   config.color = true
   config.tty = true
 
-  config.filter_run_excluding :ruby_gte_19 => true unless ruby_gte_19?
-  config.filter_run_excluding :ruby_gte_20 => true unless ruby_gte_20?
-  config.filter_run_excluding :ruby_gte_20_and_openssl_gte_101 => true unless (ruby_gte_20? && openssl_gte_101?)
-  config.filter_run_excluding :openssl_lt_101 => true unless openssl_lt_101?
-  config.filter_run_excluding :ruby_lt_20 => true unless ruby_lt_20?
+  config.filter_run_excluding ruby_gte_19: true unless ruby_gte_19?
+  config.filter_run_excluding ruby_gte_20: true unless ruby_gte_20?
+  unless ruby_gte_20? && openssl_gte_101?
+    config.filter_run_excluding ruby_gte_20_and_openssl_gte_101: true
+  end
+  config.filter_run_excluding openssl_lt_101: true unless openssl_lt_101?
+  config.filter_run_excluding ruby_lt_20: true unless ruby_lt_20?
+
+  config.include ChefHelpers
+  config.include EncryptedAttributesHelpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-encrypted-attributes
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Onddo Labs, SL.
@@ -30,144 +30,178 @@ cert_chain:
   cYe8PqNEkky7ugvF4zU3sB6TW+96XasuwDv1uJmyr35LF15U6Cs83+osMbAKJTmG
   /vqKzw==
   -----END CERTIFICATE-----
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
+  name: ffi-yajl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '11.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '11.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: chef-zero
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: should_not
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.27.1
 description: Chef plugin to add Node encrypted attributes support using client keys
 email: team@onddo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- API.md
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
-- INTERNAL.md
+- KNIFE.md
 - LICENSE
 - README.md
 - Rakefile
@@ -175,6 +209,7 @@ files:
 - TODO.md
 - lib/chef-encrypted-attributes.rb
 - lib/chef/encrypted_attribute.rb
+- lib/chef/encrypted_attribute/api.rb
 - lib/chef/encrypted_attribute/assertions.rb
 - lib/chef/encrypted_attribute/cache_lru.rb
 - lib/chef/encrypted_attribute/config.rb
@@ -190,7 +225,10 @@ files:
 - lib/chef/encrypted_attribute/remote_users.rb
 - lib/chef/encrypted_attribute/search_helper.rb
 - lib/chef/encrypted_attribute/version.rb
+- lib/chef/encrypted_attributes.rb
 - lib/chef/knife/core/config.rb
+- lib/chef/knife/core/encrypted_attribute_base.rb
+- lib/chef/knife/core/encrypted_attribute_depends.rb
 - lib/chef/knife/core/encrypted_attribute_editor_options.rb
 - lib/chef/knife/encrypted_attribute_create.rb
 - lib/chef/knife/encrypted_attribute_delete.rb
@@ -210,12 +248,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -225,6 +263,7 @@ signing_key:
 specification_version: 4
 summary: Chef Encrypted Attributes
 test_files:
+- spec/spec_helper.rb
 - spec/integration_helper.rb
 - spec/benchmark_helper.rb
-- spec/spec_helper.rb
+has_rdoc: