solidus_easypost 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd2fbbbe3195c88f863d4d2c4ed379f31a76a46d
-  data.tar.gz: c48efd0eab44b9dedc80d3ecbb3f616ee872c45a
+SHA256:
+  metadata.gz: d31b734374e49e27bb7f182577cd2f1693b716299d8419e0d9b9d456bdfe9d50
+  data.tar.gz: 603ca168bb0c4a460af1fa498c7b5448316e4986cb285b5fe9eb442f9a3fa11d
 SHA512:
-  metadata.gz: 533a53e70be4f0e6ab23325d2034e9fd1d0774b82f7e530b6c7bcad36feed79d47a147a485048e4f5ef925f18b7d3aa4ca61d83739a440fff10271406f1eda8b
-  data.tar.gz: 88b11c8f12232b88079117f71ba9cc5cf797903d12bfdd5448a1ee92c527049549f965099ab08382a6a605056a627a8ec77974852d585633eaf343dcbc266c60
+  metadata.gz: 3b0c53d359fd325783c1e4646cfd8a8f97c392ae5ddfcba384c79b05efcf755fa7ed8f06c62fac7bfea0dc41471243327f6e62c916ba463efe1dccccc625c36b
+  data.tar.gz: 21cd54816073d19859d1077002237ebf4b2c302f29e7fc3cc0e1d567ddc96a78ce69dcea6d461e207b46e67697d37a9f2f8d4f25b49f431fbc668e45a156efea

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_easypost/version.rb'
+  message: Bump SolidusEasypost to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - solidus_dev_support/rubocop

data/.rubocop_todo.yml

@@ -0,0 +1,71 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-07-24 11:17:48 +0200 using RuboCop version 0.76.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, AutoCorrect, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'app/decorators/models/solidus_easypost/spree/address_decorator.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'lib/generators/solidus_easypost/install/install_generator.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterFinalLet:
+  Exclude:
+    - 'spec/models/solidus_easypost/return_authorization_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 1
+RSpec/MultipleExpectations:
+  Max: 3
+
+# Offense count: 22
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/models/solidus_easypost/return_authorization_spec.rb'
+    - 'spec/models/spree/address_spec.rb'
+    - 'spec/models/spree/shipment_spec.rb'
+    - 'spec/models/spree/shipping_rate_spec.rb'
+    - 'spec/models/spree/stock/estimator_spec.rb'
+    - 'spec/models/spree/stock/package_spec.rb'
+    - 'spec/models/spree/stock_location_spec.rb'
+
+# Offense count: 4
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 2
+RSpec/ScatteredSetup:
+  Exclude:
+    - 'spec/models/solidus_easypost/return_authorization_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/models/spree/stock/estimator_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 137

data/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2020 Brendan Deere
+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 Solidus 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,104 @@
+# solidus_easypost
+
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_easypost.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_easypost)
+
+This is an extension to integrate EasyPost with Solidus.
+
+Due to how it works, you will not be able to use any other extension for shipping methods. Your own
+shipping methods will not work, either. But the good thing is that you won't have to worry about
+that, because EasyPost handles it all for you.
+
+You will need to [sign up for an account](https://www.easypost.com/) to use this extension.
+
+## Installation
+
+Add solidus_easypost to your Gemfile:
+
+```ruby
+gem 'solidus_easypost'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bin/rails generate solidus_easypost:install
+```
+
+Create an initializer at `config/initializers/solidus_easypost.rb`:
+
+```ruby
+EasyPost.api_key = 'YOUR_API_KEY_HERE'
+```
+
+## Usage
+
+This extension hijacks `Spree::Stock::Estimator#shipping_rates` to calculate shipping rates for your
+orders. This call happens during the checkout process, once the order's address information has been
+provided.
+
+The extension also adds a callback to the `ship` event on the `Spree::Shipment` model, telling
+EasyPost which rate was selected and "buying" that rate. This can be disabled by setting:
+
+```ruby
+# config/initializers/solidus_easypost.rb
+SolidusEasypost.configure do |config|
+  config.purchase_labels = false
+end
+```
+
+This gem will create shipping methods for each type of carrier/service for which it receives a rate
+from the EasyPost API. These are set to  `display_on: back_end` by default and must be set to
+`front_end` or `both` before the rate will be visible on the delivery page of the checkout.
+
+## Development
+
+### Testing the extension
+
+First bundle your dependencies, then run `bin/rake`. `bin/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
+`bin/rake extension:test_app`.
+
+```console
+$ bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```console
+$ bundle exec rubocop
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_easypost/factories'
+```
+
+### Running the sandbox
+
+To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
+the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
+`sandbox/bin/rails`.
+
+Here's an example:
+
+```console
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+### Releasing new versions
+
+Your new extension version can be released using `gem-release` like this:
+
+```console
+$ bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+```
+
+## License
+
+Copyright (c) 2020 Brendan Deere, released under the New BSD License.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'

data/app/decorators/models/solidus_easypost/spree/address_decorator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  module Spree
+    module AddressDecorator
+      def easypost_address
+        attributes = {
+          street1: address1,
+          street2: address2,
+          city: city,
+          zip: zipcode,
+          phone: phone
+        }
+
+        attributes[:company] = company if respond_to?(:company)
+        attributes[:name] = if respond_to?(:name)
+                              name
+                            elsif respond_to?(:full_name)
+                              full_name
+        end
+        attributes[:state] = state ? state.abbr : state_name
+        attributes[:country] = country&.iso
+
+        ::EasyPost::Address.create attributes
+      end
+
+      ::Spree::Address.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_easypost/spree/shipment_decorator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  module Spree
+    module ShipmentDecorator
+      def self.prepended(mod)
+        mod.state_machine.before_transition(
+          to: :shipped,
+          do: :buy_easypost_rate,
+          if: -> { SolidusEasypost.configuration.purchase_labels }
+        )
+      end
+
+      def easypost_shipment
+        if selected_easy_post_shipment_id
+          @ep_shipment ||= ::EasyPost::Shipment.retrieve(selected_easy_post_shipment_id)
+        else
+          @ep_shipment = build_easypost_shipment
+        end
+      end
+
+      private
+
+      def selected_easy_post_rate_id
+        selected_shipping_rate.easy_post_rate_id
+      end
+
+      def selected_easy_post_shipment_id
+        selected_shipping_rate.easy_post_shipment_id
+      end
+
+      def build_easypost_shipment
+        ::EasyPost::Shipment.create(
+          to_address: order.ship_address.easypost_address,
+          from_address: stock_location.easypost_address,
+          parcel: to_package.easypost_parcel
+        )
+      end
+
+      def buy_easypost_rate
+        rate = easypost_shipment.rates.find do |sr|
+          sr.id == selected_easy_post_rate_id
+        end
+
+        easypost_shipment.buy(rate)
+        self.tracking = easypost_shipment.tracking_code
+      end
+
+      ::Spree::Shipment.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_easypost/spree/shipping_rate_decorator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  module Spree
+    module ShippingRateDecorator
+      def name
+        read_attribute(:name) || super
+      end
+
+      ::Spree::ShippingRate.prepend self
+    end
+  end
+end