tribune_recurly_api 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58af8cbf779fe4fd7123c8721b9047742bfe3c5cf65e198d684cb1db47e69948
-  data.tar.gz: 5fc8b5e12bf3875fb0804c2832a13ed540680ac0c8c8a8be1c2414889155ff9b
+  metadata.gz: 428cd1714997ee102df9b99bc56183a720cd4666f1d552cf9105781dd1b460f3
+  data.tar.gz: 8067703da783c5903489b116b748522fedd2b685c77d66d1411658306b805855
 SHA512:
-  metadata.gz: b446b40811f68202554293ad18450eb81da9e36ce9e3a5a5f0282cb39bb8303f79c62766edb3a7e491c77567bc9c7e2665a8f07ad127b1a8a34effb8cf137ece
-  data.tar.gz: 461e45b651ffe4b3d8b31ba6d8d25b21f12b13ea2686316ad2925b5b16e60829604dc30ffc12c60c575c56e5ace61d5f07db2310001957700523a0a8b7e82a9c
+  metadata.gz: 57d171be31c09ebaf536e9d14934e2260c38cf22d6ceb034e3616dbeadf87f2036d040f85cd72622103a7d99ce70af78802deac349d766cda15cc2b9484e7561
+  data.tar.gz: b72b9e239cd6248761e52e59fbb4af4e14252e46f980c1a543f1cff6c1eab1b5a23ce3f650d8436814dd11b96f7f3dc6254d339e73b1da68216136fad6e5a15c

data/lib/recurly_api/caching.rb

@@ -53,12 +53,12 @@ module RecurlyApi
 
     # TODO: remove below method once integration testing is done
     def check_logs_for_caching_info
-      logger.info("#{logger_heading}: ----> caching_enabled?: #{caching_enabled?}")
-      # logger.info("#{logger_heading}: ----> ignore_caching?: #{ignore_caching?}")
-      logger.info("#{logger_heading}: ----> bypass_caching?: #{bypass_caching?}")
-      logger.info("#{logger_heading}: ----> http_method: #{http_method} -- #{http_method.class}")
-      logger.info("#{logger_heading}: ----> cache_expires_in: #{cache_expires_in}")
-      logger.info("#{logger_heading}: ----> cache_key: #{cache_key} -- #{cache_key.class}")
+      # logger.info("#{logger_heading}: ----> caching_enabled?: #{caching_enabled?}")
+      # # logger.info("#{logger_heading}: ----> ignore_caching?: #{ignore_caching?}")
+      # logger.info("#{logger_heading}: ----> bypass_caching?: #{bypass_caching?}")
+      # logger.info("#{logger_heading}: ----> http_method: #{http_method} -- #{http_method.class}")
+      # logger.info("#{logger_heading}: ----> cache_expires_in: #{cache_expires_in}")
+      # logger.info("#{logger_heading}: ----> cache_key: #{cache_key} -- #{cache_key.class}")
       # logger.info("#{logger_heading}: ----> final response: #{final_response || fetch_response_from_cache}")
       logger.info("#{logger_heading}: ----> ratelimit_retries: #{ratelimit_retries}")
     end

data/lib/recurly_api/client/accounts.rb

@@ -8,7 +8,11 @@ module RecurlyApi
     # @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/code-#{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>
+      cache_key_name = "account_info.#{ssor_id}"
+      request_api(path_name: "accounts/code-#{ssor_id}",
+                  cache_key_name: cache_key_name, **optional_params)
     end
 
     # Deactivate account ---

data/lib/recurly_api/client/other_requests.rb

@@ -8,7 +8,11 @@ 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/code-#{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>
+      cache_key_name = "coupon_redemptions.#{ssor_id}"
+      request_api(path_name: "accounts/code-#{ssor_id}/coupon_redemptions",
+                  cache_key_name: cache_key_name, **optional_params)
     end
 
     # Other request any.....

data/lib/recurly_api/client/plans.rb

@@ -28,8 +28,8 @@ module RecurlyApi
       # 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
       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)
+      # cache_key_name = 'all_plans' # for custom cache key pass as extra argument
+      request_api(path_name: 'plans', query_params: recurly_query_params, **optional_params)
     end
 
     # Fetch Plan Info--
@@ -39,7 +39,25 @@ module RecurlyApi
     # @param optional_params [Hash] Optional, same as above
     def plan_info(plan_id:, **optional_params)
       self.cache_expires_in = optional_params[:cache_expires_in] || cache_settings[:plan_expiry] unless bypass_caching?
-      request_api(path_name: "plans/#{plan_id}", **optional_params) # cache_key_name: cache_key_name
+      # cache_key should be uniq for each plan(here plan_id is uniq)
+      # final cache key with prefix: tribune_recurly_api.plan_info.<abcdef>
+      cache_key_name = "plan_info.#{plan_id}"
+      request_api(path_name: "plans/#{plan_id}",
+                  cache_key_name: cache_key_name, **optional_params)
+    end
+
+    # Fetch Plan Info--
+    # { https://developers.recurly.com/api/v2021-02-25/index.html#operation/list_plan_add_ons }
+    # @param plan_id [String] Required, Plan ID or code.
+    #    - 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_add_ons(plan_id:, **optional_params)
+      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>
+      cache_key_name = "plan_info.#{plan_id}.add_ons"
+      request_api(path_name: "plans/#{plan_id}/add_ons",
+                  cache_key_name: cache_key_name, **optional_params)
     end
   end
 end

data/lib/recurly_api/client/subscriptions.rb

@@ -11,7 +11,11 @@ module RecurlyApi
     def account_subscriptions(ssor_id:, recurly_query_params: {}, **optional_params)
       path = "accounts/code-#{ssor_id}/subscriptions"
       self.cache_expires_in = optional_params[:cache_expires_in] || cache_settings[:subscription_expiry] unless bypass_caching?
-      request_api(path_name: path, query_params: recurly_query_params, **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_subscriptions.<abcdef>
+      cache_key_name = "account_subscriptions.#{ssor_id}"
+      request_api(path_name: path, query_params: recurly_query_params,
+                  cache_key_name: cache_key_name, **optional_params)
     end
 
     # Checking if user already has subscription OR

data/lib/recurly_api/client.rb

@@ -184,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/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/logging.rb

@@ -1,33 +1,33 @@
-# frozen_string_literal: true
-
-# Logger for Gem
-module RecurlyApi
-  # fallback to STDOUT for non-rails project
-  module Logging
-    #  accessor setter method
-    attr_writer :logger
-
-    # Fallback to STDOUT logger for non-rails applications
-    # Usage examples to logging details in RecurlyApi:Client
-    # a. logger.info("I'm an info log")
-    # b. logger.warn("I'm a warn log")
-    # c. logger.error("I'm an error log: error message")
-    # d. logger.fatal("I'm a fatal log")
-    def logger
-      @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-    end
-
-    # Classical set method(instead used attr_writer)
-    # def logger=(logger)
-    #   @logger = logger
-    # end
-
-    def logger_heading
-      'tribune_recurly_api'
-    end
-
-    def logger_cache_heading
-      "#{logger_heading} CACHING"
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Logger for Gem
+module RecurlyApi
+  # fallback to STDOUT for non-rails project
+  module Logging
+    #  accessor setter method
+    attr_writer :logger
+
+    # Fallback to STDOUT logger for non-rails applications
+    # Usage examples to logging details in RecurlyApi:Client
+    # a. logger.info("I'm an info log")
+    # b. logger.warn("I'm a warn log")
+    # c. logger.error("I'm an error log: error message")
+    # d. logger.fatal("I'm a fatal log")
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    # Classical set method(instead used attr_writer)
+    # def logger=(logger)
+    #   @logger = logger
+    # end
+
+    def logger_heading
+      'tribune_recurly_api'
+    end
+
+    def logger_cache_heading
+      "#{logger_heading} CACHING"
+    end
+  end
+end

data/lib/recurly_api/version.rb

@@ -15,5 +15,9 @@ module RecurlyApi
   #   STRING
   # end
   # 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.2' # prefixing '<code->' to ssor_id is now part of GEM
+  # VERSION = '1.0.3' # return recurly error response
+  # VERSION = '1.0.4' # is yanked in rubygems.org
+  # VERSION = '1.0.5' # cache key should be uniq
+  VERSION = '1.0.6' # new api call to fetch plan add_ons
 end

data/lib/tribune_recurly_api.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tribune_recurly_api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - udevulapally
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport