axm 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647f814737c960878d73525988b5478ba70806d283e52384e8e511483a2410ae
-  data.tar.gz: d1825207bf7ecf99a24bb62da4dc6c15aba43e110f2b4a63462e4a794a21d2cf
+  metadata.gz: 2b9cf51eb8d1e42d2ee6112d4bf1bc8d38408a56581f0ed0fcaafcb4358692a7
+  data.tar.gz: 48a58959848c13ff47d37dd9eb9cd104291bd66e422fc00ba8b3bfbdd3eea3b7
 SHA512:
-  metadata.gz: '019c72d25c2de0cbfd4996ed555c1cb58507be75548ce7df1dbcf9dc99a737371c34728532013599428ee7316aa2f69a1a0c3a829729be6a2f37d8ce172f5dae'
-  data.tar.gz: 46f9235329a51fccf772b3b8d8403f7e9ccb8f20e5d046f42e3e1a79f9ef160583164e806339451b1d3fbc039bcbc36589947cf8e05e0b8160c8d909ca693fbd
+  metadata.gz: bd809519957cc388dff7f4c62ce718de7f0c3990c85056a24964de019b2c77338db9078c56b488a583e289ecde0378f40e965682bcd11beaa329bbab625dccbb
+  data.tar.gz: 8d4db509e738fe69a17265e718f8371a7c8c2d1e9a1ad7ca3c8471a5eebec62262c5d7f071c5040614fefc1568b75b47f59cd1bc331dae063b9f4ae5073812d1

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## [Unreleased]
 
-## [0.1.0] - 2025-06-16
+## 0.1.2 - 2025-07-14
+
+### Added
+
+- Get information about a specific device
+
+### Fixed
+
+- Fixed issue with incorrect endpoints being included
+
+## [0.1.1] - 2025-07-14
+
+- Updated README with more detailed usage instructions
+
+## [0.1.0] - 2025-07-14
 
 - Initial release
+
+### Added
+
+- Exchange credentials for an access token
+- List all devices in an organisation

data/README.md

@@ -4,10 +4,60 @@ A Ruby wrapper around the Apple Business Manager (ABM) and Apple School Manager
 
 This gem is heavily inspired by [Octokit](https://github.com/octokit/octokit.rb) and [Oktakit](https://github.com/Shopify/oktakit). If you're familiar with those libraries, you should feel right at home.
 
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add axm
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install axm
+```
+
+## Usage
+
+First, generate API credentials from the Apple Business Manager or Apple School Manager portal and store the credentials in a secure location accessible to your app.
+
+With the credentials handy, you can create an instance of the client:
+
+```ruby
+private_key = File.read('path/to/your/private_key.pem')
+client_id = 'your_client_id'
+key_id = 'your_key_id'
+
+client = Axm::Client.new(private_key:, client_id:, key_id:)
+```
+
+You're now ready to make API requests.
+
+```ruby
+client.list_org_devices
+```
+
+For any endpoints that don't currently exist in the gem, you can use the `get` or `post` method directly to make API requests
+
+```ruby
+client.get('/v1/some/endpoint', { limit: 10 })
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+If the credentials are stored in the `secrets/` directory, you can use the `Secret.read` method to load them:
+
+```ruby
+private_key = Secret.read('private_key.pem')
+client_id = Secret.read('client_id')
+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).
 
 ## Contributing

data/lib/axm/client/organization_devices.rb

@@ -11,7 +11,19 @@ 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/organization/devices', options)
+        get("v1/orgDevices", options)
+      end
+
+      # Retrieves information about a specific device in the organization.
+      #
+      # @param options [Hash] Optional query parameters to filter or paginate results.
+      #   - fields: (Array) Array of fields to include in the response.
+      # @return [<Hash>] A device and its selected attributes.
+      #
+      # See: https://developer.apple.com/documentation/applebusinessmanagerapi/get-orgdevice-information
+      # See: https://developer.apple.com/documentation/appleschoolmanagerapi/get-orgdevice-information
+      def device(id, options = {})
+        get("/v1/orgDevices/#{id}", options)
       end
     end
   end

data/lib/axm/client.rb

@@ -8,6 +8,8 @@ require 'axm/client/organization_devices'
 
 module Axm
   class Client
+    include OrganizationDevices
+
     # Initializes a new instance of the AXM client.
     #
     # @param private_key [String] The private key used for authentication.
@@ -95,7 +97,6 @@ module Axm
 
       response_body = response.first if response.last.to_i == 200
 
-      require 'pry'; binding.pry
       token = response_body.merge!({ 'expires_at' => Time.now.utc + response_body['expires_in'] })
 
       Secret.write('stub_access_token', token.to_json)
@@ -153,22 +154,9 @@ module Axm
 
       response_json = JSON.parse(response.body)
 
-      require 'pry'; binding.pry
       raise 'Invalid request' if response_json['error'] == 'invalid_request'
 
       [response_json, response.code]
     end
-
-    # Fetches a list of organization devices from Apple Business Manager.
-    #
-    # @param limit [Integer] Maximum number of devices to return (default: 100).
-    # @param paginate [Boolean] Whether to paginate through all results (default: false).
-    # @param fields [Array<String>] Optional fields to include in the response. (default: all fields are returned)
-    # @return [Hash] The API response containing organization devices.
-    #
-    # See: https://developer.apple.com/documentation/applebusinessmanagerapi/get-org-devices
-    def org_devices(limit: 100, paginate: false, fields: [])
-      get('v1/orgDevices', limit:, paginate:, fields:)
-    end
   end
 end

data/lib/axm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Axm
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: axm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - nick-f
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Gem to interact with the Apple Business Manager/Apple School Manager API