chef-api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 897751a69516ca8d1e12eaa9dcb521b32aaea046
-  data.tar.gz: 054568ad2efe5331ed9f752bd7ff6eab4127cd3a
+  metadata.gz: 75862fce6679a723c8a852797401ffba16d1797f
+  data.tar.gz: 062d62a2b686c86bb693195cbc109be922feeb3d
 SHA512:
-  metadata.gz: 49db17dfafabca27646fc677a2e3067ce165bb04982c51cfcbd7d999251495dab9c2b264dd56efa8c2aa06b3ab7e5a61b1a20de75fdbee9e80c4b06bdd5cef11
-  data.tar.gz: deb8bcb861d3d3dc352f1c554de34eb9fc8d6064d4a4e5aa9e32f4032341e1e37bd29c4f8af0cba49c138ff8cc4b9e610f0f0f3efc58447da79fd9d2a388048e
+  metadata.gz: 48bbfa255c2e75e154ab1fb89f8417c57fa7b495390d31241ef3f68dc5ca21970a6d9914dbef7627ad8ce786b740154819fa413209a110d702531949ad7cfefe
+  data.tar.gz: 3896eaa411e4a10307ee45d503c82da4b55eff89c85f356bfcdc3050f725a18a5f8485e88658e6ce45c42d356140eabb4b12880a31667714ef67cafe063d411f

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 bin
 .rspec
 .ruby-version
+vendor/

data/.travis.yml

@@ -1,7 +1,10 @@
+sudo: false
+
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.0
   - 2.1
+  - 2.2
+  - 2.3.1
 
 # Don't install local development gems on Travis, use parallel gem downloads
 bundler_args: --without development --jobs 7

data/CHANGELOG.md

@@ -1,32 +1,41 @@
-ChefAPI Changelog
-=================
+# ChefAPI Changelog
+
+## v0.6.0 (2016-05-05)
+
+- Remove support for Ruby 1.9
+- Add the ability to disable signing on a request
+- Always send JSON when authenticating a user
+- Fix to_json method contract
+- Add config file support. See the readme for an example
+- Add required fields to role schema
+- Do not symbolize keys in the config
+- Fix boolean logic in determining if SSL should be verified
+
+## v0.5.0 (2014-07-10)
 
-v0.5.0 (2014-07-10)
--------------------
 - Relax the dependency on mime-types
 - When searching for the file object of a multipart filepart, find the first IO that not a StringIO
 - Rewind IO objects after digesting them
 
-v0.4.1 (2014-07-07)
--------------------
+## v0.4.1 (2014-07-07)
+
 - Remove dependency on mixlib-authentication
 - Fix a bug where Content-Type headers were not sent properly
 - Switch to rake for test running
 - Improve test coverage with fixtures
 
-v0.4.0 (2014-07-05)
--------------------
+## v0.4.0 (2014-07-05)
+
 - Support multipart POST
 
-v0.3.0 (2014-06-18)
--------------------
+## v0.3.0 (2014-06-18)
+
 - Add search functionality
 - Add partial search
 - Update testing harness
 
+## v0.2.1 (2014-04-17)
 
-v0.2.1 (2014-04-17)
--------------------
 - Fix a series of typographical errors
 - Improved documentation for loading resources from disk
 - Improved spec coverage

data/README.md

@@ -2,11 +2,9 @@ ChefAPI Client
 ==============
 [![Gem Version](http://img.shields.io/gem/v/chef-api.svg)][gem]
 [![Build Status](http://img.shields.io/travis/sethvargo/chef-api.svg)][travis]
-[![Gittip](http://img.shields.io/gittip/sethvargo.svg)][gittip]
 
 [gem]: https://rubygems.org/gems/chef-api
 [travis]: http://travis-ci.org/sethvargo/chef-api
-[gittip]: https://www.gittip.com/sethvargo
 
 **ChefAPI is currently in rapid development!** You should not consider this API stable until the official 1.0.0 release.
 
@@ -104,6 +102,16 @@ export CHEF_API_CLIENT=bacon
 export CHEF_API_KEY=~/.chef/bacon.pem
 ```
 
+In addition, you can configure the environment variables in a JSON-formatted config file either placed in ~/.chef-api or placed in a location configured via the environment variable `CHEF_API_CONFIG`. For example:
+
+```json
+{
+  "CHEF_API_ENDPOINT": "https://api.opscode.com/organizations/meats",
+  "CHEF_API_CLIENT": "bacon",
+  "CHEF_API_KEY": "~/.chef/bacon.pem"
+}
+```
+
 If you prefer a more object-oriented approach (or if you want to support multiple simultaneous connections), you can create a raw `ChefAPI::Connection` object. All of the options that are available on the `ChefAPI` object are also available on a raw connection:
 
 ```ruby

data/chef-api.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/sethvargo/chef-api'
   spec.license       = 'Apache 2.0'
 
-  spec.required_ruby_version = '>= 1.9'
+  spec.required_ruby_version = '>= 2.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/chef-api/authentication.rb

@@ -227,7 +227,7 @@ module ChefAPI
     # @return [String]
     #
     def encrypted_request
-      canonical_key.private_encrypt(canonical_request).chomp
+      canonical_key.private_encrypt(canonical_request)
     end
 
     #

data/lib/chef-api/connection.rb

@@ -98,11 +98,12 @@ module ChefAPI
     # @param path (see Connection#request)
     # @param [Hash] params
     #   the list of query params
+    # @param request_options (see Connection#request)
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def get(path, params = {})
+    def get(path, params = {}, request_options = {})
       request(:get, path, params)
     end
 
@@ -114,11 +115,12 @@ module ChefAPI
     #   the body to use for the request
     # @param [Hash] params
     #   the list of query params
+    # @param request_options (see Connection#request)
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def post(path, data, params = {})
+    def post(path, data, params = {}, request_options = {})
       request(:post, path, data, params)
     end
 
@@ -128,11 +130,12 @@ module ChefAPI
     # @param path (see Connection#request)
     # @param data (see Connection#post)
     # @param params (see Connection#post)
+    # @param request_options (see Connection#request)
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def put(path, data, params = {})
+    def put(path, data, params = {}, request_options = {})
       request(:put, path, data, params)
     end
 
@@ -142,11 +145,12 @@ module ChefAPI
     # @param path (see Connection#request)
     # @param data (see Connection#post)
     # @param params (see Connection#post)
+    # @param request_options (see Connection#request)
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def patch(path, data, params = {})
+    def patch(path, data, params = {}, request_options = {})
       request(:patch, path, data, params)
     end
 
@@ -155,11 +159,12 @@ module ChefAPI
     #
     # @param path (see Connection#request)
     # @param params (see Connection#get)
+    # @param request_options (see Connection#request)
     #
     # @raise (see Connection#request)
     # @return (see Connection#request)
     #
-    def delete(path, params = {})
+    def delete(path, params = {}, request_options = {})
       request(:delete, path, params)
     end
 
@@ -180,11 +185,16 @@ module ChefAPI
     #   the data to use (varies based on the +verb+)
     # @param [Hash] params
     #   the params to use for :patch, :post, :put
+    # @param [Hash] request_options
+    #   the list of options/configurables for the actual request
+    #
+    # @option request_options [true, false] :sign (default: +true+)
+    #   whether to sign the request using mixlib authentication headers
     #
     # @return [String, Hash]
     #   the response body
     #
-    def request(verb, path, data = {}, params = {})
+    def request(verb, path, data = {}, params = {}, request_options = {})
       log.info  "#{verb.to_s.upcase} #{path}..."
       log.debug "Chef flavor: #{flavor.inspect}"
 
@@ -230,7 +240,11 @@ module ChefAPI
       end
 
       # Sign the request
-      add_signing_headers(verb, uri.path, request)
+      if request_options[:sign] == false
+        log.info "Skipping signed header authentication (user requested)..."
+      else
+        add_signing_headers(verb, uri.path, request)
+      end
 
       # Create the HTTP connection object - since the proxy information defaults
       # to +nil+, we can just pass it to the initializer method instead of doing
@@ -256,7 +270,7 @@ module ChefAPI
         unless ssl_verify
           log.warn "Disabling SSL verification..."
           log.warn "Neither ChefAPI nor the maintainers are responsible for " \
-            "damanges incurred as a result of disabling SSL verification. " \
+            "damages incurred as a result of disabling SSL verification. " \
             "Please use this with extreme caution, or consider specifying " \
             "a custom certificate using `config.ssl_pem_file'."
           connection.verify_mode = OpenSSL::SSL::VERIFY_NONE

data/lib/chef-api/defaults.rb

@@ -1,4 +1,5 @@
 require 'chef-api/version'
+require 'json'
 
 module ChefAPI
   module Defaults
@@ -18,6 +19,15 @@ module ChefAPI
         Hash[Configurable.keys.map { |key| [key, send(key)] }]
       end
 
+      #
+      # The Chef API configuration
+      #
+      # @return [Hash]
+      def config
+        path = File.expand_path(ENV['CHEF_API_CONFIG'] || '~/.chef-api')
+        @config ||= File.exist?(path) ? JSON.parse(File.read(path)) : {}
+      end
+
       #
       # The endpoint where the Chef Server lives. This is equivalent to the
       # +chef_server_url+ in Chef terminology. If you are using Enterprise
@@ -35,7 +45,7 @@ module ChefAPI
       # @return [String] (default: +https://api.opscode.com/+)
       #
       def endpoint
-        ENV['CHEF_API_ENDPOINT'] || ENDPOINT
+        ENV['CHEF_API_ENDPOINT'] || config['CHEF_API_ENDPOINT'] || ENDPOINT
       end
 
       #
@@ -52,6 +62,8 @@ module ChefAPI
       def flavor
         if ENV['CHEF_API_FLAVOR']
           ENV['CHEF_API_FLAVOR'].to_sym
+        elsif config['CHEF_API_FLAVOR']
+          config['CHEF_API_FLAVOR']
         else
           endpoint.include?('/organizations') ? :enterprise : :open_source
         end
@@ -63,7 +75,7 @@ module ChefAPI
       # @return [String]
       #
       def user_agent
-        ENV['CHEF_API_USER_AGENT'] || USER_AGENT
+        ENV['CHEF_API_USER_AGENT'] || config['CHEF_API_USER_AGENT'] || USER_AGENT
       end
 
       #
@@ -74,7 +86,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def client
-        ENV['CHEF_API_CLIENT']
+        ENV['CHEF_API_CLIENT'] || config['CHEF_API_CLIENT']
       end
 
       #
@@ -85,7 +97,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def key
-        ENV['CHEF_API_KEY']
+         ENV['CHEF_API_KEY'] || config['CHEF_API_KEY']
       end
       #
       # The HTTP Proxy server address as a string
@@ -93,7 +105,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def proxy_address
-        ENV['CHEF_API_PROXY_ADDRESS']
+        ENV['CHEF_API_PROXY_ADDRESS'] || config['CHEF_API_PROXY_ADDRESS']
       end
 
       #
@@ -102,7 +114,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def proxy_password
-        ENV['CHEF_API_PROXY_PASSWORD']
+        ENV['CHEF_API_PROXY_PASSWORD'] || config['CHEF_API_PROXY_PASSWORD']
       end
 
       #
@@ -111,7 +123,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def proxy_port
-        ENV['CHEF_API_PROXY_PORT']
+        ENV['CHEF_API_PROXY_PORT'] || config['CHEF_API_PROXY_PORT']
       end
 
       #
@@ -120,7 +132,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def proxy_username
-        ENV['CHEF_API_PROXY_USERNAME']
+        ENV['CHEF_API_PROXY_USERNAME'] || config['CHEF_API_PROXY_USERNAME']
       end
 
       #
@@ -129,7 +141,7 @@ module ChefAPI
       # @return [String, nil]
       #
       def ssl_pem_file
-        ENV['CHEF_API_SSL_PEM_FILE']
+        ENV['CHEF_API_SSL_PEM_FILE'] || config['CHEF_API_SSL_PEM_FILE']
       end
 
       #
@@ -138,13 +150,12 @@ module ChefAPI
       # @return [true, false]
       #
       def ssl_verify
-        if ENV['CHEF_API_SSL_VERIFY'].nil?
+        if ENV['CHEF_API_SSL_VERIFY'].nil? && config['CHEF_API_SSL_VERIFY'].nil?
           true
         else
-          %w[t y].include?(ENV['CHEF_API_SSL_VERIFY'].downcase[0])
+          %w[t y].include?(ENV['CHEF_API_SSL_VERIFY'].downcase[0]) || config['CHEF_API_SSL_VERIFY']
         end
       end
-
     end
   end
 end

data/lib/chef-api/resources/base.rb

@@ -927,7 +927,7 @@ module ChefAPI
     #
     # @return [String]
     #
-    def to_json
+    def to_json(*)
       JSON.fast_generate(to_hash)
     end
 

data/lib/chef-api/resources/role.rb

@@ -4,6 +4,7 @@ module ChefAPI
 
     schema do
       attribute :name,                type: String, primary: true, required: true
+      attribute :json_class,          type: String, default: "Chef::Role"
       attribute :description,         type: String
       attribute :default_attributes,  type: Hash,   default: {}
       attribute :override_attributes, type: Hash,   default: {}

data/lib/chef-api/resources/user.rb

@@ -75,7 +75,7 @@ module ChefAPI
       #   the parsed JSON response from the server
       #
       def authenticate(options = {})
-        connection.post('/authenticate_user', options)
+        connection.post('/authenticate_user', options.to_json)
       end
     end
   end

data/lib/chef-api/version.rb

@@ -1,3 +1,3 @@
 module ChefAPI
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/unit/defaults_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module ChefAPI
+  describe Defaults do
+    context 'without a config file' do
+      before(:each) do
+        allow(subject).to receive(:config).and_return(Hash.new)
+      end
+
+      it 'returns the default endpoint' do
+        expect(subject.endpoint).to eq subject::ENDPOINT
+      end
+
+      it 'returns the default user agent' do
+        expect(subject.user_agent).to eq subject::USER_AGENT
+      end
+    end
+
+    context 'with a config file' do
+      before(:each) do
+        subject.instance_variable_set(:@config, nil)
+        allow(File).to receive(:exist?).with(anything()).and_return(true)
+        allow(File).to receive(:read).and_return("{\n"\
+            "\"CHEF_API_ENDPOINT\": \"test_endpoint\",\n" \
+            "\"CHEF_API_USER_AGENT\": \"test_user_agent\"\n" \
+            "}"
+        )
+      end
+
+      it 'returns the overridden value for endpoint' do
+        expect(subject.endpoint).to eq 'test_endpoint'
+      end
+
+      it 'returns the overridden value for user agent' do
+        expect(subject.user_agent).to eq 'test_user_agent'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logify
@@ -98,6 +98,7 @@ files:
 - spec/support/shared/chef_api_resource.rb
 - spec/support/user.pem
 - spec/unit/authentication_spec.rb
+- spec/unit/defaults_spec.rb
 - spec/unit/errors_spec.rb
 - spec/unit/resources/base_spec.rb
 - spec/unit/resources/client_spec.rb
@@ -135,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: A Chef API client in Ruby
@@ -161,6 +162,7 @@ test_files:
 - spec/support/shared/chef_api_resource.rb
 - spec/support/user.pem
 - spec/unit/authentication_spec.rb
+- spec/unit/defaults_spec.rb
 - spec/unit/errors_spec.rb
 - spec/unit/resources/base_spec.rb
 - spec/unit/resources/client_spec.rb