api_analytics 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bee24da4758d197c43e6ef9eb7ff23b51ecb233e1a86c6f9ce10deea06627af1
-  data.tar.gz: 917ca40b90ded5d83a6b01b74637ab455d72393fd3f7717e36eec82391086a4a
+  metadata.gz: 6c4d318b3d83025f43ba07d133256ce35d250466f876f4c2924a133cac7f2806
+  data.tar.gz: 793e0d8437796cb2b1ad3db61b1b39b4294b811db599a21c151ec5f088b00a36
 SHA512:
-  metadata.gz: 9653b4934817f940483f1203f0e2515edefacd8e2b2608e1860e41682ae75a5c62f92aa486fa74b40a004ed8fa61a9f9460b5d4c36ff9cdeff0438b54f97a9f7
-  data.tar.gz: 85cff895667d068ec7366c75e7c5031d56c9ff249469fcc681a5a7affcd8310e84bc9e4b1d4b524c4fd17647224035a820c48fbfe1c0400612c28e64948958fd
+  metadata.gz: ea85b0e60ad7a9e796dd1a406f3eff0a81149073b5f0e019c7b4f2eec26b932c92063490e49b74422400f6e45e5e1cccbed2f7b1ede7d42e649342925d0f31ca
+  data.tar.gz: 37ab6d51c091c4aa7c3e56d42c2eb0c7dc17529a855ab3d1a18c947731f1f3036042f989fffa7c593d4061fb37cced5d2bbf2395114d695e0ab5cc8268ddce59

data/README.md

@@ -1,43 +1,49 @@
-# 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'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
+### 2. Add middleware to your API
 
-    $ gem install api_analytics
+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.
 
-## Usage
+```bash
+gem install api_analytics
+```
 
-TODO: Write usage instructions here
+#### Rails
 
-## Development
+Assign your API key to `ANALYTICS_API_KEY` in `config/secrets.yml`.
 
-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.
+```yml
+development:
+  ANALYTICS_API_KEY: <api_key>
+production:
+  ANALYTICS_API_KEY: <api_key>
+```
 
-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).
+Require `api_analytics` and add the analytics middleware to your rails application in `config/application.rb`.
 
-## Contributing
+```ruby
+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).
+Bundler.require(*Rails.groups)
 
-## License
+module RailsMiddleware
+  class Application < Rails::Application
+    config.load_defaults 6.1
+    config.api_only = true
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+    config.middleware.use ::Analytics::Middleware  # Add middleware
+  end
+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.0"
+  VERSION = "1.0.2"
 end

data/lib/api_analytics.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
+require 'uri'
 require 'net/http'
 require 'json'
-require_relative "analytics/version"
 
 module Analytics
   class Middleware
@@ -16,7 +16,7 @@ module Analytics
       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 +28,7 @@ module Analytics
       }
 
       Thread.new {
-        log_request(json)
+        log_request(data)
       }
 
       [status, headers, response]
@@ -36,16 +36,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.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Tom Draper