gooddata-edge 0.6.27.edge

data/lib/gooddata/rest/object.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../mixins/data_property_reader'
+require_relative '../mixins/data_property_writer'
+
+require_relative '../mixins/content_getter'
+
+require_relative '../mixins/meta_getter'
+
+require_relative '../mixins/meta_property_reader'
+require_relative '../mixins/meta_property_writer'
+
+require_relative '../mixins/root_key_getter'
+
+module GoodData
+  module Rest
+    # Base class dealing with REST endpoints
+    #
+    # MUST Be interface for objects dealing with REST endpoints
+    # MUST provide way to work with remote REST-like API in unified manner.
+    # MUST NOT create new connections.
+    class Object
+      extend Mixin::DataPropertyReader
+      extend Mixin::DataPropertyWriter
+
+      extend Mixin::MetaPropertyReader
+      extend Mixin::MetaPropertyWriter
+
+      include Mixin::ContentGetter
+      include Mixin::RootKeyGetter
+      include Mixin::DataGetter
+      include Mixin::MetaGetter
+
+      attr_accessor :json
+      alias_method :raw_data, :json
+      alias_method :to_hash, :json
+
+      alias_method :to_json, :json
+
+      attr_writer :client
+      attr_accessor :project
+
+      def initialize(_opts = {})
+        @client = nil
+      end
+
+      def client(opts = {})
+        @client || GoodData::Rest::Object.client(opts)
+      end
+
+      def saved?
+        !uri.blank?
+      end
+
+      class << self
+        def default_client
+        end
+
+        def client(opts = { :client => GoodData.connection })
+          opts[:client] # || GoodData.client
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/rest/object_factory.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'object'
+
+module GoodData
+  module Rest
+    # Bridge between Rest::Object and Rest::Connection
+    #
+    # MUST be Responsible for creating new Rest::Object instances using proper Rest::Connection
+    # SHOULD be used for throttling, statistics, custom 'allocation strategies' ...
+    class ObjectFactory
+      attr_accessor :client
+      attr_accessor :connection
+      attr_accessor :objects
+      attr_accessor :resources
+
+      #################################
+      # Class methods
+      #################################
+      class << self
+        # Gets list of all GoodData::Rest::Object subclasses
+        #
+        # @return [Array<GoodData::Rest::Object>] Subclasses of GoodData::Rest::Object
+        def objects
+          ObjectSpace.each_object(Class).select { |klass| klass < GoodData::Rest::Object }
+        end
+
+        # Gets list of all GoodData::Rest::Resource subclasses
+        #
+        # @return [Array<GoodData::Rest::Resource>] Subclasses of GoodData::Rest::Resource
+        def resources
+          ObjectSpace.each_object(Class).select { |klass| klass < GoodData::Rest::Resource }
+        end
+      end
+
+      # Initializes instance of factory
+      #
+      # @param connection [GoodData::Rest::Connection] Connection used by factory
+      # @return [GoodData::Rest::ObjectFactory] Factory instance
+      def initialize(client)
+        fail ArgumentError 'Invalid connection passed' if client.nil?
+
+        @client = client
+
+        # Set connection used by factory
+        @connection = @client.connection
+
+        # Initialize internal factory map of GoodData::Rest::Object instances
+        @objects = ObjectFactory.objects
+
+        # Initialize internal factory map of GoodData::Rest::Resource instances
+        @resources = ObjectFactory.resources
+      end
+
+      def create(type, data = {}, opts = {})
+        res = type.new(data)
+        res.client = client
+
+        opts.each do |key, value|
+          method = "#{key}="
+          res.send(method, value) if res.respond_to?(method)
+        end
+
+        res
+      end
+
+      def find(type, opts = {})
+        type.send('find', opts, @client)
+      end
+    end
+  end
+end

data/lib/gooddata/rest/resource.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'object'
+
+require_relative '../mixins/obj_id'
+require_relative '../mixins/rest_resource'
+
+module GoodData
+  module Rest
+    # Base class for REST resources implementing (at least 'somehow') full CRUD
+    #
+    # IS responsible for wrapping full CRUD interface
+    class Resource < Object
+      include Mixin::RestResource
+      include Mixin::ObjId
+
+      # Default constructor passing all arguments to parent
+      def initialize(opts = {})
+        super(opts)
+      end
+    end
+  end
+end

data/lib/gooddata/rest/rest.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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_relative file
+end
+
+module GoodData
+  module Rest
+    class << self
+      # Print GoodData::Rest internal info
+      def info
+        # TODO: Print objects
+        # TODO: Print resources
+      end
+    end
+  end
+end

data/lib/gooddata/version.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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.
+
+# GoodData Module
+module GoodData
+  VERSION = '0.6.27.edge'
+
+  class << self
+    # Version
+    def version
+      VERSION
+    end
+
+    # Identifier of gem version
+    # @return Formatted gem version
+    def gem_version_string
+      "gooddata-gem/#{VERSION}/#{RUBY_PLATFORM}/#{RUBY_VERSION}"
+    end
+  end
+end

data/lib/templates/bricks/brick.rb.erb

@@ -0,0 +1,7 @@
+class MyBrick < GoodData::Bricks::Brick
+
+    def call(params)
+        # do something here
+    end
+
+end

data/lib/templates/bricks/main.rb.erb

@@ -0,0 +1,5 @@
+require_relative '../../gooddata/bricks/bricks'
+
+require_relative './mybrick'
+
+GoodData::Bricks::Pipeline.prepare([LoggerMiddleware, BenchMiddleware, GoodDataMiddleware, MyBrick])

data/lib/templates/project/Goodfile.erb

@@ -0,0 +1,4 @@
+{
+"model" : "./model/model.rb",
+"project_id"   : ""
+}

data/lib/templates/project/data/commits.csv

@@ -0,0 +1,4 @@
+lines_changed,committed_on,dev_id,repo_id
+1,01/01/2014,1,1
+3,01/02/2014,2,2
+5,05/02/2014,3,1

data/lib/templates/project/data/devs.csv

@@ -0,0 +1,4 @@
+dev_id,email
+1,tomas@gooddata.com
+2,petr@gooddata.com
+3,jirka@gooddata.com

data/lib/templates/project/data/repos.csv

@@ -0,0 +1,3 @@
+repo_id,name
+1,gooddata-gem
+2,gooddata-platform

data/lib/templates/project/model/model.rb.erb

@@ -0,0 +1,20 @@
+GoodData::Model::ProjectBuilder.create("Test project") do |p|
+  p.add_date_dimension("committed_on")
+
+  p.add_dataset("repos") do |d|
+      d.add_anchor("repo_id")
+      d.add_label("name", :reference => "repo_id")
+  end
+
+  p.add_dataset("devs") do |d|
+      d.add_anchor("dev_id")
+      d.add_label("email", :reference => "dev_id")
+  end
+
+  p.add_dataset("commits") do |d|
+      d.add_fact("lines_changed")
+      d.add_date("committed_on", :dataset => "committed_on")
+      d.add_reference('devs')
+      d.add_reference('repos')
+  end
+end

data/spec/bricks/bricks_spec.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'gooddata/bricks/brick'
+require 'gooddata/bricks/bricks'
+require 'gooddata/bricks/middleware/base_middleware'
+require 'pry'
+
+describe GoodData::Bricks do
+  it "Has GoodData::Bricks::Brick class" do
+    GoodData::Bricks::Brick.should_not == nil
+  end
+
+  it "should be possible to use block as an app in pipeline" do
+    p = GoodData::Bricks::Pipeline.prepare([
+      lambda { |params| puts "x" }
+    ])
+    p.call({})
+  end
+
+  describe "#load_defaults" do
+    context "when you define a middleware with default_loaded_call and give it some defaults file with prefix" do
+      class TestMiddleWare < GoodData::Bricks::Middleware
+        def initialize(options={})
+          @config = 'spec/bricks/default-config.json'
+          super(options)
+        end
+
+        def call(params)
+          params = super(params)
+          my_stuff = params['config']['my']['namespace']
+          puts "Now I have the defaults and runtime parameters merged and loaded: #{my_stuff['key']}"
+
+          # Doing something cool and puting it into params
+          params['something_cool'] = "#{my_stuff['key']} and also #{my_stuff['default_key']}"
+
+          @app.call(params)
+        end
+      end
+
+      class TestBrick
+        def call(params)
+          # doing something with params
+          puts "Brick: #{params['something_cool']}"
+          params
+        end
+      end
+
+      it "puts them into params" do
+        p = GoodData::Bricks::Pipeline.prepare([
+          TestMiddleWare,
+          TestBrick
+        ])
+
+        res = p.call({
+          'config' => {
+            'my' => {
+              'namespace' => {
+                'key' => 'redefined value',
+                'new_key' => 'new value'
+              }
+            },
+            'other_namespace' => {
+              'some_key' => 'some value'
+            }
+          }
+        })
+
+        res.should eq({
+          'config' => {
+            'my' => {
+              'namespace' => {
+                'key' => 'redefined value',
+                'new_key' => 'new value',
+                'default_key' => 'default value 2'
+              }
+            },
+            'other_namespace' => {
+              'some_key' => 'some value'
+            }
+          },
+          "something_cool" => "redefined value and also default value 2"
+        })
+      end
+    end
+  end
+
+
+  # TODO: Better test pre and post so we are sure it is executed in right order
+  it "should be possible to use instance both as middleware and app" do
+
+    class DummyMiddleware < GoodData::Bricks::Middleware
+
+      def call(params)
+        puts "pre"
+        app.call(params)
+        puts "post"
+      end
+
+    end
+
+    p = GoodData::Bricks::Pipeline.prepare([
+      DummyMiddleware.new,
+      lambda { |params| puts "x" }
+    ])
+    p.call({})
+  end
+
+end

data/spec/bricks/default-config.json

@@ -0,0 +1,8 @@
+{
+  "my": {
+    "namespace": {
+      "key": "default value",
+      "default_key": "default value 2"
+    }
+  }
+}

data/spec/data/.gooddata

@@ -0,0 +1,4 @@
+{
+    "username": "svarovsky+gem_tester@gooddata.com",
+    "password": "jindrisska"
+}

data/spec/data/blueprints/additional_dataset_module.json

@@ -0,0 +1,32 @@
+{
+  "title": "RubyGem Dev Week test",
+  "datasets": [
+    {
+      "type": "dataset",
+      "id": "dataset.sales",
+      "title": "Commits",
+      "columns": [
+        {
+          "type": "anchor",
+          "id": "attr.sales.id"
+        },
+        {
+          "type": "fact",
+          "id" : "some_sales_fact_id",
+          "title": "Sales fact Title",
+          "description": "Sales Fact description"
+        },
+        {
+          "type": "reference",
+          "id": "ref_dev_id",
+          "dataset": "dataset.devs"
+        },
+        {
+          "type": "reference",
+          "id": "ref_repo_id",
+          "dataset": "dataset.repos"
+        }
+      ]
+    }
+  ]
+}