ruby-macrodroid 0.8.9 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12fa9c7d9f642140ed62656a4c3444e5c739ad2be06af2883e23e48766cd742f
-  data.tar.gz: 6f70e2124afbcf43bd15295dfea8aaf9a0a8d6704de819acb34481082d8c905f
+  metadata.gz: 37e8014bb2ccd71ffd2da90197a1dd1a89c7e8e6bbbfc7ed88e9cfbff07925a1
+  data.tar.gz: f2d4910bb6893249e33eb7c4326ea733188ecef67ec94f808cd25ef6c97760d0
 SHA512:
-  metadata.gz: a00b28e20a41ffbdead956eb07ad4e7fe412aa2ceb773017a709c97a4fd1307672b78405581a8e54d855d1f9cb53fe598638bc542facccde886b127e9e150d17
-  data.tar.gz: ddcdc9689a2f202477018ab710772c834caad0e392c6d7135c0f65beb8e85dbf0144fc793e7b11db404531a1cbaf69876b2b21f7598b6baf1361ba794f7bc809
+  metadata.gz: 06015fe764a0450838ad49b6dbebba46afc32ec49673dbf4e1bce9b07e04aaea1850153cf2c0b1d56e740dd2cbcf4653f92878ee99680d7c3f2eaacf1fffb69e
+  data.tar.gz: df0c2950bcae690d137b294825c95579f8530fea24cabfe371809efff64343d4e9ffd71b5f2378c7938bc214dfc0e409892947ad03a86ef4438816fafa11000a

data/lib/ruby-macrodroid.rb

@@ -7,12 +7,7 @@
 #  ## Nlp classes
 #  
 #  TriggersNlp ActionsNlp ConstraintsNlp
-#  
-#  
-#  ## Macro class
-#  
-#  Macro
-#  
+#     
 #  
 #  ## Error class
 #  
@@ -31,11 +26,12 @@
 #  
 
 
+
 require 'yaml'
 require 'rowx'
 require 'uuid'
-require 'glw'
-require 'geozone'
+#require 'glw'
+#require 'geozone'
 require 'geocoder'
 require 'subunit'
 require 'rxfhelper'
@@ -48,248 +44,6 @@ device
     airplane_mode is disabled
 EOF
 
-class TriggersNlp
-  include AppRoutes
-
-  def initialize()
-
-    super()
-    params = {}
-    triggers(params)
-
-  end
-
-  def triggers(params) 
-    
-    # e.g. at 7:30pm daily
-    get /^(?:at )?(\d+:\d+(?:[ap]m)?) daily/i do |time, days|
-      [TimerTrigger, {time: time, 
-                      days: %w(Mon Tue Wed Thu Fri Sat Sun).join(', ')}]
-    end       
-
-    get /^(?:at )?(\d+:\d+(?:[ap]m)?) (?:on )?(.*)/i do |time, days|
-      [TimerTrigger, {time: time, days: days}]
-    end
-
-    # time.is? 'at 18:30pm on Mon or Tue'
-    get /^time.is\? ['"](?:at )?(\d+:\d+(?:[ap]m)?) (?:on )?(.*)['"]/i do |time, days|      
-      [TimerTrigger, {time: time, days: days.gsub(' or ',', ')}]
-    end     
-    
-    get /^shake[ _]device\??$/i do 
-      [ShakeDeviceTrigger, {}]
-    end
-    
-    get /^Flip Device (.*)$/i do |motion|
-       facedown = motion =~ /Face Up (?:->|to) Face Down/i
-      [FlipDeviceTrigger, {face_down: facedown }]
-    end
-    
-    get /^flip_device_down\?$/i do
-      [FlipDeviceTrigger, {face_down: true }]
-    end
-
-    get /^flip_device_up\?$/i do
-      [FlipDeviceTrigger, {face_down: false }]
-    end        
-    
-    get /^Failed Login Attempt$/i do
-      [FailedLoginTrigger, {}]
-    end
-    
-    get /^failed_login?$/i do
-      [FailedLoginTrigger, {}]
-    end         
-
-    get /^Geofence (Entry|Exit) \(([^\)]+)/i do |direction, name|
-      enter_area = direction.downcase.to_sym == :entry
-      [GeofenceTrigger, {name: name, enter_area: enter_area}]
-    end     
-    
-    get /^location (entered|exited) \(([^\)]+)/i do |direction, name|
-      enter_area = direction.downcase.to_sym == :entered
-      [GeofenceTrigger, {name: name, enter_area: enter_area}]
-    end
-    
-    # eg. Proximity Sensor (Near)
-    #
-    get /^Proximity Sensor \(([^\)]+)\)/i do |distance|
-      
-      [ProximityTrigger, {distance: distance}]
-    end    
-
-    
-    
-  end
-
-  alias find_trigger run_route
-
-  def to_s(colour: false)
-    'TriggersNlp ' + @h.inspect
-  end
-
-  alias to_summary to_s
-end
-
-class ActionsNlp
-  include AppRoutes
-
-  def initialize()
-
-    super()
-    params = {}
-    actions(params)
-
-  end
-
-  def actions(params) 
-
-    # e.g. message popup: hello world!
-    get /^message popup: (.*)/i do |msg|
-      [ToastAction, {msg: msg}]
-    end
-
-    # e.g. Popup Message 'hello world!'
-    get /^Popup[ _]Message ['"]([^'"]+)/i do |msg|
-      [ToastAction, {msg: msg}]
-    end
-    
-    # e.g. Popup Message\n  hello world!
-    get /^Popup Message\n\s+(.*)/im do |msg|
-      [ToastAction, {msg: msg}]
-    end    
-            
-    # e.g. Popup Message
-    get /^Popup Message$/i do
-      [ToastAction, {}]
-    end    
-    
-    # e.g. say current time
-    get /^say current[ _]time/i do
-      [SayTimeAction, {}]
-    end    
-    
-    get /^Torch :?(.*)/i do |onoffstate|
-      state = onoffstate.downcase == 'on' ? 0 : 1
-      [CameraFlashLightAction, {state: state}]
-    end    
-    
-    get /^Take Picture/i do
-      [TakePictureAction, {}]
-    end
-    
-    get /^take_picture/i do
-      [TakePictureAction, {}]
-    end           
-        
-    # e.g. Display Notification: Hi there: This is the body of the message
-    get /^Display Notification: ([^:]+): [^$]+$/i do |subject, text|
-      [NotificationAction, {subject: subject, text: text}]
-    end           
-    
-    
-    # e.g. Enable Wifi
-    get /^(Enable|Disable) Wifi$/i do |raw_state|
-      
-      state = raw_state.downcase.to_sym == :enable ? 0 : 1
-      [SetWifiAction, {state: state}]
-      
-    end    
-    
-    # e.g. Play: Altair
-    get /^Play: (.*)$/i do |name|
-
-      [PlaySoundAction, {file_path: name}]
-      
-    end     
-    
-    # e.g. Launch Settings
-    get /^Launch (.*)$/i do |application|
-
-      h = {
-        application_name: application,
-        package_to_launch: 'com.android.' + application.downcase
-      }
-      [LaunchActivityAction, h]
-      
-    end
-    
-    # e.g. HTTP GET http://someurl.com/something
-    get /^HTTP GET ([^$]+)$/i do |url|
-
-      [OpenWebPageAction, url_to_open: url]
-      
-    end
-    
-    # e.g. webhook entered_kitchen
-    #
-    get /webhook|HTTP GET/i do
-      [OpenWebPageAction, {}]
-    end
-    
-    #a: Keep Device Awake Screen On Until Disabled
-    #
-    get /Keep Device Awake Screen On Until Disabled/i do
-      [KeepAwakeAction, {enabled: true, permanent: true, screen_option: 0}]
-    end
-    
-    
-    #a: Keep Device Awake Screen On 1h 1m 1s
-    #
-    get /Keep Device Awake Screen On ([^$]+)/i do |duration|
-      
-      a = duration.split.map(&:to_i)
-      secs = Subunit.new(units={minutes:60, hours:60, seconds: 60}, a).to_i
-      
-      h = {
-        permanent: true, screen_option: 0, seconds_to_stay_awake_for: secs
-      }
-      [KeepAwakeAction, h]
-    end
-    
-    #a: Disable Keep Awake
-    #
-    get /Disable Keep Awake/i do
-      [KeepAwakeAction, {enabled: false, screen_option: 0}]
-    end    
-
-    #a: Disable Keep Awake
-    #
-    get /if (.*)/i do
-      [IfConditionAction, {}]
-    end      
-
-  end
-
-  alias find_action run_route
-
-
-end
-
-class ConstraintsNlp
-  include AppRoutes
-
-  def initialize()
-
-    super()
-    params = {}
-    constraints(params)
-
-  end
-
-  def constraints(params) 
-
-    get /^airplane mode (.*)/i do |state|
-      [AirplaneModeConstraint, {enabled: (state =~ /^enabled|on$/) == 0}]
-    end
-
-  end
-
-  alias find_constraint run_route
-
-end
-
-
 module Params
 
   refine Hash do
@@ -345,518 +99,23 @@ end
 
 
 
-class Macro
-  using ColouredText
-  using Params
-
-  attr_reader :local_variables, :triggers, :actions, :constraints, 
-      :guid, :deviceid
-  attr_accessor :title, :description
-
-  def initialize(name=nil, geofences: nil, deviceid: nil, debug: false)
-
-    @title, @geofences, @deviceid, @debug = name, geofences, deviceid, debug
-    
-    puts 'inside Macro#initialize' if @debug    
-          
-    @local_variables, @triggers, @actions, @constraints = [], [], [], []
-    @h = {}
-    
-  end
-  
-  def add(obj)
-
-    if obj.kind_of? Trigger then
-      
-      puts 'trigger found' if @debug
-      @triggers << obj
-      
-    elsif obj.kind_of? Action
-      
-      puts 'action found' if @debug
-      @actions << obj
-      
-    elsif obj.kind_of? Constraint
-      
-      puts 'constraint found' if @debug
-      @constraints << obj
-      
-    end
-    
-  end
-
-  def to_h()
-
-    h = {
-      local_variables: @local_variables,
-      m_trigger_list: @triggers.map(&:to_h),
-      m_action_list: @actions.map(&:to_h),
-      m_category: @category,
-      m_constraint_list: @constraints.map(&:to_h),
-      m_description: '',
-      m_name: title(),
-      m_excludeLog: false,
-      m_GUID: guid(),
-      m_isOrCondition: false,
-      m_enabled: false,
-      m_descriptionOpen: false,
-      m_headingColor: 0
-    }
-    
-    puts 'h: ' + h.inspect if @debug
-
-    @h.merge(h)
-  end
-
-  def import_h(h)
-
-    if @debug then
-      puts 'inside import_h'
-      puts 'h:' + h.inspect
-    end
-    
-    @category = h[:category]
-    @title = h[:name]
-    @description = h[:description]
-    
-    # fetch the local variables
-    if h[:local_variables].any? and h[:local_variables].first.any? then
-      
-      @local_variables = h[:local_variables].map do |var|
-              
-        val = case var[:type]
-        when 0 # boolean
-          var[:boolean_value]
-        when 1 # integer
-          var[:int_value]
-        when 2 # string
-          var[:string_value]
-        when 3 # decimal
-          var[:decimal_Value]
-        end
-        
-        [var[:name], val]
-        
-      end.to_h
-    end
-    
-    # fetch the triggers
-    @triggers = h[:trigger_list].map do |trigger|
-      puts 'trigger: ' + trigger.inspect
-      #exit      
-      object(trigger.to_snake_case)
-
-    end
-
-    @actions = h[:action_list].map do |action|
-      object(action.to_snake_case)
-    end
-    puts 'before fetch constraints' if @debug
-    # fetch the constraints                               
-    @constraints = h[:constraint_list].map do |constraint|
-      object(constraint.to_snake_case)
-    end                               
-    puts 'after fetch constraints' if @debug    
-    @h = h
-
-    %i(local_variables m_trigger_list m_action_list m_constraint_list)\
-      .each {|x| @h[x] = [] }
-    puts 'after @h set' if @debug    
-    @h
-
-  end
-  
-  def import_xml(node)
-
-    if @debug then
-      puts 'inside Macro#import_xml'
-      puts 'node: ' + node.xml.inspect
-    end
-    
-    if node.element('triggers') then
-            
-      # level 2
-      
-      @title = node.attributes[:name]
-      @category = node.attributes[:category]
-      @description = node.attributes[:description]
-      
-      
-      # get all the triggers
-      @triggers = node.xpath('triggers/*').map do |e|
-        
-        puts 'e.name: ' + e.name.inspect if @debug
-        {timer: TimerTrigger}[e.name.to_sym].new(e.attributes.to_h)
-        
-      end
-
-      # get all the actions
-      @actions = node.xpath('actions/*').map do |e|
-        
-        if e.name == 'notification' then
-          
-          case e.attributes[:type].to_sym
-          when :popup          
-            e.attributes.delete :type
-            ToastAction.new e.attributes.to_h
-          end
-          
-        end
-
-      end    
-                               
-      # get all the constraints
-      @constraints = node.xpath('constraints/*').map do |e|
-        
-        puts 'e.name: ' + e.name.inspect if @debug
-        {airplanemode: AirplaneModeConstraint}[e.name.to_sym].new(e.attributes.to_h)
-
-      end                                  
-      
-    else
-      
-      # Level 1
-      
-      puts 'import_xml: inside level 1' if @debug
-      
-      @title = node.text('macro') || node.attributes[:name]
-      
-      #@description = node.attributes[:description]      
-      
-      tp = TriggersNlp.new      
-      
-      @triggers = node.xpath('trigger').map do |e|
-        
-        r = tp.find_trigger e.text
-        
-        puts 'found trigger ' + r.inspect if @debug
-        
-        if r then
-          if r[0] == GeofenceTrigger then
-            GeofenceTrigger.new(r[1], geofences: @geofences)
-          else
-            r[0].new(r[1])
-          end
-        end
-        
-      end
-      
-      ap = ActionsNlp.new      
-      
-      @actions = node.xpath('action').map do |e|
-        
-        puts 'action e: ' + e.xml.inspect if @debug
-        puts 'e.text ' + e.text if @debug
-        
-        inner_lines = e.xpath('item/description/text()')        
-        
-        action = if e.text.to_s.strip.empty? then
-          inner_lines.shift.strip
-        else
-          e.text.strip
-        end
-        
-        r = ap.find_action action
-        puts 'found action ' + r.inspect if @debug
-        
-        if r then
-          
-          loose = inner_lines.shift
-          
-          raw_attributes = if loose then
-          
-            puts 'do something ' + loose.to_s if @debug
-            loose.to_s
-            
-          else
-            
-            a = e.xpath('item/*')
-            
-            h = if a.any? then
-              a.map {|node| [node.name.to_sym, node.text.to_s]}.to_h
-            else
-              {}
-            end
-            
-            r[1].merge(h)
-            
-          end
-          r[0].new(raw_attributes)
-        end
-        
-      end      
-                               
-      cp = ConstraintsNlp.new      
-      
-      @constraints = node.xpath('constraint').map do |e|
-        
-        r = cp.find_constraint e.text
-        puts 'found constraint ' + r.inspect if @debug
-        
-        if r then
-          r[0].new(r[1])
-        end
-        
-      end                                   
-      
-    end
-    
-    self
-    
-  end
-  
-  def match?(triggerx, detail={time: $env[:time]}, model=nil )
-                
-    if @triggers.any? {|x| x.type == triggerx and x.match?(detail, model) } then
-      
-      if @debug then
-        puts 'checking constraints ...' 
-        puts '@constraints: ' + @constraints.inspect
-      end
-      
-      if @constraints.all? {|x| x.match?($env.merge(detail), model) } then
-      
-        true
-        
-      else
-
-        return false
-        
-      end
-      
-    end
-    
-  end
-  
-  # invokes the actions
-  #
-  def run()
-    @actions.map(&:invoke)
-  end
-  
-  # prepares the environment in order for triggers to test fire successfully
-  # Used for testing
-  #
-  def set_env()
-    @triggers.each(&:set_env)
-  end
-
-  def to_pc()
-    
-    heading = '# ' + @title
-    heading += '\n# ' + @description if @description
-    condition = @triggers.first.to_pc
-    actions = @actions.map(&:to_pc).join("\n")
-    
-<<EOF
-#{heading}
-
-if #{condition} then
-  #{actions}
-end
-EOF
-  end
-    
-  def to_s(colour: false)
-    
-    indent = 0 #@actions.map(&:to_s).join.lines.length > 0 ? 1 : 0
-    
-    a = []
-    a << '# ' + @category + "\n" if @category
-    a <<  (colour ? "m".bg_cyan.gray.bold : 'm') + ': ' + @title
-
-    
-    if @description and @description.length >= 1 then
-      a << (colour ? "d".bg_gray.gray.bold : 'd') + ': ' \
-               + @description.gsub(/\n/,"\n  ")
-    end    
-    
-    if @local_variables.length >= 1 then
-      
-      vars = @local_variables.map do |k,v|
-        label = colour ? 'v'.bg_magenta : 'v'
-        label += ': '
-        label + "%s: %s" % [k,v]
-      end
-      
-      a << vars.join("\n")
-    end    
-    
-    a << @triggers.map do |x|
-      s =-x.to_s(colour: colour)
-      
-      s2 = if s.lines.length > 1 then        
-        "\n" + s.lines.map {|x| x.prepend ('  ' * (indent+1)) }.join
-      else
-        ' ' + s
-      end         
-      #s.lines > 1 ? "\n" + x : x
-      (colour ? "t".bg_red.gray.bold : 't') + ":" + s2
-    end.join("\n")
-    
-    actions = @actions.map do |x|
-
-
-      s = x.to_s(colour: colour)
-      #puts 's: ' + s.inspect      
-      
-
-      
-      r = if indent <= 0 then
-      
-        lines = s.lines
-        
-        if lines.length > 1 then        
-          s = lines.map {|x| x.prepend ('  ' * (indent+1)) }.join
-        end      
-
-        s2 = s.lines.length > 1 ? "\n" + s : ' ' + s        
-        
-        if colour then
-          "a".bg_blue.gray.bold + ":" + s2
-        else
-          "a:" + s2
-        end
-        
-      elsif indent > 0 
-      
-        if s =~ /^Else/ then
-          ('  ' * (indent-1)) + "%s" % s
-        elsif s =~ /^End/
-          indent -= 1
-          ('  ' * indent) + "%s" % s
-        else
-          s2 = s.lines[0] + s.lines[1..-1].map {|x| ('  ' * indent) + x }.join
-          ('  ' * indent) + "%s" % s2
-        end        
-        
-      end
-      
-      if s =~ /^(?:If|DO \/ WHILE)/i then
-        
-        if indent < 1 then
-          
-          r = if colour then
-            "a".bg_blue.gray.bold + ":\n  %s" % s
-          else
-            "a:\n  %s" % s
-          end
-          
-          indent += 1
-        else
-          r = ('  ' * indent) + "%s" % s
-        end
-
-        indent += 1
-      end
-      
-      r
-      
-    end.join("\n")
-
-
-    
-
-    a << actions
-
-    
-    if @constraints.any? then
-      a << @constraints.map do |x|
-        (colour ? "c".bg_green.gray.bold : 'c') + ": %s" % x
-      end.join("\n") 
-    end
-    
-
-    
-
-    
-    a.join("\n") + "\n"
-    
-  end
-  
-  def to_summary(colour: false)
-    
-    if colour then
-      
-      a = [
-        'm'.bg_cyan.gray.bold + ': ' + @title,
-        't'.bg_red.gray.bold + ': ' + @triggers.map \
-      {|x| x.to_summary(colour: false)}.join(", "),
-        'a'.bg_blue.gray.bold + ': ' + @actions.map \
-      {|x| x.to_summary(colour: false)}.join(", ")
-      ]
-      
-      if @constraints.any? then
-        a <<  'c'.bg_green.gray.bold + ': ' + @constraints.map \
-            {|x| x.to_summary(colour: false)}.join(", ") 
-      end      
-      
-    else
-      
-      a = [
-        'm: ' + @title,
-        't: ' + @triggers.map {|x| x.to_summary(colour: false)}.join(", "),
-        'a: ' + @actions.map {|x| x.to_summary(colour: false)}.join(", ")
-      ]
-      
-      if @constraints.any? then
-        a <<  'c: ' + @constraints.map \
-            {|x| x.to_summary(colour: false)}.join(", ") 
-      end
-    end
-    
-    
-    
-    a.join("\n") + "\n"
-    
-  end
-
-  private
-  
-  def guid()
-    '-' + rand(1..9).to_s + 18.times.map { rand 9 }.join    
-  end
-
-  def object(h={})
-
-    puts ('inside object h:'  + h.inspect).debug if @debug  
-    klass = Object.const_get h[:class_type]
-    puts klass.inspect.highlight if $debug
-    
-    if klass == GeofenceTrigger then
-      puts 'GeofenceTrigger found'.highlight if $debug
-      GeofenceTrigger.new(h, geofences: @geofences)
-    else
-      puts 'before klass'
-      h2 = h.merge( macro: self)
-      puts 'h2: ' + h2.inspect      
-      r = klass.new h2 
-      puts 'r:' + r.inspect
-      r
-      
-    end
-    
-  end
-
-end
-
-
 class MacroDroidError < Exception
 end
 
 class MacroDroid
+  include RXFHelperModule
   using ColouredText
   using Params  
 
   attr_reader :macros, :geofences, :yaml
-  attr_accessor :deviceid
+  attr_accessor :deviceid, :remote_url
   
   # note: The deviceid can only be found from an existing Webhook trigger, 
   #       generated from MacroDroid itself.
 
-  def initialize(obj=nil, deviceid: nil, debug: false)
+  def initialize(obj=nil, deviceid: nil, remote_url: nil, debug: false)
 
-    @deviceid, @debug = deviceid, debug    
+    @deviceid, @remote_url, @debug = deviceid, remote_url, debug    
     
     @geofences = {}
     
@@ -885,10 +144,16 @@ class MacroDroid
           puts 'before RowX.new' if @debug
 
           s2 = s.gsub(/^g:/,'geofence:').gsub(/^m:/,'macro:')\
-              .gsub(/^t:/,'trigger:').gsub(/^a:/,'action:')\
-              .gsub(/^c:/,'constraint:').gsub(/^#.*/,'')
+              .gsub(/^v:/,'variable:').gsub(/^t:/,'trigger:')\
+              .gsub(/^a:/,'action:').gsub(/^c:/,'constraint:').gsub(/^#.*/,'')
+          
+          a = s2.split(/(?=^macro:)/)
           
-          raw_macros, raw_geofences = s2.split(/(?=^macro:)/,2).reverse
+          raw_geofences = a.shift if a.first =~ /^geofence/
+          raw_macros = a.join
+          #raw_macros, raw_geofences .reverse
+          
+          puts 'raw_macros: ' + raw_macros.inspect if @debug
           
           if raw_geofences then
             
@@ -901,6 +166,7 @@ class MacroDroid
           end
           
           xml = RowX.new(raw_macros).to_xml
+          puts 'xml: ' + xml if @debug
           import_rowxml(xml)
           
         elsif s =~ /^# / 
@@ -954,14 +220,16 @@ class MacroDroid
 
     }    
   end
+  
+  def export(filepath)
+    FileX.write filepath, to_json
+  end
 
-  def export_json()
+  def to_json()
 
     to_h.to_json
 
   end
-
-  alias to_json export_json
   
 
   def to_h()
@@ -1063,7 +331,7 @@ class MacroDroid
 #       puts '@geofences: ' + @geofences.inspect if @debug
       
       m = Macro.new(geofences: @geofences.map(&:last), deviceid: @deviceid, 
-                    debug: @debug )
+                    remote_url: @remote_url, debug: @debug )
       m.import_h(macro)
       m
 
@@ -1085,7 +353,7 @@ class MacroDroid
     @macros = doc.root.xpath('item').map do |node|
       puts ('geofences: ' + geofences.inspect).highlight if @debug
       Macro.new(geofences: geofences.map(&:last), deviceid: @deviceid, 
-                debug: @debug).import_xml(node)
+                remote_url: @remote_url, debug: @debug).import_xml(node)
       
     end
 
@@ -1107,7 +375,7 @@ class MacroDroid
     end
        
     @macros = doc.root.xpath('macro').map do |node|
-          
+      puts 'node: ' + node.inspect if @debug    
       Macro.new(geofences: @geofences.map(&:last), deviceid: @deviceid, 
                 debug: @debug).import_xml(node)
       
@@ -1308,7 +576,9 @@ class DroidSim
 
 end
 
+
 require 'ruby-macrodroid/base'
 require 'ruby-macrodroid/triggers'
 require 'ruby-macrodroid/actions'
 require 'ruby-macrodroid/constraints'
+require 'ruby-macrodroid/macro'