chef-encrypted-attributes 0.6.0.beta.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8957490821771911a13f88beedb3c1062cecdada
-  data.tar.gz: 83d2ccac8b9e7501fb064f1c330952b40fc382e8
+  metadata.gz: 9152cd93c8d694d37df7659cae3d93bf00ae85f0
+  data.tar.gz: 539393acaeef1511dd82dc035a38365ec012b043
 SHA512:
-  metadata.gz: 7fa1dc731720540385d2989062205e8542f6c4756d9cca635cabfdbfb29640b15b2722bc32aa059d43b2220d50e721a4a86a2e6602c35311ed3006aabed30518
-  data.tar.gz: 519810b6191fd1ba8b4f34746531f0341621d25f9d8eec9d3a206e4ab298389efb0beff22621274d8c0c058b700a280dd70dab46a6de79bf4a00f932babbe1dc
+  metadata.gz: 5a943ad2d06b15cd9d39a00c81da3907ecbf42e7e3a9c506db815296b32245203a3d1bd3e7076a4afd0aefb06576a43c34524abc938b61965c86c10c663f3b65
+  data.tar.gz: 1f11c694453b7fc80717808159e81c242909fe2b18b271a45400d1bfd11c21fb696155978a5604eba048a5d6795caa70102f37ad9803de26f068fbd5a9b9667f

data/CHANGELOG.md

@@ -2,9 +2,11 @@
 
 This file is used to list changes made in each version of `chef-encrypted-attributes`.
 
-## 0.6.0.beta.1 (2015-05-01)
+## 0.6.0 (2015-05-08)
 
 * Conditional gem dependency installation within a gemspec ([issue #2](https://github.com/onddo/chef-encrypted-attributes/pull/2), thanks [@chhsiung](https://github.com/chhsiung) for the help).
+* Choose YAJL library based on chef version ([issue #4](https://github.com/onddo/chef-encrypted-attributes/pull/4), thanks [Lisa Danz](https://github.com/ldanz)).
+* Add doc Rake task to generate the documentation.
 
 ## 0.5.0 (2015-04-03)
 

data/README.md

@@ -2,8 +2,8 @@
 [![Gem Version](http://img.shields.io/gem/v/chef-encrypted-attributes.svg?style=flat)](http://badge.fury.io/rb/chef-encrypted-attributes)
 [![Dependency Status](http://img.shields.io/gemnasium/onddo/chef-encrypted-attributes.svg?style=flat)](https://gemnasium.com/onddo/chef-encrypted-attributes)
 [![Code Climate](http://img.shields.io/codeclimate/github/onddo/chef-encrypted-attributes.svg?style=flat)](https://codeclimate.com/github/onddo/chef-encrypted-attributes)
-[![Build Status](http://img.shields.io/travis/onddo/chef-encrypted-attributes.svg?style=flat)](https://travis-ci.org/onddo/chef-encrypted-attributes)
-[![Coverage Status](http://img.shields.io/coveralls/onddo/chef-encrypted-attributes.svg?style=flat)](https://coveralls.io/r/onddo/chef-encrypted-attributes?branch=master)
+[![Build Status](http://img.shields.io/travis/onddo/chef-encrypted-attributes/0.6.0.svg?style=flat)](https://travis-ci.org/onddo/chef-encrypted-attributes)
+[![Coverage Status](http://img.shields.io/coveralls/onddo/chef-encrypted-attributes/0.6.0.svg?style=flat)](https://coveralls.io/r/onddo/chef-encrypted-attributes?branch=0.6.0)
 [![Inline docs](http://inch-ci.org/github/onddo/chef-encrypted-attributes.svg?branch=master&style=flat)](http://inch-ci.org/github/onddo/chef-encrypted-attributes)
 
 [Chef](https://www.chef.io/) plugin to add Node encrypted attributes support using client keys.
@@ -20,7 +20,7 @@ Node attributes are encrypted using chef client and user keys with public key in
 
 * Ruby `>= 1.9`
 * Chef Client `~> 11.4`
-* ffi_yajl `~> 1.0` (included with Chef)
+* yajl_ruby `~> 1.1` or ffi_yajl `>= 1.0, <3.0` (included with Chef)
 * If you want to use protocol version 2 to use [GCM](http://en.wikipedia.org/wiki/Galois/Counter_Mode) (disabled by default):
  * Ruby `>= 2`.
  * OpenSSL `>= 1.0.1`.
@@ -243,6 +243,7 @@ See [TODO.md](https://github.com/onddo/chef-encrypted-attributes/blob/master/TOD
 | **Author:**          | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@onddo.com>)
 | **Contributor:**     | [Josh Kalderimis](https://github.com/joshk)
 | **Contributor:**     | [@chhsiung](https://github.com/chhsiung)
+| **Contributor:**     | [Lisa Danz](https://github.com/ldanz)
 | **Copyright:**       | Copyright (c) 2014-2015 Onddo Labs, SL. (www.onddo.com)
 | **License:**         | Apache License, Version 2.0
 

data/Rakefile

@@ -27,6 +27,16 @@ Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
+desc 'Generate Ruby documentation'
+task :yard do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.stats_options = %w(--list-undoc)
+  end
+end
+
+task doc: %w(yard)
+
 desc 'Run RuboCop style checks'
 task :rubocop do
   require 'rubocop/rake_task'

data/TESTING.md

@@ -7,6 +7,12 @@ You can install gem dependencies with bundler:
     $ gem install bundler
     $ bundler install
 
+## Generate Documentation
+
+    $ bundle exec rake doc
+
+This will generate the HTML documentation in the `doc/` directory.
+
 ## All the Tests
 
     $ bundle exec rake test

data/lib/chef/encrypted_attribute/encrypted_mash/version0.rb

@@ -17,9 +17,14 @@
 # limitations under the License.
 #
 
+require 'chef/version'
 require 'chef/encrypted_attribute/encrypted_mash'
 require 'chef/encrypted_attribute/exceptions'
-require 'ffi_yajl'
+require 'chef/encrypted_attribute/yajl'
+
+# Use the YAJL library that Chef provides.  Determine which to use based on
+# Chef version.
+YAJL_NAMESPACE = Chef::EncryptedAttribute::Yajl.load_requirement(Chef::VERSION)
 
 class Chef
   class EncryptedAttribute
@@ -197,7 +202,7 @@ class Chef
         def json_encode(o)
           # TODO: This does not check if the object is correct, should be an
           # Array or a Hash
-          FFI_Yajl::Encoder.encode(o)
+          YAJL_NAMESPACE::Encoder.encode(o)
         end
 
         # Decodes a JSON string.
@@ -206,8 +211,8 @@ class Chef
         # @return [Mixed] Ruby representation of the JSON string.
         # @raise [DecryptionFailure] if JSON string format is wrong.
         def json_decode(o)
-          FFI_Yajl::Parser.parse(o.to_s)
-        rescue FFI_Yajl::ParseError => e
+          YAJL_NAMESPACE::Parser.parse(o.to_s)
+        rescue YAJL_NAMESPACE::ParseError => e
           raise DecryptionFailure, "#{e.class.name}: #{e}"
         end
 

data/lib/chef/encrypted_attribute/version.rb

@@ -20,6 +20,6 @@
 class Chef
   class EncryptedAttribute
     # `chef-encrypted-attributes` gem version.
-    VERSION = '0.6.0.beta.2'
+    VERSION = '0.6.0'
   end
 end

data/lib/chef/encrypted_attribute/yajl.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+#
+# Author:: Lisa Danz (<lisa.danz@opower.com>)
+# Author:: Xabier de Zuazo (<xabier@onddo.com>)
+# Copyright:: Copyright (c) 2015 Onddo Labs, SL. (www.onddo.com)
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Chef
+  class EncryptedAttribute
+    # Helper module to abstract the required Yajl (JSON) dependecy.
+    module Yajl
+      # Loads the required Yajl JSON library depending on the installed Chef
+      # version.
+      #
+      # * Loads the `yajl` gem in Chef `< 11.13`.
+      # * Loads the `ffi_yajl` gem in Chef `>= 11.13`.
+      #
+      # @return [Class] The correct JSON class to use.
+      def self.load_requirement(chef_version)
+        if Gem::Requirement.new('< 11.13').satisfied_by?(
+          Gem::Version.new(chef_version)
+        )
+          require 'yajl'
+          ::Yajl
+        else
+          require 'ffi_yajl'
+          ::FFI_Yajl
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/core/encrypted_attribute_editor_options.rb

@@ -116,7 +116,7 @@ class Chef
         def edit_data_obj_to_string(data, format)
           case format
           when 'JSON', 'json'
-            FFI_Yajl::Parser.parse(data)
+            YAJL_NAMESPACE::Parser.parse(data)
           else
             data
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-encrypted-attributes
 version: !ruby/object:Gem::Version
-  version: 0.6.0.beta.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Onddo Labs, SL.
@@ -30,28 +30,8 @@ cert_chain:
   cYe8PqNEkky7ugvF4zU3sB6TW+96XasuwDv1uJmyr35LF15U6Cs83+osMbAKJTmG
   /vqKzw==
   -----END CERTIFICATE-----
-date: 2015-05-02 00:00:00.000000000 Z
+date: 2015-05-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ffi-yajl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +178,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.29.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Chef plugin to add Node encrypted attributes support using client keys
 email: team@onddo.com
 executables: []
@@ -233,6 +227,7 @@ files:
 - lib/chef/encrypted_attribute/remote_users.rb
 - lib/chef/encrypted_attribute/search_helper.rb
 - lib/chef/encrypted_attribute/version.rb
+- lib/chef/encrypted_attribute/yajl.rb
 - lib/chef/encrypted_attributes.rb
 - lib/chef/knife/core/config.rb
 - lib/chef/knife/core/encrypted_attribute_base.rb
@@ -261,12 +256,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Chef Encrypted Attributes