RubyGems - ruby-miradore - Versions diffs - 1.0.0 → 1.1.0 - Mend

ruby-miradore 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

checksums.yaml +4 -4
data/.rubocop.yml +1 -0
data/Gemfile +2 -2
data/Gemfile.lock +6 -1
data/fixtures/vcr_cassettes/InvDevice.yml +52 -0
data/fixtures/vcr_cassettes/all_criteria.yml +70 -0
data/fixtures/vcr_cassettes/search_by_serial_number.yml +59 -0
data/lib/ruby/miradore.rb +19 -28
data/lib/ruby/miradore/version.rb +1 -1
metadata +8 -5

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbe3675a437a4f1a7db9f1970b5ffff9f49d7767f8f074212b1d4c115bb4a352
-  data.tar.gz: d62031266909082c468a35bd316c642f46c7342bb788283aee194f13cc21c4a0
+  metadata.gz: 0a0d9f16881d0084b790f716f147d30a6c83ccd5e61c41aac6c3f4de3d5b9011
+  data.tar.gz: c1df3a2b189804ce4786bde6d7642560b84c337fa363a8de619815f4b8eb2deb
 SHA512:
-  metadata.gz: 391f48e2cf12a8837494506f3badf713fa7c0ad27f3b29b67cedaa9f4cfcbea98f43d70cfa7bd810f9ab7526de9982b7139b77375dec7115d18b7b5b558b5e14
-  data.tar.gz: a6c04e0cc89456c175855c73cbde0f7f6b172193fc612b828ae93dbf656c921f7ff41fe33cc72a2dec7708bbe2ac365620f0db28c4a6569cf53bd37d71c848b1
+  metadata.gz: ea9c4d455b6f4c17a5bc5c8145814e0d56b44353df5e74a2bef1179491c48dad7772b61ecac59af134b528b530493c86279ea1078ce3681e5af909cb583b4ffc
+  data.tar.gz: 23f81ab6559b89e6728ff29b228fd514a489a843819dc1482d8f9f67eacccb3e6c83c5f3b81296d9079bf77a5b99db84c1d951b565bd97978a428e4922dcb9f7

data/.rubocop.yml CHANGED Viewed

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.7.3
+  NewCops: disable
 Style/StringLiterals:
   Enabled: true

data/Gemfile CHANGED Viewed

@@ -6,6 +6,6 @@ source "https://rubygems.org"
 gemspec
 group :test do
-  gem "webmock"
   gem "vcr"
-end
+  gem "webmock"
+end

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-miradore (1.0.0)
+    ruby-miradore (1.1.0)
       crack (~> 0.4.5)
       finest-builder (~> 0.0.4)
       httparty (~> 0.18.1)
@@ -17,6 +17,9 @@ GEM
     ast (2.4.2)
     crack (0.4.5)
       rexml
+    debase (2.3.2)
+      debase-ruby_core_source (~> 0.10.11)
+    debase-ruby_core_source (0.10.11)
     diff-lcs (1.4.4)
     finest-builder (0.0.5)
     hashdiff (1.0.1)
@@ -72,6 +75,8 @@ PLATFORMS
   x86_64-linux
 DEPENDENCIES
+  debase
+  debase-ruby_core_source
   ruby-miradore!
   vcr
   webmock

data/fixtures/vcr_cassettes/InvDevice.yml ADDED Viewed

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://rzilient.online.miradore.com/API/Device?auth=&filters=&select=ID,InvDevice.*
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Type:
+      - text/xml
+      Expires:
+      - "-1"
+      Server:
+      - Microsoft-IIS/10.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      X-Frame-Options:
+      - SAMEORIGIN
+      Date:
+      - Wed, 12 May 2021 14:31:33 GMT
+      Content-Length:
+      - '1165'
+    body:
+      encoding: UTF-8
+      string: '<?xml version="1.0" encoding="utf-8"?><Content><Items count="2"><Device><ID>1</ID><InvDevice><Model>Apple
+        iPhone9,3</Model><Manufacturer>Apple</Manufacturer><ProductName>iPhone9,3</ProductName><SoftwareVersion>iOS
+        14.4.2</SoftwareVersion><SerialNumber>C76TLUEMHG7F</SerialNumber><IMEI>355332088433360</IMEI><WiFiMAC>d4:dc:cd:d6:09:be</WiFiMAC><BluetoothMAC>d4:dc:cd:d6:09:e1</BluetoothMAC><UDID>84c87a9edf0c577227b96dcbe7bf45713c358ede</UDID><StoreAccountActive>True</StoreAccountActive><DoNotDisturbActive>True</DoNotDisturbActive><DeviceType>MN8X2QL</DeviceType><EASIdentifier>LU1R1J5V0H73JCTEJ2A732LI8G</EASIdentifier><DeviceName>iPhone
+        de: Eduard</DeviceName><InventoryTime>11.05.2021 22:04:19</InventoryTime></InvDevice></Device><Device><ID>2</ID><InvDevice><Model>ASUSTeK
+        COMPUTER INC. VivoBook_ASUSLaptop X712FA_X712FA</Model><Manufacturer>ASUSTeK
+        COMPUTER INC.</Manufacturer><ProductName>VivoBook_ASUSLaptop X712FA_X712FA</ProductName><SoftwareVersion>Windows
+        10 Home (20H2)</SoftwareVersion><SerialNumber>K8N0CV07315233B</SerialNumber><DeviceName>QUENTIN</DeviceName><InventoryTime>12.05.2021
+        12:30:16</InventoryTime></InvDevice></Device></Items></Content>'
+  recorded_at: Wed, 12 May 2021 14:31:34 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/all_criteria.yml ADDED Viewed

@@ -0,0 +1,70 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://rzilient.online.miradore.com/API/Device?auth=&filters=&select=*,Category.*,InvDevice.*,InvStorage.*,InvOS.*,Enrollment.*,Client.*,User.*,Location.*,Security.*,ReportedLocation.*
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Type:
+      - text/xml
+      Expires:
+      - "-1"
+      Server:
+      - Microsoft-IIS/10.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      X-Frame-Options:
+      - SAMEORIGIN
+      Date:
+      - Wed, 12 May 2021 14:00:01 GMT
+      Content-Length:
+      - '4612'
+    body:
+      encoding: UTF-8
+      string: '<?xml version="1.0" encoding="utf-8"?><Content><Items count="2"><Device><ID>1</ID><User><ID>2</ID><Email>edugarcas@gmail.com</Email><Source>GUI</Source><Status>Active</Status><Created>22.04.2021
+        06:32:00</Created><Modified>22.04.2021 06:32:00</Modified></User><Category><ID>1</ID><Name>Smartphone</Name></Category><Enrollment><ID>5</ID><User><ID>2</ID></User><Created>22.04.2021
+        06:32:00</Created><Completed>22.04.2021 06:33:20</Completed><Type>Email</Type><Sender>eduard@rzilient.club</Sender></Enrollment><OnlineStatus>Active</OnlineStatus><LastReported>12.05.2021
+        12:25:30</LastReported><LastReportedDays>0</LastReportedDays><LastReportedHours>2</LastReportedHours><LastReportedMinutes>95</LastReportedMinutes><IPAddress>31.4.148.80</IPAddress><MACAddress>d4:dc:cd:d6:09:be</MACAddress><Platform>iOS</Platform><Client><ID>1</ID><ManagementType>iOSUnsupervised</ManagementType></Client><ConfigProfileDeployments><ConfigProfileDeployment><ID>1</ID><ConfigProfile><ID>5</ID></ConfigProfile></ConfigProfileDeployment><ConfigProfileDeployment><ID>2</ID><ConfigProfile><ID>6</ID></ConfigProfile></ConfigProfileDeployment></ConfigProfileDeployments><OSVersionName>iOS
+        14.4.2</OSVersionName><Status>AutoGenerated</Status><Created>22.04.2021 06:33:20</Created><Modified>27.04.2021
+        09:20:21</Modified><Source>MiradoreOnline</Source><InvDevice><Model>Apple
+        iPhone9,3</Model><Manufacturer>Apple</Manufacturer><ProductName>iPhone9,3</ProductName><SoftwareVersion>iOS
+        14.4.2</SoftwareVersion><SerialNumber>C76TLUEMHG7F</SerialNumber><IMEI>355332088433360</IMEI><WiFiMAC>d4:dc:cd:d6:09:be</WiFiMAC><BluetoothMAC>d4:dc:cd:d6:09:e1</BluetoothMAC><UDID>84c87a9edf0c577227b96dcbe7bf45713c358ede</UDID><StoreAccountActive>True</StoreAccountActive><DoNotDisturbActive>True</DoNotDisturbActive><DeviceType>MN8X2QL</DeviceType><EASIdentifier>LU1R1J5V0H73JCTEJ2A732LI8G</EASIdentifier><DeviceName>iPhone
+        de: Eduard</DeviceName><InventoryTime>11.05.2021 22:04:19</InventoryTime></InvDevice><InvStorages><InvStorage><Type>Internal</Type><FreeSpace>16347488304</FreeSpace><TotalSpace>34359738368</TotalSpace><InventoryTime>11.05.2021
+        22:04:19</InventoryTime></InvStorage></InvStorages><InvOS><Platform>iOS</Platform><Version>14.4.2</Version><Build>18D70</Build><InventoryTime>11.05.2021
+        22:04:19</InventoryTime></InvOS><Security><PasscodeSet>Yes</PasscodeSet><EncryptionStatus>Enabled</EncryptionStatus></Security><ReportedLocation><Latitude>41.39850887104272</Latitude><Longitude>2.163043615588689</Longitude><Provider>Unknown</Provider><FixTime>29.04.2021
+        13:55:02</FixTime><InventoryTime>29.04.2021 13:55:20</InventoryTime></ReportedLocation></Device><Device><ID>2</ID><User><ID>3</ID><Name>de
+        Lambert Quentin</Name><Email>quentin@rzilient.club</Email><Firstname>Quentin</Firstname><Lastname>de
+        Lambert</Lastname><Source>GUI</Source><Status>Active</Status><Created>22.04.2021
+        06:51:53</Created><Modified>22.04.2021 06:51:53</Modified></User><Enrollment><ID>9</ID><User><ID>3</ID></User><Created>29.04.2021
+        12:22:31</Created><Completed>29.04.2021 13:01:04</Completed><Type>Email</Type><Sender>eduard@rzilient.club</Sender></Enrollment><OnlineStatus>Active</OnlineStatus><LastReported>12.05.2021
+        12:30:15</LastReported><LastReportedDays>0</LastReportedDays><LastReportedHours>2</LastReportedHours><LastReportedMinutes>90</LastReportedMinutes><IPAddress>37.223.114.163</IPAddress><MACAddress>DC:71:96:FB:8A:56</MACAddress><Platform>WindowsDesktop</Platform><Client><ID>2</ID><ManagementType>BuiltInMDM</ManagementType></Client><ConfigProfileDeployments
+        /><OSVersionName>Windows 10 Home (20H2)</OSVersionName><Status>AutoGenerated</Status><Created>29.04.2021
+        13:01:04</Created><Modified>29.04.2021 13:01:04</Modified><Source>MiradoreOnline</Source><InvDevice><Model>ASUSTeK
+        COMPUTER INC. VivoBook_ASUSLaptop X712FA_X712FA</Model><Manufacturer>ASUSTeK
+        COMPUTER INC.</Manufacturer><ProductName>VivoBook_ASUSLaptop X712FA_X712FA</ProductName><SoftwareVersion>Windows
+        10 Home (20H2)</SoftwareVersion><SerialNumber>K8N0CV07315233B</SerialNumber><DeviceName>QUENTIN</DeviceName><InventoryTime>12.05.2021
+        12:30:16</InventoryTime></InvDevice><InvStorages><InvStorage><Type>Internal</Type><Volume>C:
+        OS</Volume><FreeSpace>382347399168</FreeSpace><TotalSpace>511137091584</TotalSpace><InventoryTime>12.05.2021
+        12:30:16</InventoryTime></InvStorage></InvStorages><InvOS><Platform>WindowsDesktop</Platform><Version>10.0.19042.928</Version><Language>fr-FR</Language><InventoryTime>12.05.2021
+        12:30:16</InventoryTime></InvOS><Security><PasscodeSet>Unknown</PasscodeSet><EncryptionStatus>Disabled</EncryptionStatus></Security></Device></Items></Content>'
+  recorded_at: Wed, 12 May 2021 14:00:02 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/search_by_serial_number.yml ADDED Viewed

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://rzilient.online.miradore.com/API/Device?auth=&filters=(InvDevice.SerialNumber%20eq%20K8N0CV07315233B)&select=*,Category.*,InvDevice.*,InvStorage.*,InvOS.*,Enrollment.*,Client.*,User.*,Location.*,Security.*,ReportedLocation.*
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Type:
+      - text/xml
+      Expires:
+      - "-1"
+      Server:
+      - Microsoft-IIS/10.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      X-Frame-Options:
+      - SAMEORIGIN
+      Date:
+      - Wed, 12 May 2021 14:31:33 GMT
+      Content-Length:
+      - '2047'
+    body:
+      encoding: UTF-8
+      string: '<?xml version="1.0" encoding="utf-8"?><Content><Items count="1"><Device><ID>2</ID><User><ID>3</ID><Name>de
+        Lambert Quentin</Name><Email>quentin@rzilient.club</Email><Firstname>Quentin</Firstname><Lastname>de
+        Lambert</Lastname><Source>GUI</Source><Status>Active</Status><Created>22.04.2021
+        06:51:53</Created><Modified>22.04.2021 06:51:53</Modified></User><Enrollment><ID>9</ID><User><ID>3</ID></User><Created>29.04.2021
+        12:22:31</Created><Completed>29.04.2021 13:01:04</Completed><Type>Email</Type><Sender>eduard@rzilient.club</Sender></Enrollment><OnlineStatus>Active</OnlineStatus><LastReported>12.05.2021
+        12:30:15</LastReported><LastReportedDays>0</LastReportedDays><LastReportedHours>2</LastReportedHours><LastReportedMinutes>121</LastReportedMinutes><IPAddress>37.223.114.163</IPAddress><MACAddress>DC:71:96:FB:8A:56</MACAddress><Platform>WindowsDesktop</Platform><Client><ID>2</ID><ManagementType>BuiltInMDM</ManagementType></Client><ConfigProfileDeployments
+        /><OSVersionName>Windows 10 Home (20H2)</OSVersionName><Status>AutoGenerated</Status><Created>29.04.2021
+        13:01:04</Created><Modified>29.04.2021 13:01:04</Modified><Source>MiradoreOnline</Source><InvDevice><Model>ASUSTeK
+        COMPUTER INC. VivoBook_ASUSLaptop X712FA_X712FA</Model><Manufacturer>ASUSTeK
+        COMPUTER INC.</Manufacturer><ProductName>VivoBook_ASUSLaptop X712FA_X712FA</ProductName><SoftwareVersion>Windows
+        10 Home (20H2)</SoftwareVersion><SerialNumber>K8N0CV07315233B</SerialNumber><DeviceName>QUENTIN</DeviceName><InventoryTime>12.05.2021
+        12:30:16</InventoryTime></InvDevice><InvStorages><InvStorage><Type>Internal</Type><Volume>C:
+        OS</Volume><FreeSpace>382347399168</FreeSpace><TotalSpace>511137091584</TotalSpace><InventoryTime>12.05.2021
+        12:30:16</InventoryTime></InvStorage></InvStorages><InvOS><Platform>WindowsDesktop</Platform><Version>10.0.19042.928</Version><Language>fr-FR</Language><InventoryTime>12.05.2021
+        12:30:16</InventoryTime></InvOS><Security><PasscodeSet>Unknown</PasscodeSet><EncryptionStatus>Disabled</EncryptionStatus></Security></Device></Items></Content>'
+  recorded_at: Wed, 12 May 2021 14:31:34 GMT
+recorded_with: VCR 6.0.0

data/lib/ruby/miradore.rb CHANGED Viewed

@@ -11,25 +11,14 @@ module Ruby
     class MspConnectionError < StandardError; end
     def self.api_key
-      @@msp_api_key = ENV["MSP_API_KEY"]
+      ENV["MSP_API_KEY"]
     end
-    def self.api_urls
+    def self.url
       {
-        simple_v1: "https://%{subdomain}.online.miradore.com/API/Device?auth=%{auth}&select=ID,%{item}.*&filters=%{filter}",
-        v1: "https://%{subdomain}.online.miradore.com/API/Device?auth=%{auth}&select=*,Category.*,InvDevice.*,InvStorage.*,InvOS.*,Enrollment.*,Client.*,User.*,Location.*,Security.*,ReportedLocation.*&filters=%{filter}",
-        v2: "https://%{subdomain}.online.miradore.com/API/v2/Device/%{id}/%{method}"
-      }
-    end
-    def self.url(version = :v1, *args)
-      Miradore.api_urls[version] % {
-        subdomain: args[0],
-        item: args[1],
-        id: args[1],
-        method: args[2],
-        filter: args[2][0].nil? ? nil : "(InvDevice.SerialNumber eq #{args[2][0]})",
-        auth: Miradore.api_key
+        simple_v1: "https://%<subdomain>s.online.miradore.com/API/Device?auth=%<auth>s&select=ID,%<item>s.*&filters=%<filter>s",
+        v1: "https://%<subdomain>s.online.miradore.com/API/Device?auth=%<auth>s&select=*,Category.*,InvDevice.*,InvStorage.*,InvOS.*,Enrollment.*,Client.*,User.*,Location.*,Security.*,ReportedLocation.*&filters=%<filter>s",
+        v2: "https://%<subdomain>s.online.miradore.com/API/v2/Device/%<id>s/%<method>s"
       }
     end
@@ -39,24 +28,24 @@ module Ruby
       attr_reader :subdomain
-      def self.all(subdomain, *args)
+      def self.all(**args)
         response = JSON.parse(
           Crack::XML.parse(
             get(
-              Miradore.url(version, subdomain, class_name, args)
+              Miradore.url[version] % args.merge(item: class_name, auth: args.fetch(:auth, Miradore.api_key), filter: args.fetch(:filter, nil))
             ).body
           ).to_json,
           quirks_mode: true
         ).dig("Content", "Items", "Device")
-        transform(response, subdomain)
+        transform(response, args)
       rescue StandardError
-        raise MspConnectionError, "Error connecting to manager service provider"
+        raise MspConnectionError, "Error connecting Manager Service Provider"
       end
-      def self.transform(response, subdomain)
-        return response.map! { |e| Device.new(e.transform_keys(&:downcase), subdomain) } if response.is_a?(Array)
+      def self.transform(response, args = {})
+        return response.map! { |e| Device.new(e.transform_keys(&:downcase), args) } if response.is_a?(Array)
-        Device.new(response.transform_keys(&:downcase), subdomain)
+        Device.new(response.transform_keys(&:downcase), args)
       end
       def self.version
@@ -73,11 +62,12 @@ module Ruby
       include HTTParty
       format :json
-      attr_reader :subdomain
+      attr_reader :subdomain, :auth
-      def initialize(json = nil, subdomain = nil)
+      def initialize(json = nil, args = {})
         super json
-        @subdomain = subdomain
+        @subdomain = args[:subdomain]
+        @auth = args[:auth]
         remove_instance_variable(:@subdomain) if subdomain.nil?
       end
@@ -104,8 +94,9 @@ module Ruby
       private
       def http_method(*args)
-        self.class.headers "X-API-Key" => Miradore.api_key
-        self.class.method(args[0]).call(Miradore.url(:v2, subdomain, args[1], args[2]))
+        self.class.headers "X-API-Key" => auth || Miradore.api_key
+        url = Miradore.url[:v2] % { subdomain: subdomain, id: args[1], method: args[2] }
+        self.class.method(args[0]).call(url)
       rescue StandardError
         raise MspConnectionError, "Error connecting to manager service provider"
       end

data/lib/ruby/miradore/version.rb CHANGED Viewed

@@ -2,6 +2,6 @@
 module Ruby
   module Miradore
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-miradore
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eduard
-autorequire:
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -114,6 +114,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- fixtures/vcr_cassettes/InvDevice.yml
+- fixtures/vcr_cassettes/all_criteria.yml
+- fixtures/vcr_cassettes/search_by_serial_number.yml
 - lib/ruby/miradore.rb
 - lib/ruby/miradore/version.rb
 - ruby-miradore-0.1.0.gem
@@ -127,7 +130,7 @@ metadata:
   homepage_uri: https://github.com/eddygarcas/ruby-miradore
   source_code_uri: https://github.com/eddygarcas/ruby-miradore
   changelog_uri: https://github.com/eddygarcas/ruby-miradore
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key:
 specification_version: 4
 summary: Miradore is a MSP providing an API to get devices information as well s perform
   some security actions.