storage_room 0.3.9 → 0.3.10

data/History.txt

@@ -1,3 +1,7 @@
+== Version 0.3.10
+* Fixed cyclic dependency when preloading associated Collections 
+* Added create, update, save and destroy callbacks to Models
+
 == Version 0.3.9
 * Added a check that already defined classes inherit from StorageRoom::Entry
 

data/README.rdoc

@@ -9,6 +9,7 @@ This gem provides read and write access to the StorageRoom API (http://storagero
 * Supports lazy-loading of associations (e.g. post.category will fetch a category transparently if it has not yet been loaded)
 * Supports caching through an identity map, so that Resources don't have to be loaded multiple times
 * Easy file uploads and removals
+* Model Callbacks
 
 == Installation
 

data/Rakefile

@@ -15,6 +15,7 @@ begin
       
     gem.add_dependency 'httparty', '>= 0.6.1'
     gem.add_dependency 'activesupport', '>= 3.0.0'
+    gem.add_dependency 'activemodel', '>= 3.0.0'
     gem.add_dependency 'mime-types'
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.3.9
+0.3.10

data/examples/authentication.rb

@@ -5,5 +5,5 @@ APPLICATION_API_KEY = 'fgK8Di4FYuRKtk2Xd12A' # your application's API key with r
 
 StorageRoom.authenticate(ACCOUNT_ID, APPLICATION_API_KEY)
 
-StorageRoom.server = "api.lvh.me:3000"
-# StorageRoom.server = "api.storageroomapp.com"
+# StorageRoom.server = "api.lvh.me:3000"
+StorageRoom.server = "api.storageroomapp.com"

data/examples/callbacks.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby -rubygems
+
+require File.join(File.dirname(__FILE__), 'authentication')
+
+class Guidebook < StorageRoom::Entry
+  before_create :log_before_create
+  after_create :log_after_create
+  
+  before_save :log_before_save
+  
+  before_destroy :log_before_destroy
+  
+  def log_before_create
+    puts "Before create '#{title}'"
+  end
+  
+  def log_after_create
+    puts "After create '#{title}'"
+  end
+  
+  def log_before_save
+    puts "Before save '#{title}'"
+  end
+  
+  def log_before_destroy
+    puts "Before destroy '#{title}'"
+  end
+end
+
+guidebook_collection = StorageRoom::Collection.find('4e1e9c234250712eba00005f')
+
+guidebook = Guidebook.new(:title => 'Bar')
+
+guidebook.save
+
+guidebook.destroy

data/lib/storage_room.rb

@@ -6,6 +6,7 @@ begin; require 'rubygems'; rescue LoadError; end
 require 'httparty'
 require 'mime/types'
 require 'base64'
+require 'active_model'
 require 'active_support/all' 
 require 'storage_room/extensions/const_defined'
 require 'storage_room/extensions/symbol'

data/lib/storage_room/accessors.rb

@@ -5,6 +5,9 @@ module StorageRoom
     extend ActiveSupport::Concern
          
     included do
+      self.send(:extend, ::ActiveModel::Callbacks)
+      self.send(:define_model_callbacks, :initialize_from_response_data)
+      
       self.class_inheritable_accessor :attribute_options
       self.attribute_options ||= {}
     end
@@ -105,19 +108,21 @@ module StorageRoom
       
         # Iterate over the response data and initialize the attributes
         def initialize_from_response_data # :nodoc:
-          self.class.attribute_options.each do |name, options|
-            value = if options[:type] == :key
-              self[name].blank? ? options[:default] : self[name]
-            elsif options[:type] == :one
-              hash = self[name.to_s]
-              hash && hash['@type'] ? self.class.new_from_response_data(hash) : nil
-            elsif options[:type] == :many
-              response_data[name] && response_data[name].map{|hash| self.class.new_from_response_data(hash)} || []
-            else
-              raise "Invalid type: #{options[:type]}"
-            end
+          _run_initialize_from_response_data_callbacks do
+            self.class.attribute_options.each do |name, options|
+              value = if options[:type] == :key
+                self[name].blank? ? options[:default] : self[name]
+              elsif options[:type] == :one
+                hash = self[name.to_s]
+                hash && hash['@type'] ? self.class.new_from_response_data(hash) : nil
+              elsif options[:type] == :many
+                response_data[name] && response_data[name].map{|hash| self.class.new_from_response_data(hash)} || []
+              else
+                raise "Invalid type: #{options[:type]}"
+              end
 
-            send("#{name}=", value)
+              send("#{name}=", value)
+            end
           end
         end
         

data/lib/storage_room/embeddeds/fields/association_field.rb

@@ -6,12 +6,16 @@ module StorageRoom
     def add_to_entry_class(klass) # :nodoc:
       super
       
-      collection
+     # collection
     end
     
     # The target collection of the association field
     def collection
       @collection ||= Collection.load(self.collection_url)
     end
+    
+    def collection_loaded?
+      @collection ? true : false
+    end
   end
 end

data/lib/storage_room/identity_map.rb

@@ -26,7 +26,7 @@ module StorageRoom
         return nil if url.nil?
         
         if identity_map_on? && object = identity_map[url]
-          StorageRoom.log("Loaded #{object} from identity map (load)")
+          StorageRoom.log("Loaded #{object} (#{url}) from identity map (load)")
           object
         else
           super
@@ -39,7 +39,7 @@ module StorageRoom
         object = url ? identity_map[url] : nil
 
         if object.present? && identity_map_on?
-          StorageRoom.log("Loaded #{object} from identity map (new_from_response_data)")
+          StorageRoom.log("Loaded #{object} (#{url}) from identity map (new_from_response_data)")
           object.set_from_response_data(response_data) 
         else
           object = super

data/lib/storage_room/model.rb

@@ -1,6 +1,8 @@
 module StorageRoom
   # Abstract superclass for classes that can persist to the remote servers
   class Model < Resource  
+    define_model_callbacks :create, :update, :save, :destroy
+    
     attr_accessor :skip_webhooks
       
     class << self
@@ -62,23 +64,33 @@ module StorageRoom
     # Create a new model on the server
     def create
       return false unless new_record?
-      httparty = self.class.post(self.class.index_path, :body => to_json, :query => query_parameters)
-      handle_save_response(httparty)
+      _run_save_callbacks do
+        _run_create_callbacks do
+          httparty = self.class.post(self.class.index_path, :body => to_json, :query => query_parameters)
+          handle_save_response(httparty)
+        end
+      end
     end
     
     # Update an existing model on the server
     def update
       return false if new_record?
-      httparty = self.class.put(self[:@url], :body => to_json, :query => query_parameters)
-      handle_save_response(httparty)
+      _run_save_callbacks do
+        _run_update_callbacks do
+          httparty = self.class.put(self[:@url], :body => to_json, :query => query_parameters)
+          handle_save_response(httparty)
+        end
+      end
     end
     
     # Delete an existing model on the server
     def destroy
       return false if new_record?
       
-      httparty = self.class.delete(self[:@url], :query => query_parameters)
-      self.class.handle_critical_response_errors(httparty)
+      _run_destroy_callbacks do
+        httparty = self.class.delete(self[:@url], :query => query_parameters)
+        self.class.handle_critical_response_errors(httparty)
+      end
       
       true
     end

data/lib/storage_room/models/collection.rb

@@ -7,6 +7,7 @@ module StorageRoom
     many :fields
     many :webhook_definitions
     
+    
     class << self                  
       def index_path # :nodoc:
         "#{Resource.base_uri}/collections"
@@ -56,6 +57,22 @@ module StorageRoom
       nil
     end
     
+    # All fields of type AssociationField
+    def association_fields
+      fields.select{|f| f.is_a?(AssociationField)}
+    end
+    
+    # Load all Collections that are related to the current one through AssociationFields
+    def load_associated_collections
+      array = association_fields
+
+      if array.map{|f| f.collection_loaded?}.include?(false)
+        StorageRoom.log("Fetching associated collections for '#{name}'")
+        array.each{|f| f.collection}
+      end
+    end
+
+    
     protected   
       def initialize_from_response_data
         super

data/lib/storage_room/models/entry.rb

@@ -1,7 +1,9 @@
 module StorageRoom
   class Entry < Model
     class_inheritable_accessor :collection
-        
+    
+    before_initialize_from_response_data :load_associated_collections
+    
     class << self         
       def index_path # :nodoc:
         "#{collection[:@url]}/entries"
@@ -35,6 +37,7 @@ module StorageRoom
       end
     end
     
+        
     # The collection of a entry
     def collection
       self.class.collection
@@ -48,6 +51,12 @@ module StorageRoom
     def id
       self[:@url] ? self[:@url].split('/').last : nil
     end
-
+    
+    protected
+      # Fetch all associated Collections before the Entry is initialized from the JSON document
+      def load_associated_collections # :nodoc:
+        collection.try(:load_associated_collections)
+      end
+    
   end
 end

data/lib/storage_room/resource.rb

@@ -3,6 +3,8 @@ module StorageRoom
   class Resource
     include HTTParty
     extend Plugins
+
+    
     
     include Accessors
     

data/storage_room.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{storage_room}
-  s.version = "0.3.9"
+  s.version = "0.3.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sascha Konietzke"]
-  s.date = %q{2011-07-29}
+  s.date = %q{2011-08-03}
   s.description = %q{StorageRoom is a CMS system for Mobile Applications (iPhone, Android, BlackBerry, ...). This library gives you an ActiveModel-like interface to your data.}
   s.email = %q{sascha@thriventures.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "examples/associations.rb",
     "examples/authentication.rb",
     "examples/backup_uploads_from_export.rb",
+    "examples/callbacks.rb",
     "examples/create_entry.rb",
     "examples/destroy_entry.rb",
     "examples/get_collections.rb",
@@ -135,12 +136,14 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<activemodel>, [">= 3.0.0"])
       s.add_runtime_dependency(%q<mime-types>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<httparty>, [">= 0.6.1"])
       s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<activemodel>, [">= 3.0.0"])
       s.add_dependency(%q<mime-types>, [">= 0"])
     end
   else
@@ -148,6 +151,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<httparty>, [">= 0.6.1"])
     s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<activemodel>, [">= 3.0.0"])
     s.add_dependency(%q<mime-types>, [">= 0"])
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 9
-  version: 0.3.9
+  - 10
+  version: 0.3.10
 platform: ruby
 authors: 
 - Sascha Konietzke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-29 00:00:00 +02:00
+date: 2011-08-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,7 +76,7 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: mime-types
+  name: activemodel
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -84,10 +84,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 3
         - 0
-        version: "0"
+        - 0
+        version: 3.0.0
   type: :runtime
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
 description: StorageRoom is a CMS system for Mobile Applications (iPhone, Android, BlackBerry, ...). This library gives you an ActiveModel-like interface to your data.
 email: sascha@thriventures.com
 executables: []
@@ -108,6 +123,7 @@ files:
 - examples/associations.rb
 - examples/authentication.rb
 - examples/backup_uploads_from_export.rb
+- examples/callbacks.rb
 - examples/create_entry.rb
 - examples/destroy_entry.rb
 - examples/get_collections.rb