ORM Style Interface

Author: shawndeprey

lib/recurly.rb

@@ -10,6 +10,8 @@
 require "recurly/connection_pool"
 require "recurly/client"
 require "recurly/webhooks"
+require "recurly/config"
+require "recurly/models"
 
 module Recurly
   STRICT_MODE = ENV["RECURLY_STRICT_MODE"] && ENV["RECURLY_STRICT_MODE"].downcase == "true"

lib/recurly/config.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Configuration class for Recurly API client.
+  class Config
+    @@client = nil
+
+    def self.client=(val)
+      @@client = val
+    end
+
+    def self.api_key
+      ENV["RECURLY_API_KEY"]
+    end
+
+    def self.host
+      ENV["RECURLY_HOST"] || "v3.recurly.com"
+    end
+
+    def self.port
+      ENV["RECURLY_PORT"] || "443"
+    end
+
+    def self.region
+      ENV["RECURLY_REGION"]&.to_sym || :us
+    end
+
+    def self.debug?
+      ENV["RECURLY_DEBUG"].to_s.upcase == "TRUE"
+    end
+
+    def self.base_url
+      "https://#{host}:#{port}"
+    end
+
+    def self.ca_file
+      return unless host.end_with?(".recurly.dev")
+
+      @ca_file ||= begin
+          path = File.join(File.dirname(__FILE__), "../../../../", "certs/ca_root.crt")
+          File.exist?(path) ? path : (raise "CA file does not exist: #{path}")
+        end
+    end
+
+    def self.client
+      return @@client if @@client
+
+      opt = {
+        api_key: api_key,
+        logger: Logger.new(STDOUT).tap { |l| l.level = debug? ? Logger::DEBUG : Logger::INFO },
+        region: region,
+        base_url: base_url,
+      }
+      opt[:ca_file] = ca_file if ca_file
+      @client ||= Recurly::Client.new(**opt)
+    end
+  end
+end

lib/recurly/model.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Base model class for Recurly ORM Interface.
+  class Model
+    API_KEYS = %i[limit sort order begin_time end_time].freeze
+    attr_accessor :resource
+
+    def initialize(res)
+      @resource = res
+    end
+
+    def self.client
+      cli = Config.client
+      raise "API client is not configured" unless cli
+
+      cli
+    end
+
+    # Lookup methods which should be implemented in subclasses.
+    def self.list(params)
+      raise NotImplementedError, "The list method should be implemented in the subclass."
+    end
+
+    def self.get(id:)
+      raise NotImplementedError, "The get method should be implemented in the subclass."
+    end
+
+    # Lookup methods
+    def self.all
+      where
+    end
+
+    def self.where(query = query_params, *args)
+      if query.is_a?(String)
+        conditions = QueryParser.parse(query, *args)
+        api_params = {}
+        filter_params = []
+        conditions.each do |cond|
+          val = cond[:value].respond_to?(:iso8601) ? cond[:value].iso8601 : cond[:value]
+          if API_KEYS.include?(cond[:key].to_sym)
+            api_params[cond[:key].to_sym] = val
+          else
+            filter_params << cond.merge(value: val)
+          end
+        end
+        pager = list(params: api_params)
+        ModelPager.new(model_class: self, pager: pager, filters: filter_params)
+      else
+        api_params = (query || {}).select { |k, _| API_KEYS.include?(k) }
+        pager = list(params: api_params)
+        ModelPager.new(model_class: self, pager: pager)
+      end
+    end
+
+    def self.find_by(args = {})
+      args[:id] ? new(get(id: args[:id])) : nil
+    rescue Recurly::Errors::NotFoundError
+      nil
+    end
+
+    # Default query parameters for listing or searching models.
+    def self.query_params(args = nil)
+      params = { limit: 200 }
+      if args
+        params[:limit] = args[:limit] if args[:limit]
+        params[:sort] = args[:sort] if args[:sort]
+        params[:order] = args[:order] if args[:order]
+        params[:begin_time] = args[:begin_time].iso8601 if args[:begin_time]
+        params[:end_time] = args[:end_time].iso8601 if args[:end_time]
+      end
+      params
+    end
+
+    # Method delegation to the resource for all methods not defined in this or child classes.
+    def method_missing(method, *args, &block)
+      if @resource.respond_to?(method)
+        @resource.public_send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @resource.respond_to?(method, include_private) || super
+    end
+  end
+end

lib/recurly/model_filter.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Handles filtering logic for ModelPager
+  class ModelFilter
+    def initialize(filters)
+      @filters = filters
+    end
+
+    def include?(model)
+      return true if @filters.nil? || @filters.empty?
+
+      @filters.all? do |cond|
+        val = cond[:key].match(/\./) ? dig_value(model, cond[:key]) : model.public_send(cond[:key])
+        cmp_val = cond[:value]
+
+        val_parsed = try_parse(val)
+        cmp_parsed = try_parse(cmp_val)
+
+        case cond[:op]
+        when "="
+          val_parsed == cmp_parsed
+        when "!="
+          val_parsed != cmp_parsed
+        when ">", ">=", "<", "<="
+          return false if val_parsed.nil? || cmp_parsed.nil?
+
+          case cond[:op]
+          when ">"
+            val_parsed > cmp_parsed
+          when ">="
+            val_parsed >= cmp_parsed
+          when "<"
+            val_parsed < cmp_parsed
+          when "<="
+            val_parsed <= cmp_parsed
+          end
+        else
+          false
+        end
+      end
+    end
+
+    private
+
+    # Recursively dig through nested attributes and arrays
+    def dig_value(obj, key_chain)
+      keys = key_chain.to_s.split(".")
+      current = obj
+      keys.each do |key|
+        if current.is_a?(Array)
+          current = current.map { |el| dig_value(el, key) }.flatten.compact
+        elsif current.respond_to?(key)
+          current = current.public_send(key)
+        else
+          return nil
+        end
+      end
+      current.is_a?(Array) && current.size == 1 ? current.first : current
+    end
+
+    def try_parse(value)
+      begin
+        return DateTime.parse(value) if value.is_a?(String)
+      rescue ArgumentError;       end
+      begin
+        return Integer(value) if value.to_s.match(/\A-?\d+\z/)
+      rescue ArgumentError, TypeError;       end
+      begin
+        return Float(value) if value.to_s.match(/\A-?\d+(\.\d+)?\z/)
+      rescue ArgumentError, TypeError;       end
+      value
+    end
+  end
+end

lib/recurly/model_pager.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Pager extension for Recurly ORM Interface models, allowing iteration over model instances.
+  class ModelPager < Pager
+    include Enumerable
+
+    def initialize(model_class:, pager:, filters: [])
+      @model_class = model_class
+      @filter = ModelFilter.new(filters)
+      super(client: pager.client, path: pager.next, options: pager.instance_variable_get(:@options))
+    end
+
+    def each(&block)
+      super do |item|
+        model = @model_class.new(item)
+        block.call(model) if @filter.include?(model)
+      end
+    end
+
+    def each_page(&block)
+      super do |page|
+        transformed_page = page.each_with_object([]) do |item, result|
+          model = @model_class.new(item)
+          result << model if @filter.include?(model)
+        end
+        block.call(transformed_page) if block_given?
+      end
+    end
+  end
+end

lib/recurly/models.rb

@@ -0,0 +1,7 @@
+require_relative "query_parser"
+require_relative "model_pager"
+require_relative "model_filter"
+require_relative "model"
+Dir[File.join(__dir__, "models", "*.rb")].each do |file|
+  require file unless file.end_with?("model.rb")
+end

lib/recurly/models/account.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Represents an Account in Recurly
+  class Account < Recurly::Model
+    def self.list(params:)
+      client.list_accounts(params: params)
+    end
+
+    def self.get(id:)
+      client.get_account(account_id: id)
+    end
+  end
+end

lib/recurly/models/add_on.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Represents a AddOn in Recurly
+  class AddOn < Recurly::Model
+    def self.list(params:)
+      client.list_add_ons(params: params)
+    end
+
+    def self.get(id:)
+      client.get_add_on(add_on_id: id)
+    end
+  end
+end

lib/recurly/models/business_entity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Represents a BusinessEntity in Recurly
+  class BusinessEntity < Recurly::Model
+    def self.list(params:)
+      client.list_business_entities(params: params)
+    end
+
+    def self.get(id:)
+      client.get_business_entity(business_entity_id: id)
+    end
+  end
+end

lib/recurly/models/coupon.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Recurly
+  # Represents a Coupon in Recurly
+  class Coupon < Recurly::Model
+    def self.list(params:)
+      client.list_coupons(params: params)
+    end
+
+    def self.get(id:)
+      client.get_coupon(coupon_id: id)
+    end
+  end
+end