ruby-jss 1.1.0b5 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9337d6314a79881c726e5b816872dffb2bccdc0f538a6f7b6407075f5be684a
-  data.tar.gz: dd0d9d6210d1f8abab4bbf4046cc9ec59224e08e138e7b3d6a3122f13c4b2728
+  metadata.gz: 90a0bdaae94b5d0d1cb5ccad691ecf57daa75e205ceda668813655484ee232c8
+  data.tar.gz: 6c8e0211b2397df59d576b8fec2901f22003dd2d562c7a755209ebd0026493ca
 SHA512:
-  metadata.gz: bf9e2ca6b9075436d09415eee9cf31c18f3fa88325f5c7c99ab4ca06f996fa0c8e1446b2a88d862dd1628b16b9a3a79676abcc118d07dd26b1fb553826255143
-  data.tar.gz: 15361910ba0e772eecf502bc1d2ce644673b6a55cad00df60c207e495894a48cc67b593d05f8da32789974950984982eea568874762187bd126bb7f8fe47be56
+  metadata.gz: de40656a561b6624eaa28b4c851314de7bb4a84e151f656d1c021a784255c5c95ce76b2e7013553cc02f3094707934481e05059bf931b3fd9c659eedb8e05415
+  data.tar.gz: 8fdef7af00dc52b1ce253288415eade80d8d3812ed5470ad84f0e3c9292c95e32b1080b7c56e7457ce21e927bb0782e63124df1bb5efa2423e95694c620a148e

data/CHANGES.md

@@ -4,19 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## \[Unreleased]
+## \[1.1.3] - 2019-09-23
 ### Added
 - MobileDeviceExtensionAttribute now has a `.history` class method matching that of ComputerExtensionAttribute. Requires direct MySQL database access. Thanks @aurica!
 - JSS::AmbiguousError exception class
 - More caching of API data to improve general speed
   - The hashes created by `APIObject.map_all_ids_to(blah)`
   - ExtensionAttribute definitions when used by extendable classes
-- Implemented Ruby2.4's `String#casecmp?` in older Rubies
 - APIObject.fetch can take the search term `:random` and you'll get a randomly selected object. Example: `a_random_computer = JSS::Computer.fetch :random`
 - Keys of the hash returned by `Computer#hardware` are now available as instance methods on Computer objects. So as well as `a_computer.hardware[:total_ram]` you can also do `a_computer.total_ram`
 - Policy now recognizes the frequency Symbol `:once_per_user_per_computer`
 - Attribute reader :management_status added to Computer class
-- Implemented some useful String methods from newer versions of Ruby into older Rubies: casecmp?, delete_prefix, & delete_suffix
+- Implemented some useful String methods from newer versions of Ruby into older Rubies: `casecmp?`, `delete_prefix`, & `delete_suffix`
+- master_distribution_point class method in APIConnection & DistribtutionPoint now raise an error when no dist. point is 'master'
+  - The error states that the cloud dist. point may be the master, and there's no classic API access to it.
 
 
 ### Fixed
@@ -30,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Script#name= now works again, no longer uses a constant from an ancient version. Thanks @shahn
 - Computer#asset_tag= now accepts nil to erase the value
 - APIConnection.my_distribution_point & DistributionPoint.my_distribution_point now return the master_distribution_point object if there isn't one assigned to the current network segment.
+- RestClient no longer warns about calling 'to_i' on Responses when calling APIConnection#put_rsrc & #post_rsrc
 
 ### Changed
 - Monkey Patches are being moved to a better, more traceable technique, see https://www.justinweiss.com/articles/3-ways-to-monkey-patch-without-making-a-mess/
@@ -39,6 +41,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed deprecated VALID_DATA_KEYS constants from APIObject subclasses
 - Various changes in APIObject and its subclasses to try making `.fetch` and other lookup-methods faster.
 - All of the NetworkSegment-related methods in APIConnection have been moved back to NetworkSegment. The methods in APIConnection still work, but are marked deprecated and will go away eventually.
+- Removed last call to deprecated `URI.encode`, replaced with `CGI.escape`
 
 
 ## \[1.0.4] - 2019-05-06

data/lib/jss/api_connection.rb

@@ -539,7 +539,8 @@ module JSS
     # Get an arbitrary JSS resource
     #
     # The first argument is the resource to get (the part of the API url
-    # after the 'JSSResource/' )
+    # after the 'JSSResource/' ) The resource must be properly URL escaped
+    # beforehand. Note: URL.encode is deprecated, use CGI.escape
     #
     # By default we get the data in JSON, and parse it
     # into a ruby data structure (arrays, hashes, strings, etc)
@@ -559,11 +560,9 @@ module JSS
 
       raise JSS::InvalidDataError, 'format must be :json or :xml' unless %i[json xml].include? format
 
-      # TODO: fix what rubocop is complaining about in the line below.
-      # (I doubt we want to CGI.escape the whole resource)
-      rsrc = URI.encode rsrc
       begin
         @last_http_response = @cnx[rsrc].get(accept: format)
+        @last_http_response.body
       rescue RestClient::ExceptionWithResponse => e
         handle_http_error e
       end
@@ -588,6 +587,7 @@ module JSS
 
       # send the data
       @last_http_response = @cnx[rsrc].put(xml, content_type: 'text/xml')
+      @last_http_response.body
     rescue RestClient::ExceptionWithResponse => e
       handle_http_error e
     end
@@ -607,7 +607,8 @@ module JSS
       xml.gsub!(/\r/, '
') if xml
 
       # send the data
-      @last_http_response = @cnx[rsrc].post xml, content_type: 'text/xml', accept: :json
+      @last_http_response = @cnx[rsrc].post(xml, content_type: 'text/xml', accept: :json)
+      @last_http_response.body
     rescue RestClient::ExceptionWithResponse => e
       handle_http_error e
     end # post_rsrc
@@ -627,6 +628,7 @@ module JSS
 
       # delete the resource
       @last_http_response = @cnx[rsrc].delete
+      @last_http_response.body
     rescue RestClient::ExceptionWithResponse => e
       handle_http_error e
     end # delete_rsrc
@@ -886,17 +888,19 @@ module JSS
       @master_distribution_point = nil if refresh
       return @master_distribution_point if @master_distribution_point
 
-      all_dps = JSS::DistributionPoint.all refresh, api: self
-
-      @master_distribution_point =
-        case all_dps.size
-        when 0
-          raise JSS::NoSuchItemError, 'No distribution points defined'
-        when 1
-          JSS::DistributionPoint.fetch id: all_dps.first[:id], api: self
-        else
-          JSS::DistributionPoint.fetch id: :master, api: self
+      JSS::DistributionPoint.all_ids.each do |dp_id|
+        dp = JSS::DistributionPoint.fetch id: dp_id, api: self
+        if dp.master?
+          @master_distribution_point = dp
+          break
         end
+      end
+
+      return @master_distribution_point if @master_distribution_point
+
+      # If we're here, the Cloud DP might be master, but there's no
+      # access to it in the API :/
+      raise JSS::NoSuchItemError, 'No Master Distribtion Point defined. It could be the Cloud Dist Point, which is not available in the classic API'
     end
 
     # Get the DistributionPoint instance for the machine running
@@ -912,9 +916,11 @@ module JSS
       return @my_distribution_point if @my_distribution_point
 
       my_net_seg_id = my_network_segments[0]
+
       if my_net_seg_id
         my_net_seg = JSS::NetworkSegment.fetch(id: my_net_seg_id, api: self)
-        @my_distribution_point = JSS::DistributionPoint.fetch(name: my_net_seg.distribution_point)
+        my_dp_name = my_net_seg.distribution_point
+        @my_distribution_point = JSS::DistributionPoint.fetch(name: my_dp_name) if my_dp_name
       end # if my_net_seg_id
 
       @my_distribution_point ||= master_distribution_point refresh

data/lib/jss/api_object.rb

@@ -586,7 +586,7 @@ module JSS
       all(refresh, api: api) if refresh
 
       # it its a valid id, return it
-      return identifier if all_ids.include? identifier
+      return identifier if all_ids(api: api).include? identifier
 
       keys_to_check = lookup_keys(no_aliases: true)
       keys_to_check.delete :id # we've already checked :id
@@ -829,7 +829,7 @@ module JSS
 
         # does this lookup key have a fetch_rsrc_key?
         fetch_rsrc_key = fetch_rsrc_key(fetch_key)
-        return new fetch_rsrc: "#{self::RSRC_BASE}/#{fetch_rsrc_key}/#{fetch_val}", api: api if fetch_rsrc_key
+        return new fetch_rsrc: "#{self::RSRC_BASE}/#{fetch_rsrc_key}/#{CGI.escape fetch_val.to_s}", api: api if fetch_rsrc_key
       end
 
       # if we'ere here, we need to get the id from either the lookup key/val or
@@ -1116,7 +1116,7 @@ module JSS
     def delete
       return nil unless @in_jss
       @api.delete_rsrc @rest_rsrc
-      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name}"
+      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name.to_s}"
       @id = nil
       @in_jss = false
       @need_to_update = false
@@ -1444,7 +1444,7 @@ module JSS
       @init_data = args
       @name = args[:name]
       @in_jss = false
-      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name}"
+      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name.to_s}"
       @need_to_update = true
     end
 

data/lib/jss/api_object/computer/application_installs.rb

@@ -96,11 +96,10 @@ module JSS
     def self.application_installs(appname, fields: [], version: nil, ids_only: false, api: JSS.api)
       fields = [fields] unless fields.is_a? Array
 
-      rsrc = "#{COMPUTER_APPLICATIONS_RSRC}/#{appname}"
-      rsrc << "/version/#{version}" if version
-      rsrc << "/inventory/#{fields.join ','}" unless ids_only || fields.empty?
+      rsrc = "#{COMPUTER_APPLICATIONS_RSRC}/#{CGI.escape appname.to_s}"
+      rsrc << "/version/#{CGI.escape version.to_s}" if version
+      rsrc << "/inventory/#{CGI.escape fields.join(',')}" unless ids_only || fields.empty?
 
-      # get_rsrc will URI.encode the rsrc
       result = api.get_rsrc(rsrc)[:computer_applications]
 
       return result[:unique_computers].map { |c| c[:id] } if ids_only

data/lib/jss/api_object/creatable.rb

@@ -103,7 +103,7 @@ module JSS
       orig_id = @id
       @id = nil
       orig_rsrc = @rest_rsrc
-      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape new_name}"
+      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape new_name.to_s}"
       orig_api = @api
       @api = api
 

data/lib/jss/api_object/distribution_point.rb

@@ -323,7 +323,7 @@ module JSS
           # drop down below to try the password for mounting.
           # we'll escape all the chars that aren't unreserved
           # reserved_chars = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]")
-          user_pass = "#{CGI.escape @http_username}:#{CGI.escape ro_pw}@"
+          user_pass = "#{CGI.escape @http_username.to_s}:#{CGI.escape ro_pw.to_s}@"
           url = @http_url.sub "://#{@ip_address}", "://#{user_pass}#{@ip_address}"
         else
           url = @http_url
@@ -410,7 +410,7 @@ module JSS
 
       username = access == :ro ? @read_only_username : @read_write_username
 
-      safe_pw = CGI.escape password
+      safe_pw = CGI.escape password.to_s
 
       @mount_url = "#{@connection_type.downcase}://#{username}:#{safe_pw}@#{@ip_address}/#{@share_name}"
       @mnt_cmd = case @connection_type.downcase
@@ -463,6 +463,7 @@ module JSS
     #### aliases
     alias hostname ip_address
     alias umount unmount
+    alias master? is_master
 
     # Private Instance Methods
     ######################################

data/lib/jss/api_object/ldap_server.rb

@@ -159,7 +159,7 @@ module JSS
     def self.check_membership(ldap_server, user, group, api: JSS.api)
       ldap_server_id = valid_id ldap_server
       raise JSS::NoSuchItemError, "No LDAPServer matching #{ldap_server}" unless ldap_server_id
-      rsrc = "#{RSRC_BASE}/id/#{ldap_server_id}/group/#{CGI.escape group}/user/#{CGI.escape user}"
+      rsrc = "#{RSRC_BASE}/id/#{ldap_server_id}/group/#{CGI.escape group.to_s}/user/#{CGI.escape user.to_s}"
       member_check = api.get_rsrc rsrc
       return false if member_check[:ldap_users].empty?
       true
@@ -302,7 +302,7 @@ module JSS
     #
     def find_user(user, exact = false)
       raise JSS::NoSuchItemError, 'LDAPServer not yet saved in the JSS' unless @in_jss
-      raw = api.get_rsrc("#{RSRC_BASE}/id/#{@id}/user/#{user}")[:ldap_users]
+      raw = api.get_rsrc("#{RSRC_BASE}/id/#{@id}/user/#{CGI.escape user.to_s}")[:ldap_users]
       exact ? raw.select { |u| u[:username] == user } : raw
     end
 
@@ -314,7 +314,7 @@ module JSS
     #
     def find_group(group, exact = false)
       raise JSS::NoSuchItemError, 'LDAPServer not yet saved in the JSS' unless @in_jss
-      raw = api.get_rsrc("#{RSRC_BASE}/id/#{@id}/group/#{group}")[:ldap_groups]
+      raw = api.get_rsrc("#{RSRC_BASE}/id/#{@id}/group/#{CGI.escape group.to_s}")[:ldap_groups]
       exact ? raw.select { |u| u[:groupname] == group } : raw
     end
 

data/lib/jss/api_object/matchable.rb

@@ -88,7 +88,7 @@ module JSS
     ###
     def match(term, api: JSS.api )
       raise JSS::InvalidDataError, "Match term may not be empty" if term.to_s.empty?
-      rsrc = "#{self::RSRC_BASE}/#{JSS::Matchable::MATCH_RSRC}/#{term}"
+      rsrc = "#{self::RSRC_BASE}/#{JSS::Matchable::MATCH_RSRC}/#{CGI.escape term.to_s}"
       api.get_rsrc(rsrc)[self::RSRC_LIST_KEY]
     end
 

data/lib/jss/api_object/package.rb

@@ -899,7 +899,7 @@ module JSS
             raise JSS::InvaldDatatError, 'Incorrect password for http access to distribution point.' unless mdp.check_pw(:http, ro_pw)
             # insert the name and pw into the uri
             # reserved_chars = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]") # we'll escape all the chars that aren't unreserved
-            src_path = src_path.sub(%r{(https?://)(\S)}, "#{Regexp.last_match(1)}#{CGI.escape mdp.http_username}:#{CGI.escape ro_pw}@#{Regexp.last_match(2)}")
+            src_path = src_path.sub(%r{(https?://)(\S)}, "#{Regexp.last_match(1)}#{CGI.escape mdp.http_username.to_s}:#{CGI.escape ro_pw.to_s}@#{Regexp.last_match(2)}")
           end
 
         # or with filesharing?

data/lib/jss/api_object/patch_policy.rb

@@ -510,7 +510,7 @@ module JSS
       # TODO: prepare for more cases where the POST rsrc is
       # different from the PUT/GET/DELETE.
       orig_rsrc = @rest_rsrc
-      @rest_rsrc = "#{RSRC_BY_PATCH_TITLE}#{patch_title_id}"
+      @rest_rsrc = "#{RSRC_BY_PATCH_TITLE}#{CGI.escape patch_title_id.to_s}"
       super
       @rest_rsrc = orig_rsrc
       refetch_version_info

data/lib/jss/api_object/script.rb

@@ -184,7 +184,7 @@ module JSS
       @name = new_val
 
       ### if our REST resource is based on the name, update that too
-      @rest_rsrc = "#{RSRC_BASE}/name/#{CGI.escape @name}" if @rest_rsrc.include? '/name/'
+      @rest_rsrc = "#{RSRC_BASE}/name/#{CGI.escape @name.to_s}" if @rest_rsrc.include? '/name/'
       @need_to_update = true
     end # name=
 

data/lib/jss/api_object/updatable.rb

@@ -81,7 +81,7 @@ module JSS
       raise JSS::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} named '#{newname}' already exsists in the JSS" \
         if self.class.all_names(:refresh, api: @api).include? newname
       @name = newname
-      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name}" if @rest_rsrc.include? '/name/'
+      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name.to_s}" if @rest_rsrc.include? '/name/'
       @need_to_update = true
     end #  name=(newname)
 

data/lib/jss/ruby_extensions/string.rb

@@ -21,11 +21,15 @@
 #    KIND, either express or implied. See the Apache License for the specific
 #    language governing permissions and limitations under the Apache License.
 
-
 require 'jss/ruby_extensions/string/conversions.rb'
 require 'jss/ruby_extensions/string/predicates.rb'
 require 'jss/ruby_extensions/string/backports.rb'
 
-String.include JSSRubyExtensions::String::Predicates
-String.include JSSRubyExtensions::String::Conversions
-String.include JSSRubyExtensions::String::BackPorts
+# include the modules loaded above
+class String
+
+  include JSSRubyExtensions::String::Predicates
+  include JSSRubyExtensions::String::Conversions
+  include JSSRubyExtensions::String::BackPorts
+
+end

data/lib/jss/version.rb

@@ -27,6 +27,6 @@
 module JSS
 
   ### The version of ruby-jss
-  VERSION = '1.1.0b5'.freeze
+  VERSION = '1.1.3'.freeze
 
 end # module

data/test/README.md

@@ -2,8 +2,8 @@
 
 For years, I've attempted to use some ruby testing framework to automate testing of ruby-jss.
 
-Every time I've run into walls because unit testing suites are designed for unit testing, and that's not really what we need to do.  Yes we need to test individual methods of classes and so on, but when working with a REST API, there's a lot of
-scaffolding that needs to happen before tests can even start - and that scaffolding itself is testing the code. And the details of the scaffolding will vary in different environments.
+Every time I've run into walls because unit testing suites are designed for unit testing, and that's not really what we need to do. Yes we need to test individual methods of classes and so on, but when working with a REST API, there's a lot of
+scaffolding that needs to happen before tests can even start - and that scaffolding itself is testing the code. And the details of the scaffolding will vary in different environments. We need to run integration tests.
 
 For example, the tests *must* be very interactive from the start - you have to tell them what server to connect with, what credentials to use, and so on.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 1.1.0b5
+  version: 1.1.3
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -288,9 +288,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.8