workarea-gift_cards 3.4.6

data/CHANGELOG.md

@@ -0,0 +1,485 @@
+Workarea Gift Cards 3.4.6 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Gift Cards 3.4.5 (2019-03-05)
+--------------------------------------------------------------------------------
+
+*   Create Gift Cards For Order When Creating Fulfillment
+
+    Workarea previously enqueued the `Workarea::CreateOrderedGiftCards`
+    worker when an order was placed, but this caused an error if the job was
+    executed prior to the fulfillment being persisted. This job will now
+    enqueue after creating a new `Workarea::Fulfillment` record, ensuring
+    that the data the worker needs is in place before it runs.
+
+    GIFTCARDS-122
+    Tom Scott
+
+*   Fix Gift Cards Overwriting "To:" Field Translation
+
+    Installing the gift cards plugin previously overrode the base
+    `workarea.admin.fields.to` translation with "Recipient: ".
+    This translation is now named to `workarea.admin.fields.recipient`,
+    in order to preserve the text of `workarea.admin.fields.to` for other
+    uses in the admin.
+
+    GIFTCARDS-126
+    Tom Scott
+
+*   Add product-details__heading class for direct styling hook
+
+    ECOMMERCE-6363
+    Curt Howard
+
+
+
+Workarea Gift Cards 3.4.4 (2019-02-05)
+--------------------------------------------------------------------------------
+
+*   Update for workarea v3.4 compatibility
+
+    GIFTCARDS-123
+    Matt Duffy
+
+
+
+Workarea Gift Cards 3.4.3 (2019-01-22)
+--------------------------------------------------------------------------------
+
+*   Add #scroll to AdminRedemptionExport class to support large exports
+
+    Matt Duffy
+
+*   Incorrect Gift Card Timeline Link URL
+
+    The URL to the gift card on the timeline when created is not correct,
+    seems to be a bad copy/paste from the products. This link is now
+    correctly pointing to the gift card's payment page, not a product page
+    that doesn't exist.
+
+    GIFTCARDS-104
+    Tom Scott
+
+
+
+Workarea Gift Cards 3.4.2 (2019-01-08)
+--------------------------------------------------------------------------------
+
+*   Update README
+
+    GIFTCARDS-121
+    Matt Duffy
+
+
+
+Workarea Gift Cards 3.4.1 (2018-09-05)
+--------------------------------------------------------------------------------
+
+*   Gift Card Balance Can Equal Tendered Amount
+
+    When a gift card is in use on an order, Workarea did not detect that it
+    would cover the order total if the balance of the gift card was equal
+    to the tendered amount. Change the `>` to a `>=` to ensure that gift
+    cards with the exact amount as the order total will still be accounted
+    for in checkout.
+
+    GIFTCARDS-119
+    Tom Scott
+
+
+
+Workarea Gift Cards 3.4.0 (2018-05-24)
+--------------------------------------------------------------------------------
+
+*   Support Bulk Action Items UI
+
+    ECOMMERCE-6012
+    Curt Howard
+
+*   Update exporting to work with v3.3.0 DataFile::Export
+
+    GIFTCARDS-117
+    Matt Duffy
+
+*   Leverage Workarea Changelog task
+
+    ECOMMERCE-5355
+    Curt Howard
+
+*   Update Mailers for Premailer
+
+    GIFTCARDS-116
+    Curt Howard
+
+*   Make Gift Card an optional field
+
+    GIFTCARDS-115
+    Curt Howard
+
+
+
+Workarea Gift Cards 3.3.0 (2018-02-06)
+--------------------------------------------------------------------------------
+
+*   Supportive updates for v3.2 Order Summary changes
+
+    GIFTCARDS-113
+    Curt Howard
+
+*   Include shipping in pricing request
+
+    When re-pricing the order to apply gift card deductions, pass the
+    `Shipping` for this corresponding `Order` so that setting the gift card
+    tender amount factors in the shipping total along with the items
+    subtotal.
+
+    GIFTCARDS-94
+    Tom Scott
+
+*   Convert index cards into table
+
+    GIFTCARDS-110
+    Curt Howard
+
+
+Workarea Gift Cards 3.2.1 (2017-10-31)
+--------------------------------------------------------------------------------
+
+*   Prevent errors when API isn't installed
+
+    Add condition to documentation test to check for API before requiring documentation test
+
+    GIFTCARDS-111
+    Jake Beresford
+
+
+Workarea Gift Cards 3.2.0 (2017-10-17)
+--------------------------------------------------------------------------------
+
+*   Add crud endpoints for payment gift cards in admin api
+
+    GIFTCARDS-109
+    Francisco Galarza
+
+Workarea Gift Cards 3.1.0 (2017-09-15)
+--------------------------------------------------------------------------------
+
+*   Rework gift card fulfillment tie in
+
+    GIFTCARDS-106
+    Matt Duffy
+
+*   Update order fulfillment upon creation of Payment::GiftCard
+
+    GIFTCARDS-106
+    Matt Duffy
+
+*   Add storefront API support (if it's installed)
+
+    Includes endpoints for checking gift card balance, paying with a gift
+    card, and tender display support.
+
+    GIFTCARDS-102
+    Ben Crouse
+
+*   Update activity for trash restore link helper
+
+    GIFTCARDS-101
+    Matt Duffy
+
+*   Add restore link to gift card admin activity
+
+    GIFTCARDS-101
+    Matt Duffy
+
+*   Add jump to navigation config to plugin
+
+    GIFTCARDS-100
+    Dave Barnow
+
+
+Workarea Gift Cards 3.0.2 (2017-08-22)
+--------------------------------------------------------------------------------
+
+*   Use token for gift card name on activity after card is deleted
+
+    GIFTCARDS-103
+    Matt Duffy
+
+
+Workarea Gift Cards 3.0.1 (2017-07-25)
+--------------------------------------------------------------------------------
+
+*   Add jump to navigation config to plugin
+
+    GIFTCARDS-100
+    Dave Barnow
+
+
+Workarea Gift Cards 3.0.0 (2017-05-26)
+--------------------------------------------------------------------------------
+
+*   Update for v3 compatibility
+
+    GIFTCARDS-95
+    Matt Duffy
+
+
+WebLinc Gift Cards 2.1.1 (2017-03-01)
+--------------------------------------------------------------------------------
+
+*   Update giftcard mailer translation to render link correctly when passed as html
+
+    GIFTCARDS-91
+    Beresford, Jake
+
+*   Add a maler preview for gift cards mailer.
+
+    GIFTCARDS-90
+    Beresford, Jake
+
+
+WebLinc Gift Cards 2.1.0 (2016-10-12)
+--------------------------------------------------------------------------------
+
+*   Add activity support for v2.3
+
+    GIFTCARDS-88
+    Ben Crouse
+
+*   Update product-prices markup to match generic
+
+    Clean up call to pricing partial
+
+    GIFTCARDS-84
+    Kristen Ward
+
+
+WebLinc Gift Cards 2.0.4 (2016-07-06)
+--------------------------------------------------------------------------------
+
+*   Update product-prices markup to match generic
+
+    Clean up call to pricing partial
+
+    GIFTCARDS-84
+    Kristen Ward
+
+
+WebLinc Gift Cards 2.0.3 (2016-04-26)
+--------------------------------------------------------------------------------
+
+*   Add reset results button to gift card redemptions page
+
+    After applying date filters, there is no quick way to reset them.
+    Add action button consistent with other admin pages.
+
+    GIFTCARDS-78
+    Kristen Ward
+
+
+WebLinc Gift Cards 2.0.2 (2016-04-04)
+--------------------------------------------------------------------------------
+
+
+WebLinc Gift Cards 2.0.1 (2016-03-22)
+--------------------------------------------------------------------------------
+
+*   Ensure credit card is not added to payment if not necessary
+
+    GIFTCARDS-73
+    Matt Duffy
+
+
+
+WebLinc Gift Cards 2.0.0 (January 26, 2016)
+--------------------------------------------------------------------------------
+
+*   Update add to cart form to use drawer, add analytics
+
+    GIFTCARDS-79
+
+*   Rename tender-related Gift Card methods
+
+    Resolve a conflict between methods around order pricing during
+    checkout and final amounts displayed on order summaries wihtin the
+    store front.
+
+    GIFTCARDS-77
+
+
+WebLinc Gift Cards 1.0.0 (January 14, 2016)
+--------------------------------------------------------------------------------
+
+*   Improve misleading verbiage in checkout messaging
+
+    The balance indicates current balance, not balance after the order
+    has been placed.
+
+    GIFTCARDS-76
+
+*   Update date range pickers to current
+
+    Replace in gift card and redemption index
+
+    Update start/end date search parameters to be consistent with base
+
+    Update tests
+
+    GIFTCARDS-75
+
+*   Add form submitting control to has balance dropdown
+
+    GIFTCARDS-75
+
+*   Update for compatibility with WebLinc 2.0
+
+*   Replace absolute URLs with relative paths
+
+
+WebLinc Gift Cards 0.11.0 (October 6, 2015)
+--------------------------------------------------------------------------------
+
+*   Add metadata to the edit view
+
+    GIFTCARDS-69
+
+*   Update plugin to be compatible with v0.12
+
+    Update new & edit views, property work
+    Add blank row to permissions partial
+    Update indexes, add context-menu to summary/edit
+
+    GIFTCARDS-69
+
+*   Fix typo in sort menu options
+
+    s/Redeeed/Redeemed in app/models/workarea/payment/gift_card/redemption.rb
+
+    GIFTCARDS-72
+
+*   Update plugin to be compatible with v0.12
+
+    Update new & edit views, property work
+    Add blank row to permissions partial
+    Update indexes, add context-menu to summary/edit
+
+    GIFTCARDS-69
+
+*   Update menu classes for compatibility with WebLinc v0.12 (ECOMMERCE-1344)
+
+    GIFTCARDS-64
+
+*   Update for compatibility with the WebLinc v0.12 Ruby API.
+
+    ECOMMERCE-1543
+
+
+WebLinc Gift Cards 0.10.0 (August 21, 2015)
+--------------------------------------------------------------------------------
+
+*   Rename SCSS blocks `panel` and `panel--buttons` to `index-filters` and
+    `form-actions`, respectively, for compatibility with WebLinc 0.11.
+
+    4b4b284a2aa93f4aa1ce60333f3cbabe8f8e4ed7
+
+
+WebLinc Gift Cards 0.9.0 (July 11, 2015)
+--------------------------------------------------------------------------------
+
+*   Add model summaries to index.
+
+    GIFTCARDS-57
+
+    21042f498aa5ef9bf9bf5937b89f6c95e0303185 (merge)
+
+*   Remove view `workarea/storefront/orders/tenders/_gift_card.json.jbuilder`,
+    which isn't used.
+
+    679cabac2411dd4d0039ffbb25b564df13af7382
+
+*   Update for compatibility with workarea 0.10.0.
+
+    38055d2486d57d28164da779a4d8763cac727e76
+    c1528cd6098bf565005dad94a7b62adeaecaa447
+    18822a95254a6d475be7aee7fbd59743a4847be4
+    618b4512d03a13b3a063e3faf70254b4c57baeeb
+    74f4ad180bc5f17883ff987a336235d99737daa6
+    c78cd1aa7a9e2edb4a6867cb7ab0e149f1d64e2e
+    d4e2ea1a5e334df9f1f83849ec8b263539456fd9
+
+*   Fix "back" links in Admin.
+
+    GIFTCARDS-61
+
+    fc80b8a6428e478e0f21d256a91fe9a89354dfdc
+
+*   Fix `selected_navigation_nodes` in Admin.
+
+    GIFTCARDS-60
+
+    405446c3a63700bd20a2efac4b934c35f9fd3e9e
+
+*   Remove quantity field from gift card template.
+
+    GIFTCARDS-44
+
+    c554279546f896e1973993c54d139efeda91944b
+
+
+WebLinc Gift Cards 0.8.0 (June 1, 2015)
+--------------------------------------------------------------------------------
+
+*   Rename fixtures to factories and clean up factories.
+
+    dae3b82cbdb54ba988bc1804ba332c614c21016d
+
+*   Refactor listeners.
+
+    ea96c63c536d3b922c0b05e1ab4e843a8bc9a6eb
+
+*   Update for compatibility with workarea 0.9.0.
+
+    faf0721baaee7431c7c1825576b68574acbf137b
+
+    GIFTCARDS-56
+
+*   Allow both strings and symbols as keys in params hash of gift card search.
+
+    GIFTCARDS-54
+
+*   Move gift cards API functionality from workarea-gift_cards to workarea-api.
+
+    GIFTCARDS-50
+
+
+WebLinc Gift Cards 0.7.0 (April 10, 2015)
+--------------------------------------------------------------------------------
+
+*   Allow "From" to be a value other than an email address.
+
+    The "From" field for gift cards was required to be an email address, but users were entering non-email values such as "Mom & Dad". This change removes the email validation from the model.
+
+    GIFTCARDS-51
+
+*   Update JavaScript modules for compatibility with WebLinc 0.8.0.
+
+*   Update testing environment for compatibility with WebLinc 0.8.0.
+
+*   Move product description out of add to cart form for consistency with WebLinc 0.8.0.
+
+    GIFTCARDS-36
+
+*   Use new decorator style for consistency with WebLinc 0.8.0.
+
+*   Remove gems server secrets for consistency with WebLinc 0.8.0.
+
+*   Remove `money_field` method for compatibility with WebLinc 0.8.0.
+
+    GIFTCARDS-43
+
+*   Update assets for compatibility with WebLinc 0.8.0.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+gem 'workarea-api', '>= 4.1.x'
+gem 'workarea', github: 'workarea-commerce/workarea'

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/README.md

@@ -0,0 +1,119 @@
+Workarea Gift Cards
+================================================================================
+
+A Workarea Commerce plugin that enables customers to purchase physical and digital gift cards and redeem them for other merchandise within the catalog.
+
+Overview
+--------------------------------------------------------------------------------
+
+* Create gift card products, both digital and physical
+* Allow gift card customization with recipient name, email, and personal message
+* Automatically deliver digital gift card information to recipient upon purchase
+* Use any number of gift cards as payment in checkout (with configurable limit)
+* Check the balance of a digital gift card
+* Manage digital gift cards from the admin
+* View gift card redemptions from the admin
+* Admin API management of gift cards
+* Storefront API support for using gift cards in checkout
+* Gateway support for easily using a third-party gift card service (see below)
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-gift_cards'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+Using a custom gift card gateway
+--------------------------------------------------------------------------------
+
+The `workarea-gift_cards` plugin comes fully functional with management of gift cards, tracking of redemptions and balances within the Workarea admin. However, using a third-party gift card service is not uncommon. Taking that into consideration, the plugin allows for the use of a custom gateway for looking up
+balances, validating gift card info, and processing gift card payments. This allows a retailer to utilize the plugin for the gift card product behaviors, but continue using a third-party service for generating gift card codes and tracking the use of purchased gift cards.
+
+## Setup a custom gateway
+
+The plugin adds a configuration value of `Workarea.config.gateways.gift_card`. By default, this is set to `Workarea::GiftCards::Gateway`, which utilizes the existing `Workarea::Payment::GiftCard` collection. This configuration value can be changed to a custom class of your choice that responds to the same methods.
+
+```ruby
+class ThirdPartyGiftCardGateway
+  # setup any relevant configuration required for connecting to a
+  # third-party service
+  #
+  def initialize; end
+
+  # Optional. Define this method to tell the system you are using the
+  # Workarea::Payment::GiftCard collection. This will turn on a number of
+  # behaviors only relevant when using the collection. If the gateway does not
+  # respond to this method, it will assume false.
+  #
+  def uses_system_cards?
+    true
+  end
+
+  # These are the transactional methods expected from the gateway. They each
+  # take two arguments:
+  #   amount - is the value (in cents) that transaction is looking to apply.
+  #   tender - will be a Workarea::Payment::Tender::GiftCard which you can use
+  #            to find the relevant card number or other info stored on the
+  #            tender associated to this transaction.
+  #
+  # The system expects these method to return an object that responds to
+  # two methods:
+  #   success? - a boolean that determines if the transaction was successful
+  #   message - information around the transaction result
+  #
+  def authorize(amount, tender); end
+  def cancel(amount, tender); end
+  def capture(amount, tender); end
+  def purchase(amount, tender); end
+  def refund(amount, tender); end
+
+  # This passes in one or more tokens/numbers as strings and returns a Money
+  # object that represents the total balance of all valid card numbers.
+  #
+  def balance(token); end
+
+  # This method is used when a customer looks up their balance from the
+  # storefront. This will often require them to provide some unique info
+  # to protect against malicious attempts at discovering gift card numbers.
+  # The request parameters are passed directly into the method to allow
+  # flexibility in the information you request from the user to show them
+  # the balance. By default, the system expects this method to return an
+  # object that responds to #balance, #token, and #to. This is entirely
+  # dependent on the resulting view rendered, which can be customized.
+  #
+  def lookup(params); end
+end
+```
+
+After building a custom class, set the config value to the custom class.
+
+```ruby
+Workarea.configure do |config|
+  config.gateways.gift_card = 'ThirdPartyGiftCardGateway'
+end
+```
+
+Note that it is set to a string of the class constant, and not an instance of the class. The system constantizes and initializes a new instance whenever it uses the gateway to ensure autoloading works correctly and so a gateway that cares about the current state of the application is applied correctly. This is most relevant in multi-site environments where each site might want to use their own gift card gateway.
+
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Gift Cards is released under the [Business Software License](LICENSE)