reg.api2 0.0.8 → 0.0.9

data/lib/reg_api2/impl.rb

@@ -75,6 +75,82 @@ module RegApi2
     # @!attribute [rw] pem_password
     # @return [String] X.509 certificate password (nil by default).
     attr_accessor :pem_password
+    # @!attribute [rw] dump_requests_to
+    # @return [String,Symbol,Lambda] Where to dump outgoing API request (nil by default).
+    #
+    #    | Value | Dump to |
+    #    | ----- | ------- |
+    #    | nil | Nothing |
+    #    | :stdout, "stdout" | $stdout |
+    #    | :stderr, "stderr" | $stderr |
+    #    | lambda | Calls this lambda with requested path and form hash |
+    attr_accessor :dump_requests_to
+    # @!attribute [rw] dump_responses_to
+    # @return [String,Symbol,Lambda] Where to dump incoming API response (nil by default).
+    #
+    #    | Value | Dump to |
+    #    | ----- | ------- |
+    #    | nil | Nothing |
+    #    | :stdout, "stdout" | $stdout |
+    #    | :stderr, "stderr" | $stderr |
+    #    | lambda | Calls this lambda with incoming parsed JSON data |
+    attr_accessor :dump_responses_to
+
+    private :dump_requests_to, :dump_responses_to
+
+    # Dumps outgoing API requests to given `to` or code block.
+    # @param [String,Symbol,Lambda] to Where to dump incoming API response (nil by default).
+    #
+    #    | Value | Dump to |
+    #    | ----- | ------- |
+    #    | nil | Nothing |
+    #    | :stdout, "stdout" | $stdout |
+    #    | :stderr, "stderr" | $stderr |
+    #    | lambda | Calls this lambda with requested path and form hash |
+    #
+    # @param [Code] code_block Code block to be executed on every API request.
+    # @yield [path, form] Request path and form to be sent.
+    # @return [NilClass] nil
+    # @example Dump outgoing API requests to code block
+    #    RegApi2.dump_requests { |path, form| p path; p form }
+    def dump_requests(to = nil, &code_block)
+      if to
+        self.dump_requests_to= to
+        return nil
+      end
+      if block_given?
+        self.dump_requests_to= code_block
+        return nil
+      end
+      self.dump_requests_to= nil
+    end
+
+    # Dumps incoming API responses to given `to` or code block.
+    # @param [String,Symbol,Lambda] to Where to dump outgoing API response (nil by default).
+    #
+    #    | Value | Dump to |
+    #    | ----- | ------- |
+    #    | nil | Nothing |
+    #    | :stdout, "stdout" | $stdout |
+    #    | :stderr, "stderr" | $stderr |
+    #    | lambda | Calls this lambda with incoming parsed JSON data |
+    #
+    # @param [Code] code_block Code block to be executed on every API response.
+    # @yield [json] Response parsed JSON data to be handled.
+    # @return [NilClass] nil
+    # @example Dump incoming API responses to `$stdout`
+    #    RegApi2.dump_responses :stdout
+    def dump_responses(to = nil, &code_block)
+      if to
+        self.dump_responses_to= to
+        return nil
+      end
+      if block_given?
+        self.dump_responses_to= code_block
+        return nil
+      end
+      self.dump_responses_to= nil
+    end
 
     # Default IO encoding
     DEFAULT_IO_ENCODING = 'utf-8'
@@ -144,12 +220,38 @@ module RegApi2
     # @param [Hash] form
     # @return void
     def form_to_be_sent(path, form)
+      case dump_requests_to
+      when :stderr, "stderr"
+        $stderr.puts "RegApi2.Request:\n#{path}\n#{form}"
+      when :stdout, "stdout"
+        $stdout.puts "RegApi2.Request:\n#{path}\n#{form}"
+      when Proc
+        dump_requests_to.call(path, form)
+      when nil
+        ;
+      else
+        raise ArgumentError.new( "Bad dump_requests_to field: #{dump_requests_to.inspect}" )
+      end
+      nil
     end
 
     # Placeholder to inspect got response.
     # @param [Net::HTTPResponse] response
     # @return void
     def got_response(response)
+      case dump_responses_to
+      when :stderr, "stderr"
+        $stderr.puts "RegApi2.Response:\n#{response}"
+      when :stdout, "stdout"
+        $stdout.puts "RegApi2.Response:\n#{response}"
+      when Proc
+        dump_responses_to.call(response)
+      when nil
+        ;
+      else
+        raise ArgumentError.new( "Bad dump_responses_to field: #{dump_responses_to.inspect}" )
+      end
+      nil
     end
 
     # Gets form data for POST request
@@ -188,6 +290,8 @@ module RegApi2
       raise NetError.new(res.body)  unless res.code == '200'
 
       json = Yajl::Parser.parse(res.body)
+      got_response(json)
+
       raise ApiError.from_json(json)  if json['result'] == 'error'
 
       res_contract = RegApi2::ResultContract.new(defopts)
@@ -212,7 +316,6 @@ module RegApi2
 
       req.set_form_data(form)
       res = http.request(req)
-      got_response(res)
 
       handle_response(defopts, res)
     end

data/lib/reg_api2/service.rb

@@ -214,7 +214,7 @@ module RegApi2
     #    | Field | Description |
     #    | ----- | ----------- |
     #    | services | A list of requested services. |
-    #    | bills | A list of IDs of invoices associated with this service. |
+    #    | bills | A list of IDs of invoices associated with this service. May be nil. |
     #
     # @note Accessibility: partners
     # @note Support of service lists: yes

data/lib/reg_api2/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module RegApi2
   # Gem version.
-  VERSION = "0.0.8".freeze
+  VERSION = "0.0.9".freeze
 end

data/lib/reg_api2.rb

@@ -33,6 +33,11 @@ require 'reg_api2/zone'
 # * {RegApi2.folder} API category implemented as {RegApi2::Folder} methods.
 # * {RegApi2.zone} API category implemented as {RegApi2::Zone} methods.
 #
+# Provides dump hooks:
+#
+# * {RegApi2.dump_requests} to dump outgoing API request forms.
+# * {RegApi2.dump_responses} to dump incoming API responses.
+#
 # Please read {file:README.md} for API overview.
 #
 # @example List of services by specified identifiers
@@ -44,6 +49,8 @@ require 'reg_api2/zone'
 #    { surprise: "surprise.ru" }
 #  ])
 #
+# @example Dump incoming API responses to `$stderr`
+#    RegApi2.dump_responses :stderr
 
 module RegApi2
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -252,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1698904277702567800
+      hash: 890297353583224213
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1698904277702567800
+      hash: 890297353583224213
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24