supergood 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0cdb2377e5748a6ed76d61765fe3b15b648f397a97d6c9cdd28b592d68fd323
-  data.tar.gz: '099acaa41f71ef93c745960d9ec046b6643f68501fd95d140a1dd7c62eec76d1'
+  metadata.gz: 8b55de34e8a2ab872a9d2556a4e1e8a4e544bff0536c02fcf123fb93c30fde87
+  data.tar.gz: 974a1af1a188f5a85e77c603e9545370c360367edeb4327c009c6b12ec44a8b9
 SHA512:
-  metadata.gz: 2c15df0347deb5fcb0a0fdf04054595f8c4c9ef8b4da4fabc7879d6098fbe9595c507902ed6f7ccab95b47877f139d9121a1ecea885cb5f814ec86942cb37b3b
-  data.tar.gz: 97beed9cd863cd1175756b3084601a40f53928c205b3a3583ca04931a88f6a4804041b8506dfd7277f4232ed1bb7bad3a6eaf5494fe847955dff22439e1882c7
+  metadata.gz: c0c8f7c3b9af56109324314aa9af0220624bf9d05d2e06a8d2706b5cfac3f6d6ba2e7e8613b82803cc7365e66e6e76d85b1180c62d368ae01f55892276b730c3
+  data.tar.gz: 5bf07755f863ca866c5381f465957689616826f6db09734beda707a15099fc55b3a1fcee4b76f5c9df6623a5b5b1d9b26cb1782924a480e5f66dc279ae353a8b

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/client.rb

@@ -75,7 +75,6 @@ module Supergood
         api.post_events(data)
       rescue => e
         log.error(data, e, e.message)
-        cleanup()
       ensure
         @response_cache.clear
         @request_cache.clear if force
@@ -147,7 +146,6 @@ module Supergood
         }
       rescue => e
         log.error({ request: request }, e, ERRORS[:CACHING_REQUEST])
-        cleanup()
       end
     end
 
@@ -173,7 +171,6 @@ module Supergood
           { request: request_payload, response: response_payload },
           e, ERRORS[:CACHING_RESPONSE]
         )
-        cleanup()
       end
     end
 

data/lib/supergood/version.rb

@@ -1,3 +1,3 @@
 module Supergood
-  VERSION = '0.1.2'.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.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alex Klarfeld