recurly 2.18.2 → 2.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ecbf1f0769f7a67b1c5f7f8b5ee0d25fdbea9c93a904b3dd8db5c8de4b2b71a
-  data.tar.gz: 556898b14903f191423e71d67045cc36a957f85446e13d2cf82122d9b3c52806
+  metadata.gz: 1a3231398510bdfe53ef4dc1409033d1b526df8a5131bd3bdbf464e80ad3c112
+  data.tar.gz: ae663af432bea91f8b53da68236753e04ea1081ffd02f421bb32253df94fda5b
 SHA512:
-  metadata.gz: 92c6947d405a13ab65c52380fe7cbc57c10ee0f7118dab82d024488ce3878df8ff822522e8826471b7747d5064ca184c6b4ce91e1b835da762b2216c7981dcd9
-  data.tar.gz: 1e221b69ff31a5a07157683572956095d49ea9a893388aeebd98b8d3caada461d24e9bb3f4cc94490d28cce7c80d5925c56d52361f7dcead00449166667170c2
+  metadata.gz: c4a128e615bd56e65e7bab7be1e2d28ad0388f5f825e0bf934c659b41eab17cede3f232c5acb47801b0f53f633671add39ef30d6672843b2b2dc6acd32b7b6e9
+  data.tar.gz: 312dd60e5df037c75091641f0bc5f2cf80da097f2373a5336398ee1ab9fef7a46a8ca31327191718b2df04d796b46f488ddbafcecc566631b00bde75032243db

data/README.md

@@ -14,7 +14,7 @@ Recurly is packaged as a Ruby gem. We recommend you install it with
 [Bundler](http://gembundler.com/) by adding the following line to your Gemfile:
 
 ``` ruby
-gem 'recurly', '~> 2.18.2'
+gem 'recurly', '~> 2.18.3'
 ```
 
 Recurly will automatically use [Nokogiri](http://nokogiri.org/) (for a nice

data/lib/recurly/purchase.rb

@@ -21,11 +21,9 @@ module Recurly
   # You can also pass in adjustments and invoicing data to be added 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
+  # 1. Use {Purchase#shipping_address_id} if you want to apply an existing shipping
   #    address to all subscriptions, adjustments, and shipping fees 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.
+  # 2. Use {Purchase#shipping_address} if you want to add and apply a single shipping address.
   # 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}
@@ -45,18 +43,6 @@ module Recurly
   #     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',
@@ -84,6 +70,16 @@ module Recurly
   #         revenue_schedule_type: :at_invoice
   #       }
   #     ],
+  #     shipping_address: {
+  #       first_name: 'Benjamin',
+  #       last_name: 'Du Monde',
+  #       address1: '400 Dolores St.',
+  #       city: 'San Francisco',
+  #       state: 'CA',
+  #       zip: '94110',
+  #       country: 'US',
+  #       nickname: 'Home'
+  #     },
   #     shipping_fees: [
   #       {
   #         shipping_method_code: 'fast_fast_fast',
@@ -123,6 +119,9 @@ module Recurly
     # @return [GiftCard, nil]
     has_one :gift_card, class_name: :GiftCard, readonly: false
 
+    # @return [ShippingAddress, nil]
+    has_one :shipping_address, class_name: :ShippingAddress, readonly: false
+
     # @return [[Subscription], nil]
     has_many :subscriptions, class_name: :Subscription, readonly: false
 

data/lib/recurly/subscription.rb

@@ -176,15 +176,17 @@ module Recurly
 
     # Cancel a subscription so that it will not renew.
     #
+    # @param [String] optional timeframe. Choose one of "bill_date" or "term_end"
     # @return [true, false] +true+ when successful, +false+ when unable to
     #   (e.g., the subscription is not active).
     # @example
     #   account = Account.find account_code
     #   subscription = account.subscriptions.first
     #   subscription.cancel # => true
-    def cancel
+    def cancel(timeframe = nil)
       return false unless link? :cancel
-      reload follow_link :cancel
+      params = timeframe.nil? ? {} : { 'timeframe': timeframe }
+      reload follow_link :cancel, params: params
       true
     end
 

data/lib/recurly/version.rb

@@ -1,6 +1,6 @@
 module Recurly
   module Version
-    VERSION = "2.18.2"
+    VERSION = "2.18.3"
 
     class << self
       def inspect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 2.18.2
+  version: 2.18.3
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri