knife-opc 0.4.1 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 873c3bbd2e19b0f9d16f0cf3f0e40c9d1a00835b7a95c5fb43b0545855ab8cc9
-  data.tar.gz: 6afadda7acf3cff454c379f7430d967423eaaf77a599bf9db3c92db3d6a25994
+  metadata.gz: 1ab5d18c861be31be68d9f618c1aacf63b984cbd92880bba749013bcdfb8f4f6
+  data.tar.gz: 2f06594a523aee643a27caec8eeec29afb6c237b3021a1ec55cc8033e8887778
 SHA512:
-  metadata.gz: 78e053766a19dd42555c568a3a86d10f89662ed4a3beef4cd0dad6717959bf8de00ece54270d551faa4a80e7dd10a2e17876ff52f0cf5b9a57272d2425b4b35a
-  data.tar.gz: 1f6f0af328eb5d8f9e90c53effce7cfc68f7cbb7256282d51ceecfab564e5adb32c36510bb46d0407ff8c1b5d889500f0f7622f531dbe54e922ca9002ea115ad
+  metadata.gz: c9404db55e036c8bd2a869c3c65c542f97d0736784ad02546c7e19349421f9a497ae0422189057dad0f1f73f1e2f4e3252bfba4721c8698c308fa1f673bfc077
+  data.tar.gz: 327dd1ad9b5efd280aaf54546944bf48f41d455365e258813e72acf505099a0138ab7e45a006b551b518781fff5ef22b40f79a6bad80eb6ddf90f5bac4a45b74

data/lib/chef/knife/opc_org_create.rb

@@ -22,20 +22,20 @@ module Opc
     banner "knife opc org create ORG_SHORT_NAME ORG_FULL_NAME (options)"
 
     option :filename,
-    long: "--filename FILENAME",
-    short: "-f FILENAME",
-    description: "Write validator private key to FILENAME rather than STDOUT"
+      long: "--filename FILENAME",
+      short: "-f FILENAME",
+      description: "Write validator private key to FILENAME rather than STDOUT"
 
     option :association_user,
-    long: "--association_user USERNAME",
-    short: "-a USERNAME",
-    description: "Invite USERNAME to the new organization after creation"
+      long: "--association_user USERNAME",
+      short: "-a USERNAME",
+      description: "Invite USERNAME to the new organization after creation"
 
     attr_accessor :org_name, :org_full_name
 
     deps do
-      require "chef/org"
-      require "chef/org/group_operations"
+      require_relative "../org"
+      require_relative "../org/group_operations"
     end
 
     def run

data/lib/chef/knife/opc_org_delete.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcOrgDelete < Chef::Knife

data/lib/chef/knife/opc_org_edit.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcOrgEdit < Chef::Knife

data/lib/chef/knife/opc_org_list.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcOrgList < Chef::Knife
@@ -23,14 +23,14 @@ module Opc
     banner "knife opc org list"
 
     option :with_uri,
-    long: "--with-uri",
-    short: "-w",
-    description: "Show corresponding URIs"
+      long: "--with-uri",
+      short: "-w",
+      description: "Show corresponding URIs"
 
     option :all_orgs,
-    long: "--all-orgs",
-    short: "-a",
-    description: "Show auto-generated hidden orgs in output"
+      long: "--all-orgs",
+      short: "-a",
+      description: "Show auto-generated hidden orgs in output"
 
     include Chef::Mixin::RootRestv0
 

data/lib/chef/knife/opc_org_show.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcOrgShow < Chef::Knife

data/lib/chef/knife/opc_org_user_add.rb

@@ -23,13 +23,13 @@ module Opc
     attr_accessor :org_name, :username
 
     option :admin,
-    long: "--admin",
-    short: "-a",
-    description: "Add user to admin group"
+      long: "--admin",
+      short: "-a",
+      description: "Add user to admin group"
 
     deps do
-      require "chef/org"
-      require "chef/org/group_operations"
+      require_relative "../org"
+      require_relative "../org/group_operations"
     end
 
     def run

data/lib/chef/knife/opc_org_user_remove.rb

@@ -23,13 +23,13 @@ module Opc
     attr_accessor :org_name, :username
 
     option :force_remove_from_admins,
-    long: "--force",
-    short: "-f",
-    description: "Force removal of user from the organization's admins and billing-admins group."
+      long: "--force",
+      short: "-f",
+      description: "Force removal of user from the organization's admins and billing-admins group."
 
     deps do
-      require "chef/org"
-      require "chef/org/group_operations"
+      require_relative "../org"
+      require_relative "../org/group_operations"
       require "chef/json_compat"
     end
 
@@ -51,7 +51,7 @@ module Opc
             You ran with --force which force removes the user from the admins and billing-admins groups.
             However, removing #{username} from the admins group would leave it empty, which breaks the org.
             Please add another user to org #{org_name} admins group and try again.
-EOF
+          EOF
           exit 1
         end
         remove_user_from_admin_group(org, org_name, username, "admins")
@@ -71,7 +71,7 @@ EOF
             ui.msg <<~EOF
               User #{username} is in the organization's admin group. Removing users from an organization without removing them from the admins group is not allowed.
               Re-run this command with --force to remove this user from the admins prior to removing it from the organization.
-EOF
+            EOF
             exit 1
           else
             raise e
@@ -93,7 +93,7 @@ EOF
         ui.warn <<~EOF
           User #{username} is not in the #{admin_group_string} group for organization #{org_name}.
           You probably don't need to pass --force.
-EOF
+        EOF
       else
         raise e
       end

data/lib/chef/knife/opc_user_create.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcUserCreate < Chef::Knife
@@ -23,19 +23,19 @@ module Opc
     banner "knife opc user create USERNAME FIRST_NAME [MIDDLE_NAME] LAST_NAME EMAIL PASSWORD"
 
     option :filename,
-    long: "--filename FILENAME",
-    short: "-f FILENAME",
-    description: "Write private key to FILENAME rather than STDOUT"
+      long: "--filename FILENAME",
+      short: "-f FILENAME",
+      description: "Write private key to FILENAME rather than STDOUT"
 
     option :orgname,
-    long: "--orgname ORGNAME",
-    short: "-o ORGNAME",
-    description: "Associate new user to an organization matching ORGNAME"
+      long: "--orgname ORGNAME",
+      short: "-o ORGNAME",
+      description: "Associate new user to an organization matching ORGNAME"
 
     option :passwordprompt,
-    long: "--prompt-for-password",
-    short: "-p",
-    description: "Prompt for user password"
+      long: "--prompt-for-password",
+      short: "-p",
+      description: "Prompt for user password"
 
     include Chef::Mixin::RootRestv0
 
@@ -69,7 +69,7 @@ module Opc
         password: password,
       }
 
-     # Check the file before creating the user so the api is more transactional.
+      # Check the file before creating the user so the api is more transactional.
       if config[:filename]
         file = config[:filename]
         unless File.exist?(file) ? File.writable?(file) : File.writable?(File.dirname(file))
@@ -95,7 +95,7 @@ module Opc
     end
 
     def prompt_for_password
-      ui.ask("Please enter the user's password: ") { |q| q.echo = false }
+      ui.ask("Please enter the user's password: ", echo: false)
     end
   end
 end

data/lib/chef/knife/opc_user_delete.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcUserDelete < Chef::Knife
@@ -36,8 +36,8 @@ module Opc
     include Chef::Mixin::RootRestv0
 
     deps do
-      require "chef/org"
-      require "chef/org/group_operations"
+      require_relative "../org"
+      require_relative "../org/group_operations"
     end
 
     def run
@@ -117,7 +117,7 @@ module Opc
         Run this command again with the --remove-from-admin-groups option to
         remove the user from these admin group(s) automatically.
 
-EOM
+      EOM
       ui.fatal message
       exit 1
     end
@@ -128,7 +128,7 @@ EOM
         #{username} is the only member of the 'admins' group of the
         following organization(s):
 
-EOM
+      EOM
       only_admin_of.each { |org| message << "- #{org.name}\n" }
       message << <<~EOM
 
@@ -136,7 +136,7 @@ EOM
         Assign additional users or groups to the admin group(s) before
         deleting this user.
 
-EOM
+      EOM
       ui.fatal message
       exit 1
     end

data/lib/chef/knife/opc_user_edit.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcUserEdit < Chef::Knife
@@ -23,14 +23,14 @@ module Opc
     banner "knife opc user edit USERNAME"
 
     option :input,
-    long: "--input FILENAME",
-    short: "-i FILENAME",
-    description: "Name of file to use for PUT or POST"
+      long: "--input FILENAME",
+      short: "-i FILENAME",
+      description: "Name of file to use for PUT or POST"
 
     option :filename,
-    long: "--filename FILENAME",
-    short: "-f FILENAME",
-    description: "Write private key to FILENAME rather than STDOUT"
+      long: "--filename FILENAME",
+      short: "-f FILENAME",
+      description: "Write private key to FILENAME rather than STDOUT"
 
     include Chef::Mixin::RootRestv0
 
@@ -44,15 +44,11 @@ module Opc
       end
 
       original_user = root_rest.get("users/#{user_name}")
-      if config[:input]
-        edited_user = JSON.parse(IO.read(config[:input]))
-      else
-        edited_user = edit_data(original_user)
-      end
+      edited_user = get_updated_user(original_user)
       if original_user != edited_user
         result = root_rest.put("users/#{user_name}", edited_user)
         ui.msg("Saved #{user_name}.")
-        if ! result["private_key"].nil?
+        unless result["private_key"].nil?
           if config[:filename]
             File.open(config[:filename], "w") do |f|
               f.print(result["private_key"])
@@ -65,5 +61,34 @@ module Opc
         ui.msg("User unchanged, not saving.")
       end
     end
+
+    private
+
+    # Check the options for ex: input or filename
+    # Read Or Open file to update user information
+    # return updated user
+    def get_updated_user(original_user)
+      if config[:input]
+        edited_user = JSON.parse(IO.read(config[:input]))
+      elsif config[:filename]
+        file = config[:filename]
+        unless File.exist?(file) ? File.writable?(file) : File.writable?(File.dirname(file))
+          ui.fatal "File #{file} is not writable.  Check permissions."
+          exit 1
+        else
+          output = Chef::JSONCompat.to_json_pretty(original_user)
+          File.open(file, "w") do |f|
+            f.sync = true
+            f.puts output
+            f.close
+            raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details." unless system("#{config[:editor]} #{f.path}")
+
+            edited_user = JSON.parse(IO.read(f.path))
+          end
+        end
+      else
+        edited_user = JSON.parse(edit_data(original_user, false))
+      end
+    end
   end
 end

data/lib/chef/knife/opc_user_list.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcUserList < Chef::Knife
@@ -23,15 +23,25 @@ module Opc
     banner "knife opc user list"
 
     option :with_uri,
-    long: "--with-uri",
-    short: "-w",
-    description: "Show corresponding URIs"
+      long: "--with-uri",
+      short: "-w",
+      description: "Show corresponding URIs"
+
+    option :all_info,
+      long: "--all-info",
+      short: "-a",
+      description: "Show corresponding details i.e. username, email, first_name, last_name, display_name"
 
     include Chef::Mixin::RootRestv0
 
     def run
-      results = root_rest.get("users")
-      ui.output(ui.format_list_for_display(results))
+      if config[:all_info]
+        results = root_rest.get("users?verbose=true")
+        ui.output results
+      else
+        results = root_rest.get("users")
+        ui.output(ui.format_list_for_display(results))
+      end
     end
   end
 end

data/lib/chef/knife/opc_user_password.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcUserPassword < Chef::Knife
@@ -23,9 +23,9 @@ module Opc
     banner "knife opc user password USERNAME [PASSWORD | --enable-external-auth]"
 
     option :enable_external_auth,
-    long: "--enable-external-auth",
-    short: "-e",
-    description: "Enable external authentication for this user (such as LDAP)"
+      long: "--enable-external-auth",
+      short: "-e",
+      description: "Enable external authentication for this user (such as LDAP)"
 
     include Chef::Mixin::RootRestv0
 
@@ -34,7 +34,7 @@ module Opc
       # USERNAME PASSWORD or USERNAME --enable-external-auth
       #
       # note that you can't pass USERNAME PASSWORD --enable-external-auth
-      if !((@name_args.length == 2 && !config[:enable_external_auth]) || (@name_args.length == 1 && config[:enable_external_auth]))
+      unless (@name_args.length == 2 && !config[:enable_external_auth]) || (@name_args.length == 1 && config[:enable_external_auth])
         show_usage
         ui.fatal("You must pass two arguments")
         ui.fatal("Note that --enable-external-auth cannot be passed with a password")
@@ -52,7 +52,7 @@ module Opc
       # changing anything before we PUT.
       user = root_rest.get("users/#{user_name}")
 
-      user["password"] = password if not password.nil?
+      user["password"] = password unless password.nil?
 
       # if --enable-external-auth was passed, enable it, else disable it.
       # there is never a situation where we would want to enable ldap

data/lib/chef/knife/opc_user_show.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef/mixin/root_rest"
+require_relative "../mixin/root_rest"
 
 module Opc
   class OpcUserShow < Chef::Knife
@@ -23,8 +23,8 @@ module Opc
     banner "knife opc user show USERNAME"
 
     option :with_orgs,
-    long: "--with-orgs",
-    short: "-l"
+      long: "--with-orgs",
+      short: "-l"
 
     include Chef::Mixin::RootRestv0
 

data/lib/chef/org/group_operations.rb

@@ -1,4 +1,4 @@
-require "chef/org"
+require_relative "../org"
 
 class Chef
   class Org

data/lib/chef/org.rb

@@ -1,7 +1,7 @@
 require "chef/json_compat"
 require "chef/mixin/params_validate"
 require "chef/server_api"
-require "chef/org/group_operations"
+require_relative "org/group_operations"
 
 class Chef
   class Org
@@ -24,22 +24,22 @@ class Chef
 
     def name(arg = nil)
       set_or_return(:name, arg,
-                    regex: /^[a-z0-9\-_]+$/)
+        regex: /^[a-z0-9\-_]+$/)
     end
 
     def full_name(arg = nil)
       set_or_return(:full_name,
-                    arg, kind_of: String)
+        arg, kind_of: String)
     end
 
     def private_key(arg = nil)
       set_or_return(:private_key,
-                    arg, kind_of: String)
+        arg, kind_of: String)
     end
 
     def guid(arg = nil)
       set_or_return(:guid,
-                    arg, kind_of: String)
+        arg, kind_of: String)
     end
 
     def to_hash

data/lib/knife-opc/version.rb

@@ -1,3 +1,3 @@
 module KnifeOPC
-  VERSION = "0.4.1".freeze
+  VERSION = "0.4.8".freeze
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: knife-opc
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.8
 platform: ruby
 authors:
 - Steven Danna
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-20 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies: []
-description: Knife Tools for Chef Server
+description: Knife Tools for Chef Infra Server
 email: steve@chef.io
 executables: []
 extensions: []
@@ -34,11 +34,11 @@ files:
 - lib/chef/org.rb
 - lib/chef/org/group_operations.rb
 - lib/knife-opc/version.rb
-homepage: https://github.com/knife-opc
+homepage: https://github.com/chef/knife-opc
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,9 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
-summary: Knife Tools for Chef Server
+summary: Knife Tools for Chef Infra Server
 test_files: []