power-bi 1.7.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cdaf275d6377b0f772985c4e6b616030022652fd88201f7cc79b04cfe009d67
-  data.tar.gz: 654d2e658ffbc996beb652976094eceecf95256897ad70ff59b461e46810ff82
+  metadata.gz: 349bd7851001e6e16d1d14f50f6abdbd473038ed3ec9665d5cd009a74db365f2
+  data.tar.gz: fe96607cd040b4fd034336865e7f78ceb35b297526242c4bc1f8ea3419dc95a3
 SHA512:
-  metadata.gz: ccf88e40d284bc8e91e0bc683ed077a42a077a810e409346ac6dce508e8803b9313c7ccc1ec3ab0937c43d53169dfdbb04db64c3c73d55b52180a4f2d59a0dc0
-  data.tar.gz: 221a648dbbc8e35ab2ed75834dfbe756e57f5583282a5f1224194489378c6c17d3c10f5f2578c50f377e1536b14bd9398b7a586ba89ec751bfa89eb15c0ca79e
+  metadata.gz: efc0967cf34f597d99b17a25272ba8546c9200d7e7d85ab8ffbf2ff36f99861560799cefa280f2efb787135bb4afd5bd6588fc3d147b867bd97794803d128637
+  data.tar.gz: eff9aeb3c7609cd54cf7d9888bb0b6ebc2cddc9cd9996e614d3dffdd8d61f77fc40480fa71baebbfc775044dedc0bd40cf83e36236c512d6808ff8ea3dcb293b

data/README.md

@@ -12,20 +12,28 @@ pbi = PowerBI::Tenant.new(->{token = get_token(client, token) ; token.token})
 
 # Supported endpoints
 
+Note: where possible we use _lazy evaluation_: we only call the REST API endpoint when really needed. For examples `pbi.workspaces` won't trigger a call, while `pbi.workspaces.count` will trigger a call.  And `pbi.workspace('123')` won't trigger a call, while `pbi.workspace('123').name` will trigger a call.
+
+Note 2: to limit the number of API calls, it is best to directly use the _getters_ iso the _lists_.
+
 ## Workspaces (aka Groups)
 
 * List workspaces: `pbi.workspaces`
+* Get a specific workspace `pbi.workspace(id)`
 * 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')`
+* Assign a workspace to a capacity: `workspace.assign_to_capacity(capacity)`
+* Unassign a workspace from a capacity: `workspace.unassign_from_capacity`
 
 ## Reports
 
 * List reports in a workspace: `workspace.reports`
+* Get report in a workspace: `workspace.report(id)`
 * 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')`
+* Export report to file: `report.export_to_file(filename, format: 'PDF')`
 
 ## Pages
 
@@ -40,6 +48,7 @@ pbi = PowerBI::Tenant.new(->{token = get_token(client, token) ; token.token})
 ## Datasets
 
 * List datasets in a workspace: `workspace.datasets`
+* Get report in a workspace: `workspace.dataset(id)`
 * 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`
@@ -49,6 +58,7 @@ pbi = PowerBI::Tenant.new(->{token = get_token(client, token) ; token.token})
 ## Gateways
 
 * List gateways: `pbi.gateways`
+* Get a specific gateway `pbi.gateway(id)`
 
 ## Gateway datasources
 
@@ -57,6 +67,13 @@ pbi = PowerBI::Tenant.new(->{token = get_token(client, token) ; token.token})
 * Create a new gateway datasource: `gateway.gateway_datasource.create(name, credentials, db_server, db_name)`
 * Delete a new gateway datasource: `gateway_datasource.delete`
 
+## Capacities
+
+Note: Capacities are Azure creatures, you can't create them in Power BI.
+
+* List capacities: `pbi.capacities`
+* Get a capacity: `pbi.capacity(id)`
+
 # 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:

data/lib/power-bi/array.rb

@@ -2,10 +2,11 @@ module PowerBI
 
   class Array
 
-    def initialize(tenant)
+    def initialize(tenant, parent = nil)
       @fulfilled = false
       @content = nil
       @tenant = tenant
+      @parent = parent
     end
 
     def reload
@@ -19,7 +20,7 @@ module PowerBI
     def get_content
       unless @fulfilled
         klass = self.class.get_class
-        @content = get_data.map { |d| klass.new(@tenant, d)}
+        @content = get_data.map { |d| klass.instantiate_from_data(@tenant, @parent, d) }
         @fulfilled = true
       end
       @content

data/lib/power-bi/capacity.rb

@@ -0,0 +1,35 @@
+module PowerBI
+  class Capacity < Object
+
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+    end
+
+    def get_data(id)
+      @tenant.get("/capacities", {'$filter': "id eq #{id}"})[:value].first
+    end
+
+    def data_to_attributes(data)
+      {
+        id: data[:id],
+        display_name: data[:displayName],
+        sku: data[:sku],
+        state: data[:state],
+        region: data[:region],
+        capacity_user_access_right: data[:capacityUserAccessRight],
+        admins: data[:admins],
+      }
+    end
+
+  end
+
+  class CapacityArray < Array
+    def self.get_class
+      Capacity
+    end
+
+    def get_data
+      @tenant.get("/capacities")[:value]
+    end
+  end
+end

data/lib/power-bi/dataset.rb

@@ -1,26 +1,33 @@
 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, :refresh_history
+  class Dataset < Object
+    attr_reader :workspace, :datasources, :parameters, :refresh_history
 
-    def initialize(tenant, data)
-      @id = data[:id]
-      @name = data[:name]
-      @add_rows_API_enabled = data[:addRowsAPIEnabled]
-      @configured_by = data[:configuredBy]
-      @is_refreshable = data[:isRefreshable]
-      @is_effective_identity_required = data[:isEffectiveIdentityRequired]
-      @is_effective_identity_roles_required = data[:isEffectiveIdentityRolesRequired]
-      @is_on_prem_gateway_required = data[:isOnPremGatewayRequired]
-      @target_storage_mode = data[:targetStorageMode]
-      @workspace = data[:workspace]
-      @tenant = tenant
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @workspace = parent
       @datasources = DatasourceArray.new(@tenant, self)
       @parameters = ParameterArray.new(@tenant, self)
       @refresh_history = RefreshArray.new(@tenant, self)
     end
 
+    def get_data(id)
+      @tenant.get("/groups/#{@workspace.id}/datasets/#{id}")
+    end
+
+    def data_to_attributes(data)
+      {
+        id: data[:id],
+        name: data[:name],
+        add_rows_API_enabled: data[:addRowsAPIEnabled],
+        configured_by: data[:configuredBy],
+        is_refreshable: data[:isRefreshable],
+        is_effective_identity_required: data[:isEffectiveIdentityRequired],
+        is_effective_identity_roles_required: data[:isEffectiveIdentityRolesRequired],
+        is_on_prem_gateway_required: data[:isOnPremGatewayRequired],
+        target_storage_mode: data[:targetStorageMode],
+      }
+    end
+
     def update_parameter(name, value)
       @tenant.post("/groups/#{workspace.id}/datasets/#{id}/Default.UpdateParameters") do |req|
         req.body = {
@@ -66,7 +73,7 @@ module PowerBI
   class DatasetArray < Array
 
     def initialize(tenant, workspace)
-      super(tenant)
+      super(tenant, workspace)
       @workspace = workspace
     end
 
@@ -75,8 +82,7 @@ module PowerBI
     end
 
     def get_data
-      data = @tenant.get("/groups/#{@workspace.id}/datasets")[:value]
-      data.each { |d| d[:workspace] = @workspace }
+      @tenant.get("/groups/#{@workspace.id}/datasets")[:value]
     end
   end
 end

data/lib/power-bi/datasource.rb

@@ -1,13 +1,19 @@
 module PowerBI
-  class Datasource
-    attr_reader :gateway_id, :datasource_id, :datasource_type, :connection_details
+  class Datasource < Object
+    attr_reader :dataset
 
-    def initialize(tenant, data)
-      @gateway_id = data[:gatewayId]
-      @datasource_type = data[:datasourceType]
-      @connection_details = data[:connectionDetails]
-      @datasource_id = data[:datasourceId]
-      @tenant = tenant
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @dataset = parent
+    end
+
+    def data_to_attributes(data)
+      {
+        gateway_id: data[:gatewayId],
+        datasource_type: data[:datasourceType],
+        connection_details: data[:connectionDetails],
+        datasource_id: data[:datasourceId],
+      }
     end
 
   end
@@ -15,7 +21,7 @@ module PowerBI
   class DatasourceArray < Array
 
     def initialize(tenant, dataset)
-      super(tenant)
+      super(tenant, dataset)
       @dataset = dataset
     end
 

data/lib/power-bi/gateway.rb

@@ -1,16 +1,29 @@
 module PowerBI
-  class Gateway
-    attr_reader :name, :id, :type, :public_key, :gateway_datasources
+  class Gateway < Object
+    attr_reader :gateway_datasources
 
-    def initialize(tenant, data)
-      @id = data[:id]
-      @name = data[:name]
-      @type = data[:type]
-      @public_key = data[:publicKey]
-      @tenant = tenant
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
       @gateway_datasources = GatewayDatasourceArray.new(@tenant, self)
     end
 
+    def get_data(id)
+      @tenant.get("/gateways/#{id}")
+    end
+
+    def data_to_attributes(data)
+      {
+        id: data[:id],
+        name: data[:name],
+        type: data[:type],
+        public_key: data[:publicKey],
+      }
+    end
+
+    def gateway_datasource(id)
+      GatewayDatasource.new(@tenant, self, id)
+    end
+
   end
 
   class GatewayArray < Array

data/lib/power-bi/gateway_datasource.rb

@@ -1,20 +1,30 @@
 module PowerBI
-  class GatewayDatasource
-    attr_reader :id, :gateway_id, :datasource_type, :connection_details, :credential_type, :datasource_name, :gateway
+  class GatewayDatasource < Object
+    attr_reader :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
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @gateway = parent
+    end
+
+    def get_data(id)
+      @tenant.get("/gateways/#{@gateway.id}/datasources/#{id}")
+    end
+
+    def data_to_attributes(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],
+      }
     end
 
     def update_credentials(encrypted_credentials)
-      response = @tenant.patch("/gateways/#{gateway.id}/datasources/#{id}") do |req|
+      @tenant.patch("/gateways/#{gateway.id}/datasources/#{id}") do |req|
         req.body = {
           credentialDetails: {
             credentialType: "Basic",
@@ -41,7 +51,7 @@ module PowerBI
   class GatewayDatasourceArray < Array
 
     def initialize(tenant, gateway)
-      super(tenant)
+      super(tenant, gateway)
       @gateway = gateway
     end
 
@@ -68,12 +78,11 @@ module PowerBI
         }.to_json
       end
       self.reload
-      GatewayDatasource.new(@tenant, data)
+      GatewayDatasource.instantiate_from_data(@tenant, @gateway, data)
     end
 
     def get_data
-      data = @tenant.get("/gateways/#{@gateway.id}/datasources")[:value]
-      data.each { |d| d[:gateway] = @gateway }
+      @tenant.get("/gateways/#{@gateway.id}/datasources")[:value]
     end
   end
 end

data/lib/power-bi/object.rb

@@ -0,0 +1,59 @@
+module PowerBI
+
+  class Object
+    attr_reader :id
+
+    class UnkownAttributeError < PowerBI::Error ; end
+    class UnspecifiedIdError < PowerBI::Error ; end
+
+    def initialize(tenant, id = nil)
+      @id = id
+      @fulfilled = false
+      @not_found = nil
+      @attributes = nil
+      @tenant = tenant
+    end
+
+    def set_attributes(data)
+      @fulfilled = true
+      @not_found = false
+      @id = data[:id]
+      @attributes = data_to_attributes(data)
+    end
+
+    def reload
+      @fulfilled = false
+      @attributes = nil
+      self
+    end
+
+    def self.instantiate_from_data(tenant, parent, data)
+      o = new(tenant, parent)
+      o.set_attributes(data)
+      o
+    end
+
+    private
+
+    def get_attributes
+      unless @fulfilled
+        raise UnspecifiedIdError unless @id
+        begin
+          set_attributes(get_data(@id))
+        rescue PowerBI::NotFoundError
+          @not_found = true
+          raise PowerBI::NotFoundError
+        end
+      end
+      @attributes
+    end
+
+    def method_missing(method, *args, &block)
+      get_attributes.fetch(method.to_sym) do
+        raise UnkownAttributeError.new "Unknown attribute #{method}"
+      end
+    end
+
+  end
+
+end

data/lib/power-bi/page.rb

@@ -1,20 +1,26 @@
 module PowerBI
-  class Page
-    attr_reader :display_name, :name, :order, :report
+  class Page < Object
+    attr_reader :report
 
-    def initialize(tenant, data)
-      @name = data[:name]
-      @display_name = data[:displayName]
-      @order = data[:order]
-      @report = data[:report]
-      @tenant = tenant
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @report = parent
     end
+
+    def data_to_attributes(data)
+      {
+        name: data[:name],
+        display_name: data[:displayName],
+        order: data[:order],
+      }
+    end
+
   end
 
   class PageArray < Array
 
     def initialize(tenant, report)
-      super(tenant)
+      super(tenant, report)
       @report = report
     end
 
@@ -23,8 +29,7 @@ module PowerBI
     end
 
     def get_data
-      data = @tenant.get("/groups/#{@report.workspace.id}/reports/#{@report.id}/pages")[:value]
-      data.each { |d| d[:report] = @report }
+      @tenant.get("/groups/#{@report.workspace.id}/reports/#{@report.id}/pages")[:value]
     end
   end
 end

data/lib/power-bi/parameter.rb

@@ -1,12 +1,19 @@
 module PowerBI
-  class Parameter
-    attr_reader :name, :type, :is_required, :current_value
+  class Parameter < Object
+    attr_reader :dataset
 
-    def initialize(tenant, data)
-      @name = data[:name]
-      @type = data[:type]
-      @is_required = data[:isRequired]
-      @current_value = data[:currentValue]
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @dataset = parent
+    end
+
+    def data_to_attributes(data)
+      {
+        name: data[:name],
+        type: data[:type],
+        is_required: data[:isRequired],
+        current_value: data[:currentValue],
+      }
     end
 
   end
@@ -14,7 +21,7 @@ module PowerBI
   class ParameterArray < Array
 
     def initialize(tenant, dataset)
-      super(tenant)
+      super(tenant, dataset)
       @dataset = dataset
     end
 

data/lib/power-bi/refresh.rb

@@ -1,15 +1,22 @@
 module PowerBI
-  class Refresh
-    attr_reader :refresh_type, :start_time, :end_time, :service_exception_json, :status, :request_id
+  class Refresh < Object
+    attr_reader :dataset
 
-    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]
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @dataset = parent
+    end
+
+    def data_to_attributes(data)
+      {
+        id: data[:id],
+        refresh_type: data[:refreshType],
+        start_time: DateTime.iso8601(data[:startTime]),
+        end_time: data[:endTime] ? DateTime.iso8601(data[:endTime]) : nil,
+        service_exception_json: data[:serviceExceptionJson],
+        status: data[:status],
+        request_id: data[:requestId],
+      }
     end
 
   end
@@ -17,7 +24,7 @@ module PowerBI
   class RefreshArray < Array
 
     def initialize(tenant, dataset)
-      super(tenant)
+      super(tenant, dataset)
       @dataset = dataset
     end
 
@@ -26,7 +33,7 @@ module PowerBI
     end
 
     def get_data
-      @tenant.get("/groups/#{@dataset.workspace.id}/datasets/#{@dataset.id}/refreshes", {'$top': '3'})[:value]
+      @tenant.get("/groups/#{@dataset.workspace.id}/datasets/#{@dataset.id}/refreshes", {'$top': '1'})[:value]
     end
   end
 end

data/lib/power-bi/report.rb

@@ -1,23 +1,32 @@
 module PowerBI
-  class Report
-    attr_reader :name, :id, :report_type, :web_url, :embed_url, :is_from_pbix, :is_owned_by_me, :dataset_id, :workspace, :pages
+  class Report < Object
+    attr_reader :workspace, :pages
 
     class ExportToFileError < PowerBI::Error ; end
 
-    def initialize(tenant, data)
-      @id = data[:id]
-      @report_type = data[:reportType]
-      @name = data[:name]
-      @web_url = data[:webUrl]
-      @embed_url = data[:embedUrl]
-      @is_from_pbix = data[:isFromPbix]
-      @is_owned_by_me = data[:isOwnedByMe]
-      @dataset_id = data[:datasetId]
-      @workspace = data[:workspace]
-      @tenant = tenant
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @workspace = parent
       @pages = PageArray.new(@tenant, self)
     end
 
+    def get_data(id)
+      @tenant.get("/groups/#{@workspace.id}/reports/#{id}")
+    end
+
+    def data_to_attributes(data)
+      {
+        id: data[:id],
+        report_type: data[:reportType],
+        name: data[:name],
+        web_url: data[:webUrl],
+        embed_url: data[:embedUrl],
+        is_from_pbix: data[:isFromPbix],
+        is_owned_by_me: data[:isOwnedByMe],
+        dataset_id: data[:datasetId],
+      }
+    end
+
     def clone(target_workspace, new_report_name)
       data = @tenant.post("/reports/#{@id}/Clone") do |req|
         req.body = {
@@ -75,7 +84,7 @@ module PowerBI
   class ReportArray < Array
 
     def initialize(tenant, workspace)
-      super(tenant)
+      super(tenant, workspace)
       @workspace = workspace
     end
 
@@ -84,8 +93,7 @@ module PowerBI
     end
 
     def get_data
-      data = @tenant.get("/groups/#{@workspace.id}/reports")[:value]
-      data.each { |d| d[:workspace] = @workspace }
+      @tenant.get("/groups/#{@workspace.id}/reports")[:value]
     end
   end
 end

data/lib/power-bi/tenant.rb

@@ -1,15 +1,16 @@
 module PowerBI
   class Tenant
-    attr_reader :workspaces, :gateways
+    attr_reader :workspaces, :gateways, :capacities
 
     def initialize(token_generator, retries: 5, logger: nil)
       @token_generator = token_generator
       @workspaces = WorkspaceArray.new(self)
       @gateways = GatewayArray.new(self)
+      @capacities = CapacityArray.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 :-)
+      # It is noticed that once in a while (~0.1% API calls), the Power BI server returns a 500 (internal server error) without apparent reason, just retrying works :-)
       ##################
       @retry_options = {
         max: retries,
@@ -29,6 +30,18 @@ module PowerBI
       end
     end
 
+    def workspace(id)
+      Workspace.new(self, nil, id)
+    end
+
+    def gateway(id)
+      Gateway.new(self, nil, id)
+    end
+
+    def capacity(id)
+      Capacity.new(self, nil, id)
+    end
+
     def get(url, params = {})
       t0 = Time.now
       conn = Faraday.new do |f|
@@ -40,10 +53,13 @@ module PowerBI
         req.headers['authorization'] = "Bearer #{token}"
         yield req if block_given?
       end
+      if response.status == 400
+        raise NotFoundError
+      end
       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"
+      log "Calling (GET) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
       unless response.body.empty?
         JSON.parse(response.body, symbolize_names: true)
       end
@@ -59,7 +75,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"
+      log "Calling (GET - raw) #{response.env.url.to_s} - 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
@@ -78,7 +94,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"
+      log "Calling (POST) #{response.env.url.to_s} - 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
@@ -99,7 +115,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"
+      log "Calling (PATCH) #{response.env.url.to_s} - 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
@@ -119,7 +135,10 @@ 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"
+      log "Calling (DELETE) #{response.env.url.to_s} - took #{((Time.now - t0) * 1000).to_i} ms"
+      if [400, 401, 404].include? response.status
+        raise NotFoundError
+      end
       unless [200, 202].include? response.status
         raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
       end
@@ -142,7 +161,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"
+      log "Calling (POST - file) #{response.env.url.to_s} - 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

@@ -1,15 +1,20 @@
 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
+  class User < Object
+    attr_reader :workspace
+
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
+      @workspace = parent
+    end
+
+    def data_to_attributes(data)
+      {
+        email_address: data[:emailAddress],
+        group_user_access_right: data[:groupUserAccessRight],
+        display_name: data[:displayName],
+        identifier: data[:identifier],
+        principal_type: data[:principalType],
+      }
     end
 
     def delete
@@ -22,7 +27,7 @@ module PowerBI
   class UserArray < Array
 
     def initialize(tenant, workspace)
-      super(tenant)
+      super(tenant, workspace)
       @workspace = workspace
     end
 
@@ -41,8 +46,7 @@ module PowerBI
     end
 
     def get_data
-      data = @tenant.get("/groups/#{@workspace.id}/users")[:value]
-      data.each { |d| d[:workspace] = @workspace }
+      @tenant.get("/groups/#{@workspace.id}/users")[:value]
     end
   end
 end

data/lib/power-bi/workspace.rb

@@ -1,20 +1,30 @@
 module PowerBI
-  class Workspace
-    attr_reader :name, :is_read_only, :is_on_dedicated_capacity, :id, :reports, :datasets, :users
+  class Workspace < Object
+    attr_reader :reports, :datasets, :users
 
     class UploadError < PowerBI::Error ; end
+    class CapacityAssignmentError < PowerBI::Error ; end
 
-    def initialize(tenant, data)
-      @id = data[:id]
-      @is_read_only = data[:isReadOnly]
-      @is_on_dedicated_capacity = data[:isOnDedicatedCapacity]
-      @name = data[:name]
-      @tenant = tenant
+    def initialize(tenant, parent, id = nil)
+      super(tenant, id)
       @reports = ReportArray.new(@tenant, self)
       @datasets = DatasetArray.new(@tenant, self)
       @users = UserArray.new(@tenant, self)
     end
 
+    def get_data(id)
+      @tenant.get("/groups", {'$filter': "id eq #{id}"})[:value].first
+    end
+
+    def data_to_attributes(data)
+      {
+        id: data[:id],
+        is_read_only: data[:isReadOnly],
+        is_on_dedicated_capacity: data[:isOnDedicatedCapacity],
+        name: data[:name],
+      }
+    end
+
     def upload_pbix(file, dataset_name, timeout: 30)
       data = @tenant.post_file("/groups/#{@id}/imports", file, {datasetDisplayName: dataset_name})
       import_id = data[:id]
@@ -44,6 +54,49 @@ module PowerBI
       true
     end
 
+    def report(id)
+      Report.new(@tenant, self, id)
+    end
+
+    def dataset(id)
+      Dataset.new(@tenant, self, id)
+    end
+
+    def assign_to_capacity(capacity, timeout: 30)
+      _assign_to_capacity(capacity.id, timeout: timeout)
+    end
+
+    def unassign_from_capacity(timeout: 30)
+      _assign_to_capacity('00000000-0000-0000-0000-000000000000', timeout: timeout)
+    end
+
+    private
+
+    def _assign_to_capacity(capacity_id, timeout: 30)
+      @tenant.post("/groups/#{@id}/AssignToCapacity") do |req|
+        req.body = {
+          capacityId: capacity_id,
+        }.to_json
+      end
+
+      success = false
+      iterations = 0
+      status_history = ''
+      old_status = ''
+      while !success
+        sleep 0.5
+        iterations += 1
+        raise CapacityAssignmentError.new("(Un)assignment did not succeed after #{timeout} seconds. Status history:#{status_history}") if iterations > (2 * timeout)
+        new_status = @tenant.get("/groups/#{@id}/CapacityAssignmentStatus")[:status].to_s
+        success = (new_status == "CompletedSuccessfully")
+        if new_status != old_status
+          status_history += "\nStatus change after #{iterations/2}s: '#{old_status}' --> '#{new_status}'"
+          old_status = new_status
+        end
+      end
+      self.reload
+    end
+
   end
 
   class WorkspaceArray < Array
@@ -56,7 +109,7 @@ module PowerBI
         req.body = {name: name}.to_json
       end
       self.reload
-      Workspace.new(@tenant, data)
+      Workspace.instantiate_from_data(@tenant, nil, data)
     end
 
     def get_data

data/lib/power-bi.rb

@@ -8,9 +8,11 @@ module PowerBI
 
   class Error < StandardError ; end
   class APIError < Error ; end
+  class NotFoundError < Error; end
 end
 
 require_relative "power-bi/tenant"
+require_relative "power-bi/object"
 require_relative "power-bi/array"
 require_relative "power-bi/workspace"
 require_relative "power-bi/report"
@@ -21,4 +23,5 @@ 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"
+require_relative "power-bi/user"
+require_relative "power-bi/capacity"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Lode Cools
@@ -90,10 +90,12 @@ files:
 - README.md
 - lib/power-bi.rb
 - lib/power-bi/array.rb
+- lib/power-bi/capacity.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/object.rb
 - lib/power-bi/page.rb
 - lib/power-bi/parameter.rb
 - lib/power-bi/refresh.rb
@@ -120,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Power BI API