twinkle 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8ac554f1dff3ef39f4915f981ec076b50702272d4e580fd53c883065b01c430
-  data.tar.gz: dc5f679b7366c31e316f067886298f5408b32d11706bdd56de76a95ad6550685
+  metadata.gz: 745ebe3beb30463d26dc3801ec74938b03ae089d267586d90ff736872a5bcbca
+  data.tar.gz: 678c0fadd35d1798fd7f1f69fc1ba9d170f7f12c3b3099311d96a1fd56f7bae8
 SHA512:
-  metadata.gz: 37eaf8576e4d1b47332eb5fd48c082cb08b75df2578bba102308d5d74e550e3964bbae168a462297e4af2b78f9f78d5a9f0cbe1c2041cc9236f38b13d8ebeaa2
-  data.tar.gz: 9fcf89b14a7a6b945fe607af393db115f79d28b29a4d33585844b82009455103871060dffcc41e0017ef597ef6a05a92091410fd012fc30964fb7d1156a25181
+  metadata.gz: a80e569a9be8977f3447583de2e030ccf45341a25bc60a845b02766be74b7dadf19f4aa5314d6dcdd2f935d44efadf2c668ea5f43c55cc0ce7c10115bd3d14d3
+  data.tar.gz: a11ac6363d06444ef8aa07ca5173e8c1770ce44295ab89ca32505c0140565244b2a118a2bdac1ccccf546cd04d9ac1e8dea0040c33649691846bbad606c4de1c

data/README.md

@@ -46,10 +46,37 @@ mount Twinkle::Engine => "/"
 
 This will mount the appcast routes at /updates/:app.slug
 
+## Extending Twinkle Apps
+
+You can extend the Twinkle::App model by creating app/models/twinkle/app.rb
+
+```ruby
+class Twinkle::App < ApplicationRecord
+  include Twinkle::Concerns::Models::App
+  include Summarize
+
+  # Your custom app code and validations etc go here
+end
+```
+
 ## Contributing
 
 Pull requests welcome.
 
+## Testing
+
+```bash
+bin/rails db:test:prepare
+bin/test
+```
+
+## Building the gem
+
+```bash
+gem build
+gem push twinkle-x.x.x.gem
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/twinkle/appcast_controller.rb

@@ -1,7 +1,7 @@
 module Twinkle
   class AppcastController < ApplicationController
     def show
-      @app = App.with_versions.find_by!(slug: params[:slug])
+      @app = App.includes(:versions).find_by!(slug: params[:slug])
       Event.create(app: @app, **event_params)
       render layout: false, formats: :xml
     end

data/app/models/concerns/summarize.rb

@@ -4,7 +4,7 @@ module Summarize
   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)
+      summary = Twinkle::Summary.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)
@@ -17,7 +17,7 @@ module Summarize
       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
+          data_hash[field][event[field]] = (data_hash.dig(field, event[field]) || 0) + 1 if event[field].present?
         end
       end
       data_hash

data/app/models/twinkle/app.rb

@@ -1,19 +1,6 @@
 module Twinkle
   class App < ApplicationRecord
+    include Twinkle::Concerns::Models::App
     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/summary.rb

@@ -1,10 +1,13 @@
 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'
+    has_many :datapoints, foreign_key: :twinkle_summary_id, class_name: 'Twinkle::Datapoint', dependent: :delete_all
 
+    # Virtual relationships
+    has_one :latest_user_summary, -> { where(name: 'users').order('twinkle_datapoints.value desc').limit(1) }, foreign_key: :twinkle_summary_id, class_name: 'Twinkle::Datapoint'
+
+    scope :since, ->(date) { where('twinkle_summaries.start_date >= ?', date).order('twinkle_summaries.start_date asc') }
     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 }
 

data/app/models/twinkle/version.rb

@@ -5,27 +5,40 @@ module Twinkle
     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 :build, numericality: { only_integer: true, greater_than: 0 }
+    validates :description, presence: true, if: -> { published }
+    validates :binary_url, presence: true, if: -> { published }
+    validates :length, presence: true, if: -> { published }
+    validates :length, numericality: { only_integer: true, greater_than: 0 }, allow_blank: true
+    validates :phased_rollout_interval, numericality: { only_integer: true, greater_than: 0 }, allow_blank: true
 
     # validates that the binary_url is a valid URL
     validate :binary_url_is_url
 
+    # validates that the release_notes_link is a valid URL
+    validate :release_notes_link_is_url
+
+    # validates that the full_release_notes_link is a valid URL
+    validate :full_release_notes_link_is_url
+
     # validates that one of the two signatures is present
-    validate :signature_present
+    validate :signature_present, if: -> { published }
 
     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
+      return true if binary_url.blank?
+      errors.add(:binary_url, "is not a valid URL") unless is_url?(binary_url)
+    end
+
+    def release_notes_link_is_url
+      return true if release_notes_link.blank?
+      errors.add(:release_notes_link, "is not a valid URL") unless is_url?(release_notes_link)
+    end
+
+    def full_release_notes_link_is_url
+      return true if full_release_notes_link.blank?
+      errors.add(:full_release_notes_link, "is not a valid URL") unless is_url?(full_release_notes_link)
     end
 
     def signature_present
@@ -33,5 +46,13 @@ module Twinkle
         errors.add(:base, "At least one of the two signatures must be present")
       end
     end
+
+    private
+    def is_url?(url)
+      uri = URI.parse(url)
+      uri.is_a?(URI::HTTP) && uri.host.present?
+    rescue URI::InvalidURIError
+      false
+    end
   end
 end

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

@@ -5,14 +5,54 @@
         <% @app.versions.each do |version| %>
             <item>
                 <title><%= version.number %></title>
-                <pubDate><%= version.inserted_at %></pubDate>
+                <pubDate><%= version.published_at.strftime("%a, %d %b %Y %H:%M:%S %z") %></pubDate>
                 <sparkle:version><%= version.build %></sparkle:version>
                 <sparkle:shortVersionString><%= version.number %></sparkle:shortVersionString>
+                <% if version.link.present? %>
+                <link><%= version.link %></link>
+                <% end %>
+                <% if version.channel.present? %>
+                <sparkle:channel><%= version.channel %></sparkle:channel>
+                <% end %>
+                <% if version.release_notes_link.present? %>
+                <sparkle:releaseNotesLink><%= version.release_notes_link %></sparkle:releaseNotesLink>
+                <% end %>
+                 <% if version.full_release_notes_link.present? %>
+                <sparkle:fullReleaseNotesLink><%= version.full_release_notes_link %></sparkle:fullReleaseNotesLink>
+                <% end %>
+                <% if version.min_system_version.present? %>
                 <sparkle:minimumSystemVersion><%= version.min_system_version %></sparkle:minimumSystemVersion>
+                <% end %>
+                <% if version.max_system_version.present? %>
+                <sparkle:maximumSystemVersion><%= version.max_system_version %></sparkle:maximumSystemVersion>
+                <% end %>
+                <% if version.minimum_auto_update_version.present? %>
+                <sparkle:minimumAutoupdateVersion><%= version.minimum_auto_update_version %></sparkle:minimumAutoupdateVersion>
+                <% end %>
+                <% if version.ignore_skipped_upgrades_below_version.present? %>
+                <sparkle:ignoreSkippedUpgradesBelowVersion><%= version.ignore_skipped_upgrades_below_version %></sparkle:ignoreSkippedUpgradesBelowVersion>
+                <% end %>
+                <% if version.informational_update_below_version.present? %>
+                <sparkle:informationalUpdate>
+                    <sparkle:belowVersion><%= version.informational_update_below_version %></sparkle:belowVersion>
+                </sparkle:informationalUpdate>
+                <% end %>
+                <% if version.critical %>
+                <% if version.sparkle_two %>
+                <sparkle:criticalUpdate<%= version.critical_version.present? ? raw(" sparkle:version=\"#{version.critical_version}\"") : "" %>></sparkle:criticalUpdate>
+                <% else %>
+                <sparkle:tags>
+                <sparkle:criticalUpdate></sparkle:criticalUpdate>
+                </sparkle:tags>
+                <% end %>
+                <% end %>
+                <% if version.phased_rollout_interval.present? %>
+                <sparkle:phasedRolloutInterval><%= version.phased_rollout_interval %></sparkle:phasedRolloutInterval>
+                <% end %>
                 <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 %>"/>
+                <enclosure url="<%= version.binary_url %>" length="<%= version.length %>" type="application/octet-stream" sparkle:dsaSignature="<%= version.dsa_signature %>" sparkle:edSignature="<%= version.ed_signature %>"/>
             </item>
         <% end %>
     </channel>

data/db/migrate/20240517232121_create_twinkle_versions.rb

@@ -12,6 +12,6 @@ class CreateTwinkleVersions < ActiveRecord::Migration[7.1]
 
       t.timestamps
     end
-    add_index :twinkle_versions, :build
+    add_index :twinkle_versions, [:twinkle_app_id, :build], unique: true
   end
 end

data/db/migrate/20240517234016_create_twinkle_summaries.rb

@@ -8,6 +8,6 @@ class CreateTwinkleSummaries < ActiveRecord::Migration[7.1]
 
       t.timestamps
     end
-    add_index :twinkle_summaries, [:period, :start_date, :end_date]
+    add_index :twinkle_summaries, [:period, :start_date, :end_date], unique: true
   end
 end

data/db/migrate/20240530023848_add_published_to_twinkle_versions.rb

@@ -0,0 +1,6 @@
+class AddPublishedToTwinkleVersions < ActiveRecord::Migration[7.1]
+  def change
+    add_column :twinkle_versions, :published, :boolean, default: false, null: false
+    add_index :twinkle_versions, [:twinkle_app_id, :published]
+  end
+end

data/db/migrate/20240626232135_add_fields_to_twinkle_versions.rb

@@ -0,0 +1,19 @@
+class AddFieldsToTwinkleVersions < ActiveRecord::Migration[7.1]
+  def change
+    add_column :twinkle_versions, :sparkle_two, :boolean, default: true
+    add_column :twinkle_versions, :link, :string
+    add_column :twinkle_versions, :min_system_version, :string
+    add_column :twinkle_versions, :max_system_version, :string
+    add_column :twinkle_versions, :minimum_auto_update_version, :string
+    add_column :twinkle_versions, :ignore_skipped_upgrades_below_version, :string
+    add_column :twinkle_versions, :informational_update_below_version, :string
+    add_column :twinkle_versions, :critical, :boolean, default: false
+    add_column :twinkle_versions, :critical_version, :string
+    add_column :twinkle_versions, :phased_rollout_interval, :integer
+    add_column :twinkle_versions, :channel, :string
+    add_column :twinkle_versions, :release_notes_link, :string
+    add_column :twinkle_versions, :full_release_notes_link, :string
+    add_column :twinkle_versions, :published_at, :datetime
+    change_column :twinkle_versions, :build, :integer, using: 'build::integer'
+  end
+end

data/lib/twinkle/concerns/models/app.rb

@@ -0,0 +1,24 @@
+module Twinkle
+  module Concerns
+    module Models
+      module App
+        extend ActiveSupport::Concern
+
+        included do
+          has_many :versions,  -> { order('twinkle_versions.build desc') }, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Version', dependent: :destroy
+          has_many :events, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Event', dependent: :delete_all
+          has_many :summaries, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Summary', dependent: :destroy
+          has_one_attached :icon
+
+          # Virtual relationships
+          has_one :latest_version, -> { order('twinkle_versions.build desc').limit(1) }, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Version'
+          has_one :latest_weekly_summary, -> { where(period: :week).order('twinkle_summaries.start_date desc').limit(1) }, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Summary'
+
+          validates :name, presence: true
+          validates :slug, presence: true, uniqueness: true
+          validates :description, presence: true
+        end
+      end
+    end
+  end
+end

data/lib/twinkle/version.rb

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

data/lib/twinkle.rb

@@ -1,5 +1,6 @@
 require "twinkle/version"
 require "twinkle/engine"
+require "twinkle/concerns/models/app"
 
 module Twinkle
   # Your code goes here...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twinkle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tim Marks
@@ -57,12 +57,16 @@ files:
 - db/migrate/20240517233457_create_twinkle_events.rb
 - db/migrate/20240517234016_create_twinkle_summaries.rb
 - db/migrate/20240518000405_create_twinkle_datapoints.rb
+- db/migrate/20240530023848_add_published_to_twinkle_versions.rb
+- db/migrate/20240626232135_add_fields_to_twinkle_versions.rb
 - lib/tasks/twinkle_tasks.rake
 - lib/twinkle.rb
+- lib/twinkle/concerns/models/app.rb
 - lib/twinkle/engine.rb
 - lib/twinkle/version.rb
 homepage: https://github.com/imothee/twinkle
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/imothee/twinkle
@@ -83,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Twinkle is a Rails engine for hosting appcast and collecting anonymous sparkle-project