ixtlan-optimistic 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Kristian Meier
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Ixtlan Optimistic [![Build Status](https://secure.travis-ci.org/mkristian/ixtlan-optimistic.png)](http://travis-ci.org/mkristian/ixtlan-optimistic) #
+
+it adds optimistic persistence support to DataMapper and ActveRecord usingg the updated_at property/attribute which is automatically updated on any change of the model (for datamapper you need dm-timestamps for that). to load a model use `optimistic_get`/`optimistic_get!`/`optimistic_find` respectively where the first argument is the last `updated_at` value which the client has. if the client data is uptodate then the `optimistic_XYZ` method will return the database entity otherwise raise an exception or return nil respectively.
+
+## rails setup ##
+
+automagic via included railtie. just add
+
+    `gem 'ixtlan-optimistic'
+	
+to your Gemfile.
+
+## datamapper ##
+
+just include `Ixtlan::Optimistic::DataMapper` to your model:
+
+    class User
+      include DataMapper::Resource
+      include Ixtlan::Optimistic::DataMapper
+
+      property :id, Serial
+      property :name, String
+  
+      timestamps :at
+    end
+	
+you need timestamps to get to work !
+
+## activerecord ##
+
+just add it with
+
+     ::ActiveRecord::Base.send(:include, 
+                               Ixtlan::Optimistic::ActiveRecord)
+
+# meta-fu #
+
+bug-reports, feature request and pull request are most welcome.

data/lib/ixtlan-optimistic.rb

@@ -0,0 +1,3 @@
+if defined?(Rails)
+  require 'ixtlan/optimistic/railtie'
+end

data/lib/ixtlan/optimistic/active_record.rb

@@ -0,0 +1,30 @@
+require 'ixtlan/optimistic/object_stale_exception'
+module Ixtlan
+  module Optimistic
+    module ActiveRecord
+
+      def self.included(base)
+        base.class_eval do
+
+          def self.optimistic_find(updated_at, *args)
+            if updated_at  
+              dummy = self.new
+              dummy.updated_at = updated_at
+              updated_at_date = dummy.updated_at
+              # try different ways to use the date
+              # TODO maybe there is a nicer way ??
+              # TODO make it work with different PKs
+              result = first(:conditions => ["id = ? and updated_at <= ? and updated_at >= ?", args[0], updated_at_date + 0.0005, updated_at_date - 0.0005])
+p result
+              raise ObjectStaleException.new "#{self.class} with ID=#{args[0]} is stale" unless result
+              result
+            else
+              raise ObjectStaleException.new "no 'updated_at' given. could not dind #{self.class} with ID=#{args[0]}."
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ixtlan/optimistic/data_mapper.rb

@@ -0,0 +1,32 @@
+require 'ixtlan/optimistic/object_stale_exception'
+module Ixtlan
+  module Optimistic
+    module DataMapper
+
+      def self.included(base)
+        base.class_eval do
+          
+          def self.optimistic_get(updated_at, *args)
+            if updated_at
+              updated_at_date = new(:updated_at => updated_at).updated_at
+              # TODO make it work with different PKs
+              first(:id => args[0], :updated_at.gte => updated_at_date - 0.0005, :updated_at.lte => updated_at_date + 0.0005)
+            end
+          end
+
+          def self.optimistic_get!(updated_at, *args)
+            if updated_at
+              result = self.optimistic_get(updated_at, *args)
+              raise ObjectStaleException.new "#{self.class} with ID=#{args[0]} is stale" unless result
+              result
+            else
+              raise ObjectStaleException.new "no 'updated_at' given. could not dind #{self.class} with ID=#{args[0]}."              
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/ixtlan/optimistic/object_stale_exception.rb

@@ -0,0 +1,6 @@
+module Ixtlan
+  module Optimistic
+    class ObjectStaleException < StandardError
+    end
+  end
+end

data/lib/ixtlan/optimistic/railtie.rb

@@ -0,0 +1,21 @@
+require 'ixtlan/optimistic/active_record'
+require 'ixtlan/optimistic/data_mapper'
+module Ixtlan
+  module Optimistic
+    class Railtie < Rails::Railtie
+
+      config.after_initialize do
+        if defined? ::DataMapper
+
+          ::DataMapper::Model.append_inclusions(Ixtlan::Optimistic::DataMapper)
+
+        elsif defined? ::ActiveRecord
+
+          ::ActiveRecord::Base.send(:include, 
+                                    Ixtlan::Optimistic::ActiveRecord)
+
+        end
+      end
+    end
+  end
+end

data/spec/datamapper_spec.rb

@@ -0,0 +1,38 @@
+require 'dm-core'
+require 'dm-timestamps'
+require 'dm-migrations'
+require 'dm-sqlite-adapter'
+require 'ixtlan/optimistic/data_mapper'
+
+DataMapper.setup(:default, 'sqlite::memory:')
+
+class A
+  include DataMapper::Resource
+  include Ixtlan::Optimistic::DataMapper
+
+  property :id, Serial
+  property :name, String
+  
+  timestamps :at
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!
+
+describe Ixtlan::Optimistic::DataMapper do
+
+  subject { A.create :name => 'huffalump' }
+
+  it 'should load' do
+    A.optimistic_get!(subject.updated_at.to_s, subject.id).must_equal subject
+  end
+
+  it 'should fail with nil' do
+    A.optimistic_get((subject.updated_at - 1000).to_s, subject.id).must_be_nil
+  end
+
+  it 'should fail with exception' do
+    lambda { A.optimistic_get!((subject.updated_at - 1000).to_s, subject.id) }.must_raise Ixtlan::Optimistic::ObjectStaleException
+  end
+
+end

data/spec/datamapper_spec.rb~

@@ -0,0 +1,74 @@
+require 'controller'
+
+shared_examples 'a X-Headers' do
+
+  it 'should be able to switch off' do
+    subject.send method, :inline => "asd", :x_frame_headers => :off, :x_content_type_headers => :off, :x_xss_protection_headers => :off
+    subject.response.headers.should == {}
+  end
+
+end
+
+class MyController < Controller
+  x_frame_headers :sameorigin
+  x_content_type_headers :off
+  x_xss_protection_headers :disabled
+end
+
+[:render, :send_file, :send_data].each do |method|
+  describe "x-headers using controller method #{method}" do
+    context "with simple controller" do
+      before do
+        Rails.configuration.x_frame_headers = nil
+        Rails.configuration.x_content_type_headers = nil
+        Rails.configuration.x_xss_protection_headers = nil
+      end
+      subject { Controller.new }
+      
+      it 'should use default' do
+        subject.send method, :inline => "asd"
+        subject.response.headers.should == {"X-Frame-Options"=>"DENY", "X-Content-Type-Options"=>"nosniff", "X-XSS-Protection"=>"1; mode=block"}
+      end
+      
+      it_behaves_like "a X-Headers" do
+        let(:method) { method }
+      end
+    end
+    
+    context "with controller with header configuration" do
+      before do
+        Rails.configuration.x_frame_headers = nil
+        Rails.configuration.x_content_type_headers = nil
+        Rails.configuration.x_xss_protection_headers = nil
+      end
+      subject { MyController.new }
+      
+      it 'should use configuration' do
+        subject.send method, :inline => "asd"
+        subject.response.headers.should == {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"0"}
+      end
+      
+      it_behaves_like "a X-Headers" do
+        let(:method) { method }
+      end
+    end
+    
+    context "with simple controller with rails configuration" do
+      before do
+        Rails.configuration.x_frame_headers = :sameorigin
+        Rails.configuration.x_content_type_headers = :off
+        Rails.configuration.x_xss_protection_headers = :disabled
+      end
+      subject { Controller.new }
+      
+      it 'should use configuration' do
+        subject.send method, :inline => "asd"
+        subject.response.headers.should == {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"0"}
+      end
+      
+      it_behaves_like "a X-Headers" do
+        let(:method) { method }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: ixtlan-optimistic
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- mkristian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 3
+        - 2
+        - 0
+        version: 3.2.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dm-timestamps
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: dm-migrations
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: dm-sqlite-adapter
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id005
+description: optimistic find/get on model via updated_at timestamp for datamapper and activerecord
+email: 
+- m.kristian@web.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.md
+- lib/ixtlan-optimistic.rb
+- lib/ixtlan/optimistic/active_record.rb
+- lib/ixtlan/optimistic/data_mapper.rb
+- lib/ixtlan/optimistic/railtie.rb
+- lib/ixtlan/optimistic/object_stale_exception.rb
+- spec/datamapper_spec.rb~
+- spec/datamapper_spec.rb
+homepage: http://github.com/mkristian/ixtlan-optimistic
+licenses: 
+- MIT-LICENSE
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: optimistic find/get on model via updated_at timestamp for datamapper and activerecord
+test_files: 
+- spec/datamapper_spec.rb