tim 0.2.0 → 0.3.0

data/README.rdoc

@@ -1,5 +1,34 @@
 = Tim
 
+== Summary
+
+Tim is a Rails Engine responsible for Cloud image management.  It
+allows clients to create, delete and upload images to a multitude of
+Cloud providers.  Tim builds on top of Imagefactory’s cloud
+abstraction layer.
+
+Adding the ability for clients to store meta-data (used for searching
+and sorting) as well as versioning and support for access control.
+Tim wraps all this up in a clean, simply RESTful API.
+
+You can read the full presentation
+here[http://www.aeolusproject.org/docs/presentations/2012-nov-conference/tim.odp].
+
+== Configuration
+
+=== Securing Image Factory requests
+
+It is possible to secure Image Factory requests using 2 Legged OAuth.  To use 2
+Legged OAuth you must set the OAuth consumer key, consumer secret and url in the
+Tim::ImageFactory::Base.config.
+
+Example:
+
+  oauth_config = {:consumer_key => "mock-key",
+                  :consumer_secret => "mock-secret",
+                  :site => "http://localhost:8075/imagefactory/"}
+  Tim::ImageFactory::Base.config = oauth_config
+
 == Running Tests
 
 {<img src="https://secure.travis-ci.org/aeolus-incubator/tim.png"

data/lib/image_factory/image_factory.rb

@@ -1,4 +1,5 @@
 require "active_resource"
+require File.join(File.dirname(__FILE__), 'oauth', 'active_resource_oauth_client')
 require File.join(File.dirname(__FILE__), 'model', 'base')
 require File.join(File.dirname(__FILE__), 'model', 'target_image')
-require File.join(File.dirname(__FILE__), 'model', 'provider_image')
+require File.join(File.dirname(__FILE__), 'model', 'provider_image')

data/lib/image_factory/oauth/active_resource_oauth_client.rb

@@ -0,0 +1,52 @@
+require 'oauth'
+
+# Monkey-patch ActiveResource to allow us to merge our OAuth headers in.
+# Portions of the below are taken from Active Resource which is MIT licensed;
+# hence this whole file is being licensed under the MIT License to err on the side of safety.
+module ActiveResourceOAuthClient
+  ActiveResource::Connection.class_eval do
+    def request_with_oauth(method, path, *arguments)
+      @oauth_config = Tim::ImageFactory::Base.config || {}
+      # Take care to fall back to the standard request method if we don't have full OAuth credentials
+      unless use_oauth_for_url?("#{site.scheme}://#{site.host}:#{site.port}#{path}")
+        return request_without_oauth(method, path, *arguments)
+      end
+      result = ActiveSupport::Notifications.instrument("request.active_resource") do |payload|
+        payload[:method] = method
+        payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
+        puts "#{payload[:method]} #{payload[:request_uri]}"
+        oauth_consumer = OAuth::Consumer.new(
+          @oauth_config[:consumer_key],
+          @oauth_config[:consumer_secret],
+          :site => @oauth_config[:site] )
+        puts @oauth_config[:consumer_key] + " " + @oauth_config[:consumer_secret]
+        token = OAuth::AccessToken.new(oauth_consumer)
+        base_request = oauth_consumer.create_signed_request(method, path, token, {}, *arguments)
+        payload[:result] = http.request(base_request)
+      end
+      # Error-handling code from OAuth
+      # http://wiki.oauth.net/w/page/12238543/ProblemReporting
+      auth_header = result.to_hash['www-authenticate']
+      problem_header = auth_header ? auth_header.select{|h| h =~ /^OAuth /}.select{|h| h =~ /oauth_problem/}.first : nil
+      if auth_header && problem_header
+        params = OAuth::Helper.parse_header(problem_header)
+        raise OAuth::Problem.new(params.delete("oauth_problem"), result, params)
+      end
+      # Error-handling code from ActiveResource
+      handle_response(result)
+      rescue Timeout::Error => e
+        raise TimeoutError.new(e.message)
+      rescue OpenSSL::SSL::SSLError => e
+        raise SSLError.new(e.message)
+    end
+
+    # Currently, only Factory calls should use OAuth -- extend as needed
+    def use_oauth_for_url?(url)
+      Tim::ImageFactory::Base.use_oauth? and
+        url.include?(Tim::ImageFactory::Base.config[:site])
+    end
+
+    alias_method_chain :request, :oauth
+
+  end
+end

data/lib/tim/version.rb

@@ -1,3 +1,3 @@
 module Tim
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/dummy/config/initializers/tim.rb

@@ -1,8 +1,16 @@
 Tim.user_class = "User"
 Tim.provider_account_class = "ProviderAccount"
 Tim.provider_type_class = "ProviderType"
+
 # Image Factory URL
 Tim::ImageFactory::Base.site = "http://localhost:8075/imagefactory"
+
+# Example OAuth Configuration
+#oauth_config = {:consumer_key => "mock-key",
+#                :consumer_secret => "mock-secret",
+#                :site => "http://localhost:8075/imagefactory/"}#
+#Tim::ImageFactory::Base.config = oauth_config
+
 # FIXME: We should be able to infer these from Routes
 Tim::ImageFactory::TargetImage.callback_url = "http://localhost:3000/tim/target_images/"
 Tim::ImageFactory::ProviderImage.callback_url = "http://localhost:3000/tim/provider_images/"

data/tim.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rails", "~> 3.2"
   s.add_dependency "haml"
   s.add_dependency "nokogiri"
+  s.add_dependency "oauth"
 
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "rspec-rails"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tim
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &8009320 !ruby/object:Gem::Requirement
+  requirement: &12953140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *8009320
+  version_requirements: *12953140
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &8007020 !ruby/object:Gem::Requirement
+  requirement: &12950400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8007020
+  version_requirements: *12950400
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &8006340 !ruby/object:Gem::Requirement
+  requirement: &12965480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8006340
+  version_requirements: *12965480
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &12962440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12962440
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &8018880 !ruby/object:Gem::Requirement
+  requirement: &12958660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8018880
+  version_requirements: *12958660
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &8016220 !ruby/object:Gem::Requirement
+  requirement: &12973520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8016220
+  version_requirements: *12973520
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &8026240 !ruby/object:Gem::Requirement
+  requirement: &12971700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8026240
+  version_requirements: *12971700
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
-  requirement: &8035500 !ruby/object:Gem::Requirement
+  requirement: &12970380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +99,10 @@ dependencies:
         version: 4.1.0
   type: :development
   prerelease: false
-  version_requirements: *8035500
+  version_requirements: *12970380
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &8865100 !ruby/object:Gem::Requirement
+  requirement: &12969260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +110,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8865100
+  version_requirements: *12969260
 description: Rails engine client for the Aeolus Image Factory cross-cloud virtual
   machine image builder.
 email:
@@ -198,7 +209,6 @@ files:
 - db/migrate/20121210131423_add_build_method_to_target_image.rb
 - db/migrate/20120910175233_create_tim_templates.rb
 - lib/tasks/tim_tasks.rake
-- lib/tasks/cucumber.rake
 - lib/tim/engine.rb
 - lib/tim/version.rb
 - lib/generators/tim/templates/README
@@ -210,6 +220,7 @@ files:
 - lib/image_factory/model/base.rb
 - lib/image_factory/model/target_image.rb
 - lib/image_factory/image_factory.rb
+- lib/image_factory/oauth/active_resource_oauth_client.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
@@ -315,7 +326,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2330827430856779926
+      hash: -2467413164711160043
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -324,7 +335,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2330827430856779926
+      hash: -2467413164711160043
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15

data/lib/tasks/cucumber.rake

@@ -1,59 +0,0 @@
-# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
-# It is recommended to regenerate this file in the future when you upgrade to a
-# newer version of cucumber-rails. Consider adding your own code to a new file
-# instead of editing this one. Cucumber will automatically load all features/**/*.rb
-# files.
-
-
-unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
-
-begin
-  require 'cucumber/rake/task'
-
-  namespace :cucumber do
-    Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
-      t.fork = true # You may get faster startup if you set this to false
-      t.profile = 'default'
-    end
-
-    Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
-      t.fork = true # You may get faster startup if you set this to false
-      t.profile = 'wip'
-    end
-
-    Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
-      t.fork = true # You may get faster startup if you set this to false
-      t.profile = 'rerun'
-    end
-
-    desc 'Run all features'
-    task :all => [:ok, :wip]
-
-    task :statsetup do
-      require 'rails/code_statistics'
-      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
-      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
-    end
-  end
-  desc 'Alias for cucumber:ok'
-  task :cucumber => 'cucumber:ok'
-
-  task :default => :cucumber
-
-  task :features => :cucumber do
-    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
-  end
-
-  # In case we don't have ActiveRecord, append a no-op task that we can depend upon.
-  task 'db:test:prepare' do
-  end
-
-  task :stats => 'cucumber:statsetup'
-rescue LoadError
-  desc 'cucumber rake task not available (cucumber not installed)'
-  task :cucumber do
-    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
-  end
-end
-
-end