redis_importer 0.1.0 → 1.0.0

data/lib/collections/S3_collection.rb

@@ -2,6 +2,8 @@ class S3Collection
   include GemConfigurator
   
   attr_accessor :files
+
+  # Instantiates and configures a S3Collection, using the s3_collection.yml configuration file.
   def initialize
     configure
     connection = AWS::S3::Base.establish_connection! @settings['connection']

data/lib/extensions/s3.rb

@@ -1,15 +1,17 @@
 module AWS
   module S3
+    # Methods extending the S3Object class provided by the aws-s3 gem.
     class S3Object
-      
-      def name
-        self.key
-      end
+      alias_method :name, :key
 
+      # Returns the class represented by the csv file.
+      #  person.csv => Person
       def to_class_name
         self.key.gsub('.csv','').capitalize
       end
 
+      # Copies the S3 Object to a local directory.
+      #   save_to('tmp/file.csv')
       def save_to(path)
         File.open(path,'w') do |file|
           S3Object.stream(self.key,self.bucket.name) do |chunk|

data/lib/generators/redis_importer/install/USAGE

@@ -2,7 +2,7 @@ Description:
     Installs the necessary configuration files based upon your file storage type. Currently only supports the file storage type 's3'.
     
 Example:
-    rails generate redis_import s3
+    rails generate redis_importer:install s3
 
     This will create:
         config/redis_importer.yml

data/lib/redis_importer/redis_importer.rb

@@ -5,6 +5,7 @@ module RedisImporter
     attr_reader :files, :commands, :errors
     attr_accessor :collection
 
+    # Instantiates and configures a RedisImporter object
     def initialize
       configure
       self.collection = Object::const_get("#{@settings[:storage_method].camelcase}Collection").new()
@@ -13,6 +14,7 @@ module RedisImporter
       self.commands = []
     end
     
+    # Converts each csv file in the collection to objects, which are then saved into the redis store.
     def import
       files.each do |file|
         begin

data/lib/redis_importer/version.rb

@@ -1,3 +1,3 @@
 module RedisImporter
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_importer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-09-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157611140 !ruby/object:Gem::Requirement
+  requirement: &2156986200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157611140
+  version_requirements: *2156986200
 - !ruby/object:Gem::Dependency
   name: redis_backed_model
-  requirement: &2157610640 !ruby/object:Gem::Requirement
+  requirement: &2156985700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2157610640
+  version_requirements: *2156985700
 - !ruby/object:Gem::Dependency
   name: gem_configurator
-  requirement: &2157610140 !ruby/object:Gem::Requirement
+  requirement: &2156985200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2157610140
+  version_requirements: *2156985200
 - !ruby/object:Gem::Dependency
   name: csv_to_object
-  requirement: &2164296380 !ruby/object:Gem::Requirement
+  requirement: &2157015180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164296380
+  version_requirements: *2157015180
 - !ruby/object:Gem::Dependency
   name: redis_pipeline
-  requirement: &2164295920 !ruby/object:Gem::Requirement
+  requirement: &2157014720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164295920
+  version_requirements: *2157014720
 - !ruby/object:Gem::Dependency
   name: aws-s3
-  requirement: &2164295460 !ruby/object:Gem::Requirement
+  requirement: &2157014260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,7 +77,7 @@ dependencies:
         version: 0.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *2164295460
+  version_requirements: *2157014260
 description: Creates objects, converts them to Redis commands and executes the redis
   commands.
 email: