reg.api2 0.0.9 → 0.0.10

data/.travis.yml

@@ -1,7 +1,7 @@
-notifications:
-  recipients:
-    - akzhan.abdulin@gmail.com
+language: ruby
 rvm:
+#  - jruby-19mode
+  - rbx-19mode
   - 1.9.2
   - 1.9.3
   - 2.0.0

data/.yardopts

@@ -5,4 +5,5 @@
 --plugin redcarpet-ext
 -
 README.md
+CHANGES.md
 LICENSE

data/CHANGES.md

@@ -0,0 +1,7 @@
+# Changes
+
+## Version 0.0.10
+
+* Methods of `bill` category now returns array of bills directly instead of `{ 'bills' => [ ... ] }`.
+* Documentation updated.
+

data/lib/reg_api2/bill.rb

@@ -12,23 +12,24 @@ module RegApi2
     # @option opts [String] :bill_id Invoice number in case of a single-invoice request.
     # @option opts [Array] :bills A list if invoice numbers.
     # For testing purposes.
-    # @return [NilClass or Hash(bills)] nil or bills.
+    # @return [NilClass or Array<Hash>] nil or bills.
+    # @note Accessibility: clients
     # @note Support of invoice lists: yes
     # @example Get single bill
     #    RegApi2.bill.nop bill_id: 12345
     # @example Get bills
     #    RegApi2.bill.nop bills: ["12345","12346"]
-    define :nop
+    define :nop, field: :bills
 
     # @!method get_not_payed(opts = {})
     # Use this function to obtain a list of unpaid invoices.
     # @param [Hash] opts
     # @option opts [Fixnum] :limit Defines the number of invoices to be included in the output at a time. Default value: 100. Maximum value: 1024.
     # @option opts [Fixnum] :offset The offset from the starting point, if the number of invoices exceeds the defined limit.
-    # @return [Hash(bills)] Bills.
+    # @return [Array<Hash>] Bills.
     # @note Accessibility: clients
     # @note Support of invoice lists: yes
-    define :get_not_payed
+    define :get_not_payed, field: :bills
 
     # @!method get_for_period(opts = {})
     # Use this function to obtain a list of invoices for the defined period.
@@ -39,25 +40,30 @@ module RegApi2
     # @option opts [Fixnum] :limit Defines the number of invoices to be included in the output at a time. Default value: 100. Maximum value: 1024.
     # @option opts [Fixnum] :offset The offset from the starting point, if the number of invoices exceeds the defined limit.
     # @option opts [Boolean] :all Show inactive invoices, i.e. invoices for outdated services and invoices cancelled due to impossibility of order execution.
-    # @return [Hash(bills)] Bills.
+    # @return [Array<Hash>] Bills.
     # @note Accessibility: partners
     # @note Support of invoice lists: yes
-    define :get_for_period, required: { start_date: { iso_date: true }, end_date: { iso_date: true } }
+    # @example List of invoices using Date objects.
+    #   require 'date'
+    #   RegApi.bill.get_for_period start_date: Date.new(2012, 1, 1), end_date: Date.new(2012, 12, 1)
+    # @example List of invoices using date strings in ISO format.
+    #   RegApi.bill.get_for_period start_date: '2012-01-01', end_date: '2012-12-01'
+    define :get_for_period, required: { start_date: { iso_date: true }, end_date: { iso_date: true } }, field: :bills
 
     # @!method change_pay_type(opts = {})
     # You can use this function to change payment methods. Some of the methods allow issue of invoices in the defined payment systems, advance payments are made immediately.
-    # @note Accessibility: clients
     # @param [Hash] opts
     # @option opts [Fixnum] :bill_id Invoice ID (in case of single invoice request).
     # @option opts [Array(Fixnum)] :bills A list of invoice IDs.
     # @option opts [String] :pay_type New payment type. Mandatory field. Valid values: prepay — advance payment (to be made immediately); WM — WebMoney. With the WMID defined, the invoices are issued to the customer’s WM account; yamoney, ymbill — Yandex.Dengi. To issue an invoice, define ymbill and in advance allow the receipt of invoices from REG.; bank — bank transfer
     # @option opts [String] :currency Currency. Mandatory field. «Yandex.Dengi» allows RUR only, «bank» and «prepay» – RUR and USD, «WebMoney» also allows EUR and UAH.
     # @option opts [Fixnum] :wmid WebMoney ID
+    # @note Accessibility: clients
     # @note Support of invoice lists: yes
-    # @return [Hash(bills)] Bills.
+    # @return [Array<Hash>] Bills.
     # @example Example of request
     #    bill.change_pay_type(currency: :RUR, pay_type: :prepay, bills: [ 123456 ])
-    define :change_pay_type, required: %w[ currency pay_type ]
+    define :change_pay_type, required: %w[ currency pay_type ], field: :bills
 
     # @!method delete(opts = {})
     # Deletion of unpaid invoices.
@@ -66,10 +72,10 @@ module RegApi2
     # @param [Hash] opts
     # @option opts [Fixnum] :bill_id Invoice ID (in case of single invoice request).
     # @option opts [Array(Fixnum)] :bills A list of invoice IDs.
-    # @return [Hash(bills)] Bills.
+    # @return [Array<Hash>] Bills.
     # @example Delete three bills.
     #    bill.delete(bills: [ { bill_id: 12345 }, { bill_id: 12346 }, { bill_id: 12347 } ])    
-    define :delete
+    define :delete, field: :bills
 
     extend self
   end

data/lib/reg_api2/impl.rb

@@ -114,15 +114,11 @@ module RegApi2
     # @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
+      if to.nil? && block_given?
+        to = code_block
       end
-      if block_given?
-        self.dump_requests_to= code_block
-        return nil
-      end
-      self.dump_requests_to= nil
+      self.dump_requests_to = to
+      nil
     end
 
     # Dumps incoming API responses to given `to` or code block.
@@ -141,15 +137,11 @@ module RegApi2
     # @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
+      if to.nil? && block_given?
+        to = code_block
       end
-      if block_given?
-        self.dump_responses_to= code_block
-        return nil
-      end
-      self.dump_responses_to= nil
+      self.dump_responses_to = to
+      nil
     end
 
     # Default IO encoding

data/lib/reg_api2/result_contract.rb

@@ -114,6 +114,7 @@ module RegApi2
     # @see #opts
     def handle_answer(answer)
       answer = convert(answer)
+      return nil  if answer.nil?
       field = opts[:field]
       if field
         answer = answer[field]

data/lib/reg_api2/service.rb

@@ -225,36 +225,53 @@ module RegApi2
     # @!method set_autorenew_flag(opts = {})
     # Enables or disables automatic service renewal.
     # @param opts Options.
+     # @return [NilClass] nil
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :set_autorenew_flag
 
     # @!method suspend(opts = {})
     # Use this function to suspend services (for domains – suspend delegation).
     # @param opts Options.
+    # @return [NilClass] nil
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :suspend
 
     # @!method resume(opts = {})
     # Use this function to resume services (for domains – resume domain delegation).
     # @param opts Options.
+    # @return [NilClass] nil
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :resume
 
     # @!method get_depreciated_period(opts = {})
     # Use this function to calculate the number of periods till the service expiration date.
     # @param opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :get_depreciated_period
 
     # @!method upgrade(opts = {})
     # This function upgrades service subtypes (rate plans). It can be used for changes of rate plans for virtual hosting ("srv_hosting_ispmgr"), VPS servers("srv_vps") and Additional Disk Space for VPS ("srv_disk_space").
     # @param opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :upgrade
 
     # @!method partcontrol_grant(opts = {})
     # You can use this function to grant a part of service management rights to other users.
     # @param opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :partcontrol_grant
 
     # @!method partcontrol_revoke(opts = {})
     # Use this function to stop granting service management rights to other.
     # @param opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :partcontrol_revoke
 
     # @!method resend_mail(opts = {})
@@ -262,7 +279,9 @@ module RegApi2
     # @param opts Options.
     # @option opts [Array] mailtype Email type: `approver_email` — approve ssl certificate order, `certificate_email` — certificate email.
     # @return [Hash(service_id, dname)]
-    # @example Resend mail.
+    # @note Accessibility: clients
+    # @note Support of service lists: no
+        # @example Resend mail.
     #    RegApi2.service.resend_mail servtype: :srv_ssl_certificate
     define :resend_mail
 

data/lib/reg_api2/version.rb

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

data/spec/lib/reg_api2/bill_spec.rb

@@ -14,11 +14,11 @@ describe RegApi2::Bill do
     end
 
     it "should return bill if specified" do
-      bill.nop(bill_id: 12345).bills.should have(1).bill
+      bill.nop(bill_id: 12345).should have(1).bill
     end
 
     it "should return bills if specified" do
-      bill.nop(bills: [ 12345, 12346 ]).bills.should have(2).bills
+      bill.nop(bills: [ 12345, 12346 ]).should have(2).bills
     end  
   end
 
@@ -28,7 +28,7 @@ describe RegApi2::Bill do
     end
 
     it "should return something real" do
-      bill.get_not_payed.bills.should have(1).bill
+      bill.get_not_payed.should have(1).bill
     end
   end
 
@@ -41,7 +41,7 @@ describe RegApi2::Bill do
       bill.get_for_period(
         start_date: Date.new(2000, 1, 1),
         end_date: Date.new(2015, 1, 1)
-      ).bills.should have(1).bill
+      ).should have(1).bill
     end
   end
 
@@ -63,7 +63,7 @@ describe RegApi2::Bill do
         pay_type: :prepay,
         currency: :RUR,
         bills: [ 123456 ]
-      ).bills.should have(1).bill
+      ).should have(1).bill
     end
   end
 
@@ -71,7 +71,7 @@ describe RegApi2::Bill do
     it "should remove three bills if specified" do
       ans = bill.delete(
         bills: [ { bill_id: 12345 }, { bill_id: 12346 }, { bill_id: 12347 } ]
-      ).bills
+      )
       ans.map { |b| b.bill_id }.should == [ 12345, 12346, 12347 ]
       ans.each { |b| b.result.should == 'success' }
       ans.each { |b| b.status.should == 'deleted' }

data/spec/spec_helper.rb

@@ -6,8 +6,11 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-require 'coveralls'
-Coveralls.wear!
+begin
+  require 'coveralls'
+  Coveralls.wear!
+rescue LoadError
+end
 
 require 'faker'
 require 'machinist'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -199,6 +199,7 @@ files:
 - .rspec
 - .travis.yml
 - .yardopts
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
@@ -252,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 890297353583224213
+      hash: 3535020143484780529
 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: 890297353583224213
+      hash: 3535020143484780529
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24