lmc 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31077763003e89d0d7d95ccf0882eca185921b9b
-  data.tar.gz: 20f58644eeb3bbf19f9a20142f6603147f028a51
+  metadata.gz: 4cf28191aafd359f60cc8d8d3eb7b9c4ffb4ff6a
+  data.tar.gz: 109b27a7784b63820b94a63d04ca53174a59a687
 SHA512:
-  metadata.gz: 7eb1f25f826afe31759b6a553acd5fbeee9aaef610a09a9e280441d21390fca1e169fc00a1aa77ba81d7567940ecb5b7de3730658ee4cc93b7262fb79be04bd6
-  data.tar.gz: 2054e10d846866b107e70e12c6413adc863cf5a48a0b3399254db08c72e4f042b887bee326cb8d8efd3f2e5922c8fab2e372eabcf24ce644c9876548198c1035
+  metadata.gz: 2ce921af5e82516e865bb5241719f7efb09b90dfac67d6d82402ffa06bc4b27bd108735784b25cccff56e0c2193e8c8c198ad879d443b9ea723353b93bb0a1bc
+  data.tar.gz: db341afd04ed21951870cd9a982c27d0bf93eee1a9872dce292bc6c9f324e27d62ca66021709cb7d9a04a09d709f2ca1154bb7eec7cb18a22baece62f4775492

data/.idea/encodings.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" addBOMForNewFiles="with NO BOM" />
+</project>

data/.rubocop.yml

@@ -1,2 +1,4 @@
 Layout/IndentHash:
-  IndentationWidth: 4
+  IndentationWidth: 4
+Metrics/LineLength:
+  Max: 110

data/PATTERNS.md

@@ -0,0 +1,26 @@
+# Should establish
+## URLs in ressource classes
+Add methods to build urls
+
+    def url_configbuilder
+      ['cloud-service-config', 'configbuilder', 'accounts',
+       @account.id, 'devices', @device.id, 'ui']
+    end
+
+Not decided yet if private or public
+
+## Parameter ordering for initialize methods
+
+Library/API objects ordered from least to most specific.
+Object specific data hashes go last.
+
+### Embedding the Cloud object in ressources
+* First parameter in initalizer
+* Saved in @cloud instance var
+* Should be exposed via getter (attr_reader)
+
+It' is also okay to use Cloud object from parent object if a reasonable one is passed.
+
+
+# Unsolved, bad
+* Cloud http methods (get, etc.) return response object. 99% of the time, have to call .body on it

data/Rakefile

@@ -1,17 +1,40 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 require 'rubocop/rake_task'
+require 'rdoc/task'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-
 RuboCop::RakeTask.new(:autocop) do |t|
-  t.options = ['--only', 'Style/FrozenStringLiteralComment', '--auto-correct', 'lib', 'test', 'Rakefile', 'lmc.gemspec']
+  autofix = [
+      'Layout/EmptyLines',
+      'Layout/EmptyLinesAroundClassBody',
+      'Layout/EmptyLinesAroundModuleBody',
+      'Layout/EmptyLineBetweenDefs',
+      'Layout/LeadingCommentSpace',
+      'Layout/SpaceAroundOperators',
+      'Layout/SpaceInsideBlockBraces',
+      'Layout/SpaceInsideHashLiteralBraces',
+      'Layout/TrailingBlankLines',
+      'Style/BracesAroundHashParameters',
+      'Style/CommentAnnotation',
+      'Style/FrozenStringLiteralComment',
+      'Style/MethodDefParentheses',
+      'Style/RedundantSelf',
+      'Style/RedundantReturn',
+      'Style/StringLiterals',
+      'Style/StringLiteralsInInterpolation']
+  t.options = ['--only', autofix.join(','), '--auto-correct', 'lib', 'test', 'Rakefile', 'lmc.gemspec']
 end
 task :default => :test
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+end

data/coverage/.last_run.json

@@ -1,5 +1,5 @@
 {
   "result": {
-    "covered_percent": 84.99
+    "covered_percent": 90.56
   }
 }

data/lib/lmc.rb

@@ -11,7 +11,7 @@ module LMC
                  'cloud-service-licenses']
 
   def self.useful
-    return true
+    true
   end
 end
 
@@ -23,9 +23,8 @@ Dir.glob(File.expand_path('../lmc/*.rb', __FILE__)).each do |file|
   require file
 end
 
-['exceptions', 'auth', 'monitoring'].each do |folder|
+['exceptions', 'auth', 'config', 'monitoring'].each do |folder|
   Dir.glob(File.expand_path("../lmc/#{folder}/*.rb", __FILE__)).each do |file|
     require file
   end
 end
-

data/lib/lmc/Account.rb

@@ -10,17 +10,17 @@ module LMC
 
     def self.get(id)
       cloud = Cloud.instance
-      result = cloud.get ["cloud-service-auth", "accounts", id.to_s]
-      return Account.new(result.body)
+      result = cloud.get ['cloud-service-auth', 'accounts', id.to_s]
+      Account.new(cloud, result.body)
     end
 
-    def self.get_by_uuid uuid
-      raise "Missing argument" if uuid.nil?
-      return self.get uuid
+    def self.get_by_uuid(uuid)
+      raise 'Missing argument' if uuid.nil?
+      get uuid
     end
 
     def self.get_by_name(name, type = nil)
-      raise "Missing argument" if name.nil?
+      raise 'Missing argument' if name.nil?
       accounts = Cloud.instance.get_accounts_objects.select do |a|
         (name.nil? || a.name == name) && (type.nil? || a.type == type)
       end
@@ -33,21 +33,21 @@ module LMC
       end
     end
 
-    def initialize(data)
-      @cloud = LMC::Cloud.instance
+    def initialize(cloud, data)
+      @cloud = cloud
       apply_data(data)
     end
 
-    #returns itself, allows chaining
+    # returns itself, allows chaining
     def save
       response = if @id.nil?
                    @cloud.auth_for_accounts [@parent]
-                   @cloud.post ["cloud-service-auth", "accounts"], self
+                   @cloud.post ['cloud-service-auth', 'accounts'], self
                  else
                    @cloud.post path, self
                  end
       apply_data(response.body)
-      return self
+      self
     end
 
     def delete!
@@ -56,11 +56,11 @@ module LMC
         delete_action = AuthAction.new @cloud
         delete_action.type = AuthAction::ACCOUNT_DELETE
         delete_action.name = Cloud.user
-        delete_action.data = {'password' => Cloud.password,
-                              'accountId' => @id}
+        delete_action.data = { 'password' => Cloud.password,
+                              'accountId' => @id }
         delete_action.post
         @id = nil
-        return true
+        true
       end
     end
 
@@ -71,32 +71,32 @@ module LMC
     end
 
     def members
-      ids = Cloud.instance.get ["cloud-service-auth", "accounts", @id, 'members'], {"select" => "id"}
+      ids = Cloud.instance.get ['cloud-service-auth', 'accounts', @id, 'members'], 'select' => 'id'
       puts ids.inspect if Cloud.debug
       principals = ids.map do |principal_id|
-        response = Cloud.instance.get ["cloud-service-auth", "accounts", @id, 'members', principal_id]
+        response = Cloud.instance.get ['cloud-service-auth', 'accounts', @id, 'members', principal_id]
         principal = response.body
         puts principal.inspect if Cloud.debug
         principal
       end
-      return principals
+      principals
     end
 
-    def find_member_by_name name
-      members.find {|m| m.name == name}
+    def find_member_by_name(name)
+      members.find { |m| m.name == name }
     end
 
-    #def update_member(principal_id, data)
+    # def update_member(principal_id, data)
     #  response = @cloud.post ["cloud-service-auth", "accounts", id, 'members', principal_id], data
     #  return response
-    #end
+    # end
 
     def remove_membership(member_id)
-      @cloud.delete ["cloud-service-auth", "accounts", id, "members", member_id]
+      @cloud.delete ['cloud-service-auth', 'accounts', id, 'members', member_id]
     end
 
     def remove_membership_self
-      @cloud.delete ["cloud-service-auth", "accounts", id, "members", "self"]
+      @cloud.delete ['cloud-service-auth', 'accounts', id, 'members', 'self']
     end
 
     def authority(authority_id)
@@ -112,30 +112,29 @@ module LMC
       authorities = response.body.map do |r|
         Authority.new r, self
       end
-      return authorities
+      authorities
     end
 
     def children
-      @cloud.auth_for_accounts([self.id, ROOT_ACCOUNT_UUID])
+      @cloud.auth_for_accounts([id, ROOT_ACCOUNT_UUID])
       response = @cloud.get ['cloud-service-auth', 'accounts', id, 'children']
-      response.map {|child| Account.new child}
+      response.map { |child| Account.new @cloud, child }
     end
 
-
     def logs
       # https://lmctest/cloud-service-logging/accounts/6392b234-b11c-498a-a077-a5f5b23c54a0/logs?lang=DE
       cloud = Cloud.instance
       cloud.auth_for_accounts [id]
-      cloud.get(["cloud-service-logging", "accounts", id, "logs?lang=DE"]).body
+      cloud.get(['cloud-service-logging', 'accounts', id, 'logs?lang=DE']).body
     end
 
     def sites
       # private clouds can not have sites
-      return [] if @type == "PRIVATE_CLOUD"
+      return [] if @type == 'PRIVATE_CLOUD'
       @cloud.auth_for_accounts([id])
-      response = @cloud.get ["cloud-service-devices", "accounts", id, "sites"]
-      return response.body.map {|data|
-        Site.new(data, self)
+      response = @cloud.get ['cloud-service-devices', 'accounts', id, 'sites'], {:select => :id}
+      response.body.map { |data|
+        Site.new(UUID.new(data), self)
       }
     end
 
@@ -145,16 +144,16 @@ module LMC
 
     def config_updatestates
       @cloud.auth_for_accounts([id])
-      response = @cloud.get ["cloud-service-config", "configdevice", "accounts", id, "updatestates"]
-      return LMC::Configstates.new response.body
+      response = @cloud.get ['cloud-service-config', 'configdevice', 'accounts', id, 'updatestates']
+      LMC::Configstates.new response.body
     end
 
     def to_json(*a)
       {
-          "name" => @name,
-          "state" => @state,
-          "type" => @type,
-          "parent" => @parent
+          'name' => @name,
+          'state' => @state,
+          'type' => @type,
+          'parent' => @parent
       }.to_json(*a)
     end
 
@@ -166,17 +165,16 @@ module LMC
 
     ## should be put into entity or such
     def path
-      ["cloud-service-auth", "accounts", @id].join("/")
+      ['cloud-service-auth', 'accounts', @id].join('/')
     end
 
     def apply_data(data)
-      @id = data["id"]
-      @parent = data["parent"]
-      @name = data["name"]
-      @state = data["state"]
-      @type = data["type"]
-      @identifier = data["identifier"]
+      @id = data['id']
+      @parent = data['parent']
+      @name = data['name']
+      @state = data['state']
+      @type = data['type']
+      @identifier = data['identifier']
     end
-
   end
 end

data/lib/lmc/Cloud.rb

@@ -12,9 +12,10 @@ module LMC
       Cloud.verify_tls = true
     end
 
-    def self.instance(opts = {authorize: true})
-      @@inst ||= self.new(@cloud_host, @user, @password, opts[:authorize])
+    def self.instance(opts = { authorize: true })
+      @@inst ||= new(@cloud_host, @user, @password, opts[:authorize])
     end
+
     attr_reader :auth_ok, :cloud_host, :user, :password
 
     def initialize(cloud_host, user, pass, auth = true)
@@ -47,17 +48,17 @@ module LMC
       result = get ['cloud-service-auth', 'accounts']
       if result.code == 200
         accounts = result.map do |aj|
-          Account.new(aj)
+          Account.new(self, aj)
         end
       else
         raise "Unable to fetch accounts: #{result.body.message}"
       end
 
-      return accounts
+      accounts
     end
 
     def invite_user_to_account(email, account_id, type, authorities = [])
-      body = {name: email, state: 'ACTIVE', type: type}
+      body = { name: email, state: 'ACTIVE', type: type }
       body['authorities'] = authorities
       post ['cloud-service-auth', 'accounts', account_id, 'members'], body
     end
@@ -117,26 +118,31 @@ module LMC
       ["#{protocol}://#{@cloud_host}", path_components].flatten.compact.join('/')
     end
 
-    def auth_for_accounts(account_ids)
-      puts 'Authorizing for accounts: ' + account_ids.to_s if Cloud.debug
-      authorize(account_ids)
+    def auth_for_accounts(accounts)
+      authorize(accounts)
     end
 
     def auth_for_account(account)
-      auth_for_accounts([account.id])
+      authorize([account])
     end
 
     def accept_tos(tos)
       authorize([], tos)
     end
 
-
     private
 
-    def authorize(account_ids = [], tos = [])
+    def authorize(accounts = [], tos = [])
+      account_ids = accounts.map { |a|
+        if a.respond_to? :id
+          a.id
+        else
+          a
+        end
+      }
       if account_ids != @last_authorized_account_ids
         begin
-          reply = post(['cloud-service-auth', 'auth'], {name: @user, password: @password, accountIds: account_ids, termsOfUse: tos})
+          reply = post(['cloud-service-auth', 'auth'], name: @user, password: @password, accountIds: account_ids, termsOfUse: tos)
           puts 'authorize reply ' + reply.inspect if Cloud.debug
           @last_authorized_account_ids = account_ids
           @auth_token = reply
@@ -160,7 +166,7 @@ module LMC
       if @auth_ok
         headers[:Authorization] = auth_bearer
       end
-      return headers
+      headers
     end
 
     def rest_options

data/lib/lmc/Configstates.rb

@@ -5,12 +5,10 @@ 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,20 @@ 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