power-bi 0.5.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5ef83e5bdcaaa737a8bd83a825b597d302d70b31ff35b3aff95a6b3c1c7f2a4
-  data.tar.gz: '019b0bd626eccac2f699d500d3eec467cfa209ee1658cd85e5ee9323856e4fa8'
+  metadata.gz: 38722ac553ebd26a3d354aae65d622752817faa16c9a30af60a01bf719bcbba0
+  data.tar.gz: 2cffe049c3488a0e2f642293d48a9a0a25e81a39b619da32a0609ec1dc9ad029
 SHA512:
-  metadata.gz: a0432e8d536199d1edacb320ddabf5a4abc819a1c2e565c647727c12cad819f10696043d57b102611e5adcf5facf8553f2d2702cd6879fd24a82f335033ba95b
-  data.tar.gz: ed395225b4a0a26645a167cb17319ee5c8714195680fbbbb13e533f6293152de58aae3fc823b7540b0dcb26f1523e014be7e107f66386e61b7756508a51c8374
+  metadata.gz: b2e719c386fcc7b6e97878a5d01ace8795ae67f16b1e1c8f9848c012d3493c9c02ba7293e7f6b4d70b48d06ce75204c0455bc2a3c1f9610c05dbfc91bd17b48d
+  data.tar.gz: 4a27316227878ce178bb30d3d79f81863b0cb60a0923ee1c5bf24278691ccb6dff36efc19c06067090b23f203ff058c674e7aaceaa1acd2da00a607333932914

data/README.md

@@ -1,3 +1,88 @@
 # power-bi
 
 Ruby wrapper around the Power BI API
+
+# Initialization
+
+The Power BI API does not handle the authorization part. It requires the user to pass a function where it can request tokens.
+
+```
+pbi = PowerBI::Tenant.new(->{token = get_token(client, token) ; token.token})
+```
+
+# Supported endpoints
+
+## Workspaces (aka Groups)
+
+* List workspaces: `pbi.workspaces`
+* Create workspace: `pbi.workspaces.create`
+* Upload PBIX to workspace: `ws.upload_pbix('./test.pbix', 'new_datasetname_in_the_service')`
+* Delete workspace: `workspace.delete`
+* Add a user to a wokspace: `workspace.add_user('company_0001@fabrikam.com')`
+
+## Reports
+
+* List reports in a workspace: `workspace.reports`
+* Clone a report from one workspace to another: `report.clone(src_workspace, new_report_name)`
+* Rebind report to another dataset: `report.rebind(dataset)`
+* Export report to file: `report.export_to_file(filenam, format: 'PDF')`
+
+## Datasets
+
+* List datasets in a workspace: `workspace.datasets`
+* Update parameter in a dataset: `dataset.update_parameter(parameter_name, new_value)`
+* Get time of last refresh: `dataset.last_refresh`
+* Refresh the dataset: `dataset.refresh`
+* Delete the dataset: `dataset.delete`
+* Bind dataset to a gateway datasource: `dataset.bind_to_gateway(gateway, gateway_datasource)`
+
+## Gateways
+
+* List gateways: `pbi.gateways`
+
+## Gateway datasources
+
+* List datasources in a gateway: `gateway.gateway_datasources`
+* Update credentials of a gateway datasource: `gateway_datasource.update_credentials(new_credentials)`
+* Create a new gateway datasource: `gateway.gateway_datasource.create(name, credentials, db_server, db_name)`
+* Delete a new gateway datasource: `gateway_datasource.delete`
+
+# Note about gateway credentials
+
+Power BI uses an obscure mechanism to encrypt credential exchange between the service and the gateway.  The encryption must be done outside this module on a Windows machine based on th public key of the gateway.  This is an example C# script:
+
+```
+using System;
+using Microsoft.PowerBI.Api.Models;
+using Microsoft.PowerBI.Api.Models.Credentials;
+using Microsoft.PowerBI.Api.Extensions;
+
+
+namespace pbi_credentials
+{
+    class Program
+    {
+        static void Main(string[] args)
+        {
+            Console.WriteLine("Kicking off");
+
+            var credentials = new BasicCredentials(username: "cdmuser", password: "cdmuserpw4879515365");
+
+            var publicKey = new GatewayPublicKey("AQAB", "ru5gTdHbJ+8eC/uwERTOMz9Yktf/kCDWeRDCY1M5fPCB9+p4c8Uk54/NzT5ZWPQCp958bLcO8nSOSOpz4I8fW/AI4d+JxwW6VCsxzue2mKbJjeuSDXXmIiNUFqvjOIolfSIxJFNlfWkZUFlaD3dXgJkjJxrrc4OrYBDUt0FF14UsvdZymTbOl39sAhD4i9CqkXTqm6+JDxsEkPE3GAZ6ZslCsRUqu7lX73anAHkm889FR9NOMtsLV02JDMKCblJqnoszTzgExEEeoTJKxLiJdC8Mfbl96fKFS8JElJIzfTPzldGx5TxdjRmekQODWr7SNMSVJJQTJaANh9C2FZ85pQ==");
+            var credentialsEncryptor = new AsymmetricKeyEncryptor(publicKey);
+
+            var credentialDetails = new CredentialDetails(
+                credentials,
+                PrivacyLevel.Private,
+                EncryptedConnection.Encrypted,
+                credentialsEncryptor
+            );
+            Console.WriteLine(credentialDetails.Credentials);
+
+            Console.WriteLine("Bye Bye");
+        }
+    }
+}
+```
+
+

data/lib/power-bi.rb

@@ -18,3 +18,5 @@ require_relative "power-bi/dataset"
 require_relative "power-bi/datasource"
 require_relative "power-bi/parameter"
 require_relative "power-bi/refresh"
+require_relative "power-bi/gateway"
+require_relative "power-bi/gateway_datasource"

data/lib/power-bi/dataset.rb

@@ -50,6 +50,16 @@ module PowerBI
       true
     end
 
+    def bind_to_gateway(gateway, gateway_datasource)
+      @tenant.post("/groups/#{workspace.id}/datasets/#{id}/Default.BindToGateway") do |req|
+        req.body = {
+          gatewayObjectId: gateway.id,
+          datasourceObjectIds: [gateway_datasource.id]
+        }.to_json
+      end
+      true
+    end
+
   end
 
   class DatasetArray < Array

data/lib/power-bi/gateway.rb

@@ -0,0 +1,25 @@
+module PowerBI
+  class Gateway
+    attr_reader :name, :id, :type, :public_key, :gateway_datasources
+
+    def initialize(tenant, data)
+      @id = data[:id]
+      @name = data[:name]
+      @type = data[:type]
+      @public_key = data[:publicKey]
+      @tenant = tenant
+      @gateway_datasources = GatewayDatasourceArray.new(@tenant, self)
+    end
+
+  end
+
+  class GatewayArray < Array
+    def self.get_class
+      Gateway
+    end
+
+    def get_data
+      @tenant.get("/gateways")[:value]
+    end
+  end
+end

data/lib/power-bi/gateway_datasource.rb

@@ -0,0 +1,79 @@
+module PowerBI
+  class GatewayDatasource
+    attr_reader :id, :gateway_id, :datasource_type, :connection_details, :credential_type, :datasource_name, :gateway
+
+    def initialize(tenant, data)
+      @gateway_id = data[:gatewayId]
+      @datasource_type = data[:datasourceType]
+      @datasource_name = data[:datasourceName]
+      @connection_details = data[:connectionDetails]
+      @id = data[:id]
+      @credential_type = data[:credentialType]
+      @gateway = data[:gateway]
+      @tenant = tenant
+    end
+
+    def update_credentials(encrypted_credentials)
+      response = @tenant.patch("/gateways/#{gateway.id}/datasources/#{id}") do |req|
+        req.body = {
+          credentialDetails: {
+            credentialType: "Basic",
+            credentials: encrypted_credentials,
+            encryptedConnection: "Encrypted",
+            encryptionAlgorithm: "RSA-OAEP",
+            privacyLevel: "Organizational",
+            useCallerAADIdentity: false,
+            useEndUserOAuth2Credentials: false,
+          },
+        }.to_json
+      end
+      true
+    end
+
+    def delete
+      @tenant.delete("/gateways/#{gateway.id}/datasources/#{id}")
+      @tenant.workspaces.reload
+      true
+    end
+
+  end
+
+  class GatewayDatasourceArray < Array
+
+    def initialize(tenant, gateway)
+      super(tenant)
+      @gateway = gateway
+    end
+
+    def self.get_class
+      GatewayDatasource
+    end
+
+    # only MySQL type is currently supported
+    def create(name, encrypted_credentials, db_server, db_name)
+      data = @tenant.post("/gateways/#{@gateway.id}/datasources",) do |req|
+        req.body = {
+          connectionDetails: {server: db_server, database: db_name}.to_json,
+          credentialDetails: {
+            credentialType: "Basic",
+            credentials: encrypted_credentials,
+            encryptedConnection: "Encrypted",
+            encryptionAlgorithm: "RSA-OAEP",
+            privacyLevel: "Organizational",
+            useCallerAADIdentity: false,
+            useEndUserOAuth2Credentials: false,
+          },
+          datasourceName: name,
+          datasourceType: 'MySql',
+        }.to_json
+      end
+      self.reload
+      GatewayDatasource.new(@tenant, data)
+    end
+
+    def get_data
+      data = @tenant.get("/gateways/#{@gateway.id}/datasources")[:value]
+      data.each { |d| d[:gateway] = @gateway }
+    end
+  end
+end

data/lib/power-bi/refresh.rb

@@ -6,7 +6,7 @@ module PowerBI
       @id = data[:id]
       @refresh_type = data[:refreshType]
       @start_time = DateTime.iso8601(data[:startTime])
-      @end_time = DateTime.iso8601(data[:endTime])
+      @end_time = DateTime.iso8601(data[:endTime]) if data[:endTime]
       @service_exception_json = data[:serviceExceptionJson]
       @status = data[:status]
       @request_id = data[:requestId]

data/lib/power-bi/report.rb

@@ -2,6 +2,8 @@ module PowerBI
   class Report
     attr_reader :name, :id, :report_type, :web_url, :embed_url, :is_from_pbix, :is_owned_by_me, :dataset_id, :workspace
 
+    class ExportToFileError < PowerBI::Error ; end
+
     def initialize(tenant, data)
       @id = data[:id]
       @report_type = data[:reportType]
@@ -36,6 +38,37 @@ module PowerBI
       true
     end
 
+    def export_to_file(filename, format: 'PDF', timeout: 300)
+      # post
+      data = @tenant.post("/groups/#{workspace.id}/reports/#{id}/ExportTo") do |req|
+        req.body = {
+          format: format
+        }.to_json
+      end
+      export_id = data[:id]
+
+      # poll
+      success = false
+      iterations = 0
+      status_history = ''
+      old_status = ''
+      while !success
+        sleep 0.1
+        iterations += 1
+        raise ExportToFileError.new("Report export to file did not succeed after #{timeout} seconds. Status history:#{status_history}") if iterations > (10 * timeout)
+        new_status = @tenant.get("/groups/#{workspace.id}/reports/#{id}/exports/#{export_id}")[:status].to_s
+        success = (new_status == "Succeeded")
+        if new_status != old_status
+          status_history += "\nStatus change after #{iterations/10.0}s: '#{old_status}' --> '#{new_status}'"
+          old_status = new_status
+        end
+      end
+
+      # get and write file
+      data = @tenant.get_raw("/groups/#{workspace.id}/reports/#{id}/exports/#{export_id}/file")
+      File.open(filename, "wb") { |f| f.write(data) }
+    end
+
   end
 
   class ReportArray < Array

data/lib/power-bi/tenant.rb

@@ -1,20 +1,37 @@
 module PowerBI
   class Tenant
-    attr_reader :workspaces
+    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],
+        retry_statuses: [500], # internal server error
+        interval: 0.2,
+        interval_randomness: 0,
+        backoff_factor: 4,
+        retry_block: -> (env, options, retries, exc) { puts "retrying...!!" },
+      }
     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}"
         yield req if block_given?
       end
-      if response.status != 200
+      unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
       unless response.body.empty?
@@ -22,8 +39,45 @@ module PowerBI
       end
     end
 
+    def get_raw(url, params = {})
+      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?
+      end
+      unless [200, 202].include? response.status
+        raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
+      end
+      response.body
+    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'
+        req.headers['authorization'] = "Bearer #{token}"
+        yield req if block_given?
+      end
+      unless [200, 201, 202].include? response.status
+        raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
+      end
+      unless response.body.empty?
+        JSON.parse(response.body, symbolize_names: true)
+      end
+    end
+
+    def patch(url, params = {})
+      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'
@@ -39,7 +93,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}"
@@ -56,6 +113,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

data/lib/power-bi/workspace.rb

@@ -14,17 +14,23 @@ module PowerBI
       @datasets = DatasetArray.new(@tenant, self)
     end
 
-    def upload_pbix(file, dataset_name)
+    def upload_pbix(file, dataset_name, timeout: 30)
       data = @tenant.post_file("/groups/#{@id}/imports", file, {datasetDisplayName: dataset_name})
       import_id = data[:id]
       success = false
       iterations = 0
+      status_history = ''
+      old_status = ''
       while !success
         sleep 0.1
         iterations += 1
-        raise UploadError if iterations > 300 # 30 seconds
-        status = @tenant.get("/groups/#{@id}/imports/#{import_id}")
-        success = (status[:importState] == "Succeeded")
+        raise UploadError.new("Upload did not succeed after #{timeout} seconds. Status history:#{status_history}") if iterations > (10 * 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}'"
+          old_status = new_status
+        end
       end
       @reports.reload
       @datasets.reload

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lode Cools
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Ruby wrapper for the Power BI API - Currently supports workspaces
+description: Ruby wrapper for the Power BI API
 email: lode.cools1@gmail.com
 executables: []
 extensions: []
@@ -50,6 +50,8 @@ files:
 - lib/power-bi/array.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/parameter.rb
 - lib/power-bi/refresh.rb
 - lib/power-bi/report.rb
@@ -74,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Power BI API