grid_rest 0.0.1 → 0.0.2

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+= CHANGELOG
+
+== 2011-06-08 v0.0.2
+* Initialization fixes
+* Setting default parameters 
+
+== 2011-06-07 v0.0.1
+* Initial release

data/README.rdoc

@@ -9,7 +9,7 @@ These configurations should be put in <tt>config/grid_rest.yml</tt>:
 === General REST interface
   include_in:
   - ActiveRecord::Base
-  - ApplicationController
+  - ActionController::Base
   extend: ActiveRecord::Base  
   development:
     url_prefix: '/api/1.0'
@@ -32,7 +32,7 @@ These configurations should be put in <tt>config/grid_rest.yml</tt>:
 === Multiple REST interfaces
   include_in:
   - ActiveRecord::Base
-  - ApplicationController
+  - ActionController::Base
   extend: ActiveRecord::Base  
   development:
     zieook_workflow:
@@ -72,7 +72,7 @@ These configurations should be put in <tt>config/grid_rest.yml</tt>:
 === Other ORM
   include_in:
   - MyOrm::Base
-  - ApplicationController
+  - ActionController::Base
   extend: MyOrm::Base  
   ....
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/grid_rest.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{grid_rest}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Benjamin ter Kuile"]
+  s.date = %q{2011-06-08}
+  s.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}
+  s.email = %q{bterkuile@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "CHANGELOG.rdoc",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "grid_rest.gemspec",
+    "lib/grid_rest.rb",
+    "lib/grid_rest/engine.rb",
+    "test/helper.rb",
+    "test/test_grid_rest.rb"
+  ]
+  s.homepage = %q{http://github.com/bterkuile/grid_rest}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{grid_rest is a gem that makes your rails application interact with other backends through a REST interface.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.7"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.7"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.7"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/grid_rest.rb

@@ -1,8 +1,9 @@
 require 'rest_client'
 require 'active_support/all'
-require 'grid_rest/railtie'
+require 'grid_rest/engine'
 module GridRest 
-  mattr_accessor :grid_config, :log_file
+  mattr_accessor :grid_config, :log_file, :additional_parameters
+  self.additional_parameters = { :default => {:global => {}, :get => {}, :post => {}, :put => {}, :delete => {}} }
   class GridConfig < HashWithIndifferentAccess
     # This allows for method like calling of the configuration. For example:
     #   GridRest.grid_config.host
@@ -14,6 +15,7 @@ module GridRest
     end
   end
   self.grid_config = GridConfig.new
+
   def self.include_in(klass)
     klass.send(:include, GridRestExtensions)
     self.grid_config.namespaces.keys.each do |k|
@@ -41,6 +43,10 @@ module GridRest
       def #{namespace}_delete(url, rparams = {})
         grid_rest_delete(url, rparams.merge(:grid_rest_namespace => '#{namespace}'))
       end
+      def #{namespace}_default_parameters(params, request_types = :global)
+        set_namespaced_default_grid_rest_parameters(:#{namespace}, params, request_types)
+      end
+      alias_method :set_#{namespace}_default_parameters, :#{namespace}_default_parameters
     END
   end
 
@@ -89,6 +95,50 @@ module GridRest
       @current_namespace
     end
 
+    # Global setter valid for all request/namespaces
+    def default_grid_rest_parameters(params, request_types = :global)
+      set_namespaced_default_grid_rest_parameters(:default, params, request_types)
+    end
+    alias_method :set_default_grid_rest_parameters, :default_grid_rest_parameters
+
+    # Return an array of additional parameters. This request is namespace aware
+    # It will return an array given the additional default parameters for:
+    #  ALL, GET, POST, PUT and DELETE
+    # requests in that order
+    def get_additional_grid_rest_parameters
+      globals = get_request_specific_additional_grid_rest_parameters(:global)
+      return [
+        globals,
+        globals.merge(get_request_specific_additional_grid_rest_parameters(:get)),
+        globals.merge(get_request_specific_additional_grid_rest_parameters(:post)),
+        globals.merge(get_request_specific_additional_grid_rest_parameters(:put)),
+        globals.merge(get_request_specific_additional_grid_rest_parameters(:delete))
+      ]
+    end
+
+    # Get all the global parameters. The defaults, extended/overwritten by the
+    # namespace specific ones
+    def get_request_specific_additional_grid_rest_parameters(request = :global)
+      if current_namespace
+        additional_grid_rest_parameters[:default][request].merge(additional_grid_rest_parameters[current_namespace.to_sym][request] || {})
+      else
+        additional_grid_rest_parameters[:default][request]
+      end
+    end
+
+    # Getter of additional parameters. Contains defaults and namespace specific versions
+    def additional_grid_rest_parameters
+      GridRest.additional_parameters
+    end
+    
+    def set_namespaced_default_grid_rest_parameters(ns, params, request_types = :global)
+      additional_grid_rest_parameters[ns] ||= {}
+      for request_type in Array.wrap(request_types).map(&:to_sym)
+        additional_grid_rest_parameters[ns][request_type] ||= {}
+        additional_grid_rest_parameters[ns][request_type].update(params)
+      end
+    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
@@ -114,48 +164,55 @@ module GridRest
       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
+      additional_get_parameters, additional_post_parameters, additional_put_parameters, additional_delete_parameters = get_additional_grid_rest_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 :get then RestClient.get rest_url, :params => rparams.update(additional_get_parameters), :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
+                rparams[:json_data] = rparams[:json_data].merge(additional_post_parameters).to_json if rparams[:json_data].is_a?(Hash)
+                RestClient.post rest_url, 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
+                rparams[:xml_data] = rparams[:xml_data].merge(additional_post_parameters).to_xml if rparams[:xml_data].is_a?(Hash)
+                RestClient.post rest_url, 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
+                RestClient.post rest_url, rparams.update(additional_post_parameters)
               end
-            when :put then 
+            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
+                rparams[:json_data] = rparams[:json_data].merge(additional_put_parameters).to_json if rparams[:json_data].is_a?(Hash)
+                RestClient.put rest_url, 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
+                rparams[:xml_data] = rparams[:xml_data].merge(additional_put_parameters).to_xml if rparams[:xml_data].is_a?(Hash)
+                RestClient.put rest_url, 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
+                RestClient.put rest_url, rparams.update(additional_put_parameters)
               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
+                rparams[:json_data] = rparams[:json_data].merge(additional_delete_parameters).to_json if rparams[:json_data].is_a?(Hash)
+                RestClient.delete rest_url, 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
+                rparams[:xml_data] = rparams[:xml_data].merge(additional_delete_parameters).to_xml if rparams[:xml_data].is_a?(Hash)
+                RestClient.delete rest_url, 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
+                RestClient.delete rest_url, rparams.update(additional_delete_parameters)
               end
             else
               raise "No proper method (#{method}) for a grid_rest_request call"
@@ -240,7 +297,9 @@ module GridRest
       false
     end
 
-    def try(*args)
+    def try(m, *args)
+      return send(m, *args) if respond_to?(m)
+      # Behave like a nil object otherwise
       nil
     end
 
@@ -266,7 +325,9 @@ module GridRest
     def valid?
       false
     end
-    def try(*args)
+    def try(m, *args)
+      return send(m, *args) if respond_to?(m)
+      # Behave like a nil object otherwise
       nil
     end
   end

data/lib/grid_rest/engine.rb

@@ -0,0 +1,17 @@
+module GridRest
+  class Engine < Rails::Engine
+    #rake_tasks do
+    #  load "tasks/tiny_mce.rake"
+    #end
+    config.grid_rest = GridRest
+
+    initializer "grid_rest.load_config" do |app|
+      app.config.after_initialize do
+        GridRest.load_config!
+      end
+      #ActiveSupport.on_load(:action_controller) do
+      #  GridRest.include_in(self)
+      #end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Benjamin ter Kuile
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-07 00:00:00 +02:00
+date: 2011-06-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,13 +108,15 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- CHANGELOG.rdoc
 - Gemfile
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
+- grid_rest.gemspec
 - lib/grid_rest.rb
-- lib/grid_rest/railtie.rb
+- lib/grid_rest/engine.rb
 - test/helper.rb
 - test/test_grid_rest.rb
 has_rdoc: true

data/lib/grid_rest/railtie.rb

@@ -1,13 +0,0 @@
-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