jss-api 0.6.1 → 0.6.2

data/lib/jss-api/api_object/self_servable.rb

@@ -1,355 +0,0 @@
-### Copyright 2016 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
-
-  #####################################
-  ### Module Variables
-  #####################################
-
-  #####################################
-  ### Module Methods
-  #####################################
-
-  #####################################
-  ### Sub-Modules
-  #####################################
-
-  ### A mix-in module for handling Self Service data for objects in the JSS.
-  ###
-  ### The JSS objects that have Self Service data return it in a :self_service subset,
-  ### which all have similar data, a hash with at least these keys:
-  ### - :self_service_description 
-  ### - :self_service_icon 
-  ###
-  ### Most also have:
-  ### - :feature_on_main_page
-  ### - :self_service_categories
-  ###
-  ### iOS Profiles in self service have this key: 
-  ### - :security 
-  ###
-  ### Additionally, items that apper in OS X SlfSvc have these keys:
-  ### - :install_button_text
-  ### - :force_users_to_view_description 
-  ###
-  ### See the attribute definitions for details of these values and structures.
-  ###
-  ### Including this module in an {APIObject} subclass and calling {#parse_self_service} in the
-  ### subclass's constructor will give it matching attributes with 'self_service_'
-  ### appended if needed, e.g. {#self_service_feature_on_main_page}
-  ###
-  ### If the subclass is creatable or updatable, calling {#self_service_xml} returns
-  ### a REXML element representing the Self Service subset, to be included with the
-  ### #rest_xml output of the subclass.
-  ###
-  ### Classes including this module *must*:
-  ###
-  ### - Define the constant SELF_SERVICE_TARGET which contains either :osx or :ios
-  ### - Define the constant SELF_SERVICE_PAYLOAD which contains one of :policy, :profile, or :app
-  ### - Call {#parse_self_service} in the subclass's constructor after calling super
-  ### - Include the result of {#self_service_xml} in their #rest_xml output
-  ### - Define the method #in_self_service? which returns a Boolean indicating that the item is 
-  ###   available in self service. Different API objects indicate this in different ways.
-  ### - Define the method #user_removable? which returns Boolean indicating that the item (a profile)
-  ###   can be removed by the user in SSvc. OS X profiles store this in the :user_removable key of the
-  ###   :general subset as a boolean, whereas iOS profiles stor it in :security as one of 3 strings
-  ###
-  ###
-  ### Notes: 
-  ### - Self service icons cannot be modified via this code. Use the Web UI.
-  ### - There an API bug in handling categories, and all but the last one are ommitted. Until this is fixed, categories
-  ###   cannot be saved via this code since that would cause data-loss when more than one category is applied.
-  ###
-  module SelfServable
-
-    #####################################
-    ###  Constants
-    #####################################
-
-    SELF_SERVABLE = true
-    
-    IOS_PROFILE_REMOVAL_OPTIONS = ["Always", "With Authorization", "Never"]
-    
-    #####################################
-    ###  Variables
-    #####################################
-    
-    
-    #####################################
-    ###  Attribtues
-    #####################################
-
-    
-    ### @return [String] The verbage that appears in SelfSvc for this item
-    attr_reader :self_service_description
-
-    ### @return [Hash] The icon that appears in SelfSvc for this item
-    ###
-    ### The Hash contains these keys with info about the icon:
-    ### - :filename  => [String] The name of the image file uploaded to the JSS
-    ### - :uri => [String] the URI for retriving the icon
-    ### - :id => [Integer] the JSS id number for the icon (not all SSvc items have this)
-    ### - :data => [String] the icon image encoded as Base64 (not all SSvc items have this)
-    ###
-    attr_reader :self_service_icon
-
-    ### @return [Boolean] Should this item feature on the main page of SSvc?
-    attr_reader :self_service_feature_on_main_page
-
-    ### @return [Array<Hash>] The categories in which this item should appear in SSvc
-    ###
-    ### Each Hash has these keys about the category
-    ### - :id => [Integer] the JSS id of the category
-    ### - :name => [String] the name of the category
-    ### - :display_in => [Boolean] should the item be displayed in this category in SSvc? (OSX SSvc only)
-    ### - :feature_in => [Boolean] should the item be featured in this category in SSVC? (OSX SSvc only)
-    ###
-    ### NOTE: as of Casper 9.61 there's a bug in the JSON output from the API, and only the last 
-    ### category is returned, if more than one are set.
-    ###
-    attr_reader :self_service_categories
-
-    ### @return [Hash] The security settings for iOS profiles in SSvc
-    ###
-    ### The keys are
-    ### - :removal_disallowed => [String] one of the items in IOS_PROFILE_REMOVAL_OPTIONS
-    ### - :password => [String] if :removal_disallowed is "With Authorization", this contains the passwd (in plaintext)
-    ###   needed to remove the profile.
-    ###
-    ### NOTE that the key should be called :removal_allowed, since 'Never' means it can't be removed.
-    ###
-    attr_reader :self_service_security
-
-    ### @return [String] The text label on the install button in SSvc (OSX SSvc only)
-    attr_reader :self_service_install_button_text
-    
-    ### @return [Boolean] Should an extra window appear before the user can install the item? (OSX SSvc only)
-    attr_reader :self_service_force_users_to_view_description
-
-
-    #####################################
-    ###  Mixed-in Instance Methods
-    #####################################
-
-    ###
-    ### Call this during initialization of
-    ### objects that have a self_service subset
-    ### and the self_service attributes will be populated
-    ### (as primary attributes) from @init_data
-    ###
-    ### @return [void]
-    ###
-    def parse_self_service
-      @init_data[:self_service] ||= {}
-      ss_data = @init_data[:self_service]
-      
-      @self_service_description = ss_data[:self_service_description]
-      @self_service_icon = ss_data[:self_service_icon]
-      
-      @self_service_feature_on_main_page = ss_data[:feature_on_main_page]
-      
-      # TEMPORARY - until JAMF fixes the category data in JSON
-      @self_service_categories = [
-        ss_data[:self_service_categories][:category]
-      ]
-      
-      # make this an empty hash if needed
-      @self_service_security = ss_data[:security] || {}
-      
-      # if this is an osx profile, set @self_service_security[:removal_disallowed] to "Always" or "Never" 
-      # to indicate the boolean :user_removable
-      if @init_data[:general].keys.include? :user_removable
-        @self_service_security[:removal_disallowed] = @init_data[:general][:user_removable] ? "Always" : "Never"
-      end
-      
-      @self_service_install_button_text = ss_data[:install_button_text]
-      @self_service_force_users_to_view_description = ss_data[:force_users_to_view_description]
-
-    end
-
-    
-    ###
-    ###
-    ### Setters
-    ###
-
-    ###
-    ### @param new_val[String] the new discription
-    ###
-    ### @return [void]
-    ###
-    def self_service_description= (new_val)
-      return nil if @self_service_description == new_val
-      @self_service_description = new_val.strip!
-      @need_to_update = true
-    end
-
-    ###
-    ### @param new_val[String] the new install button text
-    ###
-    ### @return [void]
-    ###
-    def self_service_install_button_text= (new_val)
-      return nil if @self_service_install_button_text == new_val
-      raise JSS::InvalidDataError, "Only OS X Self Service Items can have custom button text" unless self.class::SELF_SERVICE_TARGET == :osx
-      @self_service_install_button_text = new_val.strip
-      @need_to_update = true
-    end
-    
-    ###
-    ### @param new_val[Boolean] should this appear on the main SelfSvc page? 
-    ###
-    ### @return [void]
-    ###
-    def self_service_feature_on_main_page= (new_val)
-      return nil if @self_service_feature_on_main_page == new_val
-      raise JSS::InvalidDataError, "New value must be true or false" unless JSS::TRUE_FALSE.include? new_val
-      @self_service_feature_on_main_page = new_val
-      @need_to_update = true
-    end
-    
-    ###
-    ### @param new_val[Boolean] should this appear on the main SelfSvc page? 
-    ###
-    ### @return [void]
-    ###
-    def self_service_force_users_to_view_description= (new_val)
-      return nil if @self_service_force_users_to_view_description == new_val
-      raise JSS::InvalidDataError, "Only OS X Self Service Items can force users to view description" unless self.class::SELF_SERVICE_TARGET == :osx
-      raise JSS::InvalidDataError, "New value must be true or false" unless JSS::TRUE_FALSE.include? new_val
-      @self_service_force_users_to_view_description = new_val
-      @need_to_update = true
-    end
-    
-    ###
-    ### Add or change one of the categories for this item in SSvc.
-    ###
-    ### @param new_cat[String] the name of a category for this item in SelfSvc
-    ###
-    ### @param display_in[Boolean] should this item appear in the SelfSvc page for the new category?
-    ###
-    ### @param feature_in[Boolean] should this item be featured in the SelfSvc page for the new category?
-    ###
-    ### @return [void]
-    ###
-    def add_self_service_category (new_cat, display_in = true, feature_in = false)
-      new_cat.strip!
-      raise JSS::NoSuchItemError, "No category '#{new_cat}' in the JSS" unless JSS::Category.all_names(:refresh).include? new_cat
-      raise JSS::InvalidDataError, "display_in must be true or false" unless JSS::TRUE_FALSE.include? display_in
-      raise JSS::InvalidDataError, "feature_in must be true or false" unless JSS::TRUE_FALSE.include? feature_in
-      
-      new_data = {:name => new_cat, :display_in => display_in, :feature_in => feature_in }
-      
-      # see if this category is already among our categories.
-      idx = @self_service_categories.index{|c| c[new_cat]}
-      
-      if idx 
-        @self_service_categories[idx] = new_data
-      else
-        @self_service_categories << new_data
-      end
-      
-      @need_to_update = true
-    end
-    
-    ###
-    ### Remove a category from those for this item in SSvc
-    ###
-    ### @param cat[String] the name of the category to remove
-    ###
-    ### @return [void]
-    ###
-    def remove_self_service_category= (cat)
-      return nil unless @self_service_categories.map{|c| c[:name]}.include? cat
-      @self_service_categories.reject!{|c| c[:name]}
-      @need_to_update = true
-    end
-
-    ###
-    ### Set whether or when the user can remove a profile installed with SSvc
-    ###
-    ### @param new_val[String] one of the values in PROFILE_REMOVAL_OPTIONS, or true or false
-    ###
-    ### @return [void]
-    ###
-    def profile_can_be_removed (new_val)
-      
-      new_val = "Always" if new_val === true 
-      new_val = "Never" if new_val === false
-      
-      return nil if new_val == @self_service_security[:removal_disallowed]
-      raise JSS::InvalidDataError, "" unless IOS_PROFILE_REMOVAL_OPTIONS.include? new_val
-      
-      @self_service_security[:removal_disallowed] = new_val
-    end
-    
-    
-    ###
-    ### @api private
-    ###
-    ### Return a REXML <location> element to be
-    ### included in the rest_xml of
-    ### objects that have a Location subset
-    ###
-    ### @return [REXML::Element]
-    ###
-    def self_service_xml
-      
-      ssvc = REXML::Element.new('self_service')
-      
-      return ssvc unless self.in_self_service?
-      
-      ssvc.add_element('self_service_description').text = @self_service_description
-      ssvc.add_element('feature_on_main_page').text = @self_service_feature_on_main_page
-      
-      ### TEMPORARY - re-enable this when the category bug is fixed.
-      
-#       cats = ssvc.add_element('self_service_categories')
-#       @self_service_categories.each do |cat|
-#         catelem = cats.add_element('category')
-#         catelem.add_element('name').text = cat[:name]
-#         catelem.add_element('display_in').text = cat[:display_in] if cat.keys.include? :display_in
-#         catelem.add_element('feature_in').text = cat[:feature_in] if cat.keys.include? :feature_in
-#       end
-      
-      unless @self_service_security.empty?
-        sec = ssvc.add_element('security')
-        sec.add_element('removal_disallowed').text = @self_service_security[:removal_disallowed] if @self_service_security[:removal_disallowed]
-        sec.add_element('password').text = @self_service_security[:password] if @self_service_security[:password]
-      end
-      
-      ssvc.add_element('install_button_text').text = @self_service_install_button_text if @self_service_install_button_text
-      ssvc.add_element('force_users_to_view_description').text = @self_service_force_users_to_view_description unless @self_service_force_users_to_view_description.nil?
-
-      return ssvc
-    end
-    
-    ### aliases
-    alias change_self_service_category add_self_service_category
-    
-  end # module SelfServable
-
-end # module JSS

data/lib/jss-api/api_object/site.rb

@@ -1,93 +0,0 @@
-### Copyright 2016 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
-  
-  #####################################
-  ### Module Variables
-  #####################################
-
-  #####################################
-  ### Module Methods
-  #####################################
-
-  
-  #####################################
-  ### Classes
-  #####################################
-
-  ### 
-  ### A Site in the JSS.
-  ###
-  ### These are simple, in that they only have an ID and a name.
-  ###
-  ### @see JSS::APIObject
-  ### 
-  class Site < JSS::APIObject
-    
-    #####################################
-    ### Mix-Ins
-    #####################################
-    include JSS::Creatable
-    include JSS::Updatable
-    
-    #####################################
-    ### Class Methods
-    #####################################
-         
-    #####################################
-    ### Class Constants
-    #####################################
-    
-    ### The base for REST resources of this class
-    RSRC_BASE = "sites"
-    
-    ### the hash key used for the JSON list output of all objects in the JSS
-    RSRC_LIST_KEY = :sites
-    
-    ### The hash key used for the JSON object output.
-    ### It's also used in various error messages
-    RSRC_OBJECT_KEY = :site
-    
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = []
-    
-    #####################################
-    ### Attributes
-    #####################################
-    
-    #####################################
-    ### Constructor 
-    #####################################
-    
-
-    #####################################
-    ### Public Instance Methods
-    #####################################
-    
-    
-  end # class site
-  
-end # module

data/lib/jss-api/api_object/software_update_server.rb

@@ -1,109 +0,0 @@
-### Copyright 2016 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
-
-  #####################################
-  ### Module Variables
-  #####################################
-
-  #####################################
-  ### Module Methods
-  #####################################
-
-  #####################################
-  ### Classes
-  #####################################
-
-  ###
-  ### A Software Update Server in the JSS
-  ###
-  ### Only minimally implemented, for access to the APIObject list methods
-  ###
-  ### @see JSS::APIObject
-  ###
-  class SoftwareUpdateServer < JSS::APIObject
-
-    #####################################
-    ### Mix-Ins
-    #####################################
-
-    #####################################
-    ### Class Methods
-    #####################################
-
-    #####################################
-    ### Class Constants
-    #####################################
-
-    ### The base for REST resources of this class
-    RSRC_BASE = "softwareupdateservers"
-
-    ### the hash key used for the JSON list output of all objects in the JSS
-    RSRC_LIST_KEY = :software_update_servers
-
-    ### The hash key used for the JSON object output.
-    ### It's also used in various error messages
-    RSRC_OBJECT_KEY = :software_update_server
-
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:set_system_wide, :port]
-
-    #####################################
-    ### Attributes
-    #####################################
-
-    ### @return [String]
-    attr_reader :ip_address
-
-    ### @return [Integer]
-    attr_reader :port
-
-    ### @return [Boolean]
-    attr_reader :set_system_wide
-
-
-    #####################################
-    ### Constructor
-    #####################################
-
-    ###
-    ### @see SS::APIObject#initialize
-    ###
-    def initialize (args = {})
-      super
-      @ip_address = @init_data[:ip_address]
-      @port = @init_data[:port]
-      @set_system_wide = @init_data[:set_system_wide]
-    end
-
-    #####################################
-    ### Public Instance Methods
-    #####################################
-
-
-  end # class NetbootServer
-
-end # module