supergood 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5cc6a38a2204140f0764b5875faa3a86e40770b12b9783b2c62d79349a587e2
-  data.tar.gz: 776779840ec476c214c227d86de870fe6834738776c22ae14e5acf21c446adc7
+  metadata.gz: 8b55de34e8a2ab872a9d2556a4e1e8a4e544bff0536c02fcf123fb93c30fde87
+  data.tar.gz: 974a1af1a188f5a85e77c603e9545370c360367edeb4327c009c6b12ec44a8b9
 SHA512:
-  metadata.gz: 21dd980b5e7a766943b055d414112155687672fdaac6842d823f9f4920196ad2ea5012454ed6d38f5a27ae8151aa7d8da682c5d73b7b2032cb314f68802f447b
-  data.tar.gz: 3ae1572a26f4cba3416892c8faa3dc806580cbe4411edac101a8389364ac0dcef1950e6f09bd557a0cad5d00c90589c95cb1b852b68f3e712cd36b27fd266014
+  metadata.gz: c0c8f7c3b9af56109324314aa9af0220624bf9d05d2e06a8d2706b5cfac3f6d6ba2e7e8613b82803cc7365e66e6e76d85b1180c62d368ae01f55892276b730c3
+  data.tar.gz: 5bf07755f863ca866c5381f465957689616826f6db09734beda707a15099fc55b3a1fcee4b76f5c9df6623a5b5b1d9b26cb1782924a480e5f66dc279ae353a8b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    supergood (0.1.0)
+    supergood (0.1.1)
       rudash (~> 4.0, >= 4.0.2)
 
 GEM

data/README.md

@@ -1,50 +1,50 @@
-# Supergood
+# Ruby
 
-Monitor the cost and performance of your external API's with two lines of code. 
+The Supergood Ruby client connects Supergood to your Ruby application. Follow these steps to integrate with the Ruby client.
 
-Interested in learning more? Check us out at https://supergood.ai or Reach out to alex@supergood.ai .
+## 1. Install the Supergood library
 
-Not built on Ruby? We've got a node client, python client and golang client as well.
+```bash
+gem install supergood
+```
 
-## Installation
+## 2. Initialize the Supergood Library
 
-Add this line to your application's Gemfile:
+**Environment variables**
 
-```ruby
-gem 'supergood'
-```
+Set the environment variables `SUPERGOOD_CLIENT_ID` and `SUPERGOOD_CLIENT_SECRET` using the API keys generated in the [getting started instructions](../../getting-started.md).
 
-And then execute:
+Initialize the Supergood client at the root of your application, or anywhere you're making API calls with the following code:
 
-    $ bundle install
-
-Or install it yourself as:
+```ruby
+require 'supergood'
 
-    $ gem install supergood
+Supergood.init()
+```
 
-## Usage
+**Passing keys**
 
-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:
+You can also pass the API keys in manually without setting environment variables.\
+\
+Replace `<CLIENT_ID>` and `<CLIENT_SECRET>` with the API keys you generated in the [getting started instructions](../../getting-started.md).
 
-```
+```ruby
 require 'supergood'
 
-Supergood.init(<client_id>, <client_secret>)
+Supergood.init({ client_id: "<CLIENT_ID>", client_secret: "<CLIENT_SECRET>" })
 ```
-OR
-
-set `SUPERGOOD_CLIENT_ID` and `SUPERGOOD_CLIENT_SECRET` as environment variables and leave the init function as `Supergood.init` 
 
+#### Local development
 
-## Development
+Setting the `CLIENT_ID` and `CLIENT_SECRET_ID` to `local-client-id` and `local-client-secret`, respectively, will disable making API calls to the supergood.ai server and instead log the payloads to the local console.
 
-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.
+## 3. Monitor your API calls
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You're all set to use Supergood!
 
-## Contributing
+Head back to your [dashboard](https://dashboard.supergood.ai) to start monitoring your API calls and receiving reports.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/supergoodsystems/supergood-rb.
+## Links
 
+* [Supergood RubyGems Project](https://rubygems.org/gems/supergood)
+* [Supergood-rb Source Code](https://github.com/supergoodsystems/supergood-rb)

data/lib/supergood/api.rb

@@ -4,9 +4,17 @@ 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
@@ -17,50 +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)
-      uri = URI(@base_url + @event_sink_endpoint)
-      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]
+      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)
-      uri = URI(@base_url + @error_sink_endpoint)
-      response = Net::HTTP.post(uri, payload.to_json, @header_options)
-      if response.code == '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
-      uri = URI(@base_url + '/api/config')
-      request = Net::HTTP::Get.new(uri)
-      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
-        request['Content-Type'] = 'application/json'
-        request['Authorization'] = @header_options['Authorization']
-        http.request(request)
-      end
-      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[: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
 
@@ -83,10 +82,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 +114,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
@@ -159,7 +167,6 @@ 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]

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.1'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: supergood
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Alex Klarfeld