pushkin-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bf5e72152d65f3424c4d6451e6c3430e7b37faf439b9775c521dbaede7d061e
+  data.tar.gz: 2ba9fe9d1715d526391db320905a69a705db3b417e661e7f41193a39d303127a
+SHA512:
+  metadata.gz: 23f294013d8257e7e5339b05715f17f19c8e488a660d5c4476e82b0404e61ab60b1d94c349ec53f56541d3a07662c3f25a5d1753e307da78fb2b4d1cb57e35b4
+  data.tar.gz: 55fbe84038b2c5483499d6112c5f1126ed732d5ffa3adc25a147a01e2ca571fc19a8e8de4605474f7d285520da278960663694e889e85379a85fd60b3bf4862c

data/.standard.yml

@@ -0,0 +1,2 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-30
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pushkin-logger.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    pushkin-logger (0.1.0)
+      httparty (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.1)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  pushkin-logger!
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -0,0 +1,53 @@
+# Pushkin
+
+Pushkin is a simple http client for sending various user/system events to Pushkin API endpoint. It's used primarily for logging events in ticketing services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pushkin-logger'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Basic Usage
+```ruby
+client = Pushkin::Client.new(
+  ENV['PUSHKIN_API_URL'],
+  ENV['PUSHKIN_API_TOKEN']
+)
+
+data = {
+  log_level: 'info', # optional ['info', 'warn', 'error'], default: 'system'
+  action: 'my.action',
+  properties: { foo: 'bar' }
+}
+
+client.push(data)
+```
+## Advanced
+Predefined actions to track orders and tickets sold:
+```ruby
+order.intent
+coupon.create
+coupon.activate
+ticket.order
+ticket.create
+ticket.preregister
+ticket.upload
+ticket.download
+payment.received
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.vesputi.com/mobilitybox/pushkin-gem.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pushkin"
+
+# 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/pushkin/client.rb

@@ -0,0 +1,42 @@
+require "httparty"
+module Pushkin
+  class Client
+    include HTTParty
+
+    def initialize(api_url, api_token)
+      @options = {
+        headers: {
+          "Authorization" => "Bearer #{api_token}",
+          "Accept-Language" => "en",
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "User-Agent" => "Pushkin v#{Pushkin::VERSION}",
+          "Client-Language" => "ruby",
+          "Client-Language-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+          "Client-Platform" => RUBY_PLATFORM,
+          "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+          "Client-Hostname" => Socket.gethostname,
+          "Client-Pid" => Process.pid.to_s,
+          "Client-Thread" => Thread.current.object_id.to_s
+        }
+      }
+      @api_url = api_url
+    end
+
+    def push(data)
+      body = prepare_data(data)
+      @options = @options.merge(body: body)
+
+      self.class.post("#{@api_url}/api/events/", @options)
+    end
+
+    private
+
+    def prepare_data(data)
+      data.merge(
+        pushed_at: DateTime.current,
+        service_identifier: Rails.application.class.module_parent_name
+      ).to_json
+    end
+  end
+end

data/lib/pushkin/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pushkin
+  VERSION = "0.1.0"
+end

data/lib/pushkin.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "pushkin/version"
+require_relative "pushkin/client"
+
+module Pushkin
+  class Error < StandardError; end
+
+  LOG_PREFIX = "[pushkin]"
+
+  def self.logger
+    return @logger if @logger
+
+    @logger = if defined?(Rails)
+      Rails.logger
+    else
+      Logger.new($stdout)
+    end
+  end
+
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: pushkin-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mobilitybox Dev Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+description:
+email:
+- dev-op@vesputi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pushkin.rb
+- lib/pushkin/client.rb
+- lib/pushkin/version.rb
+homepage: https://themobilitybox.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://themobilitybox.com
+  source_code_uri: https://gitlab.vesputi.com/mobilitybox/pushkin
+  changelog_uri: https://gitlab.vesputi.com/mobilitybox/pushkin/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A http client for shipping events to Pushkin Service.
+test_files: []