gooddata 0.6.0.pre11 → 0.6.0

data/lib/gooddata/cli/commands/scaffold_cmd.rb

@@ -1,7 +1,9 @@
+# encoding: UTF-8
+
 require 'pp'
 
-require File.join(File.dirname(__FILE__), "../shared")
-require File.join(File.dirname(__FILE__), "../../commands/scaffold")
+require_relative '../shared'
+require_relative '../../commands/scaffold'
 
 GoodData::CLI.module_eval do
 
@@ -9,21 +11,21 @@ GoodData::CLI.module_eval do
   arg_name 'show'
   command :scaffold do |c|
 
-    c.desc "Scaffold a gooddata project blueprint"
+    c.desc 'Scaffold a gooddata project blueprint'
     c.command :project do |project|
       project.action do |global_options, options, args|
         name = args.first
-        fail "Name of the project has to be provided" if name.nil? || name.empty?
+        fail 'Name of the project has to be provided' if name.nil? || name.empty?
         GoodData::Command::Scaffold.project(name)
       end
     end
 
-    c.desc "Scaffold a gooddata ruby brick. This is a piece of code that you can run on our platform"
+    c.desc 'Scaffold a gooddata ruby brick. This is a piece of code that you can run on our platform'
     c.command :brick do |brick|
       # brick.arg_name 'name'
       brick.action do |global_options, options, args|
         name = args.first
-        fail "Name of the brick has to be provided" if name.nil? || name.empty?
+        fail 'Name of the brick has to be provided' if name.nil? || name.empty?
         GoodData::Command::Scaffold.brick(name)
       end
     end

data/lib/gooddata/cli/hooks.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'gli'
 require 'pp'
 
@@ -36,8 +38,8 @@ GoodData::CLI.module_eval do
     # Error logic here
     # return false to skip default error handling
     # binding.pry
-    pp exception.backtrace
+    # pp exception.backtrace
     pp exception
     true
   end
-end
+end

data/lib/gooddata/cli/shared.rb

@@ -1,6 +1,8 @@
+# encoding: UTF-8
+
 require 'gli'
 
-require File.join(File.dirname(__FILE__), "../version")
+require_relative '../version'
 
 include GLI::App
 

data/lib/gooddata/cli/terminal.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+require 'highline'
+
+# Define GoodData::CLI as GLI Wrapper
+module GoodData
+  module CLI
+    DEFAULT_TERMINAL = HighLine.new
+
+    class << self
+      def terminal
+        DEFAULT_TERMINAL
+      end
+    end
+  end
+end

data/lib/gooddata/client.rb

@@ -1,9 +1,11 @@
-require File.join(File.dirname(__FILE__), 'version')
-require File.join(File.dirname(__FILE__), 'connection')
-require File.join(File.dirname(__FILE__), 'helpers')
+# encoding: UTF-8
+
+require_relative 'version'
+require_relative 'connection'
+require_relative 'helpers'
 
 # fastercsv is built in Ruby 1.9
-if RUBY_VERSION < "1.9"
+if RUBY_VERSION < '1.9'
   require 'fastercsv'
 else
   require 'csv'
@@ -13,7 +15,7 @@ end
 # Initializes required dynamically loaded classes
 def init_gd_module()
   # Metadata packages, such as report.rb, require this to be loaded first
-  require File.join(File.dirname(__FILE__), '/models/metadata.rb')
+  require_relative 'models/metadata.rb'
 
   # Load models from models folder
   Dir[File.dirname(__FILE__) + '/models/*.rb'].each { |file| require file }
@@ -62,7 +64,10 @@ module GoodData
 
   # Dummy implementation of logger
   class NilLogger
-    def debug(*args) ; end
+    def debug(*args)
+      ;
+    end
+
     alias :info :debug
     alias :warn :debug
     alias :error :debug
@@ -73,6 +78,7 @@ module GoodData
     GoodData.project = project
     GoodData.project
   end
+
   alias :use :project=
 
   class << self
@@ -88,11 +94,11 @@ module GoodData
     #
     def connect(options=nil, second_options=nil, third_options={})
       if options.is_a? Hash
-        fail "You have to provide login and password" if ((options[:login].nil? || options[:login].empty?) && (options[:password].nil? || options[:password].empty?))
+        fail 'You have to provide login and password' if ((options[:login].nil? || options[:login].empty?) && (options[:password].nil? || options[:password].empty?))
         threaded[:connection] = Connection.new(options[:login], options[:password], options)
         GoodData.project = options[:project] if options[:project]
       elsif options.is_a?(String) && second_options.is_a?(String)
-        fail "You have to provide login and password" if ((options.nil? || options.empty?) && (second_options.nil? || second_options.empty?))
+        fail 'You have to provide login and password' if ((options.nil? || options.empty?) && (second_options.nil? || second_options.empty?))
         threaded[:connection] = Connection.new(options, second_options, third_options)
       end
 
@@ -126,7 +132,7 @@ module GoodData
     # @param options Options get routed to connect eventually so everything that you can use there should be possible to use here.
     #
     def connect_with_sst(token, options={})
-      create_authenticated_connection(options.merge({:cookies => {"GDCAuthSST" => token}}))
+      create_authenticated_connection(options.merge({:cookies => {'GDCAuthSST' => token}}))
     end
 
     # This method is aimed at creating an authenticated connection in case you do not hae pass/login but you have SST
@@ -146,7 +152,7 @@ module GoodData
     # @param project Project to use
     # @param bl Block to be performed
     def with_project(project, &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 a project when using with_project' if project.nil? || (project.is_a?(String) && project.empty?)
       old_project = GoodData.project
       begin
         GoodData.use(project)
@@ -162,7 +168,7 @@ module GoodData
     #
     # @see GoodData.connect
     def connection
-      threaded[:connection] || raise("Please authenticate with GoodData.connect first")
+      threaded[:connection] || raise('Please authenticate with GoodData.connect first')
     end
 
     # Sets the active project
@@ -264,12 +270,12 @@ module GoodData
     end
 
     def upload_to_user_webdav(file, options={})
-      u = URI(connection.options[:webdav_server] || GoodData.project.links["uploads"])
-      url = URI.join(u.to_s.chomp(u.path.to_s), "/uploads/")
+      u = URI(connection.options[:webdav_server] || GoodData.project.links['uploads'])
+      url = URI.join(u.to_s.chomp(u.path.to_s), '/uploads/')
       connection.upload(file, options.merge({
-        :directory    => options[:directory],
-        :staging_url  => url
-      }))
+                                              :directory => options[:directory],
+                                              :staging_url => url
+                                            }))
     end
 
     def get_project_webdav_path(file, options={})
@@ -280,9 +286,9 @@ module GoodData
     def upload_to_project_webdav(file, options={})
       url = get_project_webdav_path(file, options)
       connection.upload(file, options.merge({
-        :directory    => options[:directory],
-        :staging_url  => url
-      }))
+                                              :directory => options[:directory],
+                                              :staging_url => url
+                                            }))
     end
 
     def get_user_webdav_path(file, options={})
@@ -293,13 +299,13 @@ module GoodData
     def download_from_user_webdav(file, where, options={})
       url = get_user_webdav_path(file, options)
       connection.download(file, where, options.merge({
-        :staging_url  => url
-      }))
+                                                       :staging_url => url
+                                                     }))
     end
 
     def poll(result, key, options={})
       sleep_interval = options[:sleep_interval] || 10
-      link = result[key]["links"]["poll"]
+      link = result[key]['links']['poll']
       response = GoodData.get(link, :process => false)
       while response.code != 204
         sleep sleep_interval

data/lib/gooddata/commands/api.rb

@@ -1,34 +1,51 @@
-module GoodData::Command
-  class Api
-    class << self
-      def info
-        json = {}
-        puts "GoodData API"
-        puts "  Version: #{json['releaseName']}"
-        puts "  Released: #{json['releaseDate']}"
-        puts "  For more info see #{json['releaseNotesUri']}"
-      end
+# encoding: UTF-8
+
+require_relative '../exceptions/command_failed'
 
-      alias :index :info
+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'
+          }
 
-      def test
-        if GoodData.test_login
-          puts "Succesfully logged in as #{GoodData.profile.user}"
-        else
-          puts "Unable to log in to GoodData server!"
+          puts 'GoodData API'
+          puts "  Version: #{json['releaseName']}"
+          puts "  Released: #{json['releaseDate']}"
+          puts "  For more info see #{json['releaseNotesUri']}"
         end
-      end
 
-      def get(path)
-        raise(CommandFailed, "Specify the path you want to GET.") if path.nil?
-        result = GoodData.get path
-        result rescue puts result
-      end
+        alias_method :index, :info
 
-      def delete(path)
-        raise(CommandFailed, "Specify the path you want to DELETE.") if path.nil?
-        result = GoodData.delete path
-        result rescue puts result
+        # 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)
+          raise(GoodData::CommandFailed, 'Specify the path you want to GET.') if path.nil?
+          result = GoodData.get path
+          result rescue puts result
+        end
+
+        # Delete resource
+        # @param path Resource path
+        def delete(path)
+          raise(GoodData::CommandFailed, 'Specify the path you want to DELETE.') if path.nil?
+          result = GoodData.delete path
+          result rescue puts result
+        end
       end
     end
   end

data/lib/gooddata/commands/auth.rb

@@ -1,57 +1,31 @@
+# encoding: UTF-8
+
 require 'highline/import'
-require 'json'
+require 'multi_json'
 
-require File.join(File.dirname(__FILE__), '../helpers')
+require_relative '../cli/terminal'
+require_relative '../helpers'
 
 module GoodData::Command
   class Auth
-    
     class << self
-      def connect
-        unless defined? @connected
-          GoodData.connect({
-            :login    => user,
-            :password => password,
-            :server   => url,
-            :auth_token => auth_token
-          })
-          @connected = true
-        end
-        @connected
-      end
-
-      def user
-        ensure_credentials
-        @credentials[:username]
-      end
-
-      def password
-        ensure_credentials
-        @credentials[:password]
-      end
-
-      def url
-        ensure_credentials
-        @credentials[:url]
-      end
-
-      def auth_token
-        ensure_credentials
-        @credentials[:auth_token]
-      end
 
+      # Get path of .gooddata config
       def credentials_file
         "#{GoodData::Helpers.home_directory}/.gooddata"
       end
 
-      def ensure_credentials
-        return if defined? @credentials
-        unless @credentials = read_credentials
-          @credentials = ask_for_credentials
-        end
-        @credentials
+      # Ask for credentials
+      def ask_for_credentials
+        puts 'Enter your GoodData credentials.'
+        user = GoodData::CLI.terminal.ask('Email')
+        password = GoodData::CLI.terminal.ask('Password') { |q| q.echo = 'x' }
+        auth_token = GoodData::CLI.terminal.ask('Authorization Token')
+
+        {:username => user, :password => password, :auth_token => auth_token}
       end
 
+      # Read credentials
       def read_credentials
         if File.exists?(credentials_file) then
           config = File.read(credentials_file)
@@ -61,22 +35,16 @@ module GoodData::Command
         end
       end
 
-      def ask_for_credentials
-        puts "Enter your GoodData credentials."
-        user = HighLine.new.ask("Email")
-        password = HighLine.new.ask("Password") { |q| q.echo = "x" }
-        auth_token = HighLine.new.ask("Authorization Token")
-        { :username => user, :password => password, :auth_token => auth_token }
-      end
-
+      # Ask for credentials and store them
       def store
         credentials = ask_for_credentials
 
         ovewrite = if File.exist?(credentials_file)
-          HighLine::ask("Overwrite existing stored credentials (y/n)")
-        else
-          'y'
-        end
+                     GoodData::CLI.terminal.ask("Overwrite existing stored credentials (y/n)")
+                   else
+                     'y'
+                   end
+
         if ovewrite == 'y'
           File.open(credentials_file, 'w', 0600) do |f|
             f.puts JSON.pretty_generate(credentials)
@@ -86,6 +54,7 @@ module GoodData::Command
         end
       end
 
+      # Delete stored credentials
       def unstore
         FileUtils.rm_f(credentials_file)
       end

data/lib/gooddata/commands/base.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 module GoodData::Command
   class Base
   end

data/lib/gooddata/commands/commands.rb

@@ -1,3 +1,6 @@
+# encoding: UTF-8
+require 'pathname'
+
 base = Pathname(__FILE__).dirname.expand_path
 Dir.glob(base + '*.rb').each do |file|
   require file

data/lib/gooddata/commands/datasets.rb

@@ -1,21 +1,26 @@
+# encoding: UTF-8
+
 require 'date'
-require 'gooddata/extract'
+
+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
+      # ## Usage
       #
-      # <tt>gooddata datasets --project <projectid></tt>
-      # <tt>gooddata datasets:list --project <projectid></tt>
+      #     gooddata datasets --project <projectid>
+      #     gooddata datasets:list --project <projectid>
       #
-      # * <tt>--project</tt> - GoodData project identifier
+      # * `--project` - GoodData project identifier
       #
       def index
-        connect
+        # 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}"
@@ -28,20 +33,20 @@ module GoodData
       # The command prescans the data set, picks possible LDM types for it's
       # fields and asks user for confirmation.
       #
-      # == Usage
+      # ## Usage
       #
-      # <tt>gooddata datasets:describe --file-csv <path> --name <name> --output <output path></tt>
+      #     gooddata datasets:describe --file-csv <path> --name <name> --output <output path>
       #
-      # * <tt>--file-csv</tt> - path to the CSV file (required)
-      # * <tt>--name</tt> - name of the data set (user will be prompted unless provided)
-      # * <tt>--output</tt> - name of the output JSON file with the model description (user will be prompted unless provided)
+      # * `--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")
+        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 << JSON.pretty_generate(:title => name, :columns => columns) + "\n"
           f.flush
         end
       end
@@ -49,15 +54,16 @@ module GoodData
       # 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
+      # ## Usage
       #
-      # <tt>gooddata datasets:apply --project <projectid> <data set config></tt>
+      #     gooddata datasets:apply --project <projectid> <data set config>
       #
-      # * <tt>--project</tt> - GoodData project identifier
-      # * <tt>data set config</tt> - JSON file with the model description (possibly generated by the <tt>datasets:describe</tt> command)
+      # * `--project`- GoodData project identifier
+      # * `data set config` - JSON file with the model description (possibly generated by the <tt>datasets:describe</tt> command)
       #
       def apply
-        connect
+        # TODO: Review following connect replacement/reimplementation
+        # connect
         with_project do |project_id|
           cfg_file = args.shift rescue nil
           raise(CommandFailed, "Usage: #{$0} <dataset config>") unless cfg_file
@@ -67,18 +73,19 @@ module GoodData
         end
       end
 
-      # Load a CSV file into an existing server-side data set
+      # Loads a CSV file into an existing server-side data set
       #
-      # == Usage
+      # ## Usage
       #
-      # <tt>gooddata datasets:load --project <projectid> <file> <dataset config></tt>
+      #     gooddata datasets:load --project <projectid> <file> <dataset config><
       #
-      # * <tt>--project</tt> - GoodData project identifier
-      # * <tt>file</tt> - CSV file to load
-      # * <tt>data set config</tt> - JSON file with the model description (possibly generated by the <tt>datasets:describe</tt> command)
+      # * `--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
-        connect
+        # TODO: Review following connect replacement/reimplementation
+        # connect
         with_project do |project_id|
           file, cfg_file = args
           raise(CommandFailed, "Usage: #{$0} datasets:load <file> <dataset config>") unless cfg_file
@@ -93,13 +100,13 @@ module GoodData
       def with_project
         unless @project_id
           @project_id = extract_option('--project')
-          raise CommandFailed.new("Project not specified, use the --project switch") unless @project_id
+          raise CommandFailed.new('Project not specified, use the --project switch') unless @project_id
         end
         yield @project_id
       end
 
       def ask_for_fields
-        guesser = Guesser.new create_dataset.read
+        guesser = GoodData::Data::Guesser.new create_dataset.read
         guess = guesser.guess(1000)
         model = []
         connection_point_set = false
@@ -107,7 +114,7 @@ module GoodData
         guesser.headers.each_with_index do |header, i|
           options = guess[header].map { |t| t.to_s }
           options = options.select { |t| t != :connection_point.to_s } if connection_point_set
-          type = ask question_fmt % [ i + 1, header ], :answers => options
+          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
@@ -117,111 +124,7 @@ module GoodData
       def create_dataset
         file = extract_option('--file-csv')
         return Extract::CsvFile.new(file) if file
-        raise CommandFailed.new("Unknown data set. Please specify a data set using --file-csv option (more supported data sources to come!)")
-      end
-    end
-
-    ##
-    # 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! { |h| h.to_s } or raise "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
-          raise "%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; 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].nil?
-        [@pros, @cons].each do |hash|
-          if guess[hash] then
-            guess[hash] = [ guess[hash] ] unless guess[hash].is_a? Array
-            guess[hash].each { |type| hash_increment hash[header], type }
-          end
-        end
-        result
+        raise CommandFailed.new('Unknown data set. Please specify a data set using --file-csv option (more supported data sources to come!)')
       end
     end
   end