ruby-miradore 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a2d7224c804d8330fdd5af6a4f59812484057f75b317f11a2d0501a32b7d637
-  data.tar.gz: 4f6f3898d4f2a378e37059172b671d87fb8202cea5955880477c1c293726f866
+  metadata.gz: bbe3675a437a4f1a7db9f1970b5ffff9f49d7767f8f074212b1d4c115bb4a352
+  data.tar.gz: d62031266909082c468a35bd316c642f46c7342bb788283aee194f13cc21c4a0
 SHA512:
-  metadata.gz: ed281193865b2c9426fac2fab0fa0f3ed82801562d25effc7a81bdbe566f55514b40d3297b66d0af31cdb690d22002e063c599eb94bd92f0e721443b57455481
-  data.tar.gz: ccb8a22f0d3f125ab3c930aa34e635af842d69f14f2b28e3ed5948603ca615dfe35065d1948c7da11e205f792b835652f5b9ecce20ebb4b2c50af47175b230c5
+  metadata.gz: 391f48e2cf12a8837494506f3badf713fa7c0ad27f3b29b67cedaa9f4cfcbea98f43d70cfa7bd810f9ab7526de9982b7139b77375dec7115d18b7b5b558b5e14
+  data.tar.gz: a6c04e0cc89456c175855c73cbde0f7f6b172193fc612b828ae93dbf656c921f7ff41fe33cc72a2dec7708bbe2ac365620f0db28c4a6569cf53bd37d71c848b1

data/Gemfile

@@ -5,9 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in ruby-miradore.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.7"
-gem "httparty"
-gem "finest-builder",  "~> 0.0.4"
-gem "crack"
+group :test do
+  gem "webmock"
+  gem "vcr"
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    ruby-miradore (1.0.0)
+      crack (~> 0.4.5)
+      finest-builder (~> 0.0.4)
+      httparty (~> 0.18.1)
+      rake (~> 13.0)
+      rspec (~> 3.0)
+      rubocop (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    finest-builder (0.0.5)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    vcr (6.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  ruby-miradore!
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.2.15

data/lib/ruby/miradore.rb

@@ -1,31 +1,36 @@
 # frozen_string_literal: true
 
 require_relative "miradore/version"
-require 'httparty'
-require 'json'
-require 'crack/xml'
-require 'finest/builder'
+require "httparty"
+require "json"
+require "crack/xml"
+require "finest/builder"
 
 module Ruby
   module Miradore
-    class Error < StandardError; end
-
-    @@msp_api_key = ENV['MSP_API_KEY'] || '3_IHBPttQ.ub[OG27'
-
+    class MspConnectionError < StandardError; end
 
     def self.api_key
-      @@msp_api_key
+      @@msp_api_key = ENV["MSP_API_KEY"]
     end
 
     def self.api_urls
       {
-        v1: 'https://%{subdomain}.online.miradore.com/API/Device?auth=%{auth}&select=*,Category.*,InvDevice.*,InvStorage.*,InvOS.*,Enrollment.*,Client.*,User.*,Location.*,Security.*,ReportedLocation.*',
-        v2: 'https://%{subdomain}.online.miradore.com/API/v2/Device/%{id}/%{method}'
+        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], id: args[1], method: args[2], auth: Miradore::api_key }
+      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
+      }
     end
 
     class Request
@@ -35,14 +40,32 @@ module Ruby
       attr_reader :subdomain
 
       def self.all(subdomain, *args)
-        response = JSON.parse(Crack::XML.parse(get(Miradore::url(:v1, subdomain)).body).to_json, :quirks_mode => true).dig("Content", "Items", "Device")
-        if response.is_a?(Array)
-          response.map! { |e| Device.new(e.transform_keys(&:downcase), subdomain) }
-        else
-          Device.new(response.transform_keys(&:downcase), subdomain)
-        end
+        response = JSON.parse(
+          Crack::XML.parse(
+            get(
+              Miradore.url(version, subdomain, class_name, args)
+            ).body
+          ).to_json,
+          quirks_mode: true
+        ).dig("Content", "Items", "Device")
+        transform(response, subdomain)
+      rescue StandardError
+        raise MspConnectionError, "Error connecting to 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)
+
+        Device.new(response.transform_keys(&:downcase), subdomain)
+      end
+
+      def self.version
+        superclass == Request ? :simple_v1 : :v1
+      end
+
+      def self.class_name
+        to_s.split("::").last
+      end
     end
 
     class Device
@@ -63,7 +86,7 @@ module Ruby
       end
 
       def lostmode(*args)
-        if (args[0])
+        if args[0]
           http_method(:post, id, __method__)
         else
           http_method(:delete, id, __method__)
@@ -81,11 +104,33 @@ 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" => Miradore.api_key
+        self.class.method(args[0]).call(Miradore.url(:v2, subdomain, args[1], args[2]))
+      rescue StandardError
+        raise MspConnectionError, "Error connecting to manager service provider"
       end
 
     end
 
+    class Category < Request; end
+
+    class InvDevice < Request; end
+
+    class InvStorage < Request; end
+
+    class InvOS < Request; end
+
+    class Enrollment < Request; end
+
+    class Client < Request; end
+
+    class User < Request; end
+
+    class Location < Request; end
+
+    class Security < Request; end
+
+    class ReportedLocation < Request; end
+
   end
 end

data/lib/ruby/miradore/version.rb

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

data/ruby-miradore.gemspec

@@ -31,6 +31,12 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "rubocop", "~> 1.7"
+  spec.add_dependency "httparty", "~> 0.18.1"
+  spec.add_dependency "finest-builder",  "~> 0.0.4"
+  spec.add_dependency "crack", "~> 0.4.5"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: ruby-miradore
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Eduard
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
-dependencies: []
+date: 2021-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: finest-builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
 description: Miradore MSP Ruby Gem
 email:
 - eduard@rzilient.club
@@ -24,6 +108,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -31,6 +116,8 @@ files:
 - bin/setup
 - lib/ruby/miradore.rb
 - lib/ruby/miradore/version.rb
+- ruby-miradore-0.1.0.gem
+- ruby-miradore-0.1.1.gem
 - ruby-miradore.gemspec
 homepage: https://github.com/eddygarcas/ruby-miradore
 licenses: