supergood 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb3307099fe394492d12e7f204da26d9ccb0cca6d53eae8ad1a3e7cc65ae599f
-  data.tar.gz: 9d8b94b82e04ccdb7d0751b52a29381ebbba02aa2bc7c4e088354626600af5ed
+  metadata.gz: a0cdb2377e5748a6ed76d61765fe3b15b648f397a97d6c9cdd28b592d68fd323
+  data.tar.gz: '099acaa41f71ef93c745960d9ec046b6643f68501fd95d140a1dd7c62eec76d1'
 SHA512:
-  metadata.gz: add414866656373dbef5a3c78bcdf6c0220eda4855bf83c4c0b2ae4a9861e7ad8f071ebe4b3ab80244b74f0646f4953c0fcf8f8c0bba6e8af23a1c34c1c7522f
-  data.tar.gz: dec173ab5aeb5b18e9cac6a4ef15c00f8b523982b9f313e92e18a42f0c2ab15f568cf6e85662d86843e9166c155a8236afa42dc9d96f2fb25a6635508398bad7
+  metadata.gz: 2c15df0347deb5fcb0a0fdf04054595f8c4c9ef8b4da4fabc7879d6098fbe9595c507902ed6f7ccab95b47877f139d9121a1ecea885cb5f814ec86942cb37b3b
+  data.tar.gz: 97beed9cd863cd1175756b3084601a40f53928c205b3a3583ca04931a88f6a4804041b8506dfd7277f4232ed1bb7bad3a6eaf5494fe847955dff22439e1882c7

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Unit Tests
+env:
+  DATABASE_URL: ${{ secrets.STAGING_DATABASE_URL }}
+  SUPERGOOD_CLIENT_ID: ${{ secrets.STAGING_SUPERGOOD_CLIENT_ID }}
+  SUPERGOOD_CLIENT_SECRET: ${{ secrets.STAGING_SUPERGOOD_CLIENT_SECRET }}
+  SUPERGOOD_BASE_URL: 'http://localhost:3000'
+  SUPERGOOD_ORGANIZATION_ID: ${{ vars.SUPERGOOD_ORGANIZATION_ID }}
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches: [master]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        with:
+          ruby-version: '3.1'
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec spec/client_spec.rb

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.1

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    supergood (0.0.12)
-      faraday (~> 2.7, >= 2.7.4)
+    supergood (0.1.1)
       rudash (~> 4.0, >= 4.0.2)
 
 GEM
@@ -92,6 +91,7 @@ DEPENDENCIES
   base64
   digest
   dotenv
+  faraday (~> 2.7, >= 2.7.4)
   http (~> 5.1, >= 5.1.1)
   httparty (~> 0.21.0)
   json

data/README.md

@@ -1,8 +1,10 @@
 # Supergood
 
-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/supergood`. To experiment with that code, run `bin/console` for an interactive prompt.
+Monitor the cost and performance of your external API's with two lines of code. 
 
-TODO: Delete this and the text above, and describe your gem
+Interested in learning more? Check us out at https://supergood.ai or Reach out to alex@supergood.ai .
+
+Not built on Ruby? We've got a node client, python client and golang client as well.
 
 ## Installation
 
@@ -22,7 +24,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Head over to https://dashboard.supergood.ai and make an account, make sure to use your work email address!
+2. Click on the tab labeled "API Keys" and generate a client id and client secret.
+3. Head back to your code and initialize the Supergood client one of two ways:
+
+```
+require 'supergood'
+
+Supergood.init(<client_id>, <client_secret>)
+```
+OR
+
+set `SUPERGOOD_CLIENT_ID` and `SUPERGOOD_CLIENT_SECRET` as environment variables and leave the init function as `Supergood.init` 
+
 
 ## Development
 
@@ -32,5 +46,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/supergood.
+Bug reports and pull requests are welcome on GitHub at https://github.com/supergoodsystems/supergood-rb.
 

data/lib/supergood/api.rb

@@ -1,13 +1,20 @@
-require 'faraday'
 require 'dotenv'
 
 Dotenv.load
 
 module Supergood
   class Api
-    def initialize(header_options, base_url)
+    def initialize(client_id, client_secret, base_url)
       @base_url = base_url
-      @header_options = header_options
+      @header_options = {
+        'Content-Type' => 'application/json',
+        'Authorization' => 'Basic ' + Base64.encode64(client_id + ':' + client_secret).gsub(/\n/, '')
+      }
+      @local_only = client_id == LOCAL_CLIENT_ID && client_secret == LOCAL_CLIENT_SECRET
+    end
+
+    def header_options
+      @header_options
     end
 
     def log
@@ -18,45 +25,33 @@ module Supergood
       @log = logger
     end
 
-    def set_event_sink_endpoint(endpoint)
-      @event_sink_endpoint = endpoint
-    end
-
-    def set_error_sink_endpoint(endpoint)
-      @error_sink_endpoint = endpoint
-    end
-
     def post_events(payload)
-      conn = Faraday.new(url: @base_url, headers: @header_options)
-      response = conn.post(@event_sink_endpoint, body = payload.to_json, headers = @header_options)
-      if response.status == 200
-        return JSON.parse(response.body, symbolize_names: true)
-      elsif response.status == 401
-        raise SupergoodException.new ERRORS[:UNAUTHORIZED]
-      elsif response.status != 200 && response.status != 201
-        raise SupergoodException.new ERRORS[:POSTING_EVENTS]
+      if @local_only
+        @log.debug(payload)
+      else
+        uri = URI(@base_url + '/api/events')
+        response = Net::HTTP.post(uri, payload.to_json, @header_options)
+        if response.code == '200'
+          return JSON.parse(response.body, symbolize_names: true)
+        elsif response.code == '401'
+          raise SupergoodException.new ERRORS[:UNAUTHORIZED]
+        elsif response.code != '200' && response.code != '201'
+          raise SupergoodException.new ERRORS[:POSTING_EVENTS]
+        end
       end
     end
 
     def post_errors(payload)
-      conn = Faraday.new(url: @base_url, headers: @header_options)
-      response = conn.post(@error_sink_endpoint, body = payload.to_json, headers = @header_options)
-      if response.status == 200
-        return JSON.parse(response.body, symbolize_names: true)
+      if @local_only
+        @log.debug(payload)
       else
-        @log.warn(ERRORS[:POSTING_ERRORS])
-      end
-    end
-
-    def fetch_config
-      conn = Faraday.new(url: @base_url, headers: @header_options)
-      response = conn.get('/api/config')
-      if response.status == 200
-        return JSON.parse(response.body, symbolize_names: true)
-      elsif response.status == 401
-        raise SupergoodException.new ERRORS[:UNAUTHORIZED]
-      elsif response.status != 200 && response.status != 201
-        raise SupergoodException.new ERRORS[:FETCHING_CONFIG]
+        uri = URI(@base_url + '/api/errors')
+        response = Net::HTTP.post(uri, payload.to_json, @header_options)
+        if response.code == '200'
+          return JSON.parse(response.body, symbolize_names: true)
+        else
+          @log.warn(ERRORS[:POSTING_ERRORS])
+        end
       end
     end
   end

data/lib/supergood/client.rb

@@ -12,11 +12,10 @@ Dotenv.load
 module Supergood
 
   DEFAULT_SUPERGOOD_BASE_URL = 'https://dashboard.supergood.ai'
-
   class << self
-    def init(supergood_client_id=nil, supergood_client_secret=nil, base_url=nil)
-      supergood_client_id = supergood_client_id || ENV['SUPERGOOD_CLIENT_ID']
-      supergood_client_secret = supergood_client_secret || ENV['SUPERGOOD_CLIENT_SECRET']
+    def init(config={})
+      supergood_client_id = config[:client_id] || ENV['SUPERGOOD_CLIENT_ID']
+      supergood_client_secret = config[:client_secret] || ENV['SUPERGOOD_CLIENT_SECRET']
 
       if !supergood_client_id
         raise SupergoodException.new ERRORS[:NO_CLIENT_ID]
@@ -26,27 +25,27 @@ module Supergood
         raise SupergoodException.new ERRORS[:NO_CLIENT_SECRET]
       end
 
-      @base_url = base_url || ENV['SUPERGOOD_BASE_URL'] || DEFAULT_SUPERGOOD_BASE_URL
-      header_options = {
-        'Content-Type' => 'application/json',
-        'Authorization' => 'Basic ' + Base64.encode64(supergood_client_id + ':' + supergood_client_secret).gsub(/\n/, '')
-      }
+      @base_url = ENV['SUPERGOOD_BASE_URL'] || DEFAULT_SUPERGOOD_BASE_URL
+      @api = Supergood::Api.new(supergood_client_id, supergood_client_secret, @base_url)
+      @config = Supergood::Utils.make_config(config)
 
-      @api = Supergood::Api.new(header_options, @base_url)
-      @config = @api.fetch_config
       @ignored_domains = @config[:ignoredDomains]
       @keys_to_hash = @config[:keysToHash]
-      @logger = Supergood::Logger.new(@api, @config, header_options)
+      @logger = Supergood::Logger.new(@api, @config, @api.header_options)
 
-      @api.set_error_sink_endpoint(@config[:errorSinkEndpoint])
-      @api.set_event_sink_endpoint(@config[:eventSinkEndpoint])
       @api.set_logger(@logger)
 
       @request_cache = {}
       @response_cache = {}
 
       @interval_thread = set_interval(@config[:flushInterval]) { flush_cache }
-      log.debug("Using config %s" % @config.inspect)
+
+      @http_clients = [
+        Supergood::Vendor::NetHTTP,
+        Supergood::Vendor::HTTPrb
+      ]
+
+      patch_all()
       self
     end
 
@@ -76,6 +75,7 @@ module Supergood
         api.post_events(data)
       rescue => e
         log.error(data, e, e.message)
+        cleanup()
       ensure
         @response_cache.clear
         @request_cache.clear if force
@@ -83,10 +83,27 @@ module Supergood
 
     end
 
+    def cleanup()
+      @interval_thread.kill
+      unpatch_all()
+    end
+
     def close(force = true)
       log.debug('Cleaning up, flushing cache gracefully.')
-      @interval_thread.kill
       flush_cache(force)
+      cleanup()
+    end
+
+    def patch_all
+      @http_clients.each do |client|
+        client.patch
+      end
+    end
+
+    def unpatch_all
+      @http_clients.each do |client|
+        client.unpatch
+      end
     end
 
     def set_interval(delay)
@@ -98,14 +115,6 @@ module Supergood
       end
     end
 
-    def self.intercept(*args, &block)
-      instance.intercept(*args, &block)
-    end
-
-    def self.instance
-      @instance ||= Supergood.new
-    end
-
     def intercept(request)
       request_id = SecureRandom.uuid
       requested_at = Time.now
@@ -138,6 +147,7 @@ module Supergood
         }
       rescue => e
         log.error({ request: request }, e, ERRORS[:CACHING_REQUEST])
+        cleanup()
       end
     end
 
@@ -159,11 +169,11 @@ module Supergood
         }), @keys_to_hash)
         @request_cache.delete(request_id)
       rescue => e
-        puts e
         log.error(
           { request: request_payload, response: response_payload },
           e, ERRORS[:CACHING_RESPONSE]
         )
+        cleanup()
       end
     end
 

data/lib/supergood/constants.rb

@@ -4,9 +4,8 @@ ERRORS = {
   DUMPING_DATA_TO_DISK: 'Error Dumping Data to Disk',
   POSTING_EVENTS: 'Error Posting Events',
   POSTING_ERRORS: 'Error Posting Errors',
-  FETCHING_CONFIG: 'Error Fetching Config',
   WRITING_TO_DISK: 'Error writing to disk',
-  TEST_ERROR: 'Test Error for Testing Purposes',
+  TEST_ERROR: 'Test Error for Testing Purpos es',
   UNAUTHORIZED: 'Unauthorized: Invalid Client ID or Secret. Exiting.',
   NO_CLIENT_ID:
     'No Client ID Provided, set SUPERGOOD_CLIENT_ID or pass it as an argument',
@@ -14,8 +13,17 @@ ERRORS = {
     'No Client Secret Provided, set SUPERGOOD_CLIENT_SECRET or pass it as an argument'
 };
 
+LOCAL_CLIENT_ID = 'local-client-id';
+LOCAL_CLIENT_SECRET = 'local-client-secret';
+
 DEFAULT_SUPERGOOD_BYTE_LIMIT = 500000
 
+DEFAULT_CONFIG = {
+  keysToHash: [],
+  flushInterval: 1000,
+  ignoredDomains: []
+}
+
 # GZIP_START_BYTES = b'\x1f\x8b'
 
 class SupergoodException < StandardError

data/lib/supergood/utils.rb

@@ -68,5 +68,9 @@ module Supergood
     def self.request_url(http, request)
       URI::DEFAULT_PARSER.unescape("http#{"s" if http.use_ssl?}://#{http.address}#{request.path}")
     end
+
+    def self.make_config(config)
+      return DEFAULT_CONFIG.merge(config)
+    end
   end
 end

data/lib/supergood/vendors/http.rb

@@ -1,33 +1,59 @@
 module Supergood
   module Vendor
     module HTTPrb
-      if defined?(HTTP::Client)
-        HTTP::Client.class_eval {
-          alias original_perform perform
-          def perform(original_request_payload, original_options)
-            request = {
-              headers: original_request_payload.headers.to_hash,
-              method: original_request_payload.verb.upcase.to_s,
-              body: Supergood::Utils.safe_parse_json(original_request_payload.body.source),
-              url: original_request_payload.uri.to_s,
-              path: original_request_payload.uri.path,
-              search: original_request_payload.uri.query,
-              domain: original_request_payload.uri.host
-            }
-            Supergood.intercept(request) do
-              original_response = original_perform(original_request_payload, original_options)
-              status, statusText = original_response.status.to_s.split(' ')
-              {
-                headers: original_response.headers.to_hash,
-                status: status,
-                statusText: statusText,
-                body: Supergood::Utils.safe_parse_json(original_response),
-                original_response: original_response
+      def self.patch
+        if !self.existing_patch?
+
+          block = lambda do |x|
+            alias original_perform perform
+            def perform(original_request_payload, original_options)
+              request = {
+                headers: original_request_payload.headers.to_hash,
+                method: original_request_payload.verb.upcase.to_s,
+                body: Supergood::Utils.safe_parse_json(original_request_payload.body.source),
+                url: original_request_payload.uri.to_s,
+                path: original_request_payload.uri.path,
+                search: original_request_payload.uri.query,
+                domain: original_request_payload.uri.host
               }
+              Supergood.intercept(request) do
+                original_response = original_perform(original_request_payload, original_options)
+                status, statusText = original_response.status.to_s.split(' ')
+                {
+                  headers: original_response.headers.to_hash,
+                  status: status,
+                  statusText: statusText,
+                  body: Supergood::Utils.safe_parse_json(original_response),
+                  original_response: original_response
+                }
+              end
             end
           end
-        }
+
+          if defined?(HTTP::Client)
+            HTTP::Client.class_eval(&block)
+          end
+
+        end
+      end
+
+      def self.unpatch
+        if self.existing_patch?
+          block = lambda do |x|
+            alias perform original_perform
+          end
+
+          if defined?(HTTP::Client)
+            HTTP::Client.class_eval(&block)
+            HTTP::Client.undef_method :original_perform
+          end
+        end
       end
+
+      def self.existing_patch?
+        defined?(HTTP::Client) && HTTP::Client.method_defined?(:original_perform)
+      end
+
     end
   end
 end

data/lib/supergood/vendors/net-http.rb

@@ -5,41 +5,66 @@ require 'uri'
 module Supergood
   module Vendor
     module NetHTTP
-      block = lambda do |x|
-        alias original_request_method request
-        def request(original_request_payload, body = nil, &block)
-          http = self;
-          url = Supergood::Utils.request_url(http, original_request_payload)
-          uri = URI.parse(url)
-          request = {
-            headers: Supergood::Utils.get_header(original_request_payload),
-            method: original_request_payload.method,
-            body: original_request_payload.body,
-            url: url,
-            path: original_request_payload.path,
-            search: uri.query,
-            domain: uri.host,
-          }
-          Supergood.intercept(request) do
-            original_response = original_request_method(original_request_payload, body, &block)
-            {
-              headers: Supergood::Utils.get_header(original_response),
-              status: original_response.code,
-              statusText: original_response.message,
-              body: original_response.body,
-              original_response: original_response
-            }
+      def self.patch
+        if !self.existing_patch?
+          block = lambda do |x|
+            alias original_request_method request
+            def request(original_request_payload, body = nil, &block)
+              http = self;
+              url = Supergood::Utils.request_url(http, original_request_payload)
+              uri = URI.parse(url)
+              request = {
+                headers: Supergood::Utils.get_header(original_request_payload),
+                method: original_request_payload.method,
+                body: original_request_payload.body,
+                url: url,
+                path: original_request_payload.path,
+                search: uri.query,
+                domain: uri.host,
+              }
+              Supergood.intercept(request) do
+                original_response = original_request_method(original_request_payload, body, &block)
+                {
+                  headers: Supergood::Utils.get_header(original_response),
+                  status: original_response.code,
+                  statusText: original_response.message,
+                  body: original_response.body,
+                  original_response: original_response
+                }
+              end
+            end
           end
+
+          if defined?(Net::HTTP)
+            Net::HTTP.class_eval(&block)
+          elsif defined?(::WebMock)
+            WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP").class_eval(&block)
+          end
+
         end
       end
 
-      if defined?(Net::HTTP)
-        Net::HTTP.class_eval(&block)
+      def self.unpatch
+        if self.existing_patch?
+          block = lambda do |x|
+            alias request original_request_method
+          end
+
+          if defined?(Net::HTTP)
+            Net::HTTP.class_eval(&block)
+            Net::HTTP.undef_method :original_request_method
+          elsif defined?(::WebMock)
+            WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP").class_eval(&block)
+            WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP").undef_method :original_request_method
+          end
+        end
       end
 
-      if defined?(::WebMock)
-        WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP").class_eval(&block)
+      def self.existing_patch?
+        (defined?(Net::HTTP) && Net::HTTP.method_defined?(:original_request_method)) ||
+        (defined?(::Webmock) && WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP").method_defined?(:original_request_method))
       end
+
     end
   end
 end

data/lib/supergood/version.rb

@@ -1,3 +1,3 @@
 module Supergood
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/supergood.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |s|
   s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   s.add_dependency 'rudash', '~> 4.0', '>= 4.0.2'
-  s.add_dependency 'faraday', '~> 2.7', '>= 2.7.4'
 
   s.add_development_dependency 'rest-client', '~> 2.1'
   s.add_development_dependency 'httparty', '~> 0.21.0'
   s.add_development_dependency 'http', '~> 5.1', '>= 5.1.1'
   s.add_development_dependency 'rspec', '~> 3.12'
   s.add_development_dependency 'webmock', '~> 3.18', '>= 3.18.1'
+  s.add_development_dependency 'faraday', '~> 2.7', '>= 2.7.4'
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: supergood
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex Klarfeld
@@ -30,26 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.2
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.4
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -132,14 +112,36 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.18.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.4
 description:
 email: alex@supergood.ai
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - ".vscode/settings.json"
 - Gemfile