kandji 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b139dcc224da457e0570035886561f9a16445dcceb5eb87cd777f673897c0ad5
-  data.tar.gz: 290e44ba2e0e871ef2d9a8d33958e355208bbd65a5752b56f561bd1a757c7d03
+  metadata.gz: 528755a882fcf3d4e1f739f3d5aeb050eeccb82078925308eaae01fe47cdf041
+  data.tar.gz: 5ade57831d6f73d679f03ef2f8ea3dcc4b8512a2d5ea7fa4d456f19b308ef395
 SHA512:
-  metadata.gz: 122742faf6495903b7174a671c781dc9ec310f83b6763c073e1d65defc2a7f239b861edc69fb42530bc1ef4b3bae6a506a0d0ab933b560d428a5e68269a6ba38
-  data.tar.gz: 7471b5ddfd673a942f19369aa8be1ff3cf55fb5b222ee2bbbbd1cd89af24e2d541f65c6228fc7b0dc6c86f66303a6f55b6042664f411123b008aabe739a5c75c
+  metadata.gz: cf06423f2138261895b74dc7c17c7407783c2a9a739fa013b32cd69d248657709a918bc14441b993db6af9ecbc31b987d57ff05874abbe5cbf52e050971b5243
+  data.tar.gz: cac4df83de21b0b546bd5960456992d250de0a5844d85b658c70015cd6ad67e6de21723cd560ed46b03b5e7043bd04bcf27f1e8a7735273e803c69a927ba820a

data/CHANGELOG.md

@@ -1,11 +1,16 @@
-## [Unreleased]
+## [0.1.1]
 
-- Setup configuration
 - Implement endpoints:
-  - Devices.all
-  - Devices.find(device_id)
-  - Device::Applications.all
+  - Devices::Activities.all
+  - Logs.all
+  - Users.all
+  - Users.find(id)
 
 ## [0.1.0] - 2025-05-06
 
 - Initial release
+- Setup configuration
+- Implement endpoints:
+  - Devices.all
+  - Devices.find(device_id)
+  - Device::Applications.all

data/README.md

@@ -1,28 +1,36 @@
 # Kandji
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kandji`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add kandji
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install kandji
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+First you will have to confige the gem. You need to setup an API key on Kandji. Once you've retrieved that, you are ready:
+
+```ruby
+Kandji.configure do |config|
+  config.api_token = 'your-api-token'
+  config.organization_url = 'your-kanjdi-api-url'
+end
+```
+
+Then once you have the client setup, you can call the API. Some examples:
+
+```ruby
+Kandji::Applications.all
+Kandji::Users.find(user_id)
+```
 
 ## Development
 
@@ -32,7 +40,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kandji. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/kandji/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/monarchmoney/kandji. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/monarchmoney/kandji/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +48,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Kandji project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kandji/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Kandji project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/monarchmoney/kandji/blob/main/CODE_OF_CONDUCT.md).

data/lib/kandji/client.rb

@@ -27,6 +27,20 @@ module Kandji
       all_results
     end
 
+    def self.paginated_cursor_get(path, params = {})
+      params[:limit] = params[:limit] || 500
+      url = build_url(path, params)
+
+      all_results = []
+      loop do
+        response = JSON.parse(RestClient.get(url, headers))
+        all_results.concat(response["results"])
+        url = response["next"]
+        break unless url
+      end
+      all_results
+    end
+
     def self.build_url(path, params)
       url = "#{Kandji.organization_url}/api/#{API_VERSION}/#{path}"
       url += "?#{URI.encode_www_form(params)}" unless params.empty?

data/lib/kandji/device/activities.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kandji
+  module Device
+    class Activities < Client
+      def self.all(device_id)
+        paginated_get("devices/#{device_id}/activity")
+      end
+    end
+  end
+end

data/lib/kandji/logs.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kandji
+  class Logs < Client
+    def self.all(params = {})
+      paginated_cursor_get("audit/events", params)
+    end
+  end
+end

data/lib/kandji/users.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kandji
+  class Users < Client
+    def self.all(params = {})
+      paginated_cursor_get("users", params)
+    end
+
+    def self.find(id)
+      get("users/#{id}")
+    end
+  end
+end

data/lib/kandji/version.rb

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

data/lib/kandji.rb

@@ -3,7 +3,11 @@
 require_relative "kandji/version"
 require_relative "kandji/configuration"
 require_relative "kandji/client"
-require_relative "kandji/api"
+require_relative "kandji/devices"
+require_relative "kandji/device/applications"
+require_relative "kandji/logs"
+require_relative "kandji/device/activities"
+require_relative "kandji/users"
 
 module Kandji
   extend Configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kandji
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lien Van Den Steen
@@ -52,11 +52,13 @@ files:
 - README.md
 - Rakefile
 - lib/kandji.rb
-- lib/kandji/api.rb
-- lib/kandji/api/device/applications.rb
-- lib/kandji/api/devices.rb
 - lib/kandji/client.rb
 - lib/kandji/configuration.rb
+- lib/kandji/device/activities.rb
+- lib/kandji/device/applications.rb
+- lib/kandji/devices.rb
+- lib/kandji/logs.rb
+- lib/kandji/users.rb
 - lib/kandji/version.rb
 - sig/kandji.rbs
 homepage: https://github.com/monarchmoney/kandji

data/lib/kandji/api.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "api/devices"
-require_relative "api/device/applications"