hoth 0.3.4 → 0.4.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+log/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Dirk Breuer
+Copyright (c) 2009-2012 Dirk Breuer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.rdoc → README.md}

@@ -1,34 +1,34 @@
-= Hoth
+# Hoth
 
 Creating a SOA requires a centralized location to define all services within the SOA. Furthermore you want to know where those services live.
 
-= How to use
+# How to use
 
-== Install
+## Install
 
     gem install hoth
 
-== Define services and modules
+## Define services and modules
 
-=== Service-Definition
+### Service-Definition
 
 This is how you define services:
 
     Hoth::Services.define do
-  
+
       service :service_name do |first_param, second_param|
         returns :descriptive_name
       end
-        
+
     end
 
 This definition describes a service with a name, some parameters and its return value. The naming of the parameters is just for your understanding and will never be used again, so be descriptive. Same goes for the return value. The only exception is, if you want to assure that a service returns nil you can write
-  
+
     returns :nothing
-    
+
 A service whith this return value will always return nil. You can also specify `:nil`, with the same result.
 
-=== Module-Definition
+### Module-Definition
 
 After defining all you services, you need to specify in which modules they live. Each module can be seen as a set of implemented services. Each module can have one or more endpoints. Here is how you define these modules with its endpoints and services:
 
@@ -43,11 +43,6 @@ After defining all you services, you need to specify in which modules they live.
             transport :http
           end
 
-          endpoint :bert do
-            host 'localhost'
-            port 9999
-            transport :bert
-          end
         end
 
         env :production do
@@ -57,38 +52,43 @@ After defining all you services, you need to specify in which modules they live.
             transport :http
           end
 
-          endpoint :bert do
+          endpoint :beanstalk do
             host '192.168.1.15'
-            port 9999
-            transport :bert
+            port 11300
+            transport :beanstalkd
           end
         end
-    
+
         add_service :first_service
-        add_service :second_service, :via => :bert
+        add_service :second_service, :via => :beanstalk
       end
-      
+
     end
 
 
 As you can see, it is possible to define different endpoints for different environments. Each endpoint has a host, a port and a transport-type. After defining your endpoints you can add your previously defined services to the module and define which endpoint they should use. If you do not specify an endpoint the :default endpoint will be used.
 
-== Integrate in your project
+## Integrate in your project
 
 Just execute current code (in rails you can add this line to an initializer):
-    
+
     Hoth.init!
-    
+
 By default, Hoth looks for the files service_definition and module_definition in the config-Directory (`./config`). If you need to load these files from another place, just set `Hoth.config_path` to your needs.
-    
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
+
+## Todo
+
+  * Make the rack provider independent from one specific transport.
+  * Make the bodies of the `rack_provider` return an object which responds to each in order not break on Ruby 1.9.
+
+## Note on Patches/Pull Requests
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  * Send me a pull request. Bonus points for topic branches.
+
+## Copyright
 
 Copyright (c) 2009-2010 Dirk Breuer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'hoth/version'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+YARD::Rake::YardocTask.new do |t|
+  t.options += ['--title', "Hoth #{Hoth::VERSION} Documentation"]
+end

data/example/business_objects.rb

@@ -0,0 +1,60 @@
+require 'active_support'
+
+class StatisticsObject
+  attr_accessor :id, :owner_id, :statistic_type, :timestamp, :group_condition
+  
+  def initialize(attributes)
+    @id              = attributes[:id]
+    @owner_id        = attributes[:owner_id]
+    @statistic_type  = attributes[:statistic_type]
+    @timestamp       = attributes[:timestamp]
+    @group_condition = attributes[:group_condition]
+  end
+  
+  def self.json_create(hash)
+    new(hash.symbolize_keys)
+  end
+end
+
+class Event
+  attr_accessor :name, :count
+
+  def initialize(attributes)
+    @name  = attributes[:name]
+    @count = attributes[:count]
+  end
+
+  def self.json_create(hash)
+    new(hash.symbolize_keys)
+  end
+end
+
+class StatisticData
+  attr_accessor :events, :original_id
+  
+  def initialize(attributes)
+    @events      = attributes[:events]
+    @original_id = attributes[:original_id]
+  end
+
+  def self.json_create(hash)
+    new(hash.symbolize_keys)
+  end
+end
+
+class Account
+  attr_accessor :firstname, :lastname, :contract, :company
+  
+  def initialize(attributes)
+    @firstname = attributes[:firstname]
+    @lastname  = attributes[:lastname]
+    @contract  = attributes[:contract]
+    @company   = attributes[:company]
+    @contract
+  end
+  
+  def to_serialize
+    [:firstname, :lastname, :contract, :company]
+  end
+  
+end

data/example/config/module_definition.rb

@@ -0,0 +1,32 @@
+Hoth::Modules.define do
+  service_module :statistics_module do
+    env :development do
+      endpoint :default do
+        host '127.0.0.1'
+        port 443
+        transport :json_via_https
+      end
+    end
+    
+    add_service :increment_statistics
+    add_service :statistic_of_cars
+  end
+
+  service_module :accounts_module do
+    env :development do
+      endpoint :default do
+        host 'localhost'
+        port 3000
+        transport :http
+      end
+    
+      endpoint :beanstalk do
+        host 'localhost'
+        port 11300
+        transport :beanstalkd
+      end
+    end
+    
+    add_service :create_account, :via => :beanstalk
+  end
+end

data/example/config/service_definition.rb

@@ -0,0 +1,15 @@
+Hoth::Services.define do
+  
+  service :increment_statistics do |statistic_objects, event|
+    returns :nothing
+  end
+  
+  service :statistic_of_cars do |ids|
+    returns :statistic_datas
+  end
+  
+  service :create_account do |account|
+    returns :account_ids
+  end
+  
+end

data/example/rack_service_provider.ru

@@ -0,0 +1,37 @@
+$:.unshift(File.join("..", "lib"))
+
+require 'rubygems'
+
+require 'rack'
+require 'hoth'
+require 'hoth/providers/rack_provider'
+require 'business_objects'
+
+Hoth.init!
+
+class IncrementStatisticsImpl
+  def self.execute(statistic_objects, event)
+    puts "** EXECUTING IncrementStatisticsImpl"
+    puts "   statistic_objects: #{statistic_objects.inspect}"
+    puts "   events: #{event.inspect}"
+  end
+end
+
+class StatisticOfCarsImpl
+  def self.execute(ids)
+    puts "** EXECUTING StatisticOfCarsImpl"
+    puts "   ids: #{ids.inspect}"
+    
+    return ids.inject([]) do |data, id|
+      data << StatisticData.new(
+        :events       => [Event.new(:name => "viewed", :count => rand(666))],
+        :original_id => id
+      )
+    end
+  end
+end
+
+app = lambda {|env| [200, {'Content-Type' => 'application/json'}, ["body"]]}
+
+rack_thread = Thread.new { run Hoth::Providers::RackProvider.new(app) }
+rack_thread.join

data/example/service_client.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.join("..", "lib"))
+
+require 'rubygems'
+
+require 'hoth'
+require 'business_objects'
+
+Hoth.init!
+
+statistic_object = StatisticsObject.new(
+  :id              => 23,
+  :owner_id        => 42,
+  :statistic_type  => "Car",
+  :timestamp       => Time.now,
+  :group_condition => nil
+)
+
+event = Event.new(:name => "viewed", :count => 2)
+
+puts "call increment_statistics"
+Hoth::Services.increment_statistics([statistic_object], event)
+
+puts Hoth::Services.statistic_of_cars([23, 42, 303, 101]).inspect
+
+# account = Account.new(
+#   :firstname => "Dirk",
+#   :lastname  => "Breuer",
+#   :contract  => "Platinum",
+#   :company   => "Galaxy Cats"
+# )
+# 
+# puts "Account ID: #{Hoth::Services.create_account(account)}"

data/example/simple/README.md

@@ -0,0 +1,17 @@
+# Very basic and simple example of using Hoth
+
+This is a very simple example of using Hoth. It shows you how to define a module (math)
+and a service (addition) using a very basic RackProvider. It also demonstrates how Hoth 
+choose if it should invoke the service by a remote call or locally (this works by
+looking for a local implementation of the service, see `simple_client.rb`).
+
+To run this example you need to start the RackProvider first:
+
+    cd example/simple
+    rackup simple_provider.ru
+    
+Next: Run the client:
+
+    ruby simple_client.rb
+    
+Have fun!

data/example/simple/config/module_definition.rb

@@ -0,0 +1,13 @@
+Hoth::Modules.define do
+  service_module :math_module do
+    env :development do
+      endpoint :default do
+        host 'localhost'
+        port 9292
+        transport :json_via_http
+      end
+    end
+    
+    add_service :addition
+  end
+end

data/example/simple/config/service_definition.rb

@@ -0,0 +1,5 @@
+Hoth::Services.define do
+  service :addition do |a, b|
+    returns :fixnum
+  end
+end

data/example/simple/simple_client.rb

@@ -0,0 +1,27 @@
+# the client requires you to have a running provider (see simple_provider.ru)
+
+$:.unshift(File.join("..", "..", "lib"))
+
+require 'rubygems'
+
+require 'hoth'
+
+# first we initialize Hoth (this will load the configuration as well)
+Hoth.init!
+
+# let's call the "addition" service and show the result!
+puts Hoth::Services.addition(40, 2)
+# => 42
+
+# Next, we will implement addition locally...
+class AdditionImpl
+  def self.execute(a, b)
+    puts "I'm local!"
+    return a + b
+  end
+end
+
+# And call the service locally!
+puts Hoth::Services.addition(1, 2)
+# => I'm local!
+# => 3

data/example/simple/simple_provider.ru

@@ -0,0 +1,30 @@
+# to run this provider, use: rackup simple_provider.ru
+
+$:.unshift(File.join("..", "..", "lib"))
+
+require 'rubygems'
+
+require 'rack'
+require 'hoth'
+require 'hoth/providers/rack_provider'
+
+require "logger"
+
+# Initialize Hoth, load service and module definitions
+Hoth.init!
+
+# Example, how you can specify your own log provider
+Hoth::Logger.log_provider = Logger.new(STDOUT)
+Hoth::Logger.log_provider.level = Logger::WARN
+
+# To implement the service "addition", we need to provide AdditionImpl.execute
+class AdditionImpl
+  def self.execute(a, b)
+    return a + b
+  end
+end
+
+# here we go!
+app = lambda {|env| [200, {'Content-Type' => 'application/json'}, ["body"]]}
+run Hoth::Providers::RackProvider.new(app)
+