lmc 0.8.0 → 0.12.0

data/lib/lmc/Configstates.rb

@@ -5,12 +5,11 @@ module LMC
     attr_reader :actual, :outdated
 
     def initialize(data)
-      @actual = data["ACTUAL"]
-      @outdated = data["OUTDATED"]
+      @actual = data['ACTUAL']
+      @outdated = data['OUTDATED']
       @actual ||= 0
       @outdated ||= 0
     end
-
   end
+end
 
-end

data/lib/lmc/Device.rb

@@ -2,7 +2,7 @@
 
 module LMC
   class Device
-    attr_reader :id, :name, :model, :serial, :heartbeatstate
+    attr_reader :id, :name, :model, :serial, :heartbeatstate, :cloud, :account, :status
 
     def initialize(data)
       @id = data['id']
@@ -17,51 +17,42 @@ module LMC
       @cloud ||= Cloud.instance
     end
 
-    def get_config_for_account(account)
-      response = @cloud.get ["cloud-service-config", "configbuilder", "accounts", account.id, "devices", @id, "ui"]
-      JSON.parse(JSON.generate(response.body.to_h)) #terrible hack to get it to work for now. needs way to get more raw body_object from Response
-    end
-
     def set_config_for_account(config, account)
-      @cloud.put ["cloud-service-config", "configbuilder", "accounts", account.id, "devices", @id, "ui"], config
+      @cloud.put ['cloud-service-config', 'configbuilder', 'accounts', account.id, 'devices', @id, 'ui'], config
     end
 
     def get_monitor_widgets(widget_item_ids)
-      @cloud.get ["cloud-service-monitoring", @account.id, "devices", @id, "monitordata"], { :widgetItemIds => widget_item_ids.join(",") }
+      @cloud.get ['cloud-service-monitoring', @account.id, 'devices', @id, 'monitordata'], :widgetItemIds => widget_item_ids.join(',')
     end
 
     def self.get_for_account(account)
       cloud = Cloud.instance
       cloud.auth_for_accounts [account.id]
-      list = cloud.get ["cloud-service-devices", "accounts", account.id, "devices"]
+      list = cloud.get ['cloud-service-devices', 'accounts', account.id, 'devices']
       if list.code != 200
         puts "Error getting devices: #{list.body.message}"
         exit 1
       end
       devices = list.map do |data|
-        data["account"] = account
+        data['account'] = account
         LMC::Device.new(data)
       end
-      return devices
+      devices
     end
 
     def self.get_for_account_id(account_id)
-      self.get_for_account Account.get(account_id)
+      get_for_account Account.get(account_id)
     end
 
     def config_state
       @config_state ||= get_config_state
     end
 
-    def logs
-      # https://lmctest/#/project/6392b234-b11c-498a-a077-a5f5b23c54a0/devices/compact/eaafa152-62cf-48a1-be65-b222886daa6d/logging
-      #cloud = Cloud.instance
-      ##cloud.auth_for_accounts [id]
-      #cloud.get ["cloud-service-logging", "accounts", id, "logs?lang=DE"]
-      raise "device logs not supported"
+    def config
+      LMC::DeviceConfig.new(@cloud, @account, self)
     end
 
-    def record name
+    def record(name)
       MonitoringRecord.new(@cloud, @account, self, name)
     end
 
@@ -69,17 +60,21 @@ module LMC
       'DEVICE'
     end
 
+    def hwmask_hex
+      format format '%#010x', status['hwMask']
+    end
+
     private
 
+    ##
+    # TODO: This functionality is now duplicated in the DeviceConfig class and it's worse there.
     def get_config_state
-      reply = @cloud.get ["cloud-service-config", "configdevice", "accounts", @account.id, "state"], { "deviceIds" => @id }
+      reply = @cloud.get ['cloud-service-config', 'configdevice', 'accounts', @account.id, 'state'], 'deviceIds' => @id
       if reply.code == 200
         #            binding.pry
         DeviceConfigState.new reply.body[@id]
       end
     end
-
-
   end
-
 end
+

data/lib/lmc/Response.rb

@@ -3,7 +3,6 @@
 require 'ostruct'
 module LMC
   class LMCResponse
-
     attr_reader :body, :code, :headers
 
     def initialize(response)
@@ -12,7 +11,7 @@ module LMC
         @body_object = JSON.parse response.body
       end
       if @body_object.class == Array
-        @body = @body_object.map {|elem|
+        @body = @body_object.map { |elem|
           if elem.is_a? Hash then
             OpenStruct.new(elem)
           else
@@ -23,7 +22,7 @@ module LMC
       elsif @body_object.class == TrueClass || @body_object.class == FalseClass
         @body = @body_object
       else
-        raise "Unknown json parse result"
+        raise "Unknown json parse result: #{@body_object.class}"
       end
       @code = response.code
       @headers = response.headers
@@ -59,5 +58,5 @@ module LMC
         @body_object.empty?
     end
   end
-
 end
+

data/lib/lmc/Site.rb

@@ -3,38 +3,28 @@
 module LMC
   class Site
     attr_accessor :name
-    attr_reader :id, :account
+    attr_reader :id, :account, :subnet_group_id
 
     def initialize(data, account)
-      @cloud = Cloud.instance
-      @id = data["id"]
-      @name = data["name"]
-      @subnet_group_id = data["subnetGroupId"]
+      @cloud = account.cloud
+      @cloud.auth_for_account account if account
       @account = account
+      data = @cloud.get ['cloud-service-devices', 'accounts', @account.id, 'sites', data] if data.is_a? UUID
+
+      @id = data['id']
+      @name = data['name']
+      @subnet_group_id = data['subnetGroupId']
 
-      if @account
-        @cloud.auth_for_account @account
-      end
     end
 
     def to_s
       "#{@name}"
     end
 
-    def account=(account)
-      if @account == nil
-        @account = account
-        return true
-      else
-        raise "Cannot replace account for site"
-      end
-    end
-
     def configstates
-      response = @cloud.get ["cloud-service-config", "configsubnetgroup", "accounts", @account.id, "subnetgroups", @subnet_group_id, "updatestates"]
-      states = LMC::Configstates.new response.body
-      return states
+      response = @cloud.get ['cloud-service-config', 'configsubnetgroup', 'accounts', @account.id, 'subnetgroups', @subnet_group_id, 'updatestates']
+      LMC::Configstates.new response.body
     end
   end
-
 end
+

data/lib/lmc/User.rb

@@ -2,28 +2,28 @@
 
 module LMC
   class User
-    #todo: look into hiding password
+    # TODO: look into hiding password
     attr_reader :email
 
     def initialize(data)
-      @email = data["email"]
-      @password = data["password"]
+      @email = data['email']
+      @password = data['password']
     end
 
     # current registration process unclear and likely to have changed
     # since this code was written.
-    #def register()
+    # def register()
     #    # cloud instance by default authenticates.
     #    # for registration specifically, no authentication is required
     #    # should be possible without email and password for "admin" user
     #    cloud = Cloud.instance
     #    cloud.post ["cloud-service-auth", "users"], {"password" => @password, "email" => @email}
-    #end
+    # end
 
     def update(old_pw)
       cloud = Cloud.instance
       begin
-        cloud.post ["cloud-service-auth", "users", "self", "password"], {"password" => @password, 'verification' => old_pw}
+        cloud.post ['cloud-service-auth', 'users', 'self', 'password'], 'password' => @password, 'verification' => old_pw
       rescue RestClient::BadRequest => e
         response_body = JSON.parse(e.response)
         raise "#{e.message} - #{response_body['message']}"
@@ -32,11 +32,10 @@ module LMC
 
     def request_pw_reset
       action = AuthAction.new Cloud.instance
-      action.type="PASSWORD_RESET"
-      action.name=@email
+      action.type = 'PASSWORD_RESET'
+      action.name = @email
       action.post
     end
-
   end
+end
 
-end

data/lib/lmc/account_manager.rb

@@ -2,9 +2,9 @@
 
 module LMC
   class AccountManager
-    #@options
-    #@global_options
-    #@errors
+    # @options
+    # @global_options
+    # @errors
     attr_reader :errors
 
     def initialize(options, global_options)
@@ -15,59 +15,59 @@ module LMC
 
     # returns nil if invite did not work
     def invite(lmcen, distro, line, type, authority_name)
-      lmcen.auth_for_accounts([distro["id"]])
+      lmcen.auth_for_accounts([distro['id']])
       line = line.strip.downcase
       begin
-        account = Account.get(distro["id"])
+        account = Account.get(distro['id'])
         account_authorities = account.authorities
-        #puts account_authorities.inspect if @global_options[:debug]
+        # puts account_authorities.inspect if @global_options[:debug]
         if @global_options[:debug]
           account_authorities.each do |a|
-            puts a["name"]
+            puts a['name']
             puts a.inspect
           end
         end
-        authority = account_authorities.find {|auth| auth["name"] == authority_name}
-        #puts "account authorities: #{account_authorities}" if @global_options[:debug]
+        authority = account_authorities.find { |auth| auth['name'] == authority_name }
+        # puts "account authorities: #{account_authorities}" if @global_options[:debug]
         puts authority if @global_options[:debug]
         if !@options[:dry]
-          # TODO wenn der default authority nicht gibt geht das ding kaputt
-          invited = lmcen.invite_user_to_account(line, distro["id"], type, [authority["id"]])
-          puts "Invite response:" + invited.inspect if @global_options[:debug]
-          puts "Invited " + invited["name"].to_s + " to account #{distro["name"]}(#{invited.code})." if @global_options[:v]
+          # TODO: wenn der default authority nicht gibt geht das ding kaputt
+          invited = lmcen.invite_user_to_account(line, distro['id'], type, [authority['id']])
+          puts 'Invite response:' + invited.inspect if @global_options[:debug]
+          puts 'Invited ' + invited['name'].to_s + " to account #{distro['name']}(#{invited.code})." if @global_options[:v]
           if invited.code != 200
-            @errors << {:line => line, :result => invited.body}
+            @errors << { :line => line, :result => invited.body }
             return nil
           end
         else
-          invited = {"name" => line}
+          invited = { 'name' => line }
         end
 
-        invite_url = lmcen.build_url("#", "register", Base64.encode64(invited["name"]))
-        if @options["show-csv"]
-          puts "\n" + invited["name"] + ", " + invite_url
+        invite_url = lmcen.build_url('#', 'register', Base64.encode64(invited['name']))
+        if @options['show-csv']
+          puts "\n" + invited['name'] + ', ' + invite_url
         end
-        if @options["send-mail"] && invited
+        if @options['send-mail'] && invited
           mailbody = <<END
   Hallo,
-  auf #{lmcen.cloud_host} wurde eine Einladung zu dem Account #{distro["name"]} für den Nutzer #{invited["name"]} erstellt.
+  auf #{lmcen.cloud_host} wurde eine Einladung zu dem Account #{distro['name']} für den Nutzer #{invited['name']} erstellt.
   
   Falls der Account noch nicht existiert, kann dieser Link zur Registrierung genutzt werden:
 END
           mail = Mail.new do
-            from "Philipp Erbelding <philipp.erbelding@lancom.de>"
-            to invited["name"]
-            subject "Einladung auf " + lmcen.cloud_host
+            from 'Philipp Erbelding <philipp.erbelding@lancom.de>'
+            to invited['name']
+            subject 'Einladung auf ' + lmcen.cloud_host
             body mailbody + invite_url
           end
 
           puts invite_url
           if !@options[:dry]
-            puts "sending mail to " + invited["name"]
-            mail.delivery_method :smtp, address: "lcs-mail"
+            puts 'sending mail to ' + invited['name']
+            mail.delivery_method :smtp, address: 'lcs-mail'
             mail.deliver
           else
-            puts "[DRY RUN] would send mail to " + invited["name"]
+            puts '[DRY RUN] would send mail to ' + invited['name']
           end
           puts mail.to_s if @global_options[:v]
         end
@@ -77,9 +77,10 @@ END
         puts invited.inspect
         resp = JSON.parse(e.response)
         puts resp.inspect
-        puts resp["message"]
+        puts resp['message']
       end
-      return true
+      true
     end
   end
 end
+

data/lib/lmc/auth/auth_action.rb

@@ -14,9 +14,10 @@ module LMC
     def service_name
       'auth'
     end
+
     def collection_name
       'actions'
     end
-
   end
-end
+end
+

data/lib/lmc/authority.rb

@@ -5,6 +5,7 @@ module LMC
     attr_accessor :account, :id, :name, :visibility, :type
 
     def initialize(data, account)
+      # TODO: Use cloud object from account
       @cloud = Cloud.instance
       apply_data(data)
       @account = account
@@ -14,26 +15,26 @@ module LMC
       # GET /accounts/{accountId}/authorities/{authorityId}/rights
       @cloud.auth_for_account @account
       response = @cloud.get ['cloud-service-auth', 'accounts', @account.id, 'authorities', @id, 'rights']
-      return response.body.to_s
+      response.body.to_s
     end
 
-    #returns itself, allows chaining
+    # returns itself, allows chaining
     def save
       response = if @id.nil?
-                   Cloud.instance.post ["cloud-service-auth", 'accounts', @account.id, "authorities"], self
+                   Cloud.instance.post ['cloud-service-auth', 'accounts', @account.id, 'authorities'], self
                  else
-                   raise "editing authorities not supported"
-                   #@cloud.put ["cloud-service-auth", "principals", @id], self
+                   raise 'editing authorities not supported'
+                   # @cloud.put ["cloud-service-auth", "principals", @id], self
                  end
       apply_data(response.body)
-      return self
+      self
     end
 
     def to_json(*a)
       {
-          "name" => @name,
-          "type" => @type,
-          "visibility" => @visibility
+          'name' => @name,
+          'type' => @type,
+          'visibility' => @visibility
       }.to_json(*a)
     end
 
@@ -51,3 +52,4 @@ module LMC
     end
   end
 end
+

data/lib/lmc/config/device_config.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module LMC
+  # Represents a device config in LMC
+  class DeviceConfig
+    attr_reader :state
+
+    def url_configbuilder
+      ['cloud-service-config', 'configbuilder', 'accounts',
+       @account.id, 'devices', @device.id, 'ui']
+    end
+
+    def url_ticket
+      ['cloud-service-config',
+       'configbuilder',
+       'accounts',
+       @account.id,
+       'devices',
+       @device.id,
+       'tickets',
+       @ticket_id]
+    end
+
+    def url_state
+      %W(cloud-service-config configdevice accounts #{@account.id} state)
+    end
+
+    # def url_stringtable
+    #   ['cloud-service-config', 'configdsc', 'stringtable', dscui['stringtableId']]
+    # end
+
+    def initialize(cloud, account, device)
+      @cloud = cloud
+      @account = account
+      @device = device
+      @response = nil
+      @ticket_id = nil
+      # state returns an object with each requested device id pointing to a state object.
+      @state = @cloud.get(url_state, deviceIds: @device.id.to_s).body[@device.id]
+    end
+
+    def configjson
+      confighash.to_json
+    end
+
+    def confighash
+      items.to_h
+    end
+
+    ##
+    # Returns a hash similar to #confighash but with the OIDs replaced with more
+    # meaningful descriptions.
+
+    def descriptive_confighash
+      item_map = dscui.item_by_id_map
+      confighash.map { |k, v|
+        [item_map[k].description, v]
+      }.to_h
+    end
+
+    def items
+      response.items
+    end
+
+    def dscui
+      @dscui ||= DeviceDSCUi.new @device
+    end
+
+    def lcf
+      # lfc format findings:
+      # group headings in {} do not matter
+      # indentation does not matter
+      # table oids need to be enclosed in <>
+      # table cell oids need to be enclosed in () and should follow table oids
+
+      result = ''
+      result += lcf_header
+      items.each do |key, value|
+        if value.instance_of? String
+          result += "#{key} = #{value}\n"
+        elsif value.instance_of? Hash
+          rows = value['rows']
+          col_ids = value['colIds']
+          if rows.length > 0
+            result += "<#{key}>\n"
+            rows.each_with_index { |row, index|
+              row.each_with_index { |col, col_index|
+                result += "(#{key}.#{index + 1}.#{col_ids[col_index]}) = #{col}\n"}
+            }
+          end
+        else
+          raise 'Unexpected value in config items: ' + value.class.to_s
+        end
+      end
+      result += lcf_footer
+    end
+
+    def current_device_type
+      OpenStruct.new JSON.parse state['currentDeviceType']
+    end
+
+    ##
+    # @return [String]
+    def feature_mask_lower32_hex
+      feature_mask = 0
+      lower_features = current_device_type.features.select { |feature| feature < 32 }
+      lower_features.each do |feature_pos|
+        feature = 2**feature_pos
+        feature_mask = feature_mask | feature
+      end
+      if feature_mask == 0
+        '0x00000000'
+      else
+        format '%#010x', feature_mask
+      end
+    end
+
+    def lcf_device_version
+      v = 'v'
+      v += "#{@device.status['fwMajor']}."
+      v += "#{@device.status['fwMinor']}."
+      v + format('%04d', @device.status['fwBuild'])
+    end
+
+    ##
+    # Gives the feature IDs as a string like this: "IDs:2,3,f"
+    # @return [String]
+    def lcf_feature_id_string
+      hex_features = current_device_type.features.map { |feature| feature.to_s 16 }
+      "IDs:#{hex_features.join(',')}"
+    end
+
+    private
+
+    ##
+    # Produces lcf header
+    # @return [String]
+    def lcf_header
+      "(LMC Configuration of '#{@device.name}' at #{Time.now} via ruby-lmc #{LMC::VERSION})
+(#{@device.status['fwLabel']}) (#{lcf_feature_hw_string})
+[#{@device.model}] #{lcf_device_version}
+[TYPE: LCF; VERSION: 1.00; HASHTYPE: none;]
+"
+    end
+
+    ##
+    # Gives the feature mask, the feature IDs and the hardware mask as string for the lcf
+    # header like this: "0x0000c010,IDs:4,e,f//e0901447,2b;0x0c000002"
+    # @return [String]
+    def lcf_feature_hw_string
+      "#{feature_mask_lower32_hex},#{lcf_feature_id_string};#{@device.hwmask_hex}"
+    end
+
+    def lcf_footer
+      "[END: LCF;]\n"
+    end
+
+    def response
+      return @response unless @response.nil?
+      fetch_result
+    end
+
+    def fetch_result
+      response_or_ticket = @cloud.get(url_configbuilder).body
+      if response_or_ticket.respond_to? 'ticketId'
+        @ticket_id = response_or_ticket.ticketId
+        redeem_ticket 5
+      else
+        @response = response_or_ticket
+      end
+      @response
+    end
+
+    def redeem_ticket(tries)
+      attempts = 1
+      until @response
+        raise 'Too many attempts' if attempts > tries
+        attempts += 1
+        body = @cloud.get(url_ticket).body
+        unless body.respond_to? :ticketId
+          @ticket_id = nil
+          @response = body
+        end
+        sleep 0.5
+      end
+    end
+
+    # def stringtable
+    #  @stringtable ||= @cloud.get(url_stringtable).body
+    # end
+  end
+end
+