cloudstrg 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,3 @@
+= Cloudstrg
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cloudstrg'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/cloudstrg/cloudstrg.rb

@@ -0,0 +1,122 @@
+module CloudStrg
+  
+  ##
+  # This method returns an instance of an specified driver
+  #
+  # Params: the "params" variable must contain the following fields
+  #   type: the name of the selected driver.
+  #   
+  # Returns: 
+  #   An instance of the specified driver.
+  #
+  def self.new_driver params
+    type = params[:type]
+    require "#{type}strg/#{type}strg"
+    return Kernel.const_get("#{type.capitalize}Strg").new(params)
+  end
+
+  
+  ##
+  # This method returns a list of the available storage drivers.
+  #
+  def self.driver_list
+    l = Cloudstrglist.find(:all)
+    l.sort!
+    return l
+  end
+
+  ###
+  # This class must be inherited by every single driver definition in order to preserve 
+  # the coherence between them.
+  #
+  class CloudStorage
+  
+    ###
+    # This method performs the previous configuration that the current driver needs to work.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   redirect: the name of the selected driver,
+    #   username: the name of the selected driver,
+    #   session: the name of the selected driver.
+    #   
+    # Returns: 
+    #   This method returns two parameters:
+    #     session: the session variable with the new parameters added,
+    #     uri: the uri where the user will allow the application to use the desired service, 
+    #       or false if the configuration was completed successfully.
+    #
+    def config params
+      raise NotImplementedError
+    end
+  
+    ###
+    # This method performs the creation of a file.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   filename: the name of the file to create,
+    #   file_content: the content of the file.
+    #   
+    # Returns: 
+    #   This method returns true if the operation success, otherwise it returns false.
+    #
+    def create_file params
+      raise NotImplementedError
+    end
+
+    #def create_folder params
+    #  raise NotImplementedError
+    #end
+
+    ###
+    # This method performs the request to obtain a desired file content
+    #
+    # Params: the "params" variable must contain the following fields
+    #   fileid: the id of the selected file.
+    #   
+    # Returns: 
+    #   This method returns three parameters:
+    #     filename: the name of the file,
+    #     fileid: the id of the file, 
+    #     file_content: the content of the file.
+    #
+    def get_file params
+      raise NotImplementedError
+    end
+  
+    ###
+    # This method performs the update of a file.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   filename: the name of the file to edit,
+    #   fileid: the id of the file, 
+    #   file_content: the content of the file.
+    #   
+    # Returns: 
+    #   This method returns true if the operation success, otherwise it returns false.
+    #
+    def update_file params
+      raise NotImplementedError
+    end
+
+    ###
+    # This method performs the remove of a file.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   fileid: the id of the file.
+    #
+    def remove_file params
+      raise NotImplementedError
+    end
+
+    ###
+    # This method returns a list of the available files created by the application.
+    #   
+    # Returns: 
+    #   This method returns a list of tuples, containing: [[filename, fileid], ...] 
+    #
+    def list_files
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/cloudstrg/cloudstrg.rb~

@@ -0,0 +1,122 @@
+module CloudStrg
+  
+  ##
+  # This method returns an instance of an specified driver
+  #
+  # Params: the "params" variable must contain the following fields
+  #   type: the name of the selected driver.
+  #   
+  # Returns: 
+  #   An instance of the specified driver.
+  #
+  def self.new_driver params
+    type = params[:type]
+    require "#{type}strg"
+    return Kernel.const_get("#{type.capitalize}Strg").new(params)
+  end
+
+  
+  ##
+  # This method returns a list of the available storage drivers.
+  #
+  def self.driver_list
+    l = Cloudstrglist.find(:all)
+    l.sort!
+    return l
+  end
+
+  ###
+  # This class must be inherited by every single driver definition in order to preserve 
+  # the coherence between them.
+  #
+  class CloudStorage
+  
+    ###
+    # This method performs the previous configuration that the current driver needs to work.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   redirect: the name of the selected driver,
+    #   username: the name of the selected driver,
+    #   session: the name of the selected driver.
+    #   
+    # Returns: 
+    #   This method returns two parameters:
+    #     session: the session variable with the new parameters added,
+    #     uri: the uri where the user will allow the application to use the desired service, 
+    #       or false if the configuration was completed successfully.
+    #
+    def config params
+      raise NotImplementedError
+    end
+  
+    ###
+    # This method performs the creation of a file.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   filename: the name of the file to create,
+    #   file_content: the content of the file.
+    #   
+    # Returns: 
+    #   This method returns true if the operation success, otherwise it returns false.
+    #
+    def create_file params
+      raise NotImplementedError
+    end
+
+    #def create_folder params
+    #  raise NotImplementedError
+    #end
+
+    ###
+    # This method performs the request to obtain a desired file content
+    #
+    # Params: the "params" variable must contain the following fields
+    #   fileid: the id of the selected file.
+    #   
+    # Returns: 
+    #   This method returns three parameters:
+    #     filename: the name of the file,
+    #     fileid: the id of the file, 
+    #     file_content: the content of the file.
+    #
+    def get_file params
+      raise NotImplementedError
+    end
+  
+    ###
+    # This method performs the update of a file.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   filename: the name of the file to edit,
+    #   fileid: the id of the file, 
+    #   file_content: the content of the file.
+    #   
+    # Returns: 
+    #   This method returns true if the operation success, otherwise it returns false.
+    #
+    def update_file params
+      raise NotImplementedError
+    end
+
+    ###
+    # This method performs the remove of a file.
+    #
+    # Params: the "params" variable must contain the following fields
+    #   fileid: the id of the file.
+    #
+    def remove_file params
+      raise NotImplementedError
+    end
+
+    ###
+    # This method returns a list of the available files created by the application.
+    #   
+    # Returns: 
+    #   This method returns a list of tuples, containing: [[filename, fileid], ...] 
+    #
+    def list_files
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/cloudstrg/version.rb

@@ -0,0 +1,3 @@
+module Cloudstrg
+  VERSION = "0.0.1"
+end

data/lib/cloudstrg.rb

@@ -0,0 +1,2 @@
+module Cloudstrg
+end

data/lib/generators/cloudstrg_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CloudstrgGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S%6N")
+  end
+
+  def create_model_file
+    template "cloudstrglist.rb", "app/models/cloudstrglist.rb"
+    template "cloudstrguser.rb", "app/models/cloudstrguser.rb"
+    migration_template "create_cloudstrglists.rb", "db/migrate/create_cloudstrglists.rb"
+    migration_template "create_cloudstrgusers.rb", "db/migrate/create_cloudstrgusers.rb"
+  end
+end
+

data/lib/generators/cloudstrg_generator.rb~

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CloudstrgGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S%6N")
+  end
+
+  def create_model_file
+    template "cloudstrglist.rb", "app/models/cloudstrglist.rb"
+    template "cloudstrguser.rb", "app/models/cloudstrguser.rb"
+    migration_template "create_cloudstrglists.rb", "db/migrate/create_cloudstrglists.rb"
+    migration_template "create_cloudstrgusers.rb", "db/migrate/create_cloudstrguser.rb"
+  end
+end
+

data/lib/tasks/cloudstrg_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cloudstrg do
+#   # Task goes here
+# end

data/lib/templates/cloudstrgdata.rb~

@@ -0,0 +1,3 @@
+class Person < ActiveRecord::Base
+  attr_accessible :name
+end

data/lib/templates/cloudstrglist.rb

@@ -0,0 +1,3 @@
+class Cloudstrglist < ActiveRecord::Base
+  attr_accessible :plugin_name
+end

data/lib/templates/cloudstrglist.rb~

@@ -0,0 +1,3 @@
+class CloudstrgList < ActiveRecord::Base
+  attr_accessible :plugin_name
+end

data/lib/templates/cloudstrguser.rb

@@ -0,0 +1,3 @@
+class Cloudstrguser < ActiveRecord::Base
+  attr_accessible :userid
+end

data/lib/templates/create_cloudstrglist.rb~

@@ -0,0 +1,13 @@
+class CreateCloudstrglists < ActiveRecord::Migration
+  def up
+    create_table :cloudstrglists do |t|
+      t.string :plugin_name
+
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :cloudstrglist
+  end
+end

data/lib/templates/create_cloudstrglists.rb

@@ -0,0 +1,13 @@
+class CreateCloudstrglists < ActiveRecord::Migration
+  def up
+    create_table :cloudstrglists do |t|
+      t.string :plugin_name
+
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :cloudstrglists
+  end
+end

data/lib/templates/create_cloudstrgusers.rb

@@ -0,0 +1,13 @@
+class CreateCloudstrgusers < ActiveRecord::Migration
+  def up
+    create_table :cloudstrgusers do |t|
+      t.string :username
+
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :cloudstrgusers
+  end
+end

data/test/cloudstrg_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CloudstrgTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Cloudstrg
+  end
+end