ruby-jss 0.8.2 → 0.9.0.b1

data/lib/jss/api_object/scopable/scope.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.
-### 
+###
 ###
 
 ###
@@ -127,11 +127,11 @@ module JSS
       ###
       ### For telling it when a change is made and an update needed
       attr_accessor :container
-      
-      ### @return [Boolean] should we expect a potential 409 Conflict 
+
+      ### @return [Boolean] should we expect a potential 409 Conflict
       ###   if we can't connect to LDAP servers for verification?
       attr_accessor :unable_to_verify_ldap_entries
-      
+
       ### what type of target is this scope for? Computers or Mobiledevices?
       attr_reader :target_class
 
@@ -157,7 +157,7 @@ module JSS
       ### targets in the JSS form the base scope.
       ###
       attr_reader :all_targets
-      
+
 
 
       ### @return [Hash<Array>]
@@ -199,8 +199,8 @@ module JSS
       ###
       ### @param api_scope[Hash] the JSON :scope data from an API query that is scopable, e.g. a Policy.
       ###
-      def initialize(target_key, api_scope = DEFAULT_SCOPE)
-
+      def initialize(target_key, api_scope = nil)
+        api_scope ||= DEFAULT_SCOPE
         raise JSS::InvalidDataError, "The target class of a Scope must be one of the symbols :#{TARGETS_AND_GROUPS.keys.join(', :')}" unless TARGETS_AND_GROUPS.keys.include? target_key
 
         @target_key = target_key
@@ -575,13 +575,13 @@ module JSS
         end
         return scope
       end #scope_xml
-      
-      
+
+
       ### Aliases
-      
+
       alias all_targets? all_targets
-      
-      
+
+
       #####################################
       ### Private Instance Methods
       #####################################
@@ -600,17 +600,17 @@ module JSS
         return true if found_in_jss
 
         return false unless CHECK_LDAP_KEYS.include?(key)
-        
+
         begin
           return JSS::LDAPServer.user_in_ldap?(name) if LDAP_USER_KEYS.include?(key)
           return JSS::LDAPServer.group_in_ldap?(name) if LDAP_GROUP_KEYS.include?(key)
-        
+
         # if an ldap server isn't connected, make a note of it and return true
         rescue JSS::InvalidConnectionError
           @unable_to_verify_ldap_entries = true
           return true
         end # begin
-        
+
         return false
       end
 
@@ -619,4 +619,3 @@ module JSS
     end # class Scope
   end #module Scopable
 end # module
-

data/lib/jss/api_object/self_servable.rb

@@ -458,6 +458,7 @@ module JSS
     def in_self_service_at_init?
       return nil unless @self_service_data_config[:in_self_service_data_path]
       subsection, key = @self_service_data_config[:in_self_service_data_path]
+      return false unless @init_data[subsection]
       @init_data[subsection][key] == @self_service_data_config[:in_self_service]
     end
 
@@ -481,7 +482,7 @@ module JSS
     #
     def refresh_icon
       return nil unless @in_jss
-      fresh_data = JSS::API.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
+      fresh_data = JSS.api_connection.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
       icon_data = fresh_data[:self_service][:self_service_icon]
       @icon = JSS::Icon.new icon_data
     end # refresh icon
@@ -506,11 +507,13 @@ module JSS
       end
 
       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 @self_service_data_config[:can_display_in_categories]
-        catelem.add_element('feature_in').text = cat[:feature_in] if @self_service_data_config[:can_feature_in_categories]
+      if @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 @self_service_data_config[:can_display_in_categories]
+          catelem.add_element('feature_in').text = cat[:feature_in] if @self_service_data_config[:can_feature_in_categories]
+        end
       end
 
       if self_service_targets.include? :macos

data/lib/jss/api_object/updatable.rb

@@ -93,7 +93,7 @@ module JSS
       return nil unless @need_to_update
       raise JSS::UnsupportedError, "Editing #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." unless UPDATABLE
       raise JSS::NoSuchItemError, "Not In JSS! Use #create to create this #{self.class::RSRC_OBJECT_KEY} in the JSS before updating it." unless @in_jss
-      JSS::API.put_rsrc @rest_rsrc, rest_xml
+      JSS.api_connection.put_rsrc @rest_rsrc, rest_xml
       @need_to_update = false
       refresh_icon if self_servable?
       @id

data/lib/jss/api_object/uploadable.rb

@@ -130,7 +130,7 @@ module JSS
       file = File.new local_file.to_s, 'rb'
 
       # upload it!
-      JSS::API.cnx[upload_rsrc].post name: file
+      JSS.api_connection.cnx[upload_rsrc].post name: file
     end # def upload file
 
   end # module FileUpload

data/lib/jss/server.rb

@@ -1,109 +1,110 @@
 ### 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.
-### 
+###
 ###
 
 ###
 module JSS
 
-  ### A class representing a JSS Server.
-  ###
-  ### The {JSS::APIConnection} instance has a JSS::Server instance in its @server attribute.
-  ### It is created fresh every time {APIConnection#connect} is called.
-  ###
-  ### That's the only time it should be instantiated, and all access should be through
-  ### {JSS::API.server}
-  ###
+  # A class representing the currently-connected JSS Server.
+  #
+  # The {JSS::APIConnection} instance has a JSS::Server instance in its #server
+  # attribute. It is created fresh every time {APIConnection#connect} is called.
+  #
+  # That's the only time it should be instantiated, and all access should be
+  # through {JSS.api_connection.server}
+  #
   class Server
 
+    # Constants
     #####################################
-    ### Attributes
-    #####################################
+    ACTIVATION_CODE_RSRC = 'activationcode'.freeze
+    ACTIVATION_CODE_KEY = :activation_code
 
-    ### @return [String] the organization to which the server is licensed
-    attr_reader :organization
-    
 
-    ### @return [String] the activation code for the server licence
-    attr_reader :activation_code
+    # Attributes
+    #####################################
 
-    ### @return [String] the type of server licence
+    # @return [String] the type of server licence
     attr_reader :license_type
 
-    ### @return [String] the license product name
+    # @return [String] the license product name
     attr_reader :product
 
-    ###  @return [String] The version of the JSS. See the method JSS.parse_jss_version
+    #  @return [String] The version of the JSS. See the method JSS.parse_jss_version
     attr_reader :version
 
-    ###  @return [Integer]
+    #  @return [Integer]
     attr_reader :major_version
 
-    ###  @return [Integer]
+    #  @return [Integer]
     attr_reader :minor_version
 
-    ###  @return [Integer]
+    #  @return [Integer]
     attr_reader :revision_version
 
-    ###  @return [String]
+    #  @return [String]
     attr_reader :raw_version
 
+    # Instance Methods
     #####################################
-    ### Instance Methods
-    #####################################
 
-    ###
-    ### Initialize!
-    ###
-    def initialize
-      begin
-
-        # the jssuser resource is readable by anyone with a JSS acct
-        # regardless of their permissions.
-        # However, it's marked as 'deprecated'. Hopefully jamf will
-        # keep this basic level of info available for basic authentication
-        # and JSS version checking.
-        ju = JSS::API.get_rsrc('jssuser')[:user]
-        @license_type = ju[:license_type]
-        @product = ju[:product]
-        @raw_version = ju[:version]
-        parsed = JSS.parse_jss_version(@raw_version)
-        @major_version = parsed[:major]
-        @minor_version = parsed[:minor]
-        @revision_version = parsed[:revision]
-        @version = parsed[:version]
-
-      rescue RestClient::Request::Unauthorized
-        raise JSS::AuthenticationError, "Incorrect JSS username or password for '#{JSS::API.jss_user}@#{JSS::API.server_host}'."
-      end
+    # Initialize!
+    # THe jss_data to be passed in is the JSON output of the 'jssuser' resource
+    # on the API server.
+    # the jssuser resource is readable by anyone with a JSS acct
+    # regardless of their permissions.
+    # However, it's marked as 'deprecated'. Hopefully jamf will
+    # keep this basic level of info available for basic authentication
+    # and JSS version checking.
+    def initialize(jss_data)
+
+      @license_type = jss_data[:license_type]
+      @product = jss_data[:product]
+      @raw_version = jss_data[:version]
+      parsed = JSS.parse_jss_version(@raw_version)
+      @major_version = parsed[:major]
+      @minor_version = parsed[:minor]
+      @revision_version = parsed[:revision]
+      @version = parsed[:version]
+    end
+
+    # @return [String] the organization to which the server is licensed
+    def organization
+      @act_code_data ||= JSS.api_connection.get_rsrc(ACTIVATION_CODE_RSRC)[ACTIVATION_CODE_KEY]
+      @act_code_data[:organization_name]
+    end
 
+    # @return [String] the activation code for the server licence
+    def activation_code
+      @act_code_data ||= JSS.api_connection.get_rsrc(ACTIVATION_CODE_RSRC)[ACTIVATION_CODE_KEY]
+      @act_code_data[:code]
     end
 
-    
     ##### Aliases
     alias institution organization
     alias product_name product
-    
+
   end # class server
 
 end # module

data/lib/jss/utility.rb

@@ -281,6 +281,7 @@ module JSS
 
   # Given an element name and an array of content, generate an Array of
   # REXML::Element objects with that name, and matching content.
+  # Given element name 'foo' and the array ['bar','morefoo']
   # The array of REXML elements would render thus:
   #     <foo>bar</foo>
   #     <foo>morefoo</foo>
@@ -419,6 +420,9 @@ module JSS
   def self.parse_jss_version_newstyle(version)
     release, build = version.split '-'
     major, minor, revision = release.split '.'
+    minor ||= 0
+    revision ||= 0
+
     {
       major: major.to_i,
       minor:  minor.to_i,

data/lib/jss/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0.b1
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -79,26 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: immutable-struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.2
 description: |2
       The ruby-jss gem provides the JSS module, a framework for interacting with the REST API
       of the Jamf Software Server (JSS), the core of Jamf Pro, an enterprise/education
@@ -223,9 +203,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8