gooddata 1.0.0-java

data/lib/gooddata/core/core.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/core/logging.rb

@@ -0,0 +1,105 @@
+# 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 'rest-client'
+
+require_relative 'nil_logger'
+
+module GoodData
+  DEFAULT_LOG_LEVEL = Logger::INFO
+  DEFAULT_LOG_OUTPUT = STDOUT
+  DEFAULT_LOGGER_CLASS = Logger
+
+  DEFAULT_RESTLOG_LEVEL = Logger::DEBUG
+  DEFAULT_RESTLOG_OUTPUT = STDOUT
+  DEFAULT_RESTLOGGER_CLASS = Logger
+
+  class << self
+    attr_accessor :logger, :rest_logger
+    attr_writer :stats
+
+    # Turn logging on
+    #
+    # ### Example
+    #
+    #     # Turn of default logging
+    #     GoodData.logging_on
+    #
+    #     # Log only WARN and higher
+    #     GoodData.logging_on(Logger::WARN)
+    #
+    #     # Log DEBUG and above to file
+    #     GoodData.logging_on(Logger::DEBUG, 'log.txt')
+    #
+    def logging_on(level = DEFAULT_LOG_LEVEL, output = DEFAULT_LOG_OUTPUT, klass = DEFAULT_LOGGER_CLASS)
+      @logger = klass.new(output)
+      @logger.level = level
+      @logger
+    end
+
+    # Turn logging on
+    #
+    # ### Example
+    #
+    #     GoodData.logging_off
+    #
+    def logging_off
+      @logger = NilLogger.new
+    end
+
+    def logging_on?
+      !@logger.instance_of?(NilLogger)
+    end
+
+    # Turn logging on with HTTP included
+    #
+    # ### Example
+    #
+    #     GoodData.logging_http_on
+    #
+    def logging_http_on(level = DEFAULT_RESTLOG_LEVEL, output = DEFAULT_RESTLOG_OUTPUT, klass = DEFAULT_RESTLOGGER_CLASS)
+      @rest_logger = klass.new(output)
+      @rest_logger.level = level
+      @rest_logger
+    end
+
+    # Turn logging on
+    #
+    # ### Example
+    #
+    #     GoodData.logging_http_off
+    #
+    def logging_http_off
+      @rest_logger = NilLogger.new
+    end
+
+    def logging_http_on?
+      !@rest_logger.instance_of?(NilLogger)
+    end
+
+    def stats_on
+      @stats = true
+    end
+
+    def stats_on?
+      @stats
+    end
+
+    def stats_off
+      @stats = false
+    end
+
+    # Initial setup of logger
+    GoodData.logger = GoodData.logging_on
+
+    # Initial setup of rest logger
+    GoodData.rest_logger = GoodData.logging_http_on(
+      nil,
+      DEFAULT_RESTLOG_OUTPUT,
+      NilLogger
+    )
+  end
+end

data/lib/gooddata/core/nil_logger.rb

@@ -0,0 +1,32 @@
+# 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
+  # Dummy implementation of logger
+  class NilLogger
+    attr_accessor :level
+
+    def initialize(*_args)
+      @level = nil
+    end
+
+    def debug(*_args)
+    end
+
+    alias_method :info, :debug
+    alias_method :warn, :debug
+    alias_method :error, :debug
+
+    def debug?
+      false
+    end
+
+    alias_method :info?, :debug?
+    alias_method :warn?, :debug?
+    alias_method :error?, :debug?
+    alias_method :fatal?, :debug?
+  end
+end

data/lib/gooddata/core/project.rb

@@ -0,0 +1,74 @@
+# 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
+  @project = nil
+
+  class << self
+    # Sets the active project
+    #
+    # @param project A project identifier
+    #
+    # ### Examples
+    #
+    # The following calls are equivalent
+    #
+    #     # Assign project ID
+    #     GoodData.project = 'afawtv356b6usdfsdf34vt'
+    #
+    #     # Use project ID
+    #     GoodData.use 'afawtv356b6usdfsdf34vt'
+    #
+    #     # Use project URL
+    #     GoodData.use '/gdc/projects/afawtv356b6usdfsdf34vt'
+    #
+    #     # Select project using indexer on GoodData::Project class
+    #     GoodData.project = Project['afawtv356b6usdfsdf34vt']
+    # Assigns global/default GoodData project
+    def project=(project, opts = { :client => GoodData.connection })
+      if project.is_a? Project
+        @project = project
+      elsif project.nil?
+        @project = nil
+      else
+        @project = Project[project, opts]
+      end
+      @project
+    end
+
+    alias_method :use, :project=
+
+    attr_reader :project
+
+    # Returns the active project
+    #
+    # def project
+    #   threaded[:project]
+    # end
+
+    # Perform block in context of another project than currently set
+    #
+    # @param project Project to use
+    # @param bl Block to be performed
+    def with_project(project, opts = { :client => GoodData.connection }, &bl)
+      fail 'You have to specify a project when using with_project' if project.nil? || (project.is_a?(String) && project.empty?)
+      fail 'You have to specify block' unless bl
+      old_project = GoodData.project
+
+      begin
+        GoodData.use(project, opts)
+        res = bl.call(GoodData.project)
+      rescue RestClient::ResourceNotFound
+        GoodData.project = old_project
+        raise(GoodData::ProjectNotFound, 'Project was not found')
+      end
+
+      GoodData.project = old_project
+
+      res
+    end
+  end
+end

data/lib/gooddata/core/rest.rb

@@ -0,0 +1,149 @@
+# 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
+  class << self
+    # Performs a HTTP GET request.
+    #
+    # Retuns the JSON response formatted as a Hash object.
+    #
+    # @param path The HTTP path on the GoodData server (must be prefixed with a forward slash)
+    #
+    # ### Examples
+    #
+    #     GoodData.get '/gdc/projects'
+    #
+    def get(path, options = {})
+      connection.get(path, options)
+    end
+
+    # Performs a HTTP POST request.
+    #
+    # Retuns the JSON response formatted as a Hash object.
+    #
+    # @param path The HTTP path on the GoodData server (must be prefixed with a forward slash)
+    # @param data The payload data in the format of a Hash object
+    #
+    # ### Examples
+    #
+    #     client.post '/gdc/projects', { ... }
+    #
+    def post(path, data = {}, options = {})
+      connection.post path, data, options
+    end
+
+    # Performs a HTTP PUT request.
+    #
+    # Retuns the JSON response formatted as a Hash object.
+    #
+    # ### Parameters
+    #
+    # @param path The HTTP path on the GoodData server (must be prefixed with a forward slash)
+    # @param data The payload data in the format of a Hash object
+    #
+    # ### Examples
+    #
+    #     client.put '/gdc/projects', { ... }
+    #
+    def put(path, data, options = {})
+      connection.put path, data, options
+    end
+
+    # Performs a HTTP DELETE request.
+    #
+    # Retuns the JSON response formatted as a Hash object.
+    #
+    # @param path The HTTP path on the GoodData server (must be prefixed with a forward slash)
+    #
+    # ### Examples
+    #
+    #     GoodData.delete '/gdc/project/1'
+    #
+    def delete(path, options = {})
+      connection.delete path, options
+    end
+
+    # Upload to user directory
+    # @return [String]
+    def upload_to_user_webdav(file, options = {})
+      url = user_webdav_path({ :client => GoodData.client }.merge(options))
+      connection.upload(file, options.merge(staging_url: url))
+    end
+
+    # Get WebDav directory for project data
+    # @return [String]
+    def project_webdav_path(options = {})
+      options = merge_options(options)
+      project = options[:project]
+      project.project_webdav_path
+    end
+
+    # Upload to project directory
+    def upload_to_project_webdav(file, options = {})
+      options = merge_options(options)
+      url = project_webdav_path(options)
+      connection.upload(file, options.merge(:staging_url => url))
+    end
+
+    # Download from project directory
+    def download_from_project_webdav(file, where, options = {})
+      options = merge_options(options)
+      url = project_webdav_path(options)
+      connection.download(file, where, options.merge(:staging_url => url))
+    end
+
+    # Get WebDav directory for user data
+    # @return [String]
+    def user_webdav_path(options = {})
+      client = GoodData::Rest::Object.client({ :client => GoodData.client }.merge(options))
+      client.user_webdav_path
+    end
+
+    # Download from user directory
+    def download_from_user_webdav(file, where, options = {})
+      url = user_webdav_path({ :client => GoodData.client }.merge(options))
+      connection.download(file, where, options.merge(:staging_url => url))
+    end
+
+    # Generalizaton of poller. Since we have quite a variation of how async proceses are handled
+    # this is a helper that should help you with resources where the information about "Are we done"
+    # is the http code of response. By default we repeat as long as the code == 202. You can
+    # change the code if necessary. It expects the URI as an input where it can poll. It returns the
+    # value of last poll. In majority of cases these are the data that you need.
+    #
+    # @param link [String] Link for polling
+    # @param options [Hash] Options
+    # @return [Hash] Result of polling
+    def poll_on_code(link, options = {})
+      client = options[:client]
+      fail ArgumentError, 'No :client specified' if client.nil?
+      client.poll_on_code(link, options)
+    end
+
+    # Generalizaton of poller. Since we have quite a variation of how async proceses are handled
+    # this is a helper that should help you with resources where the information about "Are we done"
+    # is inside the response. It expects the URI as an input where it can poll and a block that should
+    # return either false -> 'meaning we are done' or true -> meaning sleep and repeat. It returns the
+    # value of last poll. In majority of cases these are the data that you need
+    #
+    # @param link [String] Link for polling
+    # @param options [Hash] Options
+    # @return [Hash] Result of polling
+    def poll_on_response(link, options = {}, &bl)
+      client = options[:client]
+      fail ArgumentError, 'No :client specified' if client.nil?
+      client.poll_on_response(link, options, &bl)
+    end
+
+    private
+
+    def merge_options(opts)
+      {
+        :project => GoodData.project
+      }.merge(opts)
+    end
+  end
+end

data/lib/gooddata/core/user.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_relative '../models/profile'
+
+module GoodData
+  class << self
+    # Gets currently logged user
+    #
+    # @return [GoodData::Profile] User Profile
+    def user
+      GoodData::Profile.current
+    end
+
+    alias_method :profile, :user
+  end
+end

data/lib/gooddata/data/data.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/data/guesser.rb

@@ -0,0 +1,122 @@
+# 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 '../extract'
+require_relative '../exceptions/command_failed'
+
+module GoodData
+  module Data
+    ##
+    # Utility class to guess data types of a data stream by looking at first couple of rows
+    #
+    class Guesser
+      TYPES_PRIORITY = [:connection_point, :fact, :date, :attribute]
+      attr_reader :headers
+
+      class << self
+        def sort_types(types)
+          types.sort do |x, y|
+            TYPES_PRIORITY.index(x) <=> TYPES_PRIORITY.index(y)
+          end
+        end
+      end
+
+      def initialize(reader)
+        @reader = reader
+        @headers = reader.shift.map!(&:to_s) || fail('Empty data set')
+        @pros = {}
+        @cons = {}
+        @seen = {}
+
+        @headers.map do |h|
+          @cons[h.to_s] = {}
+          @pros[h.to_s] = {}
+          @seen[h.to_s] = {}
+        end
+      end
+
+      def guess(limit)
+        count = 0
+        while (row = @reader.shift)
+          break unless row && !row.empty? && count < limit
+          fail '%i fields in row %i, %i expected' % [row.size, count + 1, @headers.size] if row.size != @headers.size
+          row.each_with_index do |value, j|
+            header = @headers[j]
+            number = check_number(header, value)
+            date = check_date(header, value)
+            store_guess header, @pros => :attribute unless number || date
+            hash_increment @seen[header], value
+          end
+          count += 1
+        end
+        # fields with unique values are connection point candidates
+        @seen.each do |header, values|
+          store_guess header, @pros => :connection_point if values.size == count
+        end
+        guess_result
+      end
+
+      private
+
+      def guess_result
+        result = {}
+        @headers.each do |header|
+          result[header] = Guesser.sort_types @pros[header].keys.select { |type| @cons[header][type].nil? }
+        end
+        result
+      end
+
+      def hash_increment(hash, key)
+        if hash[key]
+          hash[key] += 1
+        else
+          hash[key] = 1
+        end
+      end
+
+      def check_number(header, value)
+        if value.nil? || value =~ /^[\+-]?\d*(\.\d*)?$/
+          return store_guess(header, @pros => [:fact, :attribute])
+        end
+        store_guess header, @cons => :fact
+      end
+
+      def check_date(header, value)
+        return store_guess(header, @pros => [:date, :attribute, :fact]) if value.nil? || value == '0000-00-00'
+        begin
+          DateTime.parse value
+          return store_guess(header, @pros => [:date, :attribute])
+        rescue ArgumentError => e
+          raise e
+        end
+        store_guess header, @cons => :date
+      end
+
+      ##
+      # Stores a guess about given header.
+      #
+      # Returns true if the @pros key is present, false otherwise
+      #
+      # === Parameters
+      #
+      # * +header+ - A header name
+      # * +guess+ - A hash with optional @pros and @cons keys
+      #
+      def store_guess(header, guess)
+        result = guess[@pros]
+        [@pros, @cons].each do |hash|
+          if guess[hash]
+            guess[hash] = [guess[hash]] unless guess[hash].is_a? Array
+            guess[hash].each { |type| hash_increment hash[header], type }
+          end
+        end
+        result
+      end
+    end
+  end
+end