aviator 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGVhYTFmYzUyMjc5MGY4OWU0MDM2YzViZTM3N2ViNzEzNjljOGIyNA==
-  data.tar.gz: !binary |-
-    MzYyY2MwNTM5NDRmZTJhZWU2Mzg1ZmUxODNmNGVlZWI5MDgzMWY5MQ==
+SHA1:
+  metadata.gz: 50c59bcfabe57baf9c0e21fcab0370bc31855e4a
+  data.tar.gz: 41e8ce7fed1ed7ddee839142d005d66c02a6665f
 SHA512:
-  metadata.gz: !binary |-
-    NjBmYWUyY2Q0NjFhODg5MjBhYWEwZTA4NTFhYTY5YjczMDE2OWRmZGZkMTNh
-    ZTRkMGI1YjBmNjY3OWY3MzA2NGQxNjlhNGE0NDVhY2E0ZmQ3NTg3OThkNjcy
-    YjFjNWUxZjJiZmZkYWIzZjQ2NDRmNDg4MzY0NjFjOWI4Nzg0YzY=
-  data.tar.gz: !binary |-
-    NDAyMjlkNGQ1MzRhNmE5YzVlNThlNzA0M2M2YWFkNDM5ODNhNTQ2MzkxZDg3
-    MjcwMDZhYmE4MGJmZjIyZTljMDAxOGY4NTJiY2QzZWFkNDQwOTA5NTA0NGUw
-    NGI0NTFlODM2NmI1OGU4M2VkYzVkNjVhMDg2YWM5ZjdjOWM2ZDk=
+  metadata.gz: 7fafc12e4cea11cb1e7fff20f13bfdb953614729f74865f1d16e5ca9273abb3c686c79578500232860394169b45283e90a6892abeaff38496e41071231aec36e
+  data.tar.gz: a9645737bdc80f20516b8b5f499ae15fe8cae7e189268925e207696c55ad0dba1b44125415e74b34316d9f3d0e136b89790533232696792ddd19c0a99bb868e9

data/.travis.yml

@@ -3,15 +3,8 @@ rvm:
   - 1.8.7
   - 1.9.3
   - 2.0.0
-branches:
-  only:
-    - master
-    - develop
-    - release
+  - 2.1.0
 bundler_args: --without development
 script:
   - cp test/environment.yml.travis-ci test/environment.yml
   - bundle exec rake
-after_script:
-  - cat tmp/aviator.log
-  - cat tmp/vcr.log

data/Gemfile

@@ -9,6 +9,7 @@ gemspec
 group :test do
   if Aviator::Compatibility::RUBY_1_8_MODE
     gem 'mime-types', '~> 1.25.1'
+    gem 'rest-client', '~> 1.6.7'
   end
 
   gem 'rake'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Mark Maglana
+Copyright (c) 2014 Mark Maglana
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,11 +1,10 @@
 ![Aviator](https://raw.github.com/aviator/www/gh-pages/images/logo-small.png)
-<br/>A lightweight library for communicating with the OpenStack API.
+<br/>An elegantly designed OpenStack SDK for Ruby
 
 [![Build Status](https://travis-ci.org/aviator/aviator.png?branch=master)](https://travis-ci.org/aviator/aviator)
 [![Coverage Status](https://coveralls.io/repos/aviator/aviator/badge.png?branch=master)](https://coveralls.io/r/aviator/aviator?branch=master)
 [![Code Climate](https://codeclimate.com/github/aviator/aviator.png)](https://codeclimate.com/github/aviator/aviator)
 [![Gem Version](https://badge.fury.io/rb/aviator.png)](http://badge.fury.io/rb/aviator)
-[![Dependency Status](https://gemnasium.com/aviator/aviator.png)](https://gemnasium.com/aviator/aviator)
 
 
-<a href="http://aviator.github.io/www/">Usage and Installation</a>
+<a href="http://aviator.github.io/www/">Usage and Installation</a>

data/aviator.gemspec

@@ -3,7 +3,7 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'aviator/version'
-require 'aviator/compatibility'
+require 'aviator/core/utils/compatibility'
 require 'rbconfig'
 
 Gem::Specification.new do |spec|
@@ -22,13 +22,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'faraday', '0.8.8'
-
-  if Aviator::Compatibility::RUBY_1_8_MODE
-    spec.add_dependency 'activesupport', '~> 2.0'
-  else
-    spec.add_dependency 'activesupport', '>= 3.2.8'
-  end
-
   spec.add_dependency 'thor', '~> 0.18.1'
   spec.add_dependency 'terminal-table', '>= 1.4.5'
 

data/lib/aviator/core/cli/describer.rb

@@ -26,7 +26,7 @@ module Aviator
 
     def self.describe_request(provider_name, service_name, api_version, endpoint_type, request_name)
       service = Aviator::Service.new :provider => provider_name, :service => service_name
-      request_class = "Aviator::#{ provider_name.camelize }::#{ service_name.camelize }::"\
+      request_class = "Aviator::#{ provider_name.camelize }::#{ service_name.camelize }::Requests::"\
                       "#{ api_version.camelize }::#{ endpoint_type.camelize }::#{ request_name.camelize }".constantize
 
       display = ":Request => #{ request_name }\n"

data/lib/aviator/core/request_builder.rb

@@ -34,6 +34,7 @@ module Aviator
         namespace_arr = [
           klass.provider,
           klass.service,
+          'Requests',
           klass.api_version,
           klass.endpoint_type
         ]
@@ -55,17 +56,29 @@ module Aviator
 
 
       def get_request_class(root_namespace, request_class_arr)
-        request_class_arr.inject(root_namespace) do |namespace, sym|
+        provider_specific = request_class_arr != [:request]
+
+        if provider_specific
+          full_request_class_arr = request_class_arr.dup
+          full_request_class_arr.insert(2, :requests) if provider_specific
+        else
+          full_request_class_arr = request_class_arr
+        end
+
+        full_request_class_arr.inject(root_namespace) do |namespace, sym|
           namespace.const_get(sym.to_s.camelize, false)
         end
       rescue NameError => e
-        arr = ['..', '..'] + request_class_arr
-        arr[-1,1] = arr.last.to_s + '.rb'
-        path = Pathname.new(__FILE__).join(*arr.map{|i| i.to_s }).expand_path
+        if Aviator.const_defined?(full_request_class_arr[0].to_s.camelize)
+          provider = "Aviator::#{ full_request_class_arr[0] }::Provider".constantize
+          arr = ['..'] + full_request_class_arr
+          arr[-1,1] = arr.last.to_s + '.rb'
+          path = Pathname.new(provider.root_dir).join(*arr.map{|i| i.to_s }).expand_path
+        end
 
-        if path.exist?
+        if provider && path.exist?
           require path
-          request_class_arr.inject(root_namespace) do |namespace, sym|
+          full_request_class_arr.inject(root_namespace) do |namespace, sym|
             namespace.const_get(sym.to_s.camelize, false)
           end
         else

data/lib/aviator/core/response.rb

@@ -3,7 +3,7 @@ module Aviator
   class Response
     extend Forwardable
 
-    def_delegators :@response, :headers, :status
+    def_delegators :@response, :status
 
     attr_reader :request
 
@@ -28,6 +28,11 @@ module Aviator
     end
 
 
+    def headers
+      Hashish.new(@response.headers)
+    end
+
+
     private
 
     def raw_body

data/lib/aviator/core/service.rb

@@ -29,8 +29,8 @@ module Aviator
 
 
     class UnknownRequestError < StandardError
-      def initialize(request_name)
-        super "Unknown request #{ request_name }."
+      def initialize(request_name, options)
+        super "Unknown request #{ request_name } #{ options }."
       end
     end
 
@@ -60,6 +60,7 @@ module Aviator
       @provider = opts[:provider] || (raise ProviderNotDefinedError.new)
       @service  = opts[:service]  || (raise ServiceNameNotDefinedError.new)
       @log_file = opts[:log_file]
+      @default_options = opts[:default_options] || {}
 
       @default_session_data = opts[:default_session_data]
 
@@ -68,6 +69,10 @@ module Aviator
 
 
     def request(request_name, options={}, &params)
+      if options[:api_version].nil? && @default_options[:api_version]
+        options[:api_version] = @default_options[:api_version]
+      end
+
       session_data = options[:session_data] || default_session_data
 
       raise SessionDataNotProvidedError.new unless session_data
@@ -76,9 +81,9 @@ module Aviator
         session_data[k] = options[k] if options[k]
       end
 
-      request_class = find_request(request_name, session_data, options[:endpoint_type])
+      request_class = provider_module.find_request(service, request_name, session_data, options)
 
-      raise UnknownRequestError.new(request_name) unless request_class
+      raise UnknownRequestError.new(request_name, options) unless request_class
 
       request  = request_class.new(session_data, &params)
 
@@ -111,71 +116,8 @@ module Aviator
     end
 
 
-    # Candidate for extraction to aviator/openstack
-    def find_request(name, session_data, endpoint_type=nil)
-      endpoint_types = if endpoint_type
-                         [endpoint_type.to_s.camelize]
-                       else
-                         ['Public', 'Admin']
-                       end
-
-      namespace = Aviator.const_get(provider.camelize) \
-                         .const_get(service.camelize)
-
-      version = infer_version(session_data, name).to_s.camelize
-
-      return nil unless version && namespace.const_defined?(version)
-
-      namespace = namespace.const_get(version, name)
-
-      endpoint_types.each do |endpoint_type|
-        name = name.to_s.camelize
-
-        next unless namespace.const_defined?(endpoint_type)
-        next unless namespace.const_get(endpoint_type).const_defined?(name)
-
-        return namespace.const_get(endpoint_type).const_get(name)
-      end
-
-      nil
-    end
-
-
-    # Candidate for extraction to aviator/openstack
-    def infer_version(session_data, request_name='sample_request')
-      if session_data.has_key?(:auth_service) && session_data[:auth_service][:api_version]
-        session_data[:auth_service][:api_version].to_sym
-
-      elsif session_data.has_key?(:auth_service) && session_data[:auth_service][:host_uri]
-        m = session_data[:auth_service][:host_uri].match(/(v\d+)\.?\d*/)
-        return m[1].to_sym unless m.nil?
-
-      elsif session_data.has_key? :base_url
-        m = session_data[:base_url].match(/(v\d+)\.?\d*/)
-        return m[1].to_sym unless m.nil?
-
-      elsif session_data.has_key? :access
-        service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service }
-        raise MissingServiceEndpointError.new(service.to_s, request_name) unless service_spec
-        version = service_spec[:endpoints][0][:publicURL].match(/(v\d+)\.?\d*/)
-        version ? version[1].to_sym : :v1
-      end
-    end
-
-
     def load_requests
-      # :TODO => This should be determined by a provider-specific module.
-      # e.g. Aviator::OpenStack::requests_base_dir
-      request_file_paths = Dir.glob(Pathname.new(__FILE__).join(
-                             '..',
-                             '..',
-                             provider.to_s,
-                             service.to_s,
-                             '**',
-                             '*.rb'
-                             ).expand_path
-                           )
-
+      request_file_paths = provider_module.request_file_paths(service)
       request_file_paths.each{ |path| require path }
 
       constant_parts = request_file_paths \
@@ -192,6 +134,11 @@ module Aviator
       @log_file
     end
 
+
+    def provider_module
+      @provider_module ||= "Aviator::#{provider.camelize}::Provider".constantize
+    end
+
   end
 
 end

data/lib/aviator/core/session.rb

@@ -67,8 +67,11 @@ module Aviator
 
       response = auth_service.request environment[:auth_service][:request].to_sym, &block
 
-      if response.status == 200
-        @auth_info = response.body
+      if [200, 201].include? response.status
+        @auth_response = Hashish.new({
+          :headers => response.headers,
+          :body    => response.body
+        })
         update_services_session_data
       else
         raise AuthenticationError.new(response.body)
@@ -77,14 +80,14 @@ module Aviator
 
 
     def authenticated?
-      !auth_info.nil?
+      !auth_response.nil?
     end
 
 
     def dump
       JSON.generate({
-        :environment => environment,
-        :auth_info   => auth_info
+        :environment   => environment,
+        :auth_response => auth_response
       })
     end
 
@@ -118,10 +121,9 @@ module Aviator
       raise NotAuthenticatedError.new unless authenticated?
       raise ValidatorNotDefinedError.new unless environment[:auth_service][:validator]
 
-      auth_with_bootstrap = auth_info.merge({ :auth_service => environment[:auth_service] })
+      auth_with_bootstrap = auth_response.merge({ :auth_service  => environment[:auth_service] })
 
       response = auth_service.request environment[:auth_service][:validator].to_sym, :session_data => auth_with_bootstrap
-
       response.status == 200 || response.status == 203
     end
 
@@ -129,17 +131,17 @@ module Aviator
     private
 
 
-    def auth_info
-      @auth_info
+    def auth_response
+      @auth_response
     end
 
 
     def auth_service
       @auth_service ||= Service.new(
-        :provider => environment[:provider],
-        :service  => environment[:auth_service][:name],
+        :provider             => environment[:provider],
+        :service              => environment[:auth_service][:name],
         :default_session_data => { :auth_service => environment[:auth_service] },
-        :log_file => log_file
+        :log_file             => log_file
       )
     end
 
@@ -154,12 +156,17 @@ module Aviator
 
       @services ||= {}
 
-      @services[service_name] ||= Service.new(
-        :provider => environment[:provider],
-        :service  => service_name,
-        :default_session_data => auth_info,
-        :log_file => log_file
-      )
+      if @services[service_name].nil?
+        default_options = environment["#{ service_name }_service"]
+
+        @services[service_name] = Service.new(
+          :provider             => environment[:provider],
+          :service              => service_name,
+          :default_session_data => auth_response,
+          :default_options      => default_options,
+          :log_file             => log_file
+        )
+      end
 
       @services[service_name]
     end
@@ -177,15 +184,17 @@ module Aviator
 
 
     def initialize_with_dump(session_dump)
-      session_info = Hashish.new(JSON.parse(session_dump))
-      @environment = session_info[:environment]
-      @auth_info   = session_info[:auth_info]
+      session_info   = Hashish.new(JSON.parse(session_dump))
+      @environment   = session_info[:environment]
+      @auth_response = session_info[:auth_response]
     end
 
+
     def initialize_with_hash(hash_obj)
       @environment = Hashish.new(hash_obj)
     end
 
+
     def log_file
       @log_file
     end
@@ -195,7 +204,7 @@ module Aviator
       return unless @services
 
       @services.each do |name, obj|
-        obj.default_session_data = auth_info
+        obj.default_session_data = auth_response
       end
     end
 

data/lib/aviator/{hashish.rb → core/utils/hashish.rb}

@@ -1,3 +1,5 @@
+require 'json'
+
 # Hash-ish!
 #
 # This class is implemented using composition rather than inheritance so
@@ -6,7 +8,8 @@ class Hashish
   include Enumerable
 
   def initialize(hash={})
-    @hash = hash
+    @hash = hash.dup
+    stringify_keys
     hashishify_values
   end
 
@@ -23,6 +26,10 @@ class Hashish
     @hash[normalize(key)] = value
   end
 
+  def dup
+    Hashish.new(JSON.parse(@hash.to_json))
+  end
+
   def each(&block)
     @hash.each(&block)
   end
@@ -96,11 +103,10 @@ class Hashish
     end
   end
 
+
   def normalize(key)
     if @hash.has_key? key
       key
-    elsif key.is_a? String
-      key.to_sym
     elsif key.is_a? Symbol
       key.to_s
     else
@@ -108,4 +114,14 @@ class Hashish
     end
   end
 
+
+  def stringify_keys
+    keys = @hash.keys
+    keys.each do |key|
+      if key.is_a? Symbol
+        @hash[key.to_s] = @hash.delete(key)
+      end
+    end
+  end
+
 end

data/lib/aviator/core/utils/string.rb

@@ -0,0 +1,24 @@
+class String
+
+  unless instance_methods.include? 'camelize'
+    define_method :camelize do
+      word = self.slice(0,1).capitalize + self.slice(1..-1)
+      word.gsub(/_([a-zA-Z\d])/) { "#{$1.capitalize}" }
+    end
+  end
+
+  unless instance_methods.include? 'constantize'
+    define_method :constantize do
+      self.split("::").inject(Object) do |namespace, sym|
+        namespace.const_get(sym.to_s.camelize, false)
+      end
+    end
+  end
+
+  unless instance_methods.include? 'underscore'
+    define_method :underscore do
+      self.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+    end
+  end
+
+end

data/lib/aviator/core.rb

@@ -1,11 +1,12 @@
 require 'yaml'
 require 'json'
-require 'active_support/inflector'
 require 'faraday'
+require 'pathname'
 
 require "aviator/version"
-require "aviator/compatibility"
-require "aviator/hashish"
+require "aviator/core/utils/string"
+require "aviator/core/utils/compatibility"
+require "aviator/core/utils/hashish"
 require "aviator/core/request"
 require "aviator/core/request_builder"
 require "aviator/core/response"

data/lib/aviator/openstack/common/requests/v0/public/base.rb

@@ -0,0 +1,119 @@
+module Aviator
+
+  define_request :base do
+
+    meta :provider,      :openstack
+    meta :service,       :common
+    meta :api_version,   :v0
+    meta :endpoint_type, :public
+
+    def headers
+      {}.tap do |h|
+        if self.anonymous?
+          # do nothing
+
+        elsif keystone_v2_style_session_data?
+          h['X-Auth-Token'] = session_data[:body][:access][:token][:id]
+
+        elsif keystone_v3_style_session_data?
+          h['X-Auth-Token'] = session_data[:headers]['x-subject-token']
+
+        else
+          raise "Unknown session data format!"
+
+        end
+      end
+    end
+
+
+    private
+
+    def base_url
+      if session_data[:base_url]
+        session_data[:base_url]
+
+      elsif keystone_v2_style_session_data? && keystone_v2_style_service_info?
+        extract_base_url_from_keystone_v2_session_data
+
+      elsif keystone_v3_style_session_data? && keystone_v3_style_service_info?
+        extract_base_url_from_keystone_v3_session_data
+
+      elsif session_data[:auth_service] && session_data[:auth_service][:host_uri] && session_data[:auth_service][:api_version]
+        version = session_data[:auth_service][:api_version].to_s == "v2" ? "v2.0" : session_data[:auth_service][:api_version]
+        "#{ session_data[:auth_service][:host_uri] }/#{ version }"
+
+      elsif session_data[:auth_service] && session_data[:auth_service][:host_uri]
+        session_data[:auth_service][:host_uri]
+
+      else
+        raise Aviator::Service::MissingServiceEndpointError.new(service.to_s, self.class)
+      end
+    end
+
+
+    def build_service_type_string
+      api_versions_without_a_suffix = [
+        [:compute,  :v2],
+        [:ec2,      :v1],
+        [:identity, :v2],
+        [:image,    :v1],
+        [:metering, :v1],
+        [:s3,       :v1],
+        [:volume,   :v1]
+      ]
+
+      if api_versions_without_a_suffix.include? [service, api_version]
+        service.to_s
+      else
+        "#{ service }#{ api_version }"
+      end
+    end
+
+
+    def extract_base_url_from_keystone_v2_session_data
+      service_info = session_data[:body][:access][:serviceCatalog].find{ |s| s[:type] == build_service_type_string }
+      service_info[:endpoints][0]["#{ endpoint_type }URL".to_sym]
+    end
+
+
+    def extract_base_url_from_keystone_v3_session_data
+      service_info = session_data[:body][:token][:catalog].select{ |s| s[:type] == build_service_type_string }
+      endpoints = service_info.find{ |s| s.keys.include? "endpoints" }['endpoints']
+
+      endpoints.find{ |s| s['interface'] == endpoint_type.to_s }['url']
+    end
+
+
+    def keystone_v2_style_service_info?
+      not session_data[:body][:access][:serviceCatalog].find{ |s| s[:type] == build_service_type_string }.nil?
+    end
+
+
+    def keystone_v2_style_session_data?
+      session_data.has_key?(:body) && session_data[:body].has_key?(:access)
+    end
+
+
+    def keystone_v3_style_service_info?
+        not session_data[:body][:token][:catalog].find{ |s| s[:type] == build_service_type_string }.nil?
+    end
+
+
+    def keystone_v3_style_session_data?
+      session_data.has_key?(:headers) && session_data[:headers].has_key?("x-subject-token")
+    end
+
+
+    def params_to_querystring(param_names)
+      filters = []
+
+      param_names.each do |param_name|
+        filters << "#{ param_name }=#{ params[param_name] }" if params[param_name]
+      end
+
+      filters.empty? ? "" : "?#{ filters.join('&') }"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/common/requests/v2/public/base.rb

@@ -0,0 +1,9 @@
+module Aviator
+
+  define_request :base, :inherit => [:openstack, :common, :v0, :public, :base] do
+
+    meta :api_version,   :v2
+
+  end
+
+end

data/lib/aviator/openstack/common/requests/v3/public/base.rb

@@ -0,0 +1,9 @@
+module Aviator
+
+  define_request :base, :inherit => [:openstack, :common, :v0, :public, :base] do
+
+    meta :api_version,   :v3
+
+  end
+
+end