gooddata 1.0.0-java

data/lib/gooddata/commands/project.rb

@@ -0,0 +1,144 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'pathname'
+require 'terminal-table'
+
+require_relative '../connection'
+
+module GoodData
+  module Command
+    class Project
+      class << self
+        # Create new project based on options supplied
+        def create(options = { client: GoodData.connection })
+          title = options[:title]
+          summary = options[:summary]
+          template = options[:template]
+          token = options[:token]
+          client = options[:client]
+          driver = options[:driver] || 'Pg'
+          GoodData::Project.create(:title => title, :summary => summary, :template => template, :auth_token => token, :client => client, :driver => driver)
+        end
+
+        # Show existing project
+        def show(id, options = { client: GoodData.connection })
+          client = options[:client]
+          client.projects(id)
+        end
+
+        def invite(project_id, email, role, msg = GoodData::Project::DEFAULT_INVITE_MESSAGE, options = {})
+          client = options[:client]
+          project = client.projects(project_id)
+          fail "Invalid project id '#{project_id}' specified" if project.nil?
+
+          project.invite(email, role, msg)
+        end
+
+        # Clone existing project
+        #
+        # @param project_id [String | GoodData::Project] Project id or project instance to delete
+        # @option options [String] :data Clone including all the data (default true)
+        # @option options [String] :users Clone including all the users (default false)
+        # @option options [String] :title Name of the cloned project (default "Clone of {old_project_title}")
+        # @option options [Boolean] :exclude_schedules Specifies whether to include scheduled emails
+        # @option options [Boolean] :verbose (false) Switch on verbose mode for detailed logging
+        def clone(project_id, options = { client: GoodData.connection })
+          client = options[:client]
+          client.with_project(project_id) do |project|
+            project.clone(options)
+          end
+        end
+
+        # Deletes existing project
+        #
+        # @param project_id [String | GoodData::Project] Project id or project instance to delete
+        def delete(project_id, options = { client: GoodData.connection })
+          client = options[:client]
+          p = client.projects(project_id)
+          p.delete
+        end
+
+        # Get Spec and ID (of project)
+        def get_spec_and_project_id(base_path)
+          goodfile_path = GoodData::Helpers.find_goodfile(Pathname(base_path))
+          fail 'Goodfile could not be located in any parent directory. Please make sure you are inside a gooddata project folder.' if goodfile_path.nil?
+          goodfile = JSON.parse(File.read(goodfile_path), :symbolize_names => true)
+          spec_path = goodfile[:model] || fail('You need to specify the path of the build spec')
+          fail "Model path provided in Goodfile \"#{spec_path}\" does not exist" unless File.exist?(spec_path) && !File.directory?(spec_path)
+
+          spec_path = Pathname(spec_path)
+
+          content = File.read(spec_path)
+          spec = if spec_path.extname == '.rb'
+                   eval(content)
+                 elsif spec_path.extname == '.json'
+                   JSON.parse(spec_path, :symbolize_names => true)
+                 end
+          [spec, goodfile[:project_id]]
+        end
+
+        # Update project
+        def update(opts = { client: GoodData.connection })
+          client, project = GoodData.get_client_and_project(opts)
+          GoodData::Model::ProjectCreator.migrate(:spec => opts[:spec], :client => client, :project => project)
+        end
+
+        # Build project
+        def build(opts = { client: GoodData.connection })
+          client = opts[:client]
+          fail ArgumentError, 'No :client specified' if client.nil?
+
+          GoodData::Model::ProjectCreator.migrate(opts.merge(:client => client))
+        end
+
+        # Performs project validation
+        #
+        # @param project_id [String | GoodData::Project] Project id or project instance to validate
+        # @return [Object] Report of found problems
+        def validate(project_id, options = { client: GoodData.connection })
+          client = options[:client]
+          client.with_project(project_id, &:validate)
+        end
+
+        # Lists roles in a project
+        #
+        # @param project_id [String | GoodData::Project] Project id or project instance to list the users in
+        # @return [Array <GoodData::Role>] List of project roles
+        def roles(project_id, options = { client: GoodData.connection })
+          client = options[:client]
+          client.with_project(project_id, &:roles)
+        end
+
+        # Lists users in a project
+        #
+        # @param project_id [String | GoodData::Project] Project id or project instance to list the users in
+        # @return [Array <GoodData::Membership>] List of project users
+        def users(project_id, options = { client: GoodData.connection })
+          client = options[:client] || GoodData.connect(options)
+          client.with_project(project_id, &:users)
+        end
+
+        # Lists users in a project
+        #
+        # @param options [Hash] List of users
+        #
+        # TODO: Review and refactor #users & #list_users
+        def list_users(options = { client: GoodData.connection })
+          client = GoodData.connect(options)
+          project = client.projects(options[:project_id])
+
+          rows = project.users.to_a.map do |user|
+            [user.email, user.full_name, user.role.title, user.user_groups.join(', ')]
+          end
+
+          table = Terminal::Table.new :headings => ['Email', 'Full Name', 'Role', 'Groups'], :rows => rows
+          puts table
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/projects.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'pathname'
+
+module GoodData
+  module Command
+    class Projects
+      class << self
+        def list(options = { client: GoodData.connection })
+          client = options[:client]
+          client.projects
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/role.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require_relative '../core/core'
+
+module GoodData
+  module Command
+    class Role
+      class << self
+        def list(_pid, opts = { :client => GoodData.connection, :project => GoodData.project })
+          p = opts[:project]
+          fail ArgumentError, 'No :project specified' if p.nil?
+
+          project = GoodData::Project[p, opts]
+          fail ArgumentError, 'Wrong :project specified' if project.nil?
+
+          roles_response = client.get("/gdc/projects/#{project.pid}/roles")
+
+          roles = {}
+          roles_response['projectRoles']['roles'].each do |role_uri|
+            r = client.get(role_uri)
+            identifier = r['projectRole']['meta']['identifier']
+            roles[identifier] = {
+              :user_uri => r['projectRole']['links']['roleUsers'],
+              :uri => role_uri
+            }
+          end
+          roles
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/runners.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'pathname'
+
+module GoodData
+  module Command
+    class Runners
+      def self.run_ruby_locally(brick_dir, options = {})
+        pid = options[:project_id]
+        fail 'You have to specify a project ID' if pid.nil?
+        fail 'You have to specify directory of the brick run' if brick_dir.nil?
+        fail 'You specified file as a birck run directory. You have to specify directory.' if File.exist?(brick_dir) && !File.directory?(brick_dir)
+
+        params = options[:expanded_params] || {}
+
+        client = GoodData.connect(options[:username], options[:password])
+        sst = client.connection.sst_token
+        pwd = Pathname.new(Dir.pwd)
+
+        server_uri = URI(options[:server]) unless options[:server].nil?
+        scheme = server_uri.nil? ? '' : server_uri.scheme
+        hostname = server_uri.nil? ? '' : server_uri.host
+
+        script_body = <<-script_body
+        require 'fileutils'
+        FileUtils::cd(\"#{pwd + brick_dir}\") do\
+
+          $SCRIPT_PARAMS = {
+            "GDC_SST" => \"#{sst}\",
+            "GDC_PROJECT_ID" => \"#{pid}\",
+            "GDC_PROTOCOL" => \"#{scheme}\",
+            "GDC_HOSTNAME" => \"#{hostname}\",
+            "GDC_LOGGER_FILE" => STDOUT,
+            "GDC_ENV_LOCAL" => true
+          }.merge(#{params})
+          require './main.rb'
+        end
+        script_body
+        system('ruby', '-e', script_body)
+      end
+    end
+  end
+end

data/lib/gooddata/commands/scaffold.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'erubis'
+require 'fileutils'
+require 'pathname'
+
+module GoodData
+  module Command
+    class Scaffold
+      TEMPLATES_PATH = Pathname(__FILE__) + '../../../templates'
+
+      class << self
+        # Scaffolds new project
+        # TODO: Add option for custom output dir
+        def project(name)
+          fail ArgumentError, 'No name specified' if name.nil?
+
+          FileUtils.mkdir(name)
+          FileUtils.cd(name) do
+            FileUtils.mkdir('model')
+            FileUtils.cd('model') do
+              input = File.read(TEMPLATES_PATH + 'project/model/model.rb.erb')
+              eruby = Erubis::Eruby.new(input)
+              File.open('model.rb', 'w') do |f|
+                f.write(eruby.result(:name => name))
+              end
+            end
+
+            FileUtils.mkdir('data')
+            FileUtils.cd('data') do
+              FileUtils.cp(Dir.glob(TEMPLATES_PATH + 'project/data/*.csv'), '.')
+            end
+
+            input = File.read(TEMPLATES_PATH + 'project/Goodfile.erb')
+            eruby = Erubis::Eruby.new(input)
+            File.open('Goodfile', 'w') do |f|
+              f.write(eruby.result)
+            end
+          end
+        end
+
+        # Scaffolds new brick
+        # TODO: Add option for custom output dir
+        def brick(name)
+          fail ArgumentError, 'No name specified' if name.nil?
+
+          FileUtils.mkdir(name)
+          FileUtils.cd(name) do
+            input = File.read(TEMPLATES_PATH + 'bricks/brick.rb.erb')
+            eruby = Erubis::Eruby.new(input)
+            File.open('brick.rb', 'w') do |f|
+              f.write(eruby.result)
+            end
+
+            input = File.read(TEMPLATES_PATH + 'bricks/main.rb.erb')
+            eruby = Erubis::Eruby.new(input)
+            File.open('main.rb', 'w') do |f|
+              f.write(eruby.result)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/user.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'highline/import'
+require 'multi_json'
+
+require_relative '../core/core'
+
+module GoodData
+  module Command
+    class User
+      class << self
+        def roles(pid)
+          roles_response = GoodData.get("/gdc/projects/#{pid}/roles")
+
+          roles = {}
+          roles_response['projectRoles']['roles'].each do |role_uri|
+            r = GoodData.get(role_uri)
+            identifier = r['projectRole']['meta']['identifier']
+            roles[identifier] = {
+              :user_uri => r['projectRole']['links']['roleUsers'],
+              :uri => role_uri
+            }
+          end
+          roles
+        end
+
+        def show(opts = { client: GoodData.connection })
+          client = opts[:client]
+          fail ArgumentError, 'No :client specified' if client.nil?
+          pp client.user.json
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/connection.rb

@@ -0,0 +1,127 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'uri'
+
+require_relative 'core/logging'
+
+require_relative 'rest/rest'
+
+module GoodData
+  class << self
+    DEFAULT_SSO_OPTIONS = {
+      :url => '/gdc/app/account/bootstrap',
+      :valid => 24 * 60 * 60
+    }
+
+    # Returns the active GoodData connection earlier initialized via GoodData.connect call
+    #
+    # @see GoodData.connect
+    def connection
+      # TODO: Remove this after successful rest-factory transition
+      Rest::Client.connection # || fail('Please authenticate with GoodData.connect first')
+    end
+
+    alias_method :client, :connection
+
+    # Connect to the GoodData API
+    #
+    # @param options
+    # @param second_options
+    # @param third_options
+    #
+    def connect(options = nil, second_options = nil, third_options = {})
+      Rest::Client.connect(options, second_options, third_options)
+    end
+
+    # Disconnect (logout) if logged in
+    def disconnect
+      Rest::Client.disconnect
+    end
+
+    def with_connection(options = nil, second_options = nil, third_options = {}, &bl)
+      connection = connect(options, second_options, third_options)
+      bl.call(connection)
+    rescue Exception => e # rubocop:disable RescueException
+      puts e.message
+      raise e
+    ensure
+      disconnect
+    end
+
+    # Generates SSO URL
+    #
+    # This SSO implementation is custom implementation provided by GoodData
+    # that allows your application to sign in an existing GoodData user.
+    # The authentication is done not by username and password but by generating a session
+    # specific token using pair of PGP keys.
+    #
+    # @see https://developer.gooddata.com/article/single-sign-on
+    #
+    # @param [String] login Email address used for logging into gooddata
+    # @param [String] provider Name of SSO provider
+    # @param [Hash] opts Additional options
+    # @option opts [Fixnum] :validity Validity in seconds from 'now'
+    # @return [String] URL which can be used for SSO logging in
+    def sso_url(login, provider, opts = DEFAULT_SSO_OPTIONS)
+      opts = DEFAULT_SSO_OPTIONS.merge(opts)
+
+      ts = DateTime.now.strftime('%s').to_i + opts[:valid]
+      obj = {
+        'email' => login,
+        'validity' => ts
+      }
+
+      json_data = JSON.pretty_generate(obj) + "\n"
+
+      file_json = Tempfile.new('gooddata-sso-json')
+      file_json.write(json_data)
+
+      file_json.rewind
+      file_signed = Tempfile.new('gooddata-sso-signed')
+
+      cmd = "gpg --no-tty --armor --yes -u #{login} --output #{file_signed.path} --sign #{file_json.path}"
+      res = system(cmd)
+      fail 'Unable to sign json' unless res
+
+      file_signed.rewind
+      file_final = Tempfile.new('gooddata-sso-final')
+
+      cmd = "gpg --yes --no-tty --trust-model always --armor --output #{file_final.path} --encrypt --recipient security@gooddata.com #{file_signed.path}"
+      res = system(cmd)
+      fail 'Unable to encrypt json' unless res
+
+      file_final.rewind
+      final = file_final.read
+
+      "#{GoodData::Helpers::AuthHelper.read_server}/gdc/account/customerlogin?sessionId=#{CGI.escape(final)}&serverURL=#{CGI.escape(provider)}&targetURL=#{CGI.escape(opts[:url])}"
+    end
+
+    # Connect to GoodData using SSO
+    #
+    # This SSO implementation is custom implementation provided by GoodData
+    # that allows your application to sign in an existing GoodData user.
+    # The authentication is done not by username and password but by generating a session
+    # specific token using pair of PGP keys.
+    #
+    # @see https://developer.gooddata.com/article/single-sign-on
+    #
+    # @param [String] login Email address used for logging into gooddata
+    # @param [String] provider Name of SSO provider
+    # @return [GoodData::Rest::Client] Instance of REST client
+    def connect_sso(login, provider)
+      url = sso_url(login, provider)
+
+      params = {
+        :x_gdc_request => "#{GoodData::Rest::Connection.generate_string}:#{GoodData::Rest::Connection.generate_string}"
+      }
+
+      RestClient.get url, params do |response, _request, _result|
+        Rest::Client.connect_sso(:sst_token => URI.decode(response.cookies['GDCAuthSST']))
+      end
+    end
+  end
+end