power-bi 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c07790a47531d65bb2852b54424770b8ada89c21990e1834a4a6df0a5145abf
-  data.tar.gz: eab66b74310e06fb6e4e46a33d785013323991ff26e03690d79f58bc517ccf96
+  metadata.gz: e5aaadec6cec57b22f4780dd2e1f4c64c55872d49f5a17a59326fcff099844dd
+  data.tar.gz: 1a6bf8c48a1d17333f58519c5ee23ee9a85025c63110c6cc2f2fe9243566f7ca
 SHA512:
-  metadata.gz: 0e2f5fc2425a071970fe1f8f0738b4eb94ebd0b63b9f01b2fa5dd610be967b6a7a398d648611bef4f6f56a373c3af1cf6f9d53c2301de397a2ec3d3d535992d0
-  data.tar.gz: 82a07144dc3de0b18e48fb603dd6528dddc3d4fd003d86d973f71662435d37ef4e986b73d8857391937211500d52d064728a295378187819726576217a430594
+  metadata.gz: 570af0ad49001778d237e4ce712a8120d879cc83d53a9b4a877d2d51ee6fcc3dde4e913cc8a3c42273ce5de45d31d7922308fee03c895fb6fcbce46332b06288
+  data.tar.gz: 760813b41e3318fc52871f3adc61f4efcf518f9333f93fcf9295c15b9e61d094518cbd3adbbf7fec0c3c7921239d2082460099fc2adffcd4b60c15067e5946e1

data/README.md

@@ -12,9 +12,9 @@ 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')`, while `pbi.workspace('123').name` will trigger a call.
+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 index.
+Note 2: to limit the number of API calls, it is best to directly use the _getters_ iso the _lists_.
 
 ## Workspaces (aka Groups)
 
@@ -24,6 +24,8 @@ Note 2: to limit the number of API calls, it is best to directly use the _getter
 * 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
 
@@ -31,7 +33,8 @@ Note 2: to limit the number of API calls, it is best to directly use the _getter
 * 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')`
+* Get embed token: `report.embed_token(access_level: 'View', lifetime_in_minutes: 60)`
 
 ## Pages
 
@@ -65,6 +68,13 @@ Note 2: to limit the number of API calls, it is best to directly use the _getter
 * 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/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/report.rb

@@ -79,6 +79,19 @@ module PowerBI
       File.open(filename, "wb") { |f| f.write(data) }
     end
 
+    def embed_token(access_level: 'View', lifetime_in_minutes: 60)
+      data = @tenant.post("/groups/#{workspace.id}/reports/#{id}/GenerateToken") do |req|
+        req.body = {
+          accessLevel: access_level,
+          lifetimeInMinutes: lifetime_in_minutes
+        }.to_json
+      end
+      {
+        token: data[:token],
+        expiration: Time.parse(data[:expiration])
+      }
+    end
+
   end
 
   class ReportArray < Array

data/lib/power-bi/tenant.rb

@@ -1,19 +1,20 @@
 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,
-        exceptions: [Errno::ETIMEDOUT, Timeout::Error, Faraday::TimeoutError, Faraday::RetriableResponse],
+        exceptions: [Errno::ETIMEDOUT, Timeout::Error, Faraday::TimeoutError, Faraday::RetriableResponse, Faraday::ConnectionFailed],
         methods: [:get, :post, :patch, :delete],
         retry_statuses: [500], # internal server error
         interval: 0.2,
@@ -37,6 +38,10 @@ module PowerBI
       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|

data/lib/power-bi/user.rb

@@ -18,7 +18,7 @@ module PowerBI
     end
 
     def delete
-      @tenant.delete("/groups/#{@workspace.id}/users/#{@email_address}")
+      @tenant.delete("/groups/#{@workspace.id}/users/#{email_address}")
       @workspace.users.reload
     end
 

data/lib/power-bi/workspace.rb

@@ -3,6 +3,7 @@ module PowerBI
     attr_reader :reports, :datasets, :users
 
     class UploadError < PowerBI::Error ; end
+    class CapacityAssignmentError < PowerBI::Error ; end
 
     def initialize(tenant, parent, id = nil)
       super(tenant, id)
@@ -61,6 +62,41 @@ module PowerBI
       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

data/lib/power-bi.rb

@@ -23,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: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Lode Cools
@@ -90,6 +90,7 @@ 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
@@ -121,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