usage_meter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ac19c5ab99a76146c71f3bdf9f7c553c06de623dd575ace66bcdaa2b92e54b3
-  data.tar.gz: ed3c501efb5946c6a2275b0387a7f419510fab9f7112e5215f3f9caff88fa121
+  metadata.gz: e47d987fdc1401976f35f2bfe86a6f92399ebd39c1f8d5fc7ac5933f28320070
+  data.tar.gz: bdbd0f0a8d2c5a67856c9b849fb91dbb7cf6ae7486f5c4cf7a668224907677a9
 SHA512:
-  metadata.gz: d81512658f46522b0ae64e35485c7e0f997e71c376faa2712fd5561d4b976b9c6fe412de3ac57911b352ac9bb7db6e474eb5f1c0d738f84ce4b4f970be0354b6
-  data.tar.gz: 0c0a5ab6f0db4cc5a261acd472c2c7279e8dead8dc6bba9a27a140088b4bd273a5a8f8a5f9f4ee63a42f23a8e6afb3b9b0d433c33b0fae8a68059282888bc297
+  metadata.gz: 73309dd912770cbf1af17937c405deafab64912088242ba506185b7f778ecc966ac2a4fe8cd5df7d0d3b3fec8caa5e58204b08850922176e6e0c33119fced628
+  data.tar.gz: b2294a49324a32553406ed7052c1c7684bc3d4a6bd5e68491d6da755efd058aacdcad4262736d343e5c715ef4dde6f13cb1ffa8fc043d3d73d7128c818ec31b9

data/README.md

@@ -1,9 +1,27 @@
 # UsageMeter
-Short description and motivation.
+A Rails engine to track usage metrics of features, useful for implementing usage-based billing.
 
 ## Usage
 How to use my plugin.
 
+## Supported Versions
+
+This gem supports the following Ruby, Rails, and database versions.
+
+### Ruby
+
+- Ruby 3.+ and above (tested with 3.0, 3.1, 3.2, 3.3)
+
+### Rails
+
+- Rails 8.x and above (tested with 8.x)
+
+### Databases
+
+- **SQLite**: Supported for local development and testing.
+- **PostgreSQL**: Fully supported and recommended for production.
+- **MySQL**: Supported for production environments.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -22,7 +40,7 @@ $ gem install usage_meter
 ```
 
 ## Contributing
-Contribution directions go here.
+We are not actively accepting contributions at this early stage of development, and external pull Requests will be automatically closed.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as under the terms of the [License](LICENCE.txt)

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/setup"
+# frozen_string_literal: true
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
+require 'bundler/setup'
 
-require "bundler/gem_tasks"
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/usage_meter/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UsageMeter
   class ApplicationController < ActionController::Base
   end

data/app/helpers/usage_meter/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UsageMeter
   module ApplicationHelper
   end

data/app/jobs/usage_meter/application_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UsageMeter
   class ApplicationJob < ActiveJob::Base
   end

data/app/mailers/usage_meter/application_mailer.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module UsageMeter
   class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
+    default from: 'from@example.com'
+    layout 'mailer'
   end
 end

data/app/models/usage_meter/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UsageMeter
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true

data/app/models/usage_meter/customer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UsageMeter
+  # UsageMeter Customer model
+  # A customer in an enttity who's usage is being metered. This is typically a Tenant
+  # Organization, or User.
+  #
+  # UsageMeter tracks it's own customers to ensure consistency and integrity of usage data.
+  # Each customer will have a unique composite key of external_type and external_identifier.
+  # Usage data is then associated with these customers, with foreign keys referencing the
+  # to ensure referential integrity.
+  #
+  # Once created, records are readonly by design to prevent tampering with historical usage data.
+  class Customer < ApplicationRecord
+    validates :external_type, presence: true
+    validates :external_identifier, presence: true, uniqueness: { scope: :external_type }
+
+    attr_readonly :external_type, :external_identifier, :created_at, :updated_at
+
+    def readonly?
+      persisted?
+    end
+  end
+end

data/app/models/usage_meter/event_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UsageMeter
+  # EventType allows strict categorization of events
+  #
+  # Events of the same category and Customer will
+  # tally together for the usage of that type
+  # Events must have a type, and types will be
+  # enforced with a foreign key ref.
+  #
+  # Key must be unique, to allow lookup
+  class EventType < ApplicationRecord
+    KEY_FORMAT = /\A[a-z0-9\-_]+\z/
+    def self.key_format
+      KEY_FORMAT
+    end
+
+    validates :key, presence: true
+    validates :key, uniqueness: true
+    validates :key, format: { with: key_format, message: :invalid, key_format_regex: key_format.inspect }
+
+    attr_readonly :key
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  activerecord:
+    errors:
+      models:
+        usage_meter/event_type:
+          attributes:
+            key:
+              invalid: "must satisfy the regular expression %{key_format_regex}"

data/config/routes.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 UsageMeter::Engine.routes.draw do
 end

data/db/migrate/20251107032323_create_usage_meter_customers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class CreateUsageMeterCustomers < ActiveRecord::Migration[7.0]
+  PK_TYPE = begin
+    ApplicationRecord.connection_config[:primary_key_type]
+  rescue StandardError
+    :bigint
+  end
+
+  def change
+    create_table :usage_meter_customers do |t|
+      if ActiveRecord::Base.connection.adapter_name == 'Mysql2'
+        t.string :external_identifier, collation: "utf8mb4_bin"
+        t.string :external_type, collation: "utf8mb4_bin"
+      else
+        t.string :external_identifier
+        t.string :external_type
+      end
+      t.string :human_description
+      if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+        t.jsonb :metadata
+      else
+        t.json :metadata
+      end
+
+      t.timestamps
+    end
+    add_index :usage_meter_customers, %i[external_type external_identifier], unique: true, name: :index_usage_meter_customers_on_external_type_and_identifier
+  end
+end

data/db/migrate/20251111204821_create_usage_meter_event_types.rb

@@ -0,0 +1,14 @@
+class CreateUsageMeterEventTypes < ActiveRecord::Migration[7.0]
+  def change
+    create_table :usage_meter_event_types do |t|
+      if ActiveRecord::Base.connection.adapter_name == 'Mysql2'
+        t.string :key, null: false, index: { unique: true }, collation: "utf8mb4_bin"
+      else
+        t.string :key, null: false, index: { unique: true }
+      end
+      t.string :human_description
+
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/usage_meter_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :usage_meter do
 #   # Task goes here

data/lib/usage_meter/engine.rb

@@ -1,5 +1,12 @@
+# frozen_string_literal: true
+
 module UsageMeter
   class Engine < ::Rails::Engine
     isolate_namespace UsageMeter
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot, dir: 'spec/factories'
+    end
   end
 end

data/lib/usage_meter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UsageMeter
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/usage_meter.rb

@@ -1,5 +1,7 @@
-require "usage_meter/version"
-require "usage_meter/engine"
+# frozen_string_literal: true
+
+require 'usage_meter/version'
+require 'usage_meter/engine'
 
 module UsageMeter
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usage_meter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James P. McGrath
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-03 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,18 +16,200 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.1.1
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.1.1
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.81.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.33.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.33.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: rubocop-rspec_rails
+  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: shoulda-matchers
+  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: simplecov
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 description: A Rails engine to track usage metrics of features, useful for implementing
   usage-based billing.
 email:
-- james@shippit.com
+- gems@jamespmcgrath.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -40,8 +222,13 @@ files:
 - app/jobs/usage_meter/application_job.rb
 - app/mailers/usage_meter/application_mailer.rb
 - app/models/usage_meter/application_record.rb
+- app/models/usage_meter/customer.rb
+- app/models/usage_meter/event_type.rb
 - app/views/layouts/usage_meter/application.html.erb
+- config/locales/en.yml
 - config/routes.rb
+- db/migrate/20251107032323_create_usage_meter_customers.rb
+- db/migrate/20251111204821_create_usage_meter_event_types.rb
 - lib/tasks/usage_meter_tasks.rake
 - lib/usage_meter.rb
 - lib/usage_meter/engine.rb
@@ -53,6 +240,7 @@ metadata:
   homepage_uri: https://github.com/jpmcgrath/usage_meter
   source_code_uri: https://github.com/jpmcgrath/usage_meter
   changelog_uri: https://github.com/jpmcgrath/usage_meter
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -61,14 +249,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: A Rails engine to track usage metrics of features