storage_room 0.3.4 → 0.3.5

data/History.txt

@@ -1,3 +1,9 @@
+== Version 0.3.5
+* Added WebhookDefinition as an array on Collection
+* Added WebhookCall Resource to parse the POST body of StorageRoom Webhooks on a server
+* Added the option to skip_webhooks when creating, updating or destroying a Model
+* Added trash key to Entries
+
 == Version 0.3.4
 * Added interface key to Fields
 

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/lib/storage_room/accessors.rb

@@ -152,6 +152,12 @@ module StorageRoom
         new_from_response_data(httparty.parsed_response.first[1])
       end
       
+      # Build an object out of the POST body
+      def new_from_json_string(json_string)
+        hash = JSON.parse(json_string)
+        new_from_response_data(hash)
+      end
+      
       # Creates a new object of the correct class and initializes it from the response data
       def new_from_response_data(response_data)
         object = StorageRoom.class_for_name(response_data['@type']).new.set_from_response_data(response_data)

data/lib/storage_room/embeddeds/webhook_definition.rb

@@ -0,0 +1,17 @@
+module StorageRoom
+  
+  class WebhookDefinition < Embedded
+    key :url
+    
+    key :username
+    key :password
+    
+    key :on_create
+    key :on_update
+    key :on_delete
+    
+    key :api
+    key :web_interface
+    
+  end
+end

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    
+  class Model < Resource  
+    attr_accessor :skip_webhooks
+      
     class << self
       # Create a new model with the passed attributes
       def create(attributes={})
@@ -60,14 +62,14 @@ 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)
+      httparty = self.class.post(self.class.index_path, :body => to_json, :query => query_parameters)
       handle_save_response(httparty)
     end
     
     # Update an existing model on the server
     def update
       return false if new_record?
-      httparty = self.class.put(self[:@url], :body => to_json)
+      httparty = self.class.put(self[:@url], :body => to_json, :query => query_parameters)
       handle_save_response(httparty)
     end
     
@@ -75,7 +77,7 @@ module StorageRoom
     def destroy
       return false if new_record?
       
-      httparty = self.class.delete(self[:@url])
+      httparty = self.class.delete(self[:@url], :query => query_parameters)
       self.class.handle_critical_response_errors(httparty)
       
       true
@@ -119,6 +121,10 @@ module StorageRoom
           false
         end
       end
+      
+      def query_parameters
+        skip_webhooks ? {:skip_webhooks => true} : nil
+      end
 
       
   end

data/lib/storage_room/models/collection.rb

@@ -5,6 +5,7 @@ module StorageRoom
     key :primary_field_identifier
     
     many :fields
+    many :webhook_definitions
     
     class << self                  
       def index_path # :nodoc:

data/lib/storage_room/models/entry.rb

@@ -29,6 +29,11 @@ module StorageRoom
     def collection
       self.class.collection
     end    
+    
+    # Has this Entry been trashed?
+    def trashed?
+      self[:@trash]
+    end
 
   end
 end

data/lib/storage_room/resource.rb

@@ -11,7 +11,7 @@ module StorageRoom
     headers 'User-Agent' => "StorageRoom Ruby Gem (#{StorageRoom.version})", 'Accept' => 'application/json', 'Content-Type' => 'application/json'
     format :json
 
-    class << self      
+    class << self            
       # Handle known server errors
       def handle_critical_response_errors(httparty) # :nodoc:
         case httparty.response.code

data/lib/storage_room/webhook_call.rb

@@ -0,0 +1,11 @@
+module StorageRoom
+  # Helper class for receiving Webhook Calls
+  class WebhookCall < Resource
+    one :@entry
+    
+    def entry
+      send('@entry')
+    end
+    
+  end
+end

data/lib/storage_room.rb

@@ -26,6 +26,7 @@ module StorageRoom
   autoload :Resource,                 'storage_room/resource'
   autoload :Model,                    'storage_room/model'
   autoload :Array,                    'storage_room/array'
+  autoload :WebhookCall,              'storage_room/webhook_call'
 
   autoload :Embedded,                 'storage_room/embedded'
   
@@ -58,6 +59,7 @@ module StorageRoom
   autoload :Image,                    'storage_room/embeddeds/image'
   autoload :Location,                 'storage_room/embeddeds/location'
   autoload :ImageVersion,             'storage_room/embeddeds/image_version'
+  autoload :WebhookDefinition,        'storage_room/embeddeds/webhook_definition'
 
 
   class << self

data/spec/fixtures/webhook_call.json

@@ -0,0 +1,18 @@
+{
+  "@attempts": 0, 
+  "@created_at": "2011-07-14T18:25:42Z", 
+  "@entry": {
+    "@collection_url": "http:\/\/api.storageroomapp.com\/accounts\/4e1e9c234250712eba000052\/collections\/4e1e9c234250712eba000062", 
+    "@created_at": "2011-07-14T18:15:53Z", 
+    "@type": "Announcement", 
+    "@trash": false,
+    "@updated_at": "2011-07-14T18:25:42Z", 
+    "@url": "http:\/\/api.storageroomapp.com\/accounts\/4e1e9c234250712eba000052\/collections\/4e1e9c234250712eba000062\/entries\/4e1f3259425071435e00004a", 
+    "@version": 2, 
+    "text": "WEBHOOK TEST"
+  }, 
+  "@event": "update", 
+  "@last_attempt_at": null, 
+  "@last_status_code": null, 
+  "@type": "WebhookCall"
+}

data/spec/storage_room/embeddeds/webhook_definition_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe StorageRoom::WebhookDefinition do
+
+  before(:each) do
+    @webhook_definition = StorageRoom::WebhookDefinition.new(:url => 'URL', :on_create => true, :on_update => true, :on_delete => true, :api => true, :web_interface => true, :username => 'username', :password => 'password')
+  end
+
+  context "Configuration" do
+    describe "#keys" do
+      it "should have keys" do        
+        @webhook_definition.url.should == 'URL'
+        
+        @webhook_definition.on_create.should be_true
+        @webhook_definition.on_update.should be_true
+        @webhook_definition.on_delete.should be_true
+        
+        @webhook_definition.api.should be_true
+        @webhook_definition.web_interface.should be_true
+        
+        @webhook_definition.username.should == 'username'
+        @webhook_definition.password.should == 'password'
+      end
+    end
+  end
+  
+end

data/spec/storage_room/model_spec.rb

@@ -255,6 +255,19 @@ describe StorageRoom::Model do
          collection.destroy
        end
      end
+     
+     describe "#query_parameters" do
+       it "should return parameter if skip_webhooks" do
+         @model.skip_webhooks = false
+         @model.send(:query_parameters).should be_nil
+       end
+       
+       it "should return nil if not skip_webhooks" do
+         @model.skip_webhooks = true
+         @model.send(:query_parameters).should include(:skip_webhooks => true)
+       end
+       
+     end
     
   end
   

data/spec/storage_room/models/entry_spec.rb

@@ -54,5 +54,17 @@ describe StorageRoom::Entry do
         @entry.collection.should == @collection
       end
     end
+    
+    describe "#trashed?" do
+      it "should return true" do
+        @entry.response_data[:@trash] = true
+        @entry.should be_trashed
+      end
+      
+      it "should return false" do
+        @entry.response_data[:@trash] = false
+        @entry.should_not be_trashed
+      end
+    end
   end
 end

data/spec/storage_room/webhook_call_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+class Announcement < StorageRoom::Entry
+  key :text
+end
+
+describe StorageRoom::WebhookCall do
+  before(:each) do
+    @webhook_call = StorageRoom::WebhookCall.new
+  end
+  
+  describe "#new_from_json_string" do
+    it "should create object" do
+      file = fixture_file('webhook_call.json')
+      webhook_call = StorageRoom::Resource.new_from_json_string(file)
+      
+      webhook_call.should be_an_instance_of(StorageRoom::WebhookCall)        
+      webhook_call[:@url].should_not be_present
+      webhook_call[:@event].should == 'update'
+      webhook_call.entry.should be_an_instance_of(Announcement)
+      webhook_call.entry.text.should == 'WEBHOOK TEST'
+    end
+  end
+end

data/storage_room.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{storage_room}
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sascha Konietzke"]
-  s.date = %q{2011-07-14}
+  s.date = %q{2011-07-18}
   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 = [
@@ -60,6 +60,7 @@ Gem::Specification.new do |s|
     "lib/storage_room/embeddeds/image.rb",
     "lib/storage_room/embeddeds/image_version.rb",
     "lib/storage_room/embeddeds/location.rb",
+    "lib/storage_room/embeddeds/webhook_definition.rb",
     "lib/storage_room/extensions/const_defined.rb",
     "lib/storage_room/identity_map.rb",
     "lib/storage_room/model.rb",
@@ -68,10 +69,12 @@ Gem::Specification.new do |s|
     "lib/storage_room/plugins.rb",
     "lib/storage_room/proxy.rb",
     "lib/storage_room/resource.rb",
+    "lib/storage_room/webhook_call.rb",
     "spec/fixtures/collection.json",
     "spec/fixtures/collections.json",
     "spec/fixtures/image.png",
     "spec/fixtures/validation_error.json",
+    "spec/fixtures/webhook_call.json",
     "spec/spec_helper.rb",
     "spec/storage_room/accessors_spec.rb",
     "spec/storage_room/array_spec.rb",
@@ -98,12 +101,14 @@ Gem::Specification.new do |s|
     "spec/storage_room/embeddeds/image_spec.rb",
     "spec/storage_room/embeddeds/image_version_spec.rb",
     "spec/storage_room/embeddeds/location_spec.rb",
+    "spec/storage_room/embeddeds/webhook_definition_spec.rb",
     "spec/storage_room/identity_map_spec.rb",
     "spec/storage_room/model_spec.rb",
     "spec/storage_room/models/collection_spec.rb",
     "spec/storage_room/models/entry_spec.rb",
     "spec/storage_room/proxy_spec.rb",
     "spec/storage_room/resource_spec.rb",
+    "spec/storage_room/webhook_call_spec.rb",
     "spec/storage_room_spec.rb",
     "storage_room.gemspec",
     "tasks/storage_room.rake"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Sascha Konietzke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 +02:00
+date: 2011-07-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -141,6 +141,7 @@ files:
 - lib/storage_room/embeddeds/image.rb
 - lib/storage_room/embeddeds/image_version.rb
 - lib/storage_room/embeddeds/location.rb
+- lib/storage_room/embeddeds/webhook_definition.rb
 - lib/storage_room/extensions/const_defined.rb
 - lib/storage_room/identity_map.rb
 - lib/storage_room/model.rb
@@ -149,10 +150,12 @@ files:
 - lib/storage_room/plugins.rb
 - lib/storage_room/proxy.rb
 - lib/storage_room/resource.rb
+- lib/storage_room/webhook_call.rb
 - spec/fixtures/collection.json
 - spec/fixtures/collections.json
 - spec/fixtures/image.png
 - spec/fixtures/validation_error.json
+- spec/fixtures/webhook_call.json
 - spec/spec_helper.rb
 - spec/storage_room/accessors_spec.rb
 - spec/storage_room/array_spec.rb
@@ -179,12 +182,14 @@ files:
 - spec/storage_room/embeddeds/image_spec.rb
 - spec/storage_room/embeddeds/image_version_spec.rb
 - spec/storage_room/embeddeds/location_spec.rb
+- spec/storage_room/embeddeds/webhook_definition_spec.rb
 - spec/storage_room/identity_map_spec.rb
 - spec/storage_room/model_spec.rb
 - spec/storage_room/models/collection_spec.rb
 - spec/storage_room/models/entry_spec.rb
 - spec/storage_room/proxy_spec.rb
 - spec/storage_room/resource_spec.rb
+- spec/storage_room/webhook_call_spec.rb
 - spec/storage_room_spec.rb
 - storage_room.gemspec
 - tasks/storage_room.rake