distrito_tracking 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d99da01296b93d1223fbf8d8dda8be4c9e9cc8684c0b4cba9adee5f4460b02d
+  data.tar.gz: ac532d61b0812d6ea68dd721aa2a1537ce731a8ec59ceb86f02ac8a79a715a63
+SHA512:
+  metadata.gz: 68d587dfedd6dc9141f60702e8ed5d4f70d461c3808bac91009e277ee786df4b235b891991c16228293b92d5e4a20f37928ecd38c7fc152a1690b4fd64db656d
+  data.tar.gz: 8047937cdf3e8eb9db19a580ab3746897ba214a7e6c307a354e19cbb0150bce934f73b6b745b6ec1c35fb0952951ebdb1d08b38ae1e595362bcdb8b6ec944a62

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in distrito_tracking.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.11"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    distrito_tracking (0.1.0)
+      aws-sdk-sns
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.648.0)
+    aws-sdk-core (3.162.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.525.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-sns (1.55.0)
+      aws-sdk-core (~> 3, >= 3.127.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.5.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    diff-lcs (1.5.0)
+    jmespath (1.6.1)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  distrito_tracking!
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,42 @@
+# DistritoTracking
+
+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/distrito_tracking`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'distrito_tracking'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install distrito_tracking
+
+## Usage
+
+```ruby
+DistritoTracking.configure do |config|
+  config.region = ENV['AWS_REGION']
+  config.access_key_id = ENV['AWS_ACCESS_KEY_ID']
+  config.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+  config.topic_arn = ENV['AWS_TOPIC_ARN']
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/distrito_tracking.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/distrito_tracking/client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "aws-sdk-sns"
+require "json"
+
+module DistritoTracking
+  class Client
+    attr_reader :client, :configuration
+
+    def initialize
+      @client = Aws::SNS::Client.new(
+        region: configuration.region,
+        access_key_id: configuration.access_key_id,
+        secret_access_key: configuration.secret_access_key
+      )
+    end
+
+    def publish(data)
+      return false if data.empty?
+
+      client.publish({
+                       topic_arn: configuration.topic_arn,
+                       message: JSON.generate(data)
+                     })
+    end
+
+    def configuration
+      @configuration ||= DistritoTracking.configuration
+    end
+
+    def inspect
+      "#<DistritoTracking::Client>"
+    end
+  end
+end

data/lib/distrito_tracking/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DistritoTracking
+  class Configuration
+    attr_accessor :region, :access_key_id, :secret_access_key, :topic_arn
+
+    FIELDS = %i[region access_key_id secret_access_key topic_arn].freeze
+
+    def validate!
+      FIELDS.each do |field|
+        raise DistritoTracking::Error, "#{field} is missing" unless send(field)
+      end
+
+      true
+    end
+  end
+end

data/lib/distrito_tracking/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DistritoTracking
+  class Error < StandardError; end
+end

data/lib/distrito_tracking/schema.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "date"
+
+module DistritoTracking
+  class Schema
+    DEFAULT_SCHEMA = {
+      appName: String,
+      event: {
+        name: String,
+        type: String
+      },
+      feature: {
+        name: String
+      },
+      time: Time
+    }.freeze
+
+    attr_accessor :errors
+
+    def initialize
+      @errors = {}
+    end
+
+    def validate(data:)
+      errors[:data] = "Data provided is invalid" if data.empty? || !data.is_a?(Hash)
+
+      iterate(data, DEFAULT_SCHEMA)
+
+      @errors.empty?
+    end
+
+    def inspect
+      "#<DistritoTracking::Schema>"
+    end
+
+    private
+
+    def iterate(obj, schema, old_key = nil)
+      schema.each do |key, value|
+        error_key = old_key.nil? ? key : old_key
+
+        if obj.is_a?(Hash) && obj.include?(key)
+          if value.is_a?(Hash)
+            iterate(obj[key], value, key)
+          else
+            next if value == obj[key].class
+
+            errors[error_key] = "The key \"#{key}\" must be a #{value} value"
+          end
+        else
+          errors[error_key] = "The key \"#{key}\" is missing or invalid"
+        end
+      end
+    end
+  end
+end

data/lib/distrito_tracking/version.rb

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

data/lib/distrito_tracking.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "distrito_tracking/version"
+
+module DistritoTracking
+  autoload :Client, "distrito_tracking/client"
+  autoload :Error, "distrito_tracking/error"
+  autoload :Configuration, "distrito_tracking/configuration"
+  autoload :Schema, "distrito_tracking/schema"
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.publish(data:)
+    false unless configuration.validate!
+
+    if schema.validate(data: data)
+      client.publish(data)
+    else
+      { errors: schema.errors }
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.schema
+    @schema ||= Schema.new
+  end
+end

data/sig/distrito_tracking.rbs

@@ -0,0 +1,4 @@
+module DistritoTracking
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: distrito_tracking
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Queiroz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jonathan@distrito.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/distrito_tracking.rb
+- lib/distrito_tracking/client.rb
+- lib/distrito_tracking/configuration.rb
+- lib/distrito_tracking/error.rb
+- lib/distrito_tracking/schema.rb
+- lib/distrito_tracking/version.rb
+- sig/distrito_tracking.rbs
+homepage: 
+licenses: []
+metadata: {}
+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: DistritoTracking is a gem to help to track some data from users on Distrito
+  services
+test_files: []