jaxx 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use --create 1.9.3@jaxx
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jaxx.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marc Watts
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Jaxx
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jaxx'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jaxx
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/jaxx

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+require 'optparse'
+$:.unshift File.expand_path('../../lib', __FILE__)
+opts = {}
+OptionParser.new do |o|
+  o.banner = "Jaxx file distributor: jaxx [options]"
+
+  o.on('-b', '--bucket BUCKET')                   { |b| opts['bucket'] = b }
+  o.on('-k', '--access-key [ACCESS_KEY]')         { |k| opts['access_key'] = k }
+  o.on('-s', '--access-secret [ACCESS_SECRET]')   { |s| opts['access_secret'] = s }
+  o.on('-f', '--file FILE')                       { |f| opts['file'] = f }
+  o.on('-p', '--privacy [PRIVACY]')               { |p| opts['privacy'] = p }
+  o.on('-h', '--help')                            { puts o; exit }
+end.parse!
+
+require 'jaxx'
+Jaxx.save(opts)

data/jaxx.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jaxx/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marc Watts"]
+  gem.email         = ["marcky.sharky@googlemail.com"]
+  gem.description   = %q{Command line wrapper for pushing files to S3}
+  gem.summary       = %q{RubyGems to allow any file to be pushed to S3 in the simplist way}
+  gem.homepage      = "https://github.com/marckysharky/jaxx"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jaxx"
+  gem.require_paths = ["lib"]
+  gem.version       = Jaxx::VERSION
+
+  gem.add_dependency 'fog'
+  gem.add_development_dependency  'rake'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'fakeweb'
+end

data/lib/jaxx/environment.rb

@@ -0,0 +1,36 @@
+require 'timeout'
+require 'socket'
+require 'net/http'
+require 'json'
+
+module Jaxx
+  class Environment
+
+    DEFAULT_ARGS = {
+      'service_domain'  => '169.254.169.254',
+      'service_path'    => '/latest/meta-data/iam/security-credentials/default',
+      'service_timeout' => 5
+    }
+
+    attr_reader :service_domain, :service_path, :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' 
+    end
+
+    def credentials
+      return @credentials unless @credentials.nil?
+      
+      http = Net::HTTP.new service_domain
+      http.open_timeout = http.read_timeout = service_timeout
+      resp = JSON.parse http.get(service_path).body
+      @credentials = { :access_key => resp['AccessKeyId'], :access_secret => resp['SecretAccessKey'], :code => resp['Code'] }
+    rescue Errno::EHOSTDOWN, Errno::EHOSTUNREACH, Timeout::Error
+      @credentials = { :access_key => nil, :access_secret => nil, :code => 'Failure' }
+    end
+  end
+end

data/lib/jaxx/transaction.rb

@@ -0,0 +1,85 @@
+require 'fog'
+
+module Jaxx
+  
+  class Transaction
+
+    PRIVACIES = %w[public private]
+    
+    attr_reader :bucket, :access_key, :access_secret, :file, :privacy
+
+    def initialize args = {}
+      @bucket, @access_key, @access_secret, @file, @privacy = args.values_at 'bucket', 'access_key', 'access_secret', 'file', 'privacy'
+    end
+
+    def privacy
+      @privacy || 'private'
+    end
+
+    def private?
+      privacy.to_s == 'private'
+    end
+
+    def public?
+      !private?
+    end
+
+    def credentials
+      return @credentials unless @credentials.nil?
+
+      key, secret = access_key.to_s, access_secret.to_s
+      if Jaxx.environment.ami? and (key.empty? or secret.empty?)
+        creds  = Jaxx.environment.credentials
+        key    = creds[:access_key]
+        secret = creds[:access_secret]
+      end
+      @credentials = { access_key: key, access_secret: secret }
+    end
+
+    def process
+      errs = errors
+      if errs.empty?
+        remote_directory.files.create(:key => File.basename(file), :body => File.read(file), :public => public?)
+      else
+        raise RuntimeError, "Unable to process transaction: #{errs.inspect}"
+      end
+    end
+
+    def validate
+      err = {} 
+      err[:bucket]      = "is required" unless validate_bucket
+      err[:file]        = "given cannot be processed"  unless validate_file
+      err[:credentials] = "for access key and access secret required" unless validate_credentials
+      err[:privacy]     = "#{privacy} is not supported" unless validate_privacy
+      err
+    end
+
+    alias :errors :validate
+
+    private
+
+    def remote_directory
+      s3  = Fog::Storage::AWS.new :aws_access_key_id => credentials[:access_key], :aws_secret_access_key => credentials[:access_secret], :use_iam_profile => Jaxx.environment.ami?
+      dir = s3.directories.get(bucket)
+      dir ||= s3.directories.create(:key => bucket, :public => public?)
+      dir
+    end
+
+    def validate_bucket
+      !bucket.to_s.empty?
+    end
+
+    def validate_file
+      !file.to_s.empty? and File.exist?(file.to_s)
+    end
+
+    def validate_credentials
+      !credentials[:access_key].empty? and !credentials[:access_secret].empty?
+    end
+
+    def validate_privacy
+      PRIVACIES.include?(privacy.to_s)
+    end
+
+  end
+end

data/lib/jaxx/version.rb

@@ -0,0 +1,3 @@
+module Jaxx
+  VERSION = "0.0.3"
+end

data/lib/jaxx.rb

@@ -0,0 +1,14 @@
+require "jaxx/version"
+require "jaxx/transaction"
+require "jaxx/environment"
+
+module Jaxx
+
+  def self.save args = {}
+    Jaxx::Transaction.new(args).process
+  end
+
+  def self.environment
+    @environment ||= Environment.new
+  end
+end

data/spec/helpers/service.rb

@@ -0,0 +1,9 @@
+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"}'
+  end
+
+end

data/spec/lib/jaxx/environment_spec.rb

@@ -0,0 +1,45 @@
+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'
+      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
+        subject.credentials.should be_kind_of(Hash)
+      end
+    end
+  end
+end

data/spec/lib/jaxx/transaction_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+require 'fog/aws/models/storage/directory'
+
+module Jaxx
+  describe Transaction do
+
+    it "raises RuntimeError on invalid process" do
+      -> { described_class.new.process }.should raise_error(RuntimeError)
+    end
+
+    it "accepts bucket" do
+      described_class.new('bucket' => 'foo').bucket.should == 'foo'
+    end
+
+    it "raises error on missing bucket" do
+      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
+
+    it "accepts access secret" do
+      described_class.new('access_secret' => 'abc').access_secret.should == 'abc'
+    end
+
+    it "accepts file" do
+      file = double 'file'
+      described_class.new('file' => file).file.should == file
+    end
+
+    context "passing a file path" do
+      
+      it "raises error on missing file" do
+        described_class.new.errors.should include(:file => "given cannot be processed")
+      end
+
+      it "includes error when file does not exist" do
+        file = "foo"
+        described_class.new('file' => file).errors.should include(:file => "given cannot be processed")
+      end
+
+      it "includes error when path is empty" do
+        described_class.new('file' => "").errors.should include(:file => "given cannot be processed")
+      end
+    end
+
+    it "accepts privacy level" do
+      described_class.new('privacy' => 'private').privacy.should == 'private'
+    end
+
+    it "defaults privacy level to private" do
+      described_class.new.privacy.should == 'private'
+    end
+
+    it "raises error on invalid privacy level" do
+      described_class.new('privacy' => 'foo').errors.should include(:privacy => "foo is not supported")
+    end
+
+    context "non-ami environment" do
+
+      it "raises error on missing access key" do
+        described_class.new.errors.should include(:credentials => "for access key and access secret required")
+      end
+
+      it "raises error on missing access secret" do
+        described_class.new.errors.should include(:credentials => "for access key and access secret required")
+      end
+    end
+
+    context "ami environment" do
+      
+      before :each do
+        stub_credentials_service
+      end
+
+      it "allows access key to be empty" do
+        described_class.new.errors.should_not include(:access_key)
+      end
+
+      it "allows access secret to be empty" do
+        described_class.new.errors.should_not include(:access_secret)
+      end
+    end
+
+    describe "#process" do
+      let(:args) { ({ 'access_key' => 'foo', 'access_secret' => 'bar', 'file' => File.expand_path('bar.txt', __FILE__), 'bucket' => 'temp' }) }
+      
+      subject { described_class.new(args) }
+      
+      it "sends file to storage" do
+        Fog.mock!
+         
+        File.stub(:exist?).with(args['file']).and_return(true)
+        File.should_receive(:read).with(args['file']).and_return("")
+        File.should_receive(:basename).with(args['file']).and_return('bar.txt')
+
+        subject.process
+      end
+    end
+  end
+end

data/spec/lib/jaxx_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Jaxx do
+
+  describe ".save" do
+ 
+    it "creates a new transaction" do
+      trans = double 'trans', :process => true
+      Jaxx::Transaction.should_receive(:new).and_return(trans)
+      Jaxx.save
+    end
+
+  end
+
+  describe ".environment" do
+    it "returns instance of Jaxx::Environment" do
+      Jaxx.environment.should be_kind_of(Jaxx::Environment)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'fakeweb'
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'jaxx'
+
+require_relative 'helpers/service'
+
+RSpec.configure do |c|
+  c.include ServiceHelper 
+  c.after(:each) do
+    FakeWeb.clean_registry
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: jaxx
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Marc Watts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line wrapper for pushing files to S3
+email:
+- marcky.sharky@googlemail.com
+executables:
+- jaxx
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/jaxx
+- jaxx.gemspec
+- lib/jaxx.rb
+- lib/jaxx/environment.rb
+- lib/jaxx/transaction.rb
+- lib/jaxx/version.rb
+- spec/helpers/service.rb
+- spec/lib/jaxx/environment_spec.rb
+- spec/lib/jaxx/transaction_spec.rb
+- spec/lib/jaxx_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/marckysharky/jaxx
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -94777366135890808
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -94777366135890808
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: RubyGems to allow any file to be pushed to S3 in the simplist way
+test_files:
+- spec/helpers/service.rb
+- spec/lib/jaxx/environment_spec.rb
+- spec/lib/jaxx/transaction_spec.rb
+- spec/lib/jaxx_spec.rb
+- spec/spec_helper.rb