ms_rest 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 060e261ab92aea964d4856431880cd5ac125fb26
-  data.tar.gz: 377357c01284a7018d058a680c6ed61d8af5aa6e
+  metadata.gz: 79f1ffca11820b2b12a6ba633fb3badc65ee8a83
+  data.tar.gz: bae2d6d21cb360239b38a562a36fb68c2adee019
 SHA512:
-  metadata.gz: c6fd1d63bf2979d32807251feed857142603b8c82f21d5e9a9ec3867c45a4f8f4773c57fd3dbb6b5d716577e11f5b9a632a21f5e154d2eddc9cc097b2ad71198
-  data.tar.gz: bdd7d2b73039946ba06a920e0f25b5998f4fe853b763a7a65950a447aba30ffee9b606d31a6f710fc23b9510b72d646ba742bee0d4008755538ef04089c538d0
+  metadata.gz: 68352aac8266a90025c1a3fe61bd64318bdbc7a11a5c80b793699611dcbc19bb07ae866271e6acbae14b643c9e2c200f2664eaa0f7b0b51f7778879575f8b6f9
+  data.tar.gz: e407d879d4884c9477cb01810f581c20a9e20b7d16b968484a36e14c9ef0871d089323bfe59157f636f7e9dee07654549660f2f5e1186eb6f5c24ea0b618f201

data/lib/ms_rest.rb

@@ -19,6 +19,7 @@ require 'ms_rest/deserialization_error.rb'
 require 'ms_rest/validation_error.rb'
 require 'ms_rest/serialization.rb'
 require 'ms_rest/http_operation_response'
+require 'ms_rest/http_operation_request'
 require 'ms_rest/http_operation_error'
 require 'ms_rest/retry_policy_middleware'
 require 'ms_rest/service_client'

data/lib/ms_rest/deserialization_error.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
+require 'json'
 
 module MsRest
   #
@@ -8,29 +9,34 @@ module MsRest
   #
   class DeserializationError < RestError
 
-    # @return [String] the human readable description of error.
-    attr_accessor :message
-
     # @return [String] the inner exception message.
     attr_accessor :exception_message
 
     # @return [String] the inner exception stacktrace.
     attr_accessor :exception_stacktrace
 
-    # @return [String] server response which client was unable to parse.
-    attr_accessor :response_body
+    # @return [MsRest::HttpOperationResponse] server response which client was unable to parse.
+    attr_accessor :result
 
     #
     # Creates and initialize new instance of the DeserializationError class.
     # @param [String] message message the human readable description of error.
     # @param [String] exception_message the inner exception stacktrace.
     # @param [String] exception_stacktrace the inner exception stacktrace.
-    # @param [String] response_body server response which client was unable to parse.
-    def initialize(message, exception_message, exception_stacktrace, response_body)
-      @message = message
+    # @param [MsRest::HttpOperationResponse] the request and response
+    def initialize(msg, exception_message, exception_stacktrace, result)
+      @msg = msg || self.class.name
       @exception_message = exception_message
       @exception_stacktrace = exception_stacktrace
-      @response_body = response_body
+      @result = result
+    end
+    
+    def to_json(*a)
+      {exception_message: exception_message, message: @msg,  stacktrace: exception_stacktrace, result: result}.to_json(*a)
+    end
+    
+    def to_s
+      JSON.pretty_generate(self)
     end
 
   end

data/lib/ms_rest/http_operation_error.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
+require 'json'
 
 module MsRest
   #
@@ -8,10 +9,10 @@ module MsRest
   #
   class HttpOperationError < RestError
 
-    # @return [Net::HTTPRequest] the HTTP request object.
+    # @return [Hash] the HTTP request data (uri, body, headers).
     attr_accessor :request
 
-    # @return [Net::HTTPResponse] the HTTP response object.
+    # @return [Faraday::Response] the HTTP response object.
     attr_accessor :response
 
     # @return [String] the HTTP response body.
@@ -19,13 +20,15 @@ module MsRest
 
     #
     # Creates and initialize new instance of the HttpOperationException class.
-    # @param [Net::HTTPRequest] request the HTTP request object.
-    # @param [Net::HTTPResponse] response the HTTP response object.
+    # @param [Hash] the HTTP request data (uri, body, headers).
+    # @param [Faraday::Response] the HTTP response object.
     # @param [String] body the HTTP response body.
     # @param [String] error message.
     def initialize(*args)
+      @msg = self.class.name
       if args.size == 1
         # When only message is provided.
+        @msg = args[0]
         super(args[0])
       elsif args.size == 2
         # When only request and response provided, body is nil.
@@ -44,11 +47,25 @@ module MsRest
         @request = args[0]
         @response = args[1]
         @body = args[2]
+        @msg = args[3]
         super(args[3])
       else
         fail ArgumentError, 'Invalid number of arguments was provided, valid number: 1, 2, 3 or 4'
       end
     end
+    
+    def to_json(*a)
+      res_dict = response ? { body: response.body, headers: response.headers, status: response.status } : nil
+      {message: @msg, request: request, response: res_dict}.to_json(*a)
+    end
+    
+    def to_s
+      begin
+        JSON.pretty_generate(self)
+      rescue Exception => ex
+        "#{self.class.name} failed in \n\t#{backtrace.join("\n\t")}"
+      end
+    end
   end
 
 end

data/lib/ms_rest/http_operation_request.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module MsRest
+  #
+  # Class which represents the data received and deserialized from server.
+  #
+  class HttpOperationRequest
+
+    # @return [Hash] path parameters to be ERB::Util.url_encode encoded
+    attr_accessor :path_params
+    
+    # @return [Hash] path parameters not to be ERB::Util.url_encode encoded
+    attr_accessor :skip_encoding_path_params
+    
+    # @return [Hash] query parameters to be ERB::Util.url_encode encoded
+    attr_accessor :query_params
+    
+    # @return [Hash] query parameters to be ERB::Util.url_encode encoded
+    attr_accessor :skip_encoding_query_params
+    
+    # @return [String] base uri of the request
+    attr_accessor :base_uri
+    
+    # @return [String] path template /{replace}/{url_param}
+    attr_accessor :path_template
+    
+    # @return [Hash] request headers
+    attr_accessor :headers
+    
+    # @return [String] http request method
+    attr_accessor :method
+
+    # @return [String] the HTTP response body.
+    attr_accessor :body
+    
+    # @return [Array] the list of middlewares to apply to the Request
+    attr_accessor :middlewares
+    
+    # @return [String] full - to log requests, responses and bodies, partial - just requests and responses without body
+    attr_accessor :log
+    
+    # Creates and initialize new instance of the HttpOperationResponse class.
+    # @param [String|URI] base uri for requests
+    # @param [String] path template /{replace}/{url_param}
+    # @param [String] http method for the request
+    # @param [Hash] body the HTTP response body.
+    def initialize(base_uri, path_template, method, options = {})
+      fail 'path_template must not be nil' if path_template.nil?
+      fail 'method must not be nil' if method.nil?
+      
+      @base_uri = base_uri || ''
+      @path_template = path_template
+      @method = method
+      @headers = {}
+      
+      options.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+    # Creates a promise which will execute the request. Block will yield the request for customization.
+    # @return [URI] body the HTTP response body.
+    def run_promise(&block)
+      Concurrent::Promise.new do
+        connection = Faraday.new(:url => base_uri) do |faraday|
+          middlewares.each{ |args| faraday.use(*args) }
+          faraday.adapter Faraday.default_adapter
+          logging = ENV['AZURE_HTTP_LOGGING'] || log
+          if logging
+            faraday.response :logger, nil, { :bodies => logging == 'full' }
+          end
+        end
+        
+        connection.run_request(:"#{method}", build_path, body, headers) do |req|
+          req.params = query_params.reject{|_, v| v.nil?} unless query_params.nil?
+          yield(req) if block_given?
+        end
+      end
+    end
+    
+    
+    # Creates a path from the path template and the path_params and skip_encoding_path_params
+    # @return [URI] body the HTTP response body.
+    def build_path
+      template = path_template.dup
+      path_params.each{ |key, value| template["{#{key}}"] = ERB::Util.url_encode(value) } unless path_params.nil?
+      skip_encoding_path_params.each{ |key, value| template["{#{key}}"] = value } unless skip_encoding_path_params.nil?
+      path = URI.parse(template.gsub(/([^:])\/\//, '\1/'))
+      unless skip_encoding_query_params.nil?
+        path.query = [(path.query || ""), skip_encoding_query_params.reject{|_, v| v.nil?}.map{|k,v| "#{k}=#{v}"}].join('&')
+      end
+      path
+    end
+    
+    def full_uri
+      URI.join(base_uri || '', build_path)
+    end
+    
+    def to_json(*a)
+      {
+        base_uri: base_uri,
+        path_template: path_template,
+        method: method, 
+        path_params: path_params,
+        skip_encoding_path_params: skip_encoding_path_params,
+        query_params: query_params,
+        skip_encoding_query_params: skip_encoding_query_params,
+        headers: headers,
+        body: body,
+        middlewares: middlewares,
+        log: log  
+      }.to_json(*a)
+    end
+    
+  end
+  
+end

data/lib/ms_rest/http_operation_response.rb

@@ -8,10 +8,10 @@ module MsRest
   #
   class HttpOperationResponse
 
-    # @return [Net::HTTPRequest] the HTTP request object.
+    # @param [MsRest::HttpOperationRequest] the HTTP request data.
     attr_accessor :request
 
-    # @return [Net::HTTPResponse] the HTTP response object.
+    # @return [Faraday::Response] the HTTP response object.
     attr_accessor :response
 
     # @return [String] the HTTP response body.
@@ -19,14 +19,19 @@ module MsRest
 
     #
     # Creates and initialize new instance of the HttpOperationResponse class.
-    # @param [Net::HTTPRequest] request the HTTP request object.
-    # @param [Net::HTTPResponse] response the HTTP response object.
+    # @param [MsRest::HttpOperationRequest] request the HTTP request object.
+    # @param [Faraday::Response] response the HTTP response object.
     # @param [String] body the HTTP response body.
     def initialize(request, response, body = nil)
       @request = request
       @response = response
       @body = body
     end
+    
+    def to_json(*a)
+      res_dict = response ? { body: response.body, headers: response.headers, status: response.status } : nil
+      {response: res_dict, request: request}.to_json(*a)
+    end
 
   end
 end

data/lib/ms_rest/version.rb

@@ -3,5 +3,5 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 
 module MsRest
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/ms_rest.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.3.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
 
   spec.add_runtime_dependency 'json', '~> 1.7'
-  spec.add_runtime_dependency 'timeliness', '~> 0.3.7'
+  spec.add_runtime_dependency 'timeliness', '~> 0.3'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_runtime_dependency 'faraday', '~> 0.9.1'
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ms_rest
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
 description: Azure Client Library for Ruby.
 email: azsdkteam@microsoft.com
 executables: []
@@ -128,6 +128,7 @@ files:
 - lib/ms_rest/credentials/token_provider.rb
 - lib/ms_rest/deserialization_error.rb
 - lib/ms_rest/http_operation_error.rb
+- lib/ms_rest/http_operation_request.rb
 - lib/ms_rest/http_operation_response.rb
 - lib/ms_rest/rest_error.rb
 - lib/ms_rest/retry_policy_middleware.rb
@@ -161,3 +162,4 @@ signing_key:
 specification_version: 4
 summary: Azure Client Library for Ruby.
 test_files: []
+has_rdoc: