callcounter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70bca5d8cccd13dc7e49b588c2da40b4ca0312b04732ca21d4a28f1265d9deed
-  data.tar.gz: 0ab8f77ab9fb23395bd28a479dbb16f3223ec20695514d73eaee5832c2f2c79d
+  metadata.gz: 694f83b9c21262d809ab3d266ff011d8f75c2a45b8260a6a6887ede4f1c360e5
+  data.tar.gz: 1e83328f50e2bd7e6bed1230fdee6e27cba10b6d28e7cebc8dda449835598867
 SHA512:
-  metadata.gz: 77436a39409401c6781d2ad2c82ed52737a4fcaaea40bca81a98cbb2f4e110df81d54298e1d3786ff2c59449959b74a26be667a6284b8afbdada373e41bd07d2
-  data.tar.gz: ea6c438f1f8d8abc6edbfa1c70cbb28c6113054da09ea2eaac0636fcf2dcea00ac845c5a7c6ee9a838253546fded12d19f531d1ed7081e2a6c0b4fca1e11259c
+  metadata.gz: 9b999f9fc145d1b6691d0ba32d1344f8396df52efaa53973d2953abf0a38d471238ad61c6b0c536a3a5bad814538bade3046a29b9569ee22cf7a9b727013a57f
+  data.tar.gz: 285d154f5da3904ccd4bf6750254061fe26e0c6ea8b9ef7a6ace9f2513e6eefcf94145c494a483f82a69645796e4bcfd916fe1af362fd95bd56d9d6c407bd2bb

data/README.md

@@ -2,18 +2,39 @@
 
 # Callcounter Ruby integration gem
 
-This gem can be used to gather API request & response data from Rack based applications.
+This gem can be used to gather API request & response data from Rack based applications and send it to Callcounter.
+
+Callcounter is an API analytics platform that collect information about requests (calls) to your API using so-called
+integrations. Integrations come in the form of a Ruby gem, a Nuget package, a Pip module, etcetera. The integrations
+can send the data to Callcounter using an API, which is described at: https://callcounter.eu/pages/api
+
+After collection data, the web interface can then be used to view all kinds of metrics, giving you insight in the
+(mis)usage of your API.
 
 ## Install
 
-When using bundler, simply add the following line to your Gemfile:
+### Bundler
+
+When using bundler, simply add the following line to your Gemfile and run `bundle`:
 
 ```ruby
 gem 'callcounter'
 ```
 
-Run `bundle install` in your project directory and create an initializer
-`config/initializers/callcounter.rb` with the following content:
+### Other
+
+Install the gem with: `gem install callcounter`. Next, add the following call to your entry file in order to activate
+the Rack middleware:
+
+```ruby
+use Callcounter::Capturer
+```
+
+## Configure what to capture
+
+Configure callcounter with the following code, this can be placed in a Rails initializer when using Ruby on Rails,
+for example `config/initializers/callcounter.rb`, or somewhere in your entry point file when using Sinatra or other
+Rack based frameworks:
 
 ```ruby
 Callcounter.configure do |config|
@@ -21,13 +42,12 @@ Callcounter.configure do |config|
 end
 ```
 
-After deploying you should start seeing data in Callcounter. Note that this might take some time
-because this gems only sends data every few requests or every few minutes.
-
-## Configure what to capture
+This will capture any requests to the `api` subdomain and any request that has a path which starts with `/api`.
+After deploying you should start seeing data in Callcounter. Note that this might take some time because this gems
+only sends data every few requests or every few minutes.
 
-You can add a lambda that will be called for every request to determine whether it was a request to your API.
-For example, the default lambda is shown below:
+If you API doesn't match with the default matching rules, you can add a lambda that will be called for every request
+to determine whether it was a request to your API. For example, you can custome the default lambda shown below:
 
 ```ruby
 Callcounter.configure do |config|
@@ -38,6 +58,22 @@ Callcounter.configure do |config|
 end
 ```
 
+## Bug reporting
+
+Bugs can be reported through the Sourcehut todo lists found at: https://todo.sr.ht/~webindie/callcounter-gem
+If you don't want to sign up for an account, you can also contact us through https://callcounter.eu/contact
+
+## Releasing
+
+- Verify tests pass.
+- Increment version number in: `lib/callcounter/version.rb`
+- Run `bundle install`
+- Commit all changes
+- Create a git tag for the release.
+- Push the git tag.
+- Build the gem: `gem build callcounter.gemspec`
+- Push the gem to rubygems.org: `gem push callcounter-?.?.?.gem`
+
 ## About Callcounter
 
 [Callcounter](https://callcounter.eu) is a service built by [Webindie](https://webindie.nl) that

data/lib/callcounter/capturer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'net/http'
+
 module Callcounter
   # class that captures the rack requests and sends them to callcounter.eu
   class Capturer

data/lib/callcounter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Callcounter
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callcounter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Webindie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies: []
 description: Callcounter is a service that helps API providers with debugging and
   optimising the usage of their APIs.