ruby-macrodroid 0.9.13 → 0.9.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c63b70d5cc34184d15c46395e1add89a6c8999163d4fb1e9362aa80a568dba4
-  data.tar.gz: 797fab9bff840db398067dc5b99ac53bb3d3129668573728c31aa0883a28d792
+  metadata.gz: 98e47dfdd0c7a7f5eabe5a942e3d1ad19cbacbb8cdac3de74b301e51a6e9dbdc
+  data.tar.gz: 462bf9fa2ffdb85fc51b93448c1a43b9469bd81bbec42a34549fdde9518a07ef
 SHA512:
-  metadata.gz: 2bbf5ca42c6fe1be4eeeda1ba597bc4be3f0944e7a871785b629d5344268bd65d3c560fcf65de0e5b0a619c075a31f6f61eea1d8eefbd29d066777f9fb414584
-  data.tar.gz: 139c4462602b86d49d87d9b2e73873354550b67c8bc435bfed41d6fe6434419d4cbdfef375efdc659978e012bbb8bb9d685a08d1d75f63ae0a403a6796295da7
+  metadata.gz: e8e4d4e23d498cd394739002b387907209015e06fea55facfdccdd7983e72cf72372bf152427767388ca8c3ee031dfbbe7ff69be964e210025d54ac60be6e0ed
+  data.tar.gz: c8150eccb7ba454409f7ab6d56a7418f9508050c6ee76021c0508b21b1203529e5fce79ff9dfd1aeadfab0f3aced27d95c2def9151517d3bc4eff32ba8e1d6b0

data/lib/ruby-macrodroid/actions.rb

@@ -32,6 +32,36 @@
 #  
 
 
+APPS = {
+  'AutoBoy' => 'com.happyconz.blackbox',
+  'Amazon Alexa' => 'com.amazon.dee.app',
+  'Brave' => 'com.brave.browser',
+  'Camera' => 'com.mediatek.camera',
+  'Cast to TV' => 'cast.video.screenmirroring.casttotv',
+  'Calculator' => 'com.android.pri.calculator',
+  'Calendar' => 'com.google.android.calendar',
+  'Clock' => 'com.android.deskclock',
+  'File Manager' => 'com.alphainventor.filemanager',
+  'Firefox' => 'org.mozilla.firefox',
+  'Google Chrome' => 'com.google.android.chrome',
+  'Google Calendar' => 'com.google.android.calendar',
+  'Chrome' => 'com.google.android.chrome',
+  'Earth' => 'com.google.earth',
+  'Google Home' => 'com.google.android.apps.chromecast.app',  
+  'Google Play Music' => 'com.google.android.music',
+  'MacroDroid' => 'com.arlosoft.macrodroid',
+  'QuickEdit Text Editor Pro' => 'com.rhmsoft.edit.pro',
+  'QR & Barcode Reader' => 'com.teacapps.barcodescanner',
+  'Settings' => 'com.android.settings',
+  'Chrome' => 'com.google.android.street',
+  'tinyCam PRO' => 'com.alexvas.dvr.pro',
+  'Tor Browser' => 'org.torproject.torbrowser',
+  'VLC' => 'org.videolan.vlc',
+  'WiFi FTP Server' => 'com.medhaapps.wififtpserver',
+  'YouTube' => 'com.google.android.youtube'
+}
+
+
 class Action < MacroObject
   using ColouredText
   using Params
@@ -75,20 +105,29 @@ end
 class LaunchActivityAction < ApplicationAction
 
   def initialize(h={})
-
+ 
+    # option 0 is by application name, 1 is launch by package name
+    #
     options = {
       application_name: 'Chrome',
       package_to_launch: 'com.android.chrome',
       exclude_from_recents: false,
-      start_new: false
+      start_new: false,
+      option: 0,
+      launch_by_package_name: ''
     }
 
     super(options.merge h)
+    
+    @list = %w(option launchByPackageName)
 
   end
   
   def to_s(colour: false, indent: 0)
-    'Launch ' + @h[:application_name]
+    option = @h[:option] == 0 ? @h[:application_name] : \
+        @h[:launch_by_package_name]
+    @s = 'Launch ' + option
+    super()
   end
 
 end
@@ -119,13 +158,30 @@ end
 #
 class LaunchShortcutAction < ApplicationAction
 
-  def initialize(h={})
+  def initialize(obj=nil)
     
+    puts 'obj: ' + obj.inspect
+    h = if obj.is_a? Hash then
+      obj
+    else
+      obj[2] || {}
+    end
+    
+    if h[:shortcut] and h[:shortcut] =~ /Ask Alexa/i then
+      h = {
+        :app_name=>"Amazon Alexa", :intent_encoded=>"#Intent;action=com." +   
+          "amazon.alexa.action.WIDGET_SHORTCUT;launchFlags=0x10000000;" + 
+          "component=com.amazon.dee.app/.ui.voice.LaunchAlexaActivity;end", 
+          :name=>"Ask Alexa"
+      }
+    end    
     options = {
       :app_name=>"Amazon Alexa", :intent_encoded=>"", :name=>"Ask Alexa"
     }
 
     super(options.merge h)
+    
+    #@list = %w(appName intentEncoded name)
 
   end
   
@@ -150,17 +206,17 @@ class OpenWebPageAction < ApplicationAction
 
   def initialize(obj={}, macro=nil)
 
-    $debug = false    
+    $debug = true    
     puts ('obj: ' + obj.inspect).debug if $debug
     
     h = if obj.is_a? Hash then
     
-      obj.merge({macro: macro})
+      obj.merge({macro: macro}) #unless obj and obj[:macro]
       
     elsif obj.is_a? Array
       
       puts ('obj: ' + obj.inspect).debug if $debug
-      e, macro = obj
+      e, macro, h3 = obj
       
       a = e.xpath('item/*')
 
@@ -181,7 +237,7 @@ class OpenWebPageAction < ApplicationAction
         {url: (txt || e.text)}
       end      
       
-      h2.merge(macro: macro)
+      h2.merge(macro: macro).merge(h3)
 
     end
 
@@ -219,6 +275,7 @@ class OpenWebPageAction < ApplicationAction
           h[:macro].title.downcase.gsub(/ +/,'-')            
       
     end        
+    puts 'url: ' + url.inspect if $debug
     
     if h2 then
       
@@ -242,7 +299,8 @@ class OpenWebPageAction < ApplicationAction
   end
   
   def to_s(colour: false, indent: 0)
-    @s = "HTTP GET\nurl: " + @h[:url_to_open]
+    s = @h[:http_get] ? '' : 'Open Website / '
+    @s = s + "HTTP GET\nurl: " + @h[:url_to_open]
     super()
   end
 
@@ -378,6 +436,61 @@ class TakePictureAction < CameraAction
 end
 
 
+class TakeScreenshotAction < CameraAction
+
+  def initialize(obj=nil)
+    
+    h = if obj.is_a? Hash then
+      obj
+    elsif obj.is_a? Array
+      
+      e, macro = obj      
+      
+      a = [
+        'Save to device', 
+        'Send via email', 
+        'Share via intent'
+      ]
+      
+      s = e.text('item/description').to_s
+      index = a.map(&:downcase).index s.downcase
+    
+      {option: index}
+      
+    end 
+    
+    options = {
+      option: 0, 
+      use_smtp_email: false, 
+      mechanism_option: 0, 
+      save_to_jpeg: false
+    }
+
+    super(options.merge h)
+
+  end
+
+  def to_s(colour: false, indent: 0)
+    
+    @s = 'Take Screenshot' #+ @h.inspect
+    
+    options = [
+      'Save to device', 
+      'Send via email', 
+      'Share via intent'
+    ]
+    
+    option = options[@h[:option]]
+    
+    @s += "\n" + option
+    super()
+    
+  end
+
+  alias to_summary to_s
+end
+
+
 # Conditions/Loops
 #
 class IfConfirmedThenAction < Action
@@ -961,8 +1074,15 @@ end
 #
 class ClipboardAction < DeviceAction
 
-  def initialize(h={})
+  def initialize(obj=nil)
 
+    h = if obj.is_a? Hash then
+      obj
+    elsif obj.is_a? Array
+      e, macro = obj
+      {clipboard_text: e.text('item/description').to_s}
+    end    
+    
     options = {
       clipboard_text: ''
     }
@@ -1042,14 +1162,60 @@ end
 #
 class UIInteractionAction < DeviceAction
 
-  def initialize(h={})
+  def initialize(obj=nil)
 
+    if obj.is_a? Hash then
+      h = obj
+    elsif obj.is_a? Array
+      
+      e, macro = obj
+      s = e.text('item/description').to_s
+      
+      r = s.match(/^(Click|Long Click) \[(.*)\]$/)
+
+      # [Current focus] # Current focus
+      # [0,0] # x,y location
+      # [274,186] # Identify in app
+      # [fooo] # Text content
+
+      h = {
+        ui_interaction_configuration: {
+                                       :xy_point=>{:x=>0, :y=>0},
+                                       :type=>"Click"} 
+      }
+      h2 = h[:ui_interaction_configuration]
+
+      if r then
+
+        h[:action] = 0
+
+        click, detail = r.captures
+        h2[:long_click] = false if click.downcase.to_sym == :click
+
+        if detail == 'Current focus' then          
+          h2[:click_option] = 0
+        elsif detail =~ /\d+,\d+/
+          # to-do   
+        else
+          # text content
+          h2[:click_option] = 1
+          h2[:text_content] = detail
+        end
+        
+        #h[:ui_interaction_configuration] = h2
+      end
+
+    end   
+    
     options = {
       ui_interaction_configuration: {:type=>"Copy"},
       action: 2
     }
 
-    super(options.merge h)
+
+    super(options.merge h) 
+    
+    @list = %w(uiInteractionConfiguration action xyPoint textContent  clickOption type longClick)
 
   end
 
@@ -1089,7 +1255,8 @@ class UIInteractionAction < DeviceAction
       "Gesture [%s]" % detail
     end
     
-    'UI Interaction' + "\n  " + s #+ ' ' + @h.inspect
+    @s = 'UI Interaction' + "\n" + s #+ ' ' + @h.inspect
+    super()
   end
 
   alias to_summary to_s
@@ -1109,7 +1276,10 @@ class VoiceSearchAction < DeviceAction
   end
 
   def to_s(colour: false, indent: 0)
-    'VoiceSearchAction ' + @h.inspect
+    
+    @s = 'Voice Search' # + @h.inspect
+    super()
+    
   end
 
   alias to_summary to_s
@@ -1251,7 +1421,11 @@ class SetAutoRotateAction < DeviceSettingsAction
   end
 
   def to_s(colour: false, indent: 0)
-    'SetAutoRotateAction ' + @h.inspect
+        
+    #'SetAutoRotateAction ' + @h.inspect
+    @s = 'Auto Rotate ' + %w(On Off Toggle)[@h[:state]]
+    super()
+    
   end
 
   alias to_summary to_s
@@ -1667,9 +1841,18 @@ class ClearLogAction < LoggingAction
 end
 
 
+class MacroDroidAction < Action
+  
+  def initialize(h={})
+    super(h)
+    @group = 'macrodroid'
+  end
+  
+end
+
 # MacroDroid Specific
 #
-class CancelActiveMacroAction < Action
+class CancelActiveMacroAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1693,7 +1876,7 @@ end
 
 # MacroDroid Specific
 #
-class ConfirmNextAction < Action
+class ConfirmNextAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1717,7 +1900,7 @@ class ConfirmNextAction < Action
   
 end
 
-class DisableMacroAction < Action
+class DisableMacroAction < MacroDroidAction
   
   def initialize(obj=nil)
     
@@ -1764,7 +1947,7 @@ end
 
 # MacroDroid Specific
 #
-class ExportMacrosAction < Action
+class ExportMacrosAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1786,9 +1969,61 @@ class ExportMacrosAction < Action
 end
 
 
+
+class ForceMacroRunAction < MacroDroidAction
+      
+  def initialize(obj=nil)
+    
+    h = if obj.is_a? Hash then
+    
+      obj
+      
+    elsif obj.is_a? Array
+      
+      e, macro, h2 = obj
+      
+      # find the macro guid for the given name
+      name = e.text('item/description').to_s
+      found = macro.parent.macros.find {|macro| macro.title =~ /#{name}/ }
+      
+      h3 = if found then     
+        {macro_name: found.title, GUID: found.guid}
+      else
+        {macro_name: name}
+      end
+      
+      h3.merge h2
+
+    end      
+    
+    options = {
+      guid: nil, ignore_constraints: true, 
+      macro_name: "", use_off_status: false, 
+      user_prompt_title: "Run Macro"      
+    }
+    super(options.merge h)
+    
+  end  
+  
+  def invoke()
+    super(macro_name: @h[:macro_name])
+  end
+  
+  def to_s(colour: false, indent: 0)
+    
+    @s = 'Macro Run'# + @h.inspect
+    @s += "\n" + @h[:macro_name]
+    super()
+    
+  end
+  
+  alias to_summary to_s
+  
+end
+
 # MacroDroid Specific
 #
-class SetVariableAction < Action
+class SetVariableAction < MacroDroidAction
   using ColouredText
   
   def initialize(obj=nil)
@@ -1878,7 +2113,7 @@ end
 
 # MacroDroid Specific
 #
-class TextManipulationAction < Action
+class TextManipulationAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1921,7 +2156,7 @@ end
 
 
 
-class PauseAction < Action
+class PauseAction < MacroDroidAction
   
   def initialize(h={})
     
@@ -1961,6 +2196,63 @@ end
 
 # Category: Media
 #
+
+
+# note: to find a package id from an App name, try searching for the name on 
+#       the Google Play Store and the id will be returned in the URL once the 
+#       correct app has been clicked. e.g.
+#       https://play.google.com/store/apps/details?id=com.google.android.music
+#
+class ControlMediaAction < MediaAction
+
+  def initialize(obj=nil)
+
+    h = if obj.is_a? Hash then
+      obj
+    elsif obj.is_a? Array
+      
+      e, macro, h2 = obj      
+      s = e.text('item/description').to_s
+      app = s[/Simulate Media Button \(([^\)]+)/,1]
+      
+      if app then        
+        
+        {
+          application_name: app,  package_name: APPS[app], 
+          simulate_media_button: true
+        }.merge h2
+        
+      else
+        {}
+      end
+    end
+    #puts 'h: ' + h.inspect
+    
+    options = {
+      application_name: "Google Play Music", option: "Play/Pause", 
+      package_name: "com.google.android.music", 
+      send_media_player_commands: false, 
+      simulate_media_button: true,
+    }
+
+    super(options.merge h)
+
+  end
+
+  def to_s(colour: false, indent: 0)
+    
+    @s = 'Media ' + @h[:option] #+ @h.inspect
+    
+    if @h[:simulate_media_button] then
+      @s +=  "\nSimulate Media Button (%s)" % @h[:application_name]
+    end
+    
+    super()
+  end
+
+  alias to_summary to_s
+end
+
 class RecordMicrophoneAction < MediaAction
 
   def initialize(h={})

data/lib/ruby-macrodroid/actionsnlp.rb

@@ -86,10 +86,15 @@ class ActionsNlp
     
     get /^take_picture/i do
       [TakePictureAction, {}]
-    end           
+    end
+    
+    get /^Take Screenshot/i do
+      [TakeScreenshotAction, {}]
+    end               
     
     # -- DEVICE ACTIONS ------------------------------------------------------
     
+    #
     get /^Speak text \(([^\)]+)\)/i do |text|
       [SpeakTextAction, {text: text}]
     end           
@@ -100,7 +105,11 @@ class ActionsNlp
     
     get /^Speak text$/i do |text|
       [SpeakTextAction, {}]
-    end     
+    end  
+    
+    get /^UI Interaction$/i do
+      [UIInteractionAction, {}]
+    end  
     
     get /^Vibrate \(([^\)]+)/i do |pattern|
       [VibrateAction, {pattern: pattern}]
@@ -109,6 +118,19 @@ class ActionsNlp
     get /^Vibrate$/i do |pattern|
       [VibrateAction, {pattern: 'short buzz'}]
     end       
+
+    get /^Voice Search$/i do
+      [VoiceSearchAction, {}]
+    end           
+    
+    # -- Device settings ---------------------------------------
+    
+    get /^Auto Rotate (On|Off|Toggle)$/i do |state|
+      
+      a = %w(on off toggle)
+      
+      [SetAutoRotateAction, {state: a.map(&:downcase).index(state.downcase)}]
+    end               
     
     # e.g. Display Notification: Hi there: This is the body of the message
     get /^Display Notification: ([^:]+): [^$]+$/i do |subject, text|
@@ -123,6 +145,10 @@ class ActionsNlp
       [SetWifiAction, {state: state}]
       
     end    
+        
+    get /^Fill Clipboard$/i do            
+      [ClipboardAction, {}]
+    end           
     
     # e.g. Play: Altair
     get /^Play: (.*)$/i do |name|
@@ -130,14 +156,34 @@ class ActionsNlp
       [PlaySoundAction, {file_path: name}]
       
     end     
+
+    get /^Launch Shortcut:? (?:Amazon|Ask) Alexa$/i do
+      [LaunchShortcutAction, {shortcut: 'Ask Alexa'}]      
+    end
+    
+    get /^Shortcut:? (?:Amazon|Ask) Alexa$/i do
+      [LaunchShortcutAction, {shortcut: 'Ask Alexa'}]      
+    end    
     
     # e.g. Launch Settings
-    get /^Launch (.*)$/i do |application|
+    get /^Launch (.*)$/i do |s|
 
-      h = {
-        application_name: application,
-        package_to_launch: 'com.android.' + application.downcase
-      }
+      h = {}
+      
+      if s[0] == '[' then
+        
+        h[:launch_by_package_name] = s
+        h[:option] = 1
+        
+      else
+        application = s
+        h[:application_name] = application
+        h[:package_to_launch] = APPS[application] || 'com.android.' + 
+            application.downcase.split().join('.')
+        h[:option] = 0
+        
+      end
+      
       [LaunchActivityAction, h]
       
     end
@@ -155,6 +201,19 @@ class ActionsNlp
       
     end    
     
+    
+    get /^Open Website \/ HTTP GET$/i do
+
+      [OpenWebPageAction, {http_get: false}]
+      
+    end
+    
+    get /^(?:open|goto) ((?:https?:\/\/|\[lv=)[^$]+)$/i do |url|
+
+      [OpenWebPageAction, url_to_open: url, http_get: false]
+      
+    end
+    
     # e.g. webhook entered_kitchen
     #
     get /(?:webhook|HTTP GET) ([^$]+)$/i do |s|
@@ -221,6 +280,14 @@ class ActionsNlp
       state = %w(enable disable toggle).index(rawstate.downcase)
       [DisableMacroAction, {state: state}]
     end        
+
+    get /^Macro Run$/i do
+      [ForceMacroRunAction, {}]
+    end
+    
+    get /^Run Macro$/i do
+      [ForceMacroRunAction, {}]
+    end    
     
     get /^Set Variable$/i do
       [SetVariableAction, {}]
@@ -230,6 +297,14 @@ class ActionsNlp
       [PauseAction, {delay_in_seconds: seconds.to_i}]
     end        
     
+    ## -- Media -----------------------------------------
+    #
+    # options: Play/Pause, Previous, Next, Play, Pause, Stop
+    #
+    get /^Media ([^$]+)$/i do |option|
+      [ControlMediaAction, {option: option}]
+    end            
+    
     # -- Screen ------------------------------------------------
     #
     get /^Screen (On|Off)$/i do |state|

data/lib/ruby-macrodroid/base.rb

@@ -12,7 +12,7 @@ module ObjectX
   
   def action_to_object(ap, e, item, macro)
     
-    debug = false
+    debug = true
     
     puts 'inside action_to_object: item.xml: ' + item.xml if debug
         
@@ -34,7 +34,7 @@ module ObjectX
         r = ap.find_action action          
         puts 'r: ' + r.inspect if debug
         
-        nested = description.element('item/description')
+        nested = description.element('item/*')
         puts 'nested: ' + nested.inspect if debug
         
         if r[1].any? and not nested then
@@ -133,7 +133,8 @@ class MacroObject
   end
 
   def to_h()
-
+    
+    @h.delete :macro
     hashify(@h)
 
   end
@@ -194,6 +195,7 @@ class MacroObject
     
   end
   
+  
   private
   
   def hashify(h)

data/lib/ruby-macrodroid/macro.rb

@@ -356,7 +356,7 @@ class Macro
     
   end
   
-  def match?(triggerx, detail={time: $env[:time]}, model=nil )
+  def match?(triggerx, detail={}, model=nil )
                 
     if @triggers.any? {|x| x.type == triggerx and x.match?(detail, model) } then
       

data/lib/ruby-macrodroid/triggers.rb

@@ -1416,6 +1416,10 @@ class ActivityRecognitionTrigger < SensorsTrigger
 
   end
   
+  def match?(detail={})
+    @h[:selected_index] == detail[:selected_index]
+  end
+  
   def to_s(colour: false)
     
     activity = @activity[@h[:selected_index]]
@@ -1540,6 +1544,19 @@ class FlipDeviceTrigger < SensorsTrigger
 
   end  
   
+  def match?(detail={})
+    
+    fd = detail[:face_down]
+    
+    b = if fd.is_a? String then
+      fd.downcase == 'true'
+    else
+      fd
+    end
+    
+    @h[:face_down] == b
+  end
+  
   def to_pc()
     @h[:face_down] ? 'flip_device_down?' : 'flip_device_up?'
   end
@@ -1771,6 +1788,21 @@ class SwipeTrigger < Trigger
     super(options.merge h)
 
   end
+  
+  def match?(detail={}, model=nil)
+    
+    puts 'detail : ' + detail.inspect
+        
+    return false if detail.empty?
+   
+    detail[:swipe_start_area] = detail[:start]
+    detail[:swipe_motion] = detail[:motion]
+    return unless detail[:swipe_start_area] and detail[:swipe_motion]
+    
+    @h[:swipe_start_area] == detail[:swipe_start_area].to_i and \
+       @h[:swipe_motion] == detail[:swipe_motion].to_i
+
+  end  
 
   def to_s(colour: false)
     

data/lib/ruby-macrodroid/triggersnlp.rb

@@ -67,6 +67,8 @@ class TriggersNlp
       [WifiConnectionTrigger, {}]
     end       
     
+  
+    
     # -- Device Events ----------------------------------------------------
     
     get /^NFC Tag$/i do |state|            
@@ -185,7 +187,27 @@ class TriggersNlp
     
     get /^Swipe Screen$/i do       
       [SwipeTrigger, {}]
-    end     
+    end
+    
+    get /^Swipe (top left) (across|diagonal|down)$/i do |start, motion|
+                  
+      swipe_motion = case motion.downcase.to_sym
+      when :across
+        0
+      when :diagonal
+        1
+      when :down
+        2
+      end
+      
+      h = {
+        swipe_start_area: (start.downcase == 'top left' ? 0 : 1),
+        swipe_motion: swipe_motion
+      }
+      
+      [SwipeTrigger, h]
+      
+    end
     
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macrodroid
 version: !ruby/object:Gem::Version
-  version: 0.9.13
+  version: 0.9.18
 platform: ruby
 authors:
 - James Robertson
@@ -35,7 +35,7 @@ cert_chain:
   NZ2kdBIUDnAM24e0/wXdVxg4HnsZbdymxyzMQ4P5pKYcpI6oisBxI37p/Xy+wAg3
   SBHno3GEuuD8ZWj24IMJpfbp
   -----END CERTIFICATE-----
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glw