axm 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d2f95c8bc2de0f7a2c7ea620d2f301980eb6c5a21243bc8ee878b0ae4ebb351
-  data.tar.gz: 59c698eebe7dbe7baf4b1378ca5a66b0045334a2d69c3441b0300ca5dc3de6a4
+  metadata.gz: 729a2e7795a94f807dc732928f6e704f42d4e93fdb712bde4083a04410fb1aa5
+  data.tar.gz: 8256543f1d81885b9ee2f6bae17f74506efaef554796b9ac2e03a415a3d50954
 SHA512:
-  metadata.gz: 8e3fc06e2e51475d49a6d5612700046e9003967200d1234ca3aa52d4ead5f08827d8f4eb432a512af127cb01920befab0a3f4dd9f354a6705a4f3ca8d1d5d781
-  data.tar.gz: dac8b555c797f8b773de5c58cc0de9b35128df4251a5cfbe9c3260160c11f5b2178e010f3fe9d8126a63ad144c0db71e9abd452b020488bb6440bb239e1875fe
+  metadata.gz: f3ae6ad5f92c66c84284011b9bb3ac2e5f3297df2662783807bf0893ec46efd337490185b6871a131b8a12e2fbfa2b59d581e213921510fadf16be5532ec563f
+  data.tar.gz: 5bcb9240a6aae5f17e9e872c0bf5a5796c8b9b0665e583a9063f6d42dafd59161656c1645ea8fa35deba31e8ae899d13993b031c61bddb5c193f7f5381b09bed

data/.rubocop.yml

@@ -11,9 +11,3 @@ Layout/LineLength:
 
 Style/Documentation:
   Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.0.1 - 2025-11-13
+
+- Add OpenSSL as a dev dependency (<https://github.com/nick-f/axm/pull/26>)
+- Store the access token in memory (<https://github.com/nick-f/axm/pull/25>)
+
 ## 1.0.0 - 2025-11-08
 
 ### Added

data/README.md

@@ -58,7 +58,13 @@ key_id = Secret.read('key_id')
 client = Axm::Client.new(private_key:, client_id:, key_id:)
 ```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releasing
+
+1. Update the version number in [lib/axm/version.rb](./lib/axm/version.rb)
+2. Add release notes to [CHANGELOG.md](CHANGELOG.md)
+3. Run the "Release" Action
 
 ## Contributing
 
@@ -70,4 +76,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Axm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nick-f/axm/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting with the AXM codebase and issue tracker is expected to follow the [code of conduct](https://github.com/nick-f/axm/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/axm/client/mdm_servers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axm
   class Client
     module MdmServers
@@ -11,7 +13,7 @@ module Axm
       # See: https://developer.apple.com/documentation/applebusinessmanagerapi/get-mdm-servers
       # See: https://developer.apple.com/documentation/appleschoolmanagerapi/get-mdm-servers
       def list_mdm_servers(options = {})
-        get("v1/mdmServers", options)
+        get('v1/mdmServers', options)
       end
 
       # Retrieves a list of IDs for the devices assigned to a specific MDM server.

data/lib/axm/client/organization_device_activities.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axm
   class Client
     module OrganizationDeviceActivities
@@ -19,7 +21,7 @@ module Axm
       # @param mdm_server_id [String] The unique identifier of the MDM server to which the device will be assigned.
       # @return [Hash, Integer] The response from the POST method, containing details of the assignment and status code.
       def assign(device_id, mdm_server_id)
-        assignment_change(device_id, mdm_server_id, "ASSIGN_DEVICES")
+        assignment_change(device_id, mdm_server_id, 'ASSIGN_DEVICES')
       end
 
       # Unassigns a device from an MDM server.
@@ -28,7 +30,7 @@ module Axm
       # @param mdm_server_id [String] The unique identifier of the MDM server to which the device will be assigned.
       # @return [Hash, Integer] The response from the POST method, containing details of the assignment and status code.
       def unassign(device_id, mdm_server_id)
-        assignment_change(device_id, mdm_server_id, "UNASSIGN_DEVICES")
+        assignment_change(device_id, mdm_server_id, 'UNASSIGN_DEVICES')
       end
 
       private
@@ -39,24 +41,25 @@ module Axm
       # @param mdm_server_id [String] The unique identifier of the MDM server.
       # @param activity_type [String] The type of activity being performed ("ASSIGN_DEVICES" or "UNASSIGN_DEVICES").
       # @return [Hash, Integer] The response from the POST request, containing details of the operation and status code.
+      # rubocop:disable Metrics/MethodLength
       def assignment_change(device_ids, mdm_server_id, activity_type)
         devices = device_ids.map do |device_id|
           {
-            type: "orgDevices",
+            type: 'orgDevices',
             id: device_id
           }
         end
 
         request_body = {
           data: {
-            type: "orgDeviceActivities",
+            type: 'orgDeviceActivities',
             attributes: {
               activityType: activity_type
             },
             relationships: {
               mdmServer: {
                 data: {
-                  type: "mdmServers",
+                  type: 'mdmServers',
                   id: mdm_server_id
                 }
               },
@@ -67,8 +70,9 @@ module Axm
           }
         }
 
-        post("v1/orgDeviceActivities", request_body)
+        post('v1/orgDeviceActivities', request_body)
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/axm/client/organization_devices.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axm
   class Client
     module OrganizationDevices
@@ -11,7 +13,7 @@ module Axm
       # See: https://developer.apple.com/documentation/applebusinessmanagerapi/get-org-devices
       # See: https://developer.apple.com/documentation/appleschoolmanagerapi/get-org-devices
       def list_org_devices(options = {})
-        get("v1/orgDevices", options)
+        get('v1/orgDevices', options)
       end
 
       # Retrieves information about a specific device in the organization.
@@ -49,7 +51,7 @@ module Axm
       # See: https://developer.apple.com/documentation/applebusinessmanagerapi/get-the-assigned-server-information-for-an-orgdevice
       # See: https://developer.apple.com/documentation/appleschoolmanagerapi/get-the-assigned-server-information-for-an-orgdevice
       def assigned_mdm_server(device_id, options = {})
-        options[:fields_key] = "mdmServers"
+        options[:fields_key] = 'mdmServers'
 
         get("v1/orgDevices/#{device_id}/assignedServer", options)
       end
@@ -65,7 +67,7 @@ module Axm
       # See: https://developer.apple.com/documentation/applebusinessmanagerapi/get-all-apple-care-coverage-for-an-orgdevice
       # See: https://developer.apple.com/documentation/appleschoolmanagerapi/get-all-apple-care-coverage-for-an-orgdevice
       def applecare_coverage(device_id, options = {})
-        options[:fields_key] = "appleCareCoverage"
+        options[:fields_key] = 'appleCareCoverage'
 
         get("v1/orgDevices/#{device_id}/appleCareCoverage", options)
       end

data/lib/axm/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'jwt'
 require 'net/http'
@@ -9,6 +11,7 @@ require 'axm/client/organization_device_activities'
 require 'axm/client/organization_devices'
 
 module Axm
+  # rubocop: disable Metrics/ClassLength
   class Client
     include MdmServers
     include OrganizationDeviceActivities
@@ -58,13 +61,14 @@ module Axm
       end
     end
 
+    # rubocop: disable Metrics/MethodLength
     def client_assertion
       @client_assertion ||= begin
         audience = 'https://account.apple.com/auth/oauth2/v2/token'
         algo = 'ES256'
 
         issued_at_timestamp = Time.now.utc.to_i
-        expiration_timestamp = issued_at_timestamp + 86_400 * 180 # 180 days
+        expiration_timestamp = issued_at_timestamp + (86_400 * 180) # 180 days
 
         payload = {
           sub: @client_id,
@@ -78,26 +82,23 @@ module Axm
         JWT.encode(payload, @private_key, algo, kid: @key_id)
       end
     end
+    # rubocop: enable Metrics/MethodLength
 
     def access_token
-      cached_access_token = JSON.parse(Secret.read('stub_access_token')) if File.exist?('secrets/stub_access_token')
-
-      if cached_access_token
-        token_expiration = Time.parse(cached_access_token['expires_at'])
+      if @cached_access_token
+        token_expiration = Time.parse(@cached_access_token['expires_at'])
         token_expired = Time.now.utc >= token_expiration
 
-        return cached_access_token unless token_expired
+        return @cached_access_token unless token_expired
       end
 
       response = exchange_access_token_request
 
       response_body = response.first if response.last.to_i == 200
 
-      token = response_body.merge!({ 'expires_at' => Time.now.utc + response_body['expires_in'] })
-
-      Secret.write('stub_access_token', token.to_json)
+      @cached_access_token = response_body.merge({ 'expires_at' => Time.now.utc + response_body['expires_in'] })
 
-      response_body
+      @cached_access_token
     end
 
     # Sends a GET request to the specified API endpoint.
@@ -107,6 +108,7 @@ module Axm
     #   - :paginate [Boolean] Whether to paginate through all results (unused).
     #   - :fields [Array<String>] Optional fields to include as fields[orgDevices].
     # @return [Hash] The parsed JSON response.
+    # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
     def get(path, options = {})
       options = options.dup
 
@@ -132,10 +134,12 @@ module Axm
 
       JSON.parse(res.body)
     end
+    # rubocop: enable Metrics/MethodLength, Metrics/AbcSize
 
     # Sends a POST request to exchange the credentials for an access token.
     #
     # @return [Net::HTTPResponse, integer] The HTTP response object and status code.
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def exchange_access_token_request
       uri = URI('https://account.apple.com/auth/oauth2/v2/token')
 
@@ -166,6 +170,7 @@ module Axm
 
       [response_json, response.code]
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     # Sends a POST request to the specified URI with given parameters.
     #
@@ -175,13 +180,9 @@ module Axm
     def post(path, request_body = {})
       uri = URI("https://#{api_domain}/#{path}")
 
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = uri.scheme == 'https'
+      http = Net::HTTP.new(uri.host, uri.port, use_ssl: true)
 
-      request = Net::HTTP::Post.new(uri)
-      request['Host'] = uri.host
-      request['Content-Type'] = 'application/json'
-      request['Authorization'] = "Bearer #{access_token['access_token']}"
+      request = add_post_headers(Net::HTTP::Post.new(uri))
 
       request.body = request_body.to_json unless request_body.empty?
 
@@ -191,5 +192,19 @@ module Axm
 
       [response_body, response.code]
     end
+
+    private
+
+    # Adds necessary headers to a POST request.
+    #
+    # @return [Net::HTTP::Post] The modified request with added headers.
+    def add_post_headers(request)
+      request['Host'] = uri.host
+      request['Content-Type'] = 'application/json'
+      request['Authorization'] = "Bearer #{access_token['access_token']}"
+
+      request
+    end
   end
+  # rubocop: enable Metrics/ClassLength
 end

data/lib/axm/secret.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Secret
   def self.read(filename)
     File.read("secrets/#{filename}").strip

data/lib/axm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Axm
-  VERSION = "1.0.0"
+  VERSION = '1.0.1'
 end

data/lib/axm.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "axm/client"
-require_relative "axm/secret"
-require_relative "axm/version"
+require_relative 'axm/client'
+require_relative 'axm/secret'
+require_relative 'axm/version'
 
 module Axm
   class Error < StandardError; end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: axm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - nick-f
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-08 00:00:00.000000000 Z
+date: 2025-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description:
 email:
 - nick@nickf.dev
 executables: []
@@ -53,7 +51,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/nick-f/axm
   source_code_uri: https://github.com/nick-f/axm
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -68,8 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Gem to interact with the Apple Business Manager/Apple School Manager API
 test_files: []