ruby-jss 1.6.4 → 2.0.0b1

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -39,9 +39,10 @@ module JamfRubyExtensions
       ### @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)
+      def j_masked_v4addr(starting,ending)
         IPAddr.new "#{starting}/#{self.j_cidr_from_ends(starting,ending)}"
       end #self.j_masked_v4addr(starting,ending)
+      alias jss_masked_v4addr j_masked_v4addr
 
       ### Given starting and ending IPv4 IP addresses (either Strings or IPAddrs)
       ### return the CIDR notation routing prefix mask
@@ -55,7 +56,7 @@ module JamfRubyExtensions
       ### @example
       ###   IPAddr.j_cidr_from_ends '10.0.0.0', '10.0.0.255' # => 24
       ###
-      def self.j_cidr_from_ends(starting,ending)
+      def j_cidr_from_ends(starting,ending)
 
         starting = IPAddr.new(starting) unless starting.kind_of? IPAddr
         ending = IPAddr.new(ending) unless ending.kind_of? IPAddr
@@ -70,6 +71,7 @@ module JamfRubyExtensions
         return 32 - num_addrs.to_s(2).length + 1
 
       end #self.get_cidr(starting,ending)
+      alias jss_cidr_from_ends j_cidr_from_ends
 
       ### Convert a starting address (either String or IPAddr) and a
       ### CIDR notation routing prefix mask into the IPv4 address
@@ -84,9 +86,10 @@ module JamfRubyExtensions
       ### @example
       ###   IPAddr.j_ending_address '10.0.0.0', 24 # => #<IPAddr: IPv4:10.0.0.255>
       ###
-      def self.j_ending_address(starting, cidr)
+      def j_ending_address(starting, cidr)
         IPAddr.new( "#{starting}/#{cidr}").to_range.max
       end # ending_address
+      alias jss_ending_address j_ending_address
 
     end # module
 

data/lib/jamf/ruby_extensions/ipaddr.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -31,7 +31,7 @@ require 'jamf/ruby_extensions/ipaddr/utils'
 ###
 class IPAddr
 
-  include JamfRubyExtensions::IPAddr::Utils
+  extend JamfRubyExtensions::IPAddr::Utils
 
 
 end # Class IPAddr

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -43,6 +43,8 @@ module JamfRubyExtensions
         [true, false].include? self
       end
       alias j_bool? j_boolean?
+      alias jss_boolean? j_boolean?
+      alias jss_bool? j_boolean?
 
     end # module
 

data/lib/jamf/ruby_extensions/object.rb

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -34,6 +34,7 @@ module JamfRubyExtensions
       def j_real_file?
         FileTest.real_file? self
       end # real_file?
+      alias jss_real_file? j_real_file?
 
       # does a path include another?
       # i.e. is 'other' a descendant of self ?
@@ -42,6 +43,7 @@ module JamfRubyExtensions
         oeps = other.expand_path.to_s
         oeps != eps && oeps.start_with?(eps)
       end
+      alias jss_include? j_include?
 
     end # module
 

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -29,15 +29,17 @@ module JamfRubyExtensions
 
       # Copy a path to a destination
       # @see FileUtils.cp
-      def j_cp(dest, options = {})
-        FileUtils.cp @path, dest.to_s, options
+      def j_cp(dest, **options)
+        FileUtils.cp @path, dest.to_s, **options
       end # cp
+      alias jss_cp j_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
+      def j_cp_r(dest, **options)
+        FileUtils.cp_r @path, dest.to_s, **options
       end # cp
+      alias jss_cp_r j_cp_r
 
       # Write some string content to a file.
       #
@@ -47,6 +49,7 @@ module JamfRubyExtensions
       def j_save(content)
         self.open('w') { |f| f.write content.to_s }
       end
+      alias jss_save j_save
 
       # Append some string content to a file.
       #
@@ -55,6 +58,7 @@ module JamfRubyExtensions
       def j_append(content)
         self.open('a') { |f| f.write content.to_s }
       end
+      alias jss_append j_append
 
       # Touching can sometimes be good
       #
@@ -62,11 +66,13 @@ module JamfRubyExtensions
       def j_touch
         FileUtils.touch @path
       end
+      alias jss_touch j_touch
 
       # Pathname should use FileUtils.chown, not File.chown
       def j_chown(usr, grp)
         FileUtils.chown usr, grp, @path
       end
+      alias jss_chown j_chown
 
     end # module
 

data/lib/jamf/ruby_extensions/pathname.rb

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -41,6 +41,7 @@ module JamfRubyExtensions
         when 'false' then false
         end # case
       end # to bool
+      alias jss_to_bool j_to_bool
 
       # Convert a string to a Jamf::Timestamp object
       #
@@ -50,6 +51,19 @@ module JamfRubyExtensions
         Jamf::Timestamp.new self
       end
 
+      # Convert a string to a Time object
+      #
+      # @see Jamf.parse_time
+      #
+      # @return [Time] the time represented by the string, or nil
+      #
+      def j_to_time
+        Jamf.parse_time self
+      rescue
+        nil
+      end
+      alias jss_to_time j_to_time
+
       # Convert a String to a Pathname object
       #
       # @return [Pathname]
@@ -57,6 +71,7 @@ module JamfRubyExtensions
       def j_to_pathname
         Pathname.new self
       end
+      alias jss_to_pathname j_to_pathname
 
     end # module
 

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -40,6 +40,7 @@ module JamfRubyExtensions
       def j_integer?
         self =~ INTEGER_RE ? true : false
       end
+      alias jss_integer? j_integer?
 
       # Is this string also a floar?
       # (i.e. it consists only of numberic digits)
@@ -49,6 +50,7 @@ module JamfRubyExtensions
       def j_float?
         self =~ FLOAT_RE ? true : false
       end
+      alias jss_float? j_float?
 
     end # module
 

data/lib/jamf/ruby_extensions/string.rb

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,13 +23,11 @@
 
 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/{jss/ruby_extensions/time.rb → jamf/ruby_extensions/time/utils.rb}

@@ -1,30 +1,30 @@
-### Copyright 2020 Pixar
+### Copyright 2022 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 JSS API can take incoming timestamp data in three formats:
+
+### The Classic API can take incoming timestamp data in three formats:
 ### - plain date: YYYY-mm-dd HH:MM:SS, which is assumed to be in the local timezone
 ### - UTC date: YYYY-mm-ddTHH:MM:SS.mmm [+-]zzzz, the local time with milliseconds and the timezone offset
 ### - Unix epoch with milliseconds, nnnnnnnnnnnnn,  which like all epoch times, is UTC
@@ -39,26 +39,41 @@
 ### and the APIObjects in the gem will use the epoch format and the JSS.epoch_to_time method (q.v.) to store
 ### the data as a Ruby Time.
 ###
-class Time
 
-  ### @return [Integer] the milliseconds of the Time
-  def jss_msec
-    (self.usec/1000.0).round
-  end
+module JamfRubyExtensions
 
-  ### @return [Integer] The Time as a unix epoch with milliseconds appended
-  def to_jss_epoch
-    (self.strftime('%s') + self.jss_msec.to_s.ljust(3,'0')).to_i
-  end
+  module Time
 
-  ### @return [String] the Time formatted for a plain JSS XML date element
-  def to_jss_date
-    self.strftime '%Y-%m-%d %H:%M:%S'
-  end
+    module Utils
+
+      ### @return [Integer] the milliseconds of the Time
+      def j_msec
+        strftime('%L').to_i
+      end
+      alias jss_msec j_msec
+
+      ### @return [Integer] The Time as a unix epoch with milliseconds appended
+      def to_j_epoch
+        msec = strftime('%L').rjust(3, "0")
+        epoch = strftime('%s')
+        "#{epoch}#{msec}".to_i
+      end
+      alias to_jss_epoch to_j_epoch
+
+      ### @return [String] the Time formatted for a plain JSS XML date element
+      def to_j_date
+        strftime '%Y-%m-%d %H:%M:%S'
+      end
+      alias to_jss_date to_j_date
+
+      ### @return [String] the Time formatted for a JSS UTC XML date element
+      def to_j_utc
+        strftime("%Y-%m-%dT%H:%M:%S.#{j_msec}%z")
+      end
+      alias to_jss_utc to_j_utc
+
+    end
 
-  ### @return [String] the Time formatted for a JSS UTC XML date element
-  def to_jss_utc
-    self.strftime("%Y-%m-%dT%H:%M:%S.#{self.jss_msec}%z")
   end
 
 end

data/lib/{jss/version.rb → jamf/ruby_extensions/time.rb}

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,10 +23,11 @@
 ###
 ###
 
-###
-module JSS
+require 'jamf/ruby_extensions/time/utils'
+
+# include the modules loaded above
+class Time
 
-  ### The version of ruby-jss
-  VERSION = '1.6.4'.freeze
+  include JamfRubyExtensions::Time::Utils
 
-end # module
+end

data/lib/jamf/ruby_extensions.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -27,11 +27,11 @@
 ### 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'
-require 'jamf/ruby_extensions/dig.rb'
+require 'jamf/ruby_extensions/array'
+require 'jamf/ruby_extensions/filetest'
+require 'jamf/ruby_extensions/hash'
+require 'jamf/ruby_extensions/ipaddr'
+require 'jamf/ruby_extensions/object'
+require 'jamf/ruby_extensions/pathname'
+require 'jamf/ruby_extensions/string'
+require 'jamf/ruby_extensions/time'