gooddata-edge 0.6.27.edge

data/lib/gooddata/cli/hooks.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'gli'
+require 'pp'
+
+require_relative '../helpers/auth_helpers'
+
+GoodData::CLI.module_eval do
+  pre do |global, _command, _options, _args|
+    require 'logger'
+    GoodData.logger = Logger.new(STDOUT) if global[:l]
+    username = global[:username]
+    password = global[:password]
+    token = global[:token]
+
+    creds = GoodData::Helpers::AuthHelper.read_credentials
+
+    username = creds[:username] if username.nil?
+    password = creds[:password] if password.nil?
+    token = creds[:auth_token] || creds[:token] if token.nil?
+
+    global[:token] = token if global[:token].nil?
+    if global[:login].nil?
+      global[:login] = username
+      global['login'] = username
+    end
+    if global[:password].nil?
+      global[:password] = password
+      global['password'] = password
+    end
+    # Pre logic here
+    # Return true to proceed; false to abort and not call the
+    # chosen command
+    # Use skips_pre before a command to skip this block
+    # on that command only
+    true
+  end
+
+  post do |_global, _command, _options, _args|
+    # Post logic here
+    # Use skips_post before a command to skip this
+    # block on that command only
+  end
+
+  on_error do |_exception|
+    # Error logic here
+    # return false to skip default error handling
+    # binding.pry
+    # pp exception.backtrace
+    # pp exception
+    true
+  end
+end

data/lib/gooddata/cli/shared.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'gli'
+
+require_relative '../version'
+require_relative '../core/core'
+require_relative '../extensions/extensions'
+require_relative '../exceptions/exceptions'
+require_relative '../helpers/auth_helpers'
+
+module GoodData
+  module CLI
+    extend GLI::App
+
+    program_desc 'GoodData Ruby gem - a wrapper over GoodData API and several useful abstractions to make your everyday usage of GoodData easier.'
+
+    version GoodData::VERSION
+
+    desc 'GoodData user name'
+    default_value nil
+    arg_name 'gooddata-login'
+    flag [:U, :username, :login]
+
+    desc 'GoodData password'
+    default_value nil
+    arg_name 'gooddata-password'
+    flag [:P, :password]
+
+    desc 'Project pid'
+    default_value nil
+    arg_name 'project-id'
+    flag [:p, :project_id]
+
+    desc 'Server'
+    default_value GoodData::Helpers::AuthHelper.read_server
+    arg_name 'server'
+    flag [:s, :server]
+
+    desc 'WEBDAV Server. Used for uploads of files'
+    default_value nil
+    arg_name 'web dav server'
+    flag [:w, :webdav_server]
+
+    desc 'Token for project creation'
+    default_value nil
+    arg_name 'token'
+    flag [:t, :token]
+
+    desc 'Verbose mode'
+    arg_name 'verbose'
+    switch [:v, :verbose]
+
+    desc 'Http logger on stdout'
+    arg_name 'logger'
+    switch [:l, :logger]
+  end
+end

data/lib/gooddata/cli/terminal.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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'
+
+# Define GoodData::CLI as GLI Wrapper
+module GoodData
+  module CLI
+    DEFAULT_TERMINAL = HighLine.new unless const_defined?(:DEFAULT_TERMINAL)
+
+    class << self
+      def terminal
+        DEFAULT_TERMINAL
+      end
+    end
+  end
+end

data/lib/gooddata/client.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'csv'
+
+require_relative 'version'
+require_relative 'connection'
+require_relative 'helpers/helpers'
+
+# # GoodData API wrapper
+#
+# A convenient Ruby wrapper around the GoodData RESTful API.
+#
+# The best documentation for the API can be found using these resources:
+#
+# * http://developer.gooddata.com/api
+# * https://secure.gooddata.com/gdc
+#
+# ## Usage
+#
+# To communicate with the API you first need a personal GoodData account.
+# [Sign up here](https://secure.gooddata.com/registration.html) if you havent already.
+#
+# Now it is just a matter of initializing the GoodData connection via the connect method:
+#
+#     GoodData.connect 'gooddata_user', 'gooddata_password'
+#
+# This GoodData object can now be utalized to retrieve your GoodData profile, the available
+# projects etc.
+#
+# ## Logging
+#
+#     GoodData.logger = Logger.new(STDOUT)
+#
+# For details about the logger options and methods, see the
+# (Logger module documentation)[http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc].
+
+require_relative 'core/core'
+
+module GoodData
+  class << self
+    RELEASE_INFO_PATH = '/gdc/releaseInfo'
+
+    # Initializes required dynamically loaded classes
+    def init_module
+      # Metadata packages, such as report.rb, require this to be loaded first
+      require_relative 'models/metadata.rb'
+
+      # Load models from models folder
+      Dir[File.dirname(__FILE__) + '/models/*.rb'].each { |file| require file }
+
+      # Load collections
+      Dir[File.dirname(__FILE__) + '/collections/*.rb'].each { |file| require file }
+    end
+
+    # Returns information about the GoodData API as a Hash (e.g. version, release time etc.)
+    def release_info
+      @release_info ||= @connection.get(RELEASE_INFO_PATH)['release']
+    end
+  end
+end
+
+# Init requires
+GoodData.init_module

data/lib/gooddata/commands/api.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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-2015 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-2015 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-2015 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-2015 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.load 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.load 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