api_analytics 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c4d318b3d83025f43ba07d133256ce35d250466f876f4c2924a133cac7f2806
-  data.tar.gz: 793e0d8437796cb2b1ad3db61b1b39b4294b811db599a21c151ec5f088b00a36
+  metadata.gz: e63c1589bb56b02570e9ae05d9f38ca68bb604ef071084f49638b9ff7cc7e90a
+  data.tar.gz: e468852d2153f6827c8359aceb349884c21e00766b8efbc4895057b89e26318a
 SHA512:
-  metadata.gz: ea85b0e60ad7a9e796dd1a406f3eff0a81149073b5f0e019c7b4f2eec26b932c92063490e49b74422400f6e45e5e1cccbed2f7b1ede7d42e649342925d0f31ca
-  data.tar.gz: 37ab6d51c091c4aa7c3e56d42c2eb0c7dc17529a855ab3d1a18c947731f1f3036042f989fffa7c593d4061fb37cced5d2bbf2395114d695e0ab5cc8268ddce59
+  metadata.gz: 25be82084145978d624eb701f84dfe0639ba5c405011b55398f6da5a0e788d4ed87322bd9253002ed9528ac3e757e709a393962327f3864bb7f696a161245c89
+  data.tar.gz: d65d9b770e3640008a9243dba26d07722bd47acbf786e571c984f2c568f40e2bb2a94d973c667fbe0c02545d091d523663687b26c88e1437bf1fbe3576b6a634

data/README.md

@@ -18,19 +18,11 @@ gem install api_analytics
 
 #### Rails
 
-Assign your API key to `ANALYTICS_API_KEY` in `config/secrets.yml`.
-
-```yml
-development:
-  ANALYTICS_API_KEY: <api_key>
-production:
-  ANALYTICS_API_KEY: <api_key>
-```
-
-Require `api_analytics` and add the analytics middleware to your rails application in `config/application.rb`.
+Add the analytics middleware to your rails application in `config/application.rb`.
 
 ```ruby
-require "api_analytics"
+require 'rails'
+require 'api_analytics'
 
 Bundler.require(*Rails.groups)
 
@@ -39,11 +31,28 @@ module RailsMiddleware
     config.load_defaults 6.1
     config.api_only = true
 
-    config.middleware.use ::Analytics::Middleware  # Add middleware
+    config.middleware.use ::Analytics::Rails, <api_key> # Add middleware
   end
 end
 ```
 
+#### Sinatra
+
+```ruby
+require 'sinatra'
+require 'api_analytics'
+
+use Analytics::Sinatra, <api_key>
+
+before do
+    content_type 'application/json'
+end
+
+get '/' do
+    {message: 'Hello World!'}.to_json
+end
+```
+
 ### 3. View your analytics
 
 Your API will log requests on all valid routes. Head over to https://my-api-analytics.vercel.app/dashboard and paste in your API key to view your dashboard.

data/lib/api_analytics/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Analytics
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/api_analytics.rb

@@ -6,10 +6,9 @@ require 'json'
 
 module Analytics
   class Middleware
-    def initialize(app)
+    def initialize(app, api_key)
       @app = app
-      @api_key = Rails.application.secrets.ANALYTICS_API_KEY
-      raise StandardError.new 'ANALYTICS_API_KEY secret unset.' if @api_key.nil?
+      @api_key = api_key
     end
 
     def call(env)
@@ -23,7 +22,7 @@ module Analytics
         user_agent: env['HTTP_USER_AGENT'],
         method: env['REQUEST_METHOD'],
         status: status,
-        framework: "Rails",
+        framework: @framework,
         response_time: (Time.now - start).to_f.round,
       }
 
@@ -41,6 +40,22 @@ module Analytics
       res = Net::HTTP.post(uri, data.to_json)
     end
   end
+
+  private_constant :Middleware
+  
+  class Rails < Middleware
+    def initialize(app, api_key)
+      super(app, api_key)
+      @framework = "Rails"
+    end
+  end
+
+  class Sinatra < Middleware
+    def initialize(app, api_key)
+      super(app, api_key)
+      @framework = "Sinatra"
+    end
+  end
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_analytics
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Tom Draper