recurly 2.14.1 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c8e60038f1fbb3762105225c21991eeeb0c87d6d90c6ed6f024dda9c95369a41
-  data.tar.gz: c8a792a38f9faffc340abf9370f2646303bb467b8034422f6e796f119beab148
+SHA1:
+  metadata.gz: 79a20ab75b4ef516202e7be58e66ae30cd07d3e4
+  data.tar.gz: 1ed091b912940dfa9868139668b6f2d8b2c290d2
 SHA512:
-  metadata.gz: e7f8d7e9cc69df1ceda438557e90be530f1691ce413458f78da5d06cd19780d2986cece301672f6a6937f25fa01f59ed59f8369623897ea0313afd4ca7758f58
-  data.tar.gz: '093ba8354e1a54df6f5f3bb91c13df07c58086f010a7df24a9d4b8e42627ce24459499fc9aa32c98bc8dc126c699d5d69b7fa5a97b717ae00398000937e9cb6a'
+  metadata.gz: a3b448e8c15ee9731c1f20209645f14937c3deb9baf7a950ccc57f9c90c83dfe5263c66ca120686912f97d4006562bc45cc392a476e51ea908c622970b0920ad
+  data.tar.gz: 821dcb4d1ec270a673ccd781312445e478520dd2994895435c71cb5d743eb30f2bfa9e9c010ab6765eb34412956f0b90d73840aa5324a3d1e9b26cb59239edb3

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.14.0'
+gem 'recurly', '~> 2.15.0'
 ```
 
 Recurly will automatically use [Nokogiri](http://nokogiri.org/) (for a nice

data/lib/recurly.rb

@@ -89,8 +89,6 @@ module Recurly
     end
 
     # Assigns a logger to log requests/responses and more.
-    # The logger can only be set if the environment variable
-    # `RECURLY_INSECURE_DEBUG` equals `true`.
     #
     # @return [Logger, nil]
     # @example
@@ -102,22 +100,6 @@ module Recurly
     #   Recurly.logger = nil # Or Recurly.logger = Logger.new nil
     attr_accessor :logger
 
-    def logger=(logger)
-      if ENV['RECURLY_INSECURE_DEBUG'].to_s.downcase == 'true'
-        @logger = logger
-        puts <<-MSG
-        [WARNING] Recurly logger enabled. The logger has the potential to leak
-        PII and should never be used in production environments.
-        MSG
-      else
-        puts <<-MSG
-        [WARNING] Recurly logger has been disabled. If you wish to use it,
-        only do so in a non-production environment and make sure
-        the `RECURLY_INSECURE_DEBUG` environment variable is set to `true`.
-        MSG
-      end
-    end
-
     # Convenience logging method includes a Logger#progname dynamically.
     # @return [true, nil]
     def log level, message

data/lib/recurly/gift_card.rb

@@ -25,6 +25,7 @@ module Recurly
       updated_at
       canceled_at
     )
+    alias to_param id
 
     # Preview a GiftCard given some attributes
     #

data/lib/recurly/invoice.rb

@@ -164,28 +164,28 @@ module Recurly
 
     # Refunds specific line items on the invoice.
     #
-    # @return [InvoiceCollection, false] A new refund invoice, false if the invoice isn't
+    # @return [Invoice, false] Invoice if successful, false if the invoice isn't
     # refundable.
     # @raise [Error] If the refund fails.
     # @param line_items [Array, nil] An array of line items to refund.
     # @param refund_method ["credit_first", "transaction_first"] The method used to refund.
     def refund(line_items = nil, refund_method = 'credit_first')
       return false unless link? :refund
-      InvoiceCollection.from_response(
+      self.class.from_response(
         follow_link :refund, :body => refund_line_items_to_xml(line_items, refund_method)
       )
     end
 
     # Refunds the invoice for a specific amount.
     #
-    # @return [Invoice, false] A new refund invoice, false if the invoice isn't
+    # @return [Invoice, false] Invoice if successful, false if the invoice isn't
     # refundable.
     # @raise [Error] If the refund fails.
     # @param amount_in_cents [Integer, nil] The amount (in cents) to refund.
     # @param refund_method ["credit_first", "transaction_first"] The method used to refund.
     def refund_amount amount_in_cents = nil, refund_method = 'credit_first'
       return false unless link? :refund
-      InvoiceCollection.from_response(
+      self.class.from_response(
         follow_link :refund, :body => refund_amount_to_xml(amount_in_cents, refund_method)
       )
     end

data/lib/recurly/resource.rb

@@ -285,14 +285,24 @@ module Recurly
 
       # Iterates through every record by automatically paging.
       #
+      # @option options [Hash] Optional hash to pass to Pager#paginate
+      #
       # @return [nil]
       # @param [Integer] per_page The number of records returned per request.
       # @yield [record]
-      # @see Pager#find_each
+      # @see Pager#paginate
       # @example
       #   Recurly::Account.find_each { |a| p a }
-      def find_each(per_page = 50, &block)
-        paginate(:per_page => per_page).find_each(&block)
+      # @example With sorting and filter
+      #   opts = {
+      #     begin_time: DateTime.new(2016,1,1),
+      #     sort: :updated_at
+      #   }
+      #   Recurly::Account.find_each(opts) do |a|
+      #     puts a.inspect
+      #   end
+      def find_each(options = {}, &block)
+        paginate(options).find_each(&block)
       end
 
       # @return [Integer] The total record count of the resource in question.

data/lib/recurly/resource/pager.rb

@@ -20,6 +20,34 @@ module Recurly
     #
     #   account.transactions.new(attributes) # or #create, or #create!
     #   # => #<Recurly::Transaction ...>
+    #
+    #   account.transactions.find_each do |transaction|
+    #     puts transaction
+    #   end
+    # @example Iterate through a page of invoices at a time
+    #   opts = {
+    #     order: :desc,
+    #     state: :collected
+    #   }
+    #   invoices = Recurly::Invoice.paginate(opts)
+    #   begin
+    #     invoices.each do |invoice|
+    #       puts invoice.invoice_number
+    #     end
+    #     puts "fetching next page..."
+    #   end while invoices.next
+    # @example Passing sorting and filtering parameters
+    #   opts = {
+    #     begin_time: DateTime.new(2016,1,1),
+    #     end_time: DateTime.new(2017,1,1),
+    #     sort: :updated_at,
+    #     order: :desc,
+    #     state: :collected
+    #   }
+    #   Recurly::Invoice.find_each(opts) do |invoice|
+    #     puts invoice
+    #   end
+    #
     class Pager
       include Enumerable
 
@@ -68,6 +96,13 @@ module Recurly
         @collection = nil
       end
 
+      # This will tell you if there are any associated resources
+      # on the server by checking the presence of a link in the xml
+      #
+      # @example
+      #   # if <invoices href="..." /> is present, will return true
+      #   account.invoices.any?
+      #   #=> true
       # @return [Boolean] whether or not the xml element is present
       def any?
         !@uri.nil?
@@ -78,6 +113,17 @@ module Recurly
         @uri ||= resource_class.collection_path
       end
 
+      # Calls the server to get the count of server side resources.
+      #
+      # @example Count collected invoices in 2016
+      #   opts = {
+      #     begin_time: DateTime.new(2016,1,1),
+      #     end_time: DateTime.new(2017,1,1),
+      #     state: :collected
+      #   }
+      #   count = Recurly::Invoice.paginate(opts).count
+      #   #=> 42
+      #
       # @return [Integer] The total record count of the resource in question.
       # @see Resource.count
       def count
@@ -127,12 +173,25 @@ module Recurly
       end
       alias reload load!
 
+
       # @return [Pager] Duplicates the pager, updating it with the options
       #   supplied. Useful for resource scopes.
-      # @see #initialize
+      # @option options [String, Symbol] :sort The attribute that will be used to order
+      #   records: <tt>created_at</tt>, <tt>updated_at</tt>. Defaults to <tt>created_at</tt>.
+      # @option options [String, Symbol] :order The order in which records will be
+      #   returned: <tt>asc</tt> for ascending order, <tt>desc</tt> for descending order.
+      #   Defaults to <tt>desc</tt>.
+      # @option options [DateTime, String] :begin_time Operates on the attribute specified by the
+      #   <tt>sort</tt> parameter. Filters records to only include those with datetimes
+      #   greater than or equal to the supplied datetime. Accepts an ISO 8601
+      #   date or date and time.
+      # @option options [DateTime, String] :end_time Operates on the attribute specified by
+      #   the <tt>sort</tt> parameter. Filters records to only include those with
+      #   datetimes less than or equal to the supplied datetime. Accepts an
+      #   ISO 8601 date or date and time.
       # @example
-      #   Recurly::Account.active.paginate :per_page => 20
-      def paginate options = {}
+      #   Recurly::Account.paginate(sort: :updated_at, per_page: 20)
+      def paginate(options = {})
         dup.instance_eval {
           @collection = @etag = nil
           @options = @options.merge options

data/lib/recurly/version.rb

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

data/lib/recurly/webhook.rb

@@ -47,8 +47,11 @@ module Recurly
     autoload :ProcessingInvoiceNotification,    'recurly/webhook/processing_invoice_notification'
     autoload :ScheduledPaymentNotification,     'recurly/webhook/scheduled_payment_notification'
     autoload :NewDunningEventNotification,      'recurly/webhook/new_dunning_event_notification'
+    autoload :GiftCardNotification,             'recurly/webhook/gift_card_notification'
+    autoload :PurchasedGiftCardNotification,    'recurly/webhook/purchased_gift_card_notification'
+    autoload :RedeemedGiftCardNotification,     'recurly/webhook/redeemed_gift_card_notification'
+    autoload :UpdatedBalanceGiftCardNotification,'recurly/webhook/updated_balance_gift_card_notification'
     autoload :NewUsageNotification,             'recurly/webhook/new_usage_notification'
-
     # This exception is raised if the Webhook Notification initialization fails
     class NotificationError < Error
     end

data/lib/recurly/webhook/gift_card_notification.rb

@@ -0,0 +1,8 @@
+module Recurly
+  module Webhook
+    class GiftCardNotification < Notification
+      has_one :gift_card
+
+    end
+  end
+end

data/lib/recurly/webhook/purchased_gift_card_notification.rb

@@ -0,0 +1,7 @@
+module Recurly
+  module Webhook
+    class PurchasedGiftCardNotification < GiftCardNotification
+
+    end
+  end
+end

data/lib/recurly/webhook/redeemed_gift_card_notification.rb

@@ -0,0 +1,7 @@
+module Recurly
+  module Webhook
+    class RedeemedGiftCardNotification < GiftCardNotification
+
+    end
+  end
+end

data/lib/recurly/webhook/updated_balance_gift_card_notification.rb

@@ -0,0 +1,7 @@
+module Recurly
+  module Webhook
+    class UpdatedBalanceGiftCardNotification < GiftCardNotification
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 2.14.1
+  version: 2.15.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -210,6 +210,7 @@ files:
 - lib/recurly/webhook/dunning_notification.rb
 - lib/recurly/webhook/expired_subscription_notification.rb
 - lib/recurly/webhook/failed_payment_notification.rb
+- lib/recurly/webhook/gift_card_notification.rb
 - lib/recurly/webhook/invoice_notification.rb
 - lib/recurly/webhook/new_account_notification.rb
 - lib/recurly/webhook/new_dunning_event_notification.rb
@@ -220,7 +221,9 @@ files:
 - lib/recurly/webhook/past_due_invoice_notification.rb
 - lib/recurly/webhook/processing_invoice_notification.rb
 - lib/recurly/webhook/processing_payment_notification.rb
+- lib/recurly/webhook/purchased_gift_card_notification.rb
 - lib/recurly/webhook/reactivated_account_notification.rb
+- lib/recurly/webhook/redeemed_gift_card_notification.rb
 - lib/recurly/webhook/renewed_subscription_notification.rb
 - lib/recurly/webhook/scheduled_payment_notification.rb
 - lib/recurly/webhook/subscription_notification.rb
@@ -228,6 +231,7 @@ files:
 - lib/recurly/webhook/successful_refund_notification.rb
 - lib/recurly/webhook/transaction_notification.rb
 - lib/recurly/webhook/updated_account_notification.rb
+- lib/recurly/webhook/updated_balance_gift_card_notification.rb
 - lib/recurly/webhook/updated_subscription_notification.rb
 - lib/recurly/webhook/void_payment_notification.rb
 - lib/recurly/xml.rb
@@ -255,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Recurly API Client