solidus_tec_estimator 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1078c9453d7e334bd19b7b09a11c491271420bb39c24a83ed645b217bd647d18
-  data.tar.gz: 95191b668cda00e855dbd41904b3bf884d7efc761d13f901e85b5e29e1413d6d
+  metadata.gz: e231ff08a8f0dcf8e7172c16b9b40204576b4fa7e609c9dc255f0c3d870f3b8c
+  data.tar.gz: d35235f464d741587aa212f67f11e73df04ebaf82254539714becfb9110fe0dc
 SHA512:
-  metadata.gz: 6e54b8db27c49e6330df33ce009b013e26eb37eb68a3e6a57dfc42d1177890d821df07a64c668fe319ee50be354f2c60b2f563292e7a34d99fcbb9731d8318a0
-  data.tar.gz: '09793f7e54a0bc6366da0aae9234fcca8cf77338c176967ec0fdc141ee5b527d94222e4d8d63f0cde52d273643f4534bd7dc7fbcca1224f12eec308bbcef6d14'
+  metadata.gz: 1d4593a8be735e4f38ca6e09d9984f17bcc30622dc01eb534da470c6282703e8e7f76bd8e3b2db5a1e6471d4e739131ca0b68bc26056d39e082812579307eae9
+  data.tar.gz: 72a94a36e01fbf611668749443737d0ef918887665002b7204e2c7154a24dc29ba111449bef46b9d1e15de128bd50878c705b746b85c998a3a967b49bd794926

data/README.md

@@ -1,17 +1,212 @@
-# Solidus Tec Estimator
+# SolidusTecEstimator
 
-<!-- Explain what your extension does. -->
+[![Gem Version](https://badge.fury.io/rb/solidus_tec_estimator.svg)](https://badge.fury.io/rb/solidus_tec_estimator)
 
-## Installation
+Uma extensão para Solidus que fornece um sistema flexível de estimativa de frete com suporte a múltiplos provedores de entrega.
 
-Add solidus_tec_estimator to your Gemfile:
+## Características
+
+- **Sistema de Provedores Plugável**: Arquitetura modular que permite adicionar facilmente novos provedores de entrega
+- **Entrega Local**: Provedor integrado para entrega local com estimativas de tempo em tempo real
+- **Interface Administrativa**: Interface web para gerenciar provedores de entrega
+- **Integração com Solidus Brazilian Adaptations**: Compatibilidade total com adaptações brasileiras do Solidus
+- **Cálculo Dinâmico de Frete**: Estimativas baseadas em peso, localização e disponibilidade de estoque
+- **Estimativas de Tempo de Entrega**: Cálculo automático de janelas de entrega baseado em horários comerciais
+
+## Instalação
+
+Adicione esta linha ao Gemfile da sua aplicação:
 
 ```ruby
 gem 'solidus_tec_estimator'
 ```
 
-Bundle your dependencies and run the installation generator:
+E execute:
+
+```bash
+$ bundle install
+```
+
+Ou instale diretamente:
+
+```bash
+$ gem install solidus_tec_estimator
+```
+
+### Configuração
+
+Execute o gerador de instalação:
+
+```bash
+$ rails generate solidus_tec_estimator:install
+```
+
+Execute as migrações:
+
+```bash
+$ rails db:migrate
+```
+
+### Configuração da Interface Administrativa
+
+Para acessar a interface administrativa dos provedores, você precisa adicionar uma aba na seção de shipping do painel administrativo do Solidus.
+
+Crie o arquivo `app/views/spree/admin/shared/_shipping_tabs.html.erb` no seu projeto (se não existir) copiando o conteúdo do [arquivo original do Solidus](https://github.com/solidusio/solidus/blob/main/backend/app/views/spree/admin/shared/_shipping_tabs.html.erb) e adicione o seguinte bloco:
+
+```erb
+<% if can?(:show, Spree::ShippingMethod) %>
+  <%= settings_tab_item "Providers", admin_solidus_tec_estimator_providers_path %>
+<% end %>
+```
+
+O arquivo completo deve ficar assim:
+
+```erb
+<% content_for :tabs do %>
+  <nav>
+    <ul class="tabs" data-hook="admin_settings_shipping_tabs">
+      <% if can?(:show, Spree::ShippingMethod) %>
+        <%= settings_tab_item plural_resource_name(Spree::ShippingMethod), spree.admin_shipping_methods_path %>
+      <% end %>
+
+      <% if can?(:show, Spree::ShippingCategory) %>
+        <%= settings_tab_item plural_resource_name(Spree::ShippingCategory), spree.admin_shipping_categories_path %>
+      <% end %>
+
+      <% if can?(:show, Spree::StockLocation) %>
+        <%= settings_tab_item plural_resource_name(Spree::StockLocation), spree.admin_stock_locations_path %>
+      <% end %>
+
+      <% if can?(:show, Spree::ShippingMethod) %>
+        <%= settings_tab_item "Providers", admin_solidus_tec_estimator_providers_path %>
+      <% end %>
+    </ul>
+  </nav>
+<% end %>
+```
+
+## Uso
+
+### Configuração Básica
+
+A gem estende o sistema de estimativa de frete do Solidus, permitindo que você use tanto os métodos de envio tradicionais quanto provedores personalizados.
+
+### Provedores de Entrega
+
+#### Criando um Novo Provedor
+
+Para criar um novo provedor de entrega, crie uma classe que implemente a interface do provedor:
+
+```ruby
+module SolidusTecEstimator
+  module Providers
+    class MeuProvedor
+      attr_accessor :package, :shipping_methods
+
+      def initialize(package, shipping_methods)
+        @package = package
+        @shipping_methods = shipping_methods
+      end
+
+      def self.install
+        # Lógica para instalar/configurar o método de envio
+        Spree::ShippingMethod.find_or_create_by(code: name.underscore) do |shipping_method|
+          shipping_method.name = "Meu Provedor"
+          shipping_method.carrier = "Transportadora Custom"
+          shipping_method.code = name.underscore
+          # ... outras configurações
+        end
+      end
+
+      def shipping_rates
+        # Retorna um array de Spree::ShippingRate
+        []
+      end
+    end
+  end
+end
+```
+
+#### Registrando um Provedor
+
+Para registrar um novo provedor:
+
+```ruby
+SolidusTecEstimator::Provider.create!(
+  name: "Meu Provedor",
+  class_name: "SolidusTecEstimator::Providers::MeuProvedor",
+  active: true
+)
+```
+
+### Provedor de Entrega Local
+
+A gem inclui um provedor de entrega local (`LocalDelivery`) que oferece:
+
+- Verificação de CEP para São João da Boa Vista
+- Validação de estoque na filial F1
+- Cálculo de tempo de entrega baseado em horários comerciais
+- Limite de peso de 50kg
+
+## Interface Administrativa
+
+Acesse a interface administrativa em:
+
+```
+/admin/solidus_tec_estimator/providers
+```
+
+Através desta interface você pode:
+
+- Visualizar todos os provedores cadastrados
+- Ativar/desativar provedores
+- Adicionar novos provedores
+- Editar configurações dos provedores
+
+## Estrutura do Projeto
 
-```shell
-bin/rails generate solidus_tec_estimator:install
 ```
+app/
+├── controllers/
+│   └── spree/admin/solidus_tec_estimator/
+│       └── providers_controller.rb      # Controller administrativo
+├── models/
+│   └── solidus_tec_estimator/
+│       ├── estimator.rb                 # Motor principal de estimativas
+│       ├── provider.rb                  # Model do provedor
+│       └── providers/
+│           └── local_delivery.rb        # Provedor de entrega local
+└── views/
+    └── spree/admin/solidus_tec_estimator/
+        └── providers/                   # Views administrativas
+```
+
+## Dependências
+
+- `solidus_brazilian_adaptations` - Adaptações brasileiras para Solidus
+- Rails 7.1+
+- Solidus
+
+## Como Funciona
+
+1. **Estimador Principal**: A classe `SolidusTecEstimator::Estimator` é responsável por coletar estimativas de todos os métodos de envio e provedores ativos.
+
+2. **Provedores**: Cada provedor implementa sua própria lógica de cálculo de frete e tempo de entrega.
+
+3. **Seleção Automática**: O sistema automaticamente seleciona uma opção padrão baseada na configuração do Solidus.
+
+4. **Filtragem**: Os métodos de envio são filtrados baseados em disponibilidade, localização e outros critérios.
+
+## Exemplo de Integração
+
+```ruby
+# No seu modelo de Order ou similar
+def shipping_rates_for_package(package)
+  estimator = SolidusTecEstimator::Estimator.new
+  estimator.shipping_rates(package)
+end
+```
+
+## Versão
+
+Versão atual: 2.1.2

data/lib/solidus_tec_estimator/version.rb

@@ -1,3 +1,3 @@
 module SolidusTecEstimator
-  VERSION = '2.1.2'
+  VERSION = '2.1.3'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: solidus_tec_estimator
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - ulysses
 bindir: bin
 cert_chain: []
-date: 2025-06-20 00:00:00.000000000 Z
+date: 2025-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_brazilian_adaptations