power-bi 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c120eeef2ac35b02afcfff32690f003efad7fbfd59c7f2bd714a6d0659b1ed44
-  data.tar.gz: ee077e4fa8f6faae52ad5c1107fd96f9cb8bae5e7c8f0ef47a83009e7c80ce0d
+  metadata.gz: 98d26348ce002789d1f065e91735ae2d441a64bb32c8c935993961036f2d2379
+  data.tar.gz: e3527606c13a8f62a4918b98e0dfc5ed441f691b836b4f670251e80442fcf104
 SHA512:
-  metadata.gz: c9c742362808fb3fa08ad663ebbdaf34d916f932fa5bed8f66d657caf769c230a7694d82cd05555a642d41098ccb9fcf6eed9b6f89233ca344ff3f1c3d02b6fb
-  data.tar.gz: dc28a5e89d26365b7b48d5f6538bd1e8c12a9fe45c81b4f216ae63074ced3b728f31395c98751ee571a9e7234315693af5f6a7cffe4d86c398f6ec6683cfeafe
+  metadata.gz: 5e1674d67c5cf55473e0325601b65b532dc374cd9e5a08a2345a282c4b5dd0a984392d1c0196857a649a00ceaf45362d21980e85c9050868b5538b4377f20dd6
+  data.tar.gz: 1c7517a30c1d32ddcc7e6d6883ef6a5b91fcac12500c76b89bdbebb473c405dde6b58f45a2b60dc3c60b7dfac440973ea81daa6a49f308c9d22b23670484293a

data/README.md

@@ -62,7 +62,9 @@ Once authenticated, you can set profiles like this:
 pbi.profile = profile
 ```
 
-Every action executed after setting the profile, will be executed _through the eyes of the profile_.  This way, you can create an isolated multi-tenant setup.  Using profiles, simplifies the internal organization of Power BI and allows faster interaction with Power BI.  This also lifts the 1000-workspaces limit that is imposed on Master Userss and Service Principals
+Every action executed after setting the profile, will be executed _through the eyes of the profile_.  This way, you can create an isolated multi-tenant setup.  Using profiles, simplifies the internal organization of Power BI and allows faster interaction with Power BI.  This also lifts the 1000-workspaces limit that is imposed on Master Users and Service Principals
+
+Note: when working with Service principal profiles (SPP), you need to add the SPP to the gateway datasource before binding the gateway datasource to the dataset.
 
 # Supported endpoints
 
@@ -122,6 +124,11 @@ Note 2: to limit the number of API calls, it is best to directly use the _getter
 * Create a new gateway datasource: `gateway.gateway_datasource.create(name, credentials, db_server, db_name)`
 * Delete a new gateway datasource: `gateway_datasource.delete`
 
+## Gateway datasource users
+
+* List datasource users in a gateway datasource: `gateway_datasource.gateway_datasource_users`
+* Add a Service principal profile to a gateway datasource: `gateway_datasource.add_service_principal_profile_user(profile_id, principal_object_id)`
+
 ## Capacities
 
 Note: Capacities are Azure creatures, you can't create them in Power BI.

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/gateway.rb

@@ -8,7 +8,7 @@ module PowerBI
     end
 
     def get_data(id)
-      @tenant.get("/gateways/#{id}")
+      @tenant.get("/gateways/#{id}", use_profile: false)
     end
 
     def data_to_attributes(data)
@@ -32,7 +32,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/gateways")[:value]
+      @tenant.get("/gateways", use_profile: false)[:value]
     end
   end
 end

data/lib/power-bi/gateway_datasource.rb

@@ -1,14 +1,15 @@
 module PowerBI
   class GatewayDatasource < Object
-    attr_reader :gateway
+    attr_reader :gateway, :gateway_datasource_users
 
     def initialize(tenant, parent, id = nil)
       super(tenant, id)
       @gateway = parent
+      @gateway_datasource_users = GatewayDatasourceUserArray.new(@tenant, self)
     end
 
     def get_data(id)
-      @tenant.get("/gateways/#{@gateway.id}/datasources/#{id}")
+      @tenant.get("/gateways/#{@gateway.id}/datasources/#{id}", use_profile: false)
     end
 
     def data_to_attributes(data)
@@ -24,7 +25,7 @@ module PowerBI
     end
 
     def update_credentials(encrypted_credentials)
-      @tenant.patch("/gateways/#{gateway.id}/datasources/#{id}") do |req|
+      @tenant.patch("/gateways/#{gateway.id}/datasources/#{id}", use_profile: false) do |req|
         req.body = {
           credentialDetails: {
             credentialType: "Basic",
@@ -41,7 +42,7 @@ module PowerBI
     end
 
     def delete
-      @tenant.delete("/gateways/#{gateway.id}/datasources/#{id}")
+      @tenant.delete("/gateways/#{gateway.id}/datasources/#{id}", use_profile: false)
       @gateway.gateway_datasources.reload
       true
     end
@@ -61,7 +62,7 @@ module PowerBI
 
     # only MySQL type is currently supported
     def create(name, encrypted_credentials, db_server, db_name)
-      data = @tenant.post("/gateways/#{@gateway.id}/datasources",) do |req|
+      data = @tenant.post("/gateways/#{@gateway.id}/datasources", use_profile: false) do |req|
         req.body = {
           connectionDetails: {server: db_server, database: db_name}.to_json,
           credentialDetails: {
@@ -82,7 +83,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/gateways/#{@gateway.id}/datasources")[:value]
+      @tenant.get("/gateways/#{@gateway.id}/datasources", use_profile: false)[:value]
     end
   end
 end

data/lib/power-bi/gateway_datasource_user.rb

@@ -0,0 +1,51 @@
+module PowerBI
+  class GatewayDatasourceUser < Object
+    attr_reader :gateway_datasource
+
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @gateway_datasource = parent
+    end
+
+    def data_to_attributes(data)
+      {
+        datasource_access_right: data[:datasourceAccessRight],
+        display_name: data[:displayName],
+        email_address: data[:emailAddress],
+        identifier: data[:identifier],
+        principal_type: data[:principalType],
+        profile: data[:profile],
+      }
+    end
+
+  end
+
+  class GatewayDatasourceUserArray < Array
+
+    def initialize(tenant, gateway_datasource)
+      super(tenant, gateway_datasource)
+      @gateway_datasource = gateway_datasource
+    end
+
+    def self.get_class
+      GatewayDatasourceUser
+    end
+
+    # service principal object ID: https://learn.microsoft.com/en-us/power-bi/developer/embedded/embedded-troubleshoot#what-is-the-difference-between-application-object-id-and-principal-object-id
+    def add_service_principal_profile_user(profile_id, principal_object_id, datasource_access_right: "Read")
+      @tenant.post("/gateways/#{@gateway_datasource.gateway.id}/datasources/#{@gateway_datasource.id}/users", use_profile: false) do |req|
+        req.body = {
+          datasourceAccessRight: datasource_access_right,
+          identifier: principal_object_id,
+          principalType: "App",
+          profile: {id: profile_id},
+        }.to_json
+      end
+      self.reload
+    end
+
+    def get_data
+      @tenant.get("/gateways/#{@gateway_datasource.gateway.id}/datasources/#{@gateway_datasource.id}/users", use_profile: false)[:value]
+    end
+  end
+end

data/lib/power-bi/profile.rb

@@ -6,7 +6,7 @@ module PowerBI
     end
 
     def get_data(id)
-      @tenant.get("/profiles/#{id}")
+      @tenant.get("/profiles/#{id}", use_profile: false)
     end
 
     def data_to_attributes(data)
@@ -17,7 +17,7 @@ module PowerBI
     end
 
     def delete
-      @tenant.delete("/profiles/#{@id}")
+      @tenant.delete("/profiles/#{@id}", use_profile: false)
       @tenant.profiles.reload
       true
     end
@@ -30,7 +30,7 @@ module PowerBI
     end
 
     def create(name)
-      data = @tenant.post("/profiles") do |req|
+      data = @tenant.post("/profiles", use_profile: false) do |req|
         req.body = {displayName: name}.to_json
       end
       self.reload
@@ -38,7 +38,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/profiles")[:value]
+      @tenant.get("/profiles", use_profile: false)[:value]
     end
   end
 end

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
+    attr_reader :workspaces, :gateways, :capacities, :profiles, :profile_id, :admin
 
     def initialize(token_generator, retries: 5, logger: nil)
       @token_generator = token_generator
@@ -9,7 +9,8 @@ module PowerBI
       @capacities = CapacityArray.new(self)
       @profiles = ProfileArray.new(self)
       @logger = logger
-      @profile = nil
+      @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 :-)
@@ -44,12 +45,16 @@ module PowerBI
       Capacity.new(self, nil, id)
     end
 
+    def profile(id)
+      Profile.new(self, nil, id)
+    end
+
     def profile=(profile)
-      @profile = profile
+      @profile_id = profile.is_a?(String) ? profile : profile&.id
       @workspaces.reload # we need to reload the workspaces because we look through the eyes of the profile
     end
 
-    def get(url, params = {})
+    def get(url, params = {}, use_profile: true)
       t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
@@ -58,8 +63,8 @@ module PowerBI
         req.params = params
         req.headers['Accept'] = 'application/json'
         req.headers['authorization'] = "Bearer #{token}"
-        if @profile
-          req.headers['X-PowerBI-Profile-Id'] = @profile.id
+        if use_profile
+          add_spp_header(req)
         end
         yield req if block_given?
       end
@@ -75,7 +80,7 @@ module PowerBI
       end
     end
 
-    def get_raw(url, params = {})
+    def get_raw(url, params = {}, use_profile: true)
       t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
@@ -83,8 +88,8 @@ module PowerBI
       response = conn.get(PowerBI::BASE_URL + url) do |req|
         req.params = params
         req.headers['authorization'] = "Bearer #{token}"
-        if @profile
-          req.headers['X-PowerBI-Profile-Id'] = @profile.id
+        if use_profile
+          add_spp_header(req)
         end
         yield req if block_given?
       end
@@ -95,7 +100,7 @@ module PowerBI
       response.body
     end
 
-    def post(url, params = {})
+    def post(url, params = {}, use_profile: true)
       t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
@@ -105,8 +110,8 @@ module PowerBI
         req.headers['Accept'] = 'application/json'
         req.headers['Content-Type'] = 'application/json'
         req.headers['authorization'] = "Bearer #{token}"
-        if @profile
-          req.headers['X-PowerBI-Profile-Id'] = @profile.id
+        if use_profile
+          add_spp_header(req)
         end
         yield req if block_given?
       end
@@ -119,7 +124,7 @@ module PowerBI
       end
     end
 
-    def patch(url, params = {})
+    def patch(url, params = {}, use_profile: true)
       t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
@@ -129,8 +134,8 @@ module PowerBI
         req.headers['Accept'] = 'application/json'
         req.headers['Content-Type'] = 'application/json'
         req.headers['authorization'] = "Bearer #{token}"
-        if @profile
-          req.headers['X-PowerBI-Profile-Id'] = @profile.id
+        if use_profile
+          add_spp_header(req)
         end
         yield req if block_given?
       end
@@ -143,7 +148,7 @@ module PowerBI
       end
     end
 
-    def delete(url, params = {})
+    def delete(url, params = {}, use_profile: true)
       t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
@@ -152,8 +157,8 @@ module PowerBI
         req.params = params
         req.headers['Accept'] = 'application/json'
         req.headers['authorization'] = "Bearer #{token}"
-        if @profile
-          req.headers['X-PowerBI-Profile-Id'] = @profile.id
+        if use_profile
+          add_spp_header(req)
         end
         yield req if block_given?
       end
@@ -169,7 +174,7 @@ module PowerBI
       end
     end
 
-    def post_file(url, file, params = {})
+    def post_file(url, file, params = {}, use_profile: true)
       t0 = Time.now
       conn = Faraday.new do |f|
         f.request :multipart
@@ -180,8 +185,8 @@ module PowerBI
         req.headers['Accept'] = 'application/json'
         req.headers['Content-Type'] = 'multipart/form-data'
         req.headers['authorization'] = "Bearer #{token}"
-        if @profile
-          req.headers['X-PowerBI-Profile-Id'] = @profile.id
+        if use_profile
+          add_spp_header(req)
         end
         req.body = {value: Faraday::UploadIO.new(file, 'application/octet-stream')}
         req.options.timeout = 120  # default is 60 seconds Net::ReadTimeout
@@ -195,6 +200,12 @@ module PowerBI
 
     private
 
+    def add_spp_header(req)
+      if @profile_id
+        req.headers['X-PowerBI-Profile-Id'] = @profile_id
+      end
+    end
+
     def token
       @token_generator.call
     end

data/lib/power-bi.rb

@@ -22,7 +22,9 @@ require_relative "power-bi/parameter"
 require_relative "power-bi/refresh"
 require_relative "power-bi/gateway"
 require_relative "power-bi/gateway_datasource"
+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.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Lode Cools
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -89,12 +89,14 @@ 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
 - lib/power-bi/datasource.rb
 - lib/power-bi/gateway.rb
 - lib/power-bi/gateway_datasource.rb
+- lib/power-bi/gateway_datasource_user.rb
 - lib/power-bi/object.rb
 - lib/power-bi/page.rb
 - lib/power-bi/parameter.rb