reg.api2 0.0.10 → 0.0.11

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changes
 
+## Version 0.0.11
+
+* New API category: `hosting`.
+* Methods of Jelastic API in `hosting` category.
+
 ## Version 0.0.10
 
 * Methods of `bill` category now returns array of bills directly instead of `{ 'bills' => [ ... ] }`.

data/Rakefile

@@ -1,36 +1,19 @@
 require 'rake'
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
 
-APP_ROOT = File.dirname(__FILE__).freeze
+GEM_ROOT = File.dirname(__FILE__).freeze
 
-lib = File.expand_path('lib', APP_ROOT)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'reg_api2/version'
+lib_path = File.expand_path('lib', GEM_ROOT)
+$LOAD_PATH.unshift(lib_path)  unless $LOAD_PATH.include? lib_path
 
-begin
-  require 'rspec/core/rake_task'
+require 'reg_api2/version'
 
-  RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new
 
-  RSpec::Core::RakeTask.new(:rcov) do |t|
-    t.rcov = true
-    t.ruby_opts = '-w'
-    t.rcov_opts = %q[-Ilib --exclude "spec/*,gems/*"]
-  end
-rescue LoadError
-  $stderr.puts "RSpec not available. Install it with: gem install rspec-core rspec-expectations"
+YARD::Rake::YardocTask.new do |yard|
+  yard.options << "--title='reg.api2 #{RegApi2::VERSION}'"
 end
 
 task :default => :spec
-
-begin
-  require 'yard'
-
-  YARD::Rake::YardocTask.new do |yard|
-
-    version = RegApi2::VERSION
-    yard.options << "--title='reg.api2 #{version}'"
-  end
-rescue LoadError
-  $stderr.puts "Please install YARD with: gem install yard"
-end

data/bin/regapi2console

@@ -3,8 +3,8 @@
 begin
   require 'reg_api2/console'
 rescue LoadError # local run
-  APP_ROOT = File.expand_path('..', File.dirname(__FILE__)).freeze
-  lib = File.expand_path('lib', APP_ROOT)
-  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+  LOCAL_GEM_ROOT = File.expand_path('..', File.dirname(__FILE__)).freeze
+  lib_path = File.expand_path('lib', LOCAL_GEM_ROOT)
+  $LOAD_PATH.unshift(lib_path)  unless $LOAD_PATH.include?(lib_path)
   require 'reg_api2/console'
 end

data/lib/reg_api2/action.rb

@@ -0,0 +1,144 @@
+# -*- encoding : utf-8 -*-
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'yajl'
+
+module RegApi2
+  # Implementation of request/response activity.
+  module Action
+    # Default IO encoding
+    DEFAULT_IO_ENCODING = 'utf-8'.freeze
+    # Default lang.
+    DEFAULT_LANG = 'en'.freeze
+    # Default user name.
+    DEFAULT_USERNAME = 'test'.freeze
+    # Default password.
+    DEFAULT_PASSWORD = 'test'.freeze
+
+    # 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 ||= 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
+
+    # Gets form data for POST request
+    # @param [Hash] defopts
+    # @param [Hash] opts
+    # @return [Hash] Form data to be sent.
+    # @raise [ContractError]
+    def get_form_data(defopts, opts)
+      # 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)
+      req_contract = RegApi2::RequestContract.new(defopts)
+      opts = req_contract.validate(opts)
+
+      form = {
+        'username'          => username || DEFAULT_USERNAME,
+        'password'          => password || DEFAULT_PASSWORD,
+        'io_encoding'       => io_encoding,
+        'lang'              => lang || DEFAULT_LANG,
+        'output_format'     => 'json',
+        'input_format'      => 'json',
+        'show_input_params' => 0,
+        'input_data'        => Yajl::Encoder.encode(opts)
+      }
+
+      form
+    end
+
+    # Handles response
+    # @param [Hash] defopts
+    # @param [Net::HTTPResponse] res HTTP Response
+    # @return [Object] Contracted response.
+    # @raise [NetError]
+    # @raise [ApiError]
+    def handle_response(defopts, res)
+      raise NetError.new(res.body)  unless res.code == '200'
+
+      json = Yajl::Parser.parse(res.body)
+      RegApi2.got_response(json)
+
+      raise ApiError.from_json(json)  if json['result'] == 'error'
+
+      res_contract = RegApi2::ResultContract.new(defopts)
+      res_contract.handle_result(json)
+    end
+
+    # Do actual call to REG.API using POST/JSON convention.
+    # @param [Symbol] category
+    # @param [Symbol] name
+    # @param [Hash] defopts
+    # @param [Hash] opts
+    # @return [Hash] Result answer field.
+    # @raise [NetError]
+    # @raise [ApiError]
+    # @raise [ContractError]
+    def make_action category, name, defopts, opts = {}
+      req = Net::HTTP::Post.new(
+        category.nil? ? "#{API_URI.path}/#{name}" : "#{API_URI.path}/#{category}/#{name}"
+      )
+      form = get_form_data(defopts, opts)
+      RegApi2.form_to_be_sent(req.path, form)
+
+      req.set_form_data(form)
+      res = http.request(req)
+
+      handle_response(defopts, res)
+    end
+  end
+end

data/lib/reg_api2/api_error.rb

@@ -0,0 +1,30 @@
+# -*- encoding : utf-8 -*-
+module RegApi2
+  # API Error from REG.API provider.
+  # Please refer to {file:README.md#Common_error_codes common error codes}.
+  class ApiError < StandardError
+    # @!attribute [r] description
+    # @return [String] Localized error description.
+    attr_reader :description
+    # @!attribute [r] params
+    # @return [Hash] Optional error params.
+    attr_reader :params
+
+    def initialize code,  description, params
+      super code
+      @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
+end

data/lib/reg_api2/console.rb

@@ -12,4 +12,4 @@ module RegApi2
   end
 end
 
-RegApi2::Console.run!
+RegApi2::Console.run!

data/lib/reg_api2/contract_error.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+module RegApi2
+  # API Contract Error.
+  # Raised when input parameters doesn't pass Ruby client tests.
+  class ContractError < ArgumentError
+    # @!attribute [r] 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
+end

data/lib/reg_api2/entity/entity_base.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'yajl'
 
 module RegApi2

data/lib/reg_api2/entity/user.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'reg_api2/entity/entity_base'
 
 module RegApi2

data/lib/reg_api2/hosting.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+module RegApi2
+  # REG.API hosting category
+  module Hosting
+
+    include RegApi2::Builder
+
+    category :hosting
+
+    # @!method nop(opts = {})
+    # @param [Hash] opts
+    # This function serves for testing purposes.
+    # @return [Hash(domains)] A list of domains. Domains that allow DNS zone management will have the “success” value in the “result” field, otherwise the “result” field will feature an error code explaining the error reason.
+    # @note Accessibility: everyone
+    # @example Test
+    #    RegApi2.hosting.nop
+    define :nop
+
+    # @!method get_jelastic_refill_url(opts = {})
+    # @param [Hash] opts
+    # Gets Jelastic refill URL for current reseller.
+    # @return [String] Jelastic refill URL.
+    # @note Accessibility: partners
+    # @example Typical usage
+    #    puts RegApi2.get_jelastic_refill_url
+    define :get_jelastic_refill_url, field: :url
+
+    # @!method set_jelastic_refill_url(opts = {})
+    # @param [Hash] opts
+    # @option opts [String] :url Jelastic refill URL.
+    # Sets Jelastic refill URL for current reseller.
+    # @note Accessibility: partners
+    # @example Typical usage
+    #    RegApi2.set_jelastic_refill_url url: 'http://mysite.com?service_id=<service_id>&email=<email>'
+    define :set_jelastic_refill_url, required: :url
+
+    extend self
+  end
+end

data/lib/reg_api2/impl.rb

@@ -1,58 +1,8 @@
 # -*- encoding : utf-8 -*-
-require 'uri'
-require 'net/http'
-require 'net/https'
-require 'yajl'
 
-module RegApi2
-  # Networking Error.
-  # Raised when response doesn't meet HTTP 200 OK status.
-  class NetError < IOError
-  end
-
-  # API Contract Error.
-  # Raised when input parameters doesn't pass Ruby client tests.
-  class ContractError < ArgumentError
-    # @!attribute [r] 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
-
-  # API Error from REG.API provider.
-  # Please refer to {file:README.md#Common_error_codes common error codes}.
-  class ApiError < StandardError
-    # @!attribute [r] description
-    # @return [String] Localized error description.
-    attr_reader :description
-    # @!attribute [r] params
-    # @return [Hash] Optional error params.
-    attr_reader :params
-
-    def initialize code,  description, params
-      super code
-      @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
+require 'reg_api2/action'
 
+module RegApi2
   class << self
     # @!attribute [rw] username
     # @return [String] User name (`test` by default).
@@ -144,69 +94,6 @@ module RegApi2
       nil
     end
 
-    # Default IO encoding
-    DEFAULT_IO_ENCODING = 'utf-8'
-    # Default lang.
-    DEFAULT_LANG = 'en'
-
-    # 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 ||= 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
     # @param [String] path
     # @param [Hash] form
@@ -246,71 +133,6 @@ module RegApi2
       nil
     end
 
-    # Gets form data for POST request
-    # @param [Hash] defopts
-    # @param [Hash] opts
-    # @return [Hash] Form data to be sent.
-    # @raise [ContractError]
-    def get_form_data(defopts, opts)
-      # 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)
-      req_contract = RegApi2::RequestContract.new(defopts)
-      opts = req_contract.validate(opts)
-
-      form = {
-        '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)
-      }
-
-      form
-    end
-
-    # Handles response
-    # @param [Hash] defopts
-    # @param [Net::HTTPResponse] res HTTP Response
-    # @return [Object] Contracted response.
-    # @raise [NetError]
-    # @raise [ApiError]
-    def handle_response(defopts, res)
-      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)
-      res_contract.handle_result(json)
-    end
-
-    # Do actual call to REG.API using POST/JSON convention.
-    # @param [Symbol] category
-    # @param [Symbol] name
-    # @param [Hash] defopts
-    # @param [Hash] opts
-    # @return [Hash] Result answer field.
-    # @raise [NetError]
-    # @raise [ApiError]
-    # @raise [ContractError]
-    def make_action category, name, defopts, opts = {}
-      req = Net::HTTP::Post.new(
-        category.nil? ? "#{API_URI.path}/#{name}" : "#{API_URI.path}/#{category}/#{name}"
-      )
-      form = get_form_data(defopts, opts)
-      form_to_be_sent(req.path, form)
-
-      req.set_form_data(form)
-      res = http.request(req)
-
-      handle_response(defopts, res)
-    end
-
+    include RegApi2::Action
   end
 end

data/lib/reg_api2/net_error.rb

@@ -0,0 +1,7 @@
+# -*- encoding : utf-8 -*-
+module RegApi2
+  # Networking Error.
+  # Raised when response doesn't meet HTTP 200 OK status.
+  class NetError < IOError
+  end
+end

data/lib/reg_api2/result_contract.rb

@@ -19,6 +19,7 @@ module RegApi2
       bill_id
       service_id
       server_id
+      folder_id
       cpu_count
       cpu_core
       hdd_count
@@ -113,8 +114,8 @@ module RegApi2
     # @see #convert
     # @see #opts
     def handle_answer(answer)
-      answer = convert(answer)
       return nil  if answer.nil?
+      answer = convert(answer)
       field = opts[:field]
       if field
         answer = answer[field]

data/lib/reg_api2/service.rb

@@ -281,7 +281,7 @@ module RegApi2
     # @return [Hash(service_id, dname)]
     # @note Accessibility: clients
     # @note Support of service lists: no
-        # @example Resend mail.
+    # @example Resend mail.
     #    RegApi2.service.resend_mail servtype: :srv_ssl_certificate
     define :resend_mail
 

data/lib/reg_api2/sym_hash.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module RegApi2
   # Hash with indifferent access to its elements.
   # Also have no difference between {String} ans {Symbol} keys. 

data/lib/reg_api2/version.rb

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

data/lib/reg_api2.rb

@@ -1,6 +1,10 @@
 # -*- encoding : utf-8 -*-
 require "reg_api2/version"
 
+require 'reg_api2/net_error'
+require 'reg_api2/contract_error'
+require 'reg_api2/api_error'
+
 require "reg_api2/request_contract"
 require "reg_api2/result_contract"
 
@@ -14,6 +18,7 @@ require 'reg_api2/service'
 require 'reg_api2/bill'
 require 'reg_api2/folder'
 require 'reg_api2/zone'
+require 'reg_api2/hosting'
 
 # Provides r/w settings for API connection:
 #
@@ -32,6 +37,7 @@ require 'reg_api2/zone'
 # * {RegApi2.bill} API category implemented as {RegApi2::Bill} methods.
 # * {RegApi2.folder} API category implemented as {RegApi2::Folder} methods.
 # * {RegApi2.zone} API category implemented as {RegApi2::Zone} methods.
+# * {RegApi2.hosting} API category implemented as {RegApi2::Hosting} methods.
 #
 # Provides dump hooks:
 #
@@ -96,4 +102,33 @@ module RegApi2
   def zone; RegApi2::Zone; end
   module_function :zone
 
+  # Shortcut for {RegApi2::Hosting} methods.
+  # @return [Module] {RegApi2::Hosting}
+  # @api Shortcuts
+  def hosting; RegApi2::Hosting; end
+  module_function :hosting
+
+  class << self
+    # @!attribute [rw] username
+    # @return [String] User name (`test` by default).
+    attr_accessor :username
+    # @!attribute [rw] password
+    # @return [String] Password (`test` by default).
+    attr_accessor :password
+    # @!attribute [rw] io_encoding
+    # @return [String] IO encoding (`utf-8` by default).
+    attr_accessor :io_encoding
+    # @!attribute [rw] lang
+    # @return [String] Language (`en` by default).
+    attr_accessor :lang
+    # @!attribute [rw] ca_cert_path
+    # @return [String] Path to certification authority certificate (nil by default).
+    attr_accessor :ca_cert_path
+    # @!attribute [rw] pem
+    # @return [String] X.509 certificate (nil by default).
+    attr_accessor :pem
+    # @!attribute [rw] pem_password
+    # @return [String] X.509 certificate password (nil by default).
+    attr_accessor :pem_password
+  end
 end

data/spec/blueprints/user.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'reg_api2/entity/user'
 
 RegApi2::Entity::User.blueprint(:bad_login) do

data/spec/lib/reg_api2/hosting_spec.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+
+describe RegApi2::Hosting do
+
+  include RegApi2
+
+  describe :nop do
+    it "should return nil" do
+      hosting.nop.should be_nil
+    end
+  end
+
+  describe :get_jelastic_refill_url do
+    it "should return nil" do
+      hosting.get_jelastic_refill_url.should == "https://test1.ru"
+    end
+  end
+
+  describe :set_jelastic_refill_url do
+    it "should return nil" do
+      hosting.set_jelastic_refill_url(url: "http://ya.ru/").should be_nil
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -206,16 +206,21 @@ files:
 - Rakefile
 - bin/regapi2console
 - lib/reg_api2.rb
+- lib/reg_api2/action.rb
+- lib/reg_api2/api_error.rb
 - lib/reg_api2/bill.rb
 - lib/reg_api2/builder.rb
 - lib/reg_api2/common.rb
 - lib/reg_api2/console.rb
 - lib/reg_api2/console_helpers.rb
+- lib/reg_api2/contract_error.rb
 - lib/reg_api2/domain.rb
 - lib/reg_api2/entity/entity_base.rb
 - lib/reg_api2/entity/user.rb
 - lib/reg_api2/folder.rb
+- lib/reg_api2/hosting.rb
 - lib/reg_api2/impl.rb
+- lib/reg_api2/net_error.rb
 - lib/reg_api2/request_contract.rb
 - lib/reg_api2/result_contract.rb
 - lib/reg_api2/service.rb
@@ -230,6 +235,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/hosting_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
@@ -253,7 +259,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3535020143484780529
+      hash: -789251017170447539
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -262,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3535020143484780529
+      hash: -789251017170447539
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -276,6 +282,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/hosting_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