ruby-jss 1.2.3 → 1.2.4a1

data/lib/jamf/api/resources/collection_resources/script.rb

@@ -0,0 +1,190 @@
+# 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
+
+  # Classes
+  #####################################
+
+  # A building defined in the JSS
+  class Script < Jamf::CollectionResource
+
+    # Mix-Ins
+    #####################################
+
+    include Jamf::ChangeLog
+    include Jamf::Referable
+
+    # Constants
+    #####################################
+
+    RSRC_PATH = 'scripts'.freeze
+
+    RSRC_VERSION = 'v1'.freeze
+
+    PRIORITY_BEFORE = 'BEFORE'.freeze
+    PRIORITY_AFTER = 'AFTER'.freeze
+    PRIORITY_AT_REBOOT = 'AT_REBOOT'.freeze
+
+    PRIORTIES = [
+      PRIORITY_BEFORE,
+      PRIORITY_AFTER,
+      PRIORITY_AT_REBOOT
+    ].freeze
+
+    # Object Model / Attributes
+    # See APIObject class documentation for details
+    # of how the OBJECT_MODEL hash works.
+    #####################################
+    OBJECT_MODEL = {
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      id: {
+        class: :integer,
+        identifier: :primary,
+        readonly: true
+      },
+
+      # @!attribute name
+      #   @return [String]
+      name: {
+        class: :string,
+        identifier: true
+      },
+
+      # @!attribute info
+      #   @return [String]
+      info: {
+        class: :string
+      },
+
+      # @!attribute notes
+      #   @return [String]
+      notes: {
+        class: :string
+      },
+
+      # @!attribute priority
+      #   @return [String]
+      priority: {
+        class: :string,
+        enum: Jamf::Script::PRIORTIES
+      },
+
+      # TODO: Jamf should standardize object references
+      # this should be a Category::Reference object
+
+      # @!attribute categoryId
+      #   @return [Integer]
+      categoryId: {
+        class: :integer
+      },
+
+      # @!attribute categoryName
+      #   @return [String]
+      categoryName: {
+        class: :string
+      },
+
+      # @!attribute osRequirements
+      #   @return [String]
+      osRequirements: {
+        class: :string
+      },
+
+      # @!attribute scriptContents
+      #   @return [String]
+      scriptContents: {
+        class: :string,
+        validate: :script_contents,
+        aliases: %i[code]
+      },
+
+      # @!attribute parameter4
+      #   @return [String]
+      parameter4: {
+        class: :string
+      },
+
+      # @!attribute parameter5
+      #   @return [String]
+      parameter5: {
+        class: :string
+      },
+
+      # @!attribute parameter6
+      #   @return [String]
+      parameter6: {
+        class: :string
+      },
+
+      # @!attribute parameter7
+      #   @return [String]
+      parameter7: {
+        class: :string
+      },
+
+      # @!attribute parameter8
+      #   @return [String]
+      parameter8: {
+        class: :string
+      },
+
+      # @!attribute parameter9
+      #   @return [String]
+      parameter9: {
+        class: :string
+      },
+
+      # @!attribute parameter10
+      #   @return [String]
+      parameter10: {
+        class: :string
+      },
+
+      # @!attribute parameter11
+      #   @return [String]
+      parameter11: {
+        class: :string
+      }
+    }.freeze
+
+    parse_object_model
+
+
+    # Class Methods
+    ##################################
+
+    def self.scriptContents(scr_ident, cnx: Jamf.cnx)
+      id = valid_id scr_ident
+      raise Jamf::NoSuchItemError, "No script matches '#{scr_ident}'" unless id
+      cnx.download "#{RSRC_VERSION}/#{RSRC_PATH}/#{id}/download"
+    end
+
+  end # class
+
+end # module

data/lib/jamf/api/resources/collection_resources/site.rb

@@ -0,0 +1,77 @@
+# 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
+
+  # Classes
+  #####################################
+
+  # A building defined in the JSS
+  class Site < Jamf::CollectionResource
+
+    # Mix-Ins
+    #####################################
+
+    include Jamf::ChangeLog
+    include Jamf::Referable
+
+    # Constants
+    #####################################
+
+    RSRC_PATH = 'settings/sites'.freeze
+
+    NO_SITE_ID = -1
+
+    NO_SITE_NAME = 'None'.freeze
+
+    # Object Model / Attributes
+    # See APIObject class documentation for details
+    # of how the OBJECT_MODEL hash works.
+    #####################################
+    OBJECT_MODEL = {
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      id: {
+        class: :integer,
+        identifier: :primary,
+        readonly: true
+      },
+
+      # @!attribute name
+      #   @return [String]
+      name: {
+        class: :string,
+        identifier: true,
+        validator: :non_empty_string,
+        required: true
+      }
+    }.freeze
+    parse_object_model
+
+  end # class
+
+end # module

data/lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb

@@ -0,0 +1,131 @@
+# 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 Jamf
+
+  # The API endpoint for country codes.
+  #
+  # Probably more useful is the Jamf.app_store_country_codes method
+  # which parses this into a hash of Code => Name
+  #
+  class AppStoreCountryCodes < Jamf::SingletonResource
+
+    extend Jamf::Immutable
+
+    # Constants
+    #####################################
+
+    RSRC_VERSION = 'v1'.freeze
+
+    RSRC_PATH = 'app-store-country-codes'.freeze
+
+    OBJECT_MODEL = {
+
+      # @!attribute checkInFrequency
+      #   @return [integer]
+      countryCodes: {
+        class: Jamf::Country,
+        multi: true,
+        read_only: true
+      }
+
+    }.freeze # end OBJECT_MODEL
+
+    parse_object_model
+
+    # Class Methods
+    #####################################
+
+    # Class level wrapper for #names
+    def self.names(refresh = false, cnx: Jamf.cnx)
+      fetch(refresh, cnx: cnx).names
+    end
+
+    # Class level wrapper for #codes
+    def self.codes(refresh = false, cnx: Jamf.cnx)
+      fetch(refresh, cnx: cnx).codes
+    end
+
+    # Class level wrapper for #codes_by_name
+    def self.codes_by_name(refresh = false, cnx: Jamf.cnx)
+      fetch(refresh, cnx: cnx).codes_by_name
+    end
+
+    # Class level wrapper for #names_by_code
+    def self.names_by_code(refresh = false, cnx: Jamf.cnx)
+      fetch(refresh, cnx: cnx).names_by_code
+    end
+
+    # Class level wrapper for #code_for_name
+    def self.code_for_name(name, refresh = false, cnx: Jamf.cnx)
+      fetch(refresh, cnx: cnx).code_for_name name
+    end
+
+    # Class level wrapper for #name_for_code
+    def self.name_for_code(code, refresh = false, cnx: Jamf.cnx)
+      fetch(refresh, cnx: cnx).name_for_code code
+    end
+
+    # Instance Methods
+    #####################################
+
+    # @return [Array<String>] the available country names
+    def names
+      @names ||= countryCodes.map{ |country| country.name }
+    end
+
+    # @return [Array<String>] the available country codes
+    def codes
+      @codes ||= countryCodes.map{ |country| country.code }
+    end
+
+    # @return [Hash] name => code
+    def codes_by_name
+      @codes_by_name ||= countryCodes.map{ |country| [country.name, country.code] }.to_h
+    end
+
+    # @return [Hash] code => name
+    def names_by_code
+      @names_by_code ||= countryCodes.map{ |country| [country.code, country.name] }.to_h
+    end
+
+    # return a country code from its name, case-insensitive
+    # @param name[String] the name of a country
+    # @return [String]
+    def code_for_name(name)
+      name = names.select { |n| n.casecmp? name }.first
+      codes_by_name[name]
+    end
+
+    # return a country name from its code, case-insensitive
+    # @param name[String] the name of a country
+    # @return [String]
+    def name_for_code(code)
+      names_by_code[code.upcase]
+    end
+
+  end # class AppStoreCountryCodes
+
+end # module JAMF

data/lib/jamf/api/resources/singleton_resources/authorization.rb

@@ -0,0 +1,88 @@
+# 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 Jamf
+
+  # Authorization Details associated with the current API token
+  #
+  class Authorization < Jamf::SingletonResource
+
+    # Constants
+    #####################################
+
+    RSRC_PATH = 'auth'.freeze
+
+    AUTH_TYPE_JSS = 'JSS'.freeze
+    AUTH_TYPE_LDAP = 'LDAP'.freeze
+    AUTH_TYPE_SAML = 'SAML'.freeze
+    AUTH_TYPE_INVITE = 'INVITE'.freeze
+    AUTH_TYPE_OAUTH = 'OAUTH'.freeze
+
+    AUTH_TYPES = [
+      AUTH_TYPE_JSS,
+      AUTH_TYPE_LDAP,
+      AUTH_TYPE_SAML,
+      AUTH_TYPE_INVITE,
+      AUTH_TYPE_OAUTH
+    ].freeze
+
+    OBJECT_MODEL = {
+
+      # @!attribute account
+      #   @return [Jamf::Account]
+      account: {
+        class: Jamf::Account,
+        readonly: true
+      },
+
+      # @!attribute accountGroups
+      #   @return [Array<Jamf::AccountGroup>]
+      accountGroups: {
+        class: Jamf::AccountGroup,
+        multi: true,
+        readonly: true
+      },
+
+      # @!attribute sites
+      #   @return [Array<amf::Site>]
+      sites: {
+        class: Jamf::Site,
+        multi: true,
+        readonly: true
+      },
+
+      # @!attribute authenticationType
+      #   @return [String]
+      authenticationType: {
+        class: :string,
+        enum: Jamf::Authorization::AUTH_TYPES
+      }
+
+    }.freeze # end OBJECT_MODEL
+    parse_object_model
+
+  end # class ReEnrollment
+
+end # module JAMF