vidibus-resource 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+rdoc
+coverage

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in vidibus-resource.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    vidibus-resource (0.0.1)
+      rails (~> 3.0.0)
+      vidibus-api
+      vidibus-service
+      vidibus-uuid
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    bson (1.1.5)
+    builder (2.1.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    i18n (0.5.0)
+    json (1.4.6)
+    macaddr (1.0.0)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mongo (1.1.5)
+      bson (>= 1.1.5)
+    mongoid (2.0.0.rc.4)
+      activemodel (~> 3.0)
+      mongo (~> 1.1.5)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rr (1.0.2)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    uuid (2.3.1)
+      macaddr (~> 1.0)
+    vidibus-api (0.0.1)
+      vidibus-service
+    vidibus-core_extensions (0.3.15)
+    vidibus-secure (0.0.3)
+      activesupport (~> 3.0.0)
+      mongoid (~> 2.0.0.beta.20)
+      rack
+      vidibus-core_extensions
+    vidibus-service (0.0.4)
+      httparty
+      json
+      mongoid (~> 2.0.0.beta.20)
+      vidibus-core_extensions
+      vidibus-secure
+      vidibus-uuid
+      vidibus-validate_uri
+    vidibus-uuid (0.3.8)
+      mongoid (~> 2.0.0.beta.20)
+      uuid (~> 2.3.1)
+    vidibus-validate_uri (0.1.4)
+      rails (~> 3.0.0)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  rack-test
+  rails (~> 3.0.0)
+  rake
+  rr
+  rspec
+  vidibus-api
+  vidibus-resource!
+  vidibus-service
+  vidibus-uuid

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andre Pankratz
+
+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.rdoc

@@ -0,0 +1,7 @@
+= vidibus-resource
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2011 Andre Pankratz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+require "rspec/core/rake_task"
+
+Rspec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rcov = true
+  t.rcov_opts = ["--exclude", "^spec,/gems/"]
+end
+
+Rake::RDocTask.new do |rdoc|
+  require File.expand_path("../lib/vidibus/resource/version", __FILE__)
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "vidibus-resource #{Vidibus::Resource::VERSION}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.options << "--charset=utf-8"
+end

data/app/controllers/api/resources_controller.rb

@@ -0,0 +1,49 @@
+class Api::ResourcesController < ApiController
+  before_filter :ensure_klass
+  before_filter :find_instance
+
+  # Creates resource consumer on provider.
+  def create
+    @instance.add_resource_consumer(params["service"])
+    render :json => {:resource => @instance.resourceable_hash}
+  end
+
+  # Updates resource on consumer.
+  def update
+    begin
+      @instance.update_resource_attributes(params["resource"])
+      render :nothing => true
+    rescue => e
+      Rails.logger.error 'Error while updating resource consumer: '+e.inspect
+      render :json => { :error => e }, :status => :bad_request
+    end
+  end
+
+  # Removes a resource consumer from provider
+  def destroy
+    if @instance.resource_provider?
+      @instance.remove_resource_consumer(params["service"])
+    else
+      # TODO
+    end
+    render :nothing => true
+  end
+
+  protected
+
+  def ensure_klass
+    begin
+      @klass = params[:klass].classify.constantize
+    rescue => e
+      render :json => { :error => e }, :status => :bad_request
+    end
+  end
+
+  def find_instance
+    result = @klass.where(:uuid => params[:uuid])
+    if @klass.new.respond_to?(:realm_uuid)
+      result.and(:realm_uuid => params[:realm])
+    end
+    @instance = result.first or render(:nothing => true, :status => :not_found)
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  post "/api/resources/:klass/:uuid" => "api/resources#create"
+  delete "/api/resources/:klass/:uuid" => "api/resources#destroy"
+  put "/api/resources/:klass/:uuid" => "api/resources#update"
+end

data/lib/vidibus/resource/consumer/mongoid.rb

@@ -0,0 +1,120 @@
+module Vidibus::Resource
+  module Consumer
+
+    class ConfigurationError < StandardError; end
+
+    module Mongoid
+      extend ActiveSupport::Concern
+
+      included do
+        include Vidibus::Uuid::Mongoid
+
+        field :resource_attributes, :type => Hash, :default => {}
+        field :uuid
+        index :uuid
+        validates :uuid, :uuid => true
+
+        before_create :add_resource_consumer
+        before_save :set_resource_attributes
+        before_destroy :remove_resource_consumer
+      end
+
+      # Registers this consumer with provider.
+      def add_resource_consumer
+        response = resource_provider.post("/api/resources/#{self.class.to_s.tableize}/#{uuid}")
+        resource = response["resource"]
+        self.resource_attributes = resource
+        set_resource_attributes(true)
+        true # ensure true!
+      end
+
+      # Removes this consumer from provider.
+      def remove_resource_consumer
+        resource_provider.delete("/api/resources/#{self.class.to_s.tableize}/#{uuid}")
+        true # ensure true!
+      end
+
+      # Updates resource attributes.
+      # TODO: Update only data that has been changed.
+      def update_resource_attributes(data)
+        update_attributes(:resource_attributes => data)
+      end
+
+      # Returns a resource provider service.
+      def resource_provider
+        @resource_provider ||= begin
+          service = self.class.instance_variable_get("@resource_provider") or
+            raise ConfigurationError.new("No resource provider has been defined. Call #{self.class}.resource_provider(service, realm)")
+          realm = self.class.instance_variable_get("@resource_realm") or
+            raise ConfigurationError.new("No resource realm has been defined. Call #{self.class}.resource_realm(realm)")
+          ::Service.discover(service, realm)
+        end
+      end
+
+      protected
+
+      # Populates attributes of instance from
+      # received resource_attributes hash.
+      def set_resource_attributes(force = false)
+        if resource_attributes_changed? or force == true
+          for key, value in resource_attributes
+            send("#{key}=", value)
+          end
+        end
+        true # ensure true!
+      end
+
+      # Defines attributes of resource_attributes hash as
+      # methods on consumer instance.
+      def method_missing(name, *args, &block)
+        if name.to_s.match(/(.+)\=$/)
+          writer = true
+          attribute = $1
+          name = "#{attribute}="
+        else
+          attribute = name.id2name
+        end
+        if resource_attributes and (value = resource_attributes[attribute])
+          self.class.class_eval do
+            field attribute.to_sym # Mongoid field
+          end
+          if writer
+            send(name, *args)
+          else
+            send("#{attribute}=", value)
+            send(name)
+          end
+        else
+          super
+        end
+      end
+
+      module ClassMethods
+
+        # Sets up resource provider service type and realm.
+        def resource_provider(service, realm = nil)
+          @resource_provider = service
+          resource_realm(realm) if realm
+        end
+
+        # Sets up realm of resource.
+        def resource_realm(realm)
+          @resource_realm = realm
+        end
+
+        # Ensures that an instance with given conditions exists.
+        def ensure!(conditions)
+          self.where(conditions).first || self.create!(conditions)
+        end
+
+        # Remove all intances with given conditions.
+        def remove(conditions)
+          existing = self.where(conditions).to_a
+          for instance in existing
+            instance.destroy
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vidibus/resource/provider/mongoid.rb

@@ -0,0 +1,67 @@
+require "digest/md5"
+
+module Vidibus::Resource
+  module Provider
+    module Mongoid
+      extend ActiveSupport::Concern
+
+      included do
+        field :resource_consumers, :type => Array, :default => []
+        field :resourceable_hash_checksum, :type => Hash
+
+        before_update :update_resource_consumers
+        # before_destroy :destroy_resource_consumers
+      end
+
+      # Adds given resource consumer.
+      def add_resource_consumer(service_uuid)
+        list = resource_consumers || []
+        list << service_uuid
+        update_attributes(:resource_consumers => list.uniq)
+      end
+
+      # Removes given resource consumer.
+      def remove_resource_consumer(service_uuid)
+        self.resource_consumers.delete(service_uuid)
+        save
+      end
+
+      def resource_provider?
+        true
+      end
+
+      def resource_consumer?
+        false
+      end
+
+      # TODO: Handle attributes properly
+      def resourceable_hash
+        attributes
+      end
+
+      protected
+
+      # Update resource consumers if significant changes were made.
+      # TODO: Send changes only (the resourceable ones)!
+      # TODO: Perform update asynchronously
+      def update_resource_consumers
+        return unless resource_consumers and resource_consumers.any?
+        return unless changes.except("resource_consumers", "updated_at").any?
+
+        hash = resourceable_hash
+        hash_checksum = Digest::MD5.hexdigest(hash.to_s)
+        unless hash_checksum == resourceable_hash_checksum
+          self.resourceable_hash_checksum = hash_checksum
+          for service in resource_consumers
+            begin
+              ::Service.discover(service, realm_uuid).put("/api/resources/#{self.class.to_s.tableize}/#{uuid}", :body => {:resource => hash})
+            rescue => e
+              Rails.logger.error "An error occurred while updating resource consumer #{service}:"
+              Rails.logger.error e.inspect
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vidibus/resource/version.rb

@@ -0,0 +1,5 @@
+module Vidibus
+  module Resource
+    VERSION = "0.0.1"
+  end
+end

data/lib/vidibus/resource.rb

@@ -0,0 +1,2 @@
+require "resource/provider/mongoid"
+require "resource/consumer/mongoid"

data/lib/vidibus-resource.rb

@@ -0,0 +1,11 @@
+require "rails"
+require "vidibus-uuid"
+require "vidibus-secure"
+require "vidibus-api"
+
+$:.unshift(File.join(File.dirname(__FILE__), "vidibus"))
+require "resource"
+
+module Vidibus::Resource
+  class Engine < ::Rails::Engine; end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "rubygems"
+require "rspec"
+require "mongoid"
+require "rack/test"
+require "rr"
+# require "webmock/rspec"
+require "vidibus-resource"
+
+Mongoid.configure do |config|
+  name = "vidibus-resource_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+  config.logger = nil
+end
+
+RSpec.configure do |config|
+  # config.include WebMock
+  config.mock_with :rr
+  config.before(:each) do
+    Mongoid.master.collections.select {|c| c.name !~ /system/}.each(&:drop)
+  end
+end

data/spec/vidibus/resource/consumer/mongoid_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+class Model
+  include Mongoid::Document
+  include Vidibus::Resource::Consumer::Mongoid
+end
+
+describe "Vidibus::Resource::Consumer::Mongoid" do
+
+  let(:model) do
+    Model.new.tap do |m|
+      m.resource_attributes = {"name" => "Jenny"}
+    end
+  end
+
+  describe "attributes" do
+    it "should be readable" do
+      model.name.should eql("Jenny")
+    end
+
+    it "should be writable" do
+      model.name = "Sara"
+      model.name.should eql("Sara")
+    end
+
+    it "should be persistent" do
+      stub(model).add_resource_consumer
+      stub(model).set_resource_attributes
+      model.save
+      model.update_attributes!({:name => "Sara"})
+      model.reload
+      model.name.should eql("Sara")
+    end
+  end
+end

data/vidibus-resource.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/vidibus/resource/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "vidibus-resource"
+  s.version     = Vidibus::Resource::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["André Pankratz"]
+  s.email       = ["andre@vidibus.com"]
+  s.homepage    = "https://github.com/vidibus/vidibus-resource"
+  s.summary     = "Provides handling of remote resources"
+  s.description = "Allows creation of proxy objects of remote resources on distributed applications."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "vidibus-resource"
+
+  s.add_dependency "rails", "~> 3.0.0"
+  s.add_dependency "vidibus-uuid"
+  s.add_dependency "vidibus-service"
+  s.add_dependency "vidibus-api"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rake", ">= 0"
+  s.add_development_dependency "rspec", ">= 0"
+  s.add_development_dependency "rack-test", ">= 0"
+  s.add_development_dependency "rr", ">= 0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification 
+name: vidibus-resource
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Andr\xC3\xA9 Pankratz"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: vidibus-uuid
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: vidibus-service
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: vidibus-api
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: Allows creation of proxy objects of remote resources on distributed applications.
+email: 
+- andre@vidibus.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- app/controllers/api/resources_controller.rb
+- config/routes.rb
+- lib/vidibus-resource.rb
+- lib/vidibus/resource.rb
+- lib/vidibus/resource/consumer/mongoid.rb
+- lib/vidibus/resource/provider/mongoid.rb
+- lib/vidibus/resource/version.rb
+- spec/spec_helper.rb
+- spec/vidibus/resource/consumer/mongoid_spec.rb
+- vidibus-resource.gemspec
+has_rdoc: true
+homepage: https://github.com/vidibus/vidibus-resource
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: vidibus-resource
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides handling of remote resources
+test_files: []
+