submane 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b09740d20fd78c7d2aeb12bbb9d36292d1ef304ebb5a0a58179303c3a2348b9c
+  data.tar.gz: 9536d399660a0b62e1f90bc81e7ae7efb5e449e9c6be0155cf71f63f0ca48164
+SHA512:
+  metadata.gz: 3b962045c706f57e02371d447985ac47fd061b13e76441903a240e7334b8e494528f7b74bf7470cff71de578949c06f0287421737348de15181aa1bab0f28614
+  data.tar.gz: 7e5b89443c941f3645b9b425ab9ebc60d5c1c9102dddea2275dec394359fde9c67c180fde17e2d3146a45537ab660450355293e0d2eec16c4471ed8eb547475b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright kingsley-people-box
+
+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,73 @@
+# Submane
+A rails gem for subscription management.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "submane"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it with bundle install:
+```bash
+$ bundle install submane
+```
+
+We then run the following command to add migrations and config yml file
+```bash
+$ bin/rails generate submane:install
+```
+
+Finally, we can add the class that subscriptions will be attached to.
+Assuming "Account" class will hold the subscriptions, then we set is as the following string in `config/submane.yml`
+```ruby
+account_class: Account
+```
+
+## Usage
+With the "Account" instance, let assume it is "account"
+```ruby
+account = Account.new(...)
+```
+### Active plan
+Get the active plan
+
+```ruby
+account.active_plan
+```
+
+Check if account has active plan
+
+```ruby
+account.has_active_plan?
+```
+Create Plans
+```ruby
+  Submane.create_plan(name: "", price: "", visual_order: 1)
+```
+
+### Subscription
+Get all subscriptions
+```ruby
+account.subscriptions
+```
+Get all active Subscriptions for a plan
+```ruby
+Submane.plan_active_subscriptions({plan_id})
+```
+Get active subscription
+```ruby
+account.active_subscription
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop app:db:migrate app:test]

data/app/assets/config/submane_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/submane .css

data/app/assets/stylesheets/submane/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/submane/application_controller.rb

@@ -0,0 +1,4 @@
+module Submane
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/submane/application_helper.rb

@@ -0,0 +1,4 @@
+module Submane
+  module ApplicationHelper
+  end
+end

data/app/jobs/submane/application_job.rb

@@ -0,0 +1,4 @@
+module Submane
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/submane/application_mailer.rb

@@ -0,0 +1,6 @@
+module Submane
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/concerns/submane/model_attributes.rb

@@ -0,0 +1,23 @@
+module Submane
+  module ModelAttributes
+    def create_subscription; end
+
+    def active_subcriptions
+      subscriptions.where("end_date > ?", Time.now).order(:end_date)
+    end
+
+    def active_plan
+      subscriptions.where("end_date > ?", Time.now).order(:end_date).last.submane_plan
+    end
+
+    def active_plan?
+      subscriptions.where("end_date > ?", Time.now).exists?
+    end
+
+    def active_subscription
+      subscriptions.where("end_date > ?", Time.now).order(:end_date).last
+    end
+
+    alias subcribed? active_plan?
+  end
+end

data/app/models/concerns/submane/models.rb

@@ -0,0 +1,12 @@
+module Submane
+  module Models
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def setup_submane
+        has_many :subscriptions, class_name: "Submane::Subscription", foreign_key: "client_id"
+        include Submane::ModelAttributes
+      end
+    end
+  end
+end

data/app/models/submane/application_record.rb

@@ -0,0 +1,5 @@
+module Submane
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/submane/plan.rb

@@ -0,0 +1,6 @@
+module Submane
+  class Plan < ApplicationRecord
+    has_many :subscriptions
+    validates :name, :price, :visual_order, presence: true
+  end
+end

data/app/models/submane/subscription.rb

@@ -0,0 +1,6 @@
+module Submane
+  class Subscription < ApplicationRecord
+    belongs_to :plan
+    belongs_to :client, class_name: Submane.account_class if Submane.account_class
+  end
+end

data/app/views/layouts/submane/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Submane</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "submane/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Submane::Engine.routes.draw do
+end

data/lib/generators/submane/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Creates migration and initializer config files for Submane
+
+Example:
+  bin/rails generate submane:install
+
+  This will create:
+    config/initializers/submane.rb
+    db/migrate/{timestamp}_install_submane.rb

data/lib/generators/submane/install_generator.rb

@@ -0,0 +1,24 @@
+require "rails/generators/active_record"
+
+module Submane
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/install_submane.rb", migration_version: migration_version
+      end
+
+      def copy_config
+        template "config.yml", "config/submane.yml"
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/submane/templates/config.yml.tt

@@ -0,0 +1 @@
+account_class: User

data/lib/generators/submane/templates/migration.rb.tt

@@ -0,0 +1,19 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :submane_plans do |t|
+      t.string :name
+      t.integer :price
+      t.integer :visual_order, index: { unique: true }
+
+      t.timestamps
+    end
+
+    create_table :submane_subscriptions do |t|
+      t.references :plan
+      t.references :client
+      t.datetime :end_date, null: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/submane/attributes.rb

@@ -0,0 +1,15 @@
+module Submane
+  module Attributes
+    def plan_active_subscriptions(plan_id)
+      Submane::Subscription.where("plan_id = ? AND end_date > ?", plan_id, Time.now)
+    end
+
+    def create_plan!(plan)
+      Submane::Plan.create!(plan)
+    end
+
+    def create_plan(plan)
+      Submane::Plan.create(plan)
+    end
+  end
+end

data/lib/submane/engine.rb

@@ -0,0 +1,5 @@
+module Submane
+  class Engine < ::Rails::Engine
+    isolate_namespace Submane
+  end
+end

data/lib/submane/version.rb

@@ -0,0 +1,3 @@
+module Submane
+  VERSION = "0.1.0".freeze
+end

data/lib/submane.rb

@@ -0,0 +1,32 @@
+require "submane/version"
+require "submane/engine"
+require "submane/attributes"
+
+module Submane
+  extend Attributes
+
+  # config_accessor :account_class
+
+  def self.config
+    @config ||= begin
+      path = Rails.root.join("config", "submane.yml").to_s
+      if File.exist?(path)
+        YAML.safe_load(ERB.new(File.read(path)).result, aliases: true)
+      else
+        {}
+      end
+    end
+  end
+
+  def self.account_class
+    unless defined?(@account_class)
+      @account_class = config["account_class"]
+      @account_class = (Account.name rescue nil) if @account_class.nil? # rubocop:disable Style/RescueModifier
+    end
+    @account_class
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include Submane::Models
+end

data/lib/tasks/submane_tasks.rake

@@ -0,0 +1,9 @@
+# desc "Explaining what the task does"
+# task :submane do
+#   # Task goes here
+# end
+
+desc "Open irb with library in load path"
+task :console do
+  exec "irb -r mygem -I ./lib"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: submane
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Unegbu Kingsley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+description: Subscription management gem for rails.
+email:
+- kingsobino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/submane_manifest.js
+- app/assets/stylesheets/submane/application.css
+- app/controllers/submane/application_controller.rb
+- app/helpers/submane/application_helper.rb
+- app/jobs/submane/application_job.rb
+- app/mailers/submane/application_mailer.rb
+- app/models/concerns/submane/model_attributes.rb
+- app/models/concerns/submane/models.rb
+- app/models/submane/application_record.rb
+- app/models/submane/plan.rb
+- app/models/submane/subscription.rb
+- app/views/layouts/submane/application.html.erb
+- config/routes.rb
+- lib/generators/submane/USAGE
+- lib/generators/submane/install_generator.rb
+- lib/generators/submane/templates/config.yml.tt
+- lib/generators/submane/templates/migration.rb.tt
+- lib/submane.rb
+- lib/submane/attributes.rb
+- lib/submane/engine.rb
+- lib/submane/version.rb
+- lib/tasks/submane_tasks.rake
+homepage: https://github.com/Urchmaney/submane
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Urchmaney/submane
+  source_code_uri: https://github.com/Urchmaney/submane
+  changelog_uri: https://github.com/Urchmaney/submane
+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.11
+signing_key: 
+specification_version: 4
+summary: Subscription management gem for rails.
+test_files: []