gd_bricks 0.0.2

data/.gitignore

@@ -0,0 +1,30 @@
+*.gem
+*.rbc
+.bundle
+.config
+<<<<<<< HEAD
+coverage
+InstalledFiles
+=======
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+>>>>>>> Initial commit
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+<<<<<<< HEAD
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+=======
+>>>>>>> Initial commit

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gooddata-bricks.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Tomas Svarovsky
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomas Svarovsky
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+bricks
+======
+
+A short POC for bricks infrastructure
+=======
+# Gooddata::Bricks
+
+Bricks is a quick POC how could reusable apps in GD infrastructure work. 
+
+## Installation
+
+There is no installation. This is a POC not a library. If you want to play do
+
+    git clone https://github.com/fluke777/bricks_usage.git 
+    bricks-usage
+    bundle install
+    ruby playground.rb
+
+## Usage
+
+Let's say we have Bricks. These are reusable pieces of code for example for syncing users or executing all reports. You want to pass bricks some parameters and also set its execution in certain context. You want to log in to GoodData, maybe other systems, maybe measure an execution, set up logging policies etc. We are introducing a concept of Middleware which is different from brick in the sense that it has knowledge not only about parameters but also about next brick or middleware. This enables it to manipulate the parameters and influence the execution of the brick. It also allows to wrap around the execution and perform tasks like measuring time. All this is only configuration the infrastructure itself does not change so it poses less risk for breaking it down.
+
+let's have a look at a simple example
+
+```ruby
+app = Pipeline.prepare([HelloWorldBrick])
+app.call({:who => "tomas"})
+```
+
+this is fine but let's say we want to introduce measuring how long execution takes
+There is a middleware called BenchMiddleware which benchmarks the app and then outputs the report
+
+```ruby
+app = Pipeline.prepare([BenchMiddleware, HelloWorldBrick])
+app.call({:who => "tomas"})
+```
+
+now imagine that you would like to create a middleware that will connect you to GD based on your gd_login and gd_password or gd_sst parameters. There is a middleware that does just this.
+
+```ruby
+app = Pipeline.prepare([BenchMiddleware, GoodDataSSTLoginMiddleware, HelloWorldBrick])
+app.call({:who => "tomas", :gd_sst => "your_sst_token_comes_here"})
+```
+
+Currently none of the middlewares is changing params but nothing keeps them from doing it. It might be useful to peek under the covers. You can easily create your own middleware. Do this
+
+```ruby
+class MyDebuggingMiddleware < Gooddata::Bricks::Middleware
+  def call(params)
+    binding.pry
+    @app.call(params)
+  end
+end
+```
+
+now you can use it.
+
+```ruby
+app = Pipeline.prepare([MyDebuggingMiddleware, HelloWorldBrick])
+app.call({:who => "tomas", :gd_sst => "your_sst_token_comes_here"})
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/gooddata-bricks.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gooddata/bricks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gd_bricks"
+  spec.version       = Gooddata::Bricks::VERSION
+  spec.authors       = ["Tomas Svarovsky"]
+  spec.email         = ["svarovsky.tomas@gmail.com"]
+  spec.description   = %q{Simple example how the brick might look like.}
+  spec.summary       = %q{This is a brief summary}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "gooddata"
+  spec.add_dependency "twitter"
+end

data/lib/gooddata/bricks.rb

@@ -0,0 +1,17 @@
+require 'pp'
+require 'json'
+require 'pry'
+require 'fileutils'
+require 'restclient'
+require 'benchmark'
+
+require 'gooddata'
+require 'logger'
+
+require "gooddata/bricks/utils"
+require "gooddata/bricks/brick"
+require "gooddata/bricks/version"
+
+
+Gem.find_files("gooddata/bricks/middleware/*.rb").each { |path| require path }
+Gem.find_files("gooddata/bricks/user/*.rb").each { |path| require path }

data/lib/gooddata/bricks/brick.rb

@@ -0,0 +1,42 @@
+module Gooddata
+  module Bricks
+
+    class Pipeline
+      def self.prepare(pipeline)
+        pipeline.reverse.reduce(nil) {|memo, app| memo.nil? ? app.new : app.new(memo)}
+      end
+    end
+
+    class Middleware
+      include Gooddata::Bricks::Utils
+
+      def initialize(app)
+        @app = app
+      end
+      
+    end
+    
+    class Brick
+
+      def log(message)
+        logger = @params[:gdc_logger]
+        logger.info(message) unless logger.nil?
+      end
+
+      def name
+        self.class
+      end
+
+      def version
+        fail "Method version should be reimplemented"
+      end
+
+      def call(params={})
+        @params = params
+        ""
+      end
+
+    end
+    
+  end
+end

data/lib/gooddata/bricks/middleware/bench_middleware.rb

@@ -0,0 +1,12 @@
+class BenchMiddleware < Gooddata::Bricks::Middleware
+
+  def call(params)
+    puts "Starting timer"
+    result = nil
+    report = Benchmark.measure { result = @app.call(params) }
+    puts "Stopping timer"
+    pp report
+    result
+  end
+
+end

data/lib/gooddata/bricks/middleware/gooddata_middleware.rb

@@ -0,0 +1,15 @@
+require 'gooddata'
+
+class GoodDataMiddleware < Gooddata::Bricks::Middleware
+
+  def call(params)
+    logger = params[:gdc_logger]
+    token_name = :gdc_sst
+    fail "SST (SuperSecureToken) not present in params" if params[token_name].nil?
+    logger.info "Connecting to GD with SST"
+    GoodData.connect_with_sst(params[token_name])
+    GoodData.logger = logger
+    @app.call(params)
+  end
+
+end

data/lib/gooddata/bricks/middleware/logger_middleware.rb

@@ -0,0 +1,12 @@
+class LoggerMiddleware < Gooddata::Bricks::Middleware
+
+  def call(params)
+    logger = params[:gdc_logger] = params[:gdc_logger_file].nil? ? Logger.new(STDOUT) : Logger.new(params[:gdc_logger_file])
+    logger.info("Pipeline starts")
+
+    returning(@app.call(params)) do |result|
+      logger.info("Pipeline ending")
+    end
+  end
+
+end

data/lib/gooddata/bricks/middleware/stdout_middleware.rb

@@ -0,0 +1,12 @@
+class STDOUTLoggingMiddleware < Gooddata::Bricks::Middleware
+
+  def call(params)
+    logger = Logger.new(STDOUT)
+    params[:logger] = logger
+    logger.info("Pipeline starting with STDOUT logger")
+    returning(@app.call(params)) do
+      logger.info("Pipeline ending")
+    end
+  end
+
+end

data/lib/gooddata/bricks/middleware/twitter_middleware.rb

@@ -0,0 +1,19 @@
+require 'twitter'
+
+class TwitterMiddleware < Gooddata::Bricks::Middleware
+
+  def call(params)
+    
+    client = Twitter::REST::Client.new do |config|
+      config.consumer_key        = params[:twitter_consumer_key]
+      config.consumer_secret     = params[:twitter_consumer_secret]
+      config.access_token        = params[:twitter_access_token]
+      config.access_token_secret = params[:twitter_access_token_secret]
+    end
+
+    returning(@app.call(params)) do |result|
+      client.update(result)
+    end
+  end
+
+end

data/lib/gooddata/bricks/utils.rb

@@ -0,0 +1,10 @@
+module Gooddata::Bricks::Utils
+
+  def returning(value, &block)
+    fail "Block was not provided" if block.nil? 
+    return_val = value
+    block.call(value)
+    return_val
+  end
+
+end

data/lib/gooddata/bricks/version.rb

@@ -0,0 +1,5 @@
+module Gooddata
+  module Bricks
+    VERSION = "0.0.2"
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: gd_bricks
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Tomas Svarovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gooddata
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple example how the brick might look like.
+email:
+- svarovsky.tomas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- gooddata-bricks.gemspec
+- lib/gooddata/bricks.rb
+- lib/gooddata/bricks/brick.rb
+- lib/gooddata/bricks/middleware/bench_middleware.rb
+- lib/gooddata/bricks/middleware/gooddata_middleware.rb
+- lib/gooddata/bricks/middleware/logger_middleware.rb
+- lib/gooddata/bricks/middleware/stdout_middleware.rb
+- lib/gooddata/bricks/middleware/twitter_middleware.rb
+- lib/gooddata/bricks/utils.rb
+- lib/gooddata/bricks/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This is a brief summary
+test_files: []