Extract method for default daily API limit

openaustralia · Aug 8, 2024 · 968ffe4 · 968ffe4
1 parent fcea1d4
commit 968ffe4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/app/models/api_key.rb b/app/models/api_key.rb
@@ -17,13 +17,18 @@ def self.find_valid(value)
     ApiKey.find_by(value:, disabled: false)
   end
 
+  # By default we allow up to 1000 API requests per day per API key
+  sig { returns(Integer) }
+  def self.default_daily_limit
+    1000
+  end
+
   # Returns the daily limit for a given API key value. If no daily limit
   # is set will return the default daily limit. Also, if an invalid key is given it
   # will return the default daily limit as well.
-  # By default we allow up to 1000 API requests per day per API key
   sig { params(value: String).returns(Integer) }
   def self.daily_limit_with_default(value)
-    ApiKey.find_valid(value)&.daily_limit || 1000
+    ApiKey.find_valid(value)&.daily_limit || ApiKey.default_daily_limit
   end
 
   private

diff --git a/app/views/documentation/api_howto.html.erb b/app/views/documentation/api_howto.html.erb
@@ -192,7 +192,7 @@
       Also, please
       <%= pa_link_to "get in touch", documentation_contact_path(reason: "I want API access or commercial use") %>
       if you intend to use the service on a large scale.
-      In order to maintain quality of service for our API users, this service is rate limited by default to approximately 1000 requests per day.
+      In order to maintain quality of service for our API users, this service is rate limited by default to approximately <%= ApiKey.default_daily_limit %> requests per day.
     </p>
     <p class="mt-8">
       We offer a range of paid options, from rate&ndash;limited to unlimited use of this service.