axm 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647f814737c960878d73525988b5478ba70806d283e52384e8e511483a2410ae
-  data.tar.gz: d1825207bf7ecf99a24bb62da4dc6c15aba43e110f2b4a63462e4a794a21d2cf
+  metadata.gz: 02ec17dcd1e6762bebf731dd97394f9fe87c75be604baed827f34106482d0caf
+  data.tar.gz: 4b480339114ab452ed36ce63ae9b843a95e548f5ccc38de034c4d85eb331e674
 SHA512:
-  metadata.gz: '019c72d25c2de0cbfd4996ed555c1cb58507be75548ce7df1dbcf9dc99a737371c34728532013599428ee7316aa2f69a1a0c3a829729be6a2f37d8ce172f5dae'
-  data.tar.gz: 46f9235329a51fccf772b3b8d8403f7e9ccb8f20e5d046f42e3e1a79f9ef160583164e806339451b1d3fbc039bcbc36589947cf8e05e0b8160c8d909ca693fbd
+  metadata.gz: 28c69e287d78e9b120a75a3092294b1a7526d9b41301869c04c96921066dc34440423e28f06ccca208396dd24f98a5d460c5ab0c1e32e89ccbebb4f4ded09317
+  data.tar.gz: 0bfd98852076b669c53f02c3ddbcbdc3e60a1958125e2ef9d66af2ab8ec11207451245fd9fabe123583c24996703bb977990cba1e001950b5323696db38820d9

data/README.md

@@ -4,6 +4,46 @@ 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')
+issuer_id = 'your_issuer_id'
+key_id = 'your_key_id'
+
+client = Axm::Client.new(private_key:, issuer_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.

data/lib/axm/client.rb

@@ -95,7 +95,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 +152,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.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: axm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 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