gooddata 0.6.3 → 0.6.4

data/lib/gooddata/models/project_blueprint.rb

@@ -7,7 +7,11 @@ module GoodData
 
       def self.from_json(spec)
         if spec.is_a?(String)
-          ProjectBlueprint.new(MultiJson.load(File.read(spec), :symbolize_keys => true))
+          if File.file?(spec)
+            ProjectBlueprint.new(MultiJson.load(File.read(spec), :symbolize_keys => true))
+          else
+            ProjectBlueprint.new(MultiJson.load(spec, :symbolize_keys => true))
+          end
         else
           ProjectBlueprint.new(spec)
         end
@@ -21,7 +25,8 @@ module GoodData
       end
 
       def datasets
-        data[:datasets].map { |d| DatasetBlueprint.new(d) }
+        sets = data[:datasets] || []
+        sets.map { |d| DatasetBlueprint.new(d) }
       end
 
       def add_dataset(a_dataset, index = nil)
@@ -38,6 +43,13 @@ module GoodData
         data[:datasets].delete_at(index)
       end
 
+      # Is this a project blueprint?
+      #
+      # @return [Boolean] if it is
+      def project_blueprint?
+        true
+      end
+
       def date_dimensions
         data[:date_dimensions]
       end
@@ -53,10 +65,24 @@ module GoodData
         DatasetBlueprint.new(ds)
       end
 
+      # Constructor
+      #
+      # @param init_data [ProjectBlueprint | Hash] Blueprint or a blueprint definition. If passed a hash it is used as data for new instance. If there is a ProjectBlueprint passed it is duplicated and a new instance is created.
+      # @return [ProjectBlueprint] A new project blueprint instance
       def initialize(init_data)
-        @data = init_data
-      end
-
+        some_data = if init_data.respond_to?(:project_blueprint?) && init_data.project_blueprint?
+                      init_data.to_hash
+                    elsif init_data.respond_to?(:to_blueprint)
+                      init_data.to_blueprint.to_hash
+                    else
+                      init_data
+                    end
+        @data = some_data.deep_dup
+      end
+
+      # Validate the blueprint in particular if all references reference existing datasets and valid fields inside them.
+      #
+      # @return [Array] array of errors
       def validate_references
         if datasets.count == 1
           []
@@ -71,21 +97,20 @@ module GoodData
         end
       end
 
-      def validate_labels_references
-        datasets.reduce([]) { |a, e| a.concat(e.validate_label_references) }
-      end
-
-      def validate_model
+      # Validate the blueprint and all its datasets return array of errors that are found.
+      #
+      # @return [Array] array of errors
+      def validate
         refs_errors = validate_references
-        labels_errors = validate_labels_references
+        labels_errors = datasets.reduce([]) { |a, e| a.concat(e.validate) }
         refs_errors.concat(labels_errors)
       end
 
-      def model_valid?
-        refs_errors = validate_references
-        labels_errors = validate_labels_references
-        errors = refs_errors.concat(labels_errors)
-        errors.empty? ? true : false
+      # Validate the blueprint and all its datasets and return true if model is valid. False otherwise.
+      #
+      # @return [Boolean] is model valid?
+      def valid?
+        validate.empty?
       end
 
       def referenced_by(dataset)
@@ -185,8 +210,7 @@ module GoodData
       end
 
       def dup
-        deep_copy = Marshal.load(Marshal.dump(data))
-        ProjectBlueprint.new(deep_copy)
+        ProjectBlueprint.new(data.deep_dup)
       end
 
       def title

data/lib/gooddata/models/project_creator.rb

@@ -11,7 +11,10 @@ module GoodData
       class << self
         def migrate(options = {})
           spec = options[:spec] || fail('You need to provide spec for migration')
-          spec = spec.to_hash
+          bp = ProjectBlueprint.new(spec)
+          spec = bp.to_hash
+
+          fail GoodData::ValidationError, "Blueprint is invalid #{bp.validate.inspect}" unless bp.valid?
 
           token = options[:token]
           project = options[:project] || GoodData::Project.create(:title => spec[:title], :auth_token => token)

data/lib/gooddata/models/project_role.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require_relative 'account_settings'
+require_relative 'profile'
 
 module GoodData
   class ProjectRole
@@ -17,20 +17,20 @@ module GoodData
 
     # Gets Project Role Author
     #
-    # @return [GoodData::AccountSettings] Project Role author
+    # @return [GoodData::Profile] Project Role author
     def author
       url = @json['projectRole']['meta']['author']
       tmp = GoodData.get url
-      GoodData::AccountSettings.new(tmp)
+      GoodData::Profile.new(tmp)
     end
 
     # Gets Project Role Contributor
     #
-    # @return [GoodData::AccountSettings] Project Role Contributor
+    # @return [GoodData::Profile] Project Role Contributor
     def contributor
       url = @json['projectRole']['meta']['contributor']
       tmp = GoodData.get url
-      GoodData::AccountSettings.new(tmp)
+      GoodData::Profile.new(tmp)
     end
 
     # Gets DateTime time when created
@@ -70,14 +70,14 @@ module GoodData
 
     # Gets Users with this Role
     #
-    # @return [Array<GoodData::AccountSettings>] List of users
+    # @return [Array<GoodData::Profile>] List of users
     def users
       res = []
       url = @json['projectRole']['links']['roleUsers']
       tmp = GoodData.get url
       tmp['associatedUsers']['users'].each do |user_url|
         user = GoodData.get user_url
-        res << GoodData::AccountSettings.new(user)
+        res << GoodData::Profile.new(user)
       end
       res
     end

data/lib/gooddata/models/schedule.rb

@@ -48,6 +48,7 @@ module GoodData
           },
           :hidden_params => {}
         }
+        default_opts.merge!(:reschedule => options[:reschedule])
 
         inject_schema = {
           :hidden_params => 'hiddenParams'
@@ -183,6 +184,21 @@ module GoodData
       @dirty = true
     end
 
+    # Returns reschedule settings
+    #
+    # @return [Integer] Reschedule settings
+    def reschedule
+      @json['schedule']['reschedule']
+    end
+
+    # Assigns execution reschedule settings
+    #
+    # @param new_reschedule [Integer] Reschedule settings to be set
+    def reschedule=(new_reschedule)
+      @json['schedule']['reschedule'] = new_reschedule
+      @dirty = true
+    end
+
     # Returns execution process ID
     #
     # @return [String] Process ID
@@ -265,8 +281,8 @@ module GoodData
             'hiddenParams' => @json['schedule']['hiddenParams']
           }
         }
+        update_json['schedule'].merge!('reschedule' => @json['schedule']['reschedule'])
         res = GoodData.put uri, update_json
-
         @json = res
         @dirty = false
         return true

data/lib/gooddata/models/schema_blueprint.rb

@@ -120,8 +120,7 @@ module GoodData
       end
 
       def dup
-        deep_copy = Marshal.load(Marshal.dump(data))
-        DatasetBlueprint.new(deep_copy)
+        DatasetBlueprint.new(data.deep_dup)
       end
 
       def to_wire_model
@@ -148,6 +147,24 @@ module GoodData
         end
       end
 
+      # Validate the blueprint return array of errors that are found.
+      #
+      # @return [Array] array of errors
+      def validate
+        more_than_one_anchor = find_column_by_type(:anchor, :all).count > 1 ? [{ :anchor => 2 }] : []
+        validate_label_references.concat(more_than_one_anchor)
+      end
+
+      # Validate the blueprint and return true if model is valid. False otherwise.
+      #
+      # @return [Boolean] is model valid?
+      def valid?
+        validate.empty?
+      end
+
+      # Validate the that any labels are pointing to the existing attribute. If not returns the list of errors. Currently just violating labels.
+      #
+      # @return [Array] array of errors
       def validate_label_references
         labels.select do |label|
           find_column_by_name(label[:reference]).empty?

data/lib/gooddata/version.rb

@@ -2,7 +2,7 @@
 
 # GoodData Module
 module GoodData
-  VERSION = '0.6.3'
+  VERSION = '0.6.4'
 
   class << self
     # Version

data/spec/data/users.csv

@@ -0,0 +1,12 @@
+First Name,Last Name,Email,Password,MUF,MUF ID,Role,Role ID,Project ID,Domain
+Gem,Tester,svarovsky+gem_tester@gooddata.com,jindrisska,Edit,,adminRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User0,test.user.110@example.com,password0,Full,,adminRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User1,test.user.111@example.com,password1,Full,,connectorsSystemRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User2,test.user.112@example.com,password2,Full,,editorRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User3,test.user.113@example.com,password3,Full,,dashboardOnlyRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User4,test.user.114@example.com,password4,Full,,unverifiedAdminRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User5,test.user.115@example.com,password5,Full,,readOnlyUserRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User6,test.user.116@example.com,password6,Full,,adminRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User7,test.user.117@example.com,password7,Full,,connectorsSystemRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User8,test.user.118@example.com,password8,Full,,editorRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky
+Test,User9,test.user.119@example.com,password9,Full,,dashboardOnlyRole,5,wgqhml3se0035s8n5byqdq0j0ob5jam4,gooddata-tomas-svarovsky

data/spec/helpers/connection_helper.rb

@@ -6,6 +6,7 @@ module ConnectionHelper
   DEFAULT_USERNAME = "svarovsky+gem_tester@gooddata.com"
   DEFAULT_PASSWORD = "jindrisska"
   DEFAULT_DOMAIN = 'gooddata-tomas-svarovsky'
+  DEFAULT_USER_URL = '/gdc/account/profile/3cea1102d5584813506352a2a2a00d95'
 
   # Creates connection using default credentials or supplied one
   #

data/spec/helpers/csv_helper.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+# Global requires
+require 'multi_json'
+
+# Local requires
+require 'gooddata/models/models'
+
+module CsvHelper
+  CSV_PATH_EXPORT = 'out.txt'
+  CSV_PATH_IMPORT = File.join(File.dirname(__FILE__), '..', 'data', 'users.csv')
+end

data/spec/helpers/project_helper.rb

@@ -7,7 +7,7 @@ require 'multi_json'
 require 'gooddata/models/models'
 
 module ProjectHelper
-  PROJECT_ID = 'wgqhml3se0035s8n5byqdq0j0ob5jam4'
+  PROJECT_ID = 'we1vvh4il93r0927r809i3agif50d7iz'
   PROJECT_URL = "/gdc/projects/#{PROJECT_ID}"
 
   def self.get_default_project

data/spec/integration/full_project_spec.rb

@@ -1,8 +1,9 @@
 require 'gooddata'
 
-describe "Ful project implementation", :constraint => 'slow' do
+describe "Full project implementation", :constraint => 'slow' do
   before(:all) do
     @spec = JSON.parse(File.read("./spec/data/test_project_model_spec.json"), :symbolize_names => true)
+    @invalid_spec = JSON.parse(File.read("./spec/data/blueprint_invalid.json"), :symbolize_names => true)
     ConnectionHelper::create_default_connection
     @project = GoodData::Model::ProjectCreator.migrate({:spec => @spec, :token => ConnectionHelper::GD_PROJECT_TOKEN})
   end
@@ -11,6 +12,12 @@ describe "Ful project implementation", :constraint => 'slow' do
     @project.delete unless @project.nil?
   end
 
+  it "should not build an invalid model" do
+    expect {
+      GoodData::Model::ProjectCreator.migrate({:spec => @invalid_spec, :token => ConnectionHelper::GD_PROJECT_TOKEN})
+    }.to raise_error(GoodData::ValidationError)
+  end
+
   it "should contain datasets" do
     GoodData.with_project(@project) do |p|
       p.datasets.count.should == 4
@@ -79,10 +86,62 @@ describe "Ful project implementation", :constraint => 'slow' do
     end
   end
 
+  it "should throw an exception if trying to access object without explicitely specifying a project" do
+    expect do
+      GoodData::Metric[:all]
+    end.to raise_exception(GoodData::NoProjectError)
+  end
+
+  it "should be possible to get all metrics" do
+    GoodData.with_project(@project) do |p|
+      metrics1 = GoodData::Metric[:all]
+      metrics2 = GoodData::Metric.all
+      metrics1.should == metrics2
+    end
+  end
+
+  it "should be possible to get all metrics with full objects" do
+    GoodData.with_project(@project) do |p|
+      metrics1 = GoodData::Metric[:all, :full => true]
+      metrics2 = GoodData::Metric.all :full => true
+      metrics1.should == metrics2
+    end
+  end
+
+  it "should be able to get a metric by identifier" do
+    GoodData.with_project(@project) do |p|
+      metrics = GoodData::Metric.all :full => true
+      metric = GoodData::Metric[metrics.first.identifier]
+      metric.identifier == metrics.first.identifier
+      metrics.first == metric
+    end
+  end
+
+  it "should be able to get a metric by uri" do
+    GoodData.with_project(@project) do |p|
+      metrics = GoodData::Metric.all :full => true
+      metric = GoodData::Metric[metrics.first.uri]
+      metric.uri == metrics.first.uri
+      metrics.first == metric
+    end
+  end
+
+  it "should be able to get a metric by object id" do
+    GoodData.with_project(@project) do |p|
+      metrics = GoodData::Metric.all :full => true
+      metric = GoodData::Metric[metrics.first.obj_id]
+      metric.obj_id == metrics.first.obj_id
+      metrics.first == metric
+    end
+  end
+
   it "should exercise the object relations and getting them in various ways" do
     GoodData.with_project(@project) do |p|
+
       # Find a metric by name
       metric = GoodData::Metric.find_first_by_title('My metric')
+      the_same_metric = GoodData::Metric[metric]
+      metric.should == metric
 
       # grab fact in several different ways
       fact1 = GoodData::Fact.find_first_by_title('Lines changed')
@@ -148,6 +207,11 @@ describe "Ful project implementation", :constraint => 'slow' do
 
       res = GoodData::Metric.execute("SELECT SUM(![fact.commits.lines_changed])", :extended_notation => true)
       res.should == 9
+
+      fact = GoodData::Fact.find_first_by_title('Lines changed')
+      fact.fact?.should == true
+      res = fact.create_metric(:type => :sum).execute
+      res.should == 9
     end
   end
 
@@ -163,7 +227,9 @@ describe "Ful project implementation", :constraint => 'slow' do
 
   it "should have more users"  do
     GoodData.with_project(@project) do |p|
-      GoodData::Attribute['attr.devs.dev_id'].create_metric.execute.should == 4
+      attribute = GoodData::Attribute['attr.devs.dev_id']
+      attribute.attribute?.should == true
+      attribute.create_metric.execute.should == 4
     end
   end
 
@@ -188,6 +254,14 @@ describe "Ful project implementation", :constraint => 'slow' do
     end
   end
 
+  it "Should be able to compute count o different datasets" do
+    GoodData.with_project(@project) do |p|
+      attribute = GoodData::Attribute['attr.devs.dev_id']
+      dataset_attribute = GoodData::Attribute['attr.commits.id']
+      attribute.create_metric(:attribute => dataset_attribute).execute.should == 3
+    end
+  end
+
   it "should be able to tell you if a value is contained in a metric" do
     GoodData.with_project(@project) do |p|
       attribute = GoodData::Attribute['attr.devs.dev_id']
@@ -213,10 +287,69 @@ describe "Ful project implementation", :constraint => 'slow' do
     end
   end
 
-  it "should be able to lookup the attributes by regexp and return a collectio" do
+  it "should be able to lookup the attributes by regexp and return a collection" do
     GoodData.with_project(@project) do |p|
       attrs = GoodData::Attribute.find_by_title(/Date/i)
       attrs.count.should == 1
     end
   end
+
+  it "should be able to give you values of the label as an array of hashes" do
+    GoodData.with_project(@project) do |p|
+      attribute = GoodData::Attribute['attr.devs.dev_id']
+      label = attribute.primary_label
+      label.values.map {|v| v[:value]}.should == [
+        'jirka@gooddata.com',
+        'josh@gooddata.com',
+        'petr@gooddata.com',
+        'tomas@gooddata.com'
+      ]
+    end
+  end
+
+  it "should be able to give you values for" do
+    GoodData.with_project(@project) do |p|
+      attribute = GoodData::Attribute['attr.devs.dev_id']
+      attribute.values_for(2).should == ["tomas@gooddata.com", "1"]
+    end
+  end
+
+  it "should be able to find specific element and give you the primary label value" do
+    GoodData.with_project(@project) do |p|
+      attribute = GoodData::Attribute['attr.devs.dev_id']
+      GoodData::Attribute.find_element_value("#{attribute.uri}/elements?id=2").should == 'tomas@gooddata.com'
+    end
+  end
+
+  it "should be able to give you label by name" do
+    GoodData.with_project(@project) do |p|
+      attribute = GoodData::Attribute['attr.devs.dev_id']
+      label = attribute.label_by_name('email')
+      label.label?.should == true
+      label.title.should == 'Email'
+      label.identifier.should == "label.devs.dev_id.email"
+      label.attribute_uri.should == attribute.uri
+      label.attribute.should == attribute
+    end
+  end
+
+  it "should be able to return values of the attribute for inspection" do
+    GoodData.with_project(@project) do |p|
+      attribute = GoodData::Attribute['attr.devs.dev_id']
+      vals = attribute.values
+      vals.count.should == 4
+      vals.first.count.should == 2
+      vals.first.first[:value].should == "jirka@gooddata.com"
+    end
+  end
+
+  it "should be able to save_as a metric" do
+    GoodData.with_project(@project) do |p|
+      m = GoodData::Metric.find_first_by_title("My test metric")
+      cloned = m.save_as
+      m_cloned = GoodData::Metric.find_first_by_title("Clone of My test metric")
+      m_cloned.should == cloned
+      m_cloned.execute.should == cloned.execute
+    end
+  end
 end