ruby-miradore 4.3.1 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e723736ca0d695530b9e1542255704218bc0393916fb2fb43594f2207da3fb79
-  data.tar.gz: b358ae47df701554c332186f0c9b089e0110368710cd9e41387918610ed6ea17
+  metadata.gz: c854cbb5ab9cac28c6e4fb8c1d913f96531c54eaf0463a5c931d48020c045b40
+  data.tar.gz: 16db5100e8b11468ff2da6edeb797a135a30638882b97cefb33ca18adc815c1f
 SHA512:
-  metadata.gz: dc59038d193e6ad6392a327ddbf342907f05e4b805914c27c72bf71c41ac6175608cba59dcb20da2df3d1e69e8d1191af269e9f4cc3c08edb942483795616c1b
-  data.tar.gz: 4cb5771a916087dbbb2b924890f98117e13ad0222a890e0d225f38caa9cd23190216b90d424646c5f2d6840b16fded3bfe65e81529b250fd670d85d8e8e763a8
+  metadata.gz: 0b2e17d1750e09479355f82b4f14ced4c4273d712c6459449b71be3ec6d21482305748f75b6f3000e892cec72ac461e87145e8bf042e09bb36c798caa023d125
+  data.tar.gz: 944315dd81361acb3b6b283434b053a29b45499c3e947e04de03c5ae588c1a8819a6695eb75f1d72396bb11ff339f2d009ad585dbb1c2b8d92b5a69abfa28ec3

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-miradore (4.3.1)
+    ruby-miradore (4.4.1)
       activesupport (~> 7.0)
       builder (~> 3.1)
       crack (~> 0.4)
@@ -14,7 +14,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,60 +23,58 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     finest-builder (2.0.0)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
-    minitest (5.16.3)
+    json (2.6.3)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
     multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
-    public_suffix (5.0.0)
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.1)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.39.0)
+    rubocop (1.45.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     vcr (6.1.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
@@ -93,4 +91,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.25
+   2.4.5

data/fixtures/vcr_cassettes/Change_User_Email_Address.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://test634.online.miradore.com/API/v2/Device/13/
+    body:
+      encoding: UTF-8
+      string: '{"userEmailAddress":"eduard@rzilient.club"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      X-Api-Key:
+      - 1_8,Yo-TV8QyCiBUF
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Content-Type:
+      - text/plain
+      Server:
+      - Microsoft-IIS/10.0
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      Referrer-Policy:
+      - same-origin
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+      Date:
+      - Tue, 25 Oct 2022 10:51:38 GMT
+      Content-Length:
+      - '530'
+    body:
+      encoding: UTF-8
+      string: 'Status Code: 401; Unauthorized                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    '
+  recorded_at: Tue, 25 Oct 2022 10:51:39 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/Change_User_Email_Address_Error.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://rzilient.online.miradore.com/API/v2/Device//
+    body:
+      encoding: UTF-8
+      string: '{"userEmailAddress":"eduard@rzilient.club"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      X-Api-Key:
+      - ''
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - text/plain
+      Server:
+      - Microsoft-IIS/10.0
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      Referrer-Policy:
+      - same-origin
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+      Date:
+      - Tue, 25 Oct 2022 10:50:52 GMT
+      Content-Length:
+      - '527'
+    body:
+      encoding: UTF-8
+      string: 'Status Code: 404; Not Found                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    '
+  recorded_at: Tue, 25 Oct 2022 10:50:52 GMT
+recorded_with: VCR 6.0.0

data/lib/ruby/miradore/version.rb

@@ -2,6 +2,6 @@
 
 module Ruby
   module Miradore
-    VERSION = "4.3.1"
+    VERSION = '4.4.1'
   end
 end

data/lib/ruby/miradore.rb

@@ -3,6 +3,7 @@
 require_relative 'miradore/version'
 require 'active_support/isolated_execution_state'
 require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/module/attribute_accessors'
 require 'httparty'
 require 'json'
 require 'crack/xml'
@@ -11,11 +12,25 @@ require 'finest/builder'
 module Ruby
   module Miradore
 
-    def self.url
-      {
-        v1: 'https://%<subdomain>s.online.miradore.com/API/%<item>s/%<id>s?auth=%<auth>s&select=*,%<attribute>s&filters=%<filter>s&options=%<options>s',
-        v2: 'https://%<subdomain>s.online.miradore.com/API/v2/Device/%<id>s/%<method>s'
+    mattr_accessor :url, default: {
+      v1: 'https://%<subdomain>s.online.miradore.com/API/%<item>s/%<id>s?auth=%<auth>s&select=*,%<attribute>s&filters=%<filter>s&options=%<options>s',
+      v2: 'https://%<subdomain>s.online.miradore.com/API/v2/Device/%<id>s/%<method>s'
+    }
+    mattr_accessor :phone_types, default: %w[Android iOS WindowsPhone]
+    mattr_accessor :commands, default: {
+      mobile: {
+        lostmode: {
+          message: 'This device has been reported as lost and its location has been identified, please return before authorities arrive.',
+          phoneNumber: '',
+          footnote: 'Contact Support team to unlock.',
+          enableLocationTracking: true
+        }
       }
+    }
+
+    # Setup data from initializer
+    def self.setup
+      yield(self)
     end
 
     class Request
@@ -25,11 +40,11 @@ module Ruby
 
       attr_writer :subdomain, :auth, :json
 
-      def initialize(json = {})
-        super json
-        @subdomain ||= json[:subdomain]
-        @auth ||= json[:auth]
-        @json ||= json.to_json
+      def initialize(args = {})
+        super args
+        @subdomain ||= args[:subdomain]
+        @auth ||= args[:auth]
+        @json ||= args.to_json
         remove_instance_variable(:@subdomain) if @subdomain.nil?
         remove_instance_variable(:@auth) if @auth.nil?
       end
@@ -40,18 +55,18 @@ module Ruby
       # If the superclass is Request the GET will call simple_v1 which will require the item which is class name.
       # otherwise will call to retrieve devices based on filters.
       #
-      def all(**args)
+      def all(args = {})
         transform(
           Crack::XML.parse(
-            http_method_v1(**args).body
+            http_method_v1(args).body
           ).dig('Content', 'Items'), args
         )
       end
 
-      def call(**args)
+      def call(args = {})
         transform(
           Crack::XML.parse(
-            http_method_v1(**args.merge(attribute: 'ID')).body
+            http_method_v1(args.merge(attribute: 'ID')).body
           )['Content'], args
         )
       end
@@ -60,8 +75,7 @@ module Ruby
         @json
       end
 
-
-      def http_method_v1(**args)
+      def http_method_v1(args)
         url = Miradore.url[:v1] % args.merge(
           subdomain: @subdomain || args[:subdomain],
           auth: args.fetch(:auth, @auth),
@@ -85,7 +99,7 @@ module Ruby
         end
         self.class.new(args.merge(res.values.first&.transform_keys(&:downcase)))
       rescue StandardError
-        { error: "#{self.class.to_s.split("::").last}(s) not found", status: :not_found }
+        { error: "#{self.class.to_s.split('::').last}(s) not found", status: :not_found }
       end
 
     end
@@ -96,48 +110,48 @@ module Ruby
       headers "Content-Type": 'application/json'
       headers "Accept": 'application/json'
 
-      def initialize(json = {})
-        super json
+      def initialize(args = {})
+        super args
       end
 
-      def lock(**args)
-        http_method(**args.merge(method: :post, id: id, action: __method__))
+      def lock(args = {})
+        http_method(args.merge(method: :post, id: id, action: __method__))
       end
 
-      def lostmode(**args)
-        if args[0]
-          http_method(**args.merge(method: :post, id: id, action: __method__))
+      def lostmode(args = {})
+        if args.fetch(:enable, false)
+          http_method(args.merge(method: :post, id: id, action: __method__, body: Miradore.commands[:mobile][:lostmode]))
         else
-          http_method(**args.merge(method: :delete, id: id, action: __method__))
+          http_method(args.merge(method: :delete, id: id, action: __method__))
         end
       end
 
-      def reboot(**args)
-        http_method(**args.merge(method: :post, id: id, action: __method__))
+      def reboot(args = {})
+        http_method(args.merge(method: :post, id: id, action: __method__))
       end
 
-      def wipe(**args)
-        http_method(**args.merge(method: :post, id: id, action: __method__))
+      def wipe(args = {})
+        http_method(args.merge(method: :post, id: id, action: __method__))
       end
 
-      def location(**args)
-        http_method(**args.merge(method: :get, action: __method__))
+      def location(args = {})
+        http_method(args.merge(method: :get, action: __method__))
       end
 
-      def family(**args)
-        http_method(**args.merge(method: :put, action: :category))
+      def family(args = {})
+        http_method(args.merge(method: :put, action: :category))
       end
 
-      def model(**args)
-        http_method(**args.merge(method: :put, action: __method__))
+      def model(args = {})
+        http_method(args.merge(method: :put, action: __method__))
       end
 
-      def activate(**args)
-        http_method(**args.merge(method: :post, action: __method__))
+      def activate(args = {})
+        http_method(args.merge(method: :post, action: __method__))
       end
 
-      def retire(**args)
-        http_method(**args.merge(method: :delete, id: id, action: nil))
+      def retire(args = {})
+        http_method(args.merge(method: :delete, id: id, action: nil))
       end
 
       def device_serial_number
@@ -153,16 +167,16 @@ module Ruby
       end
 
       def phone?
-        %w[Android iOS WindowsPhone].include?(platform)
+        Miradore.phone_types.include?(platform)
       end
 
-      def call(**args)
-        http_method(**args)
+      def call(args = {})
+        http_method(args)
       end
 
       private
 
-      def http_method(**args)
+      def http_method(args)
         self.class.headers 'X-API-Key' => @auth || args[:auth]
         url = Miradore.url[:v2] % {
           subdomain: @subdomain || args[:subdomain],

data/ruby-miradore.gemspec

@@ -3,16 +3,16 @@
 require_relative "lib/ruby/miradore/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "ruby-miradore"
-  spec.version       = Ruby::Miradore::VERSION
-  spec.authors       = ["Eduard Garcia Castelló"]
-  spec.email         = %w[edugarcas@gmail.com eduard@rzilient.club]
+  spec.name = "ruby-miradore"
+  spec.version = Ruby::Miradore::VERSION
+  spec.authors = ["Eduard Garcia Castelló"]
+  spec.email = %w[edugarcas@gmail.com eduard@rzilient.club]
 
-  spec.summary       = "Miradore is a MSP providing an API to get devices information as well s perform some security actions."
-  spec.description   = "Miradore MSP Ruby Gem"
-  spec.homepage      = "https://github.com/eddygarcas/ruby-miradore"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.2")
+  spec.summary = "Miradore is a MSP providing an API to get devices information as well s perform some security actions."
+  spec.description = "Miradore MSP Ruby Gem"
+  spec.homepage = "https://github.com/eddygarcas/ruby-miradore"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
 
@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-miradore
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.1
 platform: ruby
 authors:
 - Eduard Garcia Castelló
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,6 +143,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- fixtures/vcr_cassettes/Change_User_Email_Address.yml
+- fixtures/vcr_cassettes/Change_User_Email_Address_Error.yml
 - fixtures/vcr_cassettes/Change_User_Email_Address_Without_v1.yml
 - fixtures/vcr_cassettes/Get_Device_Location.yml
 - fixtures/vcr_cassettes/Get__Mobile_Device.yml
@@ -186,14 +188,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Miradore is a MSP providing an API to get devices information as well s perform