solidus_shipstation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37cf9d9129cf565114ca4f4b83ffeea474d5d448e16400a93bc566b92f1344a2
+  data.tar.gz: 236d9df971bd47bac9c0bab46673f3c0e48dddf14f7110835609788554b42861
+SHA512:
+  metadata.gz: 8ca2d78aaaec9acbf0c28a38a85c73176613c131cae3888d5d63c285f0c94b04116a3a4a728e7639bf8e1b36540b8a87e8260dbd3ee33d081d355e308a3e27fe
+  data.tar.gz: c14094a306bf705b4289a7455a0818a34fe5b926e25fcb20a65f750891c3e554c5cfc468775cb6deaae2a550b68525a7ab533b1bae1164dd27c5fffa9ead0a11

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "12"

data/.circleci/config.yml

@@ -0,0 +1,41 @@
+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
+  lint-code:
+    executor: solidusio_extensions/sqlite-memory
+    steps:
+      - solidusio_extensions/lint-code
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+      - lint-code
+
+  "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_shipstation/version.rb'
+  message: Bump SolidusShipstation 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: false
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: stale
+# 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 might 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/.github_changelog_generator

@@ -0,0 +1,2 @@
+issues=false
+exclude-labels=infrastructure

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,13 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - solidus_dev_support/rubocop
+
+AllCops:
+  NewCops: disable
+
+Layout/LineLength:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,40 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-09-22 09:09:44 UTC using RuboCop version 0.87.1.
+# 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
+Lint/UselessAssignment:
+  Exclude:
+    - 'app/controllers/spree/shipstation_controller.rb'
+
+# Offense count: 1
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/lib/solidus_shipstation/shipment_notice_spec.rb'
+
+# Offense count: 5
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 8
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 6
+# Configuration parameters: ForbiddenMethods, AllowedMethods.
+# ForbiddenMethods: decrement!, decrement_counter, increment!, increment_counter, insert, insert!, insert_all, insert_all!, toggle!, touch, touch_all, update_all, update_attribute, update_column, update_columns, update_counters, upsert, upsert_all
+Rails/SkipsModelValidations:
+  Exclude:
+    - 'spec/lib/solidus_shipstation/shipment_notice_spec.rb'
+    - 'spec/models/spree/shipment_spec.rb'
+    - 'spec/support/shipment_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'spec/support/configuration_helper.rb'

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+## [v1.0.0](https://github.com/solidusio-contrib/solidus_shipstation/tree/v1.0.0) (2021-05-26)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_shipstation/compare/v2.0.1...v1.0.0)
+
+**Closed issues:**
+
+- Prepare Solidus Shipstation for Solidus 3.0 [\#6](https://github.com/solidusio-contrib/solidus_shipstation/issues/6)
+
+**Merged pull requests:**
+
+- Fix pending API sync query returning synced shipments [\#15](https://github.com/solidusio-contrib/solidus_shipstation/pull/15) ([aldesantis](https://github.com/aldesantis))
+- Swallow errors in `Api::SyncShipmentsJob` [\#14](https://github.com/solidusio-contrib/solidus_shipstation/pull/14) ([aldesantis](https://github.com/aldesantis))
+- API sync improvements [\#13](https://github.com/solidusio-contrib/solidus_shipstation/pull/13) ([aldesantis](https://github.com/aldesantis))
+- Error handling & configuration improvements [\#12](https://github.com/solidusio-contrib/solidus_shipstation/pull/12) ([aldesantis](https://github.com/aldesantis))
+- API integration [\#10](https://github.com/solidusio-contrib/solidus_shipstation/pull/10) ([aldesantis](https://github.com/aldesantis))
+- Deprecate Spree::Shipment decorators [\#9](https://github.com/solidusio-contrib/solidus_shipstation/pull/9) ([aldesantis](https://github.com/aldesantis))
+- Fix ShipmentNotice not handling double shipments [\#8](https://github.com/solidusio-contrib/solidus_shipstation/pull/8) ([aldesantis](https://github.com/aldesantis))
+- Update extension skeleton [\#7](https://github.com/solidusio-contrib/solidus_shipstation/pull/7) ([aldesantis](https://github.com/aldesantis))
+- Add configuration to export canceled shipments [\#4](https://github.com/solidusio-contrib/solidus_shipstation/pull/4) ([igorbp](https://github.com/igorbp))
+- Fix shipment tracking number not being propagated to carton [\#3](https://github.com/solidusio-contrib/solidus_shipstation/pull/3) ([aldesantis](https://github.com/aldesantis))
+- Fix installer [\#2](https://github.com/solidusio-contrib/solidus_shipstation/pull/2) ([kennyadsl](https://github.com/kennyadsl))
+- Make extension compatible with latest Solidus [\#1](https://github.com/solidusio-contrib/solidus_shipstation/pull/1) ([aldesantis](https://github.com/aldesantis))
+
+## [v2.0.1](https://github.com/solidusio-contrib/solidus_shipstation/tree/v2.0.1) (2014-05-01)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_shipstation/compare/v1.3.2...v2.0.1)
+
+## [v1.3.2](https://github.com/solidusio-contrib/solidus_shipstation/tree/v1.3.2) (2013-11-22)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_shipstation/compare/077ee0bcdf9faf66121faa4387ec645122892c98...v1.3.2)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

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) 2013 Boomer Digital
+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,208 @@
+# Solidus ShipStation
+
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_shipstation.svg?style=shield)](https://circleci.com/gh/solidusio-contrib/solidus_shipstation)
+[![codecov](https://codecov.io/gh/solidusio-contrib/solidus_shipstation/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio-contrib/solidus_shipstation)
+
+This gem integrates [ShipStation](http://www.shipstation.com) with [Solidus](http://solidus.io). It
+enables ShipStation to pull shipments from the system and update tracking numbers.
+
+This integration is a fork of [spree_shipstation](https://github.com/DynamoMTL/spree_shipstation)
+that adds Solidus and Rails 4.2+ compatibility.
+
+## Installation
+
+Add solidus_shipstation to your Gemfile:
+
+```ruby
+gem 'solidus_shipstation', github: 'solidusio-contrib/solidus_shipstation'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bin/rails generate solidus_shipstation:install
+```
+
+The installer will create a configuration initializer that you'll need to customize.
+
+The installer will also create a migration, which is required by the API integration. If you are
+going to use the XML integration, feel free to delete the migration file, as those columns won't be
+used by the extension.
+
+## Usage
+
+This extension can integrate with ShipStation in two ways.
+
+### XML integration
+
+The [XML integration](https://help.shipstation.com/hc/en-us/articles/360025856192-Custom-Store-Development-Guide)
+works by exposing a route in your Solidus application that generates an XML feed of all recently
+created and updated shipments in your Solidus store.
+
+#### XML integration: Configuration
+
+In order to enable the XML integration, make sure to configure the relevant section of the
+configuration initializer, and configure your ShipStation store accordingly:
+
+- **Username**: the username defined in your configuration.
+- **Password**: the password defined in your configuration.
+- **URL to custom page**: `https://yourdomain.com/shipstation.xml`.
+
+You can also configure your ShipStation store to pull the XML feed automatically on a recurring
+basis, or manually by clicking the "Refresh stores" button.
+
+There are five shipment states for an order (= shipment) in ShipStation. These states do not
+necessarily align with Solidus, but you can configure ShipStation to create a mapping for your
+specific needs. Here's the recommended mapping:
+
+ShipStation description | ShipStation status | Solidus status
+------------------------|--------------------|---------------
+Awaiting Payment        | `unpaid`           | `pending`
+Awaiting Shipment       | `paid`             | `ready`
+Shipped                 | `shipped`          | `shipped`
+Cancelled               | `cancelled`        | `cancelled`
+On-Hold                 | `on-hold`          | `pending`
+
+Once you've configured the XML integration in your app and ShipStation, there's nothing else you
+need to do. ShipStation will 
+
+#### XML integration: Usage
+
+There's nothing you need to do. Once properly configured, the integration just works!
+
+#### XML integration: Gotchas
+
+There are a few gotchas you need to be aware of:
+
+- If you change the shipping method of an order in ShipStation, the change will not be reflected in
+  Solidus and the tracking link might not work properly.
+- When `shipstation_capture_at_notification` is enabled, any errors during payment capture will
+  prevent the update of the shipment's tracking number.
+
+### API integration
+
+The [API integration](https://www.shipstation.com/docs/api/) works by calling the ShipStation API
+to sync all of your shipments continuously.
+
+Because ShipStation has very low rate limits (i.e., 40 reqs/minute at the time of writing), the
+API integration does not send an API request for every single shipment update, as you would expect
+from a traditional API integration.
+
+Instead, a background job runs on a recurring basis and batches together all the shipments that need
+to be created or updated in ShipStation. These shipments are then sent in groups of 100 (by default)
+to ShipStation's [bulk order upsert endpoint](https://www.shipstation.com/docs/api/orders/create-update-multiple-orders/).
+
+This allows us to work around ShipStation's rate limit and sync up to 4000 shipments/minute.
+
+As you may imagine, this technique also comes at the expense of some additional complexity in the
+implementation, but the extension abstracts it all away for you.
+
+#### API integration: Configuration
+
+In order to enable the API integration, make sure to configure the relevant section of the
+configuration initializer. At the very least, the integration needs to know your API credentials
+and store ID, but there are additional options you can configure — just look at the initializer!
+
+#### API integration: Usage
+
+Once you've configured the integration, you will also need to enqueue the `ScheduleShipmentSyncsJob`
+on a recurring basis, to kick off the synchronization process. Because every app uses a different
+background processing library, this is left up to the user.
+
+Here's what an example with [sidekiq-scheduler](https://github.com/moove-it/sidekiq-scheduler) might
+look like:
+
+```yaml
+# config/sidekiq.yml
+:schedule:
+  schedule_shipment_syncs:
+    every: ['1m', first_in: '0s']
+    class: 'SolidusShipstation::Api::ScheduleShipmentSyncsJob'
+```
+
+This will schedule the job to run every minute. This is generally a good starting point, but feel
+free to adjust it as needed.
+
+#### API integration: Gotchas
+
+There's one possible problem you need to be aware of, when integrating via the API.
+
+You should make sure the interval between your syncs is, on average, larger than your latency in
+processing background jobs, or you are going to experience sync overlaps.
+
+As an example, if it takes your Sidekiq process 10 seconds to execute a job from the time it's
+scheduled, but you schedule a shipment sync every 5 seconds, your sync jobs will start overlapping,
+making your latency even worse.
+
+This is a problem that is faced by all recurring jobs. The solution is two-fold:
+
+1. Monitor the latency of your background processing queues. Seriously, do it.
+2. Make sure your sync interval is not too aggressive: unless you really need to, there's no point
+   in syncing your shipments more often than once a minute.
+
+## 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`.
+
+```shell
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+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/spec_helper.rb`:
+
+```ruby
+require 'solidus_shipstation/testing_support/factories'
+```
+
+Or, if you are using `FactoryBot.definition_file_paths`, you can load Solidus core
+factories along with this extension's factories using this statement:
+
+```ruby
+SolidusDevSupport::TestingSupport::Factories.load_for(SolidusShipstation::Engine)
+```
+
+### 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:
+
+```
+$ 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
+```
+
+### Updating the changelog
+
+Before and after releases the changelog should be updated to reflect the up-to-date status of
+the project:
+
+```shell
+bin/rake changelog
+git add CHANGELOG.md
+git commit -m "Update the changelog"
+```
+
+### Releasing new versions
+
+Please refer to the dedicated [page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) on Solidus wiki.
+
+## License
+
+Copyright (c) 2013 Boomer Digital, released under the New BSD License.