lmcadm 0.15.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c6d0a6cd45c6c772311396c13646899f7db20675004254fc70cb1821620d3c
-  data.tar.gz: 93484873efe2767cb5c7911d00e72be3937cc7fbed2e29dfd3cbaeeb4d634d1d
+  metadata.gz: ca0dd10565f531737baa49a5fbfef88cd87428354379bfea56479b695f6a9447
+  data.tar.gz: 057bef12dff7c5b8ec69b6f833343789c4682595b6bd99f4dbce64b1a740b6af
 SHA512:
-  metadata.gz: d9790f5e3e28fcd2fc3b4a8633b47019b3190e166bc15e9e926ee552620a6ad9a1edb4364f2355c9c4a0cc523db6997f042bccbcdf8f07d781611d1fdf4759ee
-  data.tar.gz: 92ed71b779d0bb817035a51965f4c308ce76cff89c4ddc86f8b06faf940766242e513260164eec6fb62b9c198fbb1e722072a8dc9c65e1be2f475070221d01f8
+  metadata.gz: b4d94f44775a0c2bea6b8e0c7376af6e7b21268670f0bc119e83d1ea2de670e8477012e717eb52df18651af18c51186551e4c71f10bd1d78bf5b4838df486f4f
+  data.tar.gz: f45285b9223ada9c9213f99e351335f59aff2e6f9ee0038b12efe14cec3e8f0bdc6564f87db76082efce72d36128de84e45d2d50ae4414a10170f779fa6edb91

data/.github/workflows/build-win.yaml

@@ -0,0 +1,35 @@
+name: build-win
+on:
+  release:
+    types:
+      - published
+
+#  push:
+#    tags:
+#      - 'v*.*.*'
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+      - run: gem install eventmachine --platform ruby
+      - run: gem install ocra lmcadm
+      - run: ruby makeocragemfile.rb
+      - run: ocra --gemfile ocra_gemfile --gem-full exe/lmcadm
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: false
+      - run: ./lmcadm.exe --version
+      - uses: papeloto/action-zip@v1
+        with:
+          files: lmcadm.exe LICENSE.txt
+          dest: lmcadm-${{ github.event.release.tag_name }}-win.zip
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: lmcadm-${{ github.event.release.tag_name }}-win.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

data/.gitignore

@@ -15,3 +15,5 @@
 /.idea/modules.xml
 /Gemfile.lock
 /lmcadm-*.gem
+ocra_gemfile
+lmcadm*.exe

data/README.md

@@ -14,6 +14,25 @@ These can usually be installed the same way ruby was installed.
 
 On Ubuntu for example, installing the `ruby-dev` via the package manager is sufficient.
 
+### Windows
+
+Lmcadm works with https://rubyinstaller.org/downloads/, use the recommended version with Devkit and choose the default options during install.
+Installation can continue with rubygems.
+
+#### Known issues
+*Installing lmcadm fails with `ERROR: Failed to build gem native extension.`*
+
+Ruby headers and some tools to build software (C compiler, make) are needed.
+On Ubuntu for example, the packages `ruby-dev` and `build-essential` should be enough.
+    apt install ruby-dev build-essential
+
+*Unable to load the EventMachine C extension ; To use the pure-ruby reactor, require 'em/pure_ruby'*
+
+Workaround: Reinstall eventmachine with --platform ruby.
+
+    gem uninstall eventmachine  (select all versions if prompted)
+    gem install eventmachine --platform ruby
+
 ## Usage
 
 The primary usage documentation is in the help output of lmcadm:
@@ -32,6 +51,11 @@ Set the environment variable LMCADM\_PATH\_DEP to 1 to use the _lmc_ gem from ..
 Example:
     $ LMCADM_PATH_DEP=1 bundle exec lmcadm --version
 
+### Building an exe for windows using ocra
+
+* Apply workaround reinstalling eventmachine (see above)
+* run ocra.sh
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lmcadm.
@@ -40,3 +64,38 @@ The sentence above is patently wrong currently.
 ## License
 
 The gem is available as open source under the terms of the BSD 3-Clause License.
+
+# Advanced usage or experimental features
+
+## Using lmcadm to query monitoring data
+
+Example use:
+
+    lmcadm monitor -A "ExampleProject" raw device_info cloud_rtt 42adf60b-0fe7-4187-af4f-9ee97669bfb0
+
+### --type scalar (default)
+
+When specifying a period longer than MINUTE1, the name must be suffixed with a dot, followed by an aggregation type.
+Available types are
+* .min
+* .max
+* .avg
+
+Example use:
+
+    lmcadm monitor -A "ExampleProject" raw --type scalar --period MINUTE10 \
+        device_info cloud_rtt.max 3e19ada7-86fa-4809-a14e-7174b018603d
+
+
+### --type json
+
+This dumps the raw values response as json.
+To further extract data, use something that can parse json, like `jq`[1].
+
+Example use:
+
+    lmcadm monitor -A "SDN-DEMO (LANCOM Visitor)" raw --type json --period MINUTE1 \
+      wan_info_json interfaces a6871a81-84f3-4c57-a20e-c3410b47e895  | jq ' .[]["DSL-CH-1"].rxRate'
+
+# Footnotes
+[1] https://stedolan.github.io/jq/manual/

data/exe/lmcadm

@@ -85,6 +85,9 @@ module LMCAdm
     ::LMC::Cloud.verify_tls = global["verify-tls"]
     ::LMC::Cloud.use_tls = global["use-tls"]
     LMCAdm::ProgressVisualizer.take_time = global["take-time"]
+    # let table_print print wide columns
+    tp.set :max_width, 50
+
     true
   end
 
@@ -106,5 +109,8 @@ module LMCAdm
     true
   end
 
+  if Encoding.find('locale') != 'UTF-8'
+    STDIN.set_encoding(Encoding.find('locale'),'UTF-8')
+  end
   exit run(ARGV)
 end

data/lib/lmcadm/account_commands.rb

@@ -26,7 +26,7 @@ module LMCAdm
             a["type"] == options[:account_type]
           end
         end
-        accounts.sort {|a, b| a["name"] <=> b["name"]}.each do |account|
+        accounts.sort { |a, b| a["name"] <=> b["name"] }.each do |account|
           puts account.inspect if global_options[:v]
           if options[:l]
             puts account.summary
@@ -82,9 +82,9 @@ module LMCAdm
       account_create.action do |global_options, options, args|
         parent = LMC::Account.get_by_uuid_or_name options[:p]
         t = ProgressVisualizer.new "Creating object"
-        a = LMC::Account.new(LMC::Cloud.instance, {"name" => args.first,
-                                                   "type" => options[GLI::Command::PARENT][:account_type],
-                                                   "parent" => parent.id})
+        a = LMC::Account.new(LMC::Cloud.instance, { "name" => args.first,
+                                                    "type" => options[GLI::Command::PARENT][:account_type],
+                                                    "parent" => parent.id })
         t.done
         t = ProgressVisualizer.new "Saving #{a.name}"
         result = a.save
@@ -106,13 +106,13 @@ module LMCAdm
         t = ProgressVisualizer.new "Getting accounts"
         if options[:e]
           accounts = LMC::Cloud.instance.get_accounts_objects
-          matched_accounts = accounts.select {|account| /#{args.first}/.match(account.name)}
+          matched_accounts = accounts.select { |account| /#{args.first}/.match(account.name) }
         else
           matched_accounts = [LMC::Account.get_by_uuid_or_name(args.first)]
         end
         t.done
         puts 'Accounts to delete:'
-        puts matched_accounts.map {|a| "#{a.id} - #{a.name}"}.join("\n")
+        puts matched_accounts.map { |a| "#{a.id} - #{a.name}" }.join("\n")
         print('Type yes to confirm: ')
         exit unless STDIN.gets.chomp == 'yes'
         t = ProgressVisualizer.new "Deleting accounts"
@@ -159,12 +159,12 @@ module LMCAdm
       memberlist.action do |global_options, options, args|
         account = LMC::Account.get_by_uuid_or_name args.first
         members = account.members
-        tp members, [{:id => {:width => 36}}, :name, :type, :state, :invitationState, :principalState,
-                     :authorities => {:display_method => lambda {|m|
-                       m.authorities.map {|a|
+        tp members, [{ :id => { :width => 36 } }, :name, :type, :state, :invitationState, :principalState,
+                     :authorities => { :display_method => lambda { |m|
+                       m.authorities.map { |a|
                          a['name']
                        }.join(',')
-                     }, :width => 128}]
+                     }, :width => 128 }]
       end
     end
 
@@ -174,8 +174,8 @@ module LMCAdm
       auth.action do |_g, _o, args|
         account = LMC::Account.get_by_uuid_or_name args.first
         authorities = account.authorities
-        max = Helpers::longest_in_collection(authorities.map {|a| a.name})
-        tp authorities, [{:id => {:width => 36}}, {:name => {:width => max}}, :visibility, :type]
+        max = Helpers::longest_in_collection(authorities.map { |a| a.name })
+        tp authorities, [{ :id => { :width => 36 } }, { :name => { :width => max } }, :visibility, :type]
       end
     end
 
@@ -187,7 +187,7 @@ module LMCAdm
         create.flag :A, :required => true
         create.action do |_global_options, options, _args|
           account = LMC::Account.get_by_uuid_or_name options[:A]
-          auth = LMC::Authority.new({'name' => _args.first, 'visibility' => 'PRIVATE'}, account)
+          auth = LMC::Authority.new({ 'name' => _args.first, 'visibility' => 'PRIVATE' }, account)
           puts auth.save
         end
       end
@@ -202,7 +202,7 @@ module LMCAdm
       account_invite.action do |global_options, options, args|
         account = LMC::Account.get_by_uuid_or_name options[:account]
         cloud = LMC::Cloud.instance
-        chosen_authorities = account.authorities.select {|auth| auth.name == options[:role]}
+        chosen_authorities = account.authorities.select { |auth| auth.name == options[:role] }
         args.each do |email|
           cloud.invite_user_to_account email, account.id, options[:type], chosen_authorities
         end
@@ -256,28 +256,37 @@ module LMCAdm
       update.flag :A, :account, :required => true
       update.desc 'authority id'
       update.flag 'add-authority'
-      update.action do |_global_options, options, args|
+      update.desc 'authority name|id'
+      update.flag 'remove-authority'
+      update.action do |global_options, options, args|
         account = LMC::Account.get_by_uuid_or_name(options[:account])
+        account.cloud.auth_for_account account
         membership = account.find_member_by_name args.first
-        puts membership
+        if global_options[:verbose]
+          puts "membership class: #{membership.class}"
+          puts "membership.authorities first class: #{membership.authorities.first.class}"
+          puts membership
+        end
+        authority_ids = membership.authorities.map do |a|
+          a.id
+        end
+        puts "Existing authority ids: #{authority_ids}"
         if options['add-authority']
-          # new_authority = account.authorities.find do |a|
-          #   a.name == options['add-authority']
-          # end
-          puts membership.class
-          puts membership.authorities.class
-          authority_ids = membership.authorities.map do |a|
-            a['id']
-          end
-          puts authority_ids
-          authority_ids = authority_ids.concat [options['add-authority']]
-          puts authority_ids
-          # POST /accounts/{accountId}/members/{principalId}
-          cloud = LMC::Cloud.instance
-          cloud.auth_for_account account
-          res = cloud.post ['cloud-service-auth', 'accounts', account.id, 'members', membership.id], {'authorities' => authority_ids}
-          puts res
+          add_str = options['add-authority']
+          new_authority = Helpers::find_by_id_or_name account.authorities, add_str
+          authority_ids = authority_ids.concat [new_authority.id]
+          puts "Adding #{authority_ids}"
         end
+        if options['remove-authority']
+          remove_str = options['remove-authority']
+          deleting_authority = Helpers.find_by_id_or_name account.authorities, remove_str
+          puts "Removing #{deleting_authority}"
+          authority_ids = authority_ids - [deleting_authority.id]
+        end
+        puts "New authority ids: #{authority_ids}"
+        # POST /accounts/{accountId}/members/{principalId}
+        res = account.cloud.post ['cloud-service-auth', 'accounts', account.id, 'members', membership.id], { 'authorities' => authority_ids }
+        puts res
       end
     end
 
@@ -288,16 +297,12 @@ module LMCAdm
       children.flag :special
       children.action do |global_options, options, args|
         account = LMC::Account.get_by_uuid_or_name args.first
-        cloud = LMC::Cloud.instance
 
         def recurse_childen account, indent_level
           children = account.children
           children.each do |child|
             puts '  ' * indent_level + child.to_s
-            begin
-              recurse_childen child, indent_level + 1
-            rescue RestClient::Forbidden => e
-            end
+            recurse_childen child, indent_level + 1
           end
         end
 

data/lib/lmcadm/cloud_commands.rb

@@ -86,6 +86,7 @@ module LMCAdm
         accounts = args.map { |a|
           LMC::Account.get_by_uuid_or_name a
         }
+        puts LMC::Cloud.instance.session_token if accounts.empty?
         accounts.each { |a|
           a.cloud.auth_for_account a
           puts a.cloud.session_token

data/lib/lmcadm/commands/monitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'chronic'
 
 module LMCAdm #:nodoc:
   desc 'Retrieve montoring data'
@@ -15,7 +16,7 @@ module LMCAdm #:nodoc:
       monitor_device.action do |_g, options, args|
         record_name = args.shift
         account = LMC::Account.get_by_uuid_or_name options[GLI::Command::PARENT][:account]
-        device = account.devices.find {|d| d.name == options[:device]}
+        device = account.devices.find { |d| d.name == options[:device] }
         record = device.record record_name
 
         options[:scalar].each do |datapoint|
@@ -48,5 +49,62 @@ module LMCAdm #:nodoc:
         end
       end
     end
+
+    monitor.desc 'Make raw monitoring requests'
+    monitor.arg_name '<record> <name> <id>'
+    monitor.command :raw do |raw|
+      raw.flag :t, :type, default_value: 'scalar'
+      raw.flag :g, :group, default_value: 'DEVICE'
+      raw.flag :p, :period, default_value: 'MINUTE1'
+      raw.desc 'Start time'
+      raw.flag :start, default_value: 'one hour ago'
+      raw.flag :end, default_value: 'now'
+      raw.action do |_g, options, args|
+        record = args.shift
+        name = args.shift
+        groupId = args.shift
+        account = LMC::Account.get_by_uuid_or_name options[GLI::Command::PARENT][:account]
+        account.cloud.auth_for_account account
+
+        startTime = Chronic.parse(options[:start])
+        puts "Start time: #{startTime}" if _g[:verbose]
+        endTime = Chronic.parse(options[:end])
+        puts "End time: #{endTime}" if _g[:verbose]
+
+        # https://cloud.lancom.de/cloud-service-monitoring/accounts/399bc33a-7f53-4757-a6bd-cac3cbb6ebdd/records/wlan_info_json?type=scalar&name=stations&group=ACCOUNT&groupId=399bc33a-7f53-4757-a6bd-cac3cbb6ebdd&period=MINUTE1&start=1623417748&end=1623421348
+        # https://cloud.lancom.de/cloud-service-monitoring/accounts/399bc33a-7f53-4757-a6bd-cac3cbb6ebdd/records/device_info?type=scalar&name=cloud_rtt&group=DEVICE&groupId=efec12e1-ac4d-459d-bb5d-a9b6c1410eb5&period=MINUTE1&start=1623419874&end=1623423474
+        # https://cloud.lancom.de/cloud-service-monitoring/accounts/399bc33a-7f53-4757-a6bd-cac3cbb6ebdd/records/device_info?type=scalar&name=cloud_rtt&group=DEVICE&group_id=efec12e1-ac4d-459d-bb5d-a9b6c1410eb5&period=MINUTE1&start=1623419874&end=1623423474
+        result = account.cloud.get ['cloud-service-monitoring', 'accounts', account.id, 'records', record], {
+          type: options[:type],
+          name: name,
+          group: options[:group],
+          groupId: groupId,
+          period: options[:period],
+          start: startTime.to_i,
+          end: endTime.to_i,
+        }
+        monitordata = result.body.items[name]
+        puts result.body.inspect if _g[:debug]
+        if options[:type] == 'scalar'
+          puts monitordata.values
+        elsif options[:type] == 'json'
+          puts JSON.pretty_generate monitordata.to_h[:values]
+        elsif options[:type] == 'table'
+          table_data = monitordata.values.map { |v|
+            row = v.first
+            hash = {}
+            monitordata.keys.each_with_index { |k, index|
+              unless row[index].nil?
+                hash[k] = v.first[index]
+              end
+            }
+            hash
+          }
+          tp table_data
+        end
+      end
+
+    end
+
   end
 end

data/lib/lmcadm/commands/rights.rb

@@ -15,7 +15,7 @@ module LMCAdm
     end
     rights.arg_name "rights"
     rights.command :assign do |assign|
-      assign.flag :A
+      assign.flag :A, :account
       assign.flag :authority
       assign.flag :service
       assign.action do |_g, o, a |
@@ -23,9 +23,34 @@ module LMCAdm
         account = LMC::Account.get_by_uuid_or_name o[:A]
         c = LMC::Cloud.instance
         c.auth_for_account account
-        c.post [o[:service], "accounts", account.id, 'authorities', o[:authority], 'rights' ], a
+        service_name = Helpers.complete_service_name o[:service]
+        c.post [service_name, "accounts", account.id, 'authorities', o[:authority], 'rights' ], a
 
       end
     end
+    rights.arg_name 'servicename account'
+    rights.desc 'example: lmcadm rights authorities messaging myproject'
+    rights.command :authorities do |authorities|
+      authorities.action do |_g, _o, a |
+        account = LMC::Account.get_by_uuid_or_name a[1]
+        account.cloud.auth_for_account account
+        authorities = account.cloud.get [Helpers.complete_service_name(a[0]), 'accounts', account.id, 'authorities']
+        tp authorities.body, [:name , :visibility, :type, :id]
+      end
+    end
+
+    rights.arg_name '<servicename> <account> <authority_id>'
+    rights.desc 'example: lmcadm rights show service-messaging myproject 5c244078-c937-4ff9-bb33-351f5253fe53'
+    rights.command :show do |show|
+      show.action do |_g, _o, a|
+        account = LMC::Account.get_by_uuid_or_name a[1]
+        account.cloud.auth_for_account account
+        service_name = Helpers.complete_service_name a[0]
+        authority = account.cloud.get([service_name, 'accounts', account.id, 'authorities', a[2]]).body
+        puts authority.to_h.to_s
+        rights = account.cloud.get([service_name, 'accounts', account.id, 'authorities', a[2], 'rights']).body
+        puts rights
+      end
+    end
   end
 end

data/lib/lmcadm/helpers/find_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module LMCAdm
+  module Helpers
+    def self.find_by_id_or_name(list, search)
+      found = []
+      found += list.select do |item|
+        item.id == search
+      end
+      found += list.select do |item|
+        item.name == search
+      end
+      puts "More than one item found for: #{search}" if found.length > 1
+      raise "Not found: #{search}" if found.length < 1
+      return found.first
+    end
+  end
+end
+

data/lib/lmcadm/helpers/string_helpers.rb

@@ -7,5 +7,15 @@ module LMCAdm
       end
       return max
     end
+
+    def self.complete_service_name(name)
+      if name.start_with? 'cloud-service-'
+        return name
+      end
+      if name.start_with? 'service-'
+        return 'cloud-' + name
+      end
+      return'cloud-service-' + name
+    end
   end
 end

data/lib/lmcadm/version.rb

@@ -1,3 +1,3 @@
 module LMCAdm
-  VERSION = '0.15.0'
+  VERSION = '0.18.0'
 end

data/lmcadm.gemspec

@@ -24,9 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry-nav", "0.2.4"
 
-  spec.add_runtime_dependency 'lmc', '~> 0.13.0'
+  spec.add_runtime_dependency 'lmc', '~> 0.14.0'
   spec.add_runtime_dependency 'gli', '~> 2.17'
   spec.add_runtime_dependency 'table_print', '~> 1.5'
   spec.add_runtime_dependency 'colorize', '~> 0.8'
   spec.add_runtime_dependency 'websocket-eventmachine-client', '~> 1.3.0'
+  spec.add_runtime_dependency 'chronic', '~> 0.10.2'
 end

data/makeocragemfile.rb

@@ -0,0 +1,15 @@
+# Temporary gemfile to be used by OCRA.
+GEMFILE = 'ocra_gemfile'
+
+# Add gems from gemspec.
+ocra_gemfile = File.new(GEMFILE, 'w')
+File.open("lmcadm.gemspec",'r') do |file|
+  file.each { |line| ocra_gemfile.write "gem #{$1}\n" if line =~ /spec.add_runtime_dependency (.+)/ }
+end
+ocra_gemfile.close
+
+# Execute OCRA
+#system("ocra --gemfile #{GEMFILE} --console script_name")
+
+# Cleanup
+#FileUtils.rm Dir.glob(GEMFILE)

data/ocra.sh

@@ -0,0 +1,2 @@
+ruby makeocragemfile.rb
+ocra --gemfile ocra_gemfile --gem-full exe/lmcadm

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lmcadm
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.18.0
 platform: ruby
 authors:
 - erpel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
 description:
 email:
 - philipp@copythat.de
@@ -144,6 +158,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-win.yaml"
 - ".gitignore"
 - ".idea/encodings.xml"
 - ".idea/inspectionProfiles/Project_Default.xml"
@@ -177,11 +192,14 @@ files:
 - lib/lmcadm/device_commands.rb
 - lib/lmcadm/helpers/args_helpers.rb
 - lib/lmcadm/helpers/device_helpers.rb
+- lib/lmcadm/helpers/find_helpers.rb
 - lib/lmcadm/helpers/password_helper.rb
 - lib/lmcadm/helpers/string_helpers.rb
 - lib/lmcadm/version.rb
 - lmcadm
 - lmcadm.gemspec
+- makeocragemfile.rb
+- ocra.sh
 homepage:
 licenses:
 - BSD-3-Clause