active_hashcash 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a52910cc5af45ca4b31ce6af112ce45a4ec401e584d80076aa50247f9dfc154
-  data.tar.gz: 03ca632ff343a29d9841cb950684c693b4d7684b1bd42251731fea8f8f1c36c8
+  metadata.gz: 81d808ca54efb58e16c61524bde0aee355f5a7b003ef4cb6cda2e9b672c7a284
+  data.tar.gz: 6ec6f99dd02e353bb4e86bb9db8e65ecf35dc46e13051e401b62608700b7fde5
 SHA512:
-  metadata.gz: b2758deaf12537653c08a27a988aa18e13449975caaf73e854a39ad5011eca63430ac1eb019d9dc5bb66d415a0d8975a0908c833056d0422fdf8a1b192d3316e
-  data.tar.gz: 579afe8ab7e448ffd550882fad8b4c8e724be3ec5ab043aac57c49463097a738cf66fd9700193d4f418a01f6ffb03d29510d5593b4800c659548abce968f81fc
+  metadata.gz: 17f8b181f15b009b850fea2e1ead3a5cb904218d8877b31d9b6a2e5f2578972a6a1a2837cdbda46013987911a88198d543dd7f3a79f68b455a969a005a3fbfc8
+  data.tar.gz: 2b02561bf0516b2accb42ac64fe8d93b7bf956bb9474fcadec93db08f4be551d9eea430884d133d08b92156a9d10440ac8f48067207c95d3b72e4268752748dd

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## 0.2.0 - 2022-08-02
+
+- Add ActiveHashcash::Store#clean to removed expired stamps
 
 ## [0.1.1] - 2022-07-08
 

data/README.md

@@ -66,6 +66,8 @@ You must have Redis in order to prevent double spent stamps. Otherwise it will b
 It automatically tries to connect with the environement variables `ACTIVE_HASHCASH_REDIS_URL` or `REDIS_URL`.
 You can also manually set the URL with `ActiveHashcash.redis_url = redis://user:password@localhost:6379`.
 
+You should call `ActiveHashcash::Store#clean` once a day, to remove expired stamps.
+
 ## Complexity
 
 Complexity is the most important parameter. By default its value is 20 and requires most of the time 5 to 20 seconds to be solved on a decent laptop.

data/lib/active_hashcash/engine.rb

@@ -0,0 +1,19 @@
+module ActiveHashcash
+  class Engine < ::Rails::Engine
+    config.assets.paths << File.expand_path("../..", __FILE__)
+
+    config.after_initialize { load_translations }
+
+    def load_translations
+      if !I18n.backend.exists?(I18n.locale, "active_hashcash")
+        I18n.backend.store_translations(:de, {active_hashcash: {waiting_label: "Warten auf die Überprüfung ..."}})
+        I18n.backend.store_translations(:en, {active_hashcash: {waiting_label: "Waiting for verification ..."}})
+        I18n.backend.store_translations(:es, {active_hashcash: {waiting_label: "A la espera de la verificación ..."}})
+        I18n.backend.store_translations(:fr, {active_hashcash: {waiting_label: "En attente de vérification ..."}})
+        I18n.backend.store_translations(:it, {active_hashcash: {waiting_label: "In attesa di verifica ..."}})
+        I18n.backend.store_translations(:jp, {active_hashcash: {waiting_label: "検証待ち ..."}})
+        I18n.backend.store_translations(:pt, {active_hashcash: {waiting_label: "À espera de verificação ..."}})
+      end
+    end
+  end
+end

data/lib/active_hashcash/stamp.rb

@@ -0,0 +1,52 @@
+module ActiveHashcash
+  class Stamp
+    attr_reader :version, :bits, :date, :resource, :extension, :rand, :counter
+
+    def self.parse(string)
+      args = string.split(":")
+      new(args[0], args[1], args[2], args[3], args[4], args[5], args[6])
+    end
+
+    def self.mint(resource, options = {})
+      new(
+        options[:version] || 1,
+        options[:bits] || ActiveHashcash.bits,
+        options[:date] || Date.today.strftime("%y%m%d"),
+        resource,
+        options[:ext],
+        options[:rand] || SecureRandom.alphanumeric(16),
+        options[:counter] || 0).work
+    end
+
+    def initialize(version, bits, date, resource, extension, rand, counter)
+      @version = version
+      @bits = bits.to_i
+      @date = date.respond_to?(:strftime) ? date.strftime("%y%m%d") : date
+      @resource = resource
+      @extension = extension
+      @rand = rand
+      @counter = counter
+    end
+
+    def valid?
+      Digest::SHA1.hexdigest(to_s).hex >> (160-bits) == 0
+    end
+
+    def verify(resource, bits, date)
+      self.resource == resource && self.bits >= bits && parse_date >= date && valid?
+    end
+
+    def to_s
+      [version, bits, date, resource, extension, rand, counter].join(":")
+    end
+
+    def parse_date
+      Date.strptime(date, "%y%m%d")
+    end
+
+    def work
+      @counter += 1 until valid?
+      self
+    end
+  end
+end

data/lib/active_hashcash/store.rb

@@ -0,0 +1,25 @@
+module ActiveHashcash
+  class Store
+    attr_reader :redis
+
+    def initialize(redis = Redis.new(url: ActiveHashcash.redis_url || ENV["ACTIVE_HASHCASH_REDIS_URL"] || ENV["REDIS_URL"]))
+      @redis = redis
+    end
+
+    def add?(stamp)
+      redis.sadd("active_hashcash_stamps_#{stamp.date}", stamp) ? self : nil
+    end
+
+    def clear
+      redis.del(redis.keys("active_hashcash_stamps*"))
+    end
+
+    def clean
+      today = Date.today.strftime("%y%m%d")
+      yesterday = (Date.today - 1).strftime("%y%m%d")
+      keep = ["active_hashcash_stamps_#{today}", "active_hashcash_stamps_#{yesterday}"]
+      keys = redis.keys("active_hashcash_stamps*")
+      redis.del(keys - keep)
+    end
+  end
+end

data/lib/active_hashcash/version.rb

@@ -0,0 +1,3 @@
+module ActiveHashcash
+  VERSION = "0.2.0"
+end

data/lib/active_hashcash.rb

@@ -9,14 +9,22 @@ module ActiveHashcash
 
   mattr_accessor :bits, instance_accessor: false, default: 20
   mattr_accessor :resource, instance_accessor: false
-  mattr_accessor :redis_url, instance_accessor: false
+  mattr_accessor :redis_url, instance_accessor: false, default: ENV["ACTIVE_HASHCASH_REDIS_URL"] || ENV["REDIS_URL"]
+
+  def self.store
+    @store ||= Store.new(Redis.new(url: ActiveHashcash.redis_url))
+  end
+
+  def self.store=(store)
+    @store = store
+  end
 
   # TODO: protect_from_brute_force bits: 20, exception: ActionController::InvalidAuthenticityToken, with: :handle_failed_hashcash
 
   # Call me via a before_action when the form is submitted : `before_action :chech_hashcash, only: :create`
   def check_hashcash
-    if hashcash_stamp_is_valid? && !hashcash_stamp_spent?
-      hashcash_redis.sadd("active_hashcash_stamps".freeze, hashcash_param)
+    stamp = hashcash_param && Stamp.parse(hashcash_param)
+    if stamp && stamp.verify(hashcash_resource, hashcash_bits, Date.yesterday) && ActiveHashcash.store.add?(stamp)
       hashcash_after_success
     else
       hashcash_after_failure
@@ -63,88 +71,8 @@ module ActiveHashcash
     options = {resource: hashcash_resource, bits: hashcash_bits, waiting_message: hashcash_waiting_message}
     hidden_field_tag(name, "", "data-hashcash" => options.to_json)
   end
-
-  def hashcash_redis
-    @hashcash_redis = Redis.new(url: hashcash_redis_url)
-  end
-
-  def hashcash_redis_url
-    ActiveHashcash.redis_url || ENV["ACTIVE_HASHCASH_REDIS_URL"] || ENV["REDIS_URL"]
-  end
-
-  def hashcash_stamp_is_valid?
-    stamp = hashcash_param && Stamp.parse(hashcash_param)
-    stamp && stamp.valid? && stamp.bits >= hashcash_bits && stamp.parse_date >= Date.yesterday
-  end
-
-  def hashcash_stamp_spent?
-    hashcash_redis.sismember("active_hashcash_stamps".freeze, hashcash_param)
-  end
-
-
-
-  class Engine < ::Rails::Engine
-    config.assets.paths << File.expand_path("..", __FILE__)
-
-    config.after_initialize { load_translations }
-
-    def load_translations
-      if !I18n.backend.exists?(I18n.locale, "active_hashcash")
-        I18n.backend.store_translations(:de, {active_hashcash: {waiting_label: "Warten auf die Überprüfung ..."}})
-        I18n.backend.store_translations(:en, {active_hashcash: {waiting_label: "Waiting for verification ..."}})
-        I18n.backend.store_translations(:es, {active_hashcash: {waiting_label: "A la espera de la verificación ..."}})
-        I18n.backend.store_translations(:fr, {active_hashcash: {waiting_label: "En attente de vérification ..."}})
-        I18n.backend.store_translations(:it, {active_hashcash: {waiting_label: "In attesa di verifica ..."}})
-        I18n.backend.store_translations(:jp, {active_hashcash: {waiting_label: "検証待ち ..."}})
-        I18n.backend.store_translations(:pt, {active_hashcash: {waiting_label: "À espera de verificação ..."}})
-      end
-    end
-  end
-
-  class Stamp
-    attr_reader :version, :bits, :date, :resource, :extension, :rand, :counter
-
-    def self.parse(string)
-      args = string.split(":")
-      new(args[0], args[1], args[2], args[3], args[4], args[5], args[6])
-    end
-
-    def self.mint(resource, options = {})
-      new(
-        options[:version] || 1,
-        options[:bits] || ActiveHashcash.bits,
-        options[:date] || Date.today.strftime("%y%m%d"),
-        resource,
-        options[:ext],
-        options[:rand] || SecureRandom.alphanumeric(16),
-        options[:counter] || 0).work
-    end
-
-    def initialize(version, bits, date, resource, extension, rand, counter)
-      @version = version
-      @bits = bits.to_i
-      @date = date.respond_to?(:strftime) ? date.strftime("%y%m%d") : date
-      @resource = resource
-      @extension = extension
-      @rand = rand
-      @counter = counter
-    end
-
-    def valid?
-      Digest::SHA1.hexdigest(to_s).hex >> (160-bits) == 0
-    end
-
-    def to_s
-      [version, bits, date, resource, extension, rand, counter].join(":")
-    end
-
-    def parse_date
-      Date.strptime(date, "%y%m%d")
-    end
-
-    def work
-      @counter += 1 until valid?
-      self
-    end
-  end
 end
+
+require "active_hashcash/stamp"
+require "active_hashcash/store"
+require "active_hashcash/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_hashcash
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexis Bernard
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -50,6 +50,10 @@ files:
 - LICENSE.txt
 - README.md
 - lib/active_hashcash.rb
+- lib/active_hashcash/engine.rb
+- lib/active_hashcash/stamp.rb
+- lib/active_hashcash/store.rb
+- lib/active_hashcash/version.rb
 - lib/hashcash.js
 homepage: https://github.com/BaseSecrete/active_hashcash
 licenses: