power-bi 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 775da73d3b4bd60238d697acb445bff20f5326c312f09103dcd1588470c1be3b
-  data.tar.gz: 61d0ca711744223fb780b1e28918865773aae2f6e1077ce6fc11c05b8c460d4f
+  metadata.gz: 97631e0f44964ce0b4d23675e5a023ff203456d7881fea9a2f425441ac4ede8c
+  data.tar.gz: 86c3f858e9c34ec5bebd67659f803a60d2303037ddb9f7ffd9e2eb3af13624eb
 SHA512:
-  metadata.gz: dbe587141c379fafcdbc27efb1aff73b26cdf54aa6c8d66afc96d1542c9cf161014cef8fd3c1a2ffba67c9316f8159055a527e4d42d1d7d6b0bb02fa95aeb1a6
-  data.tar.gz: 6817a28f27dcf77f022877996b61ff25030bcef8ccfabf256ee67769a53fb449cc6858891fa8c3496e21f625bf0a20d751172ccebf912e94ffcf96fc5a54bc99
+  metadata.gz: c07b1a99e33190aa95e9cc4f4131a2cf9a7f875d2143b806e9e01fe0e1af1866dbd8785aea00f2d46765237431822d5814ff563c13cc9d4bc86ded7173b68798
+  data.tar.gz: dc17f34a6ba983869a2e2e48ee90de87a8c2f1f55982e40fa1f323e6e83e6e71cf119b32fdb2a2a0c658d89adb4933b5d89649eef1435e50b0233d2e95254c70

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Lode Cools
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/power-bi/array.rb

@@ -0,0 +1,33 @@
+module PowerBI
+
+  class Array
+
+    def initialize(tenant)
+      @fulfilled = false
+      @content = nil
+      @tenant = tenant
+    end
+
+    def reload
+      @fulfilled = false
+      @content = nil
+      self
+    end
+
+    private
+
+    def get_content
+      unless @fulfilled
+        klass = self.class.get_class
+        @content = get_data.map { |d| klass.new(@tenant, d)}
+        @fulfilled = true
+      end
+      @content
+    end
+
+    def method_missing(method, *args, &block)
+      get_content.send(method, *args, &block)
+    end
+  end
+
+end

data/lib/power-bi/dataset.rb

@@ -0,0 +1,61 @@
+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
+
+    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
+      @datasources = DatasourceArray.new(@tenant, self)
+      @parameters = ParameterArray.new(@tenant, self)
+    end
+
+    def update_parameter(name, value)
+      @tenant.post("/groups/#{workspace.id}/datasets/#{id}/Default.UpdateParameters") do |req|
+        req.body = {
+          updateDetails: [{name: name, newValue: value.to_s}]
+        }.to_json
+      end
+      @parameters.reload
+      true
+    end
+
+
+    def refresh
+      @tenant.post("/groups/#{workspace.id}/datasets/#{id}/refreshes") do |req|
+        req.body = {
+          notifyOption: "NoNotification"
+        }.to_json
+      end
+      true
+    end
+
+  end
+
+  class DatasetArray < Array
+
+    def initialize(tenant, workspace)
+      super(tenant)
+      @workspace = workspace
+    end
+
+    def self.get_class
+      Dataset
+    end
+
+    def get_data
+      data = @tenant.get("/groups/#{@workspace.id}/datasets")[:value]
+      data.each { |d| d[:workspace] = @workspace }
+    end
+  end
+end

data/lib/power-bi/datasource.rb

@@ -0,0 +1,30 @@
+module PowerBI
+  class Datasource
+    attr_reader :gateway_id, :datasource_id, :datasource_type, :connection_details
+
+    def initialize(tenant, data)
+      @gateway_id = data[:gatewayId]
+      @datasource_type = data[:datasourceType]
+      @connection_details = data[:connectionDetails]
+      @datasource_id = data[:datasourceId]
+      @tenant = tenant
+    end
+
+  end
+
+  class DatasourceArray < Array
+
+    def initialize(tenant, dataset)
+      super(tenant)
+      @dataset = dataset
+    end
+
+    def self.get_class
+      Datasource
+    end
+
+    def get_data
+      @tenant.get("/groups/#{@dataset.workspace.id}/datasets/#{@dataset.id}/datasources")[:value]
+    end
+  end
+end

data/lib/power-bi/parameter.rb

@@ -0,0 +1,29 @@
+module PowerBI
+  class Parameter
+    attr_reader :name, :type, :is_required, :current_value
+
+    def initialize(tenant, data)
+      @name = data[:name]
+      @type = data[:type]
+      @is_required = data[:isRequired]
+      @current_value = data[:currentValue]
+    end
+
+  end
+
+  class ParameterArray < Array
+
+    def initialize(tenant, dataset)
+      super(tenant)
+      @dataset = dataset
+    end
+
+    def self.get_class
+      Parameter
+    end
+
+    def get_data
+      @tenant.get("/groups/#{@dataset.workspace.id}/datasets/#{@dataset.id}/parameters")[:value]
+    end
+  end
+end

data/lib/power-bi/report.rb

@@ -0,0 +1,48 @@
+module PowerBI
+  class Report
+    attr_reader :name, :id, :report_type, :web_url, :embed_url, :is_from_pbix, :is_owned_by_me, :dataset_id, :workspace
+
+    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
+    end
+
+    def clone(target_workspace, new_report_name)
+      data = @tenant.post("/reports/#{@id}/Clone") do |req|
+        req.body = {
+          name: new_report_name,
+          targetWorkspaceId: target_workspace.id
+        }.to_json
+      end
+      target_workspace.reports.reload
+      data[:workspace] = target_workspace
+      Report.new(@tenant, data)
+    end
+
+  end
+
+  class ReportArray < Array
+
+    def initialize(tenant, workspace)
+      super(tenant)
+      @workspace = workspace
+    end
+
+    def self.get_class
+      Report
+    end
+
+    def get_data
+      data = @tenant.get("/groups/#{@workspace.id}/reports")[:value]
+      data.each { |d| d[:workspace] = @workspace }
+    end
+  end
+end

data/lib/power-bi/tenant.rb

@@ -0,0 +1,65 @@
+module PowerBI
+  class Tenant
+    attr_reader :workspaces
+
+    def initialize(token_generator)
+      @token_generator = token_generator
+      @workspaces = WorkspaceArray.new(self)
+    end
+
+    def get(url, params = {})
+      response = Faraday.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
+        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 post(url, params = {})
+      response = Faraday.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, 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 post_file(url, file, params = {})
+      conn = Faraday.new do |f|
+        f.request :multipart
+      end
+      response = conn.post(PowerBI::BASE_URL + url) do |req|
+        req.params = params
+        req.headers['Accept'] = 'application/json'
+        req.headers['Content-Type'] = 'multipart/form-data'
+        req.headers['authorization'] = "Bearer #{token}"
+        req.body = {value: Faraday::UploadIO.new(file, 'application/octet-stream')}
+      end
+      if response.status != 202
+        raise APIError.new("Error calling Power BI API (status #{response.status}): #{response.body}")
+      end
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    private
+
+    def token
+      @token_generator.call
+    end
+
+  end
+end

data/lib/power-bi/workspace.rb

@@ -0,0 +1,53 @@
+module PowerBI
+  class Workspace
+    attr_reader :name, :is_read_only, :is_on_dedicated_capacity, :id, :reports, :datasets
+
+    class UploadError < 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
+      @reports = ReportArray.new(@tenant, self)
+      @datasets = DatasetArray.new(@tenant, self)
+    end
+
+    def upload_pbix(file, dataset_name)
+      data = @tenant.post_file("/groups/#{@id}/imports", file, {datasetDisplayName: dataset_name})
+      import_id = data[:id]
+      success = false
+      iterations = 0
+      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")
+      end
+      @reports.reload
+      @datasets.reload
+      true
+    end
+
+  end
+
+  class WorkspaceArray < Array
+    def self.get_class
+      Workspace
+    end
+
+    def create(name)
+      data = @tenant.post("/groups", {workspaceV2: 'True'}) do |req|
+        req.body = {name: name}.to_json
+      end
+      self.reload
+      Workspace.new(@tenant, data)
+    end
+
+    def get_data
+      @tenant.get("/groups")[:value]
+    end
+  end
+end

data/lib/power-bi.rb

@@ -1,5 +1,18 @@
-class PowerBi
-  def self.hi
-    puts "Hello Power BI world!"
-  end
-end
+require 'pry' # TODO remove in final product
+require 'faraday'
+require 'json'
+
+module PowerBI
+  BASE_URL = 'https://api.powerbi.com/v1.0/myorg'
+
+  class Error < StandardError ; end
+  class APIError < Error ; end
+end
+
+require_relative "power-bi/tenant"
+require_relative "power-bi/array"
+require_relative "power-bi/workspace"
+require_relative "power-bi/report"
+require_relative "power-bi/dataset"
+require_relative "power-bi/datasource"
+require_relative "power-bi/parameter"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-bi
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Lode Cools
@@ -9,15 +9,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-01-27 00:00:00.000000000 Z
-dependencies: []
-description: Ruby wrapper for the Power BI API
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper for the Power BI API - Currently supports workspaces
 email: lode.cools1@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/power-bi.rb
+- lib/power-bi/array.rb
+- lib/power-bi/dataset.rb
+- lib/power-bi/datasource.rb
+- lib/power-bi/parameter.rb
+- lib/power-bi/report.rb
+- lib/power-bi/tenant.rb
+- lib/power-bi/workspace.rb
 homepage: https://github.com/piloos/power-bi
 licenses:
 - MIT