vindi-hermes 0.0.1

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "vindi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vindi.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+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"
+
+module Vindi
+  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
+
+  # Set sandbox to true in dev mode.
+  mattr_accessor :sandbox
+  @@sandbox = false
+
+  # Set the API KEY to assign the API calls.
+  mattr_accessor :api_key
+  @@api_key = false
+
+  # Validates incoming Vindi Webhook calls with the given secret name.
+  mattr_accessor :webhook_name
+  @@webhook_name = nil
+
+  # Validates incoming Vindi Webhook calls with the given secret password.
+  mattr_accessor :webhook_password
+  @@webhook_password = nil
+
+  VINDI_API_URL = "https://app.vindi.com.br/api/v1"
+  VINDI_SANDBOX_API_URL = "https://sandbox-app.vindi.com.br/api/v1"
+
+  def self.api_url
+    return VINDI_SANDBOX_API_URL if @@sandbox
+
+    VINDI_API_URL
+  end
+
+  # @example
+  #   Vindi.setup do |c|
+  #     c.sandbox = true
+  #     c.api_key = 'MY API KEY'
+  #   end
+  #
+  def self.config
+    yield self
+
+    her_setup
+  end
+
+  # @private
+  def self.her_setup
+    Her::API.setup url: Vindi.api_url do |conn|
+      conn.basic_auth Vindi.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

data/lib/vindi/core_extensions/her_with_query_filter.rb

@@ -0,0 +1,67 @@
+# 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|
+        default_params = extract_params params, r.params
+        query = params_to_query params, parse_query(r.params.fetch(:query, ""))
+
+        r.params = r.params.merge default_params.merge(query: query)
+        r.clear_fetch_cache!
+      end
+    end
+
+    private
+
+    def parse_query(query)
+      CGI.parse(query).transform_values(&:first)
+    end
+
+    def extract_params(new_ones, old_ones)
+      page        = new_ones.delete(:page)        || old_ones.delete(:page)       || 1
+      per_page    = new_ones.delete(:per_page)    || old_ones.delete(:per_page)   || 25
+      sort_by     = new_ones.delete(:sort_by)     || old_ones.delete(:sort_by)    || :created_at
+      sort_order  = new_ones.delete(:sort_order)  || old_ones.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, query)
+      params.merge(query).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
+
+# Saves the rate limts from Vindi responses.
+module Vindi
+  module Middleware
+    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
+    #
+    # Set metada info to 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,105 @@
+# 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 :archived,  -> { where(status: :archived) }
+    scope :canceled,  -> { where(status: :canceled) }
+
+    # @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
+
+    before_validation
+
+    # Validate record before save and after the request
+    # put the errors in the right places.
+    #
+    # @example A subscription without a customer
+    #
+    #   @subscription = Vindi::Subscription.new.tap do |s|
+    #     s.plan_id = plan.id
+    #     s.payment_method_code = "credit_card"
+    #     s.save
+    #   end
+    #
+    #   @subscription.errors.full_messages # ["Customer can't be blank"]
+    #
+    # @example A subscription with invalid plan
+    #
+    #   @subscription = Vindi::Subscription.new.tap do |s|
+    #     s.customer_id = customer.id
+    #     s.plan_id = 1
+    #     s.payment_method_code = "credit_card"
+    #     s.save
+    #   end
+    #
+    #   @subscription.errors.full_messages # ["Plan nao encontrado"]
+    #
+    def save
+      super
+
+      response_errors.any? && errors.clear && response_errors.each do |re|
+        errors.add re[:attribute], re[:type], message: re[:message]
+      end
+
+      return false if errors.any?
+
+      self
+    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