stacker_bee 2.1.0.pre236 → 2.1.1.pre247

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGMwMTczNmU3MjVmMjM2ZGM2OGI1MzU1M2NhNDI1MTE0NDdiYjhiYQ==
+    ZTU4NzkwYjgxZGRjZTQ0MzBiMmY0Nzc2YThkMzRiYjA3ZGJmMzIyNw==
   data.tar.gz: !binary |-
-    ZDZkZWJjMDkyNWNjMTc2YmUxYmFkYzYxOTgzZTlkMDNlMjEzY2NmMQ==
+    OGJiOTIwNzY3ODM4NzBkNGRkNGVjNzNmN2UzMzgxNzM0NTBkYzZhMg==
 SHA512:
   metadata.gz: !binary |-
-    NDhhNmFjNWJlY2FjMTQzNDk1MzFjOGU5NGFhZDA3ODMwYzU1YjBlNzJkNmFl
-    ZWUyNTY5YmVjM2VkZWE3Y2VmYjk1YTdhODczOGFhMWM2ZGYzNmRjZWQyN2Q0
-    ZmYxNzE5OTJiZDVlZWJkZTZjYzA2ZGI1ZDI3YWUxMGNmNGIwN2M=
+    MmVkYWNhOTQ1N2IxNDNhMTRkMWE3NzQyZmViM2Q1MTg3YWNjMzdmMGUyMDBh
+    MTc1OTNiNTAyMThkY2NhNmM4MmU4ZWQyNmM4NjJhNzZmZGM1YTYzY2ZiZDZj
+    NThhOTgzOGVmNDVmNTM4ODAzNmE4NWJmYTAyNDRhNzZhM2FkNmU=
   data.tar.gz: !binary |-
-    ZjUxZTg3YmE0ZmVlYTBmNjUwNmE1ZWNkYjg3MWM4ODYwOGFkOTc3ZmQ1Mjdl
-    MGE0NzkzNTJhZTYzYjZjOTI2ZWIwNWY2ZTc3ZmZkODY0MGY2ZGYzMjNlY2I1
-    YzA0MDdmYTBlZGE4MzJiMTAzNjkyOGQyYmY1NDEwNzU3N2UwODI=
+    MDkyNDVmZDhiOGZmMGI2OTU5YjQ5MjNjMGNhNGMwOTg5MGFiMzVhYmUxN2Ix
+    OTdiYTBhNzA0OGQwYmIzZWU1NzljNmI4NWZiZjY1MTY5MTcxMGE3MzkxOWJh
+    NGY0ZmUwZWI5Y2Y3YmU3YWE3YTc5ZGNmZGQyNTQ5MTAzNzc3YmE=

data/README.md

@@ -204,31 +204,7 @@ StackerBee itself puts some middlewares on Faraday. Any middlewares you add will
 
 ### Logging
 
-Logging is best handled with Faraday middleware.
-
-#### GELF/Graylog2
-
-If you're using the Graylog2 GELF format, you're in luck because StackerBee currently ships with a Faraday middleware for that. Here's an example of logging to Graylog2:
-
-```ruby
-logger = GELF::Notifier.new("localhost", 12201)
-
-StackerBee::Client.configuration = {
-  faraday_middlewares: ->(faraday) do
-    faraday.use StackerBee::HTTPMiddleware::Graylog, logger
-  end
-}
-```
-
-#### Basic logging
-
-To log to a file or STDOUT, Faraday has a built-in logger. You can use it like so:
-
-```ruby
-StackerBee::Client.configuration = {
-  faraday_middlewares: ->(faraday) { faraday.response :logger }
-}
-```
+You can configure logging by passing in a logger object that adheres to the standard log4* logging conventions
 
 ### Bulk Configuration
 

data/lib/stacker_bee/client.rb

@@ -21,6 +21,7 @@ require "stacker_bee/middleware/raise_on_http_error"
 require "stacker_bee/middleware/http_status"
 require "stacker_bee/middleware/console_access"
 require "stacker_bee/middleware/error_message"
+require "stacker_bee/middleware/log_response"
 
 # rubocop:disable ClassLength
 module StackerBee
@@ -48,6 +49,7 @@ module StackerBee
       # response
       builder.use Middleware::RaiseOnHTTPError
       builder.use Middleware::ErrorMessage
+      builder.use Middleware::LogResponse
       builder.use Middleware::HTTPStatus
       builder.use Middleware::CleanResponse
       builder.use Middleware::RashifyResponse
@@ -110,7 +112,8 @@ module StackerBee
       env = Middleware::Environment.new(
         endpoint_name: endpoint_name,
         api_key:       configuration.api_key,
-        params:        params
+        params:        params,
+        logger:        configuration.logger
       )
 
       middleware_app.call(env)

data/lib/stacker_bee/configuration.rb

@@ -9,12 +9,12 @@ module StackerBee
       :secret_key,
       :api_key,
       :middlewares,
-      :faraday_middlewares
+      :faraday_middlewares,
+      :logger
     ]
 
     def initialize(attrs = nil)
       @attributes = attrs || {}
-
       @attributes.each_pair do |key, value|
         unless ATTRIBUTES.include?(key)
           fail NoAttributeError, "No attribute defined: '#{key}'"
@@ -46,6 +46,10 @@ module StackerBee
       attribute :faraday_middlewares, proc {}
     end
 
+    def logger
+      attribute :logger
+    end
+
     def to_hash
       @attributes
     end

data/lib/stacker_bee/connection.rb

@@ -27,7 +27,6 @@ module StackerBee
       @faraday = Faraday.new(options) do |faraday|
         faraday.use HTTPMiddleware::Detokenizer
         faraday.use HTTPMiddleware::SignedQuery, configuration.secret_key
-
         configuration.faraday_middlewares.call faraday
 
         unless using_adapter?(faraday.builder.handlers)
@@ -45,6 +44,7 @@ module StackerBee
     def get(path, params)
       @faraday.get(path, params)
     rescue Faraday::Error::ConnectionFailed => error
+      configuration.logger.error error if configuration.logger
       raise ConnectionError,
             "Failed to connect to #{configuration.url}, #{error}"
     end

data/lib/stacker_bee/middleware/environment.rb

@@ -10,6 +10,7 @@ module StackerBee
         self.request = Request.new(defaults.merge(request_attributes))
 
         self.response = Response.new
+        self.logger = request_attributes[:logger]
       end
 
       class Request < OpenStruct

data/lib/stacker_bee/middleware/log_response.rb

@@ -0,0 +1,36 @@
+module StackerBee
+  module Middleware
+    class LogResponse < Base
+      def after(env)
+        return unless env.logger
+        params = env.request.params.to_a.sort
+        command = params.find { |key, _| key == "command" }.last
+
+        log(env, params, command)
+      end
+
+      def log(env, params, command)
+        log_data = base_log_data(env, params)
+        if env.response.success?
+          log_data[:short_message] = command
+          env.logger.info log_data
+        else
+          log_data[:short_message] = "#{command} failed: #{env.response.error}"
+          env.logger.error log_data
+        end
+      end
+
+      def base_log_data(env, params)
+        {
+          request_path: env.request.path,
+          params: params,
+          response_body: env.raw_response[:body]
+        }
+      end
+
+      def content_types
+        /javascript/
+      end
+    end
+  end
+end

data/lib/stacker_bee/version.rb

@@ -1,3 +1,3 @@
 module StackerBee
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/lib/stacker_bee.rb

@@ -1,5 +1,2 @@
 require_relative "stacker_bee/version"
 require_relative "stacker_bee/client"
-
-require_relative "faraday_middleware/response/graylog"
-require_relative "stacker_bee/http_middleware/graylog"

data/spec/spec_helper.rb

@@ -17,6 +17,11 @@ CONFIG.merge!(YAML.load(File.read(config_file))) if File.exist?(config_file)
 
 require 'webmock/rspec'
 
+support_files = Dir[File.join(
+  File.expand_path("../../spec/support/**/*.rb", __FILE__)
+)]
+support_files.each { |f| require f }
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
@@ -32,37 +37,3 @@ RSpec.configure do |config|
     StackerBee::Client.reset!
   end
 end
-
-require 'vcr'
-
-VCR.configure do |c|
-  c.hook_into :webmock
-  c.cassette_library_dir = 'spec/cassettes'
-
-  c.filter_sensitive_data('<CLOUD_STACK_URL>') do
-    CONFIG["url"]
-  end
-
-  c.filter_sensitive_data('<CLOUD_STACK_HOST>') do
-    uri = URI.parse(CONFIG["url"])
-    "#{uri.scheme}://#{uri.host}:#{uri.port}"
-  end
-
-  c.filter_sensitive_data('<CLOUD_STACK_API_KEY>') do
-    CONFIG["api_key"]
-  end
-
-  c.filter_sensitive_data('<CLOUD_STACK_SECRET_KEY>') do
-    CONFIG["secret_key"]
-  end
-
-  c.default_cassette_options = {
-    record: :new_episodes,
-    match_requests_on: [
-      :method,
-      VCR.request_matchers.uri_without_param(:signature)
-    ]
-  }
-
-  c.configure_rspec_metadata!
-end

data/spec/support/fake_logger.rb

@@ -0,0 +1,26 @@
+class FakeLogger
+  attr_accessor :logs
+  def initialize
+    @logs = []
+  end
+
+  def debug(obj)
+    logs << obj
+  end
+
+  def info(obj)
+    logs << obj
+  end
+
+  def warn(obj)
+    logs << obj
+  end
+
+  def error(obj)
+    logs << obj
+  end
+
+  def fatal(obj)
+    logs << obj
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,33 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.hook_into :webmock
+  c.cassette_library_dir = 'spec/cassettes'
+
+  c.filter_sensitive_data('<CLOUD_STACK_URL>') do
+    CONFIG["url"]
+  end
+
+  c.filter_sensitive_data('<CLOUD_STACK_HOST>') do
+    uri = URI.parse(CONFIG["url"])
+    "#{uri.scheme}://#{uri.host}:#{uri.port}"
+  end
+
+  c.filter_sensitive_data('<CLOUD_STACK_API_KEY>') do
+    CONFIG["api_key"]
+  end
+
+  c.filter_sensitive_data('<CLOUD_STACK_SECRET_KEY>') do
+    CONFIG["secret_key"]
+  end
+
+  c.default_cassette_options = {
+    record: :new_episodes,
+    match_requests_on: [
+      :method,
+      VCR.request_matchers.uri_without_param(:signature)
+    ]
+  }
+
+  c.configure_rspec_metadata!
+end

data/spec/units/stacker_bee/middleware/cloudstack_api_spec.rb

@@ -7,11 +7,12 @@ describe StackerBee::Middleware::CloudStackAPI do
       path: path
     )
   end
-
   let(:middleware) { described_class.new(api_key: "API-KEY", params: {}) }
   let(:path) { nil }
 
-  before { middleware.before(env) }
+  before do
+    middleware.before(env)
+  end
 
   describe "request" do
     subject { env.request }

data/spec/units/stacker_bee/middleware/log_response_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+describe StackerBee::Middleware::LogResponse do
+  describe "after" do
+    let(:logger) { FakeLogger.new }
+
+    let(:env) do
+      env = StackerBee::Middleware::Environment.new(logger: logger)
+      env.raw_response = { body: "some body" }
+      env.request.params = { "command" => "some command" }
+      env.request.path = "some/path"
+      env
+    end
+
+    shared_examples_for "all logs" do
+      it "logs the details" do
+        logger.logs.length.should eq 1
+        logger.logs.last[:request_path].should eq env.request.path
+        logger.logs.last[:params].should eq env.request.params.to_a
+        logger.logs.last[:response_body].should eq env.raw_response[:body]
+      end
+    end
+
+    context "error response" do
+      before do
+        env.response.success = false
+        env.response.error = "invalid request"
+        subject.after(env)
+      end
+
+      it_should_behave_like "all logs"
+      it "should have logged the details" do
+        logger.logs.last[:short_message].should eq \
+          "some command failed: invalid request"
+      end
+    end
+
+    context "success response" do
+      before do
+        env.response.success = true
+        subject.after(env)
+      end
+
+      it_should_behave_like "all logs"
+      it "should have logged the details" do
+        logger.logs.length.should eq 1
+        logger.logs.last[:short_message].should eq "some command"
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stacker_bee
 version: !ruby/object:Gem::Version
-  version: 2.1.0.pre236
+  version: 2.1.1.pre247
 platform: ruby
 authors:
 - Greg Sterndale
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -176,7 +176,6 @@ files:
 - bin/stacker_bee
 - config.default.yml
 - config/4.2.json
-- lib/faraday_middleware/response/graylog.rb
 - lib/stacker_bee.rb
 - lib/stacker_bee/api.rb
 - lib/stacker_bee/builder.rb
@@ -200,6 +199,7 @@ files:
 - lib/stacker_bee/middleware/format_values.rb
 - lib/stacker_bee/middleware/http_status.rb
 - lib/stacker_bee/middleware/json_body.rb
+- lib/stacker_bee/middleware/log_response.rb
 - lib/stacker_bee/middleware/raise_on_http_error.rb
 - lib/stacker_bee/middleware/rashify_response.rb
 - lib/stacker_bee/middleware/remove_empty_strings.rb
@@ -232,12 +232,12 @@ files:
 - spec/integration/console_spec.rb
 - spec/integration/request_spec.rb
 - spec/spec_helper.rb
-- spec/units/faraday_graylog_middleware_spec.rb
+- spec/support/fake_logger.rb
+- spec/support/vcr.rb
 - spec/units/stacker_bee/api_spec.rb
 - spec/units/stacker_bee/client_spec.rb
 - spec/units/stacker_bee/configuration_spec.rb
 - spec/units/stacker_bee/connection_spec.rb
-- spec/units/stacker_bee/http_middleware/graylog_spec.rb
 - spec/units/stacker_bee/middleware/adapter_spec.rb
 - spec/units/stacker_bee/middleware/base_spec.rb
 - spec/units/stacker_bee/middleware/cloudstack_api_spec.rb
@@ -248,6 +248,7 @@ files:
 - spec/units/stacker_bee/middleware/format_keys_spec.rb
 - spec/units/stacker_bee/middleware/format_values_spec.rb
 - spec/units/stacker_bee/middleware/http_status_spec.rb
+- spec/units/stacker_bee/middleware/log_response_spec.rb
 - spec/units/stacker_bee/middleware/raise_on_http_errors_spec.rb
 - spec/units/stacker_bee/middleware/remove_empty_strings_spec.rb
 - spec/units/stacker_bee/middleware/remove_nils_spec.rb
@@ -305,12 +306,12 @@ test_files:
 - spec/integration/console_spec.rb
 - spec/integration/request_spec.rb
 - spec/spec_helper.rb
-- spec/units/faraday_graylog_middleware_spec.rb
+- spec/support/fake_logger.rb
+- spec/support/vcr.rb
 - spec/units/stacker_bee/api_spec.rb
 - spec/units/stacker_bee/client_spec.rb
 - spec/units/stacker_bee/configuration_spec.rb
 - spec/units/stacker_bee/connection_spec.rb
-- spec/units/stacker_bee/http_middleware/graylog_spec.rb
 - spec/units/stacker_bee/middleware/adapter_spec.rb
 - spec/units/stacker_bee/middleware/base_spec.rb
 - spec/units/stacker_bee/middleware/cloudstack_api_spec.rb
@@ -321,6 +322,7 @@ test_files:
 - spec/units/stacker_bee/middleware/format_keys_spec.rb
 - spec/units/stacker_bee/middleware/format_values_spec.rb
 - spec/units/stacker_bee/middleware/http_status_spec.rb
+- spec/units/stacker_bee/middleware/log_response_spec.rb
 - spec/units/stacker_bee/middleware/raise_on_http_errors_spec.rb
 - spec/units/stacker_bee/middleware/remove_empty_strings_spec.rb
 - spec/units/stacker_bee/middleware/remove_nils_spec.rb

data/lib/faraday_middleware/response/graylog.rb

@@ -1,35 +0,0 @@
-require 'faraday_middleware'
-require 'faraday_middleware/response_middleware'
-
-module FaradayMiddleware
-  class Graylog < ResponseMiddleware
-    INFO  = 1
-    ERROR = 3
-
-    attr_accessor :facility
-
-    def initialize(app, logger, options = {})
-      @logger       = logger
-      self.facility = options[:facility] || "faraday-middleware-graylog"
-
-      super app, options
-    end
-
-    def process_response(env)
-      @logger.info(
-        facility:      facility,
-        short_message: short_message(env),
-        level:         level(env),
-        _data:         env.dup.tap { |e| e.delete(:response) }
-      )
-    end
-
-    def short_message(env)
-      facility + " Request"
-    end
-
-    def level(env)
-      env[:status] < 400 ? INFO : ERROR
-    end
-  end
-end

data/spec/units/faraday_graylog_middleware_spec.rb

@@ -1,80 +0,0 @@
-require 'spec_helper'
-
-describe FaradayMiddleware::Graylog do
-  subject { log_data }
-
-  class DummyLogger
-    attr_accessor :data
-    alias_method :info, :data=
-  end
-
-  let(:log_data) { logger.data }
-  let(:logger)   { DummyLogger.new }
-
-  let(:dummy_adapter) { ->(env) { Faraday::Response.new(env) } }
-  let(:middleware) do
-    described_class.new(dummy_adapter, logger, facility: facility)
-  end
-
-  let(:env) do
-    {
-      body: "DATA",
-      response_headers: {},
-      response: {},
-      status: status
-    }
-  end
-  let(:facility) { nil }
-
-  before { middleware.call(env) }
-
-  context "a basic request" do
-    let(:status) { 200 }
-
-    its([:facility]) { should eq "faraday-middleware-graylog" }
-    its([:short_message]) { should eq "faraday-middleware-graylog Request" }
-    its([:_data]) do
-      should eq(body: "DATA", response_headers: {}, status: status)
-    end
-  end
-
-  context "given a facility" do
-    let(:status) { 200 }
-    let(:facility) { "stacker_bee" }
-
-    its([:facility]) { should eq "stacker_bee" }
-  end
-
-  context "a successful request" do
-    let(:status) { 200 }
-    its([:level]) { should eq FaradayMiddleware::Graylog::INFO }
-  end
-
-  context "a failed request" do
-    let(:status) { 500 }
-    its([:level]) { should eq FaradayMiddleware::Graylog::ERROR }
-  end
-
-  describe "a subclass" do
-    class GrayLogSubclass < FaradayMiddleware::Graylog
-      def short_message(env)
-        "Short message: #{env[:status]}"
-      end
-
-      def level(env)
-        env[:status]
-      end
-    end
-
-    let(:middleware) { GrayLogSubclass.new(dummy_adapter, logger) }
-    let(:status) { 401 }
-
-    it "can override the level determining logic" do
-      log_data[:level].should eq 401
-    end
-
-    it "can override the short_message logic" do
-      log_data[:short_message].should eq "Short message: 401"
-    end
-  end
-end

data/spec/units/stacker_bee/http_middleware/graylog_spec.rb

@@ -1,51 +0,0 @@
-require 'spec_helper'
-
-describe StackerBee::HTTPMiddleware::Graylog do
-  subject { log_data }
-
-  class DummyLogger
-    attr_accessor :data
-    alias_method :info, :data=
-  end
-
-  let(:log_data) { logger.data }
-  let(:logger)   { DummyLogger.new }
-
-  let(:dummy_adapter) { ->(env) { Faraday::Response.new(env) } }
-  let(:middleware) { described_class.new(dummy_adapter, logger) }
-  let(:status) { 200 }
-
-  let(:env) do
-    {
-      body: "DATA",
-      response_headers: {},
-      response: {},
-      status: status,
-      url: URI.parse("http://a.b/?key=KEY&command=listVirtualMachines&val=val")
-    }
-  end
-
-  before { middleware.call(env) }
-
-  it "sets a custom short message" do
-    log_data[:short_message].should eq "StackerBee listVirtualMachines"
-  end
-
-  its([:facility]) { should == "stacker-bee" }
-
-  context "without a command in the url" do
-    let(:env) do
-      {
-        body: "DATA",
-        response_headers: {},
-        response: {},
-        status: status,
-        url: URI.parse("http://a.b/?key=KEY&&val=val")
-      }
-    end
-
-    it "sets a custom short message" do
-      log_data[:short_message].should eq "StackerBee"
-    end
-  end
-end