mbulat-rubyprot 0.5.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Bulat
+
+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,14 @@
+= rubyprot
+
+Simple library to aid in object serialization and messaging via Rubys Marshal
+
+== An Overview
+
+Rubyprot helps with the task of using Ruby's marshal utility to package objects into binary format for storage and messaging. Marshal's speed and simplicity make it perfect for Ruby centric applications that require disconnected object sharing.
+
+Rubyprot currently allows for the utilization of Amazon's S3 servers for storage and retrieval of marshaled data.
+
+
+== Copyright
+
+Copyright (c) 2009 Michael Bulat. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rubyprot"
+    gem.summary = "Simple library to aid in object serialization and messaging via Rubys Marshal"
+    gem.email = "mbulat@facesmedia.com"
+    gem.homepage = "http://github.com/mbulat/rubyprot"
+    gem.authors = ["Michael Bulat"]
+    gem.add_dependency('aws-s3', '>= 0.5.1')
+    gem.add_dependency('mechanize', '>= 0.8.5')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rubyprot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/rubyprot.rb

@@ -0,0 +1,97 @@
+# == About rubyprot.rb
+#
+# All of Rubyprot's various part are loaded when you use <tt>require 'rubyprot'</tt>.
+#
+# * rubyprot/serializer.rb: serializes objects via marshal into file
+# * rubyprot/deserializer.rb: deserializes files via marshal into objects
+# 
+# Created by Michael Bulat on 2009-07-23.
+# Copyright 2009 Michael Bulat. All rights reserved.
+# 
+require 'rubyprot/serializer'
+require 'rubyprot/deserializer'
+require 'rubyprot/storage'
+
+module Rubyprot
+  class << self
+    # top level path where temporary files will be placed
+    attr_accessor :dump_path
+    # amazon s3 bucket for file storage
+    attr_accessor :amazon_bucket_name
+    # amazon access key
+    attr_accessor :amazon_access_key_id
+    # amazon secret key
+    attr_accessor :amazon_secret_access_key  
+    
+    #Allows block configuration of Rubyprot attributes
+    #
+    #   Rubyprot.configure do |config|
+    #     config.dump_path = "my_folder/my_path"
+    #     config.amazon_bucket_name = "my_bucket"
+    #     config.amazon_access_key_id = "my_key"
+    #     config.amazon_secret_access_key = "my_access_key"
+    #   end    
+    def configure
+      yield self
+    end
+    
+    # Marshals any object into a file named after the object class and stores 
+    # the file in the folder specified by the +dump_path+ attribute.
+    # Returns the name of the file.
+    #
+    #   >> Rubyprot.serialize(object)
+    #   => "Object"
+    def serialize(object)
+      return Rubyprot::Serializer.serialize(object)
+    end
+
+    # Unmarshals named file from the folder specified 
+    # by the +dump_path+ attribute. 
+    # Returns the object.
+    #
+    #   >> Rubyprot.deserialize("Object")
+    #   => #<Object:0x18a30d0>
+    def deserialize(name)
+      return Rubyprot::Deserializer.deserialize(name)
+    end
+
+    # Downloads file from amazon 
+    # using +amazon_bucket_name+, +amazon_access_key_id+, +amazon_secret_access_key+
+    # attributes to +dump_path+. 
+    #
+    # Returns the file name for use to deserialize object
+    #
+    #   Rubyprot.deserialize(Rubyprot.aws_download("path_to_data", "Object"))
+    def aws_download(location, name)
+      return Rubyprot::Storage.aws_download(location, name)
+    end
+
+    # Downloads file from amazon using
+    # using +amazon_bucket_name+, +amazon_access_key_id+, +amazon_secret_access_key+
+    # to given +location+ on s3.
+    #
+    # Returns HTTP status
+    #
+    #    Rubyprot.aws_upload("path_to_data", Rubyprot.serialize(conversations)) 
+    def aws_upload(location, name)
+      return Rubyprot::Storage.aws_upload(location, name)
+    end
+    
+    def dump_path=(value) #:nodoc: 
+      begin
+        unless value.nil?
+          unless File.directory?(value)
+            FileUtils.mkdir(value)
+          end      
+          if File.directory?(value)
+            @dump_path = value
+          end
+        else
+          @dump_path = nil
+        end
+      rescue
+        raise "Dump path directory invalid. Please check your configuration."
+      end
+    end
+  end
+end

data/lib/rubyprot/deserializer.rb

@@ -0,0 +1,11 @@
+module Rubyprot
+  class Deserializer #:nodoc:
+    def self.deserialize(name)
+      raise "dump_path attribute must be set" unless Rubyprot.dump_path
+      
+      File.open(Rubyprot.dump_path + "/" + name) do |f|
+        Marshal.load(f)
+      end
+    end
+  end
+end

data/lib/rubyprot/serializer.rb

@@ -0,0 +1,23 @@
+module Rubyprot
+  class Serializer #:nodoc:
+    def self.serialize(object)
+      raise "Dump path attribute must be set" if Rubyprot.dump_path.nil?
+      
+      if object.is_a?(Array) then
+        if object[0].class.name.rindex("s") == object[0].class.name.length - 1
+          plural_string = "es"
+        else
+          plural_string = "s"
+        end
+        file_name = object[0].class.name + plural_string
+      else       
+        file_name = object.class.name
+      end
+        file = File.new(Rubyprot.dump_path + "/" + file_name, "w")
+        file.write(Marshal.dump(object))
+        file.close    
+      
+      file_name
+    end
+  end
+end

data/lib/rubyprot/storage.rb

@@ -0,0 +1,48 @@
+require 'aws/s3'
+require 'mechanize'
+  
+module Rubyprot 
+  class Storage #:nodoc:
+    def self.aws_download(location, name)
+      raise "amazon_bucket_name attribute must be set" unless Rubyprot.amazon_bucket_name
+      raise "amazon_secret_access_key attribute must be set" unless Rubyprot.amazon_secret_access_key
+      raise "amazon_access_key_id attribute must be set" unless Rubyprot.amazon_access_key_id
+
+        AWS::S3::Base.establish_connection!(
+          :access_key_id     => Rubyprot.amazon_access_key_id,
+          :secret_access_key => Rubyprot.amazon_secret_access_key
+        )
+      
+        marshalled_data = AWS::S3::S3Object.find location + "/" + name, Rubyprot.amazon_bucket_name
+        url = URI.parse(marshalled_data.url)
+      
+        agent = WWW::Mechanize.new
+        marshalled_file = agent.get(url)
+        marshalled_file.save_as(Rubyprot.dump_path + '/' + name)
+        
+        name
+    end
+
+    def self.aws_upload(location, name)
+      raise "amazon_bucket_name attribute must be set" unless Rubyprot.amazon_bucket_name
+      raise "amazon_secret_access_key attribute must be set" unless Rubyprot.amazon_secret_access_key
+      raise "amazon_access_key_id attribute must be set" unless Rubyprot.amazon_access_key_id
+
+      AWS::S3::Base.establish_connection!(
+        :access_key_id     => Rubyprot.amazon_access_key_id,
+        :secret_access_key => Rubyprot.amazon_secret_access_key
+      )
+      
+      file = File.open(Rubyprot.dump_path + "/" + name)
+      
+      AWS::S3::S3Object.store(location + "/" + name, 
+                              file, 
+                              Rubyprot.amazon_bucket_name,
+                              :cache_control => "no-store, no-cache, must-revalidate, post-check=0, pre-check=0")
+    end
+    
+  end
+end
+
+
+

data/rubyprot.gemspec

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rubyprot}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Bulat"]
+  s.date = %q{2009-07-28}
+  s.email = %q{mbulat@facesmedia.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rubyprot.rb",
+     "lib/rubyprot/deserializer.rb",
+     "lib/rubyprot/serializer.rb",
+     "lib/rubyprot/storage.rb",
+     "rubyprot.gemspec",
+     "test/configuration_test.rb",
+     "test/deserializer_test.rb",
+     "test/serializer_test.rb",
+     "test/storage_test.rb",
+     "test/test_files/models/test_class.rb",
+     "test/test_files/models/test_class_two.rb",
+     "test/test_files/models/test_module.rb",
+     "test/test_files/test_data/TestClass",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/mbulat/rubyprot}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simple library to aid in object serialization and messaging via Rubys Marshal}
+  s.test_files = [
+    "test/configuration_test.rb",
+     "test/deserializer_test.rb",
+     "test/serializer_test.rb",
+     "test/storage_test.rb",
+     "test/test_files/models/test_class.rb",
+     "test/test_files/models/test_class_two.rb",
+     "test/test_files/models/test_module.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<aws-s3>, [">= 0.5.1"])
+      s.add_runtime_dependency(%q<mechanize>, [">= 0.8.5"])
+    else
+      s.add_dependency(%q<aws-s3>, [">= 0.5.1"])
+      s.add_dependency(%q<mechanize>, [">= 0.8.5"])
+    end
+  else
+    s.add_dependency(%q<aws-s3>, [">= 0.5.1"])
+    s.add_dependency(%q<mechanize>, [">= 0.8.5"])
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class ConfigurationTest < Test::Unit::TestCase  
+  should "be done with a block" do
+    Rubyprot.configure do |config|
+      config.dump_path = "test/test_files/my_path"
+      config.amazon_bucket_name = "my_bucket"
+      config.amazon_access_key_id = "my_key"
+      config.amazon_secret_access_key = "my_access_key"
+    end
+
+    assert_equal "test/test_files/my_path", Rubyprot.dump_path
+    assert_equal "my_bucket", Rubyprot.amazon_bucket_name
+    assert_equal "my_key", Rubyprot.amazon_access_key_id
+    assert_equal "my_access_key", Rubyprot.amazon_secret_access_key
+
+    Rubyprot.configure do |config|
+      config.dump_path = nil
+      config.amazon_bucket_name = nil
+      config.amazon_access_key_id = nil
+      config.amazon_secret_access_key = nil
+    end
+  end
+  
+  should "raise error if bad path supplied" do
+    assert_raise RuntimeError do
+      Rubyprot.configure do |config|
+        config.dump_path = "/this/is/a/bad/path"
+      end
+
+    end
+  end
+end

data/test/deserializer_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class DeserializerTest < Test::Unit::TestCase
+  context "Rubyprot deserializer" do
+    setup do
+      @test_file_path = "test/test_files/test_data"
+      @object_name = "TestClass"
+      Rubyprot.configure do |config|
+        Rubyprot.dump_path = @test_file_path
+      end
+
+    end
+    
+    should "should unmarshal file by name into working object" do
+      
+      assert_nothing_raised do
+        my_object = Rubyprot.deserialize(@object_name)
+
+        assert_kind_of TestClass, my_object
+
+        assert_equal my_object.test_method, 'this method returned'
+        assert_nothing_raised do
+          my_object.test_attr = 'hello world'
+        end
+        assert_equal my_object.test_attr, 'hello world'
+      end
+      
+    end    
+
+  end
+
+end

data/test/serializer_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class SerializerTest < Test::Unit::TestCase
+  context "Rubyprot serializer" do
+    setup do
+      @test_file_path = "test/test_files/dump"
+      @object_name = "TestClass"
+    end
+    
+    teardown do
+      unless Rubyprot.dump_path.nil?
+        FileUtils.rmtree(Rubyprot.dump_path)
+        Rubyprot.dump_path = nil
+      end
+    end    
+    
+    should "raise error if dump path not set" do
+      assert_raise RuntimeError do
+        object = TestClass.new      
+        Rubyprot.serialize(object)
+      end
+    end
+    
+    should "create marshalled file from object" do
+      Rubyprot.configure do |config|
+        Rubyprot.dump_path = @test_file_path
+      end
+      
+      object = TestClass.new      
+      Rubyprot.serialize(object)
+      
+      assert_nothing_raised do
+        file = File.open(@test_file_path + "/" + @object_name)
+      end
+      
+      FileUtils.rmtree(Rubyprot.dump_path)
+    end    
+
+    should "have valid marshaled file" do
+      Rubyprot.configure do |config|
+        Rubyprot.dump_path = @test_file_path
+      end
+      
+      object = TestClass.new
+      Rubyprot.serialize(object)
+      
+      assert_nothing_raised do
+        file = File.open(@test_file_path + "/" + @object_name)
+        new_object = Marshal.load(file)
+        file.close
+
+        assert_equal new_object.test_method, 'this method returned'
+        assert_nothing_raised do
+          new_object.test_attr = 'hello world'
+        end
+        assert_equal new_object.test_attr, 'hello world'
+      end
+    end
+    
+    should "return a string name" do
+      Rubyprot.configure do |config|
+        Rubyprot.dump_path = @test_file_path
+      end
+      
+      object = TestClass.new
+      name = Rubyprot.serialize(object)
+      
+      assert_kind_of String, name
+    end
+
+    should "return array string name for array" do
+      Rubyprot.configure do |config|
+        Rubyprot.dump_path = @test_file_path
+      end
+      
+      array = Array.new
+      object = TestClass.new
+      array[0] = object
+      array[1] = object
+      
+      name = Rubyprot.serialize(array)
+      
+      assert_kind_of String, name
+    end
+  end
+  
+
+end

data/test/storage_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class StorageTest < Test::Unit::TestCase
+  context "Rubyprot Storage" do
+    setup do
+      @location = "marshalled_data/"
+      @object_name = "TestClass"
+      Rubyprot.configure do |config|
+        Rubyprot.dump_path = "test/test_files/test_data"
+        #change these values to run the tests
+        #config.amazon_bucket_name = "YOUR_BUCKET"
+        #config.amazon_access_key_id = "YOUR_KEY"
+        #config.amazon_secret_access_key = "YOUR_SECRET"
+      end
+
+    end
+    
+    if Rubyprot.amazon_bucket_name && Rubyprot.amazon_access_key_id && Rubyprot.amazon_secret_access_key
+
+      should "should upload file to amazon and return true" do
+        assert_nothing_raised do
+          assert Rubyprot.aws_upload(@location, @object_name)
+        end      
+      end
+    
+      should "should load file from amazon" do
+        assert_nothing_raised do
+          assert Rubyprot.aws_download(@location, @object_name)
+        end
+      end    
+
+    else
+      should "skip tests" do
+        assert true
+      end
+    end
+  end
+
+end

data/test/test_files/models/test_class.rb

@@ -0,0 +1,9 @@
+require 'test_files/models/test_module'
+
+class TestClass < TestModule::TestClassThree
+  attr_accessor :test_attr
+    
+  def test_method
+    return 'this method returned'
+  end
+end

data/test/test_files/models/test_class_two.rb

@@ -0,0 +1,3 @@
+class TestClassTwo < TestClass
+
+end

data/test/test_files/models/test_module.rb

@@ -0,0 +1,4 @@
+module TestModule
+  class TestClassThree
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubyprot'
+require 'test_files/models/test_class'
+require 'test_files/models/test_class_two'
+require 'test_files/models/test_module'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: mbulat-rubyprot
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Michael Bulat
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.5
+    version: 
+description: 
+email: mbulat@facesmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rubyprot.rb
+- lib/rubyprot/deserializer.rb
+- lib/rubyprot/serializer.rb
+- lib/rubyprot/storage.rb
+- rubyprot.gemspec
+- test/configuration_test.rb
+- test/deserializer_test.rb
+- test/serializer_test.rb
+- test/storage_test.rb
+- test/test_files/models/test_class.rb
+- test/test_files/models/test_class_two.rb
+- test/test_files/models/test_module.rb
+- test/test_files/test_data/TestClass
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mbulat/rubyprot
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Simple library to aid in object serialization and messaging via Rubys Marshal
+test_files: 
+- test/configuration_test.rb
+- test/deserializer_test.rb
+- test/serializer_test.rb
+- test/storage_test.rb
+- test/test_files/models/test_class.rb
+- test/test_files/models/test_class_two.rb
+- test/test_files/models/test_module.rb
+- test/test_helper.rb