twinkle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8ac554f1dff3ef39f4915f981ec076b50702272d4e580fd53c883065b01c430
+  data.tar.gz: dc5f679b7366c31e316f067886298f5408b32d11706bdd56de76a95ad6550685
+SHA512:
+  metadata.gz: 37eaf8576e4d1b47332eb5fd48c082cb08b75df2578bba102308d5d74e550e3964bbae168a462297e4af2b78f9f78d5a9f0cbe1c2041cc9236f38b13d8ebeaa2
+  data.tar.gz: 9fcf89b14a7a6b945fe607af393db115f79d28b29a4d33585844b82009455103871060dffcc41e0017ef597ef6a05a92091410fd012fc30964fb7d1156a25181

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Tim Marks
+
+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,55 @@
+# Twinkle
+
+Twinkle makes it easy to serve up an appcast xml feed and to store anonymized and aggregated Sparkle Framework statistics.
+
+## Usage
+
+You can easily mount Twinkle to manage and serve your Appcast and store and summarize statistics.
+
+Twinkle contains 5 models, an appcast controller and a summarize concern for creating aggregate usage statistics.
+
+Too much trouble hosting your own? Check out [appable.xyz](https://appable.xyz)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "twinkle"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install twinkle
+```
+
+## Install the migrations
+
+```bash
+bin/rails twinkle:install:migrations
+```
+
+## Mount the routes
+
+Add the folllwing to your config/routes
+
+```
+mount Twinkle::Engine => "/"
+```
+
+This will mount the appcast routes at /updates/:app.slug
+
+## Contributing
+
+Pull requests welcome.
+
+## 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,8 @@
+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"

data/app/assets/config/twinkle_manifest.js

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

data/app/assets/stylesheets/twinkle/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/twinkle/appcast_controller.rb

@@ -0,0 +1,25 @@
+module Twinkle
+  class AppcastController < ApplicationController
+    def show
+      @app = App.with_versions.find_by!(slug: params[:slug])
+      Event.create(app: @app, **event_params)
+      render layout: false, formats: :xml
+    end
+
+    private
+
+    def event_params
+      params.permit(
+        :cpu64bit,
+        :ncpu,
+        :appVersion,
+        :cpuFreqMHz,
+        :cputype,
+        :cpusubtype,
+        :ramMB,
+        :osVersion,
+        :lang
+      )
+    end
+  end
+end

data/app/controllers/twinkle/application_controller.rb

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

data/app/helpers/twinkle/application_helper.rb

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

data/app/jobs/twinkle/application_job.rb

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

data/app/mailers/twinkle/application_mailer.rb

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

data/app/models/concerns/summarize.rb

@@ -0,0 +1,44 @@
+module Summarize
+  extend ActiveSupport::Concern
+
+  included do
+    def summarize_events(period, start_date, end_date)
+      # Find or create a summary for the week
+      summary = Twinkle::Summary.with_datapoints.find_or_create_by(app: self, period: period, start_date: start_date, end_date: end_date)
+      data_hash = get_data_hash(start_date, end_date)
+      datapoints = get_datapoints(summary, data_hash)
+      save_summary(datapoints)
+    end
+
+    def get_data_hash(start_date, end_date)
+      data_hash = Twinkle::Summary.empty_datapoints_hash()
+      
+      # We're going to accumulate the data points for the summary
+      events.created_between(start_date, end_date).find_each do |event|
+        data_hash['users']['sessions'] = (data_hash.dig('users', 'sessions') || 0) + 1
+        Twinkle::Event.fields.each do |field|
+          data_hash[field][event[field]] = (data_hash.dig(field, event[field]) || 0) + 1
+        end
+      end
+      data_hash
+    end
+
+    def get_datapoints(summary, data_hash)
+      datapoints = []
+      data_hash.each do |name, values|
+        values.each do |value, count|
+          datapoints << {twinkle_summary_id: summary.id, name: name, value: value, count: count}
+        end
+      end
+      datapoints
+    end
+
+    def save_summary(datapoints)
+      Twinkle::Datapoint.upsert_all(
+        datapoints,
+        unique_by: [:twinkle_summary_id, :name, :value],
+        update_only: [:count]
+      )
+    end
+  end
+end

data/app/models/twinkle/app.rb

@@ -0,0 +1,19 @@
+module Twinkle
+  class App < ApplicationRecord
+    include Summarize
+    
+    has_many :versions, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Version'
+    has_many :events, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Event'
+    has_many :summaries, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Summary'
+    has_one_attached :icon
+
+    scope :with_versions, -> { includes(:versions).order('twinkle_versions.build desc') }
+    scope :with_latest_version, -> { includes(:versions).order('twinkle_versions.build desc').limit(1) }
+    scope :with_latest_summary, -> { includes(:summaries).order('twinkle_summaries.created_at desc').limit(1) }
+    scope :with_summaries_since, ->(date) { includes(:summaries).where('twinkle_summaries.start >= ?', date).order('twinkle_summaries.start asc') }
+
+    validates :name, presence: true
+    validates :slug, presence: true, uniqueness: true
+    validates :description, presence: true
+  end
+end

data/app/models/twinkle/application_record.rb

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

data/app/models/twinkle/datapoint.rb

@@ -0,0 +1,5 @@
+module Twinkle
+  class Datapoint < ApplicationRecord
+    belongs_to :summary, foreign_key: :twinkle_summary_id, class_name: 'Twinkle::Summary'
+  end
+end

data/app/models/twinkle/event.rb

@@ -0,0 +1,15 @@
+module Twinkle
+  class Event < ApplicationRecord
+    belongs_to :app, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::App'
+
+    scope :created_between, -> (start_date, end_date) {where("created_at >= ? AND created_at <= ?", start_date, end_date )}
+
+    alias_attribute :app_version, :version
+    alias_attribute :cpuFreqMHz, :cpu_freq_mhz
+    alias_attribute :osVersion, :os_version
+
+    def self.fields
+      attribute_names.select{ |name| !['id', 'twinkle_app_id', 'created_at', 'updated_at'].include?(name) }
+    end
+  end
+end

data/app/models/twinkle/summary.rb

@@ -0,0 +1,23 @@
+module Twinkle
+  class Summary < ApplicationRecord
+    belongs_to :app, foreign_key: :twinkle_app_id, class_name: 'Twinkle::App'
+    has_many :datapoints, foreign_key: :twinkle_summary_id, class_name: 'Twinkle::Datapoint'
+
+    scope :week_of, -> (start_date, end_date) { where(period: :week).where("start_date >= ? AND end_date <= ?", start_date, end_date) }
+    scope :with_datapoints, -> { includes(:datapoints) }
+
+    enum period: { week: 0, fortnight: 1, month: 2 }
+
+    def hash_datapoints
+      data = Event.fields.map { |name| [name, {}] }.append(['users', {}]).to_h
+      datapoints.each do |datapoint|
+        data[datapoint.name][datapoint.value] = datapoint.count
+      end
+      data
+    end
+
+    def self.empty_datapoints_hash
+      Event.fields.map { |name| [name, {}] }.append(['users', {}]).to_h
+    end
+  end
+end

data/app/models/twinkle/version.rb

@@ -0,0 +1,37 @@
+require 'uri'
+
+module Twinkle
+  class Version < ApplicationRecord
+    belongs_to :app, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::App'
+
+    validates :number, presence: true
+    validates :build, presence: true
+    validates :description, presence: true
+    validates :binary_url, presence: true
+    validates :length, presence: true
+    validates :length, numericality: { only_integer: true, greater_than: 0 }
+
+    # validates that the binary_url is a valid URL
+    validate :binary_url_is_url
+
+    # validates that one of the two signatures is present
+    validate :signature_present
+
+    private 
+
+    def binary_url_is_url
+      begin
+        uri = URI.parse(binary_url)
+        raise URI::InvalidURIError unless uri.is_a?(URI::HTTP) && uri.host.present?
+      rescue URI::InvalidURIError
+        errors.add(:binary_url, "is not a valid URL")
+      end
+    end
+
+    def signature_present
+      if dsa_signature.blank? && ed_signature.blank?
+        errors.add(:base, "At least one of the two signatures must be present")
+      end
+    end
+  end
+end

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

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

data/app/views/twinkle/appcast/show.xml.erb

@@ -0,0 +1,19 @@
+<?xml version="1.0" standalone="yes"?>
+<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" version="2.0">
+    <channel>
+        <title><%= @app.name %></title>
+        <% @app.versions.each do |version| %>
+            <item>
+                <title><%= version.number %></title>
+                <pubDate><%= version.inserted_at %></pubDate>
+                <sparkle:version><%= version.build %></sparkle:version>
+                <sparkle:shortVersionString><%= version.number %></sparkle:shortVersionString>
+                <sparkle:minimumSystemVersion><%= version.min_system_version %></sparkle:minimumSystemVersion>
+                <description>
+                    <%= version.description %>
+                </description>
+                <enclosure url="<%= version.url %>" length="<%= version.length %>" type="application/octet-stream" sparkle:dsaSignature="<%= version.dsa_signature %>" sparkle:edSignature="<%= version.ed_signature %>"/>
+            </item>
+        <% end %>
+    </channel>
+</rss>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Twinkle::Engine.routes.draw do
+  get 'updates/:slug' => 'appcast#show'
+end

data/db/migrate/20240517231834_create_twinkle_apps.rb

@@ -0,0 +1,12 @@
+class CreateTwinkleApps < ActiveRecord::Migration[7.1]
+  def change
+    create_table :twinkle_apps do |t|
+      t.string :name
+      t.string :slug
+      t.string :description
+
+      t.timestamps
+    end
+    add_index :twinkle_apps, :slug, unique: true
+  end
+end

data/db/migrate/20240517232121_create_twinkle_versions.rb

@@ -0,0 +1,17 @@
+class CreateTwinkleVersions < ActiveRecord::Migration[7.1]
+  def change
+    create_table :twinkle_versions do |t|
+      t.references :twinkle_app, null: false, foreign_key: true
+      t.string :number
+      t.string :build
+      t.string :description
+      t.string :binary_url
+      t.string :dsa_signature
+      t.string :ed_signature
+      t.string :length
+
+      t.timestamps
+    end
+    add_index :twinkle_versions, :build
+  end
+end

data/db/migrate/20240517233457_create_twinkle_events.rb

@@ -0,0 +1,19 @@
+class CreateTwinkleEvents < ActiveRecord::Migration[7.1]
+  def change
+    create_table :twinkle_events do |t|
+      t.references :twinkle_app, null: false, foreign_key: true
+      t.string :version
+      t.boolean :cpu64bit
+      t.integer :ncpu
+      t.string :cpu_freq_mhz
+      t.string :cputype
+      t.string :cpusubtype
+      t.string :model
+      t.string :ram_mb
+      t.string :os_version
+      t.string :lang
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20240517234016_create_twinkle_summaries.rb

@@ -0,0 +1,13 @@
+class CreateTwinkleSummaries < ActiveRecord::Migration[7.1]
+  def change
+    create_table :twinkle_summaries do |t|
+      t.references :twinkle_app, null: false, foreign_key: true
+      t.integer :period
+      t.datetime :start_date
+      t.datetime :end_date
+
+      t.timestamps
+    end
+    add_index :twinkle_summaries, [:period, :start_date, :end_date]
+  end
+end

data/db/migrate/20240518000405_create_twinkle_datapoints.rb

@@ -0,0 +1,13 @@
+class CreateTwinkleDatapoints < ActiveRecord::Migration[7.1]
+  def change
+    create_table :twinkle_datapoints do |t|
+      t.references :twinkle_summary, null: false, foreign_key: true
+      t.string :name
+      t.string :value
+      t.integer :count
+
+      t.timestamps
+    end
+    add_index :twinkle_datapoints, [:twinkle_summary_id, :name, :value], unique: true
+  end
+end

data/lib/tasks/twinkle_tasks.rake

@@ -0,0 +1,14 @@
+# desc "Explaining what the task does"
+# task :twinkle do
+#   # Task goes here
+# end
+
+desc "Summarize Twinkle Events in the week period"
+task :summarize_twinkle_events_week do
+  week_start = Time.now.beginning_of_week
+  week_end = Time.now.end_of_week
+  
+  Apps.all.each do |app|
+    app.summarize_events(Summary.period[:week], week_start, week_end)
+  end
+end

data/lib/twinkle/engine.rb

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

data/lib/twinkle/version.rb

@@ -0,0 +1,3 @@
+module Twinkle
+  VERSION = "0.1.0"
+end

data/lib/twinkle.rb

@@ -0,0 +1,6 @@
+require "twinkle/version"
+require "twinkle/engine"
+
+module Twinkle
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: twinkle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Marks
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0.0
+description: Twinkle is a Rails engine for hosting appcast and collecting anonymous
+  sparkle-project usage data.
+email:
+- t@imothee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/twinkle_manifest.js
+- app/assets/stylesheets/twinkle/application.css
+- app/controllers/twinkle/appcast_controller.rb
+- app/controllers/twinkle/application_controller.rb
+- app/helpers/twinkle/application_helper.rb
+- app/jobs/twinkle/application_job.rb
+- app/mailers/twinkle/application_mailer.rb
+- app/models/concerns/summarize.rb
+- app/models/twinkle/app.rb
+- app/models/twinkle/application_record.rb
+- app/models/twinkle/datapoint.rb
+- app/models/twinkle/event.rb
+- app/models/twinkle/summary.rb
+- app/models/twinkle/version.rb
+- app/views/layouts/twinkle/application.html.erb
+- app/views/twinkle/appcast/show.xml.erb
+- config/routes.rb
+- db/migrate/20240517231834_create_twinkle_apps.rb
+- db/migrate/20240517232121_create_twinkle_versions.rb
+- db/migrate/20240517233457_create_twinkle_events.rb
+- db/migrate/20240517234016_create_twinkle_summaries.rb
+- db/migrate/20240518000405_create_twinkle_datapoints.rb
+- lib/tasks/twinkle_tasks.rake
+- lib/twinkle.rb
+- lib/twinkle/engine.rb
+- lib/twinkle/version.rb
+homepage: https://github.com/imothee/twinkle
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/imothee/twinkle
+  source_code_uri: https://github.com/imothee/twinkle
+  changelog_uri: https://github.com/imothee/twinkle/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Twinkle is a Rails engine for hosting appcast and collecting anonymous sparkle-project
+  usage data.
+test_files: []