power-bi 2.5.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98d26348ce002789d1f065e91735ae2d441a64bb32c8c935993961036f2d2379
-  data.tar.gz: e3527606c13a8f62a4918b98e0dfc5ed441f691b836b4f670251e80442fcf104
+  metadata.gz: ad399c89996fb5bc9d8503233c2827c7f57366cd849e16c3e780048a8f1973ae
+  data.tar.gz: a2ffbbac846e08cc9e9fefd52b86e9a996802ec51e5a4f748f0ab8c8799f4b87
 SHA512:
-  metadata.gz: 5e1674d67c5cf55473e0325601b65b532dc374cd9e5a08a2345a282c4b5dd0a984392d1c0196857a649a00ceaf45362d21980e85c9050868b5538b4377f20dd6
-  data.tar.gz: 1c7517a30c1d32ddcc7e6d6883ef6a5b91fcac12500c76b89bdbebb473c405dde6b58f45a2b60dc3c60b7dfac440973ea81daa6a49f308c9d22b23670484293a
+  metadata.gz: 88c0f92c90ae4392b20ea6a85f7be737302857735135b73cba780c2afd31349b672772ac2d95e38fa40a4cd01d8ae226edf49acab7caf4219c118c99021559c8
+  data.tar.gz: 78f8483bfc046ef783b852ec66b6ce7c5645c123e793dd475416de440ac83fb2ae65f3968553e02e8474e983ba06f9b27f32bf0e6ff57f3c406586b8e693427c

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

@@ -30,28 +30,11 @@ module PowerBI
     end
 
     def get_workspaces(filter: nil, expand: nil)
-      params = {}
-      params[:$filter] = filter if filter
-      params[:$expand] = expand if expand
+      base_params = {}
+      base_params[:$filter] = filter if filter
+      base_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
+      @tenant.get_paginated('/admin/groups', base_params: base_params)
     end
 
     def force_delete_workspace_by_workspace_name(user_email, workspace_name)

data/lib/power-bi/dataset.rb

@@ -87,7 +87,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/groups/#{@workspace.id}/datasets")[:value]
+      @tenant.get_paginated("/groups/#{@workspace.id}/datasets")
     end
   end
 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/profile.rb

@@ -38,7 +38,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/profiles", use_profile: false)[:value]
+      @tenant.get_paginated("/profiles", use_profile: false)
     end
   end
 end

data/lib/power-bi/report.rb

@@ -106,7 +106,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/groups/#{@workspace.id}/reports")[:value]
+      @tenant.get_paginated("/groups/#{@workspace.id}/reports")
     end
   end
 end

data/lib/power-bi/tenant.rb

@@ -74,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
@@ -93,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
@@ -115,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
@@ -139,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
@@ -162,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
@@ -191,13 +191,76 @@ 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
       JSON.parse(response.body, symbolize_names: true)
     end
 
+    # Fetches paginated data from the Power BI API using OData-style pagination.
+    #
+    # Power BI API has a documented limit of 5000 records per request.
+    # This method handles pagination automatically by:
+    # 1. Requesting 5000 records at a time using $top and $skip
+    # 2. If exactly 5000 records are returned, fetching the next page
+    # 3. Accumulating all results across pages
+    # 4. Deduplicating records by ID (to handle insertions between requests)
+    #
+    # Note: $skip-based pagination is not fully protected against deletions
+    # between requests (a deleted record may cause a subsequent record to go
+    # unseen). This risk is acceptable given the short pagination window.
+    MAX_PAGE_SIZE = 5000
+    MAX_ITERATIONS = 100
+    def get_paginated(url, page_size: MAX_PAGE_SIZE, base_params: {}, use_profile: true, max_iterations: MAX_ITERATIONS)
+      page_size = [page_size, MAX_PAGE_SIZE].min
+
+      skip = 0
+      all_data = []
+      iteration = 0
+
+      loop do
+        iteration += 1
+        if iteration > max_iterations
+          log "WARNING: Reached maximum iteration limit (#{max_iterations}). " \
+              "Fetched #{all_data.size} records so far. This may indicate an API issue or " \
+              "an extremely large dataset. Consider using API filters to reduce the result set.",
+              level: :warn
+          break
+        end
+
+        params = base_params.merge({
+          '$top' => page_size,
+          '$skip' => skip
+        })
+
+        log "Fetching paginated data from #{url} (skip: #{skip}, top: #{page_size}, iteration: #{iteration})"
+
+        resp = get(url, params, use_profile: use_profile)
+        batch = resp[:value] || []
+        all_data += batch
+        batch_count = batch.size
+
+        log "Received #{batch_count} records (total so far: #{all_data.size})"
+
+        # If we got fewer records than requested, we've reached the last page
+        break if batch_count < page_size
+
+        skip += batch_count
+      end
+
+      # Deduplicate by ID to handle any records that were inserted between requests.
+      # Insertions before the current $skip position shift items right, which can
+      # cause duplicates across pages.
+      deduplicated_data = all_data.uniq{|r| r[:id]}
+
+      if deduplicated_data.size < all_data.size
+        log "Removed #{all_data.size - deduplicated_data.size} duplicate records during deduplication"
+      end
+
+      deduplicated_data
+    end
+
     private
 
     def add_spp_header(req)

data/lib/power-bi/workspace.rb

@@ -113,7 +113,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/groups")[:value]
+      @tenant.get_paginated("/groups")
     end
   end
 end

data/lib/power-bi.rb

@@ -1,4 +1,3 @@
-require 'pry' # TODO remove in final product
 require 'faraday'
 require 'json'
 require 'date'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Lode Cools
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2026-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -110,7 +110,7 @@ homepage: https://github.com/piloos/power-bi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,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: []