ruby-jss 1.2.3 → 1.2.4a1

data/lib/jamf/exceptions.rb

@@ -0,0 +1,107 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+#
+
+# The Module
+module Jamf
+
+  # Exceptions
+  #####################################
+
+  # MissingDataError - raise this error when we
+  # are missing args, or other simliar stuff.
+  #
+  class MissingDataError < RuntimeError; end
+
+  # InvalidDataError - raise this error when
+  # a data item isn't what we expected.
+  #
+  class InvalidDataError < RuntimeError; end
+
+  # InvalidConnectionError - raise this error when we
+  # don't have a usable connection to a network service, or
+  # don't have proper authentication/authorization.
+  #
+  class InvalidConnectionError < RuntimeError; end
+
+  # NoSuchItemError - raise this error when
+  # a desired item doesn't exist.
+  #
+  class NoSuchItemError < RuntimeError; end
+
+  # AlreadyExistsError - raise this error when
+  # trying to create something that already exists.
+  #
+  class AlreadyExistsError < RuntimeError; end
+
+  # FileServiceError - raise this error when
+  # there's a problem accessing file service on a
+  # distribution point.
+  #
+  class FileServiceError < RuntimeError; end
+
+  # UnmanagedError - raise this when we
+  # try to do something managerial to
+  # an unmanaged object
+  #
+  class UnmanagedError < RuntimeError; end
+
+  # UnsupportedError - raise this when we
+  # try to do something not yet supported
+  #
+  class UnsupportedError < RuntimeError; end
+
+  # TimeoutError - raise this when we
+  # try to do something and it times out
+  #
+  class TimeoutError < RuntimeError; end
+
+  # AuthenticationError - raise this when
+  # a name/pw are wrong
+  #
+  class AuthenticationError < RuntimeError; end
+
+  # ConflictError - raise this when
+  # attempts to PUT or PUSH to the API
+  # result in a 409 Conflict http error.
+  # See {Jamf::APIConnection#raise_conflict_error}
+  #
+  class ConflictError < RuntimeError; end
+
+  # BadRequestError - raise this when
+  # attempts to PUT or PUSH or DELETE to the API
+  # result in a 400 Bad Request http error.
+  # See {Jamf::APIConnection.raise_bad_request_error}
+  #
+  class BadRequestError < RuntimeError; end
+
+  # APIRequestError - raise this when
+  # attempts API actions generate an error not dealt with
+  # by ConflictError or BadRequestError
+  # result in a 400 Bad Request http error.
+  # See {Jamf::APIConnection.raise_api_error}
+  #
+  class APIRequestError < RuntimeError; end
+
+end # module JAMF

data/lib/jamf/ruby_extensions.rb

@@ -0,0 +1,36 @@
+### Copyright 2019 Pixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+### All monkey-patched convenience methods are either prefixed with "jss_"  or
+### if they are type coercions, "to_jss_"
+###
+
+require 'jamf/ruby_extensions/filetest.rb'
+require 'jamf/ruby_extensions/hash.rb'
+require 'jamf/ruby_extensions/ipaddr.rb'
+require 'jamf/ruby_extensions/object.rb'
+require 'jamf/ruby_extensions/pathname.rb'
+require 'jamf/ruby_extensions/string.rb'
+require 'jamf/ruby_extensions/array.rb'

data/lib/jamf/ruby_extensions/array.rb

@@ -0,0 +1,35 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+#
+
+require 'jamf/ruby_extensions/array/predicates'
+require 'jamf/ruby_extensions/array/utils'
+
+#
+class Array
+
+  include JamfRubyExtensions::Array::Predicates
+  include JamfRubyExtensions::Array::Utils
+
+end # class

data/lib/jamf/ruby_extensions/array/predicates.rb

@@ -0,0 +1,46 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+#
+
+module JamfRubyExtensions
+
+  module Array
+
+    module Predicates
+
+      # A case-insensitive version of #include? for Arrays of Strings.
+      #
+      # @param somestring [String] the String to search for
+      #
+      # @return [Boolean] Does the Array contain the String, ignoring case?
+      #
+      def j_ci_include_string?(somestring)
+        any? { |s| s.to_s.casecmp? somestring }
+      end
+
+    end # module
+
+  end # module
+
+end # module

data/lib/jamf/ruby_extensions/array/utils.rb

@@ -0,0 +1,47 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+
+module JamfRubyExtensions
+
+  module Array
+
+    module Utils
+
+        # Fetch a string from an Array of Strings case-insensitively,
+        # e.g. my_array.j_ci_fetch_string('ThRashEer') will return 'thrasher'
+        # or nil if no match
+        #
+        # @param somestring [String] the String to search for
+        #
+        # @return [String, nil] The matching string as it exists in the Array, nil if it doesn't exist
+        #
+        def j_ci_fetch_string(somestring)
+          idx = index { |s| s.to_s.casecmp? somestring }
+          idx ? self[idx] : nil
+        end
+
+    end # module
+
+  end # module
+
+end # module

data/lib/jamf/ruby_extensions/filetest.rb

@@ -0,0 +1,32 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+#
+
+require 'jamf/ruby_extensions/filetest/predicates'
+
+module FileTest
+
+  extend JamfRubyExtensions::FileTest::Predicates
+
+end # module FileTest

data/lib/jamf/ruby_extensions/filetest/predicates.rb

@@ -0,0 +1,46 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+#
+
+module JamfRubyExtensions
+
+  module FileTest
+
+    module Predicates
+
+      # FileTest.file? returns true if
+      # the item is a symlink pointing to a regular file.
+      #
+      # This test, real_file?, returns true if the item is
+      # a regular file but NOT a symlink.
+      #
+      def j_real_file?(path)
+        FileTest.file?(path) && !FileTest.symlink?(path)
+      end # real_file?
+
+    end # module
+
+  end # module
+
+end # module

data/lib/jamf/ruby_extensions/hash.rb

@@ -0,0 +1,33 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+#
+
+require 'jamf/ruby_extensions/hash/backports'
+
+# include the modules loaded above
+class Hash
+
+  include JamfRubyExtensions::Hash::BackPorts
+
+end

data/lib/jamf/ruby_extensions/hash/backports.rb

@@ -0,0 +1,92 @@
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+#
+# Copyright 2019 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+
+module JamfRubyExtensions
+
+  module Hash
+
+    module BackPorts
+
+      empty_hash = {}
+
+      # Ruby 2.5 + has transform_keys
+      unless empty_hash.respond_to? :transform_keys
+        def transform_keys(&block)
+          nh = {}
+          each do |k, v|
+            nk = yield k
+            nh[nk] = v
+          end
+          nh
+        end
+
+        def transform_keys!(&block)
+          replace transform_keys(&block)
+        end
+      end # unless
+
+      # Ruby 2.4 + has transform_values
+      unless empty_hash.respond_to? :transform_values
+        def transform_values(&block)
+          nh = {}
+          each do |k, v|
+            nv = yield v
+            nh[k] = nv
+          end
+          nh
+        end
+
+        def transform_values!(&block)
+          replace transform_values(&block)
+        end
+      end # unless
+
+    end # module
+
+  end # module
+
+end # module