reg.api2 0.0.6 → 0.0.7

data/README.md

@@ -60,6 +60,11 @@ Your default username: "test", and You can change it with "~/.regapi2".
 1.9.3-p194 :002 >
 ```
 
+Console use test/test credentials by default, but you can assign new ones
+before any operations over REG.API through {RegApi2} properties.
+
+Also console reads `~/.regapi2` configuration file if exists, to assign properties from. It knows about these properties in configuration file: `username`, `password`, `lang`, `pem`, `pem_password` and `ca_cert_path`.
+
 ## Recommendations for effective use of REG.API
 
 This section provides information that will help you to make you work with REG.API more productive and convenient.

data/lib/reg_api2/console_helpers.rb

@@ -6,19 +6,18 @@ include RegApi2
 # Try to load defaults from ~/.regapi2
 def try_lo_load_defaults
   filename = "#{ENV['HOME']}/.regapi2"
-  username = 'test'
-  password = 'test'
+  props = %w[ username password lang pem pem_password ca_cert_path ]
 
   if File.readable?(filename)
     IO.read(filename).split("\n").each do |line|
-      username = $1  if line.strip =~ /^\s*username\s*\=(.+)\s*$/;
-      password = $1  if line.strip =~ /^\s*password\s*\=(.+)\s*$/;
+      line.strip!
+      props.each do |prop|
+        RegApi2.send("#{prop}=", $1)  if line =~ /\A\s*#{Regexp.escape(prop)}\s*\=(.+)\s*\z/;
+      end
     end
   end
 
-  RegApi2.username = username
-  RegApi2.password = password
-  puts "Your default username: \"#{username}\", and You can change it with \"#{filename}\"."
+  puts "Your default username: \"#{RegApi2.username}\", and You can change it with \"#{filename}\"."
 end
 
 try_lo_load_defaults

data/lib/reg_api2/impl.rb

@@ -14,11 +14,13 @@ module RegApi2
   # Raised when input parameters doesn't pass Ruby client tests.
   class ContractError < ArgumentError
     # @!attribute [r] fields
-    # Wrong fields.
+    # @return [Array<String>] Wrong fields. 
     attr_reader :fields
 
     def initialize message, fields = []
       super message
+      fields = []  if fields.nil?
+      fields = [ fields ]  unless fields.kind_of?(Array)
       @fields = fields
     end
   end
@@ -27,16 +29,16 @@ module RegApi2
   # Please refer to {file:README.md#Common_error_codes common error codes}.
   class ApiError < StandardError
     # @!attribute [r] description
-    # Localized error description.
+    # @return [String] Localized error description.
     attr_reader :description
     # @!attribute [r] params
-    # Optional error params.
+    # @return [Hash] Optional error params.
     attr_reader :params
 
     def initialize code,  description, params
       super code
       @description = description
-      @params = params
+      @params = params ||  {}
     end
 
     # Extracts error arguments from specified json.
@@ -182,7 +184,6 @@ module RegApi2
     # @return [Object] Contracted response.
     # @raise [NetError]
     # @raise [ApiError]
-    # @raise [ContractError]
     def handle_response(defopts, res)
       raise NetError.new(res.body)  unless res.code == '200'
 

data/lib/reg_api2/request_contract.rb

@@ -46,7 +46,7 @@ module RegApi2
         if value.to_s !~ opts[:re]
           raise RegApi2::ContractError.new(
             "Field #{key} mismatch regular expression: #{value}",
-            [ key ]
+            key
           )
         end
       end
@@ -57,6 +57,7 @@ module RegApi2
     # @param [Object] key Value to validate.
     # @param [Object] value Value to validate.
     # @param [Hash] opts opts with optional re field.
+    # @return [Object] Updated `value`
     def validate_iso_date key, value, opts
       if opts[:iso_date]
         return value.strftime("%Y-%m-%d")  if value.respond_to?(:strftime)
@@ -68,6 +69,7 @@ module RegApi2
     # @param [Object] key Value to validate.
     # @param [Object] value Value to validate.
     # @param [Hash] opts opts with optional ipaddr field.
+    # @return [String] Updated `value`
     def validate_ipaddr key, value, opts
       if opts[:ipaddr] == true && value.kind_of?(String)
         value = IPAddr.new(value)
@@ -75,24 +77,18 @@ module RegApi2
       value.to_s
     end
 
-    # Validates specified `form` with `required` and `optional` fields.
+    # Validates specified `form` for presence of all required fields.
     # @param [Hash] form Form to validate.
+    # @param [Hash] fields Fields to test.
+    # return void
     # @raise ContractError
-    def validate(form)
-      fields = fields_to_validate
-      return form  if fields.empty?
+    def validate_presence_of_required_fields form, fields
       absent_fields = []
       fields.each_pair do |key, opts|
+        next  unless opts[:required]
         if !form.has_key?(key) || form[key].nil?
-          if opts[:required]
-            absent_fields << key
-          end
-          next
+          absent_fields << key
         end
-
-        form[key] = validate_re key, form[key], opts
-        form[key] = validate_iso_date key, form[key], opts
-        form[key] = validate_ipaddr key, form[key], opts
       end
       unless absent_fields.empty?
         raise RegApi2::ContractError.new(
@@ -100,6 +96,27 @@ module RegApi2
           absent_fields
         )
       end
+      nil
+    end
+
+    # Validates specified `form` with `required` and `optional` fields.
+    # @param [Hash] form Form to validate.
+    # @return [Hash] Updated form.
+    # @raise ContractError
+    def validate(form)
+      fields = fields_to_validate
+      return form  if fields.empty?
+
+      validate_presence_of_required_fields form, fields
+
+      fields.each_pair do |key, opts|
+        next  if !form.has_key?(key) || form[key].nil?
+
+        form[key] = validate_re key, form[key], opts
+        form[key] = validate_iso_date key, form[key], opts
+        form[key] = validate_ipaddr key, form[key], opts
+      end
+
       form
     end
   end

data/lib/reg_api2/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -252,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -909380386582521799
+      hash: -3548838866357939780
 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: -909380386582521799
+      hash: -3548838866357939780
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24