core_merchant 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fceb2084b15e74e2aebe360df8cade628ffd930afd2ef689a6779c3f59f5f70a
-  data.tar.gz: 96368a736ce980a109bfd9d863b56cbec0c814111edd4839874738d13cc6c9e3
+  metadata.gz: 154e94061339edca03a2e9c88630c4e49ce37272252e5d6436810579ea2bd529
+  data.tar.gz: 5fe4eb2a4c24b26945a505f35d9a7694de69e7630c03776ac78b7dcd6671616b
 SHA512:
-  metadata.gz: 643e829909744d948af7a5270ebdd0f3be2dfa7f3d540da9f0fd728fc9d052731719d6ec6f93cfc73d7357f25c3bbd50a8fd32046b0c2a354058fc611d34e8ac
-  data.tar.gz: a2ecdd77b9628e2dee8b67b422f0d4fa2f1a62214c28bc9bb1ae72338986272b03bfce1a193969a3fbbc6e440e45ac041c8dd2c637de1fa0d7f796244f6b6daf
+  metadata.gz: 9debecdb722370c173fc97648d5f38e130e95475edb673d5f420b7074db10dfad908221cb2b2a1dec966be064fa07040a4ad287ab10380741cd9d9df27f8d618
+  data.tar.gz: 6d5675f20dfa56f708026a28f64cb48dcc44792f6e2663a13e1c466867defb2120f5947f84db8314d983246ef511bac2ce434aa3956fc621bdaf9cdd12b4a04c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    core_merchant (0.6.0)
+    core_merchant (0.6.2)
       activesupport (~> 7.0)
       rails (~> 7.0)
 
@@ -99,6 +99,8 @@ GEM
     diff-lcs (1.5.1)
     drb (2.2.1)
     erubi (1.13.0)
+    factory_bot (6.4.6)
+      activesupport (>= 5.0.0)
     generator_spec (0.9.5)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
@@ -251,6 +253,7 @@ PLATFORMS
 DEPENDENCIES
   core_merchant!
   database_cleaner
+  factory_bot
   generator_spec (~> 0.9.4)
   railties (~> 7.0)
   rake (~> 13.0)

data/README.md

@@ -9,8 +9,8 @@ CoreMerchant is a library for customer, product, and subscription management in
 - [X] Add customer behavior
 - [X] Add initializer generator
 - [X] Add SubscriptionPlan model
-- [ ] Add Subscription model
-- [ ] Add subscription management service
+- [X] Add Subscription model
+- [ ] Implement subscription manager and callbacks
 - [ ] Add sidekiq jobs for subscription management
 - [ ] Add Invoice model
 - [ ] Add billing and invoicing service

data/core_merchant.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_dependency "rails", "~> 7.0"
 
   spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "generator_spec", "~> 0.9.4"
   spec.add_development_dependency "railties", "~> 7.0"
   spec.add_development_dependency "rspec-rails", "~> 5.0"

data/lib/core_merchant/customer_behavior.rb

@@ -6,18 +6,21 @@ module CoreMerchant
     extend ActiveSupport::Concern
 
     included do
-    end
+      def core_merchant_customer_id
+        id
+      end
 
-    def core_merchant_customer_id
-      id
-    end
+      def core_merchant_customer_email
+        email
+      end
 
-    def core_merchant_customer_email
-      email
-    end
+      def core_merchant_customer_name
+        name if respond_to?(:name)
+      end
 
-    def core_merchant_customer_name
-      name if respond_to?(:name)
+      def subscriptions
+        CoreMerchant::Subscription.where(customer_id: core_merchant_customer_id)
+      end
     end
   end
 end

data/lib/core_merchant/subscription.rb

@@ -99,12 +99,6 @@ module CoreMerchant
 
     private
 
-    def set_period_dates
-      self.start_date ||= Time.current
-      self.current_period_start ||= start_date
-      self.current_period_end ||= start_date + subscription_plan.duration_in_date
-    end
-
     def end_date_after_start_date
       errors.add(:end_date, "must be after the `start date") if end_date <= start_date
     end

data/lib/core_merchant/subscription_listener.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CoreMerchant
+  # Include this module in your application to listen for subscription events.
+  module SubscriptionListener
+    extend ActiveSupport::Concern
+
+    included do
+      def on_test_event_received
+        puts "Test event received by CoreMerchant::SubscriptionListener. Override this method in your application."
+      end
+    end
+  end
+end

data/lib/core_merchant/subscription_manager.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CoreMerchant
+  # Manages subscriptions in CoreMerchant.
+  class SubscriptionManager
+    attr_reader :listeners
+
+    def initialize
+      @listeners = []
+    end
+
+    def add_listener(listener)
+      @listeners << listener
+    end
+
+    def notify_test_event
+      @listeners.each do |listener|
+        listener.on_test_event_received if listener.respond_to?(:on_test_event_received)
+      end
+    end
+  end
+end

data/lib/core_merchant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoreMerchant
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/lib/core_merchant.rb

@@ -5,6 +5,8 @@ require "active_support/concern"
 require_relative "core_merchant/version"
 require_relative "core_merchant/customer_behavior"
 require_relative "core_merchant/subscription_plan"
+require_relative "core_merchant/subscription_manager"
+require_relative "core_merchant/subscription_listener"
 
 # CoreMerchant module
 module CoreMerchant
@@ -19,16 +21,25 @@ module CoreMerchant
 
     def configure
       yield(configuration)
+
+      return unless configuration.subscription_listener_class
+
+      listener = configuration.subscription_listener_class.constantize.new
+      subscription_manager.add_listener(listener)
     end
 
     def customer_class
       configuration.customer_class.constantize
     end
+
+    def subscription_manager
+      @subscription_manager ||= CoreMerchant::SubscriptionManager.new
+    end
   end
 
   # Used to configure CoreMerchant.
   class Configuration
-    attr_accessor :customer_class
+    attr_accessor :customer_class, :subscription_listener_class
 
     def initialize
       @customer_class = "CoreMerchant::Customer"

data/lib/generators/core_merchant/install_generator.rb

@@ -10,12 +10,8 @@ module CoreMerchant
 
       source_root File.expand_path("templates", __dir__)
 
-      class_option :customer_class, type: :string, required: true,
-                                    desc: "Name of your existing customer class, e.g. User"
-
       def copy_initializer
-        @customer_class = options[:customer_class].classify
-        template "core_merchant.erb", "config/initializers/core_merchant.rb"
+        template "core_merchant.rb", "config/initializers/core_merchant.rb"
       end
 
       def copy_locales
@@ -36,20 +32,22 @@ module CoreMerchant
 
       def show_post_install
         say "CoreMerchant has been successfully installed.", :green
-        say <<~MESSAGE
-          Customer class: #{@customer_class}. Please update this model to include the CoreMerchant::CustomerBehavior module.
+        next_steps = <<~MESSAGE
+          Next steps:
+          1. Set the customer class in the initializer file (config/initializers/core_merchant.rb) to the class you want to use for customers.
+          2. Create a subscription listener class (should include CoreMerchant::SubscriptionListener) in your app and set this class in the initializer file (config/initializers/core_merchant.rb) to the class you want to use for subscription listeners.
+          3. Run `rails db:migrate` to create the subscription and subscription plan tables.
         MESSAGE
-        say "Please run `rails db:migrate` to create the subscription and subscription plan tables.", :yellow
+        say next_steps, :yellow
       end
 
       def self.banner
-        "rails generate core_merchant:install --customer_class=User"
+        "rails generate core_merchant:install"
       end
 
       def self.description
         <<~DESC
-          Installs CoreMerchant into your application with the specified customer class.
-          This could be User, Customer, or any other existing model in your application that represents a customer."
+          Installs CoreMerchant into your application. This generator will create an initializer file, migration files for the subscription and subscription plan tables, and a locale file."
         DESC
       end
     end

data/lib/generators/core_merchant/templates/core_merchant.rb

@@ -0,0 +1,26 @@
+# Created by: rails generate core_merchant:install
+
+CoreMerchant.configure do |config|
+  # Set the class that represents a customer in your application.
+  # This class must include the CoreMerchant::CustomerBehavior module as such:
+  # class User < ApplicationRecord
+  #   include CoreMerchant::CustomerBehavior
+  #   ...
+  # end
+  config.customer_class = "User"
+
+  # Set the class that will receive subscription notifications/
+  # This class must include the CoreMerchant::SubscriptionListener module.
+  # class SubscriptionListener
+  #   include CoreMerchant::SubscriptionListener
+  #   def on_subscription_created(subscription)
+  #     ...
+  #   end
+  #   ...
+  # end
+  # This class will receive notifications when a subscription is created, updated, canceled etc.
+  #
+  # To test notifications to this class, you can override `on_test_event_received` method
+  # and call `CoreMerchant.subscription_manager.notify_test_event`.
+  config.subscription_listener_class = "SubscriptionListener"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: core_merchant
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Seyithan Teymur
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -133,11 +147,13 @@ files:
 - lib/core_merchant/concerns/subscription_state_machine.rb
 - lib/core_merchant/customer_behavior.rb
 - lib/core_merchant/subscription.rb
+- lib/core_merchant/subscription_listener.rb
+- lib/core_merchant/subscription_manager.rb
 - lib/core_merchant/subscription_plan.rb
 - lib/core_merchant/version.rb
 - lib/generators/core_merchant/install_generator.rb
 - lib/generators/core_merchant/templates/core_merchant.en.yml
-- lib/generators/core_merchant/templates/core_merchant.erb
+- lib/generators/core_merchant/templates/core_merchant.rb
 - lib/generators/core_merchant/templates/migrate/create_core_merchant_subscription_plans.erb
 - lib/generators/core_merchant/templates/migrate/create_core_merchant_subscriptions.erb
 - sig/core_merchant.rbs

data/lib/generators/core_merchant/templates/core_merchant.erb

@@ -1,5 +0,0 @@
-# Created by: rails generate core_merchant:install --customer_class=<%= @customer_class %>
-
-CoreMerchant.configure do |config|
-  config.customer_class = "<%= @customer_class %>"
-end