railsbros-thrift4rails 0.2.0

data/History.txt

@@ -0,0 +1,8 @@
+== 0.0.1 2009-06-22
+
+* 1 major enhancement:
+  * Initial release
+  * created ThriftClient
+  * created first rake-tasks to generate thrift definitions
+* Version 0.2.0
+  * ThriftClient catches the Thrift::ProtocolException now

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/thrift4rails.rb
+lib/thrift4rails/tasks.rb
+lib/thrift4rails/tasks/generate.rake
+lib/thrift4rails/tasks/service.rake
+lib/thrift4rails/tasks/tunnel.rake
+lib/thrift4rails/thrift_client.rb
+script/console
+script/destroy
+script/generate
+tasks/Rakefile
+tasks/thrift.rb
+test/test_helper.rb
+test/test_thrift4rails.rb
+thrift4rails.gemspec

data/PostInstall.txt

@@ -0,0 +1,3 @@
+Include 
+require 'thrift4rails/tasks/thrift'
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= thrift4rails
+
+* http://github.com/#{github_username}/#{project_name}
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/thrift4rails'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('thrift4rails', Thrift4Rails::VERSION) do |p|
+  p.developer('pkw.de Development Team', 'dev@pkw.de')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['activesupport','>= 2.3.2'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/thrift4rails.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'activesupport'
+require 'thrift4rails/thrift_client'
+
+module Thrift4Rails
+  VERSION = '0.2.0'
+end

data/lib/thrift4rails/tasks.rb

@@ -0,0 +1,21 @@
+require "activesupport"
+
+class Service
+  cattr_accessor :root_dir, :default_target, :dependencies, :dependencies_root, :port, :name, :tunnel_gateway
+end
+
+# define default values
+Service.port = 4000
+Service.dependencies = []
+Service.dependencies_root = "../"
+Service.default_target = "/app/thrift"
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each { |ext| load ext }
+
+def puts_red(out)
+  puts "\e[31m#{out}\e[0m"
+end
+
+def puts_green(out)
+  puts "\e[32m#{out}\e[0m"
+end

data/lib/thrift4rails/tasks/generate.rake

@@ -0,0 +1,54 @@
+namespace :thrift do
+  
+  desc "Show configuration of service"
+  task :config do
+    puts "Service.root_dir: #{Service.root_dir}"
+    puts "Service.dependencies: #{Service.dependencies}"
+    puts "Service.dependencies_root: #{Service.dependencies_root}"
+    puts "Service.default_target: #{Service.default_target}"
+    puts "Service.port: #{Service.port}"
+  end
+  
+  namespace :generate do
+  
+    desc "Generate all service-definitions (own and dependent)"
+    task :all do
+      Rake::Task["thrift:generate:self"].invoke
+      Rake::Task["thrift:generate:dependencies"].invoke
+    end
+
+    desc "Generate own service-definitions"
+    task :self do
+      target = ENV["TARGET"] || ".#{Service.default_target}"
+      puts "Generating self..."
+      if File.exists?(File.join(Service.root_dir, "config/service_definition.thrift"))
+        puts "  -> generating service-definitions: config/service_definition.thrift"
+        system "thrift --gen rb:rails -o #{target} #{File.join(Service.root_dir, "config/service_definition.thrift")}"
+      else
+        puts "  -> no service-definitions"
+      end
+      if File.exists?(File.join(Service.root_dir, "config/service_includes.thrift"))
+        puts "  -> generating service-includes: config/service_includes.thrift"
+        system "thrift --gen rb:rails -o #{target} #{File.join(Service.root_dir, "config/service_includes.thrift")}"
+      else
+        puts "  -> no service-includes"
+      end
+      puts "...done"
+    end
+    
+    desc "Generate all dependent service-definitions"
+    task :dependencies do
+      if Service.dependencies.blank?
+        puts "No dependencies defined"
+      else
+        puts "Generating dependencies..."
+        Service.dependencies.each do |dependency|
+          puts "  -> generating dependency: #{dependency}"
+          system "cd #{File.join(Service.dependencies_root, dependency)} && rake thrift:generate:self TARGET=#{File.join(Service.root_dir, Service.default_target)}"
+        end
+        puts "...done"
+      end
+    end
+    
+  end
+end

data/lib/thrift4rails/tasks/service.rake

@@ -0,0 +1,8 @@
+namespace :service do
+  
+  desc "Start server of service on port #{Service.port}"
+  task :start do
+    system "script/server -p #{Service.port}"
+  end
+  
+end

data/lib/thrift4rails/tasks/tunnel.rake

@@ -0,0 +1,21 @@
+namespace :tunnel do
+  desc "Establish tunnel through #{Service.tunnel_gateway} for #{Service.name}"
+  task :start do
+    system "ssh -L #{Service.port}:localhost:#{Service.port} #{Service.tunnel_gateway} -fN"
+    puts "started tunnel for #{Service.name}: ssh -L #{Service.port}:localhost:#{Service.port} #{Service.tunnel_gateway} -fN"
+  end
+  desc "Stop tunnel through #{Service.tunnel_gateway} for #{Service.name}"
+  task :stop do
+    system "ps -ef | grep \"ssh -L #{Service.port}:localhost:#{Service.port} #{Service.tunnel_gateway} -fN\" | grep -v \"grep\" | awk '{print $2}' | xargs kill -9"
+    puts "stopped tunnel for #{Service.name}: ssh -L #{Service.port}:localhost:#{Service.port} #{Service.tunnel_gateway} -fN"
+  end
+  desc "status of tunnel through #{Service.tunnel_gateway} for #{Service.name}"
+  task :status do
+    result = %x[ps -ef | grep \"ssh -L #{Service.port}:localhost:#{Service.port} #{Service.tunnel_gateway} -fN\" | grep -v \"grep\"]
+    unless result.blank?
+      puts_green "tunnel of #{Service.name} is established\n--> #{result}"
+    else
+      puts_red "tunnel of #{Service.name} not established"
+    end
+  end
+end

data/lib/thrift4rails/thrift_client.rb

@@ -0,0 +1,85 @@
+# With this Thrif-Client you can easily connect to any thrift service. You just configure the endpoint ans
+#
+# == Example
+#   ThriftClient.new(
+#     :url => "http://127.0.0.1:3001/searvice_endpoint",
+#     :client_class => Thrift::Definitione::Generated::Client,
+#     :cache_methods => { :method_to_be_cached => 1.day }
+#   )
+# 
+# == Throws
+# In case of Errno::ECONNREFUSED raises "No connection to Provider: #{@url}. (Original Error: #{e.message})"
+# In case of Errno::ETIMEDOUT raises "Connection to Provider '#{@url}' timed out. (Original Error: #{e.message})"
+module Thrift4Rails
+  class ClientException < Exception; end
+  class ThriftClient
+    attr_accessor :url, :client_class, :transport, :protocol_factory
+
+    def initialize(options = {})
+      @url           = options[:url]
+      @client_class  = options[:client_class]
+      @cache_methods = options[:cache_methods] || {}
+    end
+  
+    def protocol_factory
+      @protocol_factory || Thrift::BinaryProtocolAcceleratedFactory.new
+    end
+
+    def protocol_factory=(protocol_factory)
+      @protocol_factory = protocol_factory
+    end
+
+    def protocol
+      @protocol ||= self.protocol_factory.get_protocol(self.transport)
+    end
+
+    def client
+      @client ||= self.client_class.new(protocol)
+    end
+
+    def transport
+      @transport ||= Thrift::HTTPClientTransport.new(self.url)
+    end
+
+    def method_missing(meth, *args, &blk)
+      if client.respond_to?(meth)
+        self.class.send :define_method, meth do |*args|
+          if @cache_methods[meth] && args.blank?
+            Rails.cache.fetch("thrift_client_method_cache_#{meth}", :expire_in => @cache_methods[meth]) do
+              fetch_response(meth, *args)
+            end
+          else
+            fetch_response(meth, *args)
+          end
+        end
+        send(meth, *args, &blk)
+      else
+        super
+      end
+    end
+  
+    private
+
+      def fetch_response(meth, *args)
+        begin
+          transport.open
+          response = client.send(meth, *args)
+        rescue Thrift::ProtocolException => e
+          client_exception = ClientException.new("Either no connection to Provider(#{@url}) or an internal thrift error occured. (Original Error: #{e.message})")
+          client_exception.set_backtrace(e.backtrace)
+          raise client_exception
+        rescue Errno::ECONNREFUSED => e
+          client_exception = ClientException.new("No connection to Provider: #{@url}. (Original Error: #{e.message})")
+          client_exception.set_backtrace(e.backtrace)
+          raise client_exception
+        rescue Errno::ETIMEDOUT => e
+          client_exception = ClientException.new("Connection to Provider '#{@url}' timed out. (Original Error: #{e.message})")
+          client_exception.set_backtrace(e.backtrace)
+          raise client_exception
+        ensure
+          transport.close
+        end
+      end
+
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/thrift4rails.rb'}"
+puts "Loading thrift4rails gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/tasks/Rakefile

@@ -0,0 +1 @@
+require './thrift'

data/tasks/thrift.rb

@@ -0,0 +1,47 @@
+require "activesupport"
+
+class Service
+  cattr_accessor :root_dir, :default_target, :dependencies, :dependencies_root
+end
+
+Service.root_dir ||= File.join(File.dirname(__FILE__), "../../")
+Service.dependencies ||= []
+Service.dependencies_root ||= "../"
+Service.default_target ||= "/app/thrift"
+
+namespace :thrift do
+  
+  desc "Show configuration of service"
+  task :config do
+    puts "Service.root_dir: #{Service.root_dir}"
+    puts "Service.dependencies: #{Service.dependencies}"
+    puts "Service.dependencies_root: #{Service.dependencies_root}"
+    puts "Service.default_target: #{Service.default_target}"
+  end
+  
+  namespace :generate do
+  
+    desc "Generate all service-definitions (own and dependent)"
+    task :all do
+      Rake::Task["thrift:generate:dependencies"].invoke
+      Rake::Task["thrift:generate:self"].invoke
+    end
+
+    desc "Generate own service-definitions"
+    task :self do
+      target = ENV["TARGET"] || ".#{Service.default_target}"
+      puts "generating self: thrift --gen rb:rails -o #{target} #{File.join(Service.root_dir, "config/service_definition.thrift")}"
+      system "thrift --gen rb:rails -o #{target} #{File.join(Service.root_dir, "config/service_definition.thrift")}"
+      system "thrift --gen rb:rails -o #{target} #{File.join(Service.root_dir, "config/service_includes.thrift")}" if File.exists?(File.join(Service.root_dir, "config/service_includes.thrift"))
+    end
+    
+    desc "Generate all dependent service-definitions"
+    task :dependencies do
+      Service.dependencies.each do |dependency|
+        puts "cd #{File.join(Service.dependencies_root, dependency)} && rake thrift:generate:self TARGET=#{File.join(Service.root_dir, Service.default_target)}"
+        `cd #{File.join(Service.dependencies_root, dependency)} && rake thrift:generate:self TARGET=#{File.join(Service.root_dir, Service.default_target)}`
+      end
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/thrift4rails'

data/test/test_thrift4rails.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestThrift4Rails < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/thrift4rails.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{thrift4rails}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["pkw.de Development Team"]
+  s.date = %q{2009-07-30}
+  s.description = %q{FIX (describe your package)}
+  s.email = ["dev@pkw.de"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "lib/thrift4rails.rb", "lib/thrift4rails/tasks.rb", "lib/thrift4rails/tasks/generate.rake", "lib/thrift4rails/tasks/service.rake", "lib/thrift4rails/tasks/tunnel.rake", "lib/thrift4rails/thrift_client.rb", "script/console", "script/destroy", "script/generate", "tasks/Rakefile", "tasks/thrift.rb", "test/test_helper.rb", "test/test_thrift4rails.rb", "thrift4rails.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/#{github_username}/#{project_name}}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{thrift4rails}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{FIX (describe your package)}
+  s.test_files = ["test/test_helper.rb", "test/test_thrift4rails.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_development_dependency(%q<newgem>, [">= 1.4.1"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_dependency(%q<newgem>, [">= 1.4.1"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+    s.add_dependency(%q<newgem>, [">= 1.4.1"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: railsbros-thrift4rails
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- pkw.de Development Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: FIX (describe your package)
+email: 
+- dev@pkw.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/thrift4rails.rb
+- lib/thrift4rails/tasks.rb
+- lib/thrift4rails/tasks/generate.rake
+- lib/thrift4rails/tasks/service.rake
+- lib/thrift4rails/tasks/tunnel.rake
+- lib/thrift4rails/thrift_client.rb
+- script/console
+- script/destroy
+- script/generate
+- tasks/Rakefile
+- tasks/thrift.rb
+- test/test_helper.rb
+- test/test_thrift4rails.rb
+- thrift4rails.gemspec
+has_rdoc: true
+homepage: http://github.com/#{github_username}/#{project_name}
+licenses: 
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: thrift4rails
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: FIX (describe your package)
+test_files: 
+- test/test_helper.rb
+- test/test_thrift4rails.rb