ruby-jss 1.2.3 → 1.2.4a1

data/lib/jamf/ruby_extensions/ipaddr.rb

@@ -0,0 +1,37 @@
+### 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/ipaddr/utils'
+
+
+############################################
+### A few augmentations to IPAddr handling.
+###
+class IPAddr
+
+  include JamfRubyExtensions::IPAddr::Utils
+
+
+end # Class IPAddr

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

@@ -0,0 +1,95 @@
+# 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 IPAddr
+
+    module Utils
+
+      ### Convert starting and ending IPv4 IP addresses (either Strings or IPAddrs)
+      ### into a single masked IPv4 IPAddr
+      ###
+      ### @param starting[Strings, IPAddr] the starting IP address
+      ###
+      ### @param ending[Strings, IPAddr] the ending IP address
+      ###
+      ### @return [IPAddr] the IP address range represented as a masked IPv4 address
+      ###
+      ### @example
+      ###   IPAddr.j_masked_v4addr '10.0.0.0', '10.0.0.255' # => #<IPAddr: IPv4:10.0.0.0/255.255.255.0>
+      ###
+      def self.j_masked_v4addr(starting,ending)
+        IPAddr.new "#{starting}/#{self.j_cidr_from_ends(starting,ending)}"
+      end #self.j_masked_v4addr(starting,ending)
+
+      ### Given starting and ending IPv4 IP addresses (either Strings or IPAddrs)
+      ### return the CIDR notation routing prefix mask
+      ###
+      ### @param starting[Strings, IPAddr] the starting IP address
+      ###
+      ### @param ending[Strings, IPAddr] the ending IP address
+      ###
+      ### @return [FixNum] the CIDR notation routing prefix mask
+      ###
+      ### @example
+      ###   IPAddr.j_cidr_from_ends '10.0.0.0', '10.0.0.255' # => 24
+      ###
+      def self.j_cidr_from_ends(starting,ending)
+
+        starting = IPAddr.new(starting) unless starting.kind_of? IPAddr
+        ending = IPAddr.new(ending) unless ending.kind_of? IPAddr
+
+        ### how many possible addresses in the range?
+        num_addrs =  ending.to_i - starting.to_i + 1
+
+        ### convert the number of possible addresses to
+        ### binary then subtract the number of bits from
+        ### the full length of an IPv4 addr
+        ### (32 bits) and that gives the CIDR prefix
+        return 32 - num_addrs.to_s(2).length + 1
+
+      end #self.get_cidr(starting,ending)
+
+      ### Convert a starting address (either String or IPAddr) and a
+      ### CIDR notation routing prefix mask into the IPv4 address
+      ### of at the end of the range of addresses.
+      ###
+      ### @param starting[Strings, IPAddr] the starting IP address
+      ###
+      ### @param cidr[FixNum] the CIDR mask
+      ###
+      ### @return [IPAddr] the ending IP address of the range.
+      ###
+      ### @example
+      ###   IPAddr.j_ending_address '10.0.0.0', 24 # => #<IPAddr: IPv4:10.0.0.255>
+      ###
+      def self.j_ending_address(starting, cidr)
+        IPAddr.new( "#{starting}/#{cidr}").to_range.max
+      end # ending_address
+
+    end # module
+
+  end # module
+
+end # module

data/lib/jamf/ruby_extensions/object.rb

@@ -0,0 +1,30 @@
+# 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/object/predicates'
+
+# include the modules loaded above
+class Object
+
+  include JamfRubyExtensions::Object::Predicates
+
+end

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

@@ -0,0 +1,51 @@
+# 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 Object
+
+    module Predicates
+
+      # is an object an explict true or false?
+      #
+      # TODO: globally replace
+      #      `JSS::TRUE_FALSE.include? xxx`
+      #   with
+      #      `xxx.j_boolean?`
+      #
+      #
+      # @return [Boolean]
+      #
+      def j_boolean?
+        [true, false].include? self
+      end
+      alias j_bool? j_boolean?
+
+    end # module
+
+  end # module
+
+end # module

data/lib/jamf/ruby_extensions/pathname.rb

@@ -0,0 +1,39 @@
+# 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.
+#
+#
+
+############################################
+# Some handy additions to the Pathname class.
+# Why aren't they there already?
+
+require 'jamf/ruby_extensions/pathname/utils'
+require 'jamf/ruby_extensions/pathname/predicates'
+
+# include the modules loaded above
+class Pathname
+
+  include JamfRubyExtensions::Pathname::Predicates
+  include JamfRubyExtensions::Pathname::Utils
+
+end

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

@@ -0,0 +1,50 @@
+# 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 Pathname
+
+    module Predicates
+
+      # Is this a real file rather than a symlink?
+      # @see FileTest.real_file
+      def j_real_file?
+        FileTest.real_file? self
+      end # real_file?
+
+      # does a path include another?
+      # i.e. is 'other' a descendant of self ?
+      def j_include?(other)
+        eps = expand_path.to_s
+        oeps = other.expand_path.to_s
+        oeps != eps && oeps.start_with?(eps)
+      end
+
+    end # module
+
+  end # module
+
+end # module

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

@@ -0,0 +1,75 @@
+# 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 Pathname
+
+    module Utils
+
+      # Copy a path to a destination
+      # @see FileUtils.cp
+      def j_cp(dest, options = {})
+        FileUtils.cp @path, dest.to_s, options
+      end # cp
+
+      # Recursively copy this path to a destination
+      # @see FileUtils.cp_r
+      def j_cp_r(dest, options = {})
+        FileUtils.cp_r @path, dest.to_s, options
+      end # cp
+
+      # Write some string content to a file.
+      #
+      # Simpler than always using an open('w') block
+      # *CAUTION* this overwrites files!
+      #
+      def j_save(content)
+        self.open('w') { |f| f.write content.to_s }
+      end
+
+      # Append some string content to a file.
+      #
+      # Simpler than always using an open('a') block
+      #
+      def j_append(content)
+        self.open('a') { |f| f.write content.to_s }
+      end
+
+      # Touching can sometimes be good
+      #
+      # @see FileUtils.touch
+      def j_touch
+        FileUtils.touch @path
+      end
+
+      # Pathname should use FileUtils.chown, not File.chown
+      def j_chown(usr, grp)
+        FileUtils.chown usr, grp, @path
+      end
+
+    end # module
+
+  end # module
+
+end # module

data/lib/jamf/ruby_extensions/string.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/string/conversions'
+require 'jamf/ruby_extensions/string/predicates'
+require 'jamf/ruby_extensions/string/backports'
+
+# include the modules loaded above
+class String
+
+  include JamfRubyExtensions::String::Predicates
+  include JamfRubyExtensions::String::Conversions
+  include JamfRubyExtensions::String::BackPorts
+
+end

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

@@ -0,0 +1,66 @@
+# 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 String
+
+    module BackPorts
+
+      # Ruby 2.5 + has these handy delete_* methods
+      unless Jamf::BLANK.respond_to? :delete_prefix
+
+        def delete_prefix(pfx)
+          sub /\A#{pfx}/, Jamf::BLANK
+        end
+
+        def delete_prefix!(pfx)
+          sub! /\A#{pfx}/, Jamf::BLANK
+        end
+
+        def delete_suffix(sfx)
+          sub /#{sfx}\z/, Jamf::BLANK
+        end
+
+        def delete_suffix!(sfx)
+          sub! /#{sfx}\z/, Jamf::BLANK
+        end
+
+      end # unless
+
+      # String#casecmp? - its in Ruby 2.4+
+      unless Jamf::BLANK.respond_to? :casecmp?
+
+        def casecmp?(other)
+          return nil unless other.is_a? String
+
+          casecmp(other).zero?
+        end
+
+      end # unless
+
+    end # module
+
+  end # module
+
+end # module