gooddata 0.6.0.pre10 → 0.6.0.pre11

data/lib/gooddata/client.rb

@@ -1,6 +1,6 @@
-require 'gooddata/version'
-require 'gooddata/connection'
-require 'gooddata/helpers'
+require File.join(File.dirname(__FILE__), 'version')
+require File.join(File.dirname(__FILE__), 'connection')
+require File.join(File.dirname(__FILE__), 'helpers')
 
 # fastercsv is built in Ruby 1.9
 if RUBY_VERSION < "1.9"
@@ -13,7 +13,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.dirname(__FILE__) + '/models/metadata.rb'
+  require File.join(File.dirname(__FILE__), '/models/metadata.rb')
 
   # Load models from models folder
   Dir[File.dirname(__FILE__) + '/models/*.rb'].each { |file| require file }
@@ -80,24 +80,12 @@ module GoodData
 
     RELEASE_INFO_PATH = '/gdc/releaseInfo'
 
-    # Version
-    def version
-      VERSION
-    end
-
-    # Identifier of gem version
-    # @return Formatted gem version
-    def gem_version_string()
-      "gooddata-gem/#{version}"
-    end
-
     # Connect to the GoodData API
     #
     # @param options
     # @param second_options
     # @param third_options
     #
-    #    Goodd
     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?))
@@ -107,6 +95,16 @@ module GoodData
         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
+
+      return threaded[:connection]
+    end
+
+    # Disconnect (logout) if logged in
+    def disconnect
+      if threaded[:connection]
+        threaded[:connection].disconnect
+        threaded[:connection] = nil
+      end
     end
 
     # Turn logging on
@@ -175,10 +173,17 @@ module GoodData
     #
     # The following calls are equivalent
     #
-    # * GoodData.project = 'afawtv356b6usdfsdf34vt'
-    # * GoodData.use 'afawtv356b6usdfsdf34vt'
-    # * GoodData.use '/gdc/projects/afawtv356b6usdfsdf34vt'
-    # * GoodData.project = Project['afawtv356b6usdfsdf34vt']
+    #     # 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']
     #
     def project=(project)
       if project.is_a? Project
@@ -221,7 +226,7 @@ module GoodData
     #
     # ### Examples
     #
-    #   GoodData.post '/gdc/projects', { ... }
+    #     GoodData.post '/gdc/projects', { ... }
     #
     def post(path, data, options = {})
       connection.post path, data, options
@@ -238,7 +243,7 @@ module GoodData
     #
     # ### Examples
     #
-    #   GoodData.put '/gdc/projects', { ... }
+    #     GoodData.put '/gdc/projects', { ... }
     #
     def put(path, data, options = {})
       connection.put path, data, options
@@ -267,18 +272,26 @@ module GoodData
       }))
     end
 
-    def upload_to_project_webdav(file, options={})
+    def get_project_webdav_path(file, options={})
       u = URI(connection.options[:webdav_server] || GoodData.project.links["uploads"])
       url = URI.join(u.to_s.chomp(u.path.to_s), "/project-uploads/", "#{GoodData.project.pid}/")
+    end
+
+    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
       }))
     end
 
-    def download_form_user_webdav(file, where, options={})
+    def get_user_webdav_path(file, options={})
       u = URI(connection.options[:webdav_server] || GoodData.project.links["uploads"])
       url = URI.join(u.to_s.chomp(u.path.to_s), "/uploads/")
+    end
+
+    def download_from_user_webdav(file, where, options={})
+      url = get_user_webdav_path(file, options)
       connection.download(file, where, options.merge({
         :staging_url  => url
       }))

data/lib/gooddata/commands/api.rb

@@ -8,6 +8,7 @@ module GoodData::Command
         puts "  Released: #{json['releaseDate']}"
         puts "  For more info see #{json['releaseNotesUri']}"
       end
+
       alias :index :info
 
       def test

data/lib/gooddata/commands/auth.rb

@@ -1,3 +1,8 @@
+require 'highline/import'
+require 'json'
+
+require File.join(File.dirname(__FILE__), '../helpers')
+
 module GoodData::Command
   class Auth
     
@@ -58,9 +63,9 @@ module GoodData::Command
 
       def ask_for_credentials
         puts "Enter your GoodData credentials."
-        user = HighLine::ask("Email")
-        password = HighLine::ask("Password") { |q| q.echo = "x" }
-        auth_token = HighLine::ask("Authorization Token")
+        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
 
@@ -69,7 +74,6 @@ module GoodData::Command
 
         ovewrite = if File.exist?(credentials_file)
           HighLine::ask("Overwrite existing stored credentials (y/n)")
-           # { |q| q.validate = /[y,n]/ }
         else
           'y'
         end

data/lib/gooddata/commands/base.rb

@@ -1,82 +1,4 @@
-module GoodData
-  module Command
-
-    # Initializes GoodData connection with credentials loaded from
-    # ~/.gooddata. If the file doesn't exist or doesn't contain
-    # necessary information, a command line prompt will be issued
-    # using the GoodData::Command::Base#ask method
-    #
-    def self.connect
-      run_internal('auth:connect', [])
-    end
-
-    class Base
-      include GoodData::Helpers
-
-      attr_accessor :args
-
-      def initialize(args)
-        @args = args
-      end
-
-      def connect
-        @connected ||= Command.connect
-        GoodData.connection
-      end
-
-      def extract_option(options, default=true)
-        values = options.is_a?(Array) ? options : [options]
-        return unless opt_index = args.select { |a| values.include? a }.first
-        opt_position = args.index(opt_index) + 1
-        if args.size > opt_position && opt_value = args[opt_position]
-          if opt_value.include?('--')
-            opt_value = nil
-          else
-            args.delete_at(opt_position)
-          end
-        end
-        opt_value ||= default
-        args.delete(opt_index)
-        block_given? ? yield(opt_value) : opt_value
-      end
-
-      def ask(question, options = {})
-        begin
-          if options.has_key? :answers
-            answer = nil
-            options[:default] = options[:answers][0] if !options.has_key? :default
-            while !options[:answers].include?(answer)
-              answer = get_answer "#{question} (#{options[:answers].join(',')}) [#{options[:default]}]? ", options[:secret]
-              answer = options[:default] if answer == ""
-            end
-          else
-            question = "#{question} [#{options[:default]}]" if options[:default]
-            answer = get_answer "#{question}: ", options[:secret], options[:default]
-          end
-          puts if options[:secret] # extra line-break
-        rescue NoMethodError, Interrupt => e
-          system "stty echo"
-          puts e
-          exit
-        end
-
-        if block_given?
-          yield answer
-        else
-          return answer
-        end
-      end
-
-      private
-
-      def get_answer(question, secret, default = nil)
-        print question
-        system "stty -echo" if secret
-        answer = $stdin.gets.chomp
-        system "stty echo" if secret
-        answer = default if answer.empty? && default
-        answer
-      end
-    end
+module GoodData::Command
+  class Base
   end
 end

data/lib/gooddata/commands/commands.rb

@@ -1,9 +1,4 @@
-require './api'
-require './auth'
-require './base'
-require './datasets'
-require './process'
-require './profile'
-require './projects'
-require './runners'
-require './scaffold'
+base = Pathname(__FILE__).dirname.expand_path
+Dir.glob(base + '*.rb').each do |file|
+  require file
+end

data/lib/gooddata/commands/datasets.rb

@@ -3,7 +3,7 @@ require 'gooddata/extract'
 
 module GoodData
   module Command
-    class Datasets < Base
+    class Datasets
 
       # List all data sets present in the project specified by the --project option
       #

data/lib/gooddata/commands/runners.rb

@@ -1,5 +1,3 @@
-require 'bundler'
-
 module GoodData::Command
   class Runners
 
@@ -26,11 +24,12 @@ script_body = <<-script_body
         require 'bundler/setup'
 
         $SCRIPT_PARAMS = {
-          :GDC_SST => \"#{sst}\",
-          :GDC_PROJECT_ID => \"#{pid}\",
-          :GDC_PROTOCOL => \"#{scheme}\",
-          :GDC_HOSTNAME => \"#{hostname}\",
-          :GDC_LOGGER_FILE => STDOUT
+          "GDC_SST" => \"#{sst}\",
+          "GDC_PROJECT_ID" => \"#{pid}\",
+          "GDC_PROTOCOL" => \"#{scheme}\",
+          "GDC_HOSTNAME" => \"#{hostname}\",
+          "GDC_LOGGER_FILE" => STDOUT,
+          "GDC_ENV_LOCAL" => true
         }.merge(#{params})
         eval(File.read(\"./main.rb\"))
       end

data/lib/gooddata/connection.rb

@@ -1,9 +1,11 @@
 require 'json'
 require 'rest-client'
 
+require File.join(File.dirname(__FILE__), 'version')
+
 module GoodData
 
-  # = GoodData HTTP wrapper
+  # # GoodData HTTP wrapper
   #
   # Provides a convenient HTTP wrapper for talking with the GoodData API.
   #
@@ -16,12 +18,11 @@ module GoodData
   # makes sure that the session is stored between requests and that the JSON is
   # parsed both when sending and receiving.
   #
-  # == Usage
+  # ## Usage
   #
-  # Before a connection can be made to the GoodData API, you have to supply the user
-  # credentials using the set_credentials method:
+  # Before a connection can be made to the GoodData API, you have to supply the user credentials like this:
   #
-  #   Connection.new(username, password).set_credentials(username, password)
+  #   Connection.new(username, password)
   #
   # To send a HTTP request use either the get, post or delete methods documented below.
   #
@@ -34,16 +35,15 @@ module GoodData
     attr_reader(:auth_token, :url)
     attr_accessor :status, :options
 
-
     # Options:
     # * :tries - Number of retries to perform. Defaults to 1.
     # * :on - The Exception on which a retry will be performed. Defaults to Exception, which retries on any Exception.
     #
-    # Example
-    # =======
-    #   retryable(:tries => 1, :on => OpenURI::HTTPError) do
-    #     # your code here
-    #   end
+    # ### Example
+    #
+    #     retryable(:tries => 1, :on => OpenURI::HTTPError) do
+    #       # your code here
+    #     end
     #
     def retryable(options = {}, &block)
       opts = { :tries => 1, :on => Exception }.merge(options)
@@ -63,10 +63,9 @@ module GoodData
     #
     # This have to be performed before any calls to the API.
     #
-    # === Parameters
+    # @param username The GoodData account username
+    # @param password The GoodData account password
     #
-    # * +username+ - The GoodData account username
-    # * +password+ - The GoodData account password
     def initialize(username, password, options = {})
       @status     = :not_connected
       @username   = username
@@ -89,13 +88,12 @@ module GoodData
     #
     # 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)
     #
-    # * +path+ - The HTTP path on the GoodData server (must be prefixed with a forward slash)
+    # ### Examples
     #
-    # === Examples
+    #     Connection.new(username, password).get '/gdc/projects'
     #
-    #   Connection.new(username, password).get '/gdc/projects'
     def get(path, options = {})
       GoodData.logger.debug "GET #{@server}#{path}"
       ensure_connection
@@ -107,16 +105,14 @@ module GoodData
     #
     # 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
     #
-    # * +path+ - The HTTP path on the GoodData server (must be prefixed with a forward slash)
-    # * +data+ - The payload data in the format of a Hash object
+    # ### Examples
     #
-    # === Examples
+    #     Connection.new(username, password).post '/gdc/projects', { ... }
     #
-    #   Connection.new(username, password).post '/gdc/projects', { ... }
     def post(path, data, options = {})
-      
       GoodData.logger.debug("POST #{@server}#{path}, payload: #{scrub_params(data, [:password, :login, :authorizationToken])}")
       ensure_connection
       payload = data.is_a?(Hash) ? data.to_json : data
@@ -128,14 +124,13 @@ module GoodData
     #
     # 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
     #
-    # * +path+ - The HTTP path on the GoodData server (must be prefixed with a forward slash)
-    # * +data+ - The payload data in the format of a Hash object
+    # ### Examples
     #
-    # === Examples
+    #     Connection.new(username, password).put '/gdc/projects', { ... }
     #
-    #   Connection.new(username, password).put '/gdc/projects', { ... }
     def put(path, data, options = {})
       payload = data.is_a?(Hash) ? data.to_json : data
       GoodData.logger.debug "PUT #{@server}#{path}, payload: #{payload}"
@@ -148,13 +143,12 @@ module GoodData
     #
     # 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)
     #
-    # * +path+ - The HTTP path on the GoodData server (must be prefixed with a forward slash)
+    # ### Examples
     #
-    # === Examples
+    #     Connection.new(username, password).delete '/gdc/project/1'
     #
-    #   Connection.new(username, password).delete '/gdc/project/1'
     def delete(path, options = {})
       GoodData.logger.debug "DELETE #{@server}#{path}"
       ensure_connection
@@ -278,6 +272,17 @@ module GoodData
       end
     end
 
+    def connected?
+      @status == :logged_in
+    end
+
+    def disconnect
+      if connected? && GoodData.connection.user["state"]
+        GoodData.delete(GoodData.connection.user["state"])
+        @status = :not_connected
+      end
+    end
+
     private
 
     def create_server_connection(url, options)
@@ -286,7 +291,7 @@ module GoodData
         :headers => {
           :content_type => :json,
           :accept => [ :json, :zip ],
-          :user_agent => GoodData.gem_version_string,
+          :user_agent => GoodData::gem_version_string,
         }
     end
 
@@ -372,7 +377,7 @@ module GoodData
             binding.pry
           end
         end
-      end      
+      end
       new_params
     end