tribune_recurly_api 0.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b9eafd5553b067ea352e854a202c773f0565c728b0fd89c1b8775702f36ee29
+  data.tar.gz: 73269fbd07f54d384a52a04bdc3602c1162386cf942763e2becd16b336a728a9
+SHA512:
+  metadata.gz: 0765af740d352b35433b5fe4b0ab2b4b0c19428b776c4f69c42dac223f7290d839dc1c4a0345f4cbb53d057d306250ed94708f6743df027d6f16fc227b95015f
+  data.tar.gz: cb56612cea6cd6584ecbaae4c31d31d3935167dc7b31c71abd1be887b6fde12b2cbc26b664ad4ecb7ba923b575c2a09bf00915ef1ba28eaf012b270e7bb0baf2

data/lib/recurly_api.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'recurly_api/version'
+require 'recurly_api/client'
+# some info goes here..
+module RecurlyApi
+  class Error < StandardError; end
+
+  # RecurlyApi.logger.debug("I'm a debug log")
+  # logger.info("I'm an info log")
+  # logger.warn("I'm a warn log")
+  # logger.error("I'm an error log: error message")
+  # logger.fatal("I'm a fatal log")
+  def self.logger
+    # @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    @@logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @@logger = logger
+  end
+end

data/lib/recurly_api/client.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+#
+require 'rest-client'
+require 'json'
+module RecurlyApi
+  # Wrapper class to connect Recurly API end-points
+  class Client
+    # Requesting API end-points
+    require_relative './client/accounts'
+    require_relative './client/plans'
+    require_relative './client/subscriptions'
+    require_relative './client/other_requests.rb'
+
+    API_DEFAULTS = { base_host: 'v3.recurly.com',
+                     api_version: 'v2021-02-25' }.freeze
+    # request for The number of records to return per page
+    RECORDS_LIMIT = 20
+    RATE_LIMIT_MAX_RETRIES = 3
+
+    attr_accessor :site_id, :authorization_key, :base_host,
+                  :api_version, :api_endpoint, :ratelimit_retries
+
+    # Initialize a client.
+    # KeyWord args are optional while initializing and defaults to the values present in recurly_config.yml,
+    # Ex: If you want to use custom 'api_version' instead predefined, initialize client as below,
+    #  rc = RecurlyApi::Client.new(api_version: 'v2019-10-10')
+    # @param authorization_key [String] Required, Recurly API auth key.
+    # @param site_id [String] Required, ex: 'subdomain-tribune' for https://tribune.recurly.com
+    # @param base_host [String] Optional, default: v3.recurly.com
+    # @param api_version [String] Optional, Recurly api_version ex: 'v2021-02-25' | 'v2019-10-10'
+    # @param ratelimit_retries [Integer] Optional, retry limit for rate limit exceeds, default: 3
+    def initialize(authorization_key: nil,
+                   site_id: nil,
+                   base_host: nil,
+                   api_version: nil,
+                   ratelimit_retries: RATE_LIMIT_MAX_RETRIES)
+      @authorization_key = authorization_key
+      @site_id = site_id
+      raise ArgumentError, "'authorization_key' must be set to a non-nil value" if @authorization_key.nil?
+      raise ArgumentError, "'site_id' must be set to a non-nil value" if @site_id.nil?
+
+      @base_host = base_host || API_DEFAULTS[:base_host]
+      @api_version = api_version || API_DEFAULTS[:api_version]
+      @api_endpoint = "https://#{@base_host}/sites/#{@site_id}"
+      @ratelimit_retries = ratelimit_retries
+    end
+
+    # request Recurly V3 API (v2021-02-25)(https://developers.recurly.com/api/v2021-02-25/)
+    # @param path [String] path for API call -> ex: 'plans/{plan_id}', 'accounts/{account_id}'.
+    # @param http_method [Symbol] request method -> ex:  get | post | put | delete.
+    # @param params [Hash] query parameters -> ex: { limit: 20, order: :asc etc }
+    # @param payload [Hash] request body parameters( for post, put etc..)
+    # @param add_headers [Hash] additional headers if any ex: User-Agent etc..
+    # RestClient retry { https://blog.appsignal.com/2018/05/16/ensure-retry-and-reraise-exceptions-in-ruby.html }
+    def request_api(path:, http_method: :get, params: {}, payload: {}, add_headers: {})
+      raise ArgumentError, "'request path' must be set to a non-nil value" if path.nil?
+
+      max_retries = ratelimit_retries # max count to retry if rate limit requests are exceeded.
+      retry_count = 0
+      delay = 1 # in seconds
+      end_point = "#{api_endpoint}/#{path}"
+      headers = ensure_request_headers(add_headers).merge!(params: params)
+      resp = RestClient::Request.execute(method: http_method,
+                                         url: end_point,
+                                         payload: payload.empty? ? payload : payload.to_json,
+                                         headers: headers)
+    rescue RestClient::ExceptionWithResponse => e
+      e.response
+    rescue RestClient::Exception => e
+      # Timed out reading data from server
+      e.response
+    rescue StandardError => e
+      raise e.message
+    else
+      begin
+        raise 'API Rate limit exceeded' if rate_limit_exceeded?(resp)
+      rescue StandardError => _e
+        RecurlyApi.logger.error "API Rate limit exceeded retrying again. Retries left: #{max_retries - retry_count}"
+        sleep delay += retry_count
+        retry_count += 1
+        retry if retry_count < max_retries
+      end
+      resp
+    end
+
+    def ensure_request_headers(add_headers)
+      accept_header = "application/vnd.recurly.#{api_version}+json"
+      { "Authorization": authorization_key,
+        "Content-Type": 'application/json',
+        accept: accept_header }.merge!(add_headers)
+    end
+
+    def handle_response!(resp, payload_name: :data, single_node: false)
+      if rate_limit_exceeded?(resp)
+        handle_rate_limit_exceed(resp)
+      else
+        json_body = JSON.parse(resp.body)
+        if json_body['error']
+          handle_error_response(resp.code, json_body)
+        else
+          { success: true, status: resp.code,
+            "#{payload_name}": single_node ? json_body : json_body['data'] }
+        end
+      end
+    end
+
+    def handle_error_response(code, json_body)
+      { success: false, status: code,
+        error: json_body['error']['type'],
+        message: json_body['error']['message'] }
+    end
+
+    # Recurly rate limiting
+    # { https://developers.recurly.com/api/v2019-10-10/#section/Getting-Started/Limits }
+    # The rate limit is calculated over a sliding 5 minute window.
+    # This means a production site could make 4,000 requests within one minute and not hit the rate limit
+    # so long as the site made less than 1,000 requests during the prior 4 minute
+    # --------------
+    # Response Headers that returned related to rate limiting by Recurly.
+    # x_ratelimit_limit: The maximum number of requests available in the current time frame(5-minite window)
+    # x_ratelimit_remaining: the number of requests left for the 5-minute window
+    # x_ratelimit_reset: the remaining window before the rate limit resets, in UNIX Epoch seconds
+
+    # Check if rate limit exceeded or not using resp status code OR x_ratelimit_remaining header
+    def rate_limit_exceeded?(resp)
+      ratelimit_remaining = resp.headers[:x_ratelimit_remaining]
+      resp.code.eql?(429) || (ratelimit_remaining && ratelimit_remaining.to_i < 1)
+    end
+
+    def handle_rate_limit_exceed(resp)
+      resp_headers = resp.headers
+      rate_limit_info = { limit: resp_headers[:x_ratelimit_limit],
+                          remaining: resp_headers[:x_ratelimit_remaining],
+                          reset_time_seconds: resp_headers[:x_ratelimit_reset],
+                          reset_time: DateTime.strptime(resp_headers[:x_ratelimit_reset], '%s') }
+      { success: false, status: 429,
+        error: 'Recurly API Rate limit exceeded',
+        message: 'Too Many Requests, See rate-limiting for more info',
+        rate_limit_info: rate_limit_info }
+    end
+  end
+end

data/lib/recurly_api/client/accounts.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RecurlyApi
+  # API requests to fetch Accounts related data
+  class Client
+    # Fetch Account Info--
+    # { https://developers.recurly.com/api/v2021-02-25/index.html#operation/get_account }
+    # @param ssor_id [String] Required, Account ID(SsorID) or code.
+    # For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    def account_info(ssor_id:)
+      resp = request_api(path: "accounts/#{ssor_id}")
+      handle_response!(resp, payload_name: :account_info, single_node: true)
+    end
+
+    # Deactivate account ---
+    # { https://developers.recurly.com/api/v2021-02-25/index.html#operation/deactivate_account }
+    # @param ssor_id [String] Required, Account ID(SsorID) or code.
+    # For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    def deactivate_account(ssor_id:)
+      path = "accounts/#{ssor_id}"
+      resp = request_api(path: path, http_method: :delete)
+      handle_response!(resp, payload_name: :account_info, single_node: true)
+    end
+  end
+end

data/lib/recurly_api/client/other_requests.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RecurlyApi
+  # This class fetches the data of Recurly API end-points
+  class Client
+    # Show the coupon redemptions for an account --
+    # { https://developers.recurly.com/api/v2021-02-25/index.html#tag/coupon_redemption }
+    # @param ssor_id [String] Recurly Account ID(SsorID) or code.
+    # For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    def coupon_redemptions(ssor_id:)
+      resp = request_api(path: "accounts/#{ssor_id}/coupon_redemptions")
+      handle_response!(resp, payload_name: :coupon_redemptions, single_node: true)
+    end
+
+    # Other request any.....
+  end
+end

data/lib/recurly_api/client/plans.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RecurlyApi
+  # API requests to fetch Plans related data
+  class Client
+    #  List a site's plans
+    # { https://developers.recurly.com/api/v2021-02-25/index.html#operation/list_plans }
+    # @param params [Hash] Optional query string parameters:
+    #        :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
+    #                      commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    # ex:
+    # params = { limit: 2, order: :asc, .....}
+    # ex: client.list_plans(params)
+    def list_plans(**params)
+      resp = request_api(path: 'plans', params: params)
+      # handle_response(resp, payload_name: :plans)
+      handle_response!(resp)
+    end
+
+    # Fetch Plan Info--
+    # { https://developers.recurly.com/api/v2021-02-25/index.html#operation/get_plan}
+    # @param plan_id [String] Plan ID or code.
+    # For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
+    def plan_info(plan_id:)
+      resp = request_api(path: "plans/#{plan_id}")
+      handle_response!(resp, payload_name: :plan_info, single_node: true)
+    end
+  end
+end

data/lib/recurly_api/client/subscriptions.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module RecurlyApi
+  # API requests to fetch Subscriptions related data
+  class Client
+    # Fetch Account Subscriptions ---
+    # { https://developers.recurly.com/api/v2019-10-10/index.html#operation/list_account_subscriptions }
+    # @param ssor_id [String] Account ID(SsorID) or code.
+    # For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
+    # For SsorID no prefix is required
+    #  @param params [Hash] Optional query string parameters
+    def account_subscriptions(ssor_id:, **params)
+      path = "accounts/#{ssor_id}/subscriptions"
+      resp = request_api(path: path, params: params)
+      handle_response!(resp)
+    end
+
+    # Checking if user already has subscription OR
+    # Checking if user has a subscription for particular plan by its code
+    # ---------------
+    # @param ssor_id [String] required, Recurly Account Code(i.e SsorID)
+    # @prams plan_code [String] optional,
+    #    - if present then checks if user has subscription for that particular plan by its code
+    # Usage ex:
+    # client.check_user_subscription(ssor_id: '4900-0272-6875', plan_code: '000150d03d')
+    # response => { :success=>true, :status=>200, :has_subscription=>true }
+    def check_user_subscription(ssor_id:, plan_code: nil)
+      resp = account_subscriptions(ssor_id: "code-#{ssor_id}")
+      if resp[:success]
+        has_subscription = false
+        subs = resp[:data]
+        has_subscription = true if subs.any?
+        if plan_code
+          sub =  subs.detect { |s| s['plan']['code'].eql?(plan_code) }
+          has_subscription = sub ? true : false
+        end
+        { success: true, status: 200, has_subscription: has_subscription }
+      else
+        resp
+      end
+    end
+
+    # List a site's subscriptions
+    # { https://developers.recurly.com/api/v2021-02-25/#operation/list_account_subscriptions }
+    # @param params [Hash] Optional query string parameters:
+    #        :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
+    #                      commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    # ex:
+    # params = { limit: RECORDS_LIMIT, order: :asc, .....}
+    # ex: client.site_subscriptions(params)
+    def site_subscriptions(**params)
+      resp = request_api(path: 'subscriptions', params: params)
+      handle_response!(resp)
+    end
+
+    # Create subscription(new purchase) by ssor_id(Recurly Account code)
+    # { https://developers.recurly.com/api/v2021-02-25/index.html#operation/create_purchase }
+    # @param ssor_id [String] Required, user SSOR_ID (i.e. Reculry Account Code)
+    # @param plan_code [String] Required, plan_code or ID
+    # @param billing_token [String] Required, token genereted by recurlyjs while checkout
+    # @param gateway_code [String] Optional,
+    #   Payment gateway identifier to be used for the purchase transaction
+    #   ( required only if handling Braintree Multiple Merchant accounts )
+    # @param account_info [Hash] Optional query parameters(user provided info while checkout)
+    #      :first_name [String], user First Name
+    #      :last_name [String], user Last Name
+    #      :email [String] user Email
+    # TODO: fetch user email, first_name, last_name by ssor_id connecting to SsorClient
+    # Better to pass first_name, last_name, email fetched from Checkout Page,
+    #   instead of extra DB call to SSOR to get the user details
+    def create_subscription(ssor_id:, billing_token:, plan_code:,
+                            gateway_code: nil, account_info: {})
+      account = { code: ssor_id,
+                  billing_info: { token_id: billing_token } }
+      purchase_payload = { currency: 'USD',
+                           account: account.merge!(account_info),
+                           subscriptions: [{ plan_code: plan_code }] }
+      purchase_payload[:gateway_code] = gateway_code if gateway_code
+      path = 'purchases'
+      resp = request_api(path: path, http_method: :post,
+                         payload: purchase_payload)
+      handle_response!(resp, payload_name: :purchase_info, single_node: true)
+    end
+
+    # Cancel a subscription by its id or UUID
+    # @param sub_id_or_uuid [String] Required
+    #    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2.
+    #    For UUID use prefix uuid-, e.g. uuid-123457890
+    def cancel_subscription(sub_id_or_uuid)
+      path = "subscriptions/#{sub_id_or_uuid}/cancel"
+      resp = request_api(path: path, http_method: :put)
+      handle_response!(resp, payload_name: :subscription_info, single_node: true)
+    end
+  end
+end

data/lib/recurly_api/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Gem visioning
+module RecurlyApi
+  VERSION = '0.4.3'
+end

data/lib/tribune_recurly_api.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'recurly_api'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: tribune_recurly_api
+version: !ruby/object:Gem::Version
+  version: 0.4.3
+platform: ruby
+authors:
+- udevulapally
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Wrapper for connecting to Recurly V3 API.
+email:
+- udevulapally@tribpub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/recurly_api.rb
+- lib/recurly_api/client.rb
+- lib/recurly_api/client/accounts.rb
+- lib/recurly_api/client/other_requests.rb
+- lib/recurly_api/client/plans.rb
+- lib/recurly_api/client/subscriptions.rb
+- lib/recurly_api/version.rb
+- lib/tribune_recurly_api.rb
+homepage:
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Tribune's Ruby Client for Recurly's API integration..
+test_files: []