gooddata 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 215639f8217dd917939a3b1d6174b99fb72c8b95
-  data.tar.gz: 2adebe715e73ba4391123a4c61495130d79ae409
+  metadata.gz: 54e1b70b556c4eeb491e93325a56f66847a26267
+  data.tar.gz: cd49dad5c46a4cc8750bf789f49fc4be8311730c
 SHA512:
-  metadata.gz: cc87893e984b96990174e8dbd257361e3ee86d16ffda17d199d635bc66b6070665decd5bc0ed6d64e1730185130d97b9d814f23479158864eadbbeea250ad582
-  data.tar.gz: ebcdbeca2dc7ccb94a5a36a6e718277e9bfcf40ac9bc0ae23bc8280ff402868931d941076f64e9e35631a9983df380a6ed07bbe11586e526df5c49490866f943
+  metadata.gz: 33dda151e930e04f08cfb89331d152e81991cab5a6bd45e3d7bb7a5da792787a4c55340e7259c9e59b2e40189fccb0678a99079e637e1e53e94e338b6fe63a0d
+  data.tar.gz: 23b844a8c0cab54bd9db1f4fb36150e4fd0e1cb936f524d96177ad5e1a547294c4e537d1b1c3586f0ec1fa7f6f23d07fc28adc712fc792ae519adf56b0a3553a

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # GoodData Ruby SDK Changelog
 
+## 0.6.4
+- Ability to get blueprint directly through API. This way you can work with projects that was not created using SDK
+- Added basis for GD_LINT that checks your project for typical problems
+
 ## 0.6.3
 - Able to do save_as on metadata objects (Report, Metric, Dashboard)
 - Model is now not created through build and update if it is not passing validations

data/README.md

@@ -56,3 +56,4 @@ Special thanks to Thomas Watson Steen [ <mailto:w@tson.dk> / [@wa7son](http://tw
 ## Copyright
 
 Copyright (c) 2010 - 2014 GoodData Corporation and Thomas Watson Steen. See LICENSE for details.
+

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

@@ -24,13 +24,8 @@ GoodData::CLI.module_eval do
           GoodData.connect(opts)
 
           begin
-            GoodData.with_project(project_id) do |project|
-              puts "Use 'exit' to quit the live session. Use 'q' to jump out of displaying a large output."
-              binding.pry(:quiet => true,
-                          :prompt => [proc do |target_self, nest_level, pry|
-                            'project_live_sesion: '
-                          end])
-            end
+            require 'gooddata'
+            GoodData::Command::Project.jack_in(project_id)
           rescue GoodData::ProjectNotFound
             puts "Project with id \"#{project_id}\" could not be found. Make sure that the id you provided is correct."
           end

data/lib/gooddata/client.rb

@@ -6,8 +6,6 @@ require_relative 'version'
 require_relative 'connection'
 require_relative 'helpers/helpers'
 
-FasterCSV = CSV
-
 # # GoodData API wrapper
 #
 # A convenient Ruby wrapper around the GoodData RESTful API.

data/lib/gooddata/commands/project.rb

@@ -141,6 +141,16 @@ module GoodData
             p.validate
           end
         end
+
+        def jack_in(project_id)
+          GoodData.with_project(project_id) do |project|
+            puts "Use 'exit' to quit the live session. Use 'q' to jump out of displaying a large output."
+            binding.pry(:quiet => true,
+                        :prompt => [proc do |target_self, nest_level, pry|
+                          'project_live_sesion: '
+                        end])
+          end
+        end
       end
     end
   end

data/lib/gooddata/core/rest.rb

@@ -95,9 +95,9 @@ module GoodData
       connection.download(file, where, options.merge(:staging_url => url))
     end
 
-    def poll(result, key, options = {})
+    def poll(result, key = nil, options = {}, &bl)
       sleep_interval = options[:sleep_interval] || 10
-      link = result[key]['links']['poll']
+      link = bl ? bl.call(result) : result[key]['links']['poll']
       response = GoodData.get(link, :process => false)
       while response.code != 204
         sleep sleep_interval
@@ -108,6 +108,16 @@ module GoodData
       end
     end
 
+    def poll_on_root(result, root, &bl)
+      polling_url = bl.call(result)
+      polling_result = GoodData.get(polling_url)
+      while polling_result[root]
+        sleep(3)
+        polling_result = GoodData.get(polling_url)
+      end
+      polling_result
+    end
+
     def wait_for_polling_result(polling_url)
       polling_result = GoodData.get(polling_url)
       while polling_result['wTaskStatus'] && polling_result['wTaskStatus']['status'] == 'RUNNING'

data/lib/gooddata/exceptions/attr_element_not_found.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+module GoodData
+  # Project Not Found
+  class AttributeElementNotFound < RuntimeError
+    DEFAULT_MSG = 'Attribute element "%s" was not found'
+
+    def initialize(value, msg = DEFAULT_MSG)
+      super(sprintf(DEFAULT_MSG, value))
+    end
+  end
+end

data/lib/gooddata/extensions/enumerable.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+module Enumerable
+  def mapcat(initial = [], &block)
+    reduce(initial) do |a, e|
+      block.call(e).each do |x|
+        a << x
+      end
+      a
+    end
+  end
+end

data/lib/gooddata/helpers/global_helpers.rb

@@ -60,6 +60,26 @@ module GoodData
       def humanize(str)
         ActiveSupport::Inflector.humanize(str)
       end
+
+      def underline(x)
+        '=' * x.size
+      end
+
+      # Recurscively changes the string keys of a hash to symbols.
+      #
+      # @param h [Hash] Data structure to change
+      # @return [Hash] Hash with symbolized keys
+      def symbolize_keys_deep!(h)
+        if Hash == h
+          Hash[
+            h.map do |k, v|
+              [k.respond_to?(:to_sym) ? k.to_sym : k, symbolize_keys_deep!(v)]
+            end
+          ]
+        else
+          h
+        end
+      end
     end
   end
 end

data/lib/gooddata/mixins/author.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module Author
+      # Gets Project Role Author
+      #
+      # @return [GoodData::Profile] Project Role author
+      def author
+        url = meta['author']
+        tmp = GoodData.get url
+        GoodData::Profile.new(tmp)
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/content_getter.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module ContentGetter
+      def content
+        data && data['content']
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/content_property_reader.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module ContentPropertyReader
+      def content_property_reader(*props)
+        props.each do |prop|
+          define_method prop, proc { content[prop.to_s] }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/content_property_writer.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module ContentPropertyWriter
+      def content_property_writer(*props)
+        props.each do |prop|
+          define_method "#{prop}=", proc { |val| content[prop.to_s] = val }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/contributor.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module Contributor
+      # Gets Project Role Contributor
+      #
+      # @return [GoodData::Profile] Project Role Contributor
+      def contributor
+        url = meta['contributor']
+        tmp = GoodData.get url
+        GoodData::Profile.new(tmp)
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/data_getter.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module DataGetter
+      def data
+        json[root_key]
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/data_property_reader.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module DataPropertyReader
+      def data_property_reader(*props)
+        props.each do |prop|
+          define_method prop, proc { data[prop.to_s] }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/data_property_writer.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module DataPropertyWriter
+      def data_property_writer(*props)
+        props.each do |prop|
+          define_method "#{prop}=", proc { |val| data[prop.to_s] = val }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/is_attribute.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module IsAttribute
+      # Returns true if the object is a attribute false otherwise
+      # @return [Boolean]
+      def attribute?
+        true
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/is_fact.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module IsFact
+      # Returns true if the object is a fact false otherwise
+      # @return [Boolean]
+      def fact?
+        true
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/is_label.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module IsLabel
+      # Returns true if the object is a label false otherwise
+      # @return [Boolean]
+      def label?
+        true
+      end
+
+      alias_method :display_form?, :label?
+    end
+  end
+end

data/lib/gooddata/mixins/links.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module Links
+      def links
+        data['links']
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/md_finders.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module MdFinders
+      def find_by_tag(tag)
+        self[:all].select { |r| r['tags'].split(',').include?(tag) }
+      end
+
+      def find_first_by_title(title)
+        all = self[:all]
+        item = if title.is_a?(Regexp)
+                 all.find { |r| r['title'] =~ title }
+               else
+                 all.find { |r| r['title'] == title }
+               end
+        self[item['link']] unless item.nil?
+      end
+
+      # Finds a specific type of the object by title. Returns all matches. Returns full object.
+      #
+      # @param title [String] title that has to match exactly
+      # @param title [Regexp] regular expression that has to match
+      # @return [Array<GoodData::MdObject>] Array of MdObject
+      def find_by_title(title)
+        all = self[:all]
+        items = if title.is_a?(Regexp)
+                  all.select { |r| r['title'] =~ title }
+                else
+                  all.select { |r| r['title'] == title }
+                end
+        items.map { |item| self[item['link']] unless item.nil? }
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/md_id_to_uri.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module MdIdToUri
+      IDENTIFIERS_CFG = 'instance-identifiers'
+
+      # TODO: Add test
+      def identifier_to_uri(*ids)
+        fail(NoProjectError, 'Connect to a project before searching for an object') unless GoodData.project
+        uri = GoodData.project.md[IDENTIFIERS_CFG]
+        response = GoodData.post uri, 'identifierToUri' => ids
+        if response['identifiers'].empty?
+          nil
+        else
+          identifiers = response['identifiers']
+          ids_lookup = identifiers.reduce({}) do |a, e|
+            a[e['identifier']] = e['uri']
+            a
+          end
+          uris = ids.map { |x| ids_lookup[x] }
+          uris.count == 1 ? uris.first : uris
+        end
+      end
+
+      alias_method :id_to_uri, :identifier_to_uri
+    end
+  end
+end

data/lib/gooddata/mixins/md_json.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module MdJson
+      def to_json
+        json.to_json
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/md_object_id.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module MdObjId
+      def obj_id(uri)
+        uri.split('/').last
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/md_object_indexer.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module MdObjectIndexer
+      MD_OBJ_CTG = 'obj'
+
+      # Returns either list of objects or a specific object. This method is reimplemented in subclasses to leverage specific implementation for specific type of objects. Options is used in subclasses specifically to provide shorthand for getting a full objects after getting a list of hashes from query resource
+      # @param [Object] id id can be either a number a String (as a URI). Subclasses should also be abel to deal with getting the instance of MdObject already and a :all symbol
+      # @param [Hash] options the options hash
+      # @option options [Boolean] :full if passed true the subclass can decide to pull in full objects. This is desirable from the usability POV but unfortunately has negative impact on performance so it is not the default
+      # @return [MdObject] if id is a String or number single object is returned
+      # @return [Array] if :all was provided as an id, list of objects should be returned. Note that this is implemented only in the subclasses. MdObject does not support this since API has no means to return list of all types of objects
+      def [](id, options = {})
+        project = options[:project] || GoodData.project
+
+        fail "You have to provide an \"id\" to be searched for." unless id
+        fail(NoProjectError, 'Connect to a project before searching for an object') unless project
+        return all(options) if id == :all
+        return id if id.is_a?(MdObject)
+        uri = if id.is_a?(Integer) || id =~ /^\d+$/
+                "#{project.md[MD_OBJ_CTG]}/#{id}"
+              elsif id !~ /\//
+                identifier_to_uri id
+              elsif id =~ /^\//
+                id
+              else
+                fail 'Unexpected object id format: expected numeric ID, identifier with no slashes or an URI starting with a slash'
+              end
+        new(GoodData.get uri) unless uri.nil?
+      end
+
+      alias_method :get_by_id, :[]
+    end
+  end
+end