spree_frenet 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85c827bf3050d87879c9ae638a92b6c4a4f8adbc6586fbebc8a5f2635801d85
-  data.tar.gz: ccfe15e2d2187b61aff12bd5b461f77850a94e33f449ad5b2222f64cfdeb8c50
+  metadata.gz: 6362f7a2e10af44a31452686d85ea317d3403ef4a7ea5a0855a8c40b7f8bf3b1
+  data.tar.gz: 9cbfece4679269fc17d96e866bbe92d66f0df5a07705d978985f7554e4c390a5
 SHA512:
-  metadata.gz: d2bd6f8d36448b94dcc85a9a5939a718c01be73ecbcd389f32be4b0c1da7e01b61ef84c0b6eb1b716d5780d50c213616eba679c9c070d63f22ec8d9b9d4952ea
-  data.tar.gz: 1580bd74b857016a4afc7f015d710b4123985e6667f4772a9378982137c0792bc8c9e001667ef3d5c78c30332f17f7cf69f5e0d28fc50748dfd3f2dfa8f92167
+  metadata.gz: 9794cc81f0f1c2d5ff93140616e51d5de01151161929ac0f1deb7a8007f7a2b844147448afd0e5cb118fa15b5be73b65fdda0231505994c3a8b5b288f1a63866
+  data.tar.gz: cc56a98e535da6e76e4421c2ab5b1f2bc2eb42c1d33d745ecaf649ba9ff2ec1cdfec447b2751fe0c061be3e7622e2b3ba7f2ec8a3214d3a96b9a9c1a706dcc89

data/.gitignore

@@ -0,0 +1,21 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+gemfiles/*.gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Appraisals'
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'lib/generators/**/*'
+
+Rails:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 150
+
+# DISABLED
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,31 @@
+sudo: required
+dist: trusty
+
+language: ruby
+
+env:
+  - DB=postgres
+  - DB=mysql
+
+gemfile:
+  - gemfiles/spree_3_1.gemfile
+  - gemfiles/spree_3_2.gemfile
+  - gemfiles/spree_3_3.gemfile
+  - gemfiles/spree_3_4.gemfile
+  - gemfiles/spree_master.gemfile
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rake spec
+
+rvm:
+  - 2.4.2
+  - 2.3.1
+  - 2.2.7
+
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/spree_master.gemfile
+
+before_install:
+  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"

data/Appraisals

@@ -0,0 +1,29 @@
+appraise 'spree-3-1' do
+  gem 'spree', '~> 3.1.0'
+  gem 'spree_auth_devise', '~> 3.1.0'
+  gem 'rails_test_params_backport', group: :test
+end
+
+appraise 'spree-3-2' do
+  gem 'spree', '~> 3.2.0'
+  gem 'spree_auth_devise', '~> 3.2.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-3-3' do
+  gem 'spree', '~> 3.3.0'
+  gem 'spree_auth_devise', '~> 3.3.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-3-4' do
+  gem 'spree', '~> 3.4.0'
+  gem 'spree_auth_devise', '~> 3.3.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-master' do
+  gem 'spree', github: 'spree/spree', branch: 'master'
+  gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+  gem 'rails-controller-testing'
+end

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'spree', github: 'spree/spree', branch: 'master'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+gem 'rails-controller-testing'
+
+gem 'rubocop', require: false
+gem 'rubocop-rspec', require: false
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2021 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,54 @@
+# SpreeFrenet
+
+Spree extension with custom calculators to quote shipments via Frenet
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+  ```ruby
+  gem 'spree_frenet'
+  ```
+
+2. Install the gem using Bundler:
+  ```ruby
+  bundle install
+  ```
+
+3. Add your Frenet token as an ENV variable
+  ```sh
+  export FRENET_TOKEN="your-token"
+  ```
+
+<!-- 3. Copy & run migrations
+  ```ruby
+  bundle exec rails g spree_frenet:install
+  ``` -->
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_frenet/factories'
+```
+
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.
+
+Copyright (c) 2021 [name of extension creator], released under the New BSD License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_frenet'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_frenet.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/spree_frenet.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_frenet.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/spree_frenet.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/models/spree/calculator/shipping/frenet/azul.rb

@@ -0,0 +1,11 @@
+require_dependency 'spree/calculator'
+
+module Spree::Calculator::Shipping::Frenet
+  class Azul < Spree::Calculator::Shipping::Frenet::Base
+    FRENET_SERVICE_CODE = 'AZUL_02'
+
+    def self.description
+      "Frenet - Azul Cargo"
+    end
+  end
+end

data/app/models/spree/calculator/shipping/frenet/base.rb

@@ -0,0 +1,32 @@
+require_dependency 'spree/calculator'
+
+module Spree::Calculator::Shipping::Frenet
+  class Base < Spree::ShippingCalculator
+
+    def compute(object = nil)
+      # Low level cache to avoid multiple calls since frenet returns all options in the first call
+      shipping_quotes = Rails.cache.fetch("#{object.order.number}/frenet_quotes", expires_in: 10.seconds) do
+        ::Frenet::Api.get_shipping_quote(object)
+      end
+      get_rate_for_shipping_method(shipping_quotes)
+    end
+
+    def get_rate_for_shipping_method(shipping_quotes)
+      availabe_services = shipping_quotes["ShippingSevicesArray"].reject { |service| service["Error"] == true }
+      quote_for_method = availabe_services.detect { |service| service["ServiceCode"] == shipping_method_service_code }
+      return nil unless quote_for_method
+      {
+        delivery_business_days: quote_for_method["DeliveryTime"],
+        delivery_transit_business_days: quote_for_method["DeliveryTime"],
+        estimated_carrier_price: quote_for_method["ShippingPrice"],
+        cost: quote_for_method["ShippingPrice"],
+      }
+    end
+
+    def shipping_method_service_code
+      # Constant defined on each shipping method calculator
+      self.class::FRENET_SERVICE_CODE
+    end
+
+  end
+end

data/app/models/spree/calculator/shipping/frenet/pac.rb

@@ -0,0 +1,11 @@
+require_dependency 'spree/calculator'
+
+module Spree::Calculator::Shipping::Frenet
+  class Pac < Spree::Calculator::Shipping::Frenet::Base
+    FRENET_SERVICE_CODE = '03298'
+
+    def self.description
+      "Frenet - Correios PAC"
+    end
+  end
+end

data/app/models/spree/calculator/shipping/frenet/pac_mini.rb

@@ -0,0 +1,11 @@
+require_dependency 'spree/calculator'
+
+module Spree::Calculator::Shipping::Frenet
+  class PacMini < Spree::Calculator::Shipping::Frenet::Base
+    FRENET_SERVICE_CODE = '04227'
+
+    def self.description
+      "Frenet - Correios PAC Mini Envios"
+    end
+  end
+end

data/app/models/spree/calculator/shipping/frenet/sedex.rb

@@ -0,0 +1,11 @@
+require_dependency 'spree/calculator'
+
+module Spree::Calculator::Shipping::Frenet
+  class Sedex < Spree::Calculator::Shipping::Frenet::Base
+    FRENET_SERVICE_CODE = '03220'
+
+    def self.description
+      "Frenet - Correios Sedex"
+    end
+  end
+end

data/app/services/frenet/api.rb

@@ -0,0 +1,24 @@
+class Frenet::Api
+  class << self
+    def get_shipping_quote(package)
+      body = {
+        "SellerCEP": package.stock_location.zipcode,
+        "RecipientCEP": package.order.ship_address.zipcode.gsub(/-/,""),
+        "ShipmentInvoiceValue": package.item_total,
+        "ShippingServiceCode": nil,
+        "ShippingItemArray": [
+          {
+            "Height": package.height,
+            "Length": package.depth,
+            "Width": package.width,
+            "Weight": package.weight,
+            "Quantity": 1
+          }
+        ],
+        "RecipientCountry": package.order.ship_address.country.iso
+      }
+
+      Frenet::Request.new.post("/shipping/quote", body)
+    end
+  end
+end

data/app/services/frenet/request.rb

@@ -0,0 +1,33 @@
+class Frenet::Request
+  def initialize; end
+
+  def get(path, body={})
+    response = request.get(path, body)
+    raise_error(response) unless response.success?
+    response.body
+  end
+
+  def post(path, body={})
+    response = request.post(path, body)
+    raise_error(response) unless response.success?
+    response.body
+  end
+
+  private
+
+  def request
+    @request ||= Faraday.new(url:"http://api.frenet.com.br") do |conn|
+      conn.request :json
+      conn.response :json
+      conn.adapter :net_http
+      conn.headers[:token] = ENV["FRENET_TOKEN"] ||  Rails.application.secrets.frenet_token
+    end
+  end
+
+  def raise_error(response)
+    puts "SPREE_FRENET: Request returned the following error"
+    puts "Status: #{response.status}\nBody: #{response.body}"
+    raise "Status: #{response.status}\nBody: #{response.body}"
+  end
+
+end

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" from the root of your extension
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_frenet/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.add_routes do
+  # Add your extension routes here
+end

data/lib/generators/spree_frenet/install/install_generator.rb

@@ -0,0 +1,30 @@
+module SpreeFrenet
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_frenet\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_frenet\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_frenet\n", before: %r{\*\/}, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_frenet\n", before: %r{\*\/}, verbose: true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_frenet'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_frenet.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_frenet/engine'
+require 'spree_frenet/version'

data/lib/spree_frenet/engine.rb

@@ -0,0 +1,35 @@
+module SpreeFrenet
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_frenet'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+
+    # Code to initializee calculators into Spree. It loads all calculators except base.rb
+    # Copied from Spree Active Shipping: https://github.com/spree-contrib/spree_active_shipping/blob/master/lib/spree_active_shipping/engine.rb#L30
+    initializer "spree_active_shipping.register.calculators", after: "spree.register.calculators" do |app|
+      if app.config.spree.calculators.shipping_methods
+        classes = Dir.chdir File.join(File.dirname(__FILE__), "../../app/models") do
+          Dir["spree/calculator/**/*.rb"].reject {|path| path =~ /base.rb$/ }.map do |path|
+            path.gsub('.rb', '').camelize.constantize
+          end
+        end
+
+        app.config.spree.calculators.shipping_methods.concat classes
+      end
+    end
+
+  end
+end

data/lib/spree_frenet/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_frenet/factories'
+end

data/lib/spree_frenet/version.rb

@@ -0,0 +1,17 @@
+module SpreeFrenet
+  module_function
+
+  # Returns the version of the currently loaded SpreeFrenet as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

data/spree_frenet.gemspec

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_frenet/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_frenet'
+  s.version     = SpreeFrenet.version
+  s.summary     = 'Shipping quotes using Frenet'
+  s.description = 'Spree extension with custom calculators to quote shipments via Frenet'
+  s.required_ruby_version = '>= 2.2.7'
+
+  s.author    = 'Lucas Kuhn'
+  s.email     = 'lucas@nordweg.com'
+  s.homepage  = 'https://github.com/nordweg/spree_frenet'
+  s.license = 'BSD-3-Clause'
+
+  s.files       = `git ls-files`.split("\n").reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  spree_version = '>= 3.1.0', '< 4.0'
+  s.add_dependency 'spree_core', spree_version
+  s.add_dependency 'spree_backend', spree_version
+  s.add_dependency 'spree_extension'
+
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'capybara-screenshot'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_bot'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'pg', '~> 0.18'
+  s.add_development_dependency 'simplecov'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_frenet
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lucas Kuhn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -265,7 +265,36 @@ email: lucas@nordweg.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/spree_frenet.js
+- app/assets/javascripts/spree/frontend/spree_frenet.js
+- app/assets/stylesheets/spree/backend/spree_frenet.css
+- app/assets/stylesheets/spree/frontend/spree_frenet.css
+- app/models/spree/calculator/shipping/frenet/azul.rb
+- app/models/spree/calculator/shipping/frenet/base.rb
+- app/models/spree/calculator/shipping/frenet/pac.rb
+- app/models/spree/calculator/shipping/frenet/pac_mini.rb
+- app/models/spree/calculator/shipping/frenet/sedex.rb
+- app/services/frenet/api.rb
+- app/services/frenet/request.rb
+- bin/rails
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/spree_frenet/install/install_generator.rb
+- lib/spree_frenet.rb
+- lib/spree_frenet/engine.rb
+- lib/spree_frenet/factories.rb
+- lib/spree_frenet/version.rb
+- spree_frenet.gemspec
 homepage: https://github.com/nordweg/spree_frenet
 licenses:
 - BSD-3-Clause