power-bi 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d415a89ed5860c82824f7e152e4c58d42054bc293f5534f6669774682a1ffe
-  data.tar.gz: 536d4c7cea48c859c7b780db751da15375b060a45c59946a2335887d8e948494
+  metadata.gz: a22ca0a37fc03e4fd19214f0ecb71c8fedf820fabbbc9e7a7e5add198e0ab25a
+  data.tar.gz: 61fc121ec95aa7cc815b7ee4e84a9fe28facbb2c5177dbe91e519e17ebcfae19
 SHA512:
-  metadata.gz: d31db71feb4b03d7810d5805b3d48016e89ead1782bfae66269aa2a0c55340e6cf21031525ffa6d5b917cdc36041670ef52c1ccff499ebdfc7d0051d8005b6a8
-  data.tar.gz: 1ea49ae1a15e45b16c21b9da86c8ac20abb9e96a6eb63e6a0ed9a7dfcbca25dfff8431896703f2d55736a148668cf4b85ac591eb20c68bf1b2d9f6baee455e3a
+  metadata.gz: 1c69b92f3b68c19b67a417ba7deb402b4bcc8130ebf074260e97b36c62f773ac27e3720d4fa3946060ad1d8d062bbcf95768c436f7be207e773f849a818a633f
+  data.tar.gz: 9454fcb89c9de930616e8ea944fb9aba73f5cfa558e2bef1e755c4f16ec66164dff386154532242ebd55242bc6ccd6ecbcc59fce3f64bf5e8fca554ed309ee59

data/README.md

@@ -112,6 +112,10 @@ Note 2: to limit the number of API calls, it is best to directly use the _getter
 * Delete the dataset: `dataset.delete`
 * Bind dataset to a gateway datasource: `dataset.bind_to_gateway(gateway, gateway_datasource)`
 
+## Datasources
+
+* Update credentials of a datasource: `datasource.update_credentials(username, password)`
+
 ## Gateways
 
 * List gateways: `pbi.gateways`

data/lib/power-bi/admin.rb

@@ -0,0 +1,80 @@
+module PowerBI
+  class Admin
+
+    def initialize(tenant)
+      @tenant = tenant
+    end
+
+    def get_user_artifact_access(user_id, artifact_types: nil)
+      if artifact_types
+        params = {artifactTypes: artifact_types.join(',')}
+      else
+        params = {}
+      end
+
+      url = "/admin/users/#{user_id}/artifactAccess"
+
+      resp = @tenant.get(url, params)
+      data = resp[:ArtifactAccessEntities]
+
+      continuation_token = resp[:continuationToken]
+
+      while continuation_token
+        params = {continuationToken: "'#{continuation_token}'"}
+        resp = @tenant.get(url, params)
+        data += resp[:ArtifactAccessEntities]
+        continuation_token = resp[:continuationToken] ? URI::decode_uri_component(resp[:continuationToken]) : nil
+      end
+
+      data
+    end
+
+    def get_workspaces(filter: nil, expand: nil)
+      params = {}
+      params[:$filter] = filter if filter
+      params[:$expand] = expand if expand
+
+      url = '/admin/groups'
+
+      nr_records = 5000
+      count = 0
+
+      data = []
+
+      loop do
+        params[:$top] = nr_records
+        params[:$skip] = count
+        resp = @tenant.get(url, params)
+        data += resp[:value]
+        batch_count = resp[:value].size
+        count += batch_count
+        break if batch_count < nr_records
+      end
+
+      data
+    end
+
+    def force_delete_workspace_by_workspace_name(user_email, workspace_name)
+      workspace = get_workspaces(filter: "name eq '#{workspace_name}' and state eq 'Active'").first
+      add_user(user_email, workspace[:id], access_right: "Admin")
+      @tenant.workspace(workspace[:id]).delete
+    end
+
+    def force_delete_workspace_by_workspace_id(user_email, workspace_id)
+      add_user(user_email, workspace_id, access_right: "Admin")
+      @tenant.workspace(workspace_id).delete
+    end
+
+    private
+
+    def add_user(user_email, workspace_id, access_right: "Admin")
+      @tenant.post("/admin/groups/#{workspace_id}/users") do |req|
+        req.body = {
+          emailAddress: user_email,
+          groupUserAccessRight: access_right,
+        }.to_json
+      end
+    end
+
+  end
+end

data/lib/power-bi/dataset.rb

@@ -1,6 +1,6 @@
 module PowerBI
   class Dataset < Object
-    attr_reader :workspace, :datasources, :parameters, :refresh_history
+    attr_reader :workspace, :datasources, :parameters
 
     def initialize(tenant, parent, id = nil)
       super(tenant, id)
@@ -38,6 +38,11 @@ module PowerBI
       true
     end
 
+    def refresh_history(entries_to_load = 1)
+      @refresh_history.entries_to_load = entries_to_load
+      @refresh_history
+    end
+
     def last_refresh
       @refresh_history.first
     end

data/lib/power-bi/datasource.rb

@@ -16,6 +16,24 @@ module PowerBI
       }
     end
 
+    # only MySQL type is currently supported
+    def update_credentials(username, password)
+      @tenant.patch("/gateways/#{gateway_id}/datasources/#{datasource_id}") do |req|
+        req.body = {
+          credentialDetails: {
+            credentialType: "Basic",
+            credentials: "{\"credentialData\":[{\"name\":\"username\", \"value\":\"#{username}\"},{\"name\":\"password\", \"value\":\"#{password}\"}]}",
+            encryptedConnection: "Encrypted",
+            encryptionAlgorithm: "None",
+            privacyLevel: "None",
+            useCallerAADIdentity: false,
+            useEndUserOAuth2Credentials: false,
+          },
+        }.to_json
+      end
+      true
+    end
+
   end
 
   class DatasourceArray < Array

data/lib/power-bi/gateway_datasource_user.rb

@@ -18,6 +18,14 @@ module PowerBI
       }
     end
 
+    # currently only implemented for users or service principals (not yet service principal profiles)
+    def delete
+      email_address_or_object_id = email_address || identifier
+      @tenant.delete("/gateways/#{@gateway_datasource.gateway.id}/datasources/#{@gateway_datasource.id}/users/#{email_address_or_object_id}", use_profile: false)
+      @gateway_datasource.gateway_datasource_users.reload
+      true
+    end
+
   end
 
   class GatewayDatasourceUserArray < Array

data/lib/power-bi/refresh.rb

@@ -22,18 +22,27 @@ module PowerBI
   end
 
   class RefreshArray < Array
+    attr_reader :entries_to_load
 
     def initialize(tenant, dataset)
       super(tenant, dataset)
       @dataset = dataset
+      @entries_to_load = 1
     end
 
     def self.get_class
       Refresh
     end
 
+    def entries_to_load=(entries_to_load)
+      if entries_to_load > @entries_to_load
+        @entries_to_load = entries_to_load
+        reload
+      end
+    end
+
     def get_data
-      @tenant.get("/groups/#{@dataset.workspace.id}/datasets/#{@dataset.id}/refreshes", {'$top': '1'})[:value]
+      @tenant.get("/groups/#{@dataset.workspace.id}/datasets/#{@dataset.id}/refreshes", {'$top': @entries_to_load.to_s})[:value]
     end
   end
 end

data/lib/power-bi/tenant.rb

@@ -1,6 +1,6 @@
 module PowerBI
   class Tenant
-    attr_reader :workspaces, :gateways, :capacities, :profiles, :profile_id
+    attr_reader :workspaces, :gateways, :capacities, :profiles, :profile_id, :admin
 
     def initialize(token_generator, retries: 5, logger: nil)
       @token_generator = token_generator
@@ -10,6 +10,7 @@ module PowerBI
       @profiles = ProfileArray.new(self)
       @logger = logger
       @profile_id = nil
+      @admin = Admin.new(self)
 
       ## WHY RETRIES? ##
       # It is noticed that once in a while (~0.1% API calls), the Power BI server returns a 500 (internal server error) without apparent reason, just retrying works :-)
@@ -73,7 +74,7 @@ module PowerBI
       unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
-      log "Calling (GET) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
+      log "Calling (GET) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms - status: #{response.status}"
       unless response.body.empty?
         JSON.parse(response.body, symbolize_names: true)
       end
@@ -92,7 +93,7 @@ module PowerBI
         end
         yield req if block_given?
       end
-      log "Calling (GET - raw) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
+      log "Calling (GET - raw) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms - status: #{response.status}"
       unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -114,7 +115,7 @@ module PowerBI
         end
         yield req if block_given?
       end
-      log "Calling (POST) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
+      log "Calling (POST) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms - status: #{response.status}"
       unless [200, 201, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -138,7 +139,7 @@ module PowerBI
         end
         yield req if block_given?
       end
-      log "Calling (PATCH) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
+      log "Calling (PATCH) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms - status: #{response.status}"
       unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -161,7 +162,7 @@ module PowerBI
         end
         yield req if block_given?
       end
-      log "Calling (DELETE) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
+      log "Calling (DELETE) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms - status: #{response.status}"
       if [400, 401, 404].include? response.status
         raise NotFoundError
       end
@@ -190,7 +191,7 @@ module PowerBI
         req.body = {value: Faraday::UploadIO.new(file, 'application/octet-stream')}
         req.options.timeout = 120  # default is 60 seconds Net::ReadTimeout
       end
-      log "Calling (POST - file) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
+      log "Calling (POST - file) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms - status: #{response.status}"
       if response.status != 202
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end

data/lib/power-bi.rb

@@ -1,4 +1,3 @@
-require 'pry' # TODO remove in final product
 require 'faraday'
 require 'json'
 require 'date'
@@ -26,4 +25,5 @@ require_relative "power-bi/gateway_datasource_user"
 require_relative "power-bi/page"
 require_relative "power-bi/user"
 require_relative "power-bi/capacity"
-require_relative "power-bi/profile"
+require_relative "power-bi/profile"
+require_relative "power-bi/admin"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Lode Cools
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -89,6 +89,7 @@ files:
 - LICENSE
 - README.md
 - lib/power-bi.rb
+- lib/power-bi/admin.rb
 - lib/power-bi/array.rb
 - lib/power-bi/capacity.rb
 - lib/power-bi/dataset.rb
@@ -109,7 +110,7 @@ homepage: https://github.com/piloos/power-bi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Power BI API
 test_files: []