power-bi 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51692748675ef99ea93d0bec573cca8372d76af0ef0056d04a2d71e8e19bd33e
-  data.tar.gz: 5c01631bac9bedd768445a0c3824c45ea2b020c47233f7862bf8d2b22f3c7a53
+  metadata.gz: '053216118d9fed6cb0cb3dff7a8bbe03c64be8a80f2cf26205a1c1b2ee48699c'
+  data.tar.gz: 29908d4c0d9c2c988073f42c7b1180e21863a755ee14c68858016a0d74f437b3
 SHA512:
-  metadata.gz: 99d109e441b215576e0e8c04c7af685f3ff0ffb57bdbf3190b09530479d716dce4b3c134588a1bd059e59bfb5e1ddbb61bcd928de7537da27494f229426f0a8c
-  data.tar.gz: c7a55c72ea6be93d8cdf531e8ad880f0bc34c646f98f6e425f36991aff9bfda323b1ff02f612e6f75598fe28d2073f073ae6e78cebb55dc72d9cdb5500857cd7
+  metadata.gz: b466f3f6b3d67701d40635ac0035b4a94d5aa9a1908152e2f32e244cbfe9f27f8c35f7978ec47bb2a3bccc7e681f14247d76128074c6a93006c2fc2b0c7f8438
+  data.tar.gz: b43176b8de6c021e9c2529aafa9f137fab06877d320b26acc9ea0d7e7edfaee5d37a03d81dbf9f2672beae4399e25a24958aad94f39cecbaaf4d4ecf29edeb4f

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.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"

data/lib/power-bi/dataset.rb

@@ -47,6 +47,7 @@ module PowerBI
 
     def delete
       @tenant.delete("/groups/#{workspace.id}/datasets/#{id}")
+      @workspace.datasets.reload
       true
     end
 

data/lib/power-bi/gateway_datasource.rb

@@ -32,7 +32,7 @@ module PowerBI
 
     def delete
       @tenant.delete("/gateways/#{gateway.id}/datasources/#{id}")
-      @tenant.workspaces.reload
+      @gateway.gateway_datasources.reload
       true
     end
 

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,14 +2,31 @@ module PowerBI
   class Tenant
     attr_reader :workspaces, :gateways
 
-    def initialize(token_generator)
+    def initialize(token_generator, retries: 5)
       @token_generator = token_generator
       @workspaces = WorkspaceArray.new(self)
       @gateways = GatewayArray.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) withou apparent reason, just retrying works :-)
+      ##################
+      @retry_options = {
+        max: retries,
+        exceptions: [Errno::ETIMEDOUT, Timeout::Error, Faraday::TimeoutError, Faraday::RetriableResponse],
+        methods: [:get, :post, :patch, :delete],
+        retry_statuses: [500], # internal server error
+        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}" },
+      }
     end
 
     def get(url, params = {})
-      response = Faraday.get(PowerBI::BASE_URL + url) do |req|
+      conn = Faraday.new do |f|
+        f.request :retry, @retry_options
+      end
+      response = conn.get(PowerBI::BASE_URL + url) do |req|
         req.params = params
         req.headers['Accept'] = 'application/json'
         req.headers['authorization'] = "Bearer #{token}"
@@ -24,7 +41,10 @@ module PowerBI
     end
 
     def get_raw(url, params = {})
-      response = Faraday.get(PowerBI::BASE_URL + url) do |req|
+      conn = Faraday.new do |f|
+        f.request :retry, @retry_options
+      end
+      response = conn.get(PowerBI::BASE_URL + url) do |req|
         req.params = params
         req.headers['authorization'] = "Bearer #{token}"
         yield req if block_given?
@@ -36,7 +56,10 @@ module PowerBI
     end
 
     def post(url, params = {})
-      response = Faraday.post(PowerBI::BASE_URL + url) do |req|
+      conn = Faraday.new do |f|
+        f.request :retry, @retry_options
+      end
+      response = conn.post(PowerBI::BASE_URL + url) do |req|
         req.params = params
         req.headers['Accept'] = 'application/json'
         req.headers['Content-Type'] = 'application/json'
@@ -52,7 +75,10 @@ module PowerBI
     end
 
     def patch(url, params = {})
-      response = Faraday.patch(PowerBI::BASE_URL + url) do |req|
+      conn = Faraday.new do |f|
+        f.request :retry, @retry_options
+      end
+      response = conn.patch(PowerBI::BASE_URL + url) do |req|
         req.params = params
         req.headers['Accept'] = 'application/json'
         req.headers['Content-Type'] = 'application/json'
@@ -68,7 +94,10 @@ module PowerBI
     end
 
     def delete(url, params = {})
-      response = Faraday.delete(PowerBI::BASE_URL + url) do |req|
+      conn = Faraday.new do |f|
+        f.request :retry, @retry_options
+      end
+      response = conn.delete(PowerBI::BASE_URL + url) do |req|
         req.params = params
         req.headers['Accept'] = 'application/json'
         req.headers['authorization'] = "Bearer #{token}"
@@ -85,6 +114,7 @@ module PowerBI
     def post_file(url, file, params = {})
       conn = Faraday.new do |f|
         f.request :multipart
+        f.request :retry, @retry_options
       end
       response = conn.post(PowerBI::BASE_URL + url) do |req|
         req.params = params
@@ -92,6 +122,7 @@ module PowerBI
         req.headers['Content-Type'] = 'multipart/form-data'
         req.headers['authorization'] = "Bearer #{token}"
         req.body = {value: Faraday::UploadIO.new(file, 'application/octet-stream')}
+        req.options.timeout = 120  # default is 60 seconds Net::ReadTimeout
       end
       if response.status != 202
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")

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)
@@ -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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Lode Cools
@@ -52,10 +52,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: