reg.api2 0.0.3 → 0.0.4

data/README.md

@@ -1,5 +1,6 @@
 # REG.API 2 for Ruby
 
+[![Gem Version](https://badge.fury.io/rb/reg.api2.png)](http://badge.fury.io/rb/reg.api2)
 [![build status](https://secure.travis-ci.org/regru/reg_api2-ruby.png)](https://travis-ci.org/regru/reg_api2-ruby)
 [![Code Climate](https://codeclimate.com/github/regru/reg_api2-ruby.png)](https://codeclimate.com/github/regru/reg_api2-ruby)
 [![Coverage Status](https://coveralls.io/repos/regru/reg_api2-ruby/badge.png?branch=master)](https://coveralls.io/r/regru/reg_api2-ruby)
@@ -8,6 +9,8 @@ REG.API v2 Implementation.
 
 We want to note that Ruby client uses recommended way to access API: POST requests with JSON input/output in utf-8 encoding over HTTPS protocol.
 
+This code hosted on [GitHub](https://github.com/regru/reg_api2-ruby).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/reg_api2/impl.rb

@@ -35,29 +35,40 @@ module RegApi2
       @description = description
       @params = params
     end
+
+    # Extracts error arguments from specified json.
+    # @param [Hash] json
+    # @return [ApiError] Initialized error object.
+    def self.from_json json
+      new(
+        json['error_code'],
+        json['error_text'],
+        json['error_params']
+      )
+    end
   end
 
   class << self
     # @!attribute [rw] username
-    # @return [String] User name.
+    # @return [String] User name (`test` by default).
     attr_accessor :username
     # @!attribute [rw] password
-    # @return [String] Password.
+    # @return [String] Password (`test` by default).
     attr_accessor :password
     # @!attribute [rw] io_encoding
-    # @return [String] IO encoding ('utf-8' by default).
+    # @return [String] IO encoding (`utf-8` by default).
     attr_accessor :io_encoding
     # @!attribute [rw] lang
-    # @return [String] Language ('en' by default).
+    # @return [String] Language (`en` by default).
     attr_accessor :lang
     # @!attribute [rw] ca_cert_path
-    # @return [String] Path to certificate (nil by default).
+    # @return [String] Path to certification authority certificate (nil by default).
     attr_accessor :ca_cert_path
     # @!attribute [rw] pem
-    # @return [String] PEM (nil by default).
+    # @return [String] X.509 certificate (nil by default).
     attr_accessor :pem
     # @!attribute [rw] pem_password
-    # @return [String] PEM password (nil by default).
+    # @return [String] X.509 certificate password (nil by default).
     attr_accessor :pem_password
 
     # Default IO encoding
@@ -68,32 +79,59 @@ module RegApi2
     # REG.API base URI
     API_URI = URI.parse("https://api.reg.ru/api/regru2")
 
+    def apply_ca_cert_path(http)
+      unless ca_cert_path.nil?
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http.ca_file     = ca_cert_path
+      else
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+
+    def apply_pem(http)
+      return  if pem.nil?
+      http.cert = OpenSSL::X509::Certificate.new(pem)
+      if pem_password
+        raise ArgumentError, "The private key requires a password"  if pem_password.empty?
+        http.key = OpenSSL::PKey::RSA.new(pem, pem_password)
+      else
+        http.key = OpenSSL::PKey::RSA.new(pem)
+      end
+    end
+
+    private :apply_pem, :apply_ca_cert_path
+
+    # Creates HTTPS handler.
+    # @return [Net::HTTP] HTTPS handler.
+    # @see #http
+    def create_http
+      _http = Net::HTTP.new(
+        API_URI.host, 
+        API_URI.port
+      )
+      _http.use_ssl = true
+      apply_ca_cert_path(_http)
+      apply_pem(_http)
+      _http
+    end
+
     # Creates or gets HTTPS handler.
     # @return [Net::HTTP] HTTPS handler.
+    # @see #create_http
+    # @see #clear_http
     def http
-      @http ||= begin
-        http = Net::HTTP.new(
-          API_URI.host, 
-          API_URI.port
-        )
-        http.use_ssl = true
-        unless ca_cert_path.nil?
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          http.ca_file     = ca_cert_path
-        else
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
-        unless pem.nil?
-          http.cert = OpenSSL::X509::Certificate.new(pem)
-          if pem_password
-            raise ArgumentError, "The private key requires a password"  if pem_password.empty?
-            http.key = OpenSSL::PKey::RSA.new(pem, pem_password)
-          else
-            http.key = OpenSSL::PKey::RSA.new(pem)
-          end
-        end
-        http
-      end
+      @http ||= create_http
+    end
+
+    # Clears internal `http` singleton.
+    # Also finishes any started HTTP session.
+    # @return nil
+    # @note For testing purposes.
+    # @see #http
+    def clear_http
+      return nil  unless @http
+      @http.finish  if @http.respond_to?(:started) && @http.started
+      @http = nil
     end
 
     # Placeholder to inspect sent form
@@ -118,20 +156,20 @@ module RegApi2
       # HACK: REG.API doesn't know about utf-8.
       io_encoding = 'utf8'  if !io_encoding || io_encoding == DEFAULT_IO_ENCODING
       opts = opts.to_hash  if opts.respond_to?(:to_hash)
-      opts = RegApi2::RequestContract.new(defopts).validate(opts)
+      req_contract = RegApi2::RequestContract.new(defopts)
+      opts = req_contract.validate(opts)
 
       form = {
-        'io_encoding' => io_encoding,
-        'lang' => lang || DEFAULT_LANG,
-        'output_format' => 'json',
-        'input_format' => 'json',
+        'username'          => username || 'test',
+        'password'          => password || 'test',
+        'io_encoding'       => io_encoding,
+        'lang'              => lang || DEFAULT_LANG,
+        'output_format'     => 'json',
+        'input_format'      => 'json',
         'show_input_params' => 0,
-        'input_data' => Yajl::Encoder.encode(opts)
+        'input_data'        => Yajl::Encoder.encode(opts)
       }
 
-      form['username'] = username  if username
-      form['password'] = password  if password
-
       form
     end
 
@@ -146,11 +184,7 @@ module RegApi2
       raise NetError.new(res.body)  unless res.code == '200'
 
       json = Yajl::Parser.parse(res.body)
-      raise ApiError.new(
-        json['error_code'],
-        json['error_text'],
-        json['error_params']
-      )  if json['result'] == 'error'
+      raise ApiError.from_json(json)  if json['result'] == 'error'
 
       res_contract = RegApi2::ResultContract.new(defopts)
       res_contract.handle_result(json)

data/lib/reg_api2/version.rb

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

data/lib/reg_api2.rb

@@ -33,6 +33,7 @@ require 'reg_api2/zone'
 # * {RegApi2.password} - Your password. `test` by default.
 # * {RegApi2.io_encoding} - Input/ouput encoding. `utf-8` by default.
 # * {RegApi2.lang} - Language of API answers. `en` by default.
+# * {RegApi2.ca_cert_path}, {RegApi2.pem} and {RegApi2.pem_password} - optional certification properties. nils by default.
 #
 # Provides shortcuts for API categories:
 #

data/reg.api2.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["akzhan.abdulin@gmail.com"]
   spec.description   = %q{REG.API v2 Implementation}
   spec.summary       = %q{REG.API v2 Implementation}
-  spec.homepage      = "https://github.com/regru/reg_api2-ruby"
+  spec.homepage      = "https://regru.github.com/reg_api2-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/lib/reg_api2/impl_spec.rb

@@ -0,0 +1,82 @@
+# -*- encoding : utf-8 -*-
+
+describe RegApi2 do
+  describe :http do
+    before(:each) do
+      RegApi2.clear_http
+    end
+
+    after(:all) do
+      RegApi2.clear_http
+    end
+
+    it "should #create_http at first call" do
+      mock(RegApi2).create_http { 45 }.times(1)
+      RegApi2.http.should == 45
+    end
+
+    it "should not #create_http at next call" do
+      mock(RegApi2).create_http { 45 }.times(1)
+      RegApi2.http.should == 45
+      RegApi2.http.should == 45
+    end
+  end
+
+  describe :create_http do
+    it "should create Net::HTTP object" do
+      http = RegApi2.create_http
+      http.should be_kind_of(Net::HTTP)
+      http.should be_use_ssl
+      http.verify_mode.should == OpenSSL::SSL::VERIFY_NONE
+    end
+
+    it "should use ca_cert_path if exists" do
+      any_instance_of(Net::HTTP) do |instance|
+        proxy(instance).verify_mode=(OpenSSL::SSL::VERIFY_PEER)
+        proxy(instance).ca_file=("file")
+      end
+      mock(RegApi2).ca_cert_path { "file" }.any_times
+      http = RegApi2.create_http
+      http.verify_mode.should == OpenSSL::SSL::VERIFY_PEER
+      http.ca_file.should == "file"
+    end
+
+    it "should use pem with pem_password" do
+      mock(RegApi2).pem { "pem" }.any_times
+      mock(RegApi2).pem_password { "pem_password" }.any_times
+      pem = Object.new
+      key = Object.new
+      mock(OpenSSL::X509::Certificate).new("pem") { pem }
+      mock(OpenSSL::PKey::RSA).new("pem", "pem_password") { key }
+
+      http = RegApi2.create_http
+      http.cert.should == pem
+      http.key.should  == key
+    end
+
+    it "should use pem without pem_password" do
+      mock(RegApi2).pem { "pem" }.any_times
+      mock(RegApi2).pem_password { nil }.any_times
+      pem = Object.new
+      key = Object.new
+      mock(OpenSSL::X509::Certificate).new("pem") { pem }
+      mock(OpenSSL::PKey::RSA).new("pem") { key }
+
+      http = RegApi2.create_http
+      http.cert.should == pem
+      http.key.should_not  be_nil
+    end
+  end
+
+  describe :make_action do
+
+    it "should raise ApiError with NO_SUCH_COMMAND code on absent command" do
+      lambda do
+        RegApi2.make_action(:bad, :command, {}, {})
+      end.should raise_error RegApi2::ApiError
+      lambda do
+        RegApi2.make_action(:bad, :command, {}, {})
+      end.should raise_error /NO_SUCH_COMMAND/
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -230,6 +230,7 @@ files:
 - spec/lib/reg_api2/domain_spec.rb
 - spec/lib/reg_api2/entity/entity_base_spec.rb
 - spec/lib/reg_api2/folder_spec.rb
+- spec/lib/reg_api2/impl_spec.rb
 - spec/lib/reg_api2/request_contract_spec.rb
 - spec/lib/reg_api2/result_contract_spec.rb
 - spec/lib/reg_api2/service_spec.rb
@@ -237,7 +238,7 @@ files:
 - spec/lib/reg_api2/user_spec.rb
 - spec/lib/reg_api2/zone_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/regru/reg_api2-ruby
+homepage: https://regru.github.com/reg_api2-ruby
 licenses:
 - MIT
 post_install_message: 
@@ -252,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2651933620898145662
+      hash: 784159006101606174
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -261,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2651933620898145662
+      hash: 784159006101606174
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -275,6 +276,7 @@ test_files:
 - spec/lib/reg_api2/domain_spec.rb
 - spec/lib/reg_api2/entity/entity_base_spec.rb
 - spec/lib/reg_api2/folder_spec.rb
+- spec/lib/reg_api2/impl_spec.rb
 - spec/lib/reg_api2/request_contract_spec.rb
 - spec/lib/reg_api2/result_contract_spec.rb
 - spec/lib/reg_api2/service_spec.rb