post_clerk 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2547bc9e7d5898e2d20e5a7216d0a20c731311c3
+  data.tar.gz: 8719f905321df84630e7aa5436bca8d18cb2b643
+SHA512:
+  metadata.gz: a2fd111ec8c4a03fa8635c3574d2a5ba6bd0d4a027ffc6d55445d70286a12be53b649f8326636645e9b109f64e1f74e9a09709652f29d9a488da06f9975bd3c8
+  data.tar.gz: 108a6308e74cc9d81cf8a13fe46204f517c886fbf1fd247540ca8edb43b1aaf01a61f097f27d02a1b92671ac3e4d2b3dee9813789914698f2370c5fdf818208b

data/.gitignore

@@ -0,0 +1,31 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org/'
+
+gem 'office_clerk', github: 'rubyclerks/office_clerk'
+
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+group :red_green_refactor, halt_on_fail: true do
+
+  guard 'rspec', cmd: 'bundle exec rspec' do
+    watch('spec/spec_helper.rb')    { 'spec' }
+    watch(%r{^spec/(.+)_spec\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^lib/(.+)\.rb$})       { |m| "spec/#{m[1]}_spec.rb" }
+  end
+
+  guard :rubocop, all_on_start: false, cli: ['--format', 'clang', '--rails'] do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.(rubocop|hound)\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2011-2014 Torsten Rüger, Tobias Bohwalli and other contributors. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,63 @@
+# Post Clerk
+
+A postal service is delivers based on weight only. Like most post services in Europe will.
+
+This extension adds a office_clerk/shipping_method model to do this.
+
+**Features:**
+
+- Weight restrictions can be specified.
+- You specify a weight/price table.
+- Handling fee may be added ( with a maximum when it won't be applied anymore).
+- Multi-parcel shipments are automatically created.
+- You can specify a maximum order price, orders over this will not be charged.
+
+Off course this relies on your weight data to be correct. Use the same measurements as in the product info page consistantly (either gram or kilogram).
+
+## Usage
+
+Add to your `Gemfile`:
+```ruby
+gem 'post_clerk', github: 'ruby_clerks_/post_clerk'
+```
+
+Add a config/locale/config.yml with the data for the calculator (s)
+
+
+---
+
+## Example
+
+With the default settings (measurements in kg and cm):
+
+- Max weight of one item: 18
+- Default weight: 1kg (applies when product weight is 0)
+- Handling fee: 0
+- Amount, over which handling fee won't be applied: 50
+- Max total of the order: 120.0
+- Weights (space separated): 1 2 5 10 20
+- Prices (space separated):  2 5 10 15 18
+
+
+The Shipping method does not apply to the order if any items weighs more than 18 kg.
+
+## Cost examples
+
+- Items weighing 10 kg of worth 100 Euros will cost 15 Euros.
+- Items weighing 10 kg of worth 40 Euros will cost 25 Euros (15 + 10 handling).
+- Items weighing less than 1 kg of worth 60 Euros will cost 6 Euros.
+- Items weighing less than 1 kg of worth 40 Euros will cost 16 Euros (6 + 10).
+- Items weighing 25 kg of worth 200 Euros will cost 30 Euros (2 packages, 18 + 12 Euro).
+- 3 items without weight information of worth 100 euros will cost 12 Euro.
+- Any amount of items costing more than the max_price will cost 0 Euro.
+
+---
+
+
+## License
+
+Copyright (c) 2011-2014 [Torsten Rüger][1], [Tobias Bohwalli][2] , released under the [MIT License][3].
+
+[1]: https://github.com/dancinglightning
+[2]: https://github.com/futhr
+[3]: https://github.com/ruby_clerks/post_clerk/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+require 'rspec/core/rake_task'
+require 'office_clerk/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'post_clerk'
+  Rake::Task['common:test_app'].invoke
+end

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/post_clerk/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+---
+en:
+  office_clerk:
+    price_table: Prices (space seperated)
+    weight_table: Weights (space seperated)
+    postal_service: Postal Service
+    max_item_weight: Max weight of one item
+    handling_fee: Handling fee
+    handling_max: "Amount, over which handling fee won't be applied"
+    min_price: Minimum price
+    default_weight: Default weight
+    max_price: Maximum price

data/lib/office_clerk/post.rb

@@ -0,0 +1,68 @@
+module OfficeClerk
+  class Post < ShippingMethod
+
+    DEFAULTS ={   :weight_table     => '1 2 5 10 20' , 
+                  :price_table      => '2 5 10 15 18' ,
+                  :max_item_weight  => "18" ,
+                  :max_price        => "120" ,
+                  :handling_max     => "20" ,
+                  :handling_fee     => "2" ,
+                  :default_weight   => "1" }
+                  
+    def initialize data
+      super DEFAULTS.merge(data)
+      @prices = @data[:price_table].split.map(&:to_f)
+      @weights = @data[:weight_table].split.map(&:to_f)
+      @max_item_weight = @data[:max_item_weight].to_f || 18.0
+      @max_price = @data[:max_price].to_f || 120.0
+      @handling_max = @data[:handling_max].to_f || 20.0
+      @handling_fee = @data[:handling_fee].to_f || 2.0
+      @default_weight = @data[:default_weight].to_f || 1.0
+      raise "Could not parse weights #{@data[:weight_table]} for #{key}" if @weights.empty? 
+      raise "Could not parse weights #{@data[:weight_table]} for #{key}" if @weights.include?(nil) 
+      raise "Could not parse prices #{@data[:price_table]} for #{key}" if @prices.empty?
+      raise "Could not parse prices #{@data[:price_table]} for #{key}" if @prices.include?(nil)
+    end
+    attr_reader :prices , :weights , :max_item_weight , :max_price , :handling_fee , :handling_max , :default_weight
+
+    # Determine if weight or size goes over bounds.
+    def available?(basket)
+      basket.items.each do |item|
+        if( weight = item.product.weight)
+          return false if weight > max_item_weight
+        end
+      end
+      true
+    end
+
+    def price_for(basket)
+      total_price = basket.total_price
+      return 0.0 if total_price > max_price
+
+      total_weight = basket.items.map {|item| item.quantity * (item.product.weight || default_weight) }.reduce(:+) || 0.0
+      shipping =  0
+
+      while total_weight > weights.last # In several packets if need be.
+        total_weight -= weights.last
+        shipping += prices.last
+      end
+
+      [shipping, prices[compute_index(total_weight)], calc_handling_fee(total_price)].compact.sum
+    end
+
+    private
+    
+    def compute_index(total_weight)
+      index = weights.length - 2
+      while index >= 0
+        break if total_weight > weights[index]
+        index -= 1
+      end
+      index + 1
+    end
+
+    def calc_handling_fee(total_price)
+      handling_max < total_price ? 0 : handling_fee
+    end
+  end
+end

data/lib/post_clerk.rb

@@ -0,0 +1,12 @@
+require 'office_clerk'
+module PostClerk
+  class Engine < Rails::Engine
+    engine_name 'post_clerk'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    initializer 'post_clerk' do |app|
+
+    end
+  end
+end

data/post_clerk.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.platform     = Gem::Platform::RUBY
+  s.name         = 'post_clerk'
+  s.version      = "0.4"
+  s.summary      = 'Calculate weight based charges for a OfficeClerk basket'
+  s.description  = s.summary
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.authors      = ['Torsten Rüger', 'Tobias Bohwalli']
+  s.email        = ['torsten@villataika.fi', 'hi@futhr.io']
+  s.homepage     = 'https://github.com/ruby_clerks/post_clerk'
+  s.license      = 'MIT'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.has_rdoc = false
+
+  s.add_runtime_dependency 'office_clerk', '~> 0.1'
+
+end

data/spec/lib/post_spec.rb

@@ -0,0 +1,115 @@
+RSpec.describe OfficeClerk::Post do
+
+  subject { described_class.new }
+
+  context 'returns description' do
+    %w(en fi).each do |locale|
+      it "in supported language: #{locale}" do
+        I18n.with_locale(locale.to_sym) do
+          expect(described_class.description).to eq I18n.t(:postal_service)
+        end
+      end
+    end
+  end
+
+  describe 'using the default weight-price table: [1 2 5 10 20] => [6 9 12 15 18]' do
+    context '.compute(package)' do
+      it 'gives 15.0 when total price is 100 and weight is 10kg' do
+        create_our_package(weight: 10.0, price: 100.0, quantity: 1)
+        result = subject.compute(@basket)
+        expect(result).to eq(15.0)
+      end
+
+      it 'gives 25.0 when total price is 40 and weight is 10kg' do
+        create_our_package(weight: 10.0, price: 40.0, quantity: 1)
+        result = subject.compute(@basket)
+        expect(result).to eq(25.0)
+      end
+
+      it 'gives 6 when total price is 60 and weight is less than 1kg' do
+        create_our_package(weight: 0.5, price: 60.0, quantity: 1)
+        result = subject.compute(@basket)
+        expect(result).to eq(6.0)
+      end
+
+      it 'gives 16 when total price is 40 and weight is less than 1kg' do
+        create_our_package(weight: 0.5, price: 40.0, quantity: 1)
+        result = subject.compute(@basket)
+        expect(result).to eq(16.0)
+      end
+
+      it 'gives 30 when total price is 200 and weight is 25kg (split into two)' do
+        create_our_package(weight: 25.0, price: 200.0, quantity: 1)
+        subject.preferred_max_price = 250
+        result = subject.compute(@basket)
+        expect(result).to eq(30.0)
+      end
+
+      it 'gives 12 when total price is 100, there are three items and their weight is unknown' do
+        order   = create(:order)
+        variant = create(:base_variant, weight: nil)
+        [30.0, 40.0, 30.0].each { |price| create_line_item(order, variant, price: price) }
+        order.line_items.reload
+        package = create(:shipment, order: order)
+        result  = subject.compute(package)
+        expect(result).to eq(12.0)
+      end
+
+      it 'gives 0 when total price is more than the MAX, for any number of items' do
+        create_our_package(weight: 25.0, price: 350.0, quantity: 1)
+        subject.preferred_max_price = 300
+        result = subject.compute(@basket)
+        expect(result).to eq(0.0)
+      end
+    end
+  end
+
+  describe 'when preferred max weight, length and width are 18 kg, 120 cm and 60 cm' do
+    context '.available?(package)' do
+      it 'is false when item weighs more than 18kg' do
+        create_our_package(weight: 20, height: 70, width: 30, depth: 30)
+        expect(subject.available?(@basket)).to be(false)
+      end
+
+      it 'is false when item is longer than 120cm' do
+        create_our_package(weight: 10, height: 130, width: 30, depth: 30)
+        expect(subject.available?(@basket)).to be(false)
+      end
+
+      it 'is false when item is wider than 60cm' do
+        create_our_package(weight: 10, height: 80, width: 70, depth: 30)
+        expect(subject.available?(@basket)).to be(false)
+      end
+    end
+
+    context '.item_oversized?(variant)' do
+      it 'is true if the longest side is more than 120cm' do
+        create_our_package(weight: 10, height: 130, width: 40, depth: 30)
+        expect(subject.item_oversized?(@variant)).to be(true)
+      end
+
+      it 'is true if the second longest side is more than 60cm' do
+        create_our_package(weight: 10, height: 80, width: 70, depth: 30)
+        expect(subject.item_oversized?(@variant)).to be(true)
+      end
+    end
+  end
+
+  def create_our_package(args = {})
+    @variant = create :base_variant, args.except!(:quantity)
+    order = create :order
+    create_line_item(order, @variant, args)
+    order.line_items.reload
+    @basket = create :shipment, order: order
+  end
+
+  def create_line_item(order, variant, args = {})
+    create(
+      :line_item,
+      price:    args[:price] || BigDecimal.new('10.00'),
+      quantity: args[:quantity] || 1,
+      order:    order,
+      variant:  variant
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/.bundle'
+  add_filter '/spec/'
+  add_filter '/lib/post_clerk/engine'
+  add_group 'Libraries', 'lib'
+end
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'pry'
+require 'ffaker'
+require 'rspec/rails'
+
+ActiveRecord::Migration.maintain_test_schema!
+ActiveRecord::Migration.check_pending!
+
+RSpec.configure do |config|
+
+  config.fail_fast = false
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.mock_with :rspec
+  config.raise_errors_for_deprecations!
+  config.infer_spec_type_from_file_location!
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |file| require file }

data/spec/support/database_cleaner.rb

@@ -0,0 +1,18 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,5 @@
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/i18n.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'i18n-spec'
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    I18n.locale = :en
+  end
+end

data/spec/translations/locale_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe 'locale:' do
+
+  Dir.glob('config/locales/*.yml') do |locale_file|
+    context locale_file do
+      it { is_expected.to be_parseable }
+      it { is_expected.to have_valid_pluralization_keys }
+      it { is_expected.not_to have_missing_pluralization_keys }
+      it { is_expected.to have_one_top_level_namespace }
+      it { is_expected.not_to have_legacy_interpolations }
+      it { is_expected.to have_a_valid_locale }
+      it { is_expected.to be_a_complete_translation_of 'config/locales/en.yml' }
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: post_clerk
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Torsten Rüger
+- Tobias Bohwalli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: office_clerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Calculate weight based charges for a OfficeClerk basket
+email:
+- torsten@villataika.fi
+- hi@futhr.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rails
+- config/locales/en.yml
+- lib/office_clerk/post.rb
+- lib/post_clerk.rb
+- post_clerk.gemspec
+- spec/lib/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+- spec/support/factory_girl.rb
+- spec/support/i18n.rb
+- spec/translations/locale_spec.rb
+homepage: https://github.com/ruby_clerks/post_clerk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Calculate weight based charges for a OfficeClerk basket
+test_files:
+- spec/lib/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+- spec/support/factory_girl.rb
+- spec/support/i18n.rb
+- spec/translations/locale_spec.rb