core_merchant 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d92b65405d20766e71e2510e5bc3c79dcbd1a0821721f83262c28c4ecb3e5f6
-  data.tar.gz: 1da82246e7b5145805e4c31d24b42fd7acf77d7ab541166ae5cc450a008c2b45
+  metadata.gz: 186950538bdef9e0bebf514212e20953f34f2eb2a3d2513d97a616b66744c3f3
+  data.tar.gz: 3509ceb3b0d12b66ab0cbe5715ca7e8852be461319694075ea9976e1fb5b1d4f
 SHA512:
-  metadata.gz: ec3490ecc9fd035a910657eea62a2326cf87bccd8dc4b578c44850b3eba8e0478d3f2a6174b398a0cb0b1b4821147c87f8d7cf7e2422740d0e90340becb3c975
-  data.tar.gz: 879406bcfb5e904c51c502b2fb5cd91540487993dcb5c33fa0ef8b0104c78ca8a6ba6aa37e0e577a8fd2effbb167b233d5497820849eaef9050b8774a6f3974d
+  metadata.gz: ff86052965a4ae8d5e535bae668176888879de0080a5fe5cbf0e753323aab071d64912085fd52a360b9b6db8e1eb9380d44bc4ab89b751ab531803ddbe2a38e1
+  data.tar.gz: 289f60e89c495762fa2d547cc6abc8cf1f600d6b4b8ee221449bd7e80ed52f21f794841c57d84d96c340cc53065e2ef2de003f16c5a3c388b463d13fda207ec2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    core_merchant (0.1.0)
+    core_merchant (0.2.0)
       activesupport (~> 7.0)
       rails (~> 7.0)
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Seyithan
+Copyright (c) 2024 Seyithan Teymur (https://seyithan.me)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,39 +1,87 @@
 # CoreMerchant
 
-## This gem is under development at pre-release stage
+> [!CAUTION]
+> This gem is under development at pre-release stage
 
-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/core_merchant`. To experiment with that code, run `bin/console` for an interactive prompt.
+CoreMerchant is a library for customer, product, and subscription management in Rails applications. It's meant to be a starting point for building e-commerce and SaaS applications. It provides essential functionality for handling customers, products, and subscriptions. Does not include payment integrations.
 
-TODO: Delete this and the text above, and describe your gem
+## To-dos until 1.0.0 release
+- [X] Add customer behavior
+- [X] Add initializer generator
+- [X] Add SubscriptionPlan model
+- [ ] Add Subscription model
+- [ ] Add subscription management service
+- [ ] Add sidekiq jobs for subscription management
+- [ ] Add Invoice model
+- [ ] Add billing and invoicing service
 
 ## Installation
+Add this line to your application's Gemfile:
+```
+gem 'core_merchant', '~> 0.1.0'
+```
+and run `bundle install`.
 
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add core_merchant
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install core_merchant
+Alternatively, you can install the gem manually:
+```
+$ gem install core_merchant
+```
 
 ## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. 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).
+### Initialization
+Run the generator to create the initializer file and the migrations:
+```
+$ rails generate core_merchant:install
+```
+This will create the following files:
+- `config/initializers/core_merchant.rb` - Configuration file
+- `db/migrate/xxxxxx_create_core_merchant_subscription_plans.rb` - Migration for subscription plans
+
+You can then run the migrations:
+```
+$ rails db:migrate
+```
+
+### Configuration
+The initializer file `config/initializers/core_merchant.rb` contains the following configuration options:
+```ruby
+config.customer_class
+```
+
+### The cusomer class
+The customer class is the model that represents the customer in your application. For example, if you already have a `User` model that represents the users of your application, you can use it as the customer class in CoreMerchant. To do this, you need to set the `customer_class` configuration option in the initializer file:
+```ruby
+# config/initializers/core_merchant.rb
+CoreMerchant.configure do |config|
+  config.customer_class = 'User'
+end
+```
+
+You need to then include the `CoreMerchant::Customer` module in the customer class:
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  include CoreMerchant::Customer
+
+  # ... the rest of your model code
+end
+```
+
+## Models
+### SubscriptionPlan
+The `SubscriptionPlan` model represents a subscription plan in your application. It has the following attributes:
+- `name_key`: A unique key for the subscription plan.
+            This key is used to identify the plan in the application,
+            as well as the translation key for the plan name through `core_merchant.subscription_plans`.
+- `price_cents`: The price of the subscription plan in cents.
+- `duration`: The duration of the subscription plan.
+              Consists of a number and a letter representing the time unit as day, week, month, or year.
+              For example, `1w` for 1 week, `3m` for 3 months, `1y` for 1 year.
+- `introductory_price_cents`: The introductory price of the subscription plan in cents.
+- `introductory_duration`: The duration of the introductory price of the subscription plan.
+
+> [!NOTE]
+> Other models and features are being developed and will be added in future releases.
 
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/core_merchant. 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/[USERNAME]/core_merchant/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 CoreMerchant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/core_merchant/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/theseyithan/core_merchant

data/lib/core_merchant/version.rb

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

data/lib/generators/core_merchant/install_generator.rb

@@ -19,9 +19,8 @@ module CoreMerchant
       end
 
       def create_migration_file
-        timestamp = self.class.next_migration_number(nil)
-        migration_template "create_core_merchant_subscription_plans.rb",
-                           "db/migrate/#{timestamp}_create_core_merchant_subscription_plans.rb"
+        migration_template "create_core_merchant_subscription_plans.erb",
+                           "db/migrate/create_core_merchant_subscription_plans.rb"
       end
     end
   end

data/lib/generators/core_merchant/templates/{create_core_merchant_subscription_plans.rb → create_core_merchant_subscription_plans.erb}

@@ -1,5 +1,5 @@
 # Created by: rails generate core_merchant:install
-class CreateCoreMerchantSubscriptionPlans < ActiveRecord::Migration
+class CreateCoreMerchantSubscriptionPlans < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     create_table :core_merchant_subscription_plans do |t|
       t.string :name_key, null: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: core_merchant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Seyithan Teymur
@@ -135,7 +135,7 @@ files:
 - lib/core_merchant/version.rb
 - lib/generators/core_merchant/install_generator.rb
 - lib/generators/core_merchant/templates/core_merchant.rb
-- lib/generators/core_merchant/templates/create_core_merchant_subscription_plans.rb
+- lib/generators/core_merchant/templates/create_core_merchant_subscription_plans.erb
 - sig/core_merchant.rbs
 homepage: https://github.com/theseyithan/core_merchant
 licenses: