stacker_bee 2.0.0 → 2.1.0.pre180

data/lib/stacker_bee/middleware/base.rb

@@ -0,0 +1,33 @@
+module StackerBee
+  module Middleware
+    class Base < OpenStruct
+      def call(env)
+        before env
+        app.call env
+        after env if matches_content_type?(env)
+      end
+
+      def matches_content_type?(env)
+        content_types.nil? || content_types =~ env.response.content_type
+      end
+
+      def content_types
+      end
+
+      def before(env)
+        env.request.params = params(env.request.params)
+      end
+
+      def after(env)
+      end
+
+      def params(params)
+        params
+      end
+
+      def endpoint_name_for(endpoint_name)
+        app.endpoint_name_for(endpoint_name)
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/clean_response.rb

@@ -0,0 +1,42 @@
+module StackerBee
+  module Middleware
+    class CleanResponse < Base
+      def after(env)
+        body = env.response.body
+
+        return if !is_hash?(body)
+
+        if has_count?(body)
+          env.response.body =remove_count(body)
+        elsif single_hash?(body)
+          env.response.body = first_hash(body)
+        end
+      end
+
+      def is_hash?(body)
+        body.respond_to?(:keys)
+      end
+
+      def has_count?(body)
+        body.size == 2 && body.key?("count")
+      end
+
+      def remove_count(body)
+        body.reject { |key, val| key == "count" }.values.first
+      end
+
+      def single_hash?(body)
+        body.size == 1 && body.values.first.respond_to?(:keys)
+      end
+
+      def first_hash(body)
+        body.values.first
+      end
+
+      def content_types
+        /javascript/
+      end
+    end
+  end
+end
+

data/lib/stacker_bee/middleware/cloud_stack_api.rb

@@ -0,0 +1,17 @@
+module StackerBee
+  module Middleware
+    class CloudStackAPI < Base
+      RESPONSE_TYPE = "json"
+      DEFAULT_PATH  = "/client/api/"
+
+      def before(env)
+        env.request.params.merge!(
+          api_key: api_key,
+          command: env.request.endpoint_name,
+          response: RESPONSE_TYPE
+        )
+        env.request.path ||= DEFAULT_PATH
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/console_access.rb

@@ -0,0 +1,38 @@
+module StackerBee
+  module Middleware
+    class ConsoleAccess < Base
+      include Utilities
+
+      ENDPOINT = 'consoleAccess'
+      PATH     = '/client/console'
+      PARAMS   = { cmd: 'access' }
+
+      def before(env)
+        return unless matches_endpoint?(env.request.endpoint_name)
+        super
+        env.request.path = PATH
+        env.request.endpoint_name = ENDPOINT
+      end
+
+      def params(params)
+        params.merge(PARAMS)
+      end
+
+      def content_types
+        /html/
+      end
+
+      def endpoint_name_for(name)
+        matches_endpoint?(name) ?  ENDPOINT : super
+      end
+
+      def matches_endpoint?(name)
+        uncase(name) == uncased_endpoint
+      end
+
+      def uncased_endpoint
+        @uncased_endpoint ||= uncase(ENDPOINT)
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/de_namespace.rb

@@ -0,0 +1,15 @@
+module StackerBee
+  module Middleware
+    class DeNamespace < Base
+      def after(env)
+        body = env.response.body
+        fail "Cannot determine response key in #{body.keys}" if body.size > 1
+        env.response.body = body.values.first
+      end
+
+      def content_types
+        /javascript/
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/dictionary_flattener.rb

@@ -0,0 +1,44 @@
+module StackerBee
+  module Middleware
+    class DictionaryFlattener < Base
+      LB = "SBLEFTBRACKET"
+      RB = "SBRIGHTBRACKET"
+
+      # TODO: should the tokenizing be separate from the flattener?
+      # it could be a middleware that finds [] in the keys and replaces them
+      def self.tokenize(key)
+        key.gsub('[', LB).gsub(']', RB)
+      end
+
+      def self.detokenize(key)
+        key.gsub(LB, '[').gsub(RB, ']')
+      end
+
+      def params(original)
+        original.dup.tap { |params| flatten_params(params) }
+      end
+
+      def flatten_params(params)
+        hashes = params.select { |_, val| val.respond_to?(:keys) }
+        flatten_map_values params, hashes
+      end
+
+      def flatten_map_values(params, hashes)
+        hashes.each do |hash_name, hash|
+          remove_empties(hash).each_with_index do |(key, value), index|
+            hash_url_key = self.class.tokenize("#{hash_name}[#{index}]")
+            params["#{hash_url_key}.key"] = params["#{hash_url_key}.name"] = key
+            params["#{hash_url_key}.value"] = value
+          end
+          params.delete hash_name
+        end
+      end
+
+      # TODO: isn't this done with the RemoveEmptyStrings middleware?
+      def remove_empties(hash)
+        hash.reject { |_, v| v.nil? || v == "" }
+      end
+    end
+
+  end
+end

data/lib/stacker_bee/middleware/endpoint_normalizer.rb

@@ -0,0 +1,23 @@
+module StackerBee
+  module Middleware
+    class EndpointNormalizer < Base
+      def before(env)
+        new_endpoint_name = endpoint_name_for(env.request.endpoint_name)
+        if new_endpoint_name
+          env.request.endpoint_name = new_endpoint_name
+        end
+      end
+
+      def endpoint_name_for(name)
+        # TODO: shouldn't this be in the base endpoint?
+        fail "API required" unless api
+        endpoint_description = api[name]
+        if endpoint_description
+          endpoint_description.fetch("name")
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/environment.rb

@@ -0,0 +1,23 @@
+module StackerBee
+  module Middleware
+    class Environment < OpenStruct
+      def initialize(request_attributes = {})
+        super()
+
+        defaults = { params: {} }
+        self.request = Request.new(defaults.merge(request_attributes))
+
+        self.response = Response.new
+      end
+
+      class Request < OpenStruct
+      end
+
+      class Response < OpenStruct
+        def success?
+          !!success
+        end
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/format_keys.rb

@@ -0,0 +1,13 @@
+module StackerBee
+  module Middleware
+    class FormatKeys < Base
+      include Utilities
+
+      def params(params)
+        transform_hash_keys(params) do |key|
+          camel_case(key, true)
+        end
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/format_values.rb

@@ -0,0 +1,13 @@
+module StackerBee
+  module Middleware
+    class FormatValues < Base
+      include Utilities
+
+      def params(params)
+        transform_hash_values(params) do |value|
+          value.respond_to?(:join) ? value.join(',') : value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/http_status.rb

@@ -0,0 +1,14 @@
+module StackerBee
+  module Middleware
+    class HTTPStatus < Base
+      def after(env)
+        env.response.status  = env.raw_response.status
+        env.response.success = env.raw_response.success?
+
+        unless env.response.success?
+          env.response.error = env.response.body[:errortext]
+        end
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/json_body.rb

@@ -0,0 +1,14 @@
+module StackerBee
+  module Middleware
+    class JSONBody < Base
+      def after(env)
+        env.response.raw_body = env.raw_response.body
+        env.response.body = MultiJson.load(env.response.raw_body)
+      end
+
+      def content_types
+        /javascript/
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/raise_on_http_error.rb

@@ -0,0 +1,11 @@
+require "stacker_bee/request_error"
+
+module StackerBee
+  module Middleware
+    class RaiseOnHTTPError < Base
+      def after(env)
+        fail RequestError.for(env) unless env.raw_response.success?
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/rashify_response.rb

@@ -0,0 +1,21 @@
+require 'stacker_bee/rash'
+
+module StackerBee
+  module Middleware
+    class RashifyResponse < Base
+      def after(env)
+        body = env.response.body
+        env.response.body = case body
+                            when Hash  then Rash.new(body)
+                            when Array then body.map { |item| Rash.new(item) }
+                            else
+                              body
+                            end
+      end
+
+      def content_types
+        /javascript/
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/remove_empty_strings.rb

@@ -0,0 +1,11 @@
+module StackerBee
+  module Middleware
+    class RemoveEmptyStrings < Base
+      def before(env)
+        Utilities.hash_deeply(env.request.params) do |hash|
+          hash.delete_if { |_, val| val == '' }
+        end
+      end
+    end
+  end
+end

data/lib/stacker_bee/middleware/remove_nils.rb

@@ -0,0 +1,9 @@
+module StackerBee
+  module Middleware
+    class RemoveNils < Base
+      def params(params)
+        params.reject { |key, val| val.nil? }
+      end
+    end
+  end
+end

data/lib/stacker_bee/request_error.rb

@@ -1,30 +1,22 @@
-require "stacker_bee/body_parser"
-
 module StackerBee
   class RequestError < StandardError
-    include BodyParser
+    attr_accessor :env, :status
 
-    def initialize(raw_body)
-      self.body = raw_body
+    def initialize(env)
+      self.env = env
+      self.status = env.response.status
+      super(env.response.error)
     end
 
-    def self.for(raw_response)
-      klass = case raw_response.status
+    def self.for(env)
+      klass = case env.response.status
               when 401      then AuthenticationError
               when 400..499 then ClientError
               when 500..599 then ServerError
               else
                 self
               end
-      klass.new(raw_response)
-    end
-
-    def status
-      body["errorcode"]
-    end
-
-    def to_s
-      body["errortext"]
+      klass.new(env)
     end
   end
 

data/lib/stacker_bee/utilities.rb

@@ -2,6 +2,8 @@ module StackerBee
   module Utilities
     REGEX = /\s|-|_/
 
+    module_function
+
     def uncase(string)
       string.to_s.downcase.gsub(REGEX, '')
     end
@@ -10,11 +12,39 @@ module StackerBee
       string.to_s.gsub(/(.)([A-Z])/, '\1_\2').gsub(/(\W|_)+/, '_').downcase
     end
 
+    # TODO: avoid flag arguments
     def camel_case(string, lower = false)
       string.to_s.split(REGEX).each_with_object('') do |word, memo|
         memo << (memo.empty? && lower ? word[0].downcase : word[0].upcase)
         memo << word[1..-1]
       end
     end
+
+    def hash_deeply(hash, &block)
+      block.call hash
+
+      hash.values
+        .select { |val| val.respond_to?(:to_hash) }
+        .each   { |val| hash_deeply val, &block }
+    end
+
+    def map_a_hash(hash)
+      hash.each_with_object({}) do |pair, new_hash|
+        key, value = yield(*pair)
+        new_hash[key] = value
+      end
+    end
+
+    def transform_hash_values(hash)
+      map_a_hash(hash) do |key, val|
+        [key, yield(val)]
+      end
+    end
+
+    def transform_hash_keys(hash)
+      map_a_hash(hash) do |key, val|
+        [yield(key), val]
+      end
+    end
   end
 end

data/lib/stacker_bee/version.rb

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

data/lib/stacker_bee.rb

@@ -2,4 +2,4 @@ require_relative "stacker_bee/version"
 require_relative "stacker_bee/client"
 
 require_relative "faraday_middleware/response/graylog"
-require_relative "stacker_bee/graylog_faraday_middleware"
+require_relative "stacker_bee/http_middleware/graylog"

data/spec/cassettes/A_request_sent_to_CloudStack_for_console_access/returns_html_for_console_access.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: <CLOUD_STACK_HOST>/client/console?apiKey=<CLOUD_STACK_API_KEY>&cmd=access&command=consoleAccess&response=json&signature=DsI/kxaNO7AgzDCgE1j/3rtq3xU&vm=36f9c08b-f17a-4d0e-ac9b-d45ce2d34fcd
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - text/html
+      Content-Length:
+      - '616'
+      Date:
+      - Tue, 11 Feb 2014 19:33:34 GMT
+    body:
+      encoding: UTF-8
+      string: <html><title>console2</title><frameset><frame src="https://207-19-99-5.realhostip.com/ajax?token=FAKE_TOKEN"></frame></frameset></html>
+    http_version:
+  recorded_at: Tue, 11 Feb 2014 19:34:25 GMT

data/spec/cassettes/A_response_to_a_request_sent_to_the_CloudStack_API/a_request_that_triggers_an_error/properly_signs_the_request.yml

@@ -0,0 +1,35 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: <CLOUD_STACK_URL>?apiKey=<CLOUD_STACK_API_KEY>&command=listAccounts&domainId=666&response=json&signature=xsXEaSNzlFQjI3%2B4EVBOV%2BwFrbM=
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 431
+      message: '431'
+    headers:
+      X-Description:
+      - Domain id=666 doesn't exist
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Content-Length:
+      - '121'
+      Server:
+      - Jetty(6.1.26)
+    body:
+      encoding: UTF-8
+      string: '{ "listaccountsresponse" : {"uuidList":[],"errorcode":431,"cserrorcode":4350,"errortext":"Domain
+        id=666 doesn''t exist"} }'
+    http_version: 
+  recorded_at: Tue, 11 Feb 2014 02:48:17 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/A_response_to_a_request_sent_to_the_CloudStack_API/middleware/a_middleware_that_doesn_t_match_the_content_type/uses_the_middleware.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: <CLOUD_STACK_URL>?apiKey=<CLOUD_STACK_API_KEY>&command=listAccounts&response=json&signature=oftBcJm8kFc%2Buxul8pAL2%2Bh0bdU=
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Content-Length:
+      - '1727'
+      Server:
+      - Jetty(6.1.26)
+    body:
+      encoding: UTF-8
+      string: '{ "listaccountsresponse" : { "count":1 ,"account" : [  {"id":"ce45d9a0-41f5-11e3-aaa7-d6558ad1fb9f","name":"admin","accounttype":1,"domainid":"ce4585b8-41f5-11e3-aaa7-d6558ad1fb9f","domain":"ROOT","vmlimit":"Unlimited","vmtotal":0,"vmavailable":"Unlimited","iplimit":"Unlimited","iptotal":0,"ipavailable":"Unlimited","volumelimit":"Unlimited","volumetotal":0,"volumeavailable":"Unlimited","snapshotlimit":"Unlimited","snapshottotal":0,"snapshotavailable":"Unlimited","templatelimit":"Unlimited","templatetotal":0,"templateavailable":"Unlimited","projectlimit":"Unlimited","projecttotal":0,"projectavailable":"Unlimited","networklimit":"Unlimited","networktotal":0,"networkavailable":"Unlimited","vpclimit":"Unlimited","vpctotal":0,"vpcavailable":"Unlimited","cpulimit":"Unlimited","cputotal":0,"cpuavailable":"Unlimited","memorylimit":"Unlimited","memorytotal":0,"memoryavailable":"Unlimited","primarystoragelimit":"Unlimited","primarystoragetotal":0,"primarystorageavailable":"Unlimited","secondarystoragelimit":"Unlimited","secondarystoragetotal":0,"secondarystorageavailable":"Unlimited","state":"enabled","user":[{"id":"ce46057e-41f5-11e3-aaa7-d6558ad1fb9f","username":"admin","firstname":"Admin","lastname":"User","email":"admin@mailprovider.com","created":"2013-10-30T22:29:33-0400","state":"enabled","account":"admin","accounttype":1,"domainid":"ce4585b8-41f5-11e3-aaa7-d6558ad1fb9f","domain":"ROOT","apikey":"<CLOUD_STACK_API_KEY>","secretkey":"<CLOUD_STACK_SECRET_KEY>","accountid":"ce45d9a0-41f5-11e3-aaa7-d6558ad1fb9f","iscallerchilddomain":false,"isdefault":true}],"isdefault":true}
+        ] } }'
+    http_version: 
+  recorded_at: Sat, 15 Feb 2014 20:42:23 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/A_response_to_a_request_sent_to_the_CloudStack_API/middleware/a_middleware_that_matches_the_content_type/uses_the_middleware.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: <CLOUD_STACK_URL>?apiKey=<CLOUD_STACK_API_KEY>&command=listAccounts&response=json&signature=oftBcJm8kFc%2Buxul8pAL2%2Bh0bdU=
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Content-Length:
+      - '1727'
+      Server:
+      - Jetty(6.1.26)
+    body:
+      encoding: UTF-8
+      string: '{ "listaccountsresponse" : { "count":1 ,"account" : [  {"id":"ce45d9a0-41f5-11e3-aaa7-d6558ad1fb9f","name":"admin","accounttype":1,"domainid":"ce4585b8-41f5-11e3-aaa7-d6558ad1fb9f","domain":"ROOT","vmlimit":"Unlimited","vmtotal":0,"vmavailable":"Unlimited","iplimit":"Unlimited","iptotal":0,"ipavailable":"Unlimited","volumelimit":"Unlimited","volumetotal":0,"volumeavailable":"Unlimited","snapshotlimit":"Unlimited","snapshottotal":0,"snapshotavailable":"Unlimited","templatelimit":"Unlimited","templatetotal":0,"templateavailable":"Unlimited","projectlimit":"Unlimited","projecttotal":0,"projectavailable":"Unlimited","networklimit":"Unlimited","networktotal":0,"networkavailable":"Unlimited","vpclimit":"Unlimited","vpctotal":0,"vpcavailable":"Unlimited","cpulimit":"Unlimited","cputotal":0,"cpuavailable":"Unlimited","memorylimit":"Unlimited","memorytotal":0,"memoryavailable":"Unlimited","primarystoragelimit":"Unlimited","primarystoragetotal":0,"primarystorageavailable":"Unlimited","secondarystoragelimit":"Unlimited","secondarystoragetotal":0,"secondarystorageavailable":"Unlimited","state":"enabled","user":[{"id":"ce46057e-41f5-11e3-aaa7-d6558ad1fb9f","username":"admin","firstname":"Admin","lastname":"User","email":"admin@mailprovider.com","created":"2013-10-30T22:29:33-0400","state":"enabled","account":"admin","accounttype":1,"domainid":"ce4585b8-41f5-11e3-aaa7-d6558ad1fb9f","domain":"ROOT","apikey":"<CLOUD_STACK_API_KEY>","secretkey":"<CLOUD_STACK_SECRET_KEY>","accountid":"ce45d9a0-41f5-11e3-aaa7-d6558ad1fb9f","iscallerchilddomain":false,"isdefault":true}],"isdefault":true}
+        ] } }'
+    http_version: 
+  recorded_at: Sat, 15 Feb 2014 20:39:56 GMT
+recorded_with: VCR 2.8.0

data/spec/integration/check_spec.rb

@@ -0,0 +1,48 @@
+if false
+require 'spec_helper'
+
+describe "Client initialization configures the middleware" do
+  context "pass a new middleware to the client" do
+    subject { StackerBee::Client.new(config_hash) }
+
+    let(:url) { CONFIG["url"] }
+    let(:config_hash) do
+      {
+        url:        url,
+        api_key:    api_key,
+        secret_key: secret_key,
+        apis_path:  File.join(File.dirname(__FILE__), '../fixtures/4.2.json'),
+        faraday_middlewares: ->(faraday) { faraday.use middleware_class }
+      }
+    end
+
+    let(:middleware_class) do
+      Class.new(Faraday::Middleware) do
+        def call(env)
+          $query = env[:url].query
+          fail "MiddlewareUsed"
+        end
+      end
+    end
+
+    before do
+      $query = nil
+    end
+
+    data = JSON.parse(File.read("/Users/mike/Desktop/stuff.json"))
+    data.each do |request|
+      context "something" do
+        let(:api_key)    { request["config"]["api_key"] }
+        let(:secret_key) { request["config"]["secret_key"] }
+        it do
+          expect {
+            subject.request(*request["input"])
+          }.to raise_exception "MiddlewareUsed"
+
+          $query.should == request["query"]
+        end
+      end
+    end
+  end
+end
+end