recurly 2.15.0 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79a20ab75b4ef516202e7be58e66ae30cd07d3e4
-  data.tar.gz: 1ed091b912940dfa9868139668b6f2d8b2c290d2
+  metadata.gz: '08185bb7912acbdca11fd008efc46dd66b287aed'
+  data.tar.gz: 41cae4eb087ce6c6abe567f4be13bc6603d4b9a3
 SHA512:
-  metadata.gz: a3b448e8c15ee9731c1f20209645f14937c3deb9baf7a950ccc57f9c90c83dfe5263c66ca120686912f97d4006562bc45cc392a476e51ea908c622970b0920ad
-  data.tar.gz: 821dcb4d1ec270a673ccd781312445e478520dd2994895435c71cb5d743eb30f2bfa9e9c010ab6765eb34412956f0b90d73840aa5324a3d1e9b26cb59239edb3
+  metadata.gz: 248ce1ee1bab0b1e38971837e0e4519aad201af96f6f13e2d3aa1ede337c73076701855fc7ab8e1523110d4fb6106ea2ec03cc703f7d4c658c63173eb23f31d2
+  data.tar.gz: 4818d9d58d4beea331f53923f2ac3f37583fa404a827d0ff33a409b79149a12849668628d68514e57b2c9aadabc184280068e044e04906cc8551b243d0cfb153

data/README.md

@@ -156,27 +156,3 @@ If you plan on submitting a patch, please write tests for it (we use
 [MiniTest::Spec](http://bfts.rubyforge.org/minitest/MiniTest/Expectations.html)).
 
 If everything looks good, submit a pull request on GitHub and we'll bring in your changes.
-
-## License
-
-(The MIT License.)
-
-© 2009–2017 Recurly Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/lib/recurly.rb

@@ -4,6 +4,7 @@ module Recurly
   require 'recurly/helper'
   require 'recurly/api'
   require 'recurly/resource'
+  require 'recurly/shipping_address'
   require 'recurly/billing_info'
   require 'recurly/account'
   require 'recurly/account_balance'
@@ -23,7 +24,6 @@ module Recurly
   require 'recurly/measured_unit'
   require 'recurly/plan'
   require 'recurly/redemption'
-  require 'recurly/shipping_address'
   require 'recurly/subscription'
   require 'recurly/subscription_add_on'
   require 'recurly/transaction'

data/lib/recurly/account.rb

@@ -73,6 +73,8 @@ module Recurly
       has_future_subscription
       has_canceled_subscription
       has_past_due_invoice
+      has_paused_subscription
+      preferred_locale
     )
     alias to_param account_code
 

data/lib/recurly/adjustment.rb

@@ -21,6 +21,9 @@ module Recurly
     # @return [Pager<Adjustment>, []]
     has_many :credit_adjustments, class_name: :Adjustment, readonly: true
 
+    # @return [ShippingAddress, nil]
+    has_one :shipping_address, class_name: :ShippingAddress, readonly: false
+
     define_attribute_methods %w(
       uuid
       state
@@ -50,6 +53,7 @@ module Recurly
       proration_rate
       credit_reason_code
       original_adjustment_uuid
+      shipping_address_id
     )
     alias to_param uuid
 

data/lib/recurly/api.rb

@@ -17,7 +17,7 @@ module Recurly
     @@base_uri = "https://api.recurly.com/v2/"
     @@valid_domains = [".recurly.com"]
 
-    RECURLY_API_VERSION = '2.10'
+    RECURLY_API_VERSION = '2.11'
 
     FORMATS = Helper.hash_with_indifferent_read_access(
       'pdf' => 'application/pdf',

data/lib/recurly/invoice.rb

@@ -32,7 +32,7 @@ module Recurly
     # @return [Pager<Redemption>, []]
     has_many :redemptions
 
-    # @return [Pager<ShippingAddress>, [ShippingAddress], []]
+    # @return [ShippingAddress, nil]
     has_one :shipping_address, class_name: :ShippingAddress, readonly: true
 
     # @return [Pager<Invoice>, []]

data/lib/recurly/purchase.rb

@@ -19,18 +19,42 @@ module Recurly
   # in the same way you would when creating a {Subscription} with a new account.
   #
   # You can also pass in adjustments and invoicing data to be passed to the invoice.
+  #
+  # There are multiple ways to set the shipping addresses:
+  # 1. Use {Purchase#shipping_address_id} If you want to apply an existing shipping
+  #    address to all subscriptions and adjustments in this purchase.
+  # 2. Add multiple shipping addresses to {Account#shipping_addresses}. The last
+  #    address in the list will apply to all subscriptions and adjustments
+  #    in this purchase.
+  # 3. Use {Subscription#shipping_address_id} or {Subscription#shipping_address}
+  #    to set a shipping address for only the subscription.
+  # 4. Use {Adjustment#shipping_address_id} or {Adjustment#shipping_address}
+  #    to set a shipping address for only the adjustment.
+  #
   # @example
   #   require 'securerandom'
   #
-  #   purchase = Recurly::Purchase.new({
+  #   purchase = Recurly::Purchase.new(
   #     currency: 'USD',
   #     collection_method: :automatic,
   #     account: {
   #       account_code: SecureRandom.uuid,
+  #       shipping_addresses: [
+  #         {
+  #           first_name: 'Benjamin',
+  #           last_name: 'Du Monde',
+  #           address1: '400 Dolores St.',
+  #           city: 'San Francisco',
+  #           state: 'CA',
+  #           zip: '94110',
+  #           country: 'US',
+  #           nickname: 'Home'
+  #         }
+  #       ],
   #       billing_info: {
   #         first_name: 'Benjamin',
   #         last_name: 'Du Monde',
-  #         address1: '400 Alabama St',
+  #         address1: '400 Alabama St.',
   #         city: 'San Francisco',
   #         state: 'CA',
   #         zip: '94110',
@@ -54,7 +78,7 @@ module Recurly
   #         revenue_schedule_type: :at_invoice
   #       }
   #     ]
-  #   })
+  #   )
   #
   #   begin
   #     preview_invoice = Recurly::Purchase.preview!(purchase)
@@ -98,6 +122,7 @@ module Recurly
       terms_and_conditions
       customer_notes
       vat_reverse_charge_notes
+      shipping_address_id
     )
 
     class << self

data/lib/recurly/subscription.rb

@@ -80,6 +80,8 @@ module Recurly
       no_billing_info_reason
       imported_trial
       credit_customer_notes
+      remaining_pause_cycles
+      paused_at
     )
     alias to_param uuid
 
@@ -220,8 +222,8 @@ module Recurly
 
     # Update the notes sections of the subscription
     #
+    # @param notes [Hash] should be the notes parameters you wish to update
     # @return [true, false] +true+ when successful, +false+ when unable to
-    # @params notes [Hash] should be the notes parameters you wish to update
     def update_notes(notes)
       return false unless link? :notes
       self.attributes = notes
@@ -229,6 +231,40 @@ module Recurly
       true
     end
 
+    # Pauses a subscription or cancels a scheduled pause.
+    #
+    # * For an active subscription without a pause scheduled already,
+    # this will schedule a pause period to begin at the next renewal
+    # date for the specified number of billing cycles (remaining_pause_cycles).
+    # * When a scheduled pause already exists, this will update the remaining
+    # pause cycles with the new value sent. When zero (0) remaining_pause_cycles
+    # is sent for a subscription with a scheduled pause, the pause will be canceled.
+    # * For a paused subscription, the remaining_pause_cycles will adjust the
+    # length of the current pause period. Sending zero (0) in the remaining_pause_cycles
+    # field will cause the subscription to be resumed at the next renewal date.
+    #
+    # @param remaining_pause_cycles [Integer] The number of billing cycles that the subscription will be paused.
+    # @return true
+    def pause(remaining_pause_cycles)
+      builder = XML.new("<subscription/>")
+      builder.add_element('remaining_pause_cycles', remaining_pause_cycles)
+      reload API.put("#{uri}/pause", builder.to_s)
+      true
+    end
+
+    # Resumes a paused subscription.
+    #
+    # For a paused subscription, this will immediately resume the subscription
+    # from the pause, produce an invoice, and return the newly resumed subscription.
+    # Any at-renewal subscription changes will be immediately applied
+    # when the subscription resumes.
+    #
+    # @return true
+    def resume
+      reload API.put("#{uri}/resume")
+      true
+    end
+
     # Overrides the behavior of `update_attributes` in Resource class so ensure
     # all attributes are marked as dirty if the plan code changes
     def update_attributes attributes = {}

data/lib/recurly/version.rb

@@ -2,7 +2,7 @@ module Recurly
   module Version
     MAJOR   = 2
     MINOR   = 15
-    PATCH   = 0
+    PATCH   = 1
     PRE     = nil
 
     VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze

data/lib/recurly/xml.rb

@@ -84,17 +84,36 @@ module Recurly
 end
 
 if defined? Nokogiri
-  if RUBY_VERSION < "2.1.0"
-    raise <<-MSG
+  insecure_noko_msg = <<-MSG
 
-      You are attempting to use an insecure version of
-      nokogiri on an insecure version of ruby. Please see
-      the documentation on supported versions for more information:
-      https://github.com/recurly/recurly-client-ruby#supported-versions
+    You are attempting to use an insecure version of
+    nokogiri on an insecure version of ruby. Please see
+    the documentation on supported versions for more information:
+    https://github.com/recurly/recurly-client-ruby#supported-versions
 
-    MSG
+  MSG
+  if RUBY_VERSION < "2.1.0"
+    raise insecure_noko_msg
   else
     require 'recurly/xml/nokogiri'
+    version = Gem::Version.new(Nokogiri::VERSION)
+
+    if version.segments.length == 3
+      major, minor, patch = version.segments
+    else
+      major, minor, patch, _pre = version.segments
+    end
+
+    # Only warning users for now
+    if minor < 6
+      puts insecure_noko_msg
+    elsif minor == 6 && patch < 8
+      puts insecure_noko_msg
+    elsif minor == 7 && patch < 2
+      puts insecure_noko_msg
+    elsif minor == 8 && patch < 2
+      puts insecure_noko_msg
+    end
   end
 else
   require 'recurly/xml/rexml'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.15.1
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: 1.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement