jaxx 0.0.4 → 0.0.6

data/README.md

@@ -1,6 +1,6 @@
 # Jaxx
 
-TODO: Write a gem description
+Upload and Download files from S3.
 
 ## Installation
 
@@ -18,7 +18,58 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Upload
+```
+  jaxx-upload -h
+  jaxx [options]
+    -b, --bucket [BUCKET]
+    -k, --access-key [ACCESS_KEY]
+    -s [ACCESS_SECRET],
+    --access-secret
+    -f, --file [FILE]
+    -p, --privacy [PRIVACY]
+    -h, --help
+```
+
+### Download
+```
+  jaxx-download -h
+  jaxx [options]
+    -b, --bucket [BUCKET]
+    -k, --access-key [ACCESS_KEY]
+    -s [ACCESS_SECRET],
+    --access-secret
+    -f, --file [FILE]
+    -p, --privacy [PRIVACY]
+    -h, --help
+```
+
+## Examples
+
+### Upload from local machine
+```
+  jaxx-upload -b test-bucket -f vapour.txt -k MY_KEY -s MY_SECRET
+```
+
+### Download to local machine
+```
+  jaxx-download -b test-bucket -f vapour.txt -k MY_KEY -s MY_SECRET
+```
+
+### Upload to S3 from AWS Instance
+```
+  jaxx-upload -b test-bucket -f vapour.txt
+```
+
+### Download from S3 to current folder from AWS Instance
+```
+  jaxx-download -b test-bucket -f vapour.txt
+```
+
+### Upload from local machine, and make it publicly available
+```
+  jaxx-upload -b test-bucket -f vapour.txt -k MY_KEY -s MY_SECRET -p public
+```
 
 ## Contributing
 

data/lib/jaxx.rb

@@ -20,7 +20,10 @@ module Jaxx
 
   def self.logger log = nil
     @logger = log if log
-    @logger ||= Logger.new(STDOUT)
+    @logger ||= STDOUT
+
+    [:debug, :deprecation, :warning].each {|d| Fog::Logger[d] = @logger }
+
     @logger
   end
 end

data/lib/jaxx/cli.rb

@@ -6,7 +6,7 @@ module Jaxx
 
     def self.execute meth, args
       parser.parse!(args)
-      options.empty? ? (STDOUT.write(parser) and exit) : Jaxx.send(meth, options)
+      options.empty? ? (Jaxx.logger.write(parser) and exit) : Jaxx.send(meth, options)
     rescue RuntimeError => exc
       exit 1
     end
@@ -20,7 +20,7 @@ module Jaxx
         o.on('-s', '--access-secret [ACCESS_SECRET]')   { |s| options['access_secret'] = s }
         o.on('-f', '--file [FILE]')                     { |f| options['file'] = f }
         o.on('-p', '--privacy [PRIVACY]')               { |p| options['privacy'] = p }
-        o.on('-h', '--help')                            { puts o }
+        o.on('-h', '--help')                            { o }
       end
     end
 

data/lib/jaxx/download.rb

@@ -16,7 +16,7 @@ module Jaxx
           directory.files.get(process.file) do |chunk, byt_remain, byt_total|
             file.write(chunk)
             complete = (((byt_total-byt_remain).to_f/byt_total) * 100)
-            Jaxx.logger.info "Saving file: %.2f percent complete.\r" % complete
+            Jaxx.logger.write "Saving file: %.2f percent complete.\r" % complete
           end
         end
       end

data/lib/jaxx/environment.rb

@@ -2,46 +2,28 @@ require 'timeout'
 require 'socket'
 require 'net/http'
 require 'json'
+require 'timeout'
+require 'fog'
 
 module Jaxx
   class Environment
 
-    DEFAULT_ARGS = {
-      'service_domain'  => '169.254.169.254',
-      'service_path'    => '/latest/meta-data/iam/security-credentials/default',
-      'service_timeout' => 1
-    }
+    DEFAULT_ARGS = { 'service_timeout' => 1 }
+    DEFAULT_CREDENTIALS = { :aws_access_key_id => "", :aws_secret_access_key => "", :aws_session_token => nil, :use_iam_profile => true }
 
-    attr_reader :service_domain, :service_path, :service_timeout
+    attr_reader :service_timeout
 
     def initialize args = {}
-      @service_domain, @service_path, @service_timeout = DEFAULT_ARGS.dup.merge(args).values_at 'service_domain', 'service_path', 'service_timeout'
-    end
-    
-    def ami?
-      credentials[:code] == 'Success' 
+      @service_timeout = DEFAULT_ARGS.dup.merge(args).delete('service_timeout')
     end
 
     def credentials
-      return @credentials unless @credentials.nil?
-      
-      response = credential_response
-
-      @credentials = { 
-        :access_key    => response['AccessKeyId'], 
-        :access_secret => response['SecretAccessKey'], 
-        :code          => response['Code'] 
-      }
+      Timeout::timeout(service_timeout) do 
+        DEFAULT_CREDENTIALS.merge Fog::Compute::AWS.fetch_credentials(:use_iam_profile => true)
+      end
     rescue Errno::EHOSTDOWN, Errno::EHOSTUNREACH, Timeout::Error => exc
-      @credentials = { :access_key => nil, :access_secret => nil, :code => 'Failure' }
+      DEFAULT_CREDENTIALS
     end
 
-    private
-
-    def credential_response
-      http = Net::HTTP.new service_domain
-      http.open_timeout = http.read_timeout = service_timeout
-      JSON.parse http.get(service_path).body
-    end
   end
 end

data/lib/jaxx/process.rb

@@ -28,17 +28,18 @@ module Jaxx
       return @credentials unless @credentials.nil?
 
       key, secret = access_key.to_s, access_secret.to_s
-      if (key.empty? or secret.empty?) and Jaxx.environment.ami?
-        key, secret = Jaxx.environment.credentials.values_at :access_key, :access_secret
-      end
-      @credentials = { access_key: key, access_secret: secret }
+      @credentials = if key.empty? or secret.empty?
+        Jaxx.environment.credentials
+      else
+        { :aws_access_key_id => key, :aws_secret_access_key => secret, :aws_session_token => "" }
+      end.merge(:use_iam_profile => true)
     end
 
     def start &block
       errs = errors
       
       ["Unable to process transaction", format_errors(errs)].flatten.each do |msg|
-        Jaxx.logger.warn msg
+        Jaxx.logger.write msg
       end and raise(RuntimeError) unless errs.empty?
 
       block.call(storage)
@@ -57,9 +58,7 @@ module Jaxx
     private
 
     def storage
-      @storage ||= Fog::Storage::AWS.new :aws_access_key_id => credentials[:access_key], 
-        :aws_secret_access_key => credentials[:access_secret], 
-        :use_iam_profile       => Jaxx.environment.ami?
+      @storage ||= Fog::Storage::AWS.new credentials 
     end
 
     def validate_bucket
@@ -75,7 +74,7 @@ module Jaxx
     end
 
     def validate_credentials
-      "for access key and access secret required" if credentials[:access_key].empty? or credentials[:access_secret].empty?
+      "for access key and access secret required" if credentials[:aws_access_key_id].empty? or credentials[:aws_secret_access_key].empty?
     end
 
     def validate_privacy

data/lib/jaxx/version.rb

@@ -1,3 +1,3 @@
 module Jaxx
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/spec/helpers/service.rb

@@ -3,9 +3,11 @@ require 'fakeweb'
 module ServiceHelper
 
   def stub_credentials_service
-    FakeWeb.register_uri :get, 
-      /#{Jaxx.environment.service_domain}#{Jaxx.environment.service_path}/, 
-      :body => '{"AccessKeyId" : "foo", "SecretAccessKey" : "bar", "Code" : "Success"}'
+    Fog::Compute::AWS.stub(:fetch_credentials).and_return({
+      :aws_access_key_id     => 'foo',
+      :aws_secret_access_key => 'bar',
+      :aws_session_token     => 'foobar'
+    })
   end
 
 end

data/spec/lib/jaxx/environment_spec.rb

@@ -3,41 +3,22 @@ require 'spec_helper'
 module Jaxx
   describe Environment do
 
-    it "#service_domain" do
-      subject.service_domain.should_not be_nil
-    end
-
-    it "#service_path" do
-      subject.service_path.should_not be_nil
-    end
-
     it "#service_timeout" do
       subject.service_timeout.should_not be_nil
     end
 
     context "outside ami instance" do
       
-      it "#ami?" do
-        subject.ami?.should be_false
-      end
-
       it "#credentials" do
         subject.credentials.should be_kind_of(Hash)
-        subject.credentials[:code].should eq 'Failure'
+        subject.credentials[:aws_session_token].should be_nil
       end
     end
 
     context "within ami instance" do
 
-      before :each do
-        stub_credentials_service
-      end
-      
-      it "#ami?" do
-        subject.ami?.should be_true
-      end
-
       it "#credentials" do
+        stub_credentials_service
         subject.credentials.should be_kind_of(Hash)
       end
     end

data/spec/lib/jaxx/process_spec.rb

@@ -16,8 +16,6 @@ module Jaxx
       described_class.new.errors.should include(:bucket => 'is required')
     end
 
-    it "raises error on local authentication, when not on AMI"
-
     it "accepts access key" do
       described_class.new('access_key' => 'abc').access_key.should == 'abc'
     end

data/spec/spec_helper.rb

@@ -5,11 +5,12 @@ $:.unshift File.expand_path('../lib', __FILE__)
 require 'jaxx'
 require 'rspec'
 
-require_relative 'helpers/service'
+Jaxx.logger StringIO.new
+
 
-Jaxx.logger Logger.new('log/test.log')
+require_relative 'helpers/service'
 
 RSpec.configure do |c|
-  c.include ServiceHelper 
+  c.include ServiceHelper
   c.after(:each) { FakeWeb.clean_registry }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jaxx
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -206,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -522064426156595131
+      hash: -1531357280253582986
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -215,10 +215,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -522064426156595131
+      hash: -1531357280253582986
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: RubyGems to allow any file to be pushed to S3 in the simplist way