physical 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4af0a4a737e1d5585f7770e4f27a57c22ef2163f
+  data.tar.gz: b15c1709a756d83168bb2bd442922c5111dff5ab
+SHA512:
+  metadata.gz: d1e3b5f4546d845e6eee5b94872048c2daac05c9fbd14f410a9fa5ab938f14cfdd081331732e6aba0e5c929ed6e3171b24a955ada2ce2a98e2dc08d28f9c7ae8
+  data.tar.gz: 47352b147c34e80078e8eba73c381d2893813bb9867262c474285a63964fdbf812709ee933d3313b40d8dfbb16440461af0d0a0676bf2855bfea0d9349747870

data/.circleci/config.yml

@@ -0,0 +1,58 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "physical.gemspec" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,321 @@
+AllCops:
+  Exclude:
+    - Gemfile
+    - Rakefile
+    - bin/*
+    - vendor/**/*
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+CollectionMethods:
+  Enabled: false
+
+# Sometimes I believe this reads better
+# This also causes spacing issues on multi-line fixes
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# We use class vars and will have to continue doing so for compatability
+Style/ClassVars:
+  Enabled: false
+
+# We need these names for backwards compatability
+Naming/PredicateName:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+# This has been used for customization
+Style/MutableConstant:
+  Enabled: false
+
+# `something.count > 0` is often used in Solidus admin and IMO better to read then `something.count.positive?`
+Style/NumericPredicate:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Performance/Count:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# We can use good judgement here
+Style/RegexpLiteral:
+  Enabled: false
+
+# Unicode comments are useful
+Style/AsciiComments:
+  Enabled: false
+
+Layout/EndAlignment:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/AlignParameters:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/IndentArray:
+  Enabled: false
+
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Symbol Arrays are ok and the %i syntax widely unknown
+Style/SymbolArray:
+  Enabled: false
+
+Rails/DynamicFindBy:
+  Whitelist:
+    - find_by_param
+    - find_by_param!
+
+# We use a lot of
+#
+#     expect {
+#       something
+#     }.to { happen }
+#
+# syntax in the specs files.
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+# We use eval to add common_spree_dependencies into the Gemfiles of each of our gems
+Security/Eval:
+  Exclude:
+    - 'Gemfile'
+    - '*/Gemfile'
+
+Naming/VariableNumber:
+  Enabled: false
+
+# Write empty methods as you wish.
+Style/EmptyMethod:
+  Enabled: false
+
+# The Rails Guides are in contradiction with this cop.
+Style/FormatStringToken:
+  Exclude:
+    - 'config/routes.rb'
+
+# From http://relaxed.ruby.style/
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+  StyleGuide: http://relaxed.ruby.style/#styledotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: true
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Enabled: false
+  Max: 25
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mamhoff@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in physical.gemspec
+gemspec
+
+group :test do
+  gem 'rspec_junit_formatter'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Martin Meyerhoff
+
+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,90 @@
+# Physical
+
+This is a small library to describe Packages (that could, potentially, be mailed).
+
+A `Physical::Package` represents a package. It has and ID, dimensions, and a weight.
+
+The `Package` takes it's dimensions from its `container` object, usually a `Physical::Box`.
+It also has a `Set` of `Physical::Item`s that together make with the container make up everything
+about the Package.
+
+All things are thought to be cuboid: They have three dimensions, and a weight.
+
+The weight of a `Package` is the weight of it's container plus the weight of all items, plus the weight
+of any void fill.
+
+By default, the `Physical::Box` is infinitely large. In order to limit the size of the Box, simply give it
+dimensions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'physical'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install physical
+
+## Usage
+
+```ruby
+one_sku = Physical::Item.new(
+  id: '12345',
+  dimensions: [2, 4, 5],
+  dimension_unit: :inch,
+  weight: 1,
+  weight_unit: :kg
+)
+
+two_sku = Physical::Item.new(
+  id: "54321",
+  dimensions: [1, 1, 1],
+  dimension_unit: :cm,
+  weight: 2.3,
+  weight_unit: :g
+)
+
+my_carton = Physical::Box.new(
+  dimensions: [10, 15, 15],
+  dimension_unit: :cm,
+  weight: 0.8,
+  weight_unit: :lbs
+)
+
+package = Physical::Package.new(
+  id: "my_package",
+  container: my_carton,
+  items: [one_sku, two_sku],
+  void_fill_density: 0.007
+)
+
+package.weight
+=> #<Measured::Weight: 1376.32851808 #<Measured::Unit: g (gram, grams)>>
+
+package.remaining_volume
+=> #<Measured::Volume: 1593.51744 #<Measured::Unit: ml (milliliter, millilitre, milliliters, millilitres) 1/1000 l>>
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mamhoff/physical. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Physical project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/physical/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "physical"
+
+# 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/physical/box.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'measured'
+
+module Physical
+  class Box < Cuboid
+    DEFAULT_LENGTH = BigDecimal::INFINITY
+  end
+end

data/lib/physical/cuboid.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'measured'
+
+module Physical
+  class Cuboid
+    attr_reader :dimensions, :weight, :id
+
+    def initialize(id: nil, dimensions: [], dimension_unit: :cm, weight: 0, weight_unit: :g)
+      @id = id || SecureRandom.uuid
+      @weight = Measured::Weight(weight, weight_unit).convert_to(:g)
+      @dimensions = dimensions.map { |dimension| Measured::Length.new(dimension, dimension_unit).convert_to(:cm) }
+      @dimensions.fill(Measured::Length(self.class::DEFAULT_LENGTH, dimension_unit), @dimensions.length..2)
+    end
+
+    def volume
+      Measured::Volume(dimensions.map(&:value).reduce(&:*), :ml)
+    end
+
+    def ==(other)
+      id == other.id
+    end
+  end
+end

data/lib/physical/item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Physical
+  class Item < Cuboid
+    DEFAULT_LENGTH = 0
+
+    attr_reader :properties
+
+    def initialize(properties: {}, **args)
+      @properties = properties
+      super(args)
+    end
+  end
+end

data/lib/physical/location.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'carmen'
+
+module Physical
+  class Location
+    ADDRESS_TYPES = %w(residential commercial po_box)
+
+    attr_reader :country,
+                :zip,
+                :region,
+                :city,
+                :name,
+                :address1,
+                :address2,
+                :address3,
+                :phone,
+                :fax,
+                :email,
+                :address_type,
+                :company_name
+
+    def initialize(
+        name: nil,
+        company_name: nil,
+        address1: nil,
+        address2: nil,
+        address3: nil,
+        city: nil,
+        region: nil,
+        zip: nil,
+        country: nil,
+        phone: nil,
+        fax: nil,
+        email: nil,
+        address_type: nil
+      )
+
+      if country.is_a?(Carmen::Country)
+        @country = country
+      else
+        @country = Carmen::Country.coded(country.to_s)
+      end
+
+      if region.is_a?(Carmen::Region)
+        @region = region
+      elsif country.is_a?(Carmen::Country)
+        @region = country.subregions.coded(region.to_s.upcase)
+      end
+
+      @name = name
+      @company_name = company_name
+      @address1 = address1
+      @address2 = address2
+      @address3 = address3
+      @city = city
+      @zip = zip
+      @phone = phone
+      @fax = fax
+      @email = email
+      @address_type = address_type
+    end
+
+    def residential?
+      @address_type == 'residential'
+    end
+
+    def commercial?
+      @address_type == 'commercial'
+    end
+
+    def po_box?
+      @address_type == 'po_box'
+    end
+
+    def to_hash
+      {
+        country: country.code,
+        postal_code: zip,
+        province: province.code,
+        city: city,
+        name: name,
+        address1: address1,
+        address2: address2,
+        address3: address3,
+        phone: phone,
+        fax: fax,
+        email: email,
+        address_type: address_type,
+        company_name: company_name
+      }
+    end
+
+    def ==(other)
+      to_hash == other.to_hash
+    end
+  end
+end

data/lib/physical/package.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Physical
+  class Package
+    attr_reader :container, :items, :void_fill_density, :id
+
+    def initialize(id: nil, container: Physical::Box.new, items: [], void_fill_density: 0, void_fill_density_unit: :g)
+      @id = id || SecureRandom.uuid
+      @void_fill_density = Measured::Weight(void_fill_density, void_fill_density_unit)
+      @container = container
+      @items = Set[*items]
+    end
+
+    def <<(item)
+      @items.add(item)
+    end
+
+    def >>(item)
+      @items.delete(item)
+    end
+
+    def weight
+      container.weight + items.map(&:weight).reduce(&:+) + void_fill_weight
+    end
+
+    def remaining_volume
+      container.volume - items.map(&:volume).reduce(&:+)
+    end
+
+    def void_fill_weight
+      return Measured::Weight(0, :g) if container.volume.value.infinite?
+
+      Measured::Weight(void_fill_density.value * remaining_volume.value, void_fill_density.unit)
+    end
+  end
+end

data/lib/physical/shipment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Physical
+  class Shipment
+    attr_reader :id,
+                :origin,
+                :destination,
+                :shipping_method,
+                :packages,
+                :options
+
+    def initialize(id: nil, origin: nil, destination: nil, shipping_method: nil, packages: [], options: {})
+      @id = id || SecureRandom.uuid
+      @origin = origin
+      @destination = destination
+      @shipping_method = shipping_method
+      @packages = packages
+      @options = options
+    end
+  end
+end

data/lib/physical/spec_support/factories/box_factory.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+FactoryBot.define do
+  factory :physical_box, class: "Physical::Box" do
+    dimensions { [4, 5, 6] }
+    dimension_unit { :dm }
+    weight { 0.1 }
+    weight_unit { :kg }
+    initialize_with { new(attributes) }
+  end
+end

data/lib/physical/spec_support/factories/item_factory.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+FactoryBot.define do
+  factory :physical_item, class: "Physical::Item" do
+    dimensions { [1, 2, 3] }
+    dimension_unit { :cm }
+    weight { 50 }
+    weight_unit { :g }
+    initialize_with { new(attributes) }
+  end
+end

data/lib/physical/spec_support/factories/location_factory.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :physical_location, class: 'Physical::Location' do
+    transient do
+      country_code { 'US' }
+      region_code { 'IL' }
+    end
+
+    name { 'Jane Doe' }
+    company_name { 'Company' }
+    address1 { '11 Lovely Street' }
+    address2 { 'South' }
+    city { 'Herndon' }
+    sequence(:zip, 10001) { |i| i.to_s }
+    phone { '555-555-0199' }
+    region { country.subregions.coded(region_code) }
+    country { Carmen::Country.coded(country_code) }
+    initialize_with { new(attributes) }
+  end
+end

data/lib/physical/spec_support/factories/package_factory.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+FactoryBot.define do
+  factory :physical_package, class: "Physical::Package" do
+    container { FactoryBot.build(:physical_box) }
+    items { build_list(:physical_item, 2) }
+    void_fill_density { 0.01 }
+    initialize_with { new(attributes) }
+  end
+end

data/lib/physical/spec_support/factories/shipment_factory.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+FactoryBot.define do
+  factory :physical_shipment, class: "Physical::Shipment" do
+    origin { FactoryBot.build(:physical_location) }
+    destination { FactoryBot.build(:physical_location) }
+    packages { build_list(:physical_package, 2) }
+    shipping_method { "USPS Priority" }
+    initialize_with { new(attributes) }
+  end
+end

data/lib/physical/spec_support/factories.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'physical/spec_support/factories/item_factory'
+require 'physical/spec_support/factories/box_factory'
+require 'physical/spec_support/factories/package_factory'
+require 'physical/spec_support/factories/location_factory'
+require 'physical/spec_support/factories/shipment_factory'

data/lib/physical/version.rb

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

data/lib/physical.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "physical/version"
+require "physical/cuboid"
+require "physical/box"
+require "physical/package"
+require "physical/item"
+require "physical/location"
+require "physical/shipment"
+
+module Physical
+  # Your code goes here...
+end

data/physical.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "physical/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "physical"
+  spec.version       = Physical::VERSION
+  spec.authors       = ["Martin Meyerhoff"]
+  spec.email         = ["mamhoff@gmail.com"]
+
+  spec.summary       = "A facade to deal with physical packages"
+  spec.description   = "A package with boxes and items"
+  spec.homepage      = "https://github.com/mamhoff/physical"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec)/})
+  end
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.4'
+  spec.add_runtime_dependency "carmen", "~> 1.0"
+  spec.add_runtime_dependency "factory_bot", "~> 4.8 "
+  spec.add_runtime_dependency "measured", "~> 2.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: physical
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Meyerhoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carmen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: measured
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A package with boxes and items
+email:
+- mamhoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/physical.rb
+- lib/physical/box.rb
+- lib/physical/cuboid.rb
+- lib/physical/item.rb
+- lib/physical/location.rb
+- lib/physical/package.rb
+- lib/physical/shipment.rb
+- lib/physical/spec_support/factories.rb
+- lib/physical/spec_support/factories/box_factory.rb
+- lib/physical/spec_support/factories/item_factory.rb
+- lib/physical/spec_support/factories/location_factory.rb
+- lib/physical/spec_support/factories/package_factory.rb
+- lib/physical/spec_support/factories/shipment_factory.rb
+- lib/physical/version.rb
+- physical.gemspec
+homepage: https://github.com/mamhoff/physical
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: A facade to deal with physical packages
+test_files: []