ruby-jss 0.9.2 → 0.10.0a1

data/lib/jss/api_object/criteriable/criteria.rb

@@ -1,26 +1,26 @@
 ### Copyright 2017 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.
-### 
+###
 ###
 
 ###
@@ -94,7 +94,7 @@ module JSS
       ### @return [void]
       ###
       def criteria= (new_criteria)
-        unless new_criteria.kind_of? Array and  new_criteria.reject{|c| c.kind_of? JSS::Criteriable::Criterion }.empty?
+        unless new_criteria.kind_of? Array && new_criteria.reject{|c| c.is_a? JSS::Criteriable::Criterion }.empty?
           raise JSS::InvalidDataError, "Argument must be an Array of JSS::Criteriable::Criterion instances."
         end
         new_criteria.each{ |nc| criterion_ok? nc }
@@ -140,7 +140,7 @@ module JSS
       ###
       ### @return [void]
       ###
-      def insert_criterion(priority,criterion)
+      def insert_criterion(priority, criterion)
         criterion_ok? criterion
         @criteria.insert criterion[:priority], criterion
         set_priorities

data/lib/jss/api_object/distribution_point.rb

@@ -26,22 +26,11 @@
 ###
 module JSS
 
-  #####################################
-  ### Module Variables
-  #####################################
-
-  ### the master dist. point, see JSS.master_distribution_point
-  @@master_distribution_point = nil
-
-  ### the dist point for this machine right now
-  @@my_distribution_point =nil
-
   #####################################
   ### Module Methods
   #####################################
 
 
-
   ###
   ### A Distribution Point in the JSS
   ###
@@ -96,15 +85,6 @@ module JSS
 
     DEFAULT_MOUNTPOINT_PREFIX = "CasperDistribution-id"
 
-    #####################################
-    ### Class Variables
-    #####################################
-
-    @@master_distribution_point = nil
-
-    @@my_distribution_point = nil
-
-    #####################################
     ### Class Methods
     #####################################
 
@@ -112,21 +92,14 @@ module JSS
     ### distribution point in the JSS. If there's only one
     ### in the JSS, return it even if not marked as master.
     ###
+    ### @param refresh[Boolean] should the distribution point be re-queried?
+    ###
+    ### @param api[JSS::APIConnection] which API connection should we query?
+    ###
     ### @return [JSS::DistributionPoint]
     ###
-    def self.master_distribution_point(refresh = false)
-      @@master_distribution_point = nil if refresh
-      return @@master_distribution_point if @@master_distribution_point
-
-      case self.all.count
-        when 0
-          raise JSS::NoSuchItemError, "No distribution points defined"
-        when 1
-          @@master_distribution_point = self.new :id => self.all_ids[0]
-        else
-          @@master_distribution_point = self.new :id => :master
-        end
-        @@master_distribution_point
+    def self.master_distribution_point(refresh = false, api: JSS.api)
+      api.master_distribution_point refresh
     end
 
     ### Get the DistributionPoint instance for the machine running
@@ -135,20 +108,12 @@ module JSS
     ###
     ### @param refresh[Boolean] should the distribution point be re-queried?
     ###
+    ### @param api[JSS::APIConnection] which API connection should we query?
+    ###
     ### @return [JSS::DistributionPoint]
     ###
-    def self.my_distribution_point(refresh = false)
-      @@my_distribution_point = nil if refresh
-      return @@my_distribution_point if @@my_distribution_point
-
-      my_net_seg = JSS::NetworkSegment.my_network_segment[0]
-      specific = if my_net_seg
-        JSS::NetworkSegment.new(:id => my_net_seg).distribution_point
-      else
-        nil
-      end
-      @@my_distribution_point = specific ? self.new(:name => specific) : self.master_distribution_point
-      @@my_distribution_point
+    def self.my_distribution_point(refresh = false, api: JSS.api)
+      api.my_distribution_point refresh
     end
 
     #####################################
@@ -242,7 +207,6 @@ module JSS
     ### @return [String] the ssh password as a SHA256 digest
     attr_reader :ssh_password_sha256
 
-    ###
     ### As well as the standard :id, :name, and :data, you can
     ### instantiate this class with :id => :master, in which case you'll
     ### get the Master Distribution Point as defined in the JSS.
@@ -251,14 +215,16 @@ module JSS
     ### You can also do this more easily by calling JSS.master_distribution_point
     ###
     def initialize(args = {})
+      args[:api] ||= JSS.api
+      @api = args[:api]
 
       @init_data = nil
 
       ### looking for master?
       if args[:id] == :master
 
-        self.class.all_ids.each do |id|
-          @init_data  = JSS.api_connection.get_rsrc("#{RSRC_BASE}/id/#{id}")[RSRC_OBJECT_KEY]
+        self.class.all_ids(api: @api).each do |id|
+          @init_data  = @api.get_rsrc("#{RSRC_BASE}/id/#{id}")[RSRC_OBJECT_KEY]
           if @init_data[:is_master]
             @id = @init_data[:id]
             @name = @init_data[:name]

data/lib/jss/api_object/extension_attribute.rb

@@ -201,15 +201,15 @@ module JSS
     ### @see JSS::APIObject#delete
     ###
     def delete
-      orig_open_timeout = JSS.api_connection.cnx.options[:open_timeout]
-      orig_timeout = JSS.api_connection.cnx.options[:timeout]
-      JSS.api_connection.timeout = orig_timeout + 1800
-      JSS.api_connection.open_timeout = orig_open_timeout + 1800
+      orig_open_timeout = @api.cnx.options[:open_timeout]
+      orig_timeout = @api.cnx.options[:timeout]
+      @api.timeout = orig_timeout + 1800
+      @api.open_timeout = orig_open_timeout + 1800
       begin
         super
       ensure
-        JSS.api_connection.timeout = orig_timeout
-        JSS.api_connection.open_timeout = orig_open_timeout
+        @api.timeout = orig_timeout
+        @api.open_timeout = orig_open_timeout
       end
     end
 
@@ -333,7 +333,7 @@ module JSS
       begin
 
         search_class = self.class::TARGET_CLASS::SEARCH_CLASS
-        acs = search_class.new :id => :new, :name => "JSSgem-EA-#{Time.now.to_jss_epoch}-result-search"
+        acs = search_class.new api: @api, :id => :new, :name => "ruby-jss-EA-result-search-#{Time.now.to_jss_epoch}"
         acs.display_fields = [@name]
         crit_list = [JSS::Criteriable::Criterion.new(:and_or => "and", :name => @name, :search_type => search_type.to_s, :value => desired_value)]
         acs.criteria = JSS::Criteriable::Criteria.new crit_list
@@ -387,11 +387,11 @@ module JSS
     ###
     def latest_values
       raise JSS::NoSuchItemError, "EA Not In JSS! Use #create to create this #{self.class::RSRC_OBJECT_KEY}." unless @in_jss
-      tmp_advsrch = "JSSgem-EA-#{Time.now.to_jss_epoch}-latest-search"
+      tmp_advsrch = "ruby-jss-EA-latest-search-#{Time.now.to_jss_epoch}"
 
       begin
         search_class = self.class::TARGET_CLASS::SEARCH_CLASS
-        acs = search_class.new :id => :new, :name => tmp_advsrch
+        acs = search_class.new id: :new, name: tmp_advsrch, api: @api
         acs.display_fields = self.class::TARGET_CLASS == JSS::User ?  [@name, USERNAME_FIELD] : [@name, USERNAME_FIELD, LAST_RECON_FIELD]
 
         # search for 'Username like "" ' because all searchable object classes have a "Username" value
@@ -415,8 +415,11 @@ module JSS
         end #acs.search_results.each
 
       ensure
-        acs.delete
-        self.class::TARGET_CLASS::SEARCH_CLASS.new(:name => tmp_advsrch).delete if self.class::TARGET_CLASS::SEARCH_CLASS.all_names(:refresh).include? tmp_advsrch
+        if defined? acs
+          acs.delete
+        else
+          search_class.fetch(:name => tmp_advsrch, api: @api).delete if search_class.all_names(:refresh, api: @api).include? tmp_advsrch
+        end
       end
 
       results

data/lib/jss/api_object/extension_attribute/computer_extension_attribute.rb

@@ -1,26 +1,26 @@
 ### Copyright 2017 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.
-### 
+###
 ###
 
 ###
@@ -81,10 +81,10 @@ module JSS
 
     ### these ext attribs are related to these kinds of objects
     TARGET_CLASS = JSS::Computer
-    
+
     ### A criterion that will return all members of the TARGET_CLASS
     ALL_TARGETS_CRITERION = JSS::Criteriable::Criterion.new(:and_or => "and", :name => "Username", :search_type => "like", :value => '')
-    
+
     ### When the intput type is script, what platforms can they run on?
     PLATFORMS = ["Mac","Windows"]
 
@@ -111,12 +111,12 @@ module JSS
     ### scripts defined when the type is "script",
     ### however the API will only return the Mac script info if both are defined.
     ###
-    ### @return [String] 
+    ### @return [String]
     attr_reader :platform
 
     ### @return [String] the script code that will be executed when the @input_type is "script",
     attr_reader :script
-    
+
 
     ### The scripting language of the @script when @input_type is "script",
     ### and the @platform is "Windows"
@@ -246,7 +246,7 @@ module JSS
       @script = new_val
       @need_to_update = true
     end #
-    
+
 
     ###
     ### Change the scripting_language of this EA.
@@ -288,12 +288,12 @@ module JSS
       raise JSS::InvalidConnectionError, "Database connection required for 'history' query." unless JSS::DB_CNX.connected?
 
       computer_id = case computer
-        when *JSS::Computer.all_ids
+        when *JSS::Computer.all_ids(api: @api)
           computer
-        when *JSS::Computer.all_names
-          JSS::Computer.map_all_ids_to(:name).invert[computer]
+        when *JSS::Computer.all_names(api: @api)
+          JSS::Computer.map_all_ids_to(:name, api: @api).invert[computer]
         else nil
-      end # case
+        end # case
 
       raise JSS::NoSuchItemError, "No computer found matching '#{computer}'" unless computer_id
 
@@ -323,12 +323,12 @@ module JSS
 
       history
     end # history
-    
-    
+
+
     ### Aliases here, since YARD seems to have issues with them above
     alias code script
     alias code= script=
-    
+
     ######################
     ### Private Instance Methods
     #####################

data/lib/jss/api_object/group.rb

@@ -88,16 +88,16 @@ module JSS
     ### Returns an Array of all the smart
     ### groups.
     ###
-    def self.all_smart(refresh = false)
-      self.all(refresh).select{|g| g[:is_smart] }
+    def self.all_smart(refresh = false, api: JSS.api)
+      all(refresh, api: api).select{|g| g[:is_smart] }
     end
 
     ###
     ### Returns an Array of all the static
     ### groups.
     ###
-    def self.all_static(refresh = false)
-      self.all(refresh).select{|g| not g[:is_smart] }
+    def self.all_static(refresh = false, api: JSS.api)
+      all(refresh, api: api).select{|g| not g[:is_smart] }
     end
 
     #####################################
@@ -304,7 +304,7 @@ module JSS
     ### @return [Array<Hash>] the refresh membership
     ###
     def refresh_members
-      @members = JSS.api_connection.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY][self.class::MEMBER_CLASS::RSRC_LIST_KEY]
+      @members = @api.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY][self.class::MEMBER_CLASS::RSRC_LIST_KEY]
     end
 
     ###
@@ -315,7 +315,7 @@ module JSS
     ### @return [void]
     ###
     def site= (new_val)
-      raise JSS::NoSuchItemError, "No site named #{new_val} in the JSS" unless JSS::Site.all_names.include? new_val
+      raise JSS::NoSuchItemError, "No site named #{new_val} in the JSS" unless JSS::Site.all_names(api: @api).include? new_val
       @site = new_val
       @need_to_update = true
     end
@@ -341,7 +341,7 @@ module JSS
     ### @return [Hash{:id=>Integer,:name=>String}] the valid id and name
     ###
     def check_member(m)
-      potential_members = self.class::MEMBER_CLASS.map_all_ids_to(:name)
+      potential_members = self.class::MEMBER_CLASS.map_all_ids_to(:name, api: @api)
       if m.to_s =~ /^\d+$/
         return {:id=>m.to_i, :name=> potential_members[m]} if potential_members.keys.include? m.to_i
       else

data/lib/jss/api_object/ldap_server.rb

@@ -1,26 +1,26 @@
 ### Copyright 2017 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.
-### 
+###
 ###
 
 ###
@@ -49,21 +49,21 @@ module JSS
   ### LDAP servers, and checking group membership.
   ###
   ### When an LDAPServer instance is created, if it
-  ### uses anonymous binding for lookups (the Authentication Type is set to 'none') then 
+  ### uses anonymous binding for lookups (the Authentication Type is set to 'none') then
   ### the LDAP connection is established immediately. Otherwise, you must use the {#connect}
   ### method, and provide the appropriate password for the lookup account defined.
   ###
-  ### Since LDAP server connections are used to verify the validity of LDAP users & groups used in 
+  ### Since LDAP server connections are used to verify the validity of LDAP users & groups used in
   ### scopes, if you don't connect to all LDAP servers before modifying any scope's user & group
   ### limitations or exceptions, those new values may not be verifiable. Unverified limitations and
-  ### exceptions, when sent to the API, will result in a REST 409 Conflict error if the user or 
+  ### exceptions, when sent to the API, will result in a REST 409 Conflict error if the user or
   ### group doesn't exist. Unfortunately, 409 Conflict errors are very generic and don't indicate the
-  ### source of the problem (in this case, a non-existent user or group limitation or exception to the 
+  ### source of the problem (in this case, a non-existent user or group limitation or exception to the
   ### scope). The {JSS::Scopable} module tries to catch these errors and raise a more useful
   ### exception when they happen.
   ###
   ### The class method {LDAPServer.all_ldaps} returns a Hash of JSS::LDAPServer instances.
-  ### one for each server defined in the JSS. 
+  ### one for each server defined in the JSS.
   ###
   ### The class methods {LDAPServer.user_in_ldap?} and {LDAPServer.group_in_ldap?} can be
   ### used to check all defined LDAP servers for a user or group. They are used by
@@ -76,44 +76,33 @@ module JSS
   ###
   class LDAPServer < JSS::APIObject
 
-    #####################################
-    ### Mix-Ins
-    #####################################
 
-    #####################################
-    ### Class Variables
-    #####################################
-    
-    @@all_ldaps = nil
-    
-    #####################################
     ### Class Methods
     #####################################
-    
+
+    ### DEPRECATED: Please Use ::all_objects
     ###
     ### @param refresh[Boolean] should the LDAP server data be re-read from the API?
     ###
     ### @return [Hash{String => JSS::LDAPServer}] JSS::LDAPServer instances for all defined servers
     ###
-    def self.all_ldaps(refresh = false)
-      @@all_ldaps = nil if refresh
-      return @@all_ldaps if @@all_ldaps
-      
-      @@all_ldaps = {}
-      JSS::LDAPServer.all.each { |svr| @@all_ldaps[svr[:name]] = JSS::LDAPServer.new(:id =>svr[:id])}
-
-      @@all_ldaps
+    def self.all_ldaps(refresh = false, api: JSS.api)
+      hash = {}
+      all_objects(refresh, api: api) { |ls| hash[ls.name] = s }
+      hash
     end
-    
+
     ###
     ### @param user[String] a username to search for in all LDAP servers
     ###
     ### @return [Boolean] does the user exist in any LDAP server?
     ###
-    def self.user_in_ldap? (user)
-      gotuser = false
-      self.all_ldaps.values.each{|ldap| gotuser =  true unless ldap.find_user(user, :exact).empty? }
-      return gotuser
+    def self.user_in_ldap?(user, api: JSS.api)
+      all_objects(refresh, api: api).each do |ldap|
+        next if ldap.find_user(user, :exact).empty?
+        return true
+      end
+      false
     end
 
     ###
@@ -121,10 +110,12 @@ module JSS
     ###
     ### @return [Boolean] does the group exist in any LDAP server?
     ###
-    def self.group_in_ldap? (group)
-      gotgroup = false
-      self.all_ldaps.values.each{|ldap| gotgroup =  true unless ldap.find_group(group, :exact).empty? }
-      return gotgroup
+    def self.group_in_ldap? (group, api: JSS.api)
+      all_objects(refresh, api: api).each do |ldap|
+        next if ldap.find_group(group, :exact).empty?
+        return true
+      end
+      false
     end
 
 
@@ -258,10 +249,10 @@ module JSS
     ### - :map_user_membership_to_group_field =>
     ###
     attr_reader :user_group_membership_mappings
-    
+
     ### @return [Boolean] we we connected to this server at the moment?
     attr_reader :connected
-    
+
     #####################################
     ### Constructor
     #####################################
@@ -313,7 +304,7 @@ module JSS
 
       @connection = nil
       @connected = false
-      
+
       # If we are using anonymous binding, connect now
       connect if @authentication_type == :anonymous
     end
@@ -333,9 +324,9 @@ module JSS
     ### @return [Array<Hash>] The @user_attrs_to_get for all usernames matching the query
     ###
     def find_user(user, exact = false, additional_filter = nil)
-      
+
       raise JSS::InvalidConnectionError, "Not connected to LDAP server '#{@name}'. Please use #connect first." unless @connected
-      
+
       if @use_wildcards and not exact
         user_filter = Net::LDAP::Filter.contains(@user_mappings[:map_username], user)
       else
@@ -391,9 +382,9 @@ module JSS
     ### @return [Array<Hash>] The @user_group_attrs_to_get for all groups matching the query
     ###
     def find_group(group, exact = false, additional_filter = nil)
-      
+
       raise JSS::InvalidConnectionError, "Not connected to LDAP server '#{@name}'. Please use #connect first." unless @connected
-      
+
       if @use_wildcards and not exact
         group_filter = Net::LDAP::Filter.contains(@user_group_mappings[:map_group_name], group)
       else
@@ -448,9 +439,9 @@ module JSS
     ### @todo Implement checking groups membership in 'other' ldap area
     ###
     def check_membership(user, group)
-      
+
       raise JSS::InvalidConnectionError, "Not connected to LDAP server '#{@name}'. Please use #connect first." unless @connected
-      
+
       found_user = find_user(user, :exact)[0]
       found_group = find_group(group, :exact)[0]
 
@@ -492,15 +483,15 @@ module JSS
     ### @param pw[String,Symbol] the LDAP connection password for this server. Can be nil if
     ###   authentication type is 'none'.
     ###   If :prompt, the user is promted on the commandline to enter the password for the :user.
-    ###   If :stdin#, the password is read from a line of std in represented by the digit at #, 
-    ###   so :stdin3 reads the passwd from the third line of standard input. defaults to line 2, 
+    ###   If :stdin#, the password is read from a line of std in represented by the digit at #,
+    ###   so :stdin3 reads the passwd from the third line of standard input. defaults to line 2,
     ###   if no digit is supplied. see {JSS.stdin}
     ###
     ###
     ### @return [Boolean] did we connect to the LDAP server with the defined credentials
     ###
     def connect(pw = nil)
-      
+
       unless @authentication_type == :anonymous
         # how do we get the password?
         password = if pw == :prompt
@@ -513,24 +504,24 @@ module JSS
         else
           pw
         end
-        
-        
+
+
         raise JSS::InvalidDataError, "Incorrect password for LDAP connection account '#{@lookup_dn}'" unless @lookup_pw_sha256 == Digest::SHA2.new(256).update(password.to_s).to_s
-      end # unless 
+      end # unless
 
       @connection = Net::LDAP.new :host => @hostname, :port => @port, :auth => {:method => @authentication_type, :username => @lookup_dn, :password => password }
-      
+
       @connected = true
     end # connect
-    
-    
-    
+
+
+
     ###
     ### Aliases
     ###
-    
+
     alias connected? connected
-    
+
   end # class ldap server
 
 end # module