ooor 1.6.1 → 1.6.2

data/README.md

@@ -294,17 +294,33 @@ You can also create a resource and it's ir_model_data record alltogether using t
     $ ProductCategory.create(:name => 'rails_categ', :ir_model_data_id =>['product', 'categ_x']) #1st tab element is the module, 2nd the id in the module
 
 
+Obtain report binary data:
+
+To obtain the binary data of an object report simply use the function get_report_data(report_name). This function returns a list that contains the binary data encoded in base64 and a string with the file format.
+Example:
+    
+    $ inv = AccountInvoice.find(3)
+    $ report = inv.get_report_data('account.invoice') #account.invoice is the service name defined in Invoices report
+    $ #Save the report to a file
+    $ #report[1] contains the file extension and report[0] contains the binary data of the report encoded in base64
+    $ File.open("invoice_report.#{report[1]}", "w") {|f| f.write(Base64.decode64(report[0]))} 
+
 Change logged user:
 
+An Ooor client can have a global user logged in, to change it:
+
     $ Ooor.global_login('demo', 'demo')
     $ s = SaleOrder.find(2)
     $ => 'Access denied error'
 
-Notice that this changes the globally logged user and doesn't address the issue of
-different users using Ooor concurrently with different credentials as you might want
-for instance in a Rails web application. That second issue will be addressed at
-the API level but it's not easy as ActiveResource has not been designed for it.
+Instead, every Ooor business objects can also belong to some specific user. To achieve that, generate your object passing
+proper :user_id and :password parameters inside the context of the method creating the object (typically a find).
+Notice that methods invoked on an objet use the same credentials as the business objects.
+Objects generated by this object (by a call to an association for instance) will also have the same credentials.
+
+    $ p = ProductProduct.find(1, :context => {:user_id=>3, :password=>'test'})
 
+This is tipycally the system you will use in a Ruby (Rails or not) web application.
 
 Change log level:
 

data/lib/app/models/open_object_resource.rb

@@ -21,6 +21,7 @@ require 'app/ui/form_model'
 require 'app/models/uml'
 require 'app/models/type_casting'
 require 'app/models/relation'
+require 'app/models/serialization'
 
 module Ooor
   class OpenObjectResource < ActiveResource::Base
@@ -28,6 +29,7 @@ module Ooor
     #include ActiveModel::Validations
     include UML
     include TypeCasting
+    include Serialization
 
     # ******************** class methods ********************
     class << self
@@ -172,7 +174,44 @@ module Ooor
         raise RuntimeError.new("Invalid RPC method:  #{method_symbol}") if [:type!, :allowed!].index(method_symbol)
         self.rpc_execute(method_symbol.to_s, *arguments)
       end
-
+      
+      #Added methods to obtain report data for a model
+      def report(report_name, ids, report_type='pdf', context={})
+        context = @ooor.global_context.merge(context)
+        params = {'model' => @openerp_model, 'id' => ids[0], 'report_type' => report_type}
+        @ooor.get_rpc_client("#{(@database && @site || @ooor.base_url)}/report").call("report",  @database || @ooor.config[:database], @user_id || @ooor.config[:user_id], @password || @ooor.config[:password], report_name, ids, params, context)
+      end
+      
+      def report_get(report_id, context={})
+        context = @ooor.global_context.merge(context)
+        @ooor.get_rpc_client("#{(@database && @site || @ooor.base_url)}/report").call("report_get",  @database || @ooor.config[:database], @user_id || @ooor.config[:user_id], @password || @ooor.config[:password], report_id)
+      end
+      
+      def get_report_data(report_name, ids, report_type='pdf', context={})
+        report_id = self.report(report_name, ids, report_type, context)
+        if report_id
+          state = false
+          attempt = 0
+          while not state
+            report = self.report_get(report_id, context)
+            state = report["state"]
+            attempt = 1
+            if not state 
+              sleep(0.1)
+              attempt += 1
+            else
+              return [report["result"],report["format"]]
+            end
+            if attempt > 100
+              logger.debug "OOOR RPC: 'Printing Aborted!'"
+              break
+            end
+          end     
+        else
+          logger.debug "OOOR RPC: 'report not found'"
+        end
+        return nil
+      end
 
       # ******************** finders low level implementation ********************
       private
@@ -239,6 +278,11 @@ module Ooor
     def object_uid; object_session[:user_id] || self.class.user_id || self.class.ooor.config[:user_id]; end
     def object_pass; object_session[:password] || self.class.password || self.class.ooor.config[:password]; end
 
+    # Ruby 1.9.compat, See also http://tenderlovemaking.com/2011/06/28/til-its-ok-to-return-nil-from-to_ary/
+    def to_ary # :nodoc:
+        nil
+    end
+
     #try to wrap the object context inside the query.
     def rpc_execute(method, *args)
     if args[-1].is_a? Hash
@@ -361,8 +405,8 @@ module Ooor
     def old_wizard_step(wizard_name, step='init', wizard_id=nil, form={}, context={})
       result = self.class.old_wizard_step(wizard_name, [self.id], step, wizard_id, form, {})
       FormModel.new(wizard_name, result[0], nil, nil, result[1], [self], self.class.ooor.global_context)
-    end
-    
+    end   
+        
     def log(message, context={}) rpc_execute('log', id, message, context) end
 
     def type() method_missing(:type) end #skips deprecated Object#type method
@@ -415,12 +459,17 @@ module Ooor
         rpc_execute(method_key, [id], *arguments) #we assume that's an action
       else
         super
-      end
+      end     
 
     rescue RuntimeError => e
       e.message << "\n" + available_fields if e.message.index("AttributeError")
       raise e
     end
+    
+    #Add get_report_data to obtain [report["result"],report["format]] of a concrete openERP Object
+    def get_report_data(report_name, report_type="pdf", context={})
+      self.class.get_report_data(report_name, [self.id], report_type, context)        
+    end 
 
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: ooor
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors: 
 - Raphael Valyi - www.akretion.com
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-14 00:00:00 Z
+date: 2011-09-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activeresource
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: OOOR - OpenObject On Ruby