callcounter 0.0.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1296edd2bdff7494496219c2806b20a63ca53e4edd01c5162e7d1cbae08421e
-  data.tar.gz: 6bd1af03dd43ae43fddd6c86168bce112ba5ceb1d3d546cb0c030787257f178b
+  metadata.gz: 99d0cc0bcdf0500c5203169c4f24174faa1e34bc0d6b51b9caabac4c798916bb
+  data.tar.gz: 90df76c181d3ecbb4520fe277969a1abadaefab1c7f69adc7fe0dbb4e92592c5
 SHA512:
-  metadata.gz: ea1a95f4179f2818cf9f68802ea54954010db5def0b3f0f7385a263222dd2239d63bcc63241a4d97dbc62e663c1c0e547014b4ff96b33b6f72eb3fab8bbb1819
-  data.tar.gz: 20aeb37e0ee4b67d11e29d1e66f059eee6a016ed630d7159556715ee98541c9f73149b83a0953b9aa8a07d47b50427d235837642cd47ed270e47e180434640e7
+  metadata.gz: a41c1476531b297327569a83c1dbbe176a96731671351ac98d23a7755aa0c4b41c0351163eddc88ac20540e7c40593b3529fdd9d3b22230b06e0e0d1ff340481
+  data.tar.gz: 581cae38256f5ec226ddb541cc90463b99f22f96bfea2d14f694050bf34da2321c6227de2f5b5d1e896faddaa5954267d4bd564d7df502b3da1fd53a2ab1c39c

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2021, Lint Ltd
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,76 @@
+# Callcounter Ruby integration gem
+
+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, etc. The integrations
+can send the data to Callcounter using an API, which is described at: https://callcounter.io/docs/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
+
+### Bundler
+
+When using bundler, simply add the following line to your Gemfile and run `bundle`:
+
+```ruby
+gem 'callcounter'
+```
+
+### 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|
+  config.app_token = '' # TODO: fill with your unique app token
+end
+```
+
+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.
+
+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 customise the default lambda shown below:
+
+```ruby
+Callcounter.configure do |config|
+  config.app_token = '' # TODO: fill with your unique app token
+  config.track = lambda { |request|
+    request.hostname.start_with?('api') || request.path.start_with?('/api')
+  }
+end
+```
+
+## Bug reporting
+
+Bugs can be reported through the Github issues.
+If you don't want to sign up for an account, you can also contact us through https://callcounter.io/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.io) is a service, developed and maintained by Lint Ltd, that
+helps API providers with debugging and optimising the usage of their APIs.

data/lib/callcounter/capturer.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Callcounter
+  # class that captures the rack requests and sends them to Callcounter
+  class Capturer
+    attr_accessor :buffer
+
+    def initialize(app)
+      @app = app
+      @buffer = []
+    end
+
+    def call(env)
+      start = Time.now
+      result = @app.call(env)
+      finish = Time.now
+
+      return result if app_token.nil?
+
+      threading do
+        background_work(start, finish, env, result)
+      end
+
+      result
+    end
+
+    def debug?
+      Callcounter.configuration.debug
+    end
+
+    def track?(request)
+      Callcounter.configuration.track.call(request)
+    end
+
+    def project_token
+      Callcounter.configuration.project_token
+    end
+
+    def app_token
+      Callcounter.configuration.app_token || project_token
+    end
+
+    def async?
+      Callcounter.configuration.async
+    end
+
+    def threading(&block)
+      if async?
+        Thread.new(&block)
+      else
+        yield
+      end
+    end
+
+    def send_buffer
+      http = Net::HTTP.new('api.callcounter.io', 443)
+      http.use_ssl = true
+      track = Net::HTTP::Post.new('/api/v1/events/batch')
+      track['content-type'] = 'application/json'
+      track['user-agent'] = "callcounter-gem (#{Callcounter::VERSION})"
+      track.body = { batch: { project_token: app_token, events: @buffer } }.to_json
+
+      http.request(track)
+
+      puts 'sent request' if debug?
+    rescue StandardError
+      puts 'failed to send request' if debug?
+    end
+
+    def should_send_buffer?
+      @buffer.first[:created_at] < Time.now - Random.rand(300..359) || @buffer.size > 25
+    end
+
+    def event_attributes(start, finish, request, result)
+      {
+        created_at: start,
+        elapsed_time: ((finish - start) * 1000).round,
+        method: request.request_method,
+        path: request.path,
+        user_agent: request.user_agent,
+        status: result.first
+      }
+    end
+
+    def background_work(start, finish, env, result)
+      request = Rack::Request.new(env)
+      return unless track?(request)
+
+      @buffer << event_attributes(start, finish, request, result)
+
+      return unless should_send_buffer?
+
+      send_buffer
+      @buffer = []
+    end
+  end
+end

data/lib/callcounter/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Callcounter
+  # configuration class for Callcounter middleware
+  class Configuration
+    attr_accessor :debug, :project_token, :track, :async, :app_token
+
+    def initialize
+      @debug = false
+      @project_token = nil
+      @app_token = nil
+      @track = lambda { |request|
+        return request.hostname.start_with?('api') || request.path.start_with?('/api')
+      }
+      @async = true
+    end
+  end
+end

data/lib/callcounter/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Callcounter
+  # enable the Callcounter rack middleware automatically in rails
+  class Railtie < Rails::Railtie
+    initializer 'callcounter.middleware' do |app|
+      app.middleware.use(Callcounter::Capturer)
+    end
+  end
+end

data/lib/callcounter/version.rb

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

data/lib/callcounter.rb

@@ -1,2 +1,21 @@
-class Callcounter
+# frozen_string_literal: true
+
+require 'callcounter/capturer'
+require 'callcounter/configuration'
+require 'callcounter/railtie' if defined?(Rails::Railtie)
+require 'callcounter/version'
+
+# rack middleware that captures incoming api requests and sends them to Callcounter
+module Callcounter
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Callcounter::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

metadata

@@ -1,25 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: callcounter
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.4
 platform: ruby
 authors:
-- Webindie
+- George Buckley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies: []
-description: callcounter
-email: frank@webindie.nl
+description: Callcounter is a service that helps API providers with debugging and
+  optimising the usage of their APIs.
+email:
+- george@lint.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/callcounter.rb
-homepage: https://rubygems.org/gems/callcounter
-licenses:
-- BSD-2-Clause
+- lib/callcounter/capturer.rb
+- lib/callcounter/configuration.rb
+- lib/callcounter/railtie.rb
+- lib/callcounter/version.rb
+homepage: https://github.com/Callcounter/callcounter-ruby
+licenses: []
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -36,8 +43,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: callcounter
+summary: Callcounter integration gem to gather API request statistics
 test_files: []