gooddata 1.0.0-java

data/lib/gooddata/commands/api.rb

@@ -0,0 +1,64 @@
+# 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 '../exceptions/command_failed'
+
+module GoodData
+  module Command
+    # Low level access to GoodData API
+    class Api
+      class << self
+        def info
+          json = {
+            'releaseName' => 'N/A',
+            'releaseDate' => 'N/A',
+            'releaseNotesUri' => 'N/A'
+          }
+
+          puts 'GoodData API'
+          puts "  Version: #{json['releaseName']}"
+          puts "  Released: #{json['releaseDate']}"
+          puts "  For more info see #{json['releaseNotesUri']}"
+        end
+
+        alias_method :index, :info
+
+        # Test of login
+        def test
+          if GoodData.test_login
+            puts "Succesfully logged in as #{GoodData.profile.user}"
+          else
+            puts 'Unable to log in to GoodData server!'
+          end
+        end
+
+        # Get resource
+        # @param path Resource path
+        def get(path)
+          fail(GoodData::CommandFailed, 'Specify the path you want to GET.') if path.nil?
+          result = GoodData.get path
+          begin
+            result
+          rescue
+            puts result
+          end
+        end
+
+        # Delete resource
+        # @param path Resource path
+        def delete(path)
+          fail(GoodData::CommandFailed, 'Specify the path you want to DELETE.') if path.nil?
+          result = GoodData.delete path
+          begin
+            result
+          rescue
+            puts result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/auth.rb

@@ -0,0 +1,107 @@
+# 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_relative '../cli/terminal'
+require_relative '../helpers/helpers'
+
+module GoodData
+  module Command
+    class Auth
+      class << self
+        # Ask for credentials
+        # @param [String] credentials_file_path (credentials_file) Path to .gooddata file
+        # @return [Hash]
+        #   * :username [String] Username (email address)
+        #   * :password [String] Password
+        #   * :auth_token [String] Authorization token
+        #   * :environment [String] Environment - DEVELOPMENT, TEST, PRODUCTION
+        #   * :server => [String] Server - https://secure.gooddata.com
+        def ask_for_credentials(credentials_file_path = Helpers::AuthHelper.credentials_file)
+          puts 'Enter your GoodData credentials.'
+
+          old_credentials = Helpers::AuthHelper.read_credentials(credentials_file_path)
+
+          # Ask for user email
+          user = GoodData::CLI.terminal.ask('Email') do |q|
+            set_default_value(q, old_credentials[:username])
+          end
+
+          # Ask for password
+          password = GoodData::CLI.terminal.ask('Password') do |q|
+            # set_default_value(q, old_credentials[:password])
+            q.echo = '*'
+          end
+
+          # Ask for token
+          auth_token = GoodData::CLI.terminal.ask('Authorization Token') do |q|
+            set_default_value(q, old_credentials[:auth_token])
+          end
+
+          # Read environment
+          environment = GoodData::CLI.terminal.ask('Environment') do |q|
+            set_default_value(q, old_credentials[:environment], GoodData::Project::DEFAULT_ENVIRONMENT)
+          end
+
+          # Read server
+          server = GoodData::CLI.terminal.ask('Server') do |q|
+            set_default_value(q, old_credentials[:server], 'https://secure.gooddata.com')
+          end
+
+          # Return as struct
+          {
+            :username => user,
+            :password => password,
+            :auth_token => auth_token,
+            :environment => environment,
+            :server => server
+          }
+        end
+
+        # Ask for credentials and store them
+        def store(credentials_file_path = Helpers::AuthHelper.credentials_file)
+          puts 'This will store credntials to GoodData in an enencrypted form to your harddrive to file ~/.gooddata.'
+          overwrite = GoodData::CLI.terminal.ask('Do you want to continue? (y/n)')
+          return if overwrite != 'y'
+
+          credentials = ask_for_credentials
+
+          ovewrite = if File.exist?(credentials_file_path)
+                       GoodData::CLI.terminal.ask('Overwrite existing stored credentials (y/n)')
+                     else
+                       'y'
+                     end
+
+          if ovewrite == 'y'
+            Helpers::AuthHelper.write_credentials(credentials, credentials_file_path)
+          else
+            puts 'Aborting...'
+          end
+        end
+
+        # Delete stored credentials
+        def unstore(credentials_file_path = Helpers::AuthHelper.credentials_file)
+          Helpers::AuthHelper.remove_credentials_file(credentials_file_path)
+        end
+
+        # Conditionally sets default value for prompt.
+        # Default value is set to 'value' or 'default'
+        #
+        # @param [Highline] q Highline instance used
+        # @param [String] value Value used for ask default if not nil and not empty
+        # @param [String] default Value used for ask default iv 'value' is nil or empty
+        def set_default_value(q, value, default = nil)
+          if !value.nil? && !value.empty?
+            q.default = value
+          elsif default
+            q.default = default
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/base.rb

@@ -0,0 +1,12 @@
+# 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.
+
+module GoodData
+  module Command
+    class Base
+    end
+  end
+end

data/lib/gooddata/commands/commands.rb

@@ -0,0 +1,12 @@
+# 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'
+
+base = Pathname(__FILE__).dirname.expand_path
+Dir.glob(base + '*.rb').each do |file|
+  require file
+end

data/lib/gooddata/commands/datasets.rb

@@ -0,0 +1,148 @@
+# 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 'date'
+
+require_relative '../data/guesser'
+require_relative '../extract'
+require_relative '../exceptions/command_failed'
+
+module GoodData
+  module Command
+    class Datasets
+      # List all data sets present in the project specified by the --project option
+      #
+      # ## Usage
+      #
+      #     gooddata datasets --project <projectid>
+      #     gooddata datasets:list --project <projectid>
+      #
+      # * `--project` - GoodData project identifier
+      #
+      def index
+        # TODO: Review following connect replacement/reimplementation
+        # connect
+        with_project do |project_id|
+          Project[project_id].datasets.each do |ds|
+            puts "#{ds.uri}\t#{ds.identifier}\t#{ds.title}"
+          end
+        end
+      end
+
+      # Describe a data set. Currently, only a CSV data set is supported.
+      #
+      # The command prescans the data set, picks possible LDM types for it's
+      # fields and asks user for confirmation.
+      #
+      # ## Usage
+      #
+      #     gooddata datasets:describe --file-csv <path> --name <name> --output <output path>
+      #
+      # * `--file-csv` - path to the CSV file (required)
+      # * `--name` - name of the data set (user will be prompted unless provided)
+      # * `--output` - name of the output JSON file with the model description (user will be prompted unless provided)
+      #
+      def describe
+        columns = ask_for_fields
+        name = extract_option('--name') || ask('Enter the dataset name')
+        output = extract_option('--output') || ask('Enter path to the file where to save the model description', :default => "#{name}.json")
+        open output, 'w' do |f|
+          f << JSON.pretty_generate(:title => name, :columns => columns) + "\n"
+          f.flush
+        end
+      end
+
+      # Creates a server-side model based on local model description. The model description
+      # is read from a JSON file that can be generated using the +datasets:describe+ command
+      #
+      # ## Usage
+      #
+      #     gooddata datasets:apply --project <projectid> <data set config>
+      #
+      # * `--project`- GoodData project identifier
+      # * `data set config` - JSON file with the model description (possibly generated by the <tt>datasets:describe</tt> command)
+      #
+      def apply
+        # TODO: Review following connect replacement/reimplementation
+        # connect
+        with_project do |project_id|
+          begin
+            cfg_file = args.shift
+          rescue
+            raise(CommandFailed, 'Invalid arguments')
+          end
+
+          fail(CommandFailed, "Usage: #{$PROGRAM_NAME} <dataset config>") unless cfg_file
+          config = begin
+            JSON.parse open(cfg_file)
+          rescue
+            raise(CommandFailed, "Error reading dataset config file '#{cfg_file}'")
+          end
+          objects = Project[project_id].add_dataset config['title'], config['columns']
+          puts "Dataset #{config['title']} added to the project, #{objects['uris'].length} metadata objects affected"
+        end
+      end
+
+      # Loads a CSV file into an existing server-side data set
+      #
+      # ## Usage
+      #
+      #     gooddata datasets:load --project <projectid> <file> <dataset config><
+      #
+      # * `--project` - GoodData project identifier
+      # * `file` - CSV file to load
+      # * `data set config` - JSON file with the model description (possibly generated by the <tt>datasets:describe</tt> command)
+      #
+      def load
+        # TODO: Review following connect replacement/reimplementation
+        # connect
+        with_project do |project_id|
+          file, cfg_file = args
+          fail(CommandFailed, "Usage: #{$PROGRAM_NAME} datasets:load <file> <dataset config>") unless cfg_file
+          begin
+            config = JSON.parse open(cfg_file)
+          rescue
+            raise(CommandFailed, "Error reading dataset config file '#{cfg_file}'")
+          end
+          schema = Model::Schema.new config
+          Project[project_id].upload file, schema
+        end
+      end
+
+      private
+
+      def with_project
+        unless @project_id
+          @project_id = extract_option('--project')
+          fail(CommandFailed, 'Project not specified, use the --project switch') unless @project_id
+        end
+        yield @project_id
+      end
+
+      def ask_for_fields
+        guesser = GoodData::Data::Guesser.new create_dataset.read
+        guess = guesser.guess(1000)
+        model = []
+        connection_point_set = false
+        question_fmt = 'Select data type of column #%i (%s)'
+        guesser.headers.each_with_index do |header, i|
+          options = guess[header].map(&:to_s)
+          options = options.select { |t| t != :connection_point.to_s } if connection_point_set
+          type = ask((question_fmt % [i + 1, header]), :answers => options)
+          model.push :title => header, :name => header, :type => type.upcase
+          connection_point_set = true if type == :connection_point.to_s
+        end
+        model
+      end
+
+      def create_dataset
+        file = extract_option('--file-csv')
+        return Extract::CsvFile.new(file) if file
+        fail(CommandFailed, 'Unknown data set. Please specify a data set using --file-csv option (more supported data sources to come!)')
+      end
+    end
+  end
+end

data/lib/gooddata/commands/datawarehouse.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.
+
+module GoodData
+  module Command
+    # Also known as ADS and DSS
+    class DataWarehouse
+      class << self
+        # Create new project based on options supplied
+        def create(options = { client: GoodData.connection })
+          description = options[:summary] || options[:description]
+          GoodData::DataWarehouse.create(options.merge(:description => description))
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/domain.rb

@@ -0,0 +1,40 @@
+# 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 '../exceptions/command_failed'
+require_relative '../models/domain'
+
+module GoodData
+  module Command
+    # Low level access to GoodData API
+    class Domain
+      attr_reader :name
+
+      class << self
+        def add_user(domain, login, password, opts = { :client => GoodData.connection })
+          data = {
+            :domain => domain,
+            :login => login,
+            :password => password
+          }
+          GoodData::Domain.add_user(data.merge(opts))
+        end
+
+        def list_users(domain_name, options = { :client => GoodData.connection })
+          client = GoodData.connect(options)
+          domain = client.domain(domain_name)
+
+          rows = domain.users.to_a.map do |user|
+            [user.email, user.full_name]
+          end
+
+          table = Terminal::Table.new :headings => ['Email', 'Full Name'], :rows => rows
+          puts table
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/commands/process.rb

@@ -0,0 +1,67 @@
+# 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_relative '../core/core'
+
+module GoodData
+  module Command
+    class Process
+      class << self
+        def list(options = { :client => GoodData.connection, :project => GoodData.project })
+          GoodData::Process[:all, options]
+        end
+
+        def get(options = {})
+          pid = options[:project_id]
+          fail ArgumentError, 'None or invalid project_id specified' if pid.nil? || pid.empty?
+
+          id = options[:process_id]
+          fail ArgumentError, 'None or invalid process_id' if id.nil? || id.empty?
+          c = options[:client]
+          c.with_project(pid) do |project|
+            project.processes(id)
+          end
+        end
+
+        def delete(process_id, options = { :client => GoodData.connection, :project => GoodData.project })
+          c = options[:client]
+          pid = options[:project_id]
+          process = c.with_project(pid) do |project|
+            project.processes(process_id)
+          end
+          process.delete
+        end
+
+        # TODO: check files_to_exclude param. Does it do anything? It should check that in case of using CLI, it makes sure the files are not deployed
+        def deploy(dir, options = { :client => GoodData.connection, :project => GoodData.project })
+          params = options[:params].nil? ? [] : [options[:params]]
+          c = options[:client]
+          pid = options[:project_id]
+          c.with_project(pid) do |project|
+            project.deploy_process(dir, options.merge(:files_to_exclude => params))
+          end
+        end
+
+        def execute_process(process_id, executable, options = { :client => GoodData.connection, :project => GoodData.project })
+          process = GoodData::Process[process_id, options]
+          process.execute_process(executable, options)
+        end
+
+        def run(dir, executable, options = { :client => GoodData.connection, :project => GoodData.project })
+          verbose = options[:v]
+          dir = Pathname(dir)
+          name = options[:name] || "Temporary deploy[#{dir}][#{options[:project_name]}]"
+          GoodData::Process.with_deploy(dir, options.merge(:name => name, :project_id => ProjectHelper::PROJECT_ID)) do |process|
+            puts HighLine.color('Executing', HighLine::BOLD) if verbose
+            process.execute(executable, options)
+          end
+        end
+      end
+    end
+  end
+end