ooor 1.0.5 → 1.0.6

data/README.md

@@ -156,6 +156,12 @@ Request params or ActiveResource equivalence of OpenERP domain (but degraded as
     $ Partners.find(:all, :params => {:supplier => true})
 
 
+OpenERP search method:
+
+    $ ResPartner.search([['name', 'ilike', 'a']], 0, 2)
+Arguments are: domain, offset=0, limit=false, order=false, context={}, count=false
+
+
 Relations (many2one, one2many, many2many) support:
 
     $ SaleOrder.find(1).order_line
@@ -170,6 +176,12 @@ Inherited relations support:
 
     $ ProductProduct.find(1).categ_id #where categ_id is inherited from the ProductTemplate
 
+Please notice that loaded relations are cached (to avoid  hitting OpenERP over and over)
+until the root object is reloaded (after save/update for instance)
+Currently, save/update doesn't save the whole object graph but only the current object.
+We might change this in the future to match the way OpenERP clients are working which
+is supported by the OpenERP ORM, see issue: http://github.com/rvalyi/ooor/issues/#issue/3
+
 
 Load only specific fields support (faster than loading all fields):
 
@@ -205,10 +217,46 @@ Delete:
     $ pc.destroy
 
 
-Call workflow: see code; TODO document
+Call workflow:
+
+    $ s = SaleOrder.find(2)
+    $ s.wkf_action('cancel')
+    $ s.state
+    $ => 'cancel'
+
+
+On Change methods:
+
+    $ l=SaleOrderLine.new
+    $ l.on_change('product_id_change', 1, 1, false, false, false, false, false, false, 1)
+    $ => #<Ooor::SaleOrderLine:0x10c2cfe1 @prefix_options={}, @attributes={"product_packaging"=>false, "product_uos_qty"=>false, "th_weight"=>0}>
+Notice that it reloads the Objects attrs and print warning message accordingly
+
+
+Call aribtrary method:
+
+    $ use static ObjectClass.rpc_execute_with_all method
+    $ or object.call(method_name, args*) #were args is an aribtrary list of arguments
+
+
+Change logged user:
+
+    $ 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.
+
+
+Change log level:
 
+By default the log level is very verbose (debug level) to help newcomers to jumpstart
+However you might want to change that. 2 solutions:
+    $ Ooor.logger.level = 1 #available levels are those of the standard Ruby Logger class: 0 debug, 1 info, 2 error
+    $ In the config yaml file or hash, set the :log_level parameter
 
-Call aribtrary method: see code; TODO document
 
 
 REST HTTP API:

data/lib/app/models/open_object_resource.rb

@@ -94,6 +94,7 @@ class OpenObjectResource < ActiveResource::Base
 
     #corresponding method for OpenERP osv.execute(self, db, uid, obj, method, *args, **kw) method
     def rpc_execute_with_all(db, uid, pass, obj, method, *args)
+      logger.debug "rpc_execute_with_all: rpc_methods: 'execute', db: #{db.inspect}, uid: #{uid.inspect}, pass: #{pass.inspect}, obj: #{obj.inspect}, method: #{method}, *args: #{args.inspect}"
       try_with_pretty_error_log { client(@database && @site || Ooor.object_url).call("execute",  db, uid, pass, obj, method, *args) }
     end
 
@@ -107,6 +108,7 @@ class OpenObjectResource < ActiveResource::Base
     end
 
     def rpc_exec_workflow_with_all(db, uid, pass, obj, action, *args)
+      logger.debug "rpc_execute_with_all: rpc_methods: 'exec_workflow', db: #{db.inspect}, uid: #{uid.inspect}, pass: #{pass.inspect}, obj: #{obj.inspect}, action #{action}, *args: #{args.inspect}"
       try_with_pretty_error_log { client(@database && @site || Ooor.object_url).call("exec_workflow", db, uid, pass, obj, action, *args) }
     end
 
@@ -248,7 +250,6 @@ class OpenObjectResource < ActiveResource::Base
   #Generic OpenERP on_change method
   def on_change(on_change_method, *args)
     result = self.class.rpc_execute(on_change_method, *args)
-    session
     self.classlogger.info result["warning"]["title"] if result["warning"]
     self.class.logger.info result["warning"]["message"] if result["warning"]
     load(result["value"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ooor
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors: 
   - Raphael Valyi - www.akretion.com