grid_rest 0.0.1

data/.document

@@ -0,0 +1,6 @@
+lib/**/*.rb
+bin/*
+rails/**/*.rb
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "activesupport", ">= 3.0.7"
+gem "rest-client"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Benjamin ter Kuile
+
+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.rdoc

@@ -0,0 +1,92 @@
+= grid_rest
+
+grid_rest is a gem that makes your rails application interact with other backends through a REST interface. It is build in a situation where one rails application was talking to 2 java backends. 
+The main development focus is JSON communication, but XML should be just as easy.
+
+== Example configurations
+These configurations should be put in <tt>config/grid_rest.yml</tt>:
+
+=== General REST interface
+  include_in:
+  - ActiveRecord::Base
+  - ApplicationController
+  extend: ActiveRecord::Base  
+  development:
+    url_prefix: '/api/1.0'
+    host: localhost
+    port: 20400
+    logging: true
+
+  production:
+    url_prefix: '/api/1.0'
+    host: localhost
+    port: 20400
+    logging: true
+
+  test:
+    url_prefix: '/api/1.0'
+    host: localhost
+    port: 20400
+    logging: true
+
+=== Multiple REST interfaces
+  include_in:
+  - ActiveRecord::Base
+  - ApplicationController
+  extend: ActiveRecord::Base  
+  development:
+    zieook_workflow:
+      url_prefix: "/api/1.0/"
+      host: localhost
+      port: 20200
+      logging: true
+    zieook_data:
+      url_prefix: "/api/1.0"
+      host: localhost
+      port: 20100
+      logging: true
+
+  production:
+    zieook_workflow:
+      url_prefix: "/api/1.0/"
+      host: localhost
+      port: 20200
+      logging: true
+    zieook_data:
+      url_prefix: "/api/1.0"
+      host: localhost
+      port: 20100
+      logging: false
+
+  test:
+    zieook_workflow:
+      url_prefix: "/api/1.0/"
+      host: localhost
+      port: 20200
+      logging: true
+    zieook_data:
+      url_prefix: "/api/1.0"
+      host: localhost
+      port: 20100
+      logging: true
+=== Other ORM
+  include_in:
+  - MyOrm::Base
+  - ApplicationController
+  extend: MyOrm::Base  
+  ....
+
+== Contributing to grid_rest
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+
+== Copyright
+
+Copyright (c) 2011 GridLine. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "grid_rest"
+  gem.homepage = "http://github.com/bterkuile/grid_rest"
+  gem.license = "MIT"
+  gem.summary = %Q{grid_rest is a gem that makes your rails application interact with other backends through a REST interface.}
+  gem.description = %Q{grid_rest is a gem that makes your rails application interact with other backends through a REST interface. It is build in a situation where one rails application was talking to 2 java backends. 
+    The main development focus is JSON communication, but XML should be just as easy}
+  gem.email = "bterkuile@gmail.com"
+  gem.authors = ["Benjamin ter Kuile"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grid_rest #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/grid_rest/railtie.rb

@@ -0,0 +1,13 @@
+module GridRest
+  class Railtie < Rails::Railtie
+    #rake_tasks do
+    #  load "tasks/tiny_mce.rake"
+    #end
+
+    initializer :grid_rest do |app|
+      app.config.after_initialize do
+        GridRest.load_config!
+      end
+    end
+  end
+end

data/lib/grid_rest.rb

@@ -0,0 +1,306 @@
+require 'rest_client'
+require 'active_support/all'
+require 'grid_rest/railtie'
+module GridRest 
+  mattr_accessor :grid_config, :log_file
+  class GridConfig < HashWithIndifferentAccess
+    # This allows for method like calling of the configuration. For example:
+    #   GridRest.grid_config.host
+    # or
+    #   GridRest.grid_config.namespaces 
+    def method_missing(m, *args)
+      return self.send('[]=', m.to_s.chop, args.first) if m.to_s.last == '=' && args.size == 1
+      return self.send('[]', m)
+    end
+  end
+  self.grid_config = GridConfig.new
+  def self.include_in(klass)
+    klass.send(:include, GridRestExtensions)
+    self.grid_config.namespaces.keys.each do |k|
+      klass.send(:class_eval, namespace_methods(k))
+    end
+  end
+
+  def self.extend_class(klass)
+    klass.send(:extend, GridRestExtensions)
+    self.grid_config.namespaces.keys.each do |k|
+      klass.send(:class_eval, "class << self; #{namespace_methods(k)}; end")
+    end
+  end
+  def self.namespace_methods(namespace)
+    expand_str = <<-END
+      def #{namespace}_get(url, rparams = {})
+        grid_rest_get(url, rparams.merge(:grid_rest_namespace => '#{namespace}'))
+      end
+      def #{namespace}_post(url, rparams = {})
+        grid_rest_post(url, rparams.merge(:grid_rest_namespace => '#{namespace}'))
+      end
+      def #{namespace}_put(url, rparams = {})
+        grid_rest_put(url, rparams.merge(:grid_rest_namespace => '#{namespace}'))
+      end
+      def #{namespace}_delete(url, rparams = {})
+        grid_rest_delete(url, rparams.merge(:grid_rest_namespace => '#{namespace}'))
+      end
+    END
+  end
+
+  # Very important method. This will set the appropriate settings for the current
+  # rails environment and appends this system to the specified classes
+  def self.load_config!
+    config_path = File.join(Rails.root, 'config', 'grid_rest.yml')
+    raise "File #{config_path} does not exist" unless File.exist?(config_path)
+    h = YAML::load_file(config_path) rescue nil
+    raise "Config file #{config_path} could not be parsed" unless h
+    raise "Config file #{config_path} needs an environment" unless h[Rails.env]
+    self.grid_config.namespaces = HashWithIndifferentAccess.new unless self.grid_config.namespaces.is_a?(Hash)
+    h[Rails.env].each do |k, v|
+      if v.is_a?(Hash)
+        self.grid_config.namespaces[k.to_sym] = HashWithIndifferentAccess.new(v)
+      else
+        self.grid_config[k.to_sym] = v
+      end
+    end
+
+    # Now extend/include in configured classes
+    for inclusion in Array.wrap(h['include_in'])
+      self.include_in inclusion.constantize
+    end
+    for extension in Array.wrap(h['extend'])
+      self.extend_class extension.constantize
+    end
+  end
+  module GridRestExtensions
+    include ActiveSupport::Benchmarkable
+    unless respond_to?(:logger)
+      def logger
+        Rails.logger
+      end
+    end
+    # This one is on the deprication list
+    def grid_rest?(rparams = {})
+      ns = rparams[:grid_rest_namespace].present? ? "grid_rest_#{rparams[:grid_rest_namespace]}" : 'grid_rest'
+      raise "APP_CONFIG not available, make sure that config/config.yml and config/initializers/load_config.rb are available" unless defined?(APP_CONFIG)
+      raise "Namespace #{ns} not available in config/config.yml" unless APP_CONFIG[ns]
+      @grid_rest_active ||= Net::HTTP.new(APP_CONFIG[ns]['host'], APP_CONFIG[ns]['port']).start rescue nil
+    end
+
+    # This will get the current namespace or nil during grid_rest_request processing
+    def current_namespace
+      @current_namespace
+    end
+
+    # Wrapper for grid_rest_log_message to write a log message in a consitant manner given the request parameters
+    def grid_rest_log(method, url, rparams = {}, emsg = "")
+      if current_namespace
+        return unless GridRest.grid_config.namespaces[current_namespace]['logging']
+      else
+        return unless GridRest.grid_config['logging']
+      end
+      grid_rest_log_message(rparams.any? ? "#{Time.now.to_s(:db)} #{method.to_s.upcase} #{url} with #{rparams.inspect} #{emsg}" : "#{Time.now.to_s(:db)} #{method.to_s.upcase} #{url} #{emsg}")
+    end
+
+    # Write msg to the log file. Should only be called from grid_rest_log unless you know what you are doing
+    def grid_rest_log_message(msg)
+      GridRest.log_file ||= File.open(File.join(Rails.root, 'log', "#{Rails.env}_grid_rest.log"), 'a+')
+      GridRest.log_file.puts msg
+      GridRest.log_file.flush unless Rails.env == 'production'
+    end
+
+    def grid_rest_request(method, relative_url, rparams = {})
+      #return DummyResponse.new # test return
+      rest_url = generate_url(relative_url, rparams) 
+      #return Error.new('unavailable', :url => rest_url) unless grid_rest?(rparams)
+      # Specify defaults per method for format
+      format = rparams.delete(:format) || {:get => :json, :post => :json, :put => :json}[method]
+      accept = get_accept_header(format)
+      @current_namespace = rparams.delete(:grid_rest_namespace) # Remove this setting from request parameters
+      begin
+        r = benchmark "Fetching #{method.to_s.upcase} #{relative_url} #{rparams.inspect}", :level => :debug do
+          case method
+            when :get then RestClient.get rest_url, :params => rparams, :accept => accept
+            when :post then
+              if rparams[:json_data]
+                RestClient.post rest_url, rparams[:json_data].is_a?(Hash) ? rparams[:json_data].to_json : rparams[:json_data], :content_type => :json, :accept => :json
+              elsif rparams[:xml_data]
+                RestClient.post rest_url, rparams[:xml_data].is_a?(Hash) ? rparams[:xml_data].to_xml : rparams[:xml_data], :content_type => :xml, :accept => :xml
+              elsif rparams[:binary]
+                RestClient.post rest_url, rparams[:binary], :content_type => 'binary/octet-stream'
+              else
+                rparams[:headers] ||= {}
+                rparams[:headers][:accept] = accept
+                rparams[:multipart] = true
+                RestClient.post rest_url, rparams
+              end
+            when :put then 
+              if rparams[:json_data]
+                RestClient.put rest_url, rparams[:json_data].is_a?(Hash) ? rparams[:json_data].to_json : rparams[:json_data], :content_type => :json, :accept => :json
+              elsif rparams[:xml_data]
+                RestClient.put rest_url, rparams[:xml_data].is_a?(Hash) ? rparams[:xml_data].to_xml : rparams[:xml_data], :content_type => :xml, :accept => :xml
+              elsif rparams[:binary]
+                RestClient.put rest_url, rparams[:binary], :content_type => 'binary/octet-stream'
+              else
+                rparams[:headers] ||= {}
+                rparams[:headers][:accept] = accept
+                rparams[:multipart] = true
+                RestClient.put rest_url, rparams
+              end
+            when :delete then
+              if rparams[:json_data]
+                RestClient.delete rest_url, rparams[:json_data].is_a?(Hash) ? rparams[:json_data].to_json : rparams[:json_data], :content_type => :json, :accept => :json
+              elsif rparams[:xml_data]
+                RestClient.delete rest_url, rparams[:xml_data].is_a?(Hash) ? rparams[:xml_data].to_xml : rparams[:xml_data], :content_type => :xml, :accept => :xml
+              elsif rparams[:binary]
+                RestClient.delete rest_url, rparams[:binary], :content_type => 'binary/octet-stream'
+              else
+                rparams[:headers] ||= {}
+                rparams[:headers][:accept] = accept
+                rparams[:multipart] = true
+                RestClient.delete rest_url, :params => rparams
+              end
+            else
+              raise "No proper method (#{method}) for a grid_rest_request call"
+            end
+          end
+        grid_rest_log method, rest_url, rparams, "response code: #{r.code}"
+        if format == :json
+          #r = benchmark("decoding response JSON", :level => :debug ){ ActiveSupport::JSON.decode(r.body) rescue r } # Slow
+          r = benchmark("decoding response JSON", :level => :debug ){ JSON.parse(r.body) rescue r }
+        end
+        # Singleton class extensions
+        def r.valid?
+          true
+        end
+      rescue RestClient::ResourceNotFound => e
+        r = Error.new('resource not found', :url => rest_url, :code => e.http_code, :method => method)
+        grid_rest_log method, rest_url, rparams, "resource not found response"
+      rescue Errno::ECONNREFUSED
+        r = Error.new('connection refused', :url => rest_url, :code => 404, :method => method)
+        grid_rest_log method, rest_url, rparams, "connection refused response"
+      rescue => e
+        r = Error.new "general", :url => rest_url, :code => e.respond_to?(:http_code) ? e.http_code : 500, :method => method
+        grid_rest_log method, rest_url, rparams, "error in request"
+      end
+      r
+    end
+
+    def generate_url(url, rparams = {})
+      host = GridRest.grid_config.namespaces[rparams[:grid_rest_namespace]].try('[]', 'host') || GridRest.grid_config['host']
+      port = GridRest.grid_config.namespaces[rparams[:grid_rest_namespace]].try('[]', 'port') || GridRest.grid_config['port'] || 80
+      url_prefix = GridRest.grid_config.namespaces[rparams[:grid_rest_namespace]].try('[]', 'url_prefix') || GridRest.grid_config['url_prefix'] || ''
+      raise "No host specified for GridRest" unless host
+      gurl = File.join( "#{host}:#{port}", url_prefix, URI.encode(url) )
+      gurl = "http://#{gurl}" unless gurl =~ /^http/
+      gurl
+    end
+
+    def grid_rest_get(url, rparams = {})
+      return grid_rest_request(:get, url, rparams)
+    end
+
+    def grid_rest_put(url, rparams = {})
+      grid_rest_request(:put, url, rparams)
+    end
+
+    def grid_rest_delete(url, rparams = {})
+      grid_rest_request(:delete, url, rparams)
+    end
+    def grid_rest_post(url, rparams={})
+      return grid_rest_request(:post, url, rparams)
+    end
+    def get_accept_header(f)
+      case f
+      when :json then :json #'application/json'
+      when :xml then :xml #'application/xml'
+      else :json #'application/json'
+      end
+    end
+  end
+
+  # Error class for a rest request. Has some nice features like
+  # internationalisation of messages, and basic methods to correspond
+  # with a normal request, but most importantly returns false on the 
+  # valid? question.
+  class Error
+    attr_reader :message, :code, :url, :request_method
+    def initialize(message = nil, rparams = {})
+      @message = I18n.t(message, :scope => [:grid_rest, :error])
+      @code = rparams.delete(:code)
+      @url = rparams.delete(:url)
+      @request_method = rparams.delete(:request_method)
+    end
+    def code
+      @code || 500
+    end
+    def to_s
+      ''
+    end
+    alias to_str to_s
+
+    def valid?
+      false
+    end
+
+    def try(*args)
+      nil
+    end
+
+    # Call this on error if the result should be an empty array, but wit the
+    # invalid metadata
+    def array
+      ErrorArray.new(self)
+    end
+  end
+
+  class ErrorArray < Array
+    attr_reader :message, :code, :url, :request_method
+    def initialize(e)
+      @message = e.message
+      @code = e.code
+      @url = e.url
+      @request_method = e.request_method
+    end
+    def to_s
+      ''
+    end
+    alias to_str to_s
+    def valid?
+      false
+    end
+    def try(*args)
+      nil
+    end
+  end
+
+  # This class can be used in testing environments. It will always be valid and behaves a 
+  # bit like a normal response when this is a json hash.
+  class DummyResponse < Hash
+    def code
+      200
+    end
+    def valid?
+      true
+    end
+  end
+end
+
+# Arrays are valid, unless defined otherwise
+class Object
+  def valid?
+    true
+  end
+  def invalid?
+    !valid?
+  end
+end
+
+class NilClass
+  def valid?
+    false
+  end
+end
+
+class FalseClass
+  def valid?
+    false
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'grid_rest'
+
+class Test::Unit::TestCase
+end

data/test/test_grid_rest.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGridRest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: grid_rest
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Benjamin ter Kuile
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-07 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 7
+        version: 3.0.7
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: activesupport
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  type: :runtime
+  name: rest-client
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  type: :development
+  name: shoulda
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+  prerelease: false
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  requirement: *id005
+  prerelease: false
+  type: :development
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  prerelease: false
+  type: :development
+  name: rcov
+description: |-
+  grid_rest is a gem that makes your rails application interact with other backends through a REST interface. It is build in a situation where one rails application was talking to 2 java backends. 
+      The main development focus is JSON communication, but XML should be just as easy
+email: bterkuile@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/grid_rest.rb
+- lib/grid_rest/railtie.rb
+- test/helper.rb
+- test/test_grid_rest.rb
+has_rdoc: true
+homepage: http://github.com/bterkuile/grid_rest
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: grid_rest is a gem that makes your rails application interact with other backends through a REST interface.
+test_files: []
+