ruby-jss 1.6.4 → 2.0.0b1

data/lib/jss/ruby_extensions/ipaddr.rb

@@ -1,92 +0,0 @@
-### Copyright 2020 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.
-###
-###
-
-############################################
-### A few augmentations to IPAddr handling.
-###
-class IPAddr
-
-  ### 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.jss_masked_v4addr '10.0.0.0', '10.0.0.255' # => #<IPAddr: IPv4:10.0.0.0/255.255.255.0>
-  ###
-  def self.jss_masked_v4addr(starting,ending)
-    IPAddr.new "#{starting}/#{self.jss_cidr_from_ends(starting,ending)}"
-  end #self.jss_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.jss_cidr_from_ends '10.0.0.0', '10.0.0.255' # => 24
-  ###
-  def self.jss_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.jss_ending_address '10.0.0.0', 24 # => #<IPAddr: IPv4:10.0.0.255>
-  ###
-  def self.jss_ending_address(starting, cidr)
-    IPAddr.new( "#{starting}/#{cidr}").to_range.max
-  end # ending_address
-
-end # Class IPAddr

data/lib/jss/ruby_extensions/object.rb

@@ -1,19 +0,0 @@
-# Extensions to Ruby Objects for use within the JSS module
-class Object
-
-  # is an object an explict true or false?
-  #
-  # TODO: globally replace
-  #      `JSS::TRUE_FALSE.include? xxx`
-  #   with
-  #      `xxx.jss_boolean?`
-  #
-  #
-  # @return [Boolean]
-  #
-  def jss_boolean?
-    [true, false].include? self
-  end
-  alias jss_bool? jss_boolean?
-
-end

data/lib/jss/ruby_extensions/pathname.rb

@@ -1,78 +0,0 @@
-### Copyright 2020 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?
-###
-class Pathname
-  
-  ### Is this a real file rather than a symlink?
-  ### @see FileTest.real_file
-  def jss_real_file?
-    FileTest.jss_real_file? self 
-  end # real_file?
-  
-  ### Copy a path to a destination
-  ### @see FileUtils.cp
-  def jss_cp(dest, options = {})
-    FileUtils.cp @path, dest.to_s, options
-  end # cp
-  
-  ### Recursively copy this path to a destination
-  ### @see FileUtils.cp_r
-  def jss_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 jss_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 jss_append(content)
-    self.open('a'){|f| f.write content.to_s}
-  end
-
-  ### Touching can be good 
-  ###
-  ### @see FileUtils.touch
-  def jss_touch
-    FileUtils.touch @path
-  end
-  
-  ### Pathname should use FileUtils.chown, not File.chown
-  def jss_chown(u,g)
-    FileUtils.chown u, g, @path
-  end
-end # class Pathname

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

@@ -1,68 +0,0 @@
-# Copyright 2020 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 JSSRubyExtensions
-
-  module String
-
-    module BackPorts
-
-      BLANK = ''.freeze
-
-      # Ruby 2.5 + has these handy delete_* methods
-      unless BLANK.respond_to? :delete_prefix
-
-        def delete_prefix(pfx)
-          sub /\A#{pfx}/, BLANK
-        end
-
-        def delete_prefix!(pfx)
-          sub! /\A#{pfx}/, BLANK
-        end
-
-        def delete_suffix(sfx)
-          sub /#{sfx}\z/, BLANK
-        end
-
-        def delete_suffix!(sfx)
-          sub! /#{sfx}\z/, BLANK
-        end
-
-      end # unless
-
-      # String#casecmp? - its in Ruby 2.4+
-      unless 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

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

@@ -1,69 +0,0 @@
-# Copyright 2020 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 JSSRubyExtensions
-
-  module String
-
-    module Conversions
-
-      # Convert the strings "true" and "false"
-      # (after stripping whitespace and downcasing)
-      # to TrueClass and FalseClass respectively
-      #
-      # Return nil if any other string.
-      #
-      # @return [Boolean,nil] the boolean value
-      #
-      def jss_to_bool
-        case strip.downcase
-        when 'true' then true
-        when 'false' then false
-        end # case
-      end # to bool
-
-      # Convert a string to a Time object
-      #
-      # returns nil if not parsable by JSS::parse_datetime
-      #
-      # @return [Time] the time represented by the string.
-      #
-      def jss_to_time
-        JSS.parse_time self
-      rescue
-        nil
-      end
-
-      # Convert a String to a Pathname object
-      #
-      # @return [Pathname]
-      #
-      def jss_to_pathname
-        Pathname.new self
-      end
-
-    end # module
-
-  end # module
-
-end # module

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

@@ -1,57 +0,0 @@
-# Copyright 2020 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 JSSRubyExtensions
-
-  module String
-
-    module Predicates
-
-      INTEGER_RE = /\A-?[0-9]+\Z/.freeze
-      FLOAT_RE = /\A-?[0-9]+\.[0-9]+\Z/.freeze
-
-      # Is this string also an integer?
-      # (i.e. it consists only of numberic digits, maybe with a dash in front)
-      #
-      # @return [Boolean]
-      #
-      def jss_integer?
-        self =~ INTEGER_RE ? true : false
-      end
-
-      # Is this string also a floar?
-      # (i.e. it consists only of numberic digits)
-      #
-      # @return [Boolean]
-      #
-      def jss_float?
-        self =~ FLOAT_RE ? true : false
-      end
-
-    end # module
-
-  end # module
-
-end # module

data/lib/jss/server.rb

@@ -1,146 +0,0 @@
-### Copyright 2020 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 JSS
-
-  # A class representing the currently-connected JSS Server in a
-  # JSS::APIConnection instance.
-  #
-  # The {JSS::APIConnection} instance has a JSS::Server instance in its #server
-  # attribute. It is created fresh every time {APIConnection#connect} is called.
-  #
-  # That's the only time it should be instantiated, and all access should be
-  # through the #server attribute of the APIConnection instance.
-  #
-  class Server
-
-    # Constants
-    #####################################
-    ACTIVATION_CODE_RSRC = 'activationcode'.freeze
-    ACTIVATION_CODE_KEY = :activation_code
-
-
-    # Attributes
-    #####################################
-
-    # @return [String] the type of server licence
-    attr_reader :license_type
-
-    # @return [String] the license product name
-    attr_reader :product
-
-    #  @return [String] The version of the JSS. See the method JSS.parse_jss_version
-    attr_reader :version
-
-    #  @return [Integer]
-    attr_reader :major_version
-
-    #  @return [Integer]
-    attr_reader :minor_version
-
-    #  @return [Integer]
-    attr_reader :revision_version
-
-    #  @return [String]
-    attr_reader :raw_version
-
-    # @return [JSS::APIConnection] The APIConnection object that contains this
-    #   instance of Server
-    attr_reader :api
-
-    # Instance Methods
-    #####################################
-
-    # Initialize!
-    # THe jss_data to be passed in is the JSON output of the 'jssuser' resource
-    # on the API server.
-    # the jssuser resource is readable by anyone with a JSS acct
-    # regardless of their permissions.
-    # However, it's marked as 'deprecated'. Hopefully jamf will
-    # keep this basic level of info available for basic authentication
-    # and JSS version checking.
-    #
-    # The 'api' is a reference to the JSS::APIConnection instance
-    # which this JSS::Server instance is a part of.
-    #
-    def initialize(jss_data, api)
-      @api = api
-      @license_type = jss_data[:license_type]
-      @product = jss_data[:product]
-      @raw_version = jss_data[:version]
-      parsed = JSS.parse_jss_version(@raw_version)
-      @major_version = parsed[:major]
-      @minor_version = parsed[:minor]
-      @revision_version = parsed[:revision]
-      @version = parsed[:version]
-    end
-
-    # @return [String] the organization to which the server is licensed
-    def organization
-      @act_code_data ||= @api.get_rsrc(ACTIVATION_CODE_RSRC)[ACTIVATION_CODE_KEY]
-      @act_code_data[:organization_name]
-    end
-
-    # @return [String] the activation code for the server licence
-    def activation_code
-      @act_code_data ||= @api.get_rsrc(ACTIVATION_CODE_RSRC)[ACTIVATION_CODE_KEY]
-      @act_code_data[:code]
-    end
-
-    # Update the activation code and organization name for this server
-    #
-    # @param org: [String] the organization to which the server is licensed
-    # @param code: [String ]  the activation code for the server licence
-    #
-    # @return [void]
-    def update_activation_code(org:, code:)
-      xml = REXML::Document.new JSS::APIConnection::XML_HEADER
-      acode = xml.add_element ACTIVATION_CODE_KEY.to_s
-      acode.add_element('organization_name').text = org
-      acode.add_element('code').text = code
-
-      @api.put_rsrc ACTIVATION_CODE_RSRC, xml.to_s
-    end
-
-    # Remove the api object from
-    # the instance_variables used to create
-    # pretty-print (pp) output.
-    #
-    # @return [Array] the desired instance_variables
-    #
-    def pretty_print_instance_variables
-      vars = instance_variables.sort
-      vars.delete :@api
-      vars
-    end
-
-    ##### Aliases
-    alias institution organization
-    alias product_name product
-
-  end # class server
-
-end # module