ruby-jss 1.0.3b5 → 1.0.4b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4484b1e28fa48b3359c0fa3e1f946f516e1606ba3e699f16226d98fd83a4d87f
-  data.tar.gz: 70e69a2e1e38c7f2106661ee58eced3cd60d132c7c11b22449a4b5cfca210277
+  metadata.gz: c225dd8883168a2bf57d650196a6a535bd67e185736b3e61e6b60ce1a9b8385c
+  data.tar.gz: 2bd4a39129ea203b49aa9dc579b70f2a8e4b06bafeb4267d34ed80bea4254016
 SHA512:
-  metadata.gz: 2075c974cf726e611d170ba82eafd202b5d3028201359ef57648654ca3c71df31f8237046891891d362f28bbeb8202d11a89c0e28a71eea6b1928d3a54824a8e
-  data.tar.gz: c134e904917e2b0557134d856db08a38cbc3a60aed6ceac7ace77144b070155b8771e00dd0fb33d484d4b96d80567991eab53ef8862d372b47be98d70e6d2c0b
+  metadata.gz: 6652993d14454f54cc509a6d0835eecf9d3d4b1220135c5b492ccd4c64e3af8353233c718fa27c038dbd6501bfea67987c188ed501bdd5ecb0c0bddeacbeaabd
+  data.tar.gz: f3046e7dcba8e6673805ad1990082c541f12d5e6a9ca4e1306d4e9284cdacd60807be400435ca19a4d82424f45553b61ddc3ed2deb84aff17aeca0920d1aa0b3

data/CHANGES.md

@@ -26,17 +26,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   (Thanks @christopher.kemp!)
 
 - Packages in Jamf Pro 10.10 and higher now include checksum data (`hash_type` and `hash_value` in the raw data) via the classic API. This has been integrated into JSS::Package via the following methods:
-  - New Class Method `JSS::Package.calculate_checksum(filepath, type)` calcuates an MD5 or SHA_512 hash for an arbtrary file.
+  - New Class Method
+    - `JSS::Package.calculate_checksum(filepath, type)` calcuates an MD5 or SHA_512 hash for an arbtrary file.
+  - New Instance Attributes:
+    - `JSS::Package#checksum`  the checksum value, read-write
+    - `JSS::Package#checksum_type` the string 'MD5' or 'SHA_512' ('SHA_512' if no checksum is set), read-write
   - New Instance Methods:
-    - `JSS::Package#checksum` returns the checksum value
-    - `JSS::Package#checksum_type` returns the string 'MD5' or 'SHA_512' ('SHA_512' if no checksum is set)
     - `JSS::Package#caluclate_checksum(type: nil, local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true )` recalculates and returns the checksum from a local file or the master dist. point. Doesn't change the Package instance
     - `JSS::Package#checksum_valid?(local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true)` recalculates the checksum from a local file or the master dist. point, and returns Boolean true if it matches the stored one, false if not. Always false if there is no stored checksum. Doesn't change the Package instance
     - `JSS::Package#reset_checksum(type: nil, local_file: nil,  rw_pw: nil, ro_pw: nil, unmount: true)` recalculates and resets the checksum from a local file or the master dist. point. The instance must be saved back to the server for the new checksum to stick,
-  - Modified Instance Method `JSS::Package#upload_master_file` now takes a `cksum:` parameter, 'MD5' or 'SHA_512' ('SHA_512' by default)  Any other value means 'don't use a checksum on this package'
+  - Modified Instance Method
+    - `JSS::Package#upload_master_file` now takes a `cksum:` parameter, the String 'MD5' or 'SHA_512'. Any other value means 'don't use a checksum on this package' Defaults to 'SHA_512' and a checksum will be calculated. Be sure to set `cksum:` to some other value if you don't want a checksum.
 
-  NOTE: Checksum calculation can be slow.
-  WARNING: when using a local file to calculate checksums, BE 100% SURE it is identical to the file on the master distribution point, or you will get an invalid checksum.
+  NOTE: Checksum calculation can be slow, especially for large packages on a network server.
+
+  _WARNING_: when using a local file to calculate checksums, BE 100% SURE it is identical to the file on the distribution point, or you will get an invalid checksum.
 
 
 ### Fixed

data/lib/jss/api_object/package.rb

@@ -396,12 +396,41 @@ module JSS
     #
     def notes=(new_val)
       return nil if new_val == @notes
+
       # line breaks should be \r
       new_val = new_val.to_s.tr("\n", "\r")
       @notes = new_val
       @need_to_update = true
     end
 
+    # Change the  checksum type
+    #
+    # @param new_val[String]
+    #
+    # @return [void]
+    #
+    def checksum_type=(new_val)
+      return if new_val == @checksum_type
+      raise JSS::InvalidDataError, "Checksum type must be one of: #{CHECKSUM_HASH_TYPES.keys.join ', '} " unless CHECKSUM_HASH_TYPES.key? new_val
+
+      @checksum_type = new_val
+      @need_to_update = true
+    end
+
+    # Change the  checksum type
+    #
+    # @param new_val[String]
+    #
+    # @return [void]
+    #
+    def checksum=(new_val)
+      return if new_val == @checksum
+      raise JSS::InvalidDataError, 'Checksum must be a String or nil' unless new_val.is_a?(String) || new_val.nil?
+
+      @checksum = new_val
+      @need_to_update = true
+    end
+
     # Change the os_requirements field in the JSS
     # E.g. 10.5, 10.5.3, 10.6.x
     #
@@ -611,14 +640,12 @@ module JSS
 
       if CHECKSUM_HASH_TYPES.keys.include? chksum
         @checksum_type = chksum
-        @checksum = calculate_checksum local_path, chksum
+        @checksum = calculate_checksum local_file: local_path, type: chksum, unmount: false
         @need_to_update = true
       end
-
       update if @need_to_update
-
       mdp.unmount if unmount
-    end # upload
+    end # upload master file
 
     # Using either a local file, or the file on the master dist. point,
     # re-set the checksum for this package. Call #update to save the
@@ -634,7 +661,7 @@ module JSS
     #
     # @return [void]
     #
-    def reset_checksum(type: nil, local_file: nil,  rw_pw: nil, ro_pw: nil, unmount: true)
+    def reset_checksum(type: nil, local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true)
       type ||= DEFAULT_CHECKSUM_HASH_TYPE
 
       new_checksum = calculate_checksum(
@@ -1018,13 +1045,10 @@ module JSS
       pkg.add_element('required_processor').text = @required_processor.to_s.empty? ? 'None' : @required_processor
       pkg.add_element('send_notification').text = @send_notification
       pkg.add_element('switch_with_package').text = @switch_with_package
-      # if there's no checksum value for this pkg, don't even include the
-      # hash_type and hash_value in the XML, they'll stay whatever
-      # the JSS already has (which is usuall type=MD5, and value='')
-      if @checksum
-        pkg.add_element('hash_type').text = @checksum_type
-        pkg.add_element('hash_value').text = @checksum
-      end
+
+      pkg.add_element('hash_type').text = @checksum_type
+      pkg.add_element('hash_value').text = @checksum.to_s
+
       add_category_to_xml(doc)
       doc.to_s
     end # rest xml

data/lib/jss/version.rb

@@ -27,6 +27,6 @@
 module JSS
 
   ### The version of the JSS ruby gem
-  VERSION = '1.0.3b5'.freeze
+  VERSION = '1.0.4b1'.freeze
 
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 1.0.3b5
+  version: 1.0.4b1
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -267,7 +267,7 @@ files:
 - test/specs/policy_spec.rb
 homepage: http://pixaranimationstudios.github.io/ruby-jss/
 licenses:
-- NonStandard
+- Nonstandard
 metadata: {}
 post_install_message: 
 rdoc_options: