recurly 2.16.2 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88aeded1f841b46fca644e8b89977c68111e609a13ed580bde4a692acf0fd25
-  data.tar.gz: cffcae2d4baa388b880206f705a81cb2a62dfc83948dc1b2bdecf1aea0e2fbe4
+  metadata.gz: 5bfeb53a4a29911b77e3d863c5ed3354c60205d43c03723f28aa166d161956e0
+  data.tar.gz: 48e368772a86ce80fba49d3621495f344a3b7cc6cd39a6e99e0fff4e8016fda6
 SHA512:
-  metadata.gz: 676ce8e9f2a8e731931ed89dd4a1b293a10a19b5419e18ba60388b2548a6b1c2425faa2081e5ca91c1aa1e6f61b43ccc6d13167841c9ba1f6f6ae402678ea06d
-  data.tar.gz: c0104c602b86fbbb68efda6e9b35271a051d9c3a6bdff25b01d367b065d3a4df6562bd96c3275421b5e2ff20f1a722b4ad18752f95577ec3c61e03ad98fdd3aa
+  metadata.gz: 2bfb17cbe277468533f96a4576d6153b01e164e5f6ef321c204cd252eb0b94522dc7ad393bd39a9b61e3a61be5699f4a0b15bf142d0f791417d7f05321df2137
+  data.tar.gz: 993f84fbf4f298a883f0a25daff915d00a8f0dedcd49a93c303fbdfeafdf96cf77c3869dabe122e1ed593d8baebc1f97c87f791ba60f70d36fe79ebba3cf30fb

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.16.2'
+gem 'recurly', '~> 2.17'
 ```
 
 Recurly will automatically use [Nokogiri](http://nokogiri.org/) (for a nice
@@ -85,8 +85,7 @@ thread you can use the following within the thread's context:
 Recurly.config({
   subdomain: ENV['RECURLY_SUBDOMAIN']
   api_key: ENV['RECURLY_API_KEY'],
-  default_currency: "US",
-  private_key:  ENV['RECURLY_PUBLIC_API_KEY']
+  default_currency: "US"
 })
 ```
 
@@ -96,14 +95,15 @@ will be used.
 
 ## Supported Ruby Versions
 
-We are currently supporting ruby language versions `2.2` and above. `1.9`, `2.0`, and `2.1` may still work but are not officially supported.
+We are currently supporting ruby language versions `2.3` and above. `1.9`, `2.0`, `2.1`, and `2.3` may still work but are not officially supported.
 
 If you are still using one of these rubies, you should know that support for them ended in
-2015 (1.9), 2016 (2.0), and 2017 (2.1) and continuing to use them is a security risk.
+2015 (1.9), 2016 (2.0), 2017 (2.1), 2018 (2.2) and continuing to use them is a security risk.
 
 - https://www.ruby-lang.org/en/news/2015/02/23/support-for-ruby-1-9-3-has-ended/
 - https://www.ruby-lang.org/en/news/2016/02/24/support-plan-of-ruby-2-0-0-and-2-1/
 - https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/
+- https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/
 
 ## Nokogiri Support
 

data/lib/recurly/invoice.rb

@@ -86,7 +86,7 @@ module Recurly
       line_items
       transactions
       terms_and_conditions
-      vat_reverse_charge_notes # Only shows if reverse charge invoice
+      vat_reverse_charge_notes
       customer_notes
       address
       net_terms
@@ -176,11 +176,16 @@ module Recurly
     # 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')
+    # @param refund_method ["credit_first", "transaction_first", "all_transaction", "all_credit"] The method used to refund.
+    # @param external_refund [true, false] Designates that the refund transactions created are manual.
+    # @param credit_customer_notes [String] Adds notes to refund credit invoice.
+    # @param payment_method [String] Creates the manual transactions with this payment method. Allowed if *external_refund* is true.
+    # @param description [String] Sets this value as the *transaction_note* on the manual transactions created. Allowed if *external_refund* is true.
+    # @param refunded_at [DateTime] Sets this value as the *collected_at* on the manual transactions created. Allowed if *external_refund* is true.
+    def refund(line_items = nil, refund_method = 'credit_first', options = {})
       return false unless link? :refund
       self.class.from_response(
-        follow_link :refund, :body => refund_line_items_to_xml(line_items, refund_method)
+        follow_link :refund, :body => refund_line_items_to_xml(line_items, refund_method, options)
       )
     end
 
@@ -190,11 +195,16 @@ module Recurly
     # 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'
+    # @param refund_method ["credit_first", "transaction_first", "all_transaction", "all_credit"] The method used to refund.
+    # @param external_refund [true, false] Designates that the refund transactions created are manual.
+    # @param credit_customer_notes [String] Adds notes to refund credit invoice.
+    # @param payment_method [String] Creates the manual transactions with this payment method. Allowed if *external_refund* is true.
+    # @param description [String] Sets this value as the *transaction_note* on the manual transactions created. Allowed if *external_refund* is true.
+    # @param refunded_at [DateTime] Sets this value as the *collected_at* on the manual transactions created. Allowed if *external_refund* is true.
+    def refund_amount(amount_in_cents = nil, refund_method = 'credit_first', options = {})
       return false unless link? :refund
       self.class.from_response(
-        follow_link :refund, :body => refund_amount_to_xml(amount_in_cents, refund_method)
+        follow_link :refund, :body => refund_amount_to_xml(amount_in_cents, refund_method, options)
       )
     end
 
@@ -224,17 +234,23 @@ module Recurly
       super({ :currency => Recurly.default_currency }.merge attributes)
     end
 
-    def refund_amount_to_xml amount_in_cents = nil, refund_method
+    def refund_amount_to_xml(amount_in_cents = nil, refund_method = nil, options = {})
       builder = XML.new("<invoice/>")
       builder.add_element 'refund_method', refund_method
       builder.add_element 'amount_in_cents', amount_in_cents
+      options.each do |k, v|
+        builder.add_element k.to_s, v
+      end
       builder.to_s
     end
 
-    def refund_line_items_to_xml line_items = [], refund_method
+    def refund_line_items_to_xml(line_items = nil, refund_method = nil, options = {})
       builder = XML.new("<invoice/>")
       builder.add_element 'refund_method', refund_method
-
+      options.each do |k, v|
+        builder.add_element k.to_s, v
+      end
+      line_items ||= []
       node = builder.add_element 'line_items'
       line_items.each do |line_item|
         adj_node = node.add_element 'adjustment'

data/lib/recurly/js.rb

@@ -1,35 +1,6 @@
-require 'openssl'
-require 'base64'
-require 'cgi'
-
 module Recurly
-  # @deprecated Please use the new Recurly.js tokenization system https://dev.recurly.com/docs/recurlyjs
-  #
-  # A collection of helper methods to use to verify the old
-  # {Recurly.js}[http://js.recurly.com/] callbacks.
   module JS
-    # Raised when signature verification fails.
-    class RequestForgery < Error
-    end
-
-    # Raised when the timestamp is over an hour old. Prevents replay attacks.
-    class RequestTooOld < RequestForgery
-    end
-
     class << self
-      # @return [String] A private key for Recurly.js.
-      # @raise [ConfigurationError] No private key has been set.
-      def private_key
-        if Thread.current[:recurly_config] && Thread.current[:recurly_config][:private_key]
-          return Thread.current[:recurly_config][:private_key]
-        end
-
-        defined? @private_key and @private_key or raise(
-          ConfigurationError, "private_key not configured"
-        )
-      end
-      attr_writer :private_key
-
       # @return [String] A public key for Recurly.js.
       # @raise [ConfigurationError] No public key has been set.
       def public_key
@@ -38,58 +9,6 @@ module Recurly
         )
       end
       attr_writer :public_key
-
-      # Create a signature for a given hash for Recurly.js
-      # @param Array of objects and hash of data to sign
-      def sign *records
-        data = records.last.is_a?(Hash) ? records.pop.dup : {}
-        records.each do |record|
-          data[record.class.member_name] = record.signable_attributes
-        end
-        Helper.stringify_keys! data
-        data['timestamp'] ||= Time.now.to_i
-        data['nonce'] ||= Base64.encode64(
-          OpenSSL::Random.random_bytes(32)
-        ).gsub(/\W/, '')
-        unsigned = to_query data
-        signed = OpenSSL::HMAC.hexdigest 'sha1', private_key, unsigned
-        signature = [signed, unsigned].join '|'
-        signature = signature.html_safe if signature.respond_to? :html_safe
-        signature
-      end
-
-      # Fetches a record using a token provided by Recurly.js.
-      # @param [String] Token to look up
-      # @return [BillingInfo, Invoice, Subscription] The record created or
-      #   modified by Recurly.js
-      # @raise [API::NotFound] No record was found for the token provided.
-      # @example
-      #   begin
-      #     Recurly.js.fetch params[:token]
-      #   rescue Recurly::API::NotFound
-      #     # Handle potential tampering here.
-      #   end
-      def fetch token
-        Resource.from_response API.get "recurly_js/result/#{token}"
-      end
-
-      # @return [String]
-      def inspect
-        'Recurly.js'
-      end
-
-      private
-
-      def to_query object, key = nil
-        case object
-        when Hash
-          object.map { |k, v| to_query v, key ? "#{key}[#{k}]" : k }.sort * '&'
-        when Array
-          object.map { |o| to_query o, "#{key}[]" } * '&'
-        else
-          "#{CGI.escape key.to_s}=#{CGI.escape object.to_s}"
-        end
-      end
     end
   end
 end

data/lib/recurly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 2.16.2
+  version: 2.17.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'An API client library for Recurly: http://recurly.com'
+description: 'An API client library for Recurly: https://recurly.com'
 email: support@recurly.com
 executables: []
 extensions: []
@@ -271,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Recurly API Client