pay-aws_marketplace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7cc58bc6486b362982f6041fd356bbecc50cb5a3fe7b722c0d3e9ef9b55ff5c
+  data.tar.gz: 286199b72c6a81ac8d0daa67a9dd9a541077b6d47e0b9190188d34879e3d012c
+SHA512:
+  metadata.gz: ba6d8c91028cb40981313ef2749a6c1c778f29cc270d35c31883e9a84c7dfa9fb038275a70a386c6b732dfbd0f7972e48eb419f0d4281bca1cc00dda2fa09b40
+  data.tar.gz: b11aac21afe6f7d96288b3ecb58d49eeff9ce42b2e911b1ccc03cb0d05a9ab7433d04482dc92a3ee39da79296eef5aea0c892240d440fd2e25d0dfe90afe41eb

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Andre Arko
+
+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,39 @@
+# Pay::AwsMarketplace
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pay/aws_marketplace`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add pay-aws_marketplace
+```
+
+## Usage
+
+Use the `Pay::AwsMarketplace::Subscription.sync_from_customer_token` method to set up new customers when AWS Marketplace redirects them to your application after a purchase.
+
+Use `Pay::AwsMarketplace::Subscription.sync` to update a subscription from AWS Marketplace, for example to find out of a subscription has been cancelled, expired, renewed, or changed quantities.
+
+## Development
+
+Run `bundle config local.pay-aws_marketplace ~/path/to/checkout` in your application to use the code in your checked out repo.
+
+Run `bin/rspec` to run the tests.
+
+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 the created tag, 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/indirect/pay-aws_marketplace. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/indirect/pay-aws_marketplace/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 Pay::AwsMarketplace project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/indirect/pay-aws_marketplace/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[standard spec]

data/lib/pay/aws_marketplace/charge.rb

@@ -0,0 +1,13 @@
+module Pay
+  module AwsMarketplace
+    class Charge < Pay::Charge
+      def api_record
+        self
+      end
+
+      def refund!(amount_to_refund = nil)
+        update(amount_refunded: amount_to_refund || amount)
+      end
+    end
+  end
+end

data/lib/pay/aws_marketplace/customer.rb

@@ -0,0 +1,38 @@
+module Pay
+  module AwsMarketplace
+    class Customer < Pay::Customer
+      has_many :charges, dependent: :destroy, class_name: "Pay::AwsMarketplace::Charge"
+      has_many :subscriptions, dependent: :destroy, class_name: "Pay::AwsMarketplace::Subscription"
+      has_many :payment_methods, dependent: :destroy, class_name: "Pay::AwsMarketplace::PaymentMethod"
+      has_one :default_payment_method, -> { where(default: true) }, class_name: "Pay::AwsMarketplace::PaymentMethod"
+
+      store_accessor :data, :aws_account_id
+
+      def api_record
+        {customer_identifier: processor_id, customer_aws_account_id: aws_account_id}.compact
+      end
+
+      def update_api_record(**attributes)
+        raise UpdateError, "AWS Marketplace does not allow updating customer information"
+      end
+
+      def charge(amount, options = {})
+        raise ChargeError, "AWS Marketplace does not support one-off charges"
+      end
+
+      def checkout(product_id:)
+        URI("https://aws.amazon.com/marketplace/procurement").tap do |url|
+          url.query = URI.encode_www_form(productId: product_id)
+        end.to_s
+      end
+
+      def subscribe(name: Pay.default_product_name, plan: Pay.default_plan_name, **options)
+        raise UpdateError
+      end
+
+      def add_payment_method(payment_method_id, default: false)
+        raise PaymentMethodError
+      end
+    end
+  end
+end

data/lib/pay/aws_marketplace/payment_method.rb

@@ -0,0 +1,11 @@
+module Pay
+  module AwsMarketplace
+    class PaymentMethod < Pay::PaymentMethod
+      def make_default!
+      end
+
+      def detach
+      end
+    end
+  end
+end

data/lib/pay/aws_marketplace/subscription.rb

@@ -0,0 +1,99 @@
+module Pay
+  module AwsMarketplace
+    class Subscription < Pay::Subscription
+      def self.sync_from_registration_token(token)
+        require "aws-sdk-marketplacemetering"
+        aws_mm = Aws::MarketplaceMetering::Client.new(region: "us-east-1")
+        customer_info = aws_mm.resolve_customer(registration_token: token)
+
+        customer = Customer.create_with(
+          aws_account_id: customer_info.customer_aws_account_id,
+          processor: "aws_marketplace"
+        ).find_or_create_by!(processor_id: customer_info.customer_identifier)
+
+        require "aws-sdk-marketplaceentitlementservice"
+        aws_mes = Aws::MarketplaceEntitlementService::Client.new(region: "us-east-1")
+        entitlement = aws_mes.get_entitlements(
+          product_code: customer_info.product_code,
+          filter: {CUSTOMER_IDENTIFIER: [customer_info.customer_identifier]},
+          max_results: 1
+        ).entitlements.first
+
+        sync(entitlement, customer: customer)
+      end
+
+      def self.sync(entitlement, customer: nil)
+        customer ||= Customer.find_by(processor_id: entitlement.customer_identifier)
+
+        unless customer
+          raise Pay::Error, "Customer with processor_id #{entitlement.customer_identifier} missing while syncing"
+        end
+
+        status = :active
+        ends_at = nil
+
+        # This class uses `ends_at` to track the time an already-scheduled cancellation request
+        # should take effect.  Amazon uses `expiration_date` to tell us when the contracted
+        # subscription period will end. As a result, we have to calculate the current status of the
+        # sub ourselves and put that into `status`.
+        if entitlement.expiration_date < Time.current
+          status = :cancelled
+          ends_at = entitlement.expiration_date
+        end
+
+        customer.subscriptions.find_or_initialize_by(
+          processor_plan: entitlement.product_code
+        ).update!(
+          name: entitlement.dimension,
+          quantity: entitlement.value.integer_value,
+          ends_at: ends_at,
+          status: status
+        )
+      end
+
+      # AWS Marketplace Entitlements don't have IDs, but the marketplace does enforce a unique
+      # constraint per customer for each product. You can't subscribe to one product twice.
+      before_validation -> { self[:processor_id] ||= [processor_plan, customer_id].join("-") }
+
+      def api_record(**options)
+        self
+      end
+
+      def cancel(**options)
+        raise UpdateError
+      end
+
+      def cancel_now!(**options)
+        raise UpdateError
+      end
+
+      def paused?
+        status == "paused"
+      end
+
+      def pause
+        raise UpdateError
+      end
+
+      def resumable?
+        false
+      end
+
+      def resume
+        raise UpdateError
+      end
+
+      def swap(plan, **options)
+        raise UpdateError
+      end
+
+      def change_quantity(quantity, **options)
+        raise UpdateError
+      end
+
+      def retry_failed_payment
+        raise ChargeError
+      end
+    end
+  end
+end

data/lib/pay/aws_marketplace/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pay
+  module AwsMarketplace
+    VERSION = "0.1.0"
+  end
+end

data/lib/pay/aws_marketplace.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "pay"
+
+require "zeitwerk"
+Zeitwerk::Loader.for_gem_extension(Pay).setup
+
+require_relative "aws_marketplace/version"
+
+module Pay
+  module AwsMarketplace
+    class Error < Pay::Error
+    end
+
+    class ChargeError < Error
+      def initialize(msg = "AWS Marketplace can only charge customer AWS accounts automatically")
+        super
+      end
+    end
+
+    class PaymentMethodError < Error
+      def initialize(msg = "AWS Marketplace only allows payment via customer AWS account")
+        super
+      end
+    end
+
+    class UpdateError < Error
+      def initialize(msg = "AWS Marketplace agreements can only be changed manually at https://aws.amazon.com/marketplace")
+        super
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: pay-aws_marketplace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SunChaser.io
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-marketplaceentitlementservice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-marketplacemetering
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
+- !ruby/object:Gem::Dependency
+  name: pay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.3.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description:
+email:
+- hello@sunchaser.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pay/aws_marketplace.rb
+- lib/pay/aws_marketplace/charge.rb
+- lib/pay/aws_marketplace/customer.rb
+- lib/pay/aws_marketplace/payment_method.rb
+- lib/pay/aws_marketplace/subscription.rb
+- lib/pay/aws_marketplace/version.rb
+homepage: https://sunchaser.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://sunchaser.io
+  source_code_uri: https://github.com/sunchaserio/pay-aws_marketplace
+  changelog_uri: https://github.com/sunchaserio/pay-aws_marketplace/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Add support for AWS Marketplace SaaS subscriptions to Pay
+test_files: []