not_analytics_client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96e32682a9b4ec232b965ac59ff71bbe7e5d86c7f947779bb3b83cfe58d94266
+  data.tar.gz: 205e044696c3c520768486df92885c3a0cf840fab318b033332eb376f0a0fac9
+SHA512:
+  metadata.gz: 19a288f89afe50118d72c27d07735924d4d1db0be62c3319a30d7af6b02eedb5397b318ab84e60c9694f31b7c06f556637a22de1ed9de2f4e028590a3f8626b3
+  data.tar.gz: a9ff86c62ad46da189101d760c147076df26ea0fff2e811299757d8acfb0dcfff8b9ab7c814423374cb9eeaf13fe2131cf774f6e3748c1f6b6e6033778b40352

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in not-analytics-client.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    not_analytics_client (0.2.0)
+      base64 (~> 0.1)
+      json (~> 2.5)
+      net-http (~> 0.1.1)
+      openssl (~> 2.2)
+      securerandom (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.1.0)
+    io-wait (0.1.0)
+    json (2.5.1)
+    net-http (0.1.1)
+      net-protocol
+      uri
+    net-protocol (0.1.0)
+      io-wait
+      timeout
+    openssl (2.2.0)
+    rake (13.0.3)
+    securerandom (0.1.0)
+    timeout (0.1.1)
+    uri (0.10.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  not_analytics_client!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

data/README.md

@@ -0,0 +1,41 @@
+# not Analytics Client
+
+A client for [not Analytics](https://github.com/12joan/not-analytics).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'not-analytics-client', github: '12joan/not-analytics-client', branch: 'main'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Instantiate a new Hit object for a given app ID.
+
+```ruby
+hit = NotAnalyticsClient::Hit.new(
+  app_id: app_id,
+  event: '/some/path', # Optional
+  key: app_key, # Optional
+)
+```
+
+Send the Hit to a not Analytics server.
+
+```ruby
+hit.post!(not_analytics_url: 'https://hit.example.com/')
+# => #<Net::HTTPOK 200 OK readbody=true>
+```
+
+Or output the JSON payload.
+
+```ruby
+hit.payload
+# => "{\"hit\":{\"app_id\":"...
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'not_analytics_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/not_analytics_client/hit.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'securerandom'
+require 'net/http'
+
+module NotAnalyticsClient
+  class Hit
+    def initialize(app_id:, event: nil, key: nil)
+      @app_id = app_id
+      @event = event
+      @key = key
+    end
+
+    def payload
+      {
+        hit: {
+          app_id: @app_id,
+          event: @event,
+          **auth_params,
+        }
+      }.to_json
+    end
+
+    def post!(not_analytics_url:)
+      uri = URI(not_analytics_url)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      
+      request = Net::HTTP::Post.new(uri.request_uri, {
+        'Content-Type' => 'application/json'
+      })
+
+      request.body = payload
+
+      http.request(request)
+    end
+
+    private
+
+    def auth_params
+      if @key.nil?
+        {}
+      else
+        nonce = SecureRandom.hex
+
+        MessageEncryptor.new(@key).encrypt_and_sign("#{nonce}:#{@event}").then do
+          {
+            nonce: nonce,
+            signature: _1.ciphertext,
+            iv: _1.iv,
+            auth_tag: _1.auth_tag,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/not_analytics_client/message_encryptor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'base64'
+
+module NotAnalyticsClient
+  MessageEncryptor = Struct.new(:key) do
+    def encrypt_and_sign(plain)
+      cipher = OpenSSL::Cipher.new('aes-256-gcm')
+      cipher.encrypt
+      cipher.key = Base64.decode64(key)
+      iv = cipher.random_iv
+      cipher.auth_data = ''
+      ciphertext = cipher.update(plain) + cipher.final
+      auth_tag = cipher.auth_tag
+
+      Struct.new(:ciphertext, :iv, :auth_tag).new(
+        Base64.encode64(ciphertext),
+        Base64.encode64(iv),
+        Base64.encode64(auth_tag),
+      )
+    end
+
+    def decrypt_and_verify(ciphertext, iv:, auth_tag:)
+      cipher = OpenSSL::Cipher.new('aes-256-gcm')
+      cipher.decrypt
+      cipher.key = Base64.decode64(key)
+      cipher.iv = Base64.decode64(iv)
+      cipher.auth_data = ''
+      cipher.auth_tag = Base64.decode64(auth_tag)
+
+      cipher.update(Base64.decode64(ciphertext)) + cipher.final
+    end
+  end
+end

data/lib/not_analytics_client/version.rb

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

data/lib/not_analytics_client.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'not_analytics_client/version'
+require_relative 'not_analytics_client/hit'
+require_relative 'not_analytics_client/message_encryptor'
+
+module NotAnalyticsClient
+  class Error < StandardError; end
+end

data/not_analytics_client.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/not_analytics_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'not_analytics_client'
+  spec.version       = NotAnalyticsClient::VERSION
+  spec.authors       = ['Joe Anderson']
+  spec.email         = ['joe@osbert.me']
+
+  spec.summary       = 'Client for not-analytics'
+  spec.homepage      = 'https://github.com/12joan/not_analytics_client'
+  spec.license       = 'Unlicense'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'openssl', '~> 2.2'
+  spec.add_dependency 'base64', '~> 0.1'
+  spec.add_dependency 'json', '~> 2.5'
+  spec.add_dependency 'securerandom', '~> 0.1'
+  spec.add_dependency 'net-http', '~> 0.1.1'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: not_analytics_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Joe Anderson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: 
+email:
+- joe@osbert.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/not_analytics_client.rb
+- lib/not_analytics_client/hit.rb
+- lib/not_analytics_client/message_encryptor.rb
+- lib/not_analytics_client/version.rb
+- not_analytics_client.gemspec
+homepage: https://github.com/12joan/not_analytics_client
+licenses:
+- Unlicense
+metadata:
+  homepage_uri: https://github.com/12joan/not_analytics_client
+  source_code_uri: https://github.com/12joan/not_analytics_client
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Client for not-analytics
+test_files: []