tribune_recurly_api 1.0.1 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da5718917f44aef31d9b80de00d8c0329c17c116144ea4e4c41d30597061c1a
-  data.tar.gz: 67dbddf046ce829454660f1e2d4ecbb5dc96c00ba48fd5a09f99fb745b7d435d
+  metadata.gz: 330e1d6e2d4a12cf9d767a5e3223e80bde8b4f7c31ddee9c6395eb062f36e7b4
+  data.tar.gz: 8e3c9f7293df1eb36de9dcf29f4a24f15c7d6833f5f24a74359f0f42d36c9375
 SHA512:
-  metadata.gz: d41f16026b8c2d42eaa8b2e66706bfb1e4434cb69950c5b70ef873a8db246db65a84a64db67a9fd89e2439b5c0b857abf051b93ae8e817c452f854adfef05d3a
-  data.tar.gz: 97c1da4a7194b7f2b254e792f0792b00e6e5a12721bae672fb34a5df658a413c8aa8111af44aaef04975e9221eb76bd99289fe4f9e37377ed7fc9696aaf65a91
+  metadata.gz: 2c082798d31feedaeb831c04f51f7c7dcec8035b5549cdee6d0de909ba1171516e65445a27c34ab89d9421f8642adc2669aea284e8adeddd0c08abdb4e3d1cb9
+  data.tar.gz: 032d4515cac6bb3b2c8e98573b9d4e4164472185f3691a67051fb2cc11e9a047a23eafb6a61c52aafeaef5f400ad40bd2dd7ac218e06843ee26446e98bf63e79

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/client/accounts.rb

@@ -5,18 +5,22 @@ 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>
+      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 ---
     # { 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,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/#{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,11 @@ 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
   end
 end

data/lib/recurly_api/client/subscriptions.rb

@@ -5,31 +5,36 @@ 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"
+      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
     # 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

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

@@ -14,5 +14,9 @@ module RecurlyApi
   # def self.to_s
   #   STRING
   # end
-  VERSION = '1.0.1' # cache settings from configuration file
+  # 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' # is yanked in rubygems.org
+  VERSION = '1.0.5' # cache key should be uniq
 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.1
+  version: 1.0.5
 platform: ruby
 authors:
 - udevulapally
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport