ocpp-rails 0.2.4

data/lib/generators/ocpp/rails/templates/README

@@ -0,0 +1,45 @@
+===============================================================================
+
+Ocpp::Rails has been installed!
+
+Next steps:
+
+1. Run the migrations:
+
+   rails db:migrate
+
+2. The engine is mounted at /ocpp
+
+   OCPP Rails is a backend-only engine (no bundled UI). Mounting it exposes the
+   OCPP WebSocket endpoint; you build your own dashboard on top of the models.
+
+3. Point your charge points at the OCPP WebSocket endpoint:
+
+   ws://localhost:3000/ocpp/cable
+
+   Each station subscribes to Ocpp::Rails::ChargePointChannel, passing its
+   charge_point_id. By default stations authenticate with HTTP Basic Auth on the
+   WebSocket upgrade (OCPP-J Security Profile 1), so provision a per-station
+   credential first:
+
+     charge_point.update!(auth_password: SecureRandom.base58(32))
+
+4. Configure OCPP settings in config/initializers/ocpp_rails.rb
+
+5. ActionCable transport:
+
+   No setup is required for development or test — the engine defaults to the
+   async adapter (SQLite-friendly, no Redis). For a multi-server production
+   deployment, configure a shared adapter in config/cable.yml, e.g.:
+
+     production:
+       adapter: redis
+       url: redis://localhost:6379/1
+
+6. Start your Rails server with:
+
+   rails server
+
+For more information, visit: https://github.com/trahfo/ocpp-rails
+
+===============================================================================

data/lib/generators/ocpp/rails/templates/create_ocpp_charge_points.rb

@@ -0,0 +1,21 @@
+class CreateOcppChargePoints < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :ocpp_charge_points do |t|
+      t.string :identifier, null: false, index: { unique: true }
+      t.string :vendor
+      t.string :model
+      t.string :serial_number
+      t.string :firmware_version
+      t.string :iccid
+      t.string :imsi
+      t.string :meter_type
+      t.string :meter_serial_number
+      t.string :ocpp_protocol, default: "1.6"
+      t.string :status, default: "Available"
+      t.datetime :last_heartbeat_at
+      t.boolean :connected, default: false
+      t.jsonb :metadata, default: {}
+      t.timestamps
+    end
+  end
+end

data/lib/generators/ocpp/rails/templates/create_ocpp_charging_sessions.rb

@@ -0,0 +1,22 @@
+class CreateOcppChargingSessions < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :ocpp_charging_sessions do |t|
+      t.references :charge_point, null: false, foreign_key: { to_table: :ocpp_charge_points }
+      t.integer :connector_id, null: false
+      t.string :transaction_id, index: { unique: true }
+      t.string :id_tag
+      t.string :status, default: "Preparing"
+      t.datetime :started_at
+      t.datetime :stopped_at
+      t.decimal :start_meter_value, precision: 10, scale: 2
+      t.decimal :stop_meter_value, precision: 10, scale: 2
+      t.decimal :energy_consumed, precision: 10, scale: 2
+      t.integer :duration_seconds
+      t.string :stop_reason
+      t.jsonb :metadata, default: {}
+      t.timestamps
+    end
+
+    add_index :ocpp_charging_sessions, [:charge_point_id, :connector_id]
+  end
+end

data/lib/generators/ocpp/rails/templates/create_ocpp_messages.rb

@@ -0,0 +1,18 @@
+class CreateOcppMessages < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :ocpp_messages do |t|
+      t.references :charge_point, null: false, foreign_key: { to_table: :ocpp_charge_points }
+      t.string :message_id, null: false
+      t.string :direction, null: false # inbound, outbound
+      t.string :action
+      t.string :message_type # CALL, CALLRESULT, CALLERROR
+      t.jsonb :payload, default: {}
+      t.string :status # pending, sent, received, error
+      t.text :error_message
+      t.timestamps
+    end
+
+    add_index :ocpp_messages, :message_id
+    add_index :ocpp_messages, [:charge_point_id, :created_at]
+  end
+end

data/lib/generators/ocpp/rails/templates/create_ocpp_meter_values.rb

@@ -0,0 +1,21 @@
+class CreateOcppMeterValues < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :ocpp_meter_values do |t|
+      t.references :charging_session, null: false, foreign_key: { to_table: :ocpp_charging_sessions }
+      t.references :charge_point, null: false, foreign_key: { to_table: :ocpp_charge_points }
+      t.integer :connector_id
+      t.string :measurand
+      t.string :phase
+      t.string :unit
+      t.string :context
+      t.string :format
+      t.string :location
+      t.decimal :value, precision: 15, scale: 4
+      t.datetime :timestamp
+      t.timestamps
+    end
+
+    add_index :ocpp_meter_values, :measurand
+    add_index :ocpp_meter_values, :timestamp
+  end
+end

data/lib/generators/ocpp/rails/templates/ocpp_rails.rb

@@ -0,0 +1,13 @@
+Ocpp::Rails.setup do |config|
+  # Default OCPP version to use
+  config.ocpp_version = "1.6"
+
+  # Supported OCPP versions (only 1.6 is implemented)
+  config.supported_versions = [ "1.6" ]
+
+  # Heartbeat interval in seconds
+  config.heartbeat_interval = 300
+
+  # Connection timeout in seconds
+  config.connection_timeout = 30
+end

data/lib/ocpp/rails/engine.rb

@@ -0,0 +1,19 @@
+module Ocpp
+  module Rails
+    class Engine < ::Rails::Engine
+      isolate_namespace Ocpp::Rails
+
+      config.generators.api_only = true
+
+      # Configure ActionCable to use the async adapter (works with SQLite)
+      # This is suitable for development, testing, and single-server deployments
+      # For production with multiple servers, use Redis or PostgreSQL adapter.
+      # An existing config/cable.yml always takes precedence.
+      initializer "ocpp_rails.action_cable", before: "actioncable.set_configs" do |app|
+        if (::Rails.env.development? || ::Rails.env.test?) && !app.root.join("config/cable.yml").exist?
+          app.config.action_cable.cable ||= { "adapter" => "async" }
+        end
+      end
+    end
+  end
+end

data/lib/ocpp/rails/version.rb

@@ -0,0 +1,5 @@
+module Ocpp
+  module Rails
+    VERSION = "0.2.4"
+  end
+end

data/lib/ocpp/rails.rb

@@ -0,0 +1,82 @@
+require "ocpp/rails/version"
+require "ocpp/rails/engine"
+
+module Ocpp
+  module Rails
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.setup
+      yield(configuration)
+    end
+
+    def self.supported_versions
+      configuration.supported_versions
+    end
+
+    def self.message_rate_limiter
+      @message_rate_limiter ||= RateLimiter.new { configuration.max_messages_per_minute }
+    end
+
+    def self.connection_rate_limiter
+      @connection_rate_limiter ||= RateLimiter.new { configuration.max_connection_attempts_per_minute }
+    end
+
+    def self.reset_rate_limiters!
+      @message_rate_limiter&.reset!
+      @connection_rate_limiter&.reset!
+    end
+
+    class Configuration
+      attr_accessor :ocpp_version, :supported_versions, :heartbeat_interval, :connection_timeout,
+                    :state_change_hooks, :state_change_retention_days, :state_change_cleanup_enabled,
+                    :authorization_hooks, :authorization_retention_days, :authorization_cleanup_enabled,
+                    :implausible_energy_jump_wh, :authentication_mode,
+                    :max_messages_per_minute, :max_connection_attempts_per_minute
+
+      def initialize
+        @ocpp_version = "1.6"
+        # Only 1.6 is implemented; expand when 2.x support lands.
+        @supported_versions = [ "1.6" ]
+        @heartbeat_interval = 300
+        @connection_timeout = 30
+        @state_change_hooks = []
+        @authorization_hooks = []
+        @state_change_retention_days = 30
+        @state_change_cleanup_enabled = true
+        @authorization_retention_days = 30
+        @authorization_cleanup_enabled = true
+        # Max plausible energy register increase between samples, in Wh;
+        # readings jumping further are flagged. nil disables the check.
+        @implausible_energy_jump_wh = 1_000_000
+        # :basic (OCPP-J Security Profile 1, HTTP Basic Auth) or :none.
+        # :none accepts any client that knows a station identifier - only
+        # for closed networks or during migration.
+        @authentication_mode = :basic
+        # Per-station ingress limits (fixed 60s windows, per process);
+        # nil disables the respective check.
+        @max_messages_per_minute = 300
+        @max_connection_attempts_per_minute = 12
+      end
+
+      def register_state_change_hook(hook)
+        unless hook.respond_to?(:call)
+          raise ArgumentError, "Hook must respond to :call method"
+        end
+        @state_change_hooks << hook
+      end
+
+      def register_authorization_hook(hook)
+        unless hook.respond_to?(:call)
+          raise ArgumentError, "Hook must respond to :call method"
+        end
+        @authorization_hooks << hook
+      end
+    end
+  end
+end

data/lib/tasks/ocpp/authorizations.rake

@@ -0,0 +1,18 @@
+namespace :ocpp do
+  namespace :authorizations do
+    desc "Clean up old OCPP authorization records"
+    task cleanup: :environment do
+      retention_days = ENV["RETENTION_DAYS"]&.to_i || Ocpp::Rails.configuration.authorization_retention_days
+      deleted_count = Ocpp::Rails::Authorization.older_than(retention_days).delete_all
+
+      puts "Deleted #{deleted_count} Authorization records older than #{retention_days} days"
+    end
+
+    desc "Start the automatic cleanup job (runs daily)"
+    task start_cleanup_job: :environment do
+      Ocpp::Rails::CleanupAuthorizationsJob.perform_later
+
+      puts "Automatic cleanup job started. It will run daily if cleanup is enabled."
+    end
+  end
+end

data/lib/tasks/ocpp/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ocpp_rails do
+#   # Task goes here
+# end

data/lib/tasks/ocpp/state_changes.rake

@@ -0,0 +1,18 @@
+namespace :ocpp do
+  namespace :state_changes do
+    desc "Clean up old OCPP state change records"
+    task cleanup: :environment do
+      retention_days = ENV["RETENTION_DAYS"]&.to_i || Ocpp::Rails.configuration.state_change_retention_days
+      deleted_count = Ocpp::Rails::StateChange.older_than(retention_days).delete_all
+
+      puts "Deleted #{deleted_count} StateChange records older than #{retention_days} days"
+    end
+
+    desc "Start the automatic cleanup job (runs daily)"
+    task start_cleanup_job: :environment do
+      Ocpp::Rails::CleanupStateChangesJob.perform_later
+
+      puts "Automatic cleanup job started. It will run daily if cleanup is enabled."
+    end
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: ocpp-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.4
+platform: ruby
+authors:
+- Jakob Sommerhuber
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use this engine to communicate to your EV Charging stations
+email:
+- jakob@sommerhuber.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/ocpp/rails/application.css
+- app/channels/ocpp/rails/charge_point_channel.rb
+- app/controllers/ocpp/rails/application_controller.rb
+- app/helpers/ocpp/rails/application_helper.rb
+- app/jobs/ocpp/rails/application_job.rb
+- app/jobs/ocpp/rails/async_hook_job.rb
+- app/jobs/ocpp/rails/authorization_async_hook_job.rb
+- app/jobs/ocpp/rails/change_availability_job.rb
+- app/jobs/ocpp/rails/change_configuration_job.rb
+- app/jobs/ocpp/rails/cleanup_authorizations_job.rb
+- app/jobs/ocpp/rails/cleanup_state_changes_job.rb
+- app/jobs/ocpp/rails/clear_cache_job.rb
+- app/jobs/ocpp/rails/get_configuration_job.rb
+- app/jobs/ocpp/rails/remote_start_transaction_job.rb
+- app/jobs/ocpp/rails/remote_stop_transaction_job.rb
+- app/jobs/ocpp/rails/reset_job.rb
+- app/jobs/ocpp/rails/unlock_connector_job.rb
+- app/mailers/ocpp/rails/application_mailer.rb
+- app/models/ocpp/rails/application_record.rb
+- app/models/ocpp/rails/authorization.rb
+- app/models/ocpp/rails/charge_point.rb
+- app/models/ocpp/rails/charging_session.rb
+- app/models/ocpp/rails/message.rb
+- app/models/ocpp/rails/meter_value.rb
+- app/models/ocpp/rails/state_change.rb
+- app/services/ocpp/rails/actions/authorize_handler.rb
+- app/services/ocpp/rails/actions/boot_notification_handler.rb
+- app/services/ocpp/rails/actions/heartbeat_handler.rb
+- app/services/ocpp/rails/actions/meter_values_handler.rb
+- app/services/ocpp/rails/actions/start_transaction_handler.rb
+- app/services/ocpp/rails/actions/status_notification_handler.rb
+- app/services/ocpp/rails/actions/stop_transaction_handler.rb
+- app/services/ocpp/rails/authorization_hook_manager.rb
+- app/services/ocpp/rails/message_handler.rb
+- app/services/ocpp/rails/meter_anomaly_detector.rb
+- app/services/ocpp/rails/protocol.rb
+- app/services/ocpp/rails/rate_limiter.rb
+- app/services/ocpp/rails/state_change_hook_manager.rb
+- app/services/ocpp/rails/station_authenticator.rb
+- app/services/ocpp/rails/timestamp_parser.rb
+- config/routes.rb
+- db/migrate/20251008162902_create_ocpp_models.rb
+- db/migrate/20251015190754_make_charging_session_id_nullable_in_meter_values.rb
+- db/migrate/20251016000000_create_ocpp_state_changes.rb
+- db/migrate/20251017000000_create_ocpp_authorizations.rb
+- db/migrate/20260707000000_add_timestamp_provenance_to_ocpp_meter_values.rb
+- db/migrate/20260707000001_convert_ocpp_transaction_id_to_integer.rb
+- db/migrate/20260707000002_add_active_session_guard_to_ocpp_charging_sessions.rb
+- db/migrate/20260707000003_add_anomaly_flags_to_ocpp_meter_values.rb
+- db/migrate/20260707000004_add_auth_password_digest_to_ocpp_charge_points.rb
+- lib/generators/ocpp/rails/install_generator.rb
+- lib/generators/ocpp/rails/templates/README
+- lib/generators/ocpp/rails/templates/create_ocpp_charge_points.rb
+- lib/generators/ocpp/rails/templates/create_ocpp_charging_sessions.rb
+- lib/generators/ocpp/rails/templates/create_ocpp_messages.rb
+- lib/generators/ocpp/rails/templates/create_ocpp_meter_values.rb
+- lib/generators/ocpp/rails/templates/ocpp_rails.rb
+- lib/ocpp/rails.rb
+- lib/ocpp/rails/engine.rb
+- lib/ocpp/rails/version.rb
+- lib/tasks/ocpp/authorizations.rake
+- lib/tasks/ocpp/rails_tasks.rake
+- lib/tasks/ocpp/state_changes.rake
+homepage: https://github.com/trahfo/ocpp-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/trahfo/ocpp-rails
+  source_code_uri: https://github.com/trahfo/ocpp-rails/tree/main
+  changelog_uri: https://github.com/trahfo/ocpp-rails/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/trahfo/ocpp-rails/issues
+  documentation_uri: https://github.com/trahfo/ocpp-rails/blob/main/README.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Rails engine that provides OCPP 1.6 communication for EV charging stations
+test_files: []