s3asy 0.1.0 → 0.1.1

data/README.rdoc

@@ -4,9 +4,18 @@ Rails gem for associating an s3 object with an active record model
 
 == Install
 
-  gem install robertoles-s3asy --source http://gems.github.com
+  gem install robertoles-s3asy --source http://gemcutter.org
+
+== Config
+
+Create a file /config/amazon_s3.yml in your rails application, with the following contents...
+
+  test:
+    access_key_id: your_access_key_id
+    secret_access_key: your_secret_access_key
+    bucket: your_default_bucket
   
-== Usage
+== Associate s3 object to active record usage
 
 You want to create an active record model 'product' which has an attribute 'image' which is an s3 object. First create a migration for your model and specify a string column for the image attribute followed by _name... 
 
@@ -23,21 +32,29 @@ You want to create an active record model 'product' which has an attribute 'imag
       drop_table :products
     end
   end
-  
-  
-Now you will need to specify your s3 credentials, to do this add the file /config/amazon_s3.yml
-
-  test:
-    access_key_id: your_access_key_id
-    secret_access_key: your_secret_access_key
     
     
 Finally create the association in your model, specifying the bucket on s3 the object is stored in...
 
   class Product < ActiveRecord::Base
-    has_s3object :image, :bucket => 'bucket'
+    has_s3object :image
   end
 
+The has_s3object method will accept the follow options as a hash...
+
+  :bucket => 'bucket_name' # will look for the object in this bucket instead of the default.
+
+
+== Search s3 objects in a bucket
+  
+You can search objects in an s3 bucket using the search function on the S3ObjectProxy class...
+
+  S3ObjectProxy.search('prefix_to_search_by')
+  # => [<AWS::S3::S3Object]
+
+This function takes an options parameter hash where you can provide a bucket to search in (which overrides the default set in the config file)
+
+  :bucket => 'not_the_default_bucket'
 
 == License
 

data/Rakefile

@@ -3,7 +3,12 @@ require 'rake'
 require 'spec/rake/spectask'
 require 'echoe'
 
-Echoe.new('s3asy', '0.1.0') do |p|
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ["-c"]
+  t.spec_files = FileList['spec/**/*.rb']
+end
+
+Echoe.new('s3asy', '0.1.1') do |p|
   p.description    = "Associate an s3 object to an active record model"
   p.url            = "http://github.com/robertoles/s3asy"
   p.author         = "Robert Oles"
@@ -12,9 +17,4 @@ Echoe.new('s3asy', '0.1.0') do |p|
   p.development_dependencies = ['aws-s3']
 end
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
-
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_opts = ["-c"]
-  t.spec_files = FileList['spec/**/*.rb']
-end
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/s3_object_proxy.rb

@@ -6,20 +6,39 @@ class S3ObjectProxy
   
   def initialize(options = {})
     @path = options[:path]
-    @bucket = options[:bucket]
     initialize_s3(options)
   end
   
+  def url
+    AWS::S3::S3Object.url_for(path, bucket, :authenticated => false)
+  end
+  
+  def self.search(prefix, options = {})
+    options = load_yaml().merge(options)
+    connect_to_s3(options)
+    AWS::S3::Bucket.objects(options[:bucket], :prefix => prefix)
+  end
+  
+  private
+  def self.load_yaml(options = {})
+    s3_config_path = S3ObjectProxy.const_defined?(:CONFIG_PATH) ? S3ObjectProxy.const_get(:CONFIG_PATH) : (RAILS_ROOT + '/config/amazon_s3.yml')
+    YAML.load_file(s3_config_path)[RAILS_ENV].symbolize_keys
+  end
+  
   def initialize_s3(options)
-    s3_config_path = options[:config_path] || (RAILS_ROOT + '/config/amazon_s3.yml')
-    s3_config = YAML.load_file(s3_config_path)[RAILS_ENV].symbolize_keys
-    AWS::S3::Base.establish_connection!(
-      :access_key_id => s3_config[:access_key_id],
-      :secret_access_key => s3_config[:secret_access_key]
-    )
+    options = S3ObjectProxy.load_yaml(options).merge(options)
+    S3ObjectProxy.connect_to_s3(options)
+    init_bucket(options)
   end
   
-  def url
-    AWS::S3::S3Object.url_for(path, bucket, :authenticated => false)
+  def init_bucket(options)
+    @bucket = options[:bucket]
+  end
+  
+  def self.connect_to_s3(options)
+    AWS::S3::Base.establish_connection!(
+      :access_key_id => options[:access_key_id],
+      :secret_access_key => options[:secret_access_key]
+    )
   end
 end

data/s3asy.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{s3asy}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert Oles"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: s3asy
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Robert Oles