ninjaone 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2d9edce18fc48c11d1eee0a7d87d4e3d23f3622c54d522495181f50f2004bb3
-  data.tar.gz: a99415651e31f4616c478871acc3539abdcc16d452f372a366cdc321be9ed939
+  metadata.gz: 69cf374dfc56664fdbbc61533fcffbc84cc8f378cc422641be286b5740d04d8f
+  data.tar.gz: e4f573f19bb88b7173a035622e65a86119ca20276806fa4df2ce40d2752adc29
 SHA512:
-  metadata.gz: 13fe05ba9d907d7ebb217cdd79dd890e008a5805319e2de4bbcaba6a28d8f5a8f33cbed562f36797d081f823006553bbbdb4815a119a0678461b2b89bfaa5d5e
-  data.tar.gz: 4481305a4e29b2dc3e3043e05a383225790f0c745d10efcfbe5dc06368e34b5a3d0e7fed9c43c469dd27304276f6ed25f496cfafdce317c2b65c00ba36377bbb
+  metadata.gz: '0090ba275e371d7064dee5ca2f432eb239ef6d31aa0aba63849c740834cc0c2cb6456d4d7f588a99475cb9ffa1add1c1349973b61c6c34e5ae3a90ae95b2966f'
+  data.tar.gz: 7d07158ecb6ab23ea23587453dfdadaf35df8906c8f5fbefa0c51e220782a866955338ca4dd849e9b49142dfd6c0f428859f60fe8ead3b401c072354489d97e2

data/CHANGELOG.md

@@ -8,3 +8,7 @@
 
 - Added backup and devices api group
 
+## [0.2.1] - 2026-1-16
+
+- Simplify api endpoint definition
+

data/README.md

@@ -66,7 +66,7 @@ client.login
 
 |Resource|API endpoint|
 |:--|:--|
-|.auth_token or .login|https://app.ninjarmm.com/apidocs/?links.active=authorization|
+|`login`|https://app.ninjarmm.com/apidocs/?links.active=authorization|
 
 ### System
 
@@ -78,29 +78,29 @@ subscriptions = client.subscriptions
 
 |Resource|API endpoint|
 |:--|:--|
-|contacts, contact(id)|List contact and get contact details|
-|organizations|list organizations|
-|policies|list policies|
-|jobs|list active jobs|
-|activities|list activities|
-|alerts|List active alerts (triggered conditions)|
-|automation_scripts|List available automation scripts|
-|device_custom_fields|List device custom fields|
-|devices|List devices|
-|devices_detailed|List devices(deatiled)|
-|enabled_notification_channels|List enabled notification channels|
-|notification_channels|List all notification channels|
-|notification_channels_detailed|List all notification channels detailed|
-|groups|List all groups (saved searches)|
-|locations|List all locations|
-|roles|List device roles|
-|tasks|List scheduled tasks|
-|software_products|List supported 3rd party software|
-|users|List users|
-|search_devices(query_string)|Find devices|
-|user_end_users|End user list|
-|user_technicians|Technicians list|
-|user_roles|Get user roles|
+|`contacts`, `contact(id)`|List contact and get contact details|
+|`organizations`|list organizations|
+|`policies`|list policies|
+|`jobs`|list active jobs|
+|`activities`|list activities|
+|`alerts`|List active alerts (triggered conditions)|
+|`automation_scripts`|List available automation scripts|
+|`device_custom_fields`|List device custom fields|
+|`devices`|List devices|
+|`devices_detailed`|List devices(deatiled)|
+|`notification_channels_enabled`|List enabled notification channels|
+|`notification_channels`|List all notification channels|
+|`notification_channels_detailed`|List all notification channels detailed|
+|`groups`|List all groups (saved searches)|
+|`locations`|List all locations|
+|`roles`|List device roles|
+|`tasks`|List scheduled tasks|
+|`software_products`|List supported 3rd party software|
+|`users`|List users|
+|`search_devices(query_string)`|Find devices|
+|`user_end_users`|End user list|
+|`user_technicians`|Technicians list|
+|`user_roles`|Get user roles|
 
 ### Organizations
 
@@ -114,13 +114,13 @@ org_devices = client.organization_devices(org.id)
 
 |Resource|API endpoint|
 |:--|:--|
-|.organizations,.organization(id)|List organizations or get one by id|
-|.organization_locations(id)|Organization locations|
-|.organization_end_users(id)|List users|
-|.organization_custom_fields(id)|Organization custom fields|
-|.organization_devices(id)|Organization devices|
-|.organization_locations_backup_usage(id)|Organization location backup usage|
-|.organization_backup_usage_by_location(id, location_id)|Organization locations backup usage|
+|`organizations`,`organization(id)`|List organizations or get one by id|
+|`organization_locations(id)`|Organization locations|
+|`organization_end_users(id)`|List users|
+|`organization_custom_fields(id)`|Organization custom fields|
+|`organization_devices(id)`|Organization devices|
+|`organization_locations_backup_usage(id)`|Organization location backup usage|
+|`organization_backup_usage_by_location(id, location_id)`|Organization locations backup usage|
 
 ### Backup
 

data/lib/ninjaone/client/backup.rb

@@ -6,32 +6,10 @@ module NinjaOne
     #
     # @see https://app.ninjarmm.com/apidocs/?links.active=core#/Backup Ninja One Developer Documentation - Backup section
     module Backup
-      # Dynamically defines methods for interacting with NinjaOne API resources.
-      #
-      # Depending on the arguments, this will define methods to:
-      # - Fetch all records for a resource
-      # - Fetch a specific record by ID
-      #
-      # @param method [Symbol] The method name for fetching all records.
-      # @param path [String] The API path for the resource. Defaults to the method name.
-      #
-      # @example Defining endpoints
-      #   api_endpoint :companies, :company
-      #   # Defines:
-      #   # - `companies(params = {})` to fetch all companies.
-      #   # - `company(id, params = {})` to fetch a single company by ID.
-      def self.backup_endpoint(method, path = method.to_s.tr('_', '-'))
-        # Define method to fetch all records
-        send(:define_method, method) do |params = {}|
-          results = get(api_url(path), params)
-          results.results
-        end
-      end
 
       # Backup endpoints (GET)
-      backup_endpoint(:backup_jobs, 'backup/jobs')
-      backup_endpoint(:backup_integrity_check_jobs, 'backup/integrity-check-jobs')
-
+      Client::define_endpoint('backup/jobs')
+      Client::define_endpoint('backup/integrity-check-jobs')
     end
   end
 end

data/lib/ninjaone/client/devices.rb

@@ -6,43 +6,8 @@ module NinjaOne
     #
     # @see https://app.ninjarmm.com/apidocs/?links.active=core#/Devices Ninja One Developer Documentation - Device section
     module Devices
-      # Defines a device-specific API endpoint method dynamically.
-      #
-      # This helper creates instance methods in the form of:
-      #   device_<method>(id, params = {})
-      #
-      # Example:
-      #   device_endpoint(:jobs)
-      #   # => defines #device_jobs(id, params = {})
-      #
-      # @param method [Symbol]
-      #   The method name suffix to generate (e.g., :jobs, :alerts).
-      #
-      # @param path [String]
-      #   The API path segment. Defaults to the method name with
-      #   underscores replaced by hyphens.
-      #
-      # @return [void]
-      def self.device_endpoint(method, path = method.to_s.tr('_', '-'))
-        # Define method to fetch all records for device
-        send(:define_method, "device_#{method}") do |id, params = {}|
-          get(api_url("device/#{id}/#{path}"), params)
-        end
-      end
 
-      # Retrieves a single device by ID.
-      #
-      # @param id [Integer, String]
-      #   The NinjaOne device ID.
-      #
-      # @param params [Hash, nil]
-      #   Optional query parameters.
-      #
-      # @return [Hash]
-      #   The device details returned by the API.
-      def device(id, params = nil)
-        get(api_url("device/#{id}"), params)
-      end
+      Client::define_endpoint(:device, '')
 
       # Device-related GET endpoints.
       #
@@ -54,10 +19,10 @@ module NinjaOne
       #   device_activities(123, since: '2026-01-01T00:00:00Z')
       #
       [:jobs, :activities, :alerts, :disks, :processors, :software, :volumes, :windows_services, :custom_fields,
-       :os_patch_installs, :software_patch_installs, :last_logged_on_user, :network_interfaces, :os_patches, :software_patches].each do |m|
-        device_endpoint(m)
+       :os_patch_installs, :software_patch_installs, :last_logged_on_user, :network_interfaces, :os_patches, :software_patches].each do |resource|
+        Client::define_endpoint(:device, resource.to_s.gsub('_','-'))
       end
-      device_endpoint(:policy_overrides, 'policy/overrides')
+      Client::define_endpoint(:device, 'policy/overrides')
     end
   end
 end

data/lib/ninjaone/client/organizations.rb

@@ -6,41 +6,18 @@ module NinjaOne
     #
     # @see https://app.ninjarmm.com/apidocs/?links.active=core#/organization Ninja One Developer Documentation
     module Organizations
-      # Dynamically defines methods for interacting with NinjaOne API resources.
-      #
-      # Depending on the arguments, this will define methods to:
-      # - Fetch all records for a resource
-      # - Fetch a specific record by ID
-      #
-      # @param method [Symbol] The method name for fetching all records.
-      # @param singular_method [Symbol, nil] The method name for fetching a single record by ID. Optional.
-      # @param path [String] The API path for the resource. Defaults to the method name.
-      #
-      # @example Defining endpoints
-      #   api_endpoint :companies, :company
-      #   # Defines:
-      #   # - `companies(params = {})` to fetch all companies.
-      #   # - `company(id, params = {})` to fetch a single company by ID.
-      def self.api_endpoint_suffix(method, suffix)
-        # Define method to fetch a single record by ID
-        name = "#{method}_#{suffix.gsub(/[-\/]/,'_')}"
 
-        send(:define_method, name) do |id, params = {}|
-          get(api_url("#{method}/#{id}/#{suffix}"), params)
-        end
-      end
-
-      api_endpoint_suffix(:organization, 'locations')
-      api_endpoint_suffix(:organization, 'end-users')
-      api_endpoint_suffix(:organization, 'custom-fields')
-      api_endpoint_suffix(:organization, 'devices')
-      api_endpoint_suffix(:organization, 'locations/backup/usage')
+      Client::define_endpoint(:organization, 'locations')
+      Client::define_endpoint(:organization, 'end-users')
+      Client::define_endpoint(:organization, 'custom-fields')
+      Client::define_endpoint(:organization, 'devices')
+      Client::define_endpoint(:organization, 'locations/backup/usage')
 
       # Returns a location backup usage
       def organization_backup_usage_by_location(id, location_id, params={})
         get(api_url("organization/#{id}/locations/#{location_id}/backup/usage"), params)
       rescue Faraday::ServerError
-        # it looks like a server error is thrown when no backup is available; fake it by returning anempty array
+        # it looks like a server error is thrown when no backup is available; fake it by returning an empty array
         []
       end
     end

data/lib/ninjaone/client/system.rb

@@ -7,28 +7,30 @@ module NinjaOne
     # @see https://app.ninjarmm.com/apidocs/?links.active=core#/system Ninja One Developer Documentation
     module System
 
-      Client::api_endpoint(:contacts, :contact)
-      Client::api_endpoint(:organizations,:organization)
-      Client::api_endpoint(:organizations_detailed)
-      Client::api_endpoint(:policies)
-      Client::api_endpoint(:jobs)
-      Client::api_endpoint(:activities)
-      Client::api_endpoint(:alerts)
-      Client::api_endpoint(:automation_scripts, nil, 'automation/scripts')
-      Client::api_endpoint(:devices)
-      Client::api_endpoint(:devices_detailed)
-      Client::api_endpoint(:enabled_notification_channels, nil, 'notification-channels/enabled')
-      Client::api_endpoint(:notification_channels)
-      Client::api_endpoint(:groups)
-      Client::api_endpoint(:locations)
-      Client::api_endpoint(:roles)
-      Client::api_endpoint(:tasks)
-      Client::api_endpoint(:software_products)
-      Client::api_endpoint(:users)
-      Client::api_endpoint(:user_end_users, nil, 'user/end-users')
-      Client::api_endpoint(:user_roles, nil, 'user/roles')
-      Client::api_endpoint(:user_technicians, nil, 'user/technicians')
-      Client::api_endpoint(:devices_search, nil, 'devices/search')
+      Client::define_endpoint(:contacts)
+      Client::define_endpoint(:contact, '')
+      Client::define_endpoint(:organizations)
+      Client::define_endpoint(:organization, '')
+      Client::define_endpoint('organizations-detailed')
+      Client::define_endpoint(:policies)
+      Client::define_endpoint(:jobs)
+      Client::define_endpoint(:activities)
+      Client::define_endpoint(:alerts)
+      Client::define_endpoint('automation/scripts')
+      Client::define_endpoint(:devices)
+      Client::define_endpoint('devices-detailed')
+      Client::define_endpoint('notification-channels/enabled')
+      Client::define_endpoint('notification-channels')
+      Client::define_endpoint(:groups)
+      Client::define_endpoint(:locations)
+      Client::define_endpoint(:roles)
+      Client::define_endpoint(:tasks)
+      Client::define_endpoint('software-products')
+      Client::define_endpoint(:users)
+      Client::define_endpoint('user/end-users')
+      Client::define_endpoint('user/roles')
+      Client::define_endpoint('user/technicians')
+      Client::define_endpoint('devices/search')
       
       def search_devices(query_string, options={})
         devices_search(options.merge({q:query_string}))

data/lib/ninjaone/client.rb

@@ -9,34 +9,50 @@ module NinjaOne
   # @note All methods are grouped in separate modules for better organization and follow the structure provided in the official API documentation.
   # @see https://developers.skykick.com/Guides/Authentication
   class Client < API
+
+    # Constructs url resource name from url path
+    #
+    # @param path [String] Resource name
+    # @return [String] translated from /- to  _
+    def self.resource_to_name(path)
+      path.to_s.gsub(/[-\/]/,'_')
+    end
+
     # Dynamically defines methods for interacting with NinjaOne API resources.
     #
     # Depending on the arguments, this will define methods to:
-    # - Fetch all records for a resource
-    # - Fetch a specific record by ID
+    # - Fetch all records for the given scope
+    # - Fetch a resource specific record by ID
+    #
+    # @param scope [Symbol] The method name for fetching all records.
+    # @param resource [String] If given, fetches all records for scope by id. If empty string, it will load single scope record
     #
-    # @param method [Symbol] The method name for fetching all records.
-    # @param singular_method [Symbol, nil] The method name for fetching a single record by ID. Optional.
-    # @param path [String] The API path for the resource. Defaults to the method name.
+    # Paging is not supported.
     #
     # @example Defining endpoints
     #   api_endpoint :companies, :company
     #   # Defines:
     #   # - `companies(params = {})` to fetch all companies.
     #   # - `company(id, params = {})` to fetch a single company by ID.
-    def self.api_endpoint(method, singular_method = nil, path = method.to_s.tr('_', '-'))
-      # Define method to fetch all records
-      send(:define_method, method) do |params = {}|
-        get_paged(api_url(path), params)
-      end
-      # Define method to fetch a single record by ID
-      if singular_method
-        send(:define_method, singular_method) do |id, params = {}|
-          get(api_url("#{singular_method}/#{id}"), params)
+    def self.define_endpoint(scope, resource = nil)
+      if resource
+        name = self.resource_to_name(scope)
+        name = "#{name}_#{self.resource_to_name(resource)}" if resource && !resource.empty?
+        # change to nil if resource is empty so we ar eable to generate /scope/id/resource
+        # but also /scope/id without training / 
+        resource = resource&.empty? ? nil : resource
+        send(:define_method, name) do |id, params = {}|
+          get(api_url([scope, id, resource].compact.join('/')), params)
+        end
+      else
+        name = self.resource_to_name(scope)
+        send(:define_method, name) do |params = {}|
+          get(api_url(scope), params)
         end
       end
     end
 
+
     # Dynamically require all files in the `client` directory.
     # This will load additional API modules as separate files for better modularity and code organization.
     Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
@@ -56,6 +72,5 @@ module NinjaOne
     def api_url(path)
       "/v2/#{path}"
     end
-
   end
 end

data/lib/ninjaone/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NinjaOne
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ninjaone
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Janco Tanis
 bindir: exe
 cert_chain: []
-date: 2026-01-15 00:00:00.000000000 Z
+date: 2026-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday