tribune_recurly_api 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90bc9314bc9a69973358b2865c2f75c5d4ce83f17393304deec39e8dae4dc2d4
-  data.tar.gz: 44ba860e9260009fb54fc277fc7418b5da1325d4d304dff30f7fe247b544450c
+  metadata.gz: 710191b3144933ba14175b9f79f8b913c1838daf314103e03b2ce3c2a01d6c7b
+  data.tar.gz: 1c590a30db886709b49db2628a532de7da49f1bcc2774274e992a486095821e8
 SHA512:
-  metadata.gz: 8a526bdd23c232b57019d4f5bd8356781cbfd696efd32fef9baefabda89d3b469261dc8ad1e3a313548f269d517e29f8f81a95e5a30a53fd285bfdae20f3adba
-  data.tar.gz: 5bfccbbc08e4fdb9edf9a972dade04955d92094af277546eff4698a55e67220e8fa1e2e0dbe8b60e05b4677175f80818c225284da9da8726d532d7c064debcb8
+  metadata.gz: b5357d11ad9b95582f81582fb3aec20759c3bc4fc5072e8608908d10a7fcb07f01d96e837235300bbdf6df2de3cf58eb38a6634fc37e3334f59a9374061b8993
+  data.tar.gz: cd48953eb36937260352b95ec6c58076204e261a604b33da7812eebc487de3fb9f2788012d6a33cf0690f47974100e2b16591a51a41e9a279d9142dbbb1c164a

data/lib/recurly_api/caching.rb

@@ -9,9 +9,11 @@ module RecurlyApi
                   :cache_expires_in,
                   :cache_key # key name to read/write cache, # default value is caller method_name
 
-    # default settings for caching, every GET request is cached by default with default expiry_time 5.seconds
+    # default settings for caching, every GET request is cached by default with default expiry_time 300 seconds(5 minutes)
     CACHE_SETTINGS = { bypass: false,
-                       expiry_time_in_secs: 60 }.freeze
+                       default_expiry: 300,
+                       plan_expiry: 300,
+                       subscription_expiry: 5 }.freeze
 
     # Usage examples to perform caching in RecurlyApi:Client
     # cache.write('key', 'val', expires_in: 30)

data/lib/recurly_api/client.rb

@@ -27,7 +27,7 @@ module RecurlyApi
 
     # Initialize method attributes
     attr_accessor :site_id, :authorization_key, :base_host,
-                  :api_version, :api_endpoint
+                  :api_version, :api_endpoint, :cache_settings
     # request attributes for request_api method
     attr_accessor :path_name, :http_method, :query_params,
                   :payload, :additional_headers, :payload_name,
@@ -45,11 +45,14 @@ module RecurlyApi
     # @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
+    # @param cache_settings [Hash] Optional, default settings for caching
+    # rubocop:disable Metrics/ParameterLists
     def initialize(authorization_key:,
                    site_id:,
                    base_host: nil,
                    api_version: nil,
-                   ratelimit_retries: RATE_LIMIT_MAX_RETRIES)
+                   ratelimit_retries: RATE_LIMIT_MAX_RETRIES,
+                   cache_settings: CACHE_SETTINGS)
       @authorization_key = authorization_key
       @site_id = site_id
       raise ArgumentError, "'authorization_key' must be set to a non-nil value" if @authorization_key.nil?
@@ -59,8 +62,9 @@ module RecurlyApi
       @api_version = api_version || API_DEFAULTS[:api_version]
       @api_endpoint = "https://#{@base_host}/sites/#{@site_id}"
       @ratelimit_retries = ratelimit_retries
-      @cache_expires_in = CACHE_SETTINGS[:expiry_time_in_secs]
-      @ignore_caching = CACHE_SETTINGS[:bypass]
+      @cache_settings = cache_settings
+      @cache_expires_in = cache_settings[:default_expiry]
+      @ignore_caching = cache_settings[:bypass]
     end
 
     # TODO: remove unnecessary logs once integration testing completed
@@ -78,7 +82,7 @@ module RecurlyApi
     # @param optional_params [Hash] Optional, or any of below ( ref full usage example)
     #  :payload_name [Symbol] Optional, defaults to ':data'
     #  :bypass_caching [Boolean] Optional, default value is false
-    #  :cache_expiry_in_secs [Integer] Optional, default value is 60 seconds
+    #  :cache_expiry_in [Integer] Optional, default value is 300 seconds
 
     # Ful Usage Example: Below is the example for 'request_api' call that includes all options
     #       res = request_api(path_name: 'plans', # required
@@ -89,12 +93,13 @@ module RecurlyApi
     #                         cache_key_name: 'key123', # optional, defaults to method_name
     #                         bypass_caching: true, # optionals, default false
     #                         payload_name: 'list_all_plans', # optional defaults to caller method_name
-    #                         cache_expiry_in_secs: 180 # optional default 60
+    #                         cache_expiry_in: 300 # optional default 300
     #                         )
     # RestClient retry { https://blog.appsignal.com/2018/05/16/ensure-retry-and-reraise-exceptions-in-ruby.html }
-    # rubocop:disable Metrics/ParameterLists
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength
     def request_api(path_name:, http_method: :get, query_params: {},
                     payload: {}, additional_headers: {},
                     cache_key_name: nil, **optional_params)
@@ -110,7 +115,7 @@ module RecurlyApi
       # optional params ===>
       self.payload_name = optional_params[:payload_name] || 'payload'
       self.ignore_caching = optional_params[:bypass_caching] || ignore_caching
-      self.cache_expires_in = optional_params[:cache_expiry_in_secs] || cache_expires_in
+      self.cache_expires_in = optional_params[:cache_expires_in] || cache_expires_in
       # caller_method_name = caller_locations.first.label # Ruby 2.0 +
       caller_method_name = caller(1..1).first[/`(.*)'/, 1] # Prior Ruby 2.0
       self.cache_key = cache_key_name || caller_method_name # fallbacks to caller method if cache_key_name not present
@@ -179,5 +184,12 @@ module RecurlyApi
         error: json_body['error']['type'],
         message: json_body['error']['message'] }
     end
+
+    def handle_recurly_error_response(resp)
+      json_body = JSON.parse(resp.body)
+      return unless json_body['error']
+
+      handle_error_response(resp.code, json_body)
+    end
   end
 end

data/lib/recurly_api/client/accounts.rb

@@ -5,18 +5,21 @@ module RecurlyApi
   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+.
+    # @param ssor_id [String], Recurly Account Code(i.e SsorID)
+    #    - The unique identifier of the Recurly account
     def account_info(ssor_id:, **optional_params)
-      request_api(path_name: "accounts/#{ssor_id}", **optional_params) # cache_key_name: cache_key_name
+      # cache_key should be uniq for each account(here ssor_id is uniq)
+      # final cache key with prefix: tribune_recurly_api.account_info.<abcdef>
+      self.cache_key_name = "account_info.#{ssor_id}" unless bypass_caching?
+      request_api(path_name: "accounts/code-#{ssor_id}", **optional_params) # cache_key_name: cache_key_name
     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+.
+    # @param ssor_id [String], Recurly Account Code(i.e SsorID)
+    #    - The unique identifier of the Recurly account
     def deactivate_account(ssor_id:)
-      path = "accounts/#{ssor_id}"
+      path = "accounts/code-#{ssor_id}"
       request_api(path_name: path, http_method: :delete)
     end
   end

data/lib/recurly_api/client/other_requests.rb

@@ -8,7 +8,10 @@ module RecurlyApi
     # @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:, **optional_params)
-      request_api(path_name: "accounts/#{ssor_id}/coupon_redemptions", **optional_params)
+      # cache_key should be uniq for each account(here ssor_id is uniq)
+      # final cache key with prefix: tribune_recurly_api.coupon_redemptions.<abcdef>
+      self.cache_key_name = "coupon_redemptions.#{ssor_id}" unless bypass_caching?
+      request_api(path_name: "accounts/code-#{ssor_id}/coupon_redemptions", **optional_params)
     end
 
     # Other request any.....

data/lib/recurly_api/client/plans.rb

@@ -16,7 +16,7 @@ module RecurlyApi
     # @param optional_params [Hash] Optional, or any of below ( ref full usage example)
     #  :payload_name [Symbol] Optional, defaults to caller method_name
     #  :bypass_caching [Boolean] Optional, default value is false
-    #  :cache_expiry_in_secs [Integer] Optional, default value is 60 seconds
+    #  :cache_expires_in [Integer] Optional, default value is 300 seconds(5 minutes)
 
     # Examples:
     #  query_params = { limit: 2, order: :asc, ids: ['abc', 'def'..etc], :sort: <value>}
@@ -26,7 +26,8 @@ module RecurlyApi
 
     def list_plans(recurly_query_params: {}, **optional_params)
       # payload_name = optional_params[:payload_name] # if not present default value is :payload
-      cache_key_name = 'list_all_plans' # optional by default cache_key is caller method_name in receiver i.e. list_plans here
+      # cache_key_name = 'list_all_plans' # optional by default cache_key is caller method_name in receiver i.e. list_plans here
+      self.cache_expires_in = optional_params[:cache_expires_in] || cache_settings[:plan_expiry] unless bypass_caching?
       request_api(path_name: 'plans', query_params: recurly_query_params,
                   cache_key_name: cache_key_name, **optional_params)
     end
@@ -37,7 +38,11 @@ module RecurlyApi
     #    - For ID no prefix is used e.g. <e28zov4fw0v2>. For code use prefix <code->, ex. <code-gold>.
     # @param optional_params [Hash] Optional, same as above
     def plan_info(plan_id:, **optional_params)
-      request_api(path_name: "plans/#{plan_id}", **optional_params) # cache_key_name: cache_key_name
+      self.cache_expires_in = optional_params[:cache_expires_in] || cache_settings[:plan_expiry] unless bypass_caching?
+      # cache_key should be uniq for each plan(here plan_id is uniq)
+      # final cache key with prefix: tribune_recurly_api.plan_info.<abcdef>
+      self.cache_key_name = "plan_info.#{plan_id}" unless bypass_caching?
+      request_api(path_name: "plans/#{plan_id}", **optional_params)
     end
   end
 end

data/lib/recurly_api/client/subscriptions.rb

@@ -5,30 +5,35 @@ module RecurlyApi
   class Client
     # Fetch Account Subscriptions ---
     # { https://developers.recurly.com/api/v2021-02-25/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
-    #  for other params ref documentation
+    # @param ssor_id [String], Recurly Account Code(i.e SsorID)
+    #    - The unique identifier of the Recurly account
+    #  for other params refer documentation
     def account_subscriptions(ssor_id:, recurly_query_params: {}, **optional_params)
-      path = "accounts/#{ssor_id}/subscriptions"
-      request_api(path_name: path, query_params: recurly_query_params, **optional_params) # cache_key_name: cache_key_name
+      path = "accounts/code-#{ssor_id}/subscriptions"
+      self.cache_expires_in = optional_params[:cache_expires_in] || cache_settings[:subscription_expiry] unless bypass_caching?
+      # cache_key should be uniq for each account(here ssor_id is uniq)
+      # final cache key with prefix: tribune_recurly_api.account_subscriptions.<abcdef>
+      self.cache_key_name = "account_subscriptions.#{ssor_id}" unless bypass_caching?
+      request_api(path_name: path, query_params: recurly_query_params, **optional_params)
     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)
+    #   - The unique identifier of the Recurly account
     # @param 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 }
+    # response => { :success=>true, :status_code=>200, :has_subscription=>true }
     def check_user_subscription(ssor_id:, plan_code: nil)
-      resp = account_subscriptions(ssor_id: "code-#{ssor_id}")
+      query_params = { limit: 2 }
+      resp = account_subscriptions(ssor_id: ssor_id, recurly_query_params: query_params)
       if resp[:success]
         has_subscription = false
-        subs = resp[:data]
-        has_subscription = true if subs.any?
+        subs = resp[:payload]['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
@@ -51,6 +56,7 @@ module RecurlyApi
     # recurly_query_params = { limit: RECORDS_LIMIT, order: :asc, .....}
     # ex: client.site_subscriptions(params)
     def site_subscriptions(recurly_query_params: {}, **optional_params)
+      self.cache_expires_in = optional_params[:cache_expires_in] || cache_settings[:subscription_expiry] unless bypass_caching?
       request_api(path_name: 'subscriptions', query_params: recurly_query_params, **optional_params)
     end
 

data/lib/recurly_api/exception_handler.rb

@@ -10,21 +10,21 @@ module RecurlyApi
     rescue RestClient::Unauthorized, RestClient::Forbidden => e
       # https://www.rubydoc.info/gems/rest-client/1.6.7/frames#label-Result+handling
       logger.error("#{logger_heading} ERROR: Access denied to Recurly API")
-      raise e.response
+      handle_recurly_error_response(e.response)
     rescue RestClient::ImATeapot => e
       logger.error("#{logger_heading} ERROR: Recurly Server is a teapot! # RFC 2324")
-      raise e.response
+      handle_recurly_error_response(e.response)
     rescue RestClient::MovedPermanently,
         RestClient::Found,
         RestClient::TemporaryRedirect => e
       logger.error("#{logger_heading} ERROR: Follow redirection- #{e.response.follow_redirection}")
-      raise e.response
+      handle_recurly_error_response(e.response)
     rescue RestClient::ExceptionWithResponse => e
       logger.error("#{logger_heading} ERROR: RestClient::ExceptionWithResponse")
-      raise e.response
+      handle_recurly_error_response(e.response)
     rescue RestClient::Exception => e
       logger.error("#{logger_heading} ERROR: RestClient::Exception")
-      raise e.response
+      handle_recurly_error_response(e.response)
     # rescue StandardError => e # Note:  don't rescue standard error
     #   logger.error("#{logger_heading} ERROR: Internal Server Error")
     #   # e.backtrace.join("\n  ")

data/lib/recurly_api/version.rb

@@ -14,5 +14,8 @@ module RecurlyApi
   # def self.to_s
   #   STRING
   # end
-  VERSION = '1.0.0'
+  # VERSION = '1.0.1' # cache settings from configuration file
+  # VERSION = '1.0.2' # prefixing '<code->' to ssor_id is now part of GEM
+  # VERSION = '1.0.3' # return recurly error response
+  VERSION = '1.0.4' # cache key should be uniq
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tribune_recurly_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - udevulapally
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport