arusarka-dynamic-active-resource 0.0.2 → 0.1.5

data/History.txt

@@ -1,3 +1,9 @@
+0.1.0
+-----
+
+* added active record like associations, very lightweight. supported relationships : has_many, and belongs_to
+look in the README for examples
+
 0.0.2
 -----
 

data/README

@@ -89,11 +89,122 @@ class Person < DynamicActiveResource::Base
 end
 
 The instance methods will be available as instance methods in the objects created, class methods
-will be available as class methods in the class of the object.
+will be available as class methods in the class of the object. Also active resource associations
+are sometimes paginated. So even if you use find(:all), you get only the first few results. To 
+overcome this, include in your ClassMethods module a method called find_without_pagination. In that
+method route it to acitve resource find with proper parameters. An example of the method implementation
+is 
+
+def find_without_pagination(*args)
+  scope = args.slice!(0)
+  options = args.slice!(0) || {}
+  options[:params] ||= {}
+  options[:params].merge!({:page => 'all'})
+  # call ActiveResource::Base::find with proper options
+  find(scope, options)
+end
+
+The class level find method will automatically pick up this method if defined as a ClassMethod method
+else it will pass it to find. 
+
+ASSOCIATIONS
+------------
+
+This gem also provides active record like associations(highly experimental). Right now it provides only two
+associations - 1) has_many, 2) belongs_to.
+
+1) has_many 
+-----------
+
+Taking the example from above the way it should be done
+
+class Person < DynamicActiveResource::Base
+  has_many :cars
+
+  module ClassMethods
+    def count
+      find(:all).size
+    end
+  end
+
+  module InstanceMethods
+    def occupation
+      return job if job
+      'Unemployed' 
+    end
+    
+    def resource_identifier
+     name()
+   end
+  end
+end
+
+Next a car class has to be initialized
+
+class Car < DynARBase (alias for DynamicActiveResource::Base)
+end
+
+set resource options only at the top level( Person in this case)
+
+Person.site = 'http://localhost:8080/'
+Person.user = 'test'
+Person.password = 'secret'
+
+associations take care of setting the site in the children classes automatically
+you will notice that an additional method resource_identifier() has been defined
+in the parent class. It would be discussed shortly.
+
+The way associations work is if you do something like
+
+person = Person.find('asur').cars it will hit the url http://localhost:8080/people/asur/cars.xml
+
+You would notice that its getting the cars for the person with name 'asur'. It does so because
+in the Person class a method called resource_identifier has been defined which says that the id
+is actually name instead of the database id. If the id attribute in the xml is set appropriately
+(to name in this case) then you do not need to define the method.
+
+2) belongs_to
+-------------
+
+Again, referring to the example above
+
+class Person < DynamicActiveResource::Base
+  has_many :cars
+
+  module ClassMethods
+    def count
+      find(:all).size
+    end
+  end
+
+  module InstanceMethods
+    def occupation
+      return job if job
+      'Unemployed' 
+    end
+    
+    def resource_identifier
+     name()
+   end
+  end
+end
+
+Next a car class has to be initialized
+
+class Car < DynARBase (alias for DynamicActiveResource::Base)
+  belongs_to :person
+end
+
+Right now belongs_to supports only assocation with a single class. After defining this you 
+automatically have a method 'person' available.
+
+car = Car.find('WB1234I')
+owner = car.person
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+Only site, element_name, collection_name, user, password attributes of ActiveResource::Base is managed
+by the wrapper class.
 
 == SYNOPSIS:
 
@@ -101,11 +212,11 @@ will be available as class methods in the class of the object.
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+requires active-resource
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+sudo gem install arusarka-dynamic-active-resource
 
 == LICENSE:
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: arusarka-dynamic-active-resource
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.5
 platform: ruby
 authors: 
 - asur
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: A wrapper around active resource. Normally changing active resource attributes doesn't get reflected. So this gem allows to dynamically create active resource classes
+description: A wrapper around active resource. Normally changing active resource attributes doesn't get reflected. So this gem allows to dynamically create active resource classes. This gem also provides very lightweight activerecord like associations.
 email: arusarka@gmail.com
 executables: []
 
@@ -35,6 +35,7 @@ files:
 - History.txt
 has_rdoc: false
 homepage: http://github.com/arusarka/dynamic-active-resource/
+licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -55,9 +56,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
-summary: Wrapper around active resource so that classes can be easily reused
+summary: Wrapper around active resource so that classes can be easily reused.
 test_files: []