aviator 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODAxM2VmMWQ3YzJmNWE1ZTdkODQ5Yzc4NGI2NDljNTdhODA1ZGM3NQ==
+    ZGVhYTFmYzUyMjc5MGY4OWU0MDM2YzViZTM3N2ViNzEzNjljOGIyNA==
   data.tar.gz: !binary |-
-    Y2RjMzE0NmU2ZmRjMTdmYTE5MzhkODFmNDM1OWY4YWJkNDJmMWM1Mg==
+    MzYyY2MwNTM5NDRmZTJhZWU2Mzg1ZmUxODNmNGVlZWI5MDgzMWY5MQ==
 SHA512:
   metadata.gz: !binary |-
-    YWQ3MDE0MGIzNWZhMzlkNzEzNGRjYjc0OGQ0NzRhNWY4MmU4NjMzMGRhNjgz
-    ODUwZDQ0MDI0MzdhMTcxZWRmNzViZTQ3MDgzNTc3NzU1YThjNzY1NDE0Yzcw
-    YmVjNmJmMjJlZTQ0NmEyYzkxNDZiOGM0NjAyMDUzMThhYTkyOGE=
+    NjBmYWUyY2Q0NjFhODg5MjBhYWEwZTA4NTFhYTY5YjczMDE2OWRmZGZkMTNh
+    ZTRkMGI1YjBmNjY3OWY3MzA2NGQxNjlhNGE0NDVhY2E0ZmQ3NTg3OThkNjcy
+    YjFjNWUxZjJiZmZkYWIzZjQ2NDRmNDg4MzY0NjFjOWI4Nzg0YzY=
   data.tar.gz: !binary |-
-    ZDBjY2EwMjhlYTBiYTcxMTc0ZjZjNzkzNDA1Y2UwYTRkNWZiODZiN2E5Zjk0
-    MTdiZjc4Mzk1MmNmMmExNTEyNWVmYjExZWVhODE3ZjRiMTM3OTEwMGNlNzc5
-    NDlmMWQ4ODQyMzRiNzc3NWQwMjhhNjEwMTU1OTg5YTg0MDVjZjA=
+    NDAyMjlkNGQ1MzRhNmE5YzVlNThlNzA0M2M2YWFkNDM5ODNhNTQ2MzkxZDg3
+    MjcwMDZhYmE4MGJmZjIyZTljMDAxOGY4NTJiY2QzZWFkNDQwOTA5NTA0NGUw
+    NGI0NTFlODM2NmI1OGU4M2VkYzVkNjVhMDg2YWM5ZjdjOWM2ZDk=

data/.gitignore

@@ -19,4 +19,5 @@ tmp/*.*
 .DS_Store
 test/environment.yml
 vcr.log
-
+.ruby-gemset
+.ruby-version

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 1.8.7
   - 1.9.3
   - 2.0.0
 branches:
@@ -11,3 +12,6 @@ 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

@@ -7,11 +7,15 @@ gemspec
 # we can tell travis-ci not to build any of the
 # development gems. Makes the build run faster.
 group :test do
+  if Aviator::Compatibility::RUBY_1_8_MODE
+    gem 'mime-types', '~> 1.25.1'
+  end
+
   gem 'rake'
   gem 'simplecov', '~> 0.7.0'
-  gem 'coveralls', '~> 0.6.0'
+  gem 'coveralls', '~> 0.7.0'
   gem 'json', '~> 1.7.0'
   gem 'minitest', '~> 4.7.0'
   gem 'minitest-reporters', '~> 0.14.20'
-  gem 'vcr', '~> 2.5.0'
+  gem 'vcr', '~> 2.8.0'
 end

data/aviator.gemspec

@@ -1,7 +1,10 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'aviator/version'
+require 'aviator/compatibility'
+require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name          = "aviator"
@@ -18,19 +21,29 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '~> 0.8.0'
-  spec.add_dependency 'activesupport', '>= 3.2.8'
+  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'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", ">= 1.0"
   spec.add_development_dependency 'rb-fsevent', '~> 0.9.0'
   spec.add_development_dependency 'guard', '~> 1.8.0'
   spec.add_development_dependency 'guard-rake', '~> 0.0.0'
   spec.add_development_dependency 'guard-minitest', '~> 0.5.0'
-  spec.add_development_dependency 'ruby_gntp', '~> 0.3.0'
-  spec.add_development_dependency 'debugger', '~> 1.6.0'
+
+  if /darwin|mac os/ === RbConfig::CONFIG['host_os']
+    spec.add_development_dependency 'terminal-notifier-guard', '~> 1.5.3'
+  else
+    spec.add_development_dependency 'ruby_gntp', '~> 0.3.0'
+  end
+
   spec.add_development_dependency 'pry', '~> 0.9.0'
   spec.add_development_dependency 'yard', '~> 0.8.0'
   spec.add_development_dependency 'redcarpet', '~> 2.3.0'

data/lib/aviator/compatibility.rb

@@ -0,0 +1,34 @@
+module Aviator
+
+  module Compatibility
+    RUBY_1_8_MODE = (not (RUBY_VERSION =~ /1\.8\.\d*/).nil?)
+  end
+
+end
+
+if Aviator::Compatibility::RUBY_1_8_MODE
+
+  class Module
+
+    alias_method :old_const_defined?, :const_defined?
+
+    def const_defined?(sym, ignore=nil)
+      old_const_defined?(sym)
+    end
+
+
+    alias_method :old_const_get, :const_get
+
+    def const_get(sym, ignore=nil)
+      old_const_get(sym)
+    end
+
+    alias_method :old_instance_methods, :instance_methods
+
+    def instance_methods(include_super=true)
+      old_instance_methods(include_super).map(&:to_sym)
+    end
+
+  end
+
+end

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

@@ -25,11 +25,11 @@ 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
+      service = Aviator::Service.new :provider => provider_name, :service => service_name
       request_class = "Aviator::#{ provider_name.camelize }::#{ service_name.camelize }::"\
                       "#{ api_version.camelize }::#{ endpoint_type.camelize }::#{ request_name.camelize }".constantize
 
-      display = "Request: #{ request_name }\n"
+      display = ":Request => #{ request_name }\n"
 
 
       # Build the parameters
@@ -41,7 +41,7 @@ module Aviator
       if params.length > 0
         display << "\n"
 
-        headings = ['NAME', 'REQUIRED']
+        headings = ['NAME', 'REQUIRED?']
 
         headings << 'ALIAS' if aliases.length > 0
 
@@ -57,13 +57,13 @@ module Aviator
         end
 
         widths = [
-          rows.map{|row| row[0].length }.max,
-          rows.map{|row| row[1].length }.max
+          rows.map{|row| row[0].to_s.length }.max,
+          rows.map{|row| row[1].to_s.length }.max
         ]
 
-        widths << rows.map{|row| row[2].length }.max if aliases.length > 0
+        widths << rows.map{|row| row[2].to_s.length }.max if aliases.length > 0
 
-        table = Terminal::Table.new(headings: headings, rows: rows)
+        table = Terminal::Table.new(:headings => headings, :rows => rows)
 
         table.align_column(1, :center)
 
@@ -118,25 +118,25 @@ module Aviator
       private
 
       def provider_names
-        Pathname.new(__FILE__)
-          .join('..', '..', '..')
-          .children
-          .select{|c| c.directory? && c.basename.to_s != 'core' }
+        Pathname.new(__FILE__) \
+          .join('..', '..', '..') \
+          .children \
+          .select{|c| c.directory? && c.basename.to_s != 'core' } \
           .map{|c| c.basename.to_s }
       end
 
 
       def request_classes(provider_name, service_name)
-        service = Aviator::Service.new(provider: provider_name, service: service_name)
+        service = Aviator::Service.new(:provider => provider_name, :service => service_name)
         service.request_classes
       end
 
 
       def service_names(provider_name)
-        Pathname.new(__FILE__)
-          .join('..', '..', '..', provider_name)
-          .children
-          .select{|c| c.directory? }
+        Pathname.new(__FILE__) \
+          .join('..', '..', '..', provider_name) \
+          .children \
+          .select{|c| c.directory? } \
           .map{|c| c.basename.to_s }
       end
     end

data/lib/aviator/core/logger.rb

@@ -0,0 +1,55 @@
+module Aviator
+
+  class Logger < Faraday::Response::Middleware
+    extend Forwardable
+
+    def initialize(app, logger=nil)
+      super(app)
+      @logger = logger || begin
+        require 'logger'
+        ::Logger.new(self.class::LOG_FILE_PATH)
+      end
+    end
+
+
+    def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+
+    def call(env)
+      info(env[:method].to_s.upcase) { env[:url].to_s }
+      debug('REQ_HEAD') { dump_headers env[:request_headers] }
+      debug('REQ_BODY') { dump_body env[:body] }
+      super
+    end
+
+
+    def on_complete(env)
+      info('STATUS') { env[:status].to_s }
+      debug('RES_HEAD') { dump_headers env[:response_headers] }
+      debug('RES_BODY') { dump_body env[:body] }
+    end
+
+
+    def self.configure(log_file_path)
+      # Return a subclass with its logfile path set. This
+      # must be done so that different sessions can log to
+      # different paths.
+      Class.new(self) { const_set('LOG_FILE_PATH', log_file_path) }
+    end
+
+
+    private
+
+    def dump_body(body)
+      return if body.nil?
+
+      # :TODO => Make this configurable
+      body.gsub(/["']password["']:["']\w*["']/, '"password":[FILTERED_VALUE]')
+    end
+
+    def dump_headers(headers)
+      headers.map { |k, v| "#{k}: #{v.inspect}" }.join("; ")
+    end
+  end
+
+end

data/lib/aviator/core/request.rb

@@ -196,12 +196,13 @@ module Aviator
 
 
       def link(rel, href)
-        links << { rel: rel, href: href }
+        links << { :rel => rel, :href => href }
       end
 
 
       def meta(attr_name, attr_value)
-        define_singleton_method(attr_name) do
+        eigenclass = class << self; self; end
+        eigenclass.send(:define_method, attr_name) do
           attr_value
         end
 
@@ -212,7 +213,7 @@ module Aviator
 
 
       def param(param_name, opts={})
-        opts  = opts.with_indifferent_access
+        opts  = Hashish.new(opts)
         list  = (opts[:required] == false ? optional_params : required_params)
         list << param_name unless optional_params.include?(param_name)
 
@@ -225,4 +226,4 @@ module Aviator
 
   end
 
-end
+end

data/lib/aviator/core/request_builder.rb

@@ -80,7 +80,7 @@ module Aviator
 
   class << self
 
-    def define_request(request_name, options={ inherit: [:request] }, &block)
+    def define_request(request_name, options={ :inherit => [:request] }, &block)
       RequestBuilder.define_request self, request_name, options, &block
     end
 

data/lib/aviator/core/response.rb

@@ -2,11 +2,11 @@ module Aviator
 
   class Response
     extend Forwardable
-    
+
     def_delegators :@response, :headers, :status
-    
+
     attr_reader :request
-    
+
     def initialize(response, request)
       @response = response
       @request  = request
@@ -15,19 +15,25 @@ module Aviator
 
     def body
       if raw_body.length > 0
-        JSON.parse(raw_body).with_indifferent_access
+        if Aviator::Compatibility::RUBY_1_8_MODE
+          clean_body = raw_body.gsub(/\\ /, ' ')
+        else
+          clean_body = raw_body
+        end
+
+        Hashish.new(JSON.parse(clean_body))
       else
-        {}
+        Hashish.new({})
       end
     end
-    
-    
+
+
     private
-    
+
     def raw_body
       @response.body
     end
-    
+
   end
-  
-end
+
+end

data/lib/aviator/core/service.rb

@@ -42,27 +42,14 @@ module Aviator
               "service. Therefore, I don't know to which base URL the request should be sent. "\
               "This may be because you are using a default or unscoped token. If this is not your "\
               "intention, please authenticate with a scoped token. If using a default token is your "\
-              "intention, make sure to provide a base url when you call the request. For example: \n\n"\
-              "session.#{ service_name }_service.request :#{ request_name }, base_url: 'http://myenv.com:9999/v2.0' do |params|\n"\
+              "intention, make sure to provide a base url when you call the request. For :example => \n\n"\
+              "session.#{ service_name }_service.request :#{ request_name }, :base_url => 'http://myenv.com:9999/v2.0' do |params|\n"\
               "  params[:example1] = 'example1'\n"\
               "  params[:example2] = 'example2'\n"\
               "end\n\n"
       end
     end
 
-
-
-    class Logger < Faraday::Response::Logger
-      def initialize(app, logger=nil)
-        super(app)
-        @logger = logger || begin
-          require 'logger'
-          ::Logger.new(self.class::LOG_FILE_PATH)
-        end
-      end
-    end
-
-
     attr_accessor :default_session_data
 
     attr_reader :service,
@@ -84,7 +71,7 @@ module Aviator
       session_data = options[:session_data] || default_session_data
 
       raise SessionDataNotProvidedError.new unless session_data
-      
+
       [:base_url].each do |k|
         session_data[k] = options[k] if options[k]
       end
@@ -116,14 +103,9 @@ module Aviator
 
     def http_connection
       @http_connection ||= Faraday.new do |conn|
-        if log_file
-          # Ugly hack to make logger configurable
-          const_name = 'LOG_FILE_PATH'
-          Logger.send(:remove_const, const_name) if Logger.const_defined?(const_name)
-          Logger.const_set(const_name, log_file)
-          conn.use     Logger.dup
-        end
+        conn.use     Logger.configure(log_file) if log_file
         conn.adapter Faraday.default_adapter
+
         conn.headers['Content-Type'] = 'application/json'
       end
     end
@@ -137,7 +119,7 @@ module Aviator
                          ['Public', 'Admin']
                        end
 
-      namespace = Aviator.const_get(provider.camelize)
+      namespace = Aviator.const_get(provider.camelize) \
                          .const_get(service.camelize)
 
       version = infer_version(session_data, name).to_s.camelize
@@ -182,7 +164,7 @@ module Aviator
 
 
     def load_requests
-      # TODO: This should be determined by a provider-specific module.
+      # :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(
                              '..',
@@ -196,8 +178,8 @@ module Aviator
 
       request_file_paths.each{ |path| require path }
 
-      constant_parts = request_file_paths
-                        .map{|rf| rf.to_s.match(/#{provider}\/#{service}\/([\w\/]+)\.rb$/) }
+      constant_parts = request_file_paths \
+                        .map{|rf| rf.to_s.match(/#{provider}\/#{service}\/([\w\/]+)\.rb$/) } \
                         .map{|rf| rf[1].split('/').map{|c| c.camelize }.join('::') }
 
       @request_classes = constant_parts.map do |cp|