reg.api2 0.0.1

data/lib/reg_api2/user.rb

@@ -0,0 +1,52 @@
+# -*- encoding : utf-8 -*-
+
+require 'reg_api2/entity/user'
+
+module RegApi2
+  # REG.API user category
+  module User
+
+    include RegApi2::Builder
+
+    category :user
+
+    # @!method nop
+    # @param None
+    # Accessibility testing.
+    # @return [NilClass] nil
+    define :nop
+
+    # @!method create(opts = {})
+    # @param opts Opts or {RegApi2::Entity::User}
+    # @option opts [String] :user_login Login of the new user in the REG.API system. Allowed symbols: Latin lower-case letters (a-z), digits (0 -9) and the symbols "-" and "_".
+    # @option opts [String] :user_password Password of the new user.
+    # @option opts [String] :user_email E-mail of the new user.
+    # @option opts [String] :user_country_code Two-letter ISO code of the country of residence of the new user, for example, 'RU'.
+    # @return [String] user_id of new user.
+    # @note Accessability: partners
+    # New user registration.
+    define :create, required: %w[ user_login user_password user_email user_country_code ], field: 'user_id', result: :single_field
+
+    # @!method get_statistics(opts = {})
+    # @param opts Opts
+    # @option opts [String] :date_from This field sets the statistics start date (optional).
+    # @option opts [String] :date_till This field sets the statistics end date (optional).
+    # @note Accessability: clients
+    # @note Support of service lists: no
+    # Get user statistics.
+    # @return [Hash(costs_for_period, active_domains_cnt, active_domains_get_ctrl_cnt, renew_domains_cnt, ...)] User statistics
+    define :get_statistics, optional: %w[ date_till date_from ]
+
+    # @!method get_balance(opts = {})
+    # @param opts Opts
+    # @option opts [String] :currency Define the currency in which the balance is presented. Conversion is performed automatically in accordance with the current exchange rates. Available options: RUR (default), USD, EUR, UAH.
+    # @note Accessability: clients
+    # @note Support of service lists: no
+    # View current balance.
+    # @return [Hash(currency, prepay, blocked, credit)] User balance
+    define :get_balance, required: %w[ currency ]
+
+    extend self
+  end
+end
+

data/lib/reg_api2/util.rb

@@ -0,0 +1,13 @@
+module RegApi2
+  # Internal utilities
+  module Util
+    # Constantizes specified str
+    # @param [String] str String to constantize. 
+    # @return [String] Constantized string.
+    def constantize str
+      str.to_s.split('_').map { |w| w.capitalize }.join('')
+    end
+
+    extend self
+  end
+end

data/lib/reg_api2/version.rb

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

data/lib/reg_api2.rb

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+require "reg_api2/version"
+
+require "reg_api2/request_contract/default"
+require "reg_api2/result_contract/default"
+
+require "reg_api2/impl"
+require 'reg_api2/builder'
+
+require 'reg_api2/common'
+require 'reg_api2/domains'
+require 'reg_api2/clients'
+require 'reg_api2/user'
+require 'reg_api2/service'
+
+# REG.API v2
+# @example List of services by specified identifiers
+#  RegApi2.service.nop(services: [
+#    { dname:"test.ru" },
+#    { dname: "test.su", servtype: "srv_hosting_ispmgr" },
+#    { service_id: 111111 },
+#    { service_id: "22bug22" },
+#    { surprise: "surprise.ru" }
+#  ])
+
+module RegApi2
+
+  # Shortcut for {RegApi2::Common} methods
+  # @return [Module]
+  def common; RegApi2::Common; end
+  module_function :common
+
+  # Shortcut for {RegApi2::Domains} methods.
+  # @return [Module]
+  def domains; RegApi2::Domains; end
+  module_function :domains
+
+  # Shortcut for {RegApi2::Clients} methods.
+  # @return [Module]
+  def clients; RegApi2::Clients; end
+  module_function :clients
+
+  # Shortcut for {RegApi2::User} methods.
+  # @return [Module]
+  def user; RegApi2::User; end
+  module_function :user
+
+  # Shortcut for {RegApi2::Service} methods.
+  # @return [Module]
+  def service; RegApi2::Service; end
+  module_function :service
+
+end

data/reg.api2.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reg_api2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reg.api2"
+  spec.version       = RegApi2::VERSION
+  spec.authors       = ["Akzhan Abdulin"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "yajl-ruby", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-core"
+  spec.add_development_dependency "rspec-expectations"
+  spec.add_development_dependency "rr"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "machinist"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+end

data/spec/blueprints/user.rb

@@ -0,0 +1,39 @@
+require 'reg_api2/entity/user'
+
+RegApi2::Entity::User.blueprint(:bad_login) do
+  user_login { nil }
+  user_password { Faker::Internet.password }
+  user_email { Faker::Internet.email }
+  user_country_code { 'RU' }
+end
+
+RegApi2::Entity::User.blueprint(:bad_password) do
+  user_login { Faker::Name.first_name }
+  user_password { nil }
+  user_email { Faker::Internet.email }
+  user_country_code { 'RU' }
+end
+
+RegApi2::Entity::User.blueprint(:bad_email) do
+  user_login { Faker::Name.first_name }
+  user_password { Faker::Internet.password }
+  user_email { nil }
+  user_country_code { 'RU' }
+end
+
+RegApi2::Entity::User.blueprint(:bad_country_code) do
+  user_login { Faker::Name.first_name }
+  user_password { Faker::Internet.password }
+  user_email { Faker::Internet.email }
+  user_country_code { nil }
+end
+
+RegApi2::Entity::User.blueprint(:good_user) do
+  user_login { 'autotestlogin4532' }
+  user_password { Faker::Internet.password }
+  user_email { Faker::Name.first_name + '@mail.ru' }
+  user_country_code { 'RU' }
+  user_first_name { Faker::Name.first_name }
+  user_last_name { Faker::Name.last_name }
+  check_only { 1 }
+end

data/spec/lib/reg_api2/clients_spec.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+describe RegApi2 do
+
+  describe :nop do
+    it "should raise NO_SUCH_COMMAND" do
+      lambda { RegApi2.clients.nop }.should raise_error RegApi2::ApiError
+      lambda { RegApi2.clients.nop }.should raise_error /NO_SUCH_COMMAND/
+    end
+  end
+end

data/spec/lib/reg_api2/common_spec.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+describe RegApi2 do
+
+  describe :nop do
+    it "should raise nothing" do
+      lambda { RegApi2.common.nop }.should_not raise_error
+    end
+    it "should return login" do
+      RegApi2.common.nop['login'].should == RegApi2.username
+    end
+  end
+
+  describe :reseller_nop do
+    it "should raise nothing" do
+      lambda { RegApi2.common.reseller_nop }.should_not raise_error
+    end
+    it "should return login" do
+      RegApi2.common.reseller_nop['login'].should == RegApi2.username
+    end
+  end
+
+  describe :get_user_id do
+    it "should raise nothing" do
+      lambda { RegApi2.common.get_user_id }.should_not raise_error
+    end
+    it "should return user id" do
+      RegApi2.common.get_user_id.should be_kind_of(Fixnum)
+    end
+  end
+
+  describe :get_service_id do
+    it "should raise nothing" do
+      lambda { RegApi2.common.get_service_id(service_id: 123456) }.should_not raise_error
+    end
+    it "should return user id" do
+      RegApi2.common.get_service_id(service_id: 123456) == 123456
+    end
+  end
+end

data/spec/lib/reg_api2/domains_spec.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+describe RegApi2 do
+  describe :nop do
+    it "should raise NO_SUCH_COMMAND" do
+      lambda { RegApi2::Domains.nop }.should raise_error RegApi2::ApiError
+      lambda { RegApi2.domains.nop }.should raise_error /NO_SUCH_COMMAND/
+    end
+  end
+end

data/spec/lib/reg_api2/entity/entity_base_spec.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+
+class Testplate < RegApi2::Entity::EntityBase
+  attr_accessor :a, :b
+end
+
+describe Testplate do
+  let!(:plate) { Testplate.new(a: 4, b: 5) }
+
+  it "should be initialized with hash" do
+    plate.a.should == 4
+    plate.b.should == 5
+  end
+
+  it "should return the hash" do
+    plate.to_hash.should == { a: 4, b: 5 }
+  end
+
+  it "should return json" do
+    plate.to_json.should =~ /^{.?"a":4/
+  end
+end

data/spec/lib/reg_api2/request_contract/default_spec.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+describe RegApi2::RequestContract::Default do
+
+  let!(:contract) {
+    RegApi2::RequestContract::Default.new(
+      required: %w[ a b ],
+      optional: %w[ c d ]
+    )
+  }
+
+  describe :initialize do
+    it "should assign opts" do
+      contract.opts.should == {
+        required: %w[ a b ],
+        optional: %w[ c d ]
+      }
+    end
+  end
+
+  # TODO: specs
+
+end

data/spec/lib/reg_api2/result_contract/default_spec.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+describe RegApi2::ResultContract::Default do
+
+  let!(:contract) { RegApi2::ResultContract::Default.new(a: 1, b: 4) }
+
+  describe :initialize do
+    it "should assign opts" do
+      contract.opts.should == { a: 1, b: 4 }
+    end
+  end
+
+  describe :handle_result do
+    it "should return handle_answer" do
+      expected = 'OOLOLLO'
+      mock(contract).handle_answer({}) { expected } 
+      contract.handle_result({ "answer" => {} }).should == expected
+    end
+  end
+
+  describe :handle_answer do
+    it "should return specified value" do
+      contract.handle_answer("FX").should == "FX"
+    end
+  end
+end

data/spec/lib/reg_api2/result_contract/single_field_spec.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+describe RegApi2::ResultContract::SingleField do
+
+  let!(:contract) { RegApi2::ResultContract::SingleField.new(field: 'one') }
+
+  describe :initialize do
+    it "should assign opts" do
+      contract.opts.should == { field: 'one' }
+    end
+  end
+
+  describe :handle_answer do
+    it "should return field value if exists" do
+      contract.handle_answer({ "one" => "FX" }).should == "FX"
+    end
+
+    it "should raise ContractError on field unless exists" do
+      lambda { contract.handle_answer({}) }.should raise_error RegApi2::ContractError
+      lambda { contract.handle_answer({}) }.should raise_error /one/
+    end
+  end
+end

data/spec/lib/reg_api2/service_spec.rb

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+describe RegApi2 do
+  before(:all) do
+    RegApi2.username = 'test'
+    RegApi2.password = 'test'
+    RegApi2.lang = 'ru'
+  end
+
+  describe :nop do
+    it "should return list of services if requested" do
+      answer = RegApi2.service.nop(services: [
+        { dname:"test.ru" },
+        { dname: "test.su", servtype: "srv_hosting_ispmgr" },
+        { service_id: 111111 },
+        { service_id: "22bug22" },
+        { surprise: "surprise.ru" }
+      ])
+      answer['services'].map do |rec|
+        rec['result'] == 'success' ? rec['dname'] : rec['error_code']
+      end.sort.should == %w[ INVALID_SERVICE_ID NO_DOMAIN test.ru test.su test12347.ru ]
+    end
+  end
+end

data/spec/lib/reg_api2/user_spec.rb

@@ -0,0 +1,65 @@
+# -*- encoding : utf-8 -*-
+
+require 'blueprints/user'
+
+describe RegApi2 do
+  describe :nop do
+    it "should raise nothing" do
+      lambda { RegApi2.user.nop }.should_not raise_error
+    end
+    
+    it "should return nil" do
+      RegApi2.user.nop.should be_nil
+    end
+  end
+
+  describe :create do
+    it "should raise ContractError unless user_login provided." do
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_login)) }.should raise_error RegApi2::ContractError
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_login)) }.should raise_error /user_login/
+    end
+
+    it "should raise ContractError unless user_password provided." do
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_password)) }.should raise_error RegApi2::ContractError
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_password)) }.should raise_error /user_password/
+    end
+
+    it "should raise ContractError unless user_email provided." do
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_email)) }.should raise_error RegApi2::ContractError
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_email)) }.should raise_error /user_email/
+    end
+  
+    it "should raise ContractError unless user_country_code provided." do
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_country_code)) }.should raise_error RegApi2::ContractError
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:bad_country_code)) }.should raise_error /user_country_code/
+    end
+
+    it "should create user with valid data." do
+      lambda { RegApi2.user.create(RegApi2::Entity::User.make(:good_user)) }.should_not raise_error
+      RegApi2.user.create(RegApi2::Entity::User.make(:good_user)).should == "777"
+    end
+  end
+
+  describe :get_statistics do
+    it "should return user statistics" do
+      RegApi2.user.get_statistics.keys.sort.should == %w[
+        active_domains_cnt 
+        active_domains_get_ctrl_cnt 
+        balance_total 
+        domain_folders_cnt 
+        renew_domains_cnt 
+        renew_domains_get_ctrl_cnt 
+        undelegated_domains_cnt 
+      ]
+    end
+  end
+
+  describe :get_balance do
+    it "should return user balance" do
+      RegApi2.user.get_balance(currency: "USD").keys.sort.should == %w[
+        currency
+        prepay
+      ]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# -*- encoding : utf-8 -*-
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'coveralls'
+Coveralls.wear!
+
+require 'faker'
+require 'machinist'
+require 'rspec/core'
+
+require 'reg_api2'
+
+class RegApi2::Entity::EntityBase
+  extend Machinist::Machinable
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:all) do
+    RegApi2.username = 'test'
+    RegApi2.password = 'test'
+    RegApi2.lang = 'ru'
+  end
+end