a9s_swift 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3abb3585ace40df7fac853a7dcd46f70233663f6
+  data.tar.gz: 72e10f8a0deb3410ab69a31cd343a23404ea780e
+SHA512:
+  metadata.gz: 1737f1fc453221b54286ffdb924a8b754de75d0bea657a3a97d38ceb2678ea23da184558bf8ec5003d97bf6a15cd55f2cf48f38b54303e01f2e5230ac7d72006
+  data.tar.gz: 8883b2375203f6f5f9588b9c54c242afef08bb07bbb22b5b3d7e8a5a54a90555beb6ee947bfc876d42c3777904e503335bf5643c1d9389a10c29b5096ef726b4

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end
+
+group :production do
+  gem 'fog'
+end

data/Gemfile.lock

@@ -0,0 +1,105 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.15)
+    builder (3.2.2)
+    descendants_tracker (0.0.3)
+    docile (1.1.3)
+    excon (0.32.1)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    fog (1.21.0)
+      fog-brightbox
+      fog-core (~> 1.21, >= 1.21.1)
+      fog-json
+      nokogiri (~> 1.5, >= 1.5.11)
+    fog-brightbox (0.0.1)
+      fog-core
+      fog-json
+    fog-core (1.21.1)
+      builder
+      excon (~> 0.32)
+      formatador (~> 0.2.0)
+      mime-types
+      net-scp (~> 1.1)
+      net-ssh (>= 2.1.3)
+    fog-json (1.0.0)
+      multi_json (~> 1.0)
+    formatador (0.2.4)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mime-types (2.0)
+    mini_portile (0.5.3)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.8.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.2.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.5.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.1)
+      atomic (>= 1.1.7, < 2)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  fog
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Julian Weber
+
+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,57 @@
+= a9s_swift
+
+a9s_swift is a small utility gem to ease up the usage of the anyines.com swift service within your applications.
+It enables a one-line configuration of the following libraries:
+
+* paperclip
+* carrierwave
+* fog
+
+== Dependencies
+
+* fog gem : https://github.com/fog/fog
+* paperclip (optional: if you would like to use the paperclip configuration feature)
+* carrierwave (optional: if you would like to use the carrierwave configuration feature)
+
+== Installation
+	gem install a9s_swift
+	
+	or
+	
+	gem 'a9s_swift' -> Gemfile
+	bundle
+
+== Usage
+
+=== rails applications with carrierwave or paperclip
+
+Some example initializers are provided in the examples directory. Just copy the according file over to your rails application's app/config/initializers directory and start using the anynines swift service within your live applications. 
+
+Please make sure to bind a swift service instance to your application to enable access to the swift credentials.
+
+=== fog
+	con = Anynines::Swift::Utility.fog_connection # returns a fog connection to the a9s swift service 
+	con.directories
+	
+=== paperclip configuration featue
+	Anynines::Swift::Utility.configure_paperclip("image_bucket") # create bucket, configure paperclip with a9s swift service
+	
+=== carrierwave configuration feature
+	Anynines::Swift::Utility.configure_carrierwave("image_bucket") # create bucket, configure carrierwave with a9s swift service
+	
+
+== Contributing to a9s_swift
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Julian Weber. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "a9s_swift"
+  gem.homepage = "http://github.com/anynines/a9s_swift"
+  gem.license = "MIT"
+  gem.summary = %Q{anynines.com swift service utility library for simplifying app acces to the a9s swift service.}
+  gem.description = %Q{anynines.com swift service utility library for simplifying app acces to the a9s swift service.}
+  gem.email = "jweber@anynines.com"
+  gem.authors = ["Julian Weber"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "a9s_swift #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Run an irb console session'
+task :irb_console do
+  exec("irb -r ./lib/a9s_swift.rb")
+end
+
+task irb: :irb_console

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/a9s_swift.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: a9s_swift 0.1.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "a9s_swift"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julian Weber"]
+  s.date = "2014-04-04"
+  s.description = "anynines.com swift service utility library for simplifying app acces to the a9s swift service."
+  s.email = "jweber@anynines.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "a9s_swift.gemspec",
+    "examples/rails_carrierwave_initializer.rb",
+    "examples/rails_paperclip_initializer.rb",
+    "lib/a9s_swift.rb",
+    "lib/a9s_swift/utility.rb",
+    "test/helper.rb",
+    "test/test_a9s_swift.rb"
+  ]
+  s.homepage = "http://github.com/anynines/a9s_swift"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "anynines.com swift service utility library for simplifying app acces to the a9s swift service."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/examples/rails_carrierwave_initializer.rb

@@ -0,0 +1,7 @@
+BUCKET_NAME = "images"
+
+if Rails.env.production?
+  require 'carrierwave'
+  require 'a9s_swift'
+  Anynines::Swift::Utility.configure_carrierwave(BUCKET_NAME)
+end

data/examples/rails_paperclip_initializer.rb

@@ -0,0 +1,7 @@
+BUCKET_NAME = "images"
+
+if Rails.env.production?
+  require 'paperclip'
+  require 'a9s_swift'
+  Anynines::Swift::Utility.configure_carrierwave(BUCKET_NAME)
+end

data/lib/a9s_swift.rb

@@ -0,0 +1,10 @@
+module Anynines
+  module Swift
+    autoload :Utility, File.expand_path('../a9s_swift/utility', __FILE__)
+  end
+  
+  def self.version
+    file = File.open(File.expand_path("../../VERSION", __FILE__))
+    return file.read.to_s.tr("\n","")
+  end
+end

data/lib/a9s_swift/utility.rb

@@ -0,0 +1,110 @@
+require 'fog'
+require 'json'
+
+class Anynines::Swift::Utility
+  SWIFT_HOST = "https://swift.hydranodes.de"
+  
+  # Returns a fog storage connection to the swift service
+  # @return [Fog::Storage] a fog storage connection
+  def self.fog_connection
+    Fog::Storage.new fog_credentials_hash
+  end
+  
+  # Sets up paperclip for the usage with the anynines service.
+  # Creates a bucket with the given name if not already present.
+  # @param image_bucket_name [String] the bucket name to use
+  # @param options [Hash] a hash of additional options
+  def self.configure_paperclip(image_bucket_name, options = {})
+    raise "Paperclip wasn't found in your environment! Please verify that paperclip is included within your Gemfile and loaded correctly." if defined?(Paperclip).nil?
+    
+    opts = initialize_options options
+    create_new_bucket(image_bucket_name, opts[:fog_public])
+    
+    fog_hash = fog_credentials_hash
+    # configure paperclip to use the credentials provided by the anynines environment
+    
+    Paperclip::Attachment.default_options.update(
+      {
+        :path => ":class/:id/:attachment/:style/img_:fingerprint",
+        :storage => :fog,
+        :fog_credentials => {
+          :provider => fog_hash[:provider],
+          :hp_access_key => fog_hash[:hp_access_key],
+          :hp_secret_key => fog_hash[:hp_secret_key],
+          :hp_tenant_id => fog_hash[:hp_tenant_id],
+          :hp_auth_uri => fog_hash[:hp_auth_uri],
+          :hp_use_upass_auth_style => true,
+          :hp_avl_zone => fog_hash[:hp_avl_zone]
+        },
+        :fog_directory => image_bucket_name,
+        :fog_public => opts[:fog_public],
+        :fog_host => "#{SWIFT_HOST}/v1/AUTH_#{fog_hash[:hp_tenant_id]}/#{image_bucket_name}"
+      })
+  end
+  
+  # Sets up carrierwave for the usage with the anynines service.
+  # Creates a bucket with the given name if not already present.
+  # @param image_bucket_name [String] the bucket name to use
+  # @param options [Hash] a hash of additional options
+  def self.configure_carrierwave(image_bucket_name, options = {})
+    raise "CarrierWave wasn't found in your environment! Please verify that carrierwave is included within your Gemfile and loaded correctly." if defined?(CarrierWave).nil?
+    
+    opts = initialize_options options
+    create_new_bucket(image_bucket_name, opts[:fog_public])
+    
+    CarrierWave.configure do |config|
+      config.fog_credentials = fog_credentials_hash
+
+      config.fog_directory  = image_bucket_name
+      config.fog_public     = opts[:fog_public]                                   # optional, defaults to true
+    end
+  end
+  
+  # Returns a fog compatible credentials hash for the swift service
+  def self.fog_credentials_hash
+    # parse the VCAP_SERVICES environment variable
+    services = JSON.parse(ENV["VCAP_SERVICES"])  
+    raise "Couldn't find the VCAP_SERVICE env variable! Are you running within an anynines environment?" if services.nil?
+    raise "Couldn't access the a9s swift service credentials from env! Have you bound a swift service instance to the application?" if services["swift-1.0"].nil?
+    swift_service = services["swift-1.0"].first
+    
+    return {
+       :provider => 'HP',
+       :hp_access_key => swift_service["credentials"]["user_name"],
+       :hp_secret_key => swift_service["credentials"]["password"],
+       :hp_tenant_id => swift_service["credentials"]["tenant_id"],
+       :hp_auth_uri => swift_service["credentials"]["authentication_uri"],
+       :hp_use_upass_auth_style => true,
+       :hp_avl_zone => swift_service["credentials"]["availability_zone"]
+    }
+  end
+  
+  # Creates a new bucket with the given name if not already present
+  # @param bucket_name [String] a name for the bucket
+  # @param public_access [Boolean] should the bucket be publicly accessible?
+  def self.create_new_bucket(bucket_name, public_access)
+    connection = fog_connection
+    if connection.directories.get(bucket_name).nil?
+      puts "The bucket with key=#{bucket_name} wasn't found. Creating bucket with key=#{bucket_name} ."
+      bucket = connection.directories.create key: bucket_name 
+
+      # set the directory to be public
+      bucket.public = public_access
+      bucket.save
+
+      connection = nil
+      return true
+    else
+      puts "The bucket with key=#{bucket_name} is already present! Skipping bucket creation."
+      return false
+    end
+  end
+  
+  private 
+  
+  def self.initialize_options(options)
+    # set fog_public to true if not defined within the options
+    options[:fog_public] = true if options[:fog_public].nil?
+    return options
+  end
+end

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'a9s_swift'
+
+class Test::Unit::TestCase
+end

data/test/test_a9s_swift.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestA9sSwift < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: a9s_swift
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Julian Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: anynines.com swift service utility library for simplifying app acces
+  to the a9s swift service.
+email: jweber@anynines.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- a9s_swift.gemspec
+- examples/rails_carrierwave_initializer.rb
+- examples/rails_paperclip_initializer.rb
+- lib/a9s_swift.rb
+- lib/a9s_swift/utility.rb
+- test/helper.rb
+- test/test_a9s_swift.rb
+homepage: http://github.com/anynines/a9s_swift
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: anynines.com swift service utility library for simplifying app acces to the
+  a9s swift service.
+test_files: []