power-bi 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61e60749c7e0da1010f9404770158dd257c2e4ea7bef82a6a97457dd85f8b7b8
-  data.tar.gz: 017767f4e263817f1d0fec40f56869a5191bd1778d53ef383c2b7f97869b0068
+  metadata.gz: 418399b191274cab7954c37fa24d36f17cb2f802eff6654957e9b927fce9b9ee
+  data.tar.gz: 6f1681d24c0ad6b7a986753ccb53966a46a438b334cab39404e8584769daae0f
 SHA512:
-  metadata.gz: b9e2c7483672138a160dfcca55ab7422c20ee3bb01499d959f2fde71cafff5b208acf8deb5dbbe3e80866f937b4a08bf99b653a9f35a120c3c56bad257c72e8a
-  data.tar.gz: cccd0a870109d01e4db575487c402172144b9d0b928b9e62459c3a36cca5b4f09b3f5ac7274c187b7e9ea73b2aaad5bc6890d4411ad74aa61bb8124b5514e8f3
+  metadata.gz: 1bfedc133434941eeb869dc909e322b85d21059311d1089963c48a0acd4b86d6e1d2ef05b5f2e6cd646b3eea16a5937c4aef6c46aef063afe887fcb7c2c2cb4d
+  data.tar.gz: 136a28bcfb43052f5aca2717200a4abcb3a3f81b1bcca272ff5ac79b9dad5bedb9f395446a37f00c971ed89d5edeb72e694a4c3ae685040911ec6eb1280c3cf6

data/README.md

@@ -1,3 +1,87 @@
 # 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)`
+
+# 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

@@ -1,6 +1,7 @@
 require 'pry' # TODO remove in final product
 require 'faraday'
 require 'json'
+require 'date'
 
 module PowerBI
   BASE_URL = 'https://api.powerbi.com/v1.0/myorg'
@@ -16,3 +17,6 @@ require_relative "power-bi/report"
 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

@@ -2,7 +2,7 @@ module PowerBI
   class Dataset
     attr_reader :id, :name, :add_rows_API_enabled, :configured_by, :is_refreshable, :is_effective_identity_required,
       :is_effective_identity_roles_required, :is_on_prem_gateway_required, :target_storage_mode, :workspace, :datasources,
-      :parameters
+      :parameters, :refresh_history
 
     def initialize(tenant, data)
       @id = data[:id]
@@ -18,6 +18,7 @@ module PowerBI
       @tenant = tenant
       @datasources = DatasourceArray.new(@tenant, self)
       @parameters = ParameterArray.new(@tenant, self)
+      @refresh_history = RefreshArray.new(@tenant, self)
     end
 
     def update_parameter(name, value)
@@ -30,6 +31,9 @@ module PowerBI
       true
     end
 
+    def last_refresh
+      @refresh_history.first
+    end
 
     def refresh
       @tenant.post("/groups/#{workspace.id}/datasets/#{id}/refreshes") do |req|
@@ -37,6 +41,7 @@ module PowerBI
           notifyOption: "NoNotification"
         }.to_json
       end
+      @refresh_history.reload
       true
     end
 
@@ -45,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,73 @@
+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
+
+  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

@@ -0,0 +1,32 @@
+module PowerBI
+  class Refresh
+    attr_reader :refresh_type, :start_time, :end_time, :service_exception_json, :status, :request_id
+
+    def initialize(tenant, data)
+      @id = data[:id]
+      @refresh_type = data[:refreshType]
+      @start_time = DateTime.iso8601(data[:startTime])
+      @end_time = DateTime.iso8601(data[:endTime]) if data[:endTime]
+      @service_exception_json = data[:serviceExceptionJson]
+      @status = data[:status]
+      @request_id = data[:requestId]
+    end
+
+  end
+
+  class RefreshArray < Array
+
+    def initialize(tenant, dataset)
+      super(tenant)
+      @dataset = dataset
+    end
+
+    def self.get_class
+      Refresh
+    end
+
+    def get_data
+      @tenant.get("/groups/#{@dataset.workspace.id}/datasets/#{@dataset.id}/refreshes", {'$top': '3'})[:value]
+    end
+  end
+end

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,10 +1,11 @@
 module PowerBI
   class Tenant
-    attr_reader :workspaces
+    attr_reader :workspaces, :gateways
 
     def initialize(token_generator)
       @token_generator = token_generator
       @workspaces = WorkspaceArray.new(self)
+      @gateways = GatewayArray.new(self)
     end
 
     def get(url, params = {})
@@ -14,7 +15,7 @@ module PowerBI
         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,6 +23,18 @@ module PowerBI
       end
     end
 
+    def get_raw(url, params = {})
+      response = Faraday.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|
         req.params = params
@@ -30,6 +43,22 @@ module PowerBI
         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 = {})
+      response = Faraday.patch(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, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end

data/lib/power-bi/workspace.rb

@@ -14,23 +14,35 @@ 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
       true
     end
 
+    def delete
+      @tenant.delete("/groups/#{@id}")
+      @tenant.workspaces.reload
+      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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.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,7 +50,10 @@ 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
 - lib/power-bi/tenant.rb
 - lib/power-bi/workspace.rb
@@ -73,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