JamfReports 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a38bd8791ce0cc7a828f3d99301e9bc3c263e2e94ddebd7396da49de534c43
-  data.tar.gz: 52e54858b28f7d94695007554123401e26c9ff3dd7fc83de20a06ba350f96adc
+  metadata.gz: 36bfc7c47df15153e367ff9f91e65fde6e597c9a75bf493a9d8934369d2242dd
+  data.tar.gz: 6dac11a44c6825c79202c044b19d8d745a7427c0ddcdde9d51b349dae14f384d
 SHA512:
-  metadata.gz: 07e344536853fca76d8b07ae166cff9dccae9c5d3acca87045569b9244662d878f34d11cbfbde0ce87e363cc1be21a39ea58f73d7cb59507c92da08498f239e2
-  data.tar.gz: 6d1c9e64d051340b8702bd7e5fb1aae7106fda7f02c349929807a7e92e5c681a10b7540f06ecb30a7401ba7c65f7e1e0189ad1bfebd1396a9a3614ef48f16daf
+  metadata.gz: 7374ba89f88a305014d16a8709064e3a60e9865e47a200931331d933a6557ae67c58039d843ea3cdfe27780473afc60e0b17c2ef0128304a442aeb432106ea02
+  data.tar.gz: 344c87ab2ca1469792ac9f991944c2ef32fbb62156c71e637ae20859f47937bfdc5ffa0af21560cd7703054dcf808c86de9fc1e7b0bd54e2b9f72768f3b20585

data/CHANGELOG.md

@@ -1,6 +1,16 @@
+## 0.2.2
+- Fixed: Documentation updates
 
-## 0.1.1 (2023.06.28)
-- Update: update module syntax
 
-## 0.1.0 (2023.06.28)
+## 0.2.1
+- Fixed: Issue with getting current user
+
+
+## 0.2.0
+- Add: Option for `listAllInstalledApps_exporttocsv` that exports the results to the users desktop as a csv file named `Installed Applications Report.csv`
+
+## 0.1.1
+- Update: Update module syntax
+
+## 0.1.0
 - Initial Build

data/JamfReports.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["nls.inbox@gmail.com"]
 
   spec.summary       = %q{A gem that uses the Jamf Pro API to generate reports for hosted Jamf Pro instance}
-  spec.homepage      = "https://github.com/nlscott/marshmallow"
+  spec.homepage      = "https://github.com/nlscott/JamfReports"
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.

data/README.md

@@ -1,9 +1,12 @@
 # JamfReports
 
-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/JamfReports`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Summary
 
-TODO: Delete this and the text above, and describe your gem
+JamfReports is a ruby gem that uses the Jamf Pro API for hosted instances. Currently, it only reports on Applications. Pulling from the `/api/v1/computers-inventory?section=APPLICATIONS` endpoint.
 
+Future reports may be added.
+
+---
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,20 +23,109 @@ Or install it yourself as:
 
     $ gem install JamfReports
 
+---
 ## Usage
 
-TODO: Write usage instructions here
+In order to run JamfReports, you are required to add these two lines to the top of your file, under the require `JamfReports` line
+
+```ruby
+#!/usr/bin/ruby
+require "JamfReports"
+
+## UPDATE THESE VARIABLES ------------------------------------------------------
+$jamfpro_url = "https://company.jamfcloud.com" 
+$api_pw = "Your API KEY HERE"
+```
+
+ If you don't have your api key for the `$api_pw` variable, run this command to create it and paste it into the variable.
+
+```bash
+printf "jamfUserName:JamfPassword" | iconv -t ISO-8859-1 | base64 -i -
+```
+
+
+
+And these 3 lines to generate the api token and pull the data from Jamf so you can run the report commands.
+
+```ruby
+JamfReports.getToken
+JamfReports.checkTokenExpiration
+JamfReports.getAllApplicationInventory
+```
+
+A full working file might look like this.
+
+```ruby
+#!/usr/bin/ruby
+require "JamfReports"
+
+## UPDATE THESE VARIABLES ------------------------------------------------------
+$jamfpro_url = "https://company.jamfcloud.com" 
+$api_pw = "Your API KEY HERE"
+
+## COMMANDS --------------------------------------------------------------------
+JamfReports.getToken
+JamfReports.checkTokenExpiration
+JamfReports.getAllApplicationInventory
+
+## REPORTS --------------------------------------------------------------------
+JamfReports.listAllInstalledApps
+# JamfReports.webBrowserReport
+# JamfReports.totalNumberOfOneInstalledApps
+# JamfReports.listofOneInstallApps
+
+## After reporting, revoke current token
+JamfReports.invalidateToken
+```
+
+
+---
+## Examples
+
+#### listAllInstalledApps
+
+![listAllInstalledApps](images/listAllInstalledApps.png)
+
+Returns a sorted list of all apps installed across your fleet of computers in Jamf. Sorted from most installed app, to least.
+
+#### webBrowserReport
+![webBrowserReport](images/webBrowserReport.png)
+Returns a list of installed web browsers. Current browsers searched are:
+- Google Chrome.app
+- Google Chrome Canary.app
+- Firefox.app
+- Firefox Developer Edition.app
+- Safari.app
+- Safari Technology Preview.app
+- Microsoft Edge.app
+- Brave Browser.app
+- Arc.app
+- Opera.app
+- LinCastor Browser.app
+- LockDown Browser.app
+- Tor Browser.app
+- Vivaldi.app
+- DuckDuckGo.app
+
+#### totalNumberOfOneInstalledApps
+![totalNumberOfOneInstalledApps](images/totalNumberOfOneInstalledApps.png)
+Returns a single metric to show the number of "One-off" or single installed apps across your fleet.
+
+#### listofOneInstallApps
+![listofOneInstallApps](images/listofOneInstallApps.png)
+
+Returns a list of all the "One-off" or single installed apps across your fleet. This can be helpful in scoping in Jamf uninstall policies.
+
 
-## Development
+#### listAllInstalledApps_exporttocsv
+![listAllInstalledApps_exporttocsv](images/listAllInstalledApps_exporttocsv.png)
+Using `JamfReports.listAllInstalledApps_exporttocsv` exports the results to the users desktop as a csv file named `Installed Applications Report.csv`
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/JamfReports.
 
+---
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/JamfReports/version.rb

@@ -1,3 +1,3 @@
 module JamfReports
-  VERSION = "0.1.1"
+  VERSION = "0.2.2"
 end

data/lib/JamfReports.rb

@@ -1,5 +1,6 @@
 require "JamfReports/version"
 require "uri"
+require 'etc'
 require "json"
 require "time"
 require "net/http"
@@ -149,5 +150,17 @@ module JamfReports
             end
         end
     end
+
+    def self.listAllInstalledApps_exporttocsv
+        $currentUser=Etc.getlogin
+        reportName="Installed Applications Report"
+        $reportPath="/Users/#{$currentUser}/Desktop/#{reportName}.csv"
+        File.write("#{$reportPath}", "name,count\n")
+        
+        $applicationHash.sort_by {|_key, value| value}.reverse.each do |k,v|
+            open("#{$reportPath}", "a") { |f| f << "#{k},#{v}\n" } 
+        end
+    end
+
     
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: JamfReports
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - nic scott
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,9 +53,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/listAllInstalledApps.png
+- images/listAllInstalledApps_exporttocsv.png
+- images/listofOneInstallApps.png
+- images/totalNumberOfOneInstalledApps.png
+- images/webBrowserReport.png
 - lib/JamfReports.rb
 - lib/JamfReports/version.rb
-homepage: https://github.com/nlscott/marshmallow
+homepage: https://github.com/nlscott/JamfReports
 licenses:
 - MIT
 metadata: {}