api_analytics 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74c59a8430be151e1152d5c6d7aaff920463d867b765dad9141a377fb5433b75
-  data.tar.gz: 3674f6152cd22705c436eef36eedf34c098740886c13c1371f186e2081540d56
+  metadata.gz: '098d01b85d0fcc21c62cfd725e9627023215347bf514984ce32439c8ad14b032'
+  data.tar.gz: 0e9afbc15ee1ffd011c344fb9fded1afeba64381b1040e5e01b42ef422dc5d5a
 SHA512:
-  metadata.gz: 9668fc53760f84fa9616303688f12e013d17680acaf18d6c8ed5438a879e32382c324d2b029c38827d9e88e063b70a3fa100bb059f9517af536e9dd3cd1e5a76
-  data.tar.gz: bdea3236c660f800c3d546855731ebae30ed61c46703ef775419ddb809c5eb35cc28079f65cfa60a55f09a60a3dffc1be861b9f2d514c6776056eff39a8049e9
+  metadata.gz: 452d37e57dbcb9fa71fff792238de09f49bc3f0cb6538417478087b553f8dd18bfadeaaca2757706f15872e01ea693d0bcfa0824c4867b8b557febd9de8cab54
+  data.tar.gz: 5dc72c197e4d12fcabcfa4e12f1a7f42e1f7d0496095ccde7e981b2d12d64a0e02cd48e1167355c194ac3ed1526696b7fc221e773efe1cef2c3809ad94ce8648

data/README.md

@@ -1,43 +1,58 @@
-# ApiAnalytics
+# API Analytics
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api_analytics`. To experiment with that code, run `bin/console` for an interactive prompt.
+A lightweight API analytics solution, complete with a dashboard.
 
-TODO: Delete this and the text above, and describe your gem
+## Getting Started
 
-## Installation
+### 1. Generate a new API key
 
-Add this line to your application's Gemfile:
+Head to https://my-api-analytics.vercel.app/generate to generate your unique API key with a single click. This key is used to monitor your specific API, so keep it secret! It's also required in order to view your APIs analytics dashboard.
 
-```ruby
-gem 'api_analytics'
-```
+### 2. Add middleware to your API
 
-And then execute:
+Add our lightweight middleware to your API. Almost all processing is handled by our servers so there should be virtually no impact on your APIs performance.
 
-    $ bundle install
+```bash
+gem install api_analytics
+```
 
-Or install it yourself as:
+#### Rails
 
-    $ gem install api_analytics
+Add the analytics middleware to your rails application in `config/application.rb`.
 
-## Usage
+```ruby
+require 'rails'
+require 'api_analytics'
 
-TODO: Write usage instructions here
+Bundler.require(*Rails.groups)
 
-## Development
+module RailsMiddleware
+  class Application < Rails::Application
+    config.load_defaults 6.1
+    config.api_only = true
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    config.middleware.use ::Analytics::Middleware, <api_key> # Add middleware
+  end
+end
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### Sinatra
 
-## Contributing
+```ruby
+require 'sinatra'
+require 'api_analytics'
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_analytics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/api_analytics/blob/master/CODE_OF_CONDUCT.md).
+use Analytics::Middleware, <api_key>
 
-## License
+before do
+    content_type 'application/json'
+end
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+get '/' do
+    {message: 'Hello World!'}.to_json
+end
+```
 
-## Code of Conduct
+### 3. View your analytics
 
-Everyone interacting in the ApiAnalytics project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/api_analytics/blob/master/CODE_OF_CONDUCT.md).
+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.1"
+  VERSION = "1.0.3"
 end

data/lib/api_analytics.rb

@@ -1,22 +1,21 @@
 # frozen_string_literal: true
 
+require 'uri'
 require 'net/http'
 require 'json'
-require_relative "api_analytics/version"
 
 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)
       start = Time.now
       status, headers, response = @app.call(env)
 
-      json = {
+      data = {
         api_key: @api_key,
         hostname: env['HTTP_HOST'],
         path: env['REQUEST_PATH'],
@@ -28,7 +27,7 @@ module Analytics
       }
 
       Thread.new {
-        log_request(json)
+        log_request(data)
       }
 
       [status, headers, response]
@@ -36,16 +35,12 @@ module Analytics
 
     private
 
-    def log_request(json)
+    def log_request(data)
       uri = URI('https://api-analytics-server.vercel.app/api/log-request')
-      http = Net::HTTP.new(uri.host, uri.port)
-      Rails.logger.info("#{uri.host} #{uri.port} #{uri.path}")
-      req = Net::HTTP::Post.new(uri.path, 'Content-Type' => 'application/json')
-      req.body = json.to_json
-      res = http.request(req)
-    rescue => e
+      res = Net::HTTP.post(uri, data.to_json)
     end
   end
 end
 
 
+

metadata

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