cloudcheckr 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec582152815019c9671a80a39292bb06e20a3aa
-  data.tar.gz: 91019358515155970f75a17af21282dd3f0a2743
+  metadata.gz: fc03c92dad276e512d647ec770c032e3744a0a90
+  data.tar.gz: 51e06d2c96c2fbc45d2c30413ac551ebd8a55d8b
 SHA512:
-  metadata.gz: d23ddc22acb2a9a37ec7e0aa5de661abe3b16416e9e1bb69c032126d06316b7abdb5b22ab514f7dcf0ffdc7a2e8078fcc13a4510cdfcebd8ecda3282849b0902
-  data.tar.gz: 7f817f70d6d89f74321cfb83d53b9ad2d1380b889a033efa09c66fc7f76c08ca2fd3c5e2e59efbabba23d04cdfb10410d666240bd4793057a1dc8583790af134
+  metadata.gz: 1a91207b4415e44b58749935a7fca2e677f674b13d6ee44f7fdb005ec236a2cc48d423b8a19eeea08af33be5b11d706d5643c26ee67f6438beafc683b0984279
+  data.tar.gz: 73f6e0268e4aadc1ec63bbbd75414929fa07dfb6e48b247b5573acbe55f8a7d085c1e8425f61b162f8e8c52f296d240d7215074b78f5f72b1fcd4a24200f185b

data/README.md

@@ -32,6 +32,10 @@ client = CloudCheckr::API::Client.new
 ENV['CLOUDCHECKR_ACCESS_KEY'] = "146D0Y8R...W6U0463K"
 client = CloudCheckr::API::Client.new
 
+# JSON responses automatically convert keys from camel case to snake case.
+# You can disable key conversion globally
+CloudCheckr::API.snake_case_json_keys(false)
+
 # Use XML instead (not fully implemented)
 client = CloudCheckr::API::Client.new(format: :xml)
 ```
@@ -105,13 +109,13 @@ The API client uses [Faraday](https://github.com/lostisland/faraday) under the h
 It's easy to customize Faraday to your liking.
 
 ```ruby
-# Globally apply Faraday settings
+# Globally apply Faraday settings (middleware evaluated in reverse!)
 CloudCheckr::API.connection_builder do |faraday|
   faraday.request :url_encoded
 
+  faraday.response :mashify
   faraday.response :xml,     content_type: /\bxml$/
   faraday.response :json,    content_type: /\bjson$/
-  faraday.response :mashify, content_type: /\bjson$/
   faraday.response :logger, nil, bodies: true
 
   faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP
@@ -121,9 +125,9 @@ end
 client = CloudCheckr::API::Client.new do
   faraday.request :url_encoded
 
+  faraday.response :mashify
   faraday.response :xml,     content_type: /\bxml$/
   faraday.response :json,    content_type: /\bjson$/
-  faraday.response :mashify, content_type: /\bjson$/
   faraday.response :logger, nil, bodies: true
 
   faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP

data/cloudcheckr.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
+  spec.add_dependency "hashie"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/cloud_checkr/api.rb

@@ -7,24 +7,41 @@ module CloudCheckr
   module API
     CONTROLLERS = CloudCheckr::API::Controllers.build_controller_classes!
 
+    @@access_key           = ENV['CLOUDCHECKR_ACCESS_KEY']
+    @@use_account          = ENV['CLOUDCHECKR_USE_ACCOUNT']
+    @@connection_builder   = nil
+    @@snake_case_json_keys = true
+
     def self.access_key(new_access_key = nil)
-      if new_access_key.nil?
-        @@access_key ||= ENV['CLOUDCHECKR_ACCESS_KEY']
-      else
+      unless @@access_key.nil?
         @@access_key = new_access_key
       end
+
+      @@access_key
     end
 
     def self.use_account(new_use_account = nil)
-      if new_use_account.nil?
-        @@use_account ||= ENV['CLOUDCHECKR_USE_ACCOUNT']
-      else
+      unless new_use_account.nil?
         @@use_account = new_use_account
       end
+
+      @@use_account
     end
 
     def self.connection_builder(&builder)
-      @@connection_builder = builder || @@connection_builder
+      if block_given?
+        @@connection_builder = builder
+      end
+
+      @@connection_builder
+    end
+
+    def self.snake_case_json_keys(enable = nil)
+      unless enable.nil?
+        @@snake_case_json_keys = enable
+      end
+
+      @@snake_case_json_keys
     end
   end
 end

data/lib/cloud_checkr/api/client.rb

@@ -13,8 +13,6 @@ module CloudCheckr
       attr_reader :access_key, :url, :format
 
       def initialize(options = {}, &connection_builder)
-        super()
-
         @access_key         = options.fetch(:access_key,  API.access_key)
         @use_account        = options.fetch(:use_account, API.use_account)
         @url                = options.fetch(:url,         DEFAULT_URL)
@@ -37,16 +35,9 @@ module CloudCheckr
       end
 
       def default_params
-        {access_key: @access_key}
-      end
-
-      def require_params!(required_params, params)
-        missing_required_params = required_params.map(&:to_sym) - prepare_params(params).keys.map(&:to_sym)
-        
-        if missing_required_params.any?
-          raise "Missing required parameters: #{missing_required_params.join(', ')}"
-        else
-          nil
+        {}.tap do |params|
+          params[:access_key]  = @access_key  unless @access_key.nil?
+          params[:use_account] = @use_account unless @use_account.nil?
         end
       end
 
@@ -70,11 +61,29 @@ module CloudCheckr
         if response.status != 200
           # TODO: Currently assumes JSON response
           raise ::CloudCheckr::API::ResponseError.new(data)
+        elsif @format == :json && ::CloudCheckr::API.snake_case_json_keys
+          convert_keys_to_snake_case(data)
         else
           data
         end
       end
 
+      def convert_keys_to_snake_case(hash)
+        hash_class = hash.class
+
+        if hash.is_a?(Hash)
+          hash_class.new.tap do |new_hash|
+            hash.map do |k, v|
+              new_hash[k.gsub(/(.)([A-Z])/,'\1_\2').downcase] = convert_keys_to_snake_case(v)
+            end
+          end
+        elsif hash.is_a?(Array)
+          hash.map{|item| convert_keys_to_snake_case(item)}
+        else
+          hash
+        end
+      end
+
       def build_connection
         Faraday.new(url: @url) do |faraday|
           apply_connection_settings(faraday)
@@ -91,13 +100,12 @@ module CloudCheckr
         # form-encode POST params
         faraday.request :url_encoded
 
-        faraday.response :xml,     content_type: /\bxml$/
-        faraday.response :json,    content_type: /\bjson$/
-        faraday.response :mashify, content_type: /\bjson$/
-        # faraday.response @format
-        # faraday.response :mashify if @format == :json
+        faraday.response :mashify
+        faraday.response :xml,  content_type: /\bxml$/
+        faraday.response :json, content_type: /\bjson$/
 
         # faraday.response :logger, nil, bodies: true
+        # require 'faraday/detailed_logger'
         # faraday.response :detailed_logger
 
         faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP

data/lib/cloud_checkr/api/controllers.rb

@@ -25,12 +25,10 @@ module CloudCheckr
 
               if api_call['method_name'].start_with?('get_')
                 define_method(method_name) do |params = {}, headers = nil, &request_builder|
-                  @client.require_params!(required_params, params)
                   @client.get(controller_name, method_name, params, headers, &request_builder)
                 end
               else
                 define_method(method_name) do |params = {}, headers = nil, &request_builder|
-                  @client.require_params!(required_params, params)
                   @client.post(controller_name, method_name, params, headers, &request_builder)
                 end
               end

data/lib/cloudcheckr/version.rb

@@ -1,3 +1,3 @@
 module Cloudcheckr
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcheckr
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Joel Van Horn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-12 00:00:00.000000000 Z
+date: 2015-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement