rvindi 0.0.3

data/lib/vindi/core_extensions/her_with_query_filter.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module CoreExtensions
+  # WARNING: monkey patch (https://github.com/remi/her/blob/master/lib/her/model/relation.rb#L34)
+  #
+  # The `where` clause must be adapted to vindi requirements:
+  # https://atendimento.vindi.com.br/hc/pt-br/articles/204163150
+  module HerWithQueryFilter
+    # Add a query string parameter
+    #
+    # @example
+    #   @users = User.where(contains: { name: 'Gandalf' })
+    #   # Fetched via GET "/users?query=name:Gandalf"
+    #
+    # @example
+    #   @users = User.active.where(gt: { created_at: Time.zone.yesterday })
+    #   # Fetched via GET "/users?query=status=active created_at>2021-01-01"
+    def where(params = {})
+      return self if params.blank? && !@_fetch.nil?
+
+      clone.tap do |r|
+        r.params = r.params.merge(params)
+
+        # Default params, as order and page number, will always be used.
+        default_params = extract_default_params r.params
+
+        # Query filters is joined into a single param called :query.
+        query = [r.params.delete(:query), params_to_query(r.params)].compact.join " "
+
+        r.params = { query: query }.merge(default_params)
+
+        r.clear_fetch_cache!
+      end
+    end
+
+    private
+
+    def extract_default_params(params)
+      page        = params.delete(:page)        || 1
+      per_page    = params.delete(:per_page)    || 25
+      sort_by     = params.delete(:sort_by)     || :created_at
+      sort_order  = params.delete(:sort_order)  || :desc
+
+      {
+        page: page,
+        per_page: per_page,
+        sort_by: sort_by,
+        sort_order: sort_order
+      }.delete_if { |_, v| v.nil? }
+    end
+
+    def params_to_query(params)
+      params.map do |key, value|
+        case key
+        when :contains  then value.map { |k, v| "#{k}:#{v}" }.last
+        when :gt        then value.map { |k, v| "#{k}>#{v}" }.last
+        when :gteq      then value.map { |k, v| "#{k}>=#{v}" }.last
+        when :lt        then value.map { |k, v| "#{k}<#{v}" }.last
+        when :lteq      then value.map { |k, v| "#{k}<=#{v}" }.last
+        when :not       then value.map { |k, v| "-#{k}:#{v}" }.last
+        else
+          value ? "#{key}=#{value}" : key
+        end
+      end.join(" ")
+    end
+  end
+end
+
+Her::Model::Relation.prepend CoreExtensions::HerWithQueryFilter

data/lib/vindi/middleware/rate_limit_validation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Vindi
+  module Middleware
+    # Saves the rate limts from Vindi responses.
+    class RateLimitValidation < Faraday::Middleware
+      def call(env)
+        raise Vindi::RateLimitError, "Rate limit reached" if rate_limit_reached?
+
+        @app.call(env)
+      end
+
+      private
+
+      def rate_limit_reached?
+        return false unless Vindi::RateLimit.rate_limit_limit
+
+        Vindi::RateLimit.rate_limit_limit <= Vindi::RateLimit.rate_limit_remaining &&
+          Vindi::RateLimit.rate_limit_reset > Time.now
+      end
+    end
+  end
+end

data/lib/vindi/middleware/response_parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Vindi
+  module Middleware
+    # Vindi Response Parser
+    #
+    # Saves metadata info into metadata object.
+    class ResponseParser < Faraday::Response::Middleware
+      def on_complete(env)
+        env[:body] = parse(env[:status] == 204 ? "{}" : env)
+
+        Vindi::RateLimit.update env[:body].dig :metadata, :rate_limit
+      end
+
+      def parse(env)
+        json = Her::Middleware::ParseJSON.new.parse_json env[:body]
+        errors = translate_errors_to_activemodel_style(json.delete(:errors) || [])
+        metadata = (json.delete(:metadata) || {}).merge(extract_response_headers_info(env[:response_headers]))
+
+        {
+          data: json,
+          errors: errors,
+          metadata: metadata
+        }
+      end
+
+      def translate_errors_to_activemodel_style(errors)
+        errors.map do |e|
+          {
+            attribute: e[:parameter],
+            type: e[:id] == "invalid_parameter" ? :invalid : e[:id],
+            message: e[:message]
+          }
+        end
+      end
+
+      def extract_response_headers_info(response_headers)
+        {
+          items: response_headers[:total],
+          link: response_headers[:link],
+          rate_limit: {
+            limit: response_headers[:"rate-limit-limit"],
+            reset: Time.at(response_headers[:"rate-limit-reset"].to_i),
+            remaining: response_headers[:"rate-limit-remaining"]
+          }
+        }
+      end
+    end
+  end
+end

data/lib/vindi/models/address.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Address
+  #
+  class Address < Model
+    belongs_to :customer
+  end
+end

data/lib/vindi/models/bill.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Bill
+  #
+  # @example
+  #
+  #   bill = Vindi::Bill.find(1)
+  #   bill.charges
+  #
+  # @example
+  #
+  #   subscription = Vindi::Subscription.find(1)
+  #   bills = subscription.bills
+  #
+  class Bill < Model
+    belongs_to :customer
+    belongs_to :period
+    belongs_to :subscription
+    belongs_to :payment_profile
+    # belongs_to :payment_condition
+
+    has_many :bill_items
+    has_many :charges
+  end
+end

data/lib/vindi/models/bill_item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Bill Item
+  #
+  # @example
+  #
+  #   bill = Vindi::Bill.find(1)
+  #   bill_items = bill.items
+  #
+  class BillItem < Model
+    belongs_to :product
+    belongs_to :product_item
+    belongs_to :discount
+
+    # has_many :usages
+  end
+end

data/lib/vindi/models/charge.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Bill Charges
+  #
+  class Charge < Model
+    belongs_to :bill
+  end
+end

data/lib/vindi/models/customer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "subscription"
+
+module Vindi
+  # Customers
+  #
+  # @example
+  #
+  #   customer = Vindi::Customer.find(1)
+  #   customer.subscriptions
+  #   customer.subscriptions.active
+  #
+  #   customer = Vindi::Customer.find_by(email: "gandalf@middleearth.com")
+  #   customer.name
+  #   customer.name = "Gandalf the White"
+  #   customer.save
+  #
+  class Customer < Model
+    scope :contains_name, ->(name) { where(contains: { name: name }) }
+
+    has_one :address, class_name: "Vindi::Address"
+    # has_many :subscriptions, class_name: "Vindi::Subscription", parent_as_param: true, group_params_with: :query
+
+    def subscriptions
+      Vindi::Subscription.where(customer_id: id)
+    end
+  end
+end

data/lib/vindi/models/discount.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Discounts
+  #
+  class Discount < Model
+  end
+end

data/lib/vindi/models/issue.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Issues
+  #
+  class Issue < Model
+  end
+end

data/lib/vindi/models/model.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Base model to vindi resources.
+  class Model
+    include Her::Model
+
+    # @example Active subscriptions
+    #   @subscriptions = Vindi::Subscription.active
+    #
+    scope :active,    -> { where(status: :active) }
+    scope :inactive,  -> { where(status: :inactive) }
+    scope :canceled,  -> { where(status: :canceled) }
+    scope :archived,  -> { where(status: :archived) }
+
+    # @example Active Customers paginated
+    #
+    #   @customers = Vindi::Customer.active.per_page(5).page(2)
+    #
+    scope :page,      ->(page) { where(page: page) }
+    scope :per_page,  ->(per_page) { where(per_page: per_page) }
+
+    # @example Active Customers ordered by name
+    #   @customers = Vindi::Customer.active.order_by(:name, :asc)
+    #
+    scope :order_by, ->(attr_name, order = :desc) { where(sort_by: attr_name, sort_order: order) }
+
+    parse_root_in_json true, format: :active_model_serializers
+
+    store_metadata :_metadata
+
+    # Archive a record.
+    #
+    # @example Archive a customer
+    #
+    #   Vindi::Customer.find_by(email: "sarumanthewhite@middlearth.io").archive!
+    #
+    def archive!
+      destroy
+    end
+
+    # @private
+    def valid?
+      super && response_errors.empty?
+    end
+
+    class << self
+      # @example First Customer
+      #   @customer = Vindi::Customer.first
+      #
+      # @example First two customers
+      #   @customers = Vindi::Customer.first(2)
+      #
+      def first(limit = 1)
+        records = order_by(:created_at, :asc).per_page(limit)
+
+        return records[0] if limit == 1
+
+        records
+      end
+
+      # @example Last customer
+      #   @customer = Vindi::Customer.last
+      #
+      # @example Last two customers
+      #   @customers = Vindi::Customer.last(2)
+      #
+      def last(limit = 1)
+        records = order_by(:created_at, :desc).per_page(limit)
+
+        return records[0] if limit == 1
+
+        records
+      end
+    end
+  end
+end

data/lib/vindi/models/notification.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Notifications
+  #
+  class Notitication < Model
+  end
+end

data/lib/vindi/models/payment_method.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Payment Methods
+  #
+  class PaymentMethod < Model
+  end
+end

data/lib/vindi/models/payment_profile.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Payment Profiles
+  #
+  class PaymentProfile < Model
+    belongs_to :customer
+  end
+end

data/lib/vindi/models/period.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Periods
+  #
+  class Period < Model
+  end
+end

data/lib/vindi/models/plan.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Plans
+  #
+  # @example List active plans
+  #
+  #   plans = Vindi::Plan.active
+  #
+  # @example Create a recurring plan
+  #
+  # plan = Vindi::Plan.new.tap do |p|
+  #   p.name = "Monthly Plan"
+  #   p.description = "This plan will be renewed every month in the same day"
+  #   p.period = "monthly"
+  #   p.recurring = true
+  #   p.code = 1
+  #   p.plan_items = [
+  #     {
+  #       cycles: nil,
+  #       product_id: 1
+  #     }
+  #   ]
+  # end
+  #
+  # @example Create an yearly plan with installments
+  #
+  # plan = Vindi::Plan.new.tap do |p|
+  #   p.name = "Yearly Plan"
+  #   p.description = "This plan will be paid in 12 installments"
+  #   p.period = "yearly"
+  #   p.billing_cycles = 1
+  #   p.installments = 12
+  #   p.code = 1
+  #   p.plan_items = [
+  #     {
+  #       cycles: nil,
+  #       product_id: 1
+  #     }
+  #   ]
+  # end
+  #
+  class Plan < Model
+    # has_many :plan_items
+    # has_many :products, through: :plan_items
+
+    scope :recurring, -> { where(billing_cycles: nil) }
+
+    after_initialize :set_defaults
+
+    def recurring=(value)
+      self.billing_cycles = value ? nil : 0
+    end
+
+    def period=(value)
+      raise "invalid period" unless %w[monthly quarterly biannually yearly].include? value.to_s
+
+      send "set_#{value}"
+    end
+
+    private
+
+    def set_defaults
+      self.billing_trigger_type = "beginning_of_period"
+      self.billing_trigger_day = 0
+      self.installments = 1
+      self.status = "active"
+    end
+
+    def set_monthly
+      self.interval = "months"
+      self.interval_count = 1
+    end
+
+    def set_quarterly
+      self.interval = "months"
+      self.interval_count = 3
+    end
+
+    def set_biannually
+      self.interval = "months"
+      self.interval_count = 6
+    end
+
+    def set_yearly
+      self.interval = "months"
+      self.interval_count = 12
+    end
+  end
+end

data/lib/vindi/models/plan_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Plan Items
+  #
+  class PlanItem < Model
+    belongs_to :plan
+
+    has_one :product
+  end
+end

data/lib/vindi/models/pricing_schema.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Pricing Schema
+  #
+  class PricingSchema < Model
+  end
+end

data/lib/vindi/models/product.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Products
+  #
+  # @example Active productts
+  #
+  #   products = Vindi::Product.active
+  #
+  # @example Create a product
+  #
+  #   palantir = Vindi::Product.new.tap do |p|
+  #     p.code = "palantir"
+  #     p.name = "Palantir"
+  #     p.description = "The Twitch of Istari folk"
+  #     p.pricing_schema = { price: 42.42 }
+  #     p.save
+  #   end
+  #
+  class Product < Model
+    belongs_to :pricing_schema
+
+    has_many :plans
+  end
+end

data/lib/vindi/models/product_item.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Product Items
+  #
+  class ProductItem < Model
+  end
+end

data/lib/vindi/models/subscription.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Customer Subscriptions
+  #
+  # @example Subscribe a customer to a plan
+  #
+  #   @subscription = Vindi::Subscription.new.tap do |s|
+  #     s.customer_id = customer.id
+  #     s.plan_id = plan.id
+  #     s.payment_method_code = "credit_card"
+  #     s.save
+  #   end
+  #
+  class Subscription < Model
+    belongs_to :customer
+    belongs_to :plan
+
+    attributes :plan_id, :customer_id, :payment_method_code
+
+    validates :plan_id, :customer_id, :payment_method_code, presence: true
+
+    scope :inactive, -> { canceled }
+
+    # @example Cancel a subscription
+    #
+    #   @subscription = Vindi::Customer.find(1).subscriptions.active.last
+    #   @subscription.cancel!
+    #
+    def cancel!
+      destroy
+    end
+
+    # @example Reactivate a subscription
+    #
+    #   @subscription = Vindi::Customer.find(1).subscriptions.inactive.last
+    #   @subscription.reactivate!
+    #
+    def reactivate!
+      # REVIEW: There's another way to do this using `custom_post` but the result breaks the normal
+      # flow because the API returns the root resource as singular name and HER expects to be a plural.
+
+      self.class.post_raw(:reactivate, id: id) do |parsed_data, _|
+        assign_attributes parsed_data[:data][self.class.collection_path.singularize.to_sym]
+      end
+    end
+  end
+end

data/lib/vindi/models/transaction.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vindi
+  # Transactitons
+  #
+  class Transactiton < Model
+  end
+end

data/lib/vindi/rate_limit.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Vindi
+  class RateLimitError < StandardError; end
+
+  # Vindi API calls has a rate limit.
+  class RateLimit
+    class << self
+      attr_accessor :rate_limit_limit, :rate_limit_remaining, :rate_limit_reset
+
+      def update(rate = {})
+        @rate_limit_limit     = rate[:limit].to_i
+        @rate_limit_remaining = rate[:remaining].to_i
+        @rate_limit_reset     = Time.at(rate[:reset].to_i)
+      end
+    end
+  end
+end

data/lib/vindi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vindi
+  VERSION = "0.0.3"
+end

data/lib/vindi.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "dry-configurable"
+
+require "faraday"
+require "faraday_middleware"
+require "her"
+
+require_relative "vindi/version"
+require_relative "vindi/rate_limit"
+
+require_relative "vindi/middleware/rate_limit_validation"
+require_relative "vindi/middleware/response_parser"
+
+require_relative "vindi/core_extensions/her_with_query_filter"
+require_relative "vindi/core_extensions/her_save_only_changed_attrs"
+
+module Vindi # :nodoc:
+  extend Dry::Configurable
+
+  class Error < StandardError; end
+
+  RESOURCE_MODELS = Dir[File.expand_path("vindi/models/**/*.rb", File.dirname(__FILE__))].freeze
+
+  RESOURCE_MODELS.each do |f|
+    autoload File.basename(f, ".rb").camelcase.to_sym, f
+  end
+
+  VINDI_API_URL = "https://app.vindi.com.br/api/v1"
+  VINDI_SANDBOX_API_URL = "https://sandbox-app.vindi.com.br/api/v1"
+
+  # Set sandbox to true in dev mode.
+  setting :sandbox, false
+  # Set the API KEY to assign the API calls.
+  setting :api_key
+  # Validates incoming Vindi Webhook calls with the given secret name.
+  setting :webhook_secret_name
+  # Validates incoming Vindi Webhook calls with the given secret password.
+  setting :webhook_secret_password
+
+  # @example
+  #   Vindi.configure do |config|
+  #     config.sandbox = true
+  #     config.api_key = "MY API KEY"
+  #     config.webhook_secret_name = "A SECRET NAMEE"
+  #     config.webhook_secret_password = "A SECRET PASSWORD"
+  #   end
+  #
+  def self.configure
+    super
+
+    her_setup
+  end
+
+  def self.api_url
+    return VINDI_SANDBOX_API_URL if config.sandbox
+
+    VINDI_API_URL
+  end
+
+  # @private
+  def self.her_setup
+    Her::API.setup url: Vindi.api_url do |conn|
+      conn.headers["User-Agent"] = "wedsonlima/rvindi #{Vindi::VERSION}"
+
+      conn.basic_auth config.api_key, ""
+
+      # Request
+      conn.use ::Vindi::Middleware::RateLimitValidation
+      conn.request :json
+
+      # Response
+      conn.response :json, content_type: /\bjson$/
+      conn.use ::Vindi::Middleware::ResponseParser
+
+      # Adapter
+      conn.adapter Faraday.default_adapter
+    end
+  end
+end