lmc 0.8.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31077763003e89d0d7d95ccf0882eca185921b9b
-  data.tar.gz: 20f58644eeb3bbf19f9a20142f6603147f028a51
+SHA256:
+  metadata.gz: ec4925e30542f46b5b9c991de79a672a9eabeffda07028620aaa6fa14e62c551
+  data.tar.gz: 0eb5b5654694a1eb90e920df6d00d67cf4b8dda7c42fa167760d9c329bd88341
 SHA512:
-  metadata.gz: 7eb1f25f826afe31759b6a553acd5fbeee9aaef610a09a9e280441d21390fca1e169fc00a1aa77ba81d7567940ecb5b7de3730658ee4cc93b7262fb79be04bd6
-  data.tar.gz: 2054e10d846866b107e70e12c6413adc863cf5a48a0b3399254db08c72e4f042b887bee326cb8d8efd3f2e5922c8fab2e372eabcf24ce644c9876548198c1035
+  metadata.gz: ebbb8a5bcb4eb5cdaf9f0236394f18572922a70e42f7218b9d942420e4234ff30071549fff0c37e5e6e82ffcf3cce61b8b351921915ca749f7e947a8b33e74f0
+  data.tar.gz: c4008e578e219956662b9b0239a543c95f921099cee0dca7553b8770cf4a986fd872b3867a506327a2c4ea522244984341e72dfb970193f1837729c71b078601

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/.idea/inspectionProfiles/Project_Default.xml

@@ -1,7 +1,7 @@
 <component name="InspectionProjectProfileManager">
   <profile version="1.0">
     <option name="myName" value="Project Default" />
-    <inspection_tool class="Rubocop" enabled="true" level="WARNING" enabled_by_default="true">
+    <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="true">
       <scope name="Tests" level="ERROR" enabled="true" />
     </inspection_tool>
     <inspection_tool class="RubyInstanceMethodNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">

data/.rubocop.yml

@@ -1,2 +1,8 @@
-Layout/IndentHash:
-  IndentationWidth: 4
+Layout/TrailingEmptyLines:
+  EnforcedStyle: final_blank_line
+Layout/FirstHashElementIndentation:
+  IndentationWidth: 4
+Layout/LineLength:
+  Max: 110
+Style/IfUnlessModifier:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.7.1

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,42 @@
 # 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/TrailingEmptyLines',
+      'Style/CommentAnnotation',
+      'Style/FrozenStringLiteralComment',
+      'Style/MethodDefParentheses',
+      'Style/RedundantSelf',
+      'Style/RedundantReturn',
+      'Style/StringLiterals',
+      'Style/StringLiteralsInInterpolation',
+      'Style/StabbyLambdaParentheses',
+  ]
+  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": 91.53
   }
 }

data/lib/lmc.rb

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

data/lib/lmc/Account.rb

@@ -10,22 +10,22 @@ 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
       if accounts.length == 1
-        return accounts[0]
+        accounts[0]
       elsif accounts.length == 0
         raise 'Did not find account'
       else
@@ -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,39 @@ 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)
+      if name.nil?
+        raise 'No member name given'
+      end
+      member = members.find { |m| m.name == name }
+      unless member
+        raise "Member named #{name} not found in account #{self}"
+      end
+      member
     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 +119,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 +151,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
 
@@ -162,21 +168,25 @@ module LMC
       "#{name}"
     end
 
+    def summary
+      "\"#{@name}\" (#{@type}) ID: #{@id}"
+    end
+
     private
 
     ## 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,21 +48,26 @@ 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
 
+    # @param section Array of String to indicate section to access. Example: ['principal', 'self', 'ui']
+    def preferences(section)
+      LMC::Preferences.new cloud: self, section: section
+    end
+
     def get(path, params = nil)
       prepared_headers = headers
       prepared_headers[:params] = params
@@ -73,31 +79,37 @@ module LMC
       execute_request args
     end
 
-    def put(path, body_object)
+    def put(path, body_object, params = nil)
+      prepared_headers = headers
+      prepared_headers[:params] = params
       args = {
           :method => :put,
           :url => build_url(path),
-          :payload => body_object.to_json
-
+          :payload => body_object.to_json,
+          :headers => prepared_headers
       }
       execute_request args
     end
 
-    def post(path, body_object)
+    def post(path, body_object, params=nil )
+      prepared_headers = headers
+      prepared_headers[:params] = params
       args = {
           :method => :post,
           :url => build_url(path),
-          :payload => body_object.to_json
+          :payload => body_object.to_json,
+          :headers => prepared_headers
       }
       execute_request args
     end
 
-    def delete(path, body_object = nil)
+    def delete(path, params = nil)
+      prepared_headers = headers
+      prepared_headers[:params] = params
       args = {
           :method => :delete,
           :url => build_url(path),
-          :payload => body_object.to_json,
-          :headers => headers
+          :headers => prepared_headers
       }
       execute_request args
     end
@@ -117,27 +129,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})
-          puts 'authorize reply ' + reply.inspect if Cloud.debug
+          reply = post(['cloud-service-auth', 'auth'], name: @user, password: @password, accountIds: account_ids, termsOfUse: tos)
           @last_authorized_account_ids = account_ids
           @auth_token = reply
           @auth_ok = true
@@ -160,7 +176,7 @@ module LMC
       if @auth_ok
         headers[:Authorization] = auth_bearer
       end
-      return headers
+      headers
     end
 
     def rest_options
@@ -175,17 +191,16 @@ module LMC
       internal_args.merge! args
       begin
         resp = RestClient::Request.execute internal_args
-        return LMCResponse.new(resp)
+        LMCResponse.new(resp)
       rescue RestClient::ExceptionWithResponse => e
-        print_exception e if Cloud.debug
+        if Cloud.debug
+          puts 'EXCEPTION: ' + e.to_s
+          puts 'EX.response: ' + e.response.to_s
+          puts JSON.parse(e.response)['message']
+        end
         raise e
       end
     end
-
-    def print_exception(execption)
-      puts 'EXCEPTION: ' + execption.to_s
-      puts 'EX.response: ' + execption.response.to_s
-      puts JSON.parse(execption.response)['message']
-    end
   end
 end
+