power-bi 1.3.1 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d25a34c3688310fb090dccae322ca49f7a48312246f3793b4e59cba25fd75a1
-  data.tar.gz: 5edb3f13333c5319f44fdac97769d3b5ee2adbb59f03296ceb664bc729017e77
+  metadata.gz: ffdc95c611d1fc25b04ce01028a873ed5dc3b9a2d23d57129c439146c9fd7a02
+  data.tar.gz: 20a9328435110d6aaf8c26bb1ac5c622db65a9a1b137815e2546cccee7281033
 SHA512:
-  metadata.gz: db57e4e5fb379b3cab50becc7060d19caf48cbcd366aa2231829c988ff448af01cf40ab9f189c8607b26bfaa8c96a8efd14df3d3337d1bbc257fc41315386637
-  data.tar.gz: 390c4de1b57462be8817be336b35de6e24e488569cad47936d116efc922e382b804c71b16717bbe31fb38aa486e3a946ad69a9816055832da90507f2cf1a4678
+  metadata.gz: 9a3dca6fd7fe5cb3d15251b84d8de13d1613b8104b4638f52f5957b45de92628911d65b1b5495acd2dc674c026d4d59df8570e97ae84f93d0f928d89ce32c174
+  data.tar.gz: d0c1b426eb78530a3207eb1edb56e26a588c0fef9ccb28a9824a3af89e3ec7a1938ec613468179a413c0359d9d76d04d1101c0da8566d4bcbab3bd03921b35f7

data/README.md

@@ -27,6 +27,16 @@ pbi = PowerBI::Tenant.new(->{token = get_token(client, token) ; token.token})
 * Rebind report to another dataset: `report.rebind(dataset)`
 * Export report to file: `report.export_to_file(filenam, format: 'PDF')`
 
+## Pages
+
+* List pages in a report: `report.pages`
+
+## Users
+
+* List users in a workspace: `workspace.pages`
+* Delete a user from a workspace: `user.delete`
+* Add a user to a workspace: `workspace.create(email_address, access_right: "Viewer")`
+
 ## Datasets
 
 * List datasets in a workspace: `workspace.datasets`

data/lib/power-bi/page.rb

@@ -0,0 +1,30 @@
+module PowerBI
+  class Page
+    attr_reader :display_name, :name, :order, :report
+
+    def initialize(tenant, data)
+      @name = data[:Name]
+      @display_name = data[:displayName]
+      @order = data[:order]
+      @report = data[:report]
+      @tenant = tenant
+    end
+  end
+
+  class PageArray < Array
+
+    def initialize(tenant, report)
+      super(tenant)
+      @report = report
+    end
+
+    def self.get_class
+      Page
+    end
+
+    def get_data
+      data = @tenant.get("/groups/#{@report.workspace.id}/reports/#{@report.id}/pages")[:value]
+      data.each { |d| d[:report] = @report }
+    end
+  end
+end

data/lib/power-bi/report.rb

@@ -1,6 +1,6 @@
 module PowerBI
   class Report
-    attr_reader :name, :id, :report_type, :web_url, :embed_url, :is_from_pbix, :is_owned_by_me, :dataset_id, :workspace
+    attr_reader :name, :id, :report_type, :web_url, :embed_url, :is_from_pbix, :is_owned_by_me, :dataset_id, :workspace, :pages
 
     class ExportToFileError < PowerBI::Error ; end
 
@@ -15,6 +15,7 @@ module PowerBI
       @dataset_id = data[:datasetId]
       @workspace = data[:workspace]
       @tenant = tenant
+      @pages = PageArray.new(@tenant, self)
     end
 
     def clone(target_workspace, new_report_name)

data/lib/power-bi/tenant.rb

@@ -2,10 +2,11 @@ module PowerBI
   class Tenant
     attr_reader :workspaces, :gateways
 
-    def initialize(token_generator, retries: 5)
+    def initialize(token_generator, retries: 5, logger: nil)
       @token_generator = token_generator
       @workspaces = WorkspaceArray.new(self)
       @gateways = GatewayArray.new(self)
+      @logger = logger
 
       ## WHY RETRIES? ##
       # It is noticed that once in a while (~0.1% API calls), the Power BI server returns a 500 (internal server error) withou apparent reason, just retrying works :-)
@@ -18,11 +19,18 @@ module PowerBI
         interval: 0.2,
         interval_randomness: 0,
         backoff_factor: 4,
-        retry_block: -> (env, options, retries, exc) { puts "retrying...!! (@ #{Time.now.to_s}), exception: #{exc.to_s} ---- #{exc.message}" },
+        retry_block: -> (env, options, retries, exc) { self.log "retrying...!! exception: #{exc.to_s} ---- #{exc.message}, request URL: #{env.url}" },
       }
     end
 
+    def log(message, level: :info)
+      if @logger
+        @logger.send(level, message) # hence, the logger needs to implement the 'level' methods
+      end
+    end
+
     def get(url, params = {})
+      t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
       end
@@ -35,12 +43,14 @@ 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) #{url} - took #{((Time.now - t0) * 1000).to_i} ms"
       unless response.body.empty?
         JSON.parse(response.body, symbolize_names: true)
       end
     end
 
     def get_raw(url, params = {})
+      t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
       end
@@ -49,6 +59,7 @@ module PowerBI
         req.headers['authorization'] = "Bearer #{token}"
         yield req if block_given?
       end
+      log "Calling (GET - raw) #{url} - took #{((Time.now - t0) * 1000).to_i} ms"
       unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -56,6 +67,7 @@ module PowerBI
     end
 
     def post(url, params = {})
+      t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
       end
@@ -66,6 +78,7 @@ module PowerBI
         req.headers['authorization'] = "Bearer #{token}"
         yield req if block_given?
       end
+      log "Calling (POST) #{url} - took #{((Time.now - t0) * 1000).to_i} ms"
       unless [200, 201, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -75,6 +88,7 @@ module PowerBI
     end
 
     def patch(url, params = {})
+      t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
       end
@@ -85,6 +99,7 @@ module PowerBI
         req.headers['authorization'] = "Bearer #{token}"
         yield req if block_given?
       end
+      log "Calling (PATCH) #{url} - took #{((Time.now - t0) * 1000).to_i} ms"
       unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -94,6 +109,7 @@ module PowerBI
     end
 
     def delete(url, params = {})
+      t0 = Time.now
       conn = Faraday.new do |f|
         f.request :retry, @retry_options
       end
@@ -103,6 +119,7 @@ module PowerBI
         req.headers['authorization'] = "Bearer #{token}"
         yield req if block_given?
       end
+      log "Calling (DELETE) #{url} - took #{((Time.now - t0) * 1000).to_i} ms"
       unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -112,6 +129,7 @@ module PowerBI
     end
 
     def post_file(url, file, params = {})
+      t0 = Time.now
       conn = Faraday.new do |f|
         f.request :multipart
         f.request :retry, @retry_options
@@ -124,6 +142,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) #{url} - took #{((Time.now - t0) * 1000).to_i} ms"
       if response.status != 202
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end

data/lib/power-bi/user.rb

@@ -0,0 +1,48 @@
+module PowerBI
+  class User
+    attr_reader :email_address, :group_user_access_right, :display_name, :identifier, :principal_type
+
+    def initialize(tenant, data)
+      @email_address = data[:emailAddress]
+      @group_user_access_right = data[:groupUserAccessRight]
+      @display_name = data[:displayName]
+      @identifier = data[:identifier]
+      @principal_type = data[:principalType]
+      @workspace = data[:workspace]
+      @tenant = tenant
+    end
+
+    def delete
+      @tenant.delete("/groups/#{@workspace.id}/users/#{@email_address}")
+      @workspace.users.reload
+    end
+
+  end
+
+  class UserArray < Array
+
+    def initialize(tenant, workspace)
+      super(tenant)
+      @workspace = workspace
+    end
+
+    def self.get_class
+      User
+    end
+
+    def create(email_address, access_right: "Viewer")
+      @tenant.post("/groups/#{@workspace.id}/users") do |req|
+        req.body = {
+          emailAddress: email_address,
+          groupUserAccessRight: access_right
+        }.to_json
+      end
+      self.reload
+    end
+
+    def get_data
+      data = @tenant.get("/groups/#{@workspace.id}/users")[:value]
+      data.each { |d| d[:workspace] = @workspace }
+    end
+  end
+end

data/lib/power-bi/workspace.rb

@@ -1,6 +1,6 @@
 module PowerBI
   class Workspace
-    attr_reader :name, :is_read_only, :is_on_dedicated_capacity, :id, :reports, :datasets
+    attr_reader :name, :is_read_only, :is_on_dedicated_capacity, :id, :reports, :datasets, :users
 
     class UploadError < PowerBI::Error ; end
 
@@ -12,6 +12,7 @@ module PowerBI
       @tenant = tenant
       @reports = ReportArray.new(@tenant, self)
       @datasets = DatasetArray.new(@tenant, self)
+      @users = UserArray.new(@tenant, self)
     end
 
     def upload_pbix(file, dataset_name, timeout: 30)
@@ -22,13 +23,13 @@ module PowerBI
       status_history = ''
       old_status = ''
       while !success
-        sleep 0.1
+        sleep 0.5
         iterations += 1
-        raise UploadError.new("Upload did not succeed after #{timeout} seconds. Status history:#{status_history}") if iterations > (10 * timeout)
+        raise UploadError.new("Upload did not succeed after #{timeout} seconds. Status history:#{status_history}") if iterations > (2 * timeout)
         new_status = @tenant.get("/groups/#{@id}/imports/#{import_id}")[:importState].to_s
         success = (new_status == "Succeeded")
         if new_status != old_status
-          status_history += "\nStatus change after #{iterations/10.0}s: '#{old_status}' --> '#{new_status}'"
+          status_history += "\nStatus change after #{iterations/2}s: '#{old_status}' --> '#{new_status}'"
           old_status = new_status
         end
       end
@@ -43,17 +44,6 @@ module PowerBI
       true
     end
 
-    # TODO LATER: the 'Viewer' acces right is currently not settable throught the API. Fix that later
-    def add_user(email_address, access_right = 'Member')
-      @tenant.post("/groups/#{id}/users") do |req|
-        req.body = {
-          emailAddress: email_address,
-          groupUserAccessRight: access_right
-        }.to_json
-      end
-      true
-    end
-
   end
 
   class WorkspaceArray < Array

data/lib/power-bi.rb

@@ -20,3 +20,5 @@ 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/page"
+require_relative "power-bi/user"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.6.1
 platform: ruby
 authors:
 - Lode Cools
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for the Power BI API
 email: lode.cools1@gmail.com
 executables: []
@@ -52,10 +94,12 @@ files:
 - lib/power-bi/datasource.rb
 - lib/power-bi/gateway.rb
 - lib/power-bi/gateway_datasource.rb
+- lib/power-bi/page.rb
 - lib/power-bi/parameter.rb
 - lib/power-bi/refresh.rb
 - lib/power-bi/report.rb
 - lib/power-bi/tenant.rb
+- lib/power-bi/user.rb
 - lib/power-bi/workspace.rb
 homepage: https://github.com/piloos/power-bi
 licenses:
@@ -76,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Power BI API