ThreeStore 0.0.1.a → 0.0.1.b

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 tmp/*
+ThreeStore.yml

data/README.rdoc

@@ -5,7 +5,34 @@ http://travis-ci.org/cowmanifestation/ThreeStore.png ({More info}[http://travis-
 
 == Tutorial
 
-TODO
+To store something on s3:
+
+Perhaps you are storing your s3 secret access key id and secret access key as environment variables - you can access them like this:
+
+  @store = ThreeStore.new(ENV['S3_KEY'], ENV['S3_SECRET'], 'my-bucket')
+
+If you are storing aforementioned credentials in a yaml file:
+
+  @yaml = 'path_to_my_yaml_file.yml'
+  @store = ThreeStore.new(@yaml[:access_key_id], @yaml[:secret_access_key], 'my-bucket')
+
+To upload a file, use ThreeStore#store_on_s3:
+
+  @store.store_on_s3(:url => 'http://example.com/assets/picture.png', :key => 'picture.png', :content_type => 'image/png', :access => 'public-read')
+
+Options to pass to +store_on_s3+: 
+  * :url, the url or path from which to fetch the file 
+  * :key, the that you wish your object to have on s3
+  * :content_type (optional) - the content type will be inferred from the file extension, but it can be passed in if needed
+  * :access (optional) - Default access is private, but can be set to 'public-read' and maybe even 'public-write'
+  
+(For more information on access level options, look in the Amazon S3 docs: http://aws.amazon.com/documentation)
+
+This will return your file's new location on s3:
+
+  => 'http://s3.amazonaws.com/my-bucket/picture.png'
+
+The destination path is constructed thus: http://s3.amazonaws.com/ + bucket name + key
 
 == FAQ
 

data/lib/ThreeStore.rb

@@ -11,28 +11,20 @@ class ThreeStore
 
   # Options: url (required),
   #          content_type,
-  #          access_level
+  #          access_level,
+  #          key (destination on s3)
+
   def store_on_s3(options)
     # Deleting :url from options because we don't want it in the options that we pass to s3
     # and removing some characters that aren't allowed in urls
     url = options.delete(:url).gsub(/ /, '%20').gsub(/\^/, '%5E')
     file = open(url)
+    
+    key = options.delete(:key)
 
-    key = create_key(url, file)
-
-    AWS::S3::S3Object.store(key, file, @bucket, :access => options[:access], :content_type => options[:content_type])
+    AWS::S3::S3Object.store(key, file, @bucket, options)
 
     # Return location on s3
     "http://s3.amazonaws.com/" + @bucket + "/" + key
   end
-
-  def create_key(url, file)
-    key = CGI.escape(url.gsub(/http:\/\//, ''))
-    file_content = file.read
-
-    digest = Digest::MD5.hexdigest(file_content)
-    extname = File.extname(url)
-
-    key.gsub(extname, "-#{digest}#{extname}")
-  end
 end

data/lib/ThreeStore/version.rb

@@ -1,3 +1,3 @@
 module Threestore
-  VERSION = "0.0.1.a"
+  VERSION = "0.0.1.b"
 end

data/spec/lib/ThreeStore_spec.rb

@@ -1,43 +1,37 @@
 require 'spec_helper'
+require 'yaml'
 
 describe ThreeStore do
-  
   before(:all) do
-    @test_bucket = 'hedgeye-ent-bucket'
-    @store = ThreeStore.new(ENV['S3_KEY'], ENV['S3_SECRET'], @test_bucket)
-    @url = "http://www2.hedgeye.com/assets/hedgeye-ui/button-sprite.png"
-    @s3_object_path = @store.store_on_s3(:url => @url, :content_type => 'image/png', :access => 'public-read')
+    @yaml = YAML.load_file('ThreeStore.yml')
+    @test_bucket = @yaml[:test_bucket]
+    @store = ThreeStore.new(@yaml[:access_key_id], @yaml[:secret_access_key], @test_bucket)
   end
 
-#  after(:all) do
-#    AWS::S3::Bucket.find(@test_bucket).clear
-#  end
+  after(:all) do
+    AWS::S3::Bucket.find(@test_bucket).clear
+  end
 
   it "should establish a connection with s3" do
     AWS::S3::Base.connected?.should be_true
   end
 
   it "should put a given file on s3" do
-    # TODO: test with this url (a quotemedia chart) - it has some issues
-    # url = "http://app.quotemedia.com/quotetools/getChart.go?webmasterId=98924&symbol=COMP&chsym=Nasdaq%20Comp&chscale=5d&chtype=AreaChart&chfrmon=on&chfrm=ffffff&chbdron=on&chbdr=cccccc&chbg=ffffff&chbgch=ffffff&chln=465665&chfill=1B57AA&chfill2=c0c9d2&chgrdon=on&chgrd=cccccc&chton=on&chtcol=000000&chxyc=111111&chpcon=on&chpccol=ee0000&chmrg=2&chhig=250&chwid=380"
-
-    open(@s3_object_path).read.should == open(@url).read
-  end
-
-  it "should add an md5 hexdigest to the key" do
-    file_content = open(@url).read
-    digest = Digest::MD5.hexdigest(file_content)
+    url = @yaml[:test_image]
+    s3_object_path = @store.store_on_s3(:url => url, :key => "hedgeye-button-sprite.png", :access => 'public-read')
 
-    @s3_object_path.should match(digest)
+    open(s3_object_path).read.should == open(url).read
   end
 
   # Regression test because quotemedia urls have spaces and carets for some reason.
-  it "should remove spaces and carets from the given url" do
-    url = "http://app.quotemedia.com/quotetools/getChart.go?webmasterId=500&symbol=^DOW&chsym=^DOW Comp&chscale=5d&chtype=AreaChart&chfrmon=on&chfrm=ffffff&chbdron=on&chbdr=cccccc&chbg=ffffff&chbgch=ffffff&chln=465665&chfill=1B57AA&chfill2=c0c9d2&chgrdon=on&chgrd=cccccc&chton=on&chtcol=000000&chxyc=111111&chpcon=on&chpccol=ee0000&chmrg=2&chhig=250&chwid=380"
+  it "should be able to prcess urls with spaces and carets" do
+    url = "http://app.quotemedia.com/quotetools/getChart.go?webmasterId=500&symbol=^DOW&chsym=^DOW Comp" +
+          "&chscale=5d&chtype=AreaChart&chfrmon=on&chfrm=ffffff&chbdron=on&chbdr=cccccc&chbg=ffffff" +
+          "&chbgch=ffffff&chln=465665&chfill=1B57AA&chfill2=c0c9d2&chgrdon=on&chgrd=cccccc&chton=on" +
+          "&chtcol=000000&chxyc=111111&chpcon=on&chpccol=ee0000&chmrg=2&chhig=250&chwid=380"
 
-    s3_object_path = @store.store_on_s3(:url => url, :content_type => 'image/png', :access => 'public-read')
+    s3_object_path = @store.store_on_s3(:url => url, :key => "quotemedia_chart.png", :content_type => 'image/png', :access => 'public-read')
 
-    s3_object_path.should_not match(/ /)
-    s3_object_path.should_not match(/\^/)
+    open(s3_object_path).should be_true
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: ThreeStore
 version: !ruby/object:Gem::Version 
-  hash: 46
+  hash: 47
   prerelease: 6
   segments: 
   - 0
   - 0
   - 1
-  - a
-  version: 0.0.1.a
+  - b
+  version: 0.0.1.b
 platform: ruby
 authors: 
 - Chenoa Siegenthaler
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-02 00:00:00 Z
+date: 2011-12-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws-s3