configly-ruby 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 524b5942925d1b420aca59131590986ca941ac9206e543ad00448fd1e303d0c0
-  data.tar.gz: 679cc9958ff99e8eea95fc13c713074ef880d43aaf684679d8d80f4a7a00043b
+  metadata.gz: 5d1525cdf4c14061d87df93eb5d7784ed7ec17a97ca73952c1b05955c22c1d89
+  data.tar.gz: e5e66c9d611800617304884ec26a408cd4e900f7ce559e38998e1126650098b2
 SHA512:
-  metadata.gz: 97445a7db758cbc30d2f49aaf14736855276d2195cd808e199d6b2f1a395edfc2a4503e9ef6381c6fef2a8d18e94bda89a69b2bfa38a1a8aa06c5192a1746a38
-  data.tar.gz: 3604454a283d703dc3b0a563e4c497cfaa85208b92c5124183259165bb121c441d2c7e6b468eb22e5ab7bc58c6c5b8e209957148cadc9bf1cc7bb986d36731c7
+  metadata.gz: 9ccd504f03c7a4f08242b887d873d7e47588cc3fbcb7258c0dc299828b3f982724520451c0f14cd8725d0df1436a787ab9bf076b7da33c8a32ec1d9bab620931
+  data.tar.gz: 90e29d3e9c06d3292f9f1470275567a9bec65d3e6f157b79d223a9d811e53983848db69fb80d8c3d553ef029eeaa337acdcd8e36596592492e7ed3e2d990ccac

data/README.md

@@ -1,8 +1,8 @@
-# Configly React Library
+# Configly Ruby Library
 > The Ruby library for [Configly](https://www.config.ly): the modern config/static data key/value store.
 
-![npm](https://img.shields.io/npm/v/configly-react)
-![GitHub](https://img.shields.io/github/license/configly/react)
+![npm](https://img.shields.io/gem/v/configly-ruby)
+![GitHub](https://img.shields.io/github/license/configly/ruby)
 
 Table of Contents
 =================
@@ -38,13 +38,73 @@ read more about the benefits at [Configly](config.ly).
 
 - API to fetch Strings, JSON Blobs (arrays and objects), Booleans, and Numbers from the Configly backend
 - [Web interface](https://www.config.ly/config) for modifying these values without having to deploy code (we call our beloved web interface _the Configulator_).
-- High availability, high-throughput, low-latency backend.
-- Smart caching on the client libraries to minimize server requests.
+  - High availability, high-throughput, low-latency backend.
 - Client libraries available in an expanding amount of languages.
 
+### Concepts/ Data Model
+- A Configly account contains a set of Configs.
+- A Config is a key-value pair along with associated metadata (like TTL).
+- The keys are strings.
+- The values are one of the following types:
+
+#### Types
+
+| Type    |  notes   | Example(s)|
+|---------|----------|----------|
+| string  |          | "I <3 Configly!" |
+| number  | Can be integers or decimal; _be aware some clients require you to specify which when fetching_  | 31337, 1.618 |
+| boolean | only true or false | true, false |
+| jsonBlob | A [JSON5](https://json5.org/) (more relaxed JSON) array or object. | ``` ["one", 5, true]```, ```{"text": "Buy now!", color: "#0F0"}``` |
+
+##### More `jsonBlob` examples
+You can make arbitrarily complex JSON structures -- _as long_ as the top level is
+an object or array. This is incredibly powerful as you can send a host of data
+with a single _config_:
+
+
+A more complex array for a store inventory. Note that because we're using JSON5, quotes
+are optional for single words.
+```js
+[
+  "Simple T-shirt",
+  "Basic hoodie",
+  {
+    item: "Complex T-shirt",
+    sizes: ['S', 'M', 'L'],
+    price_us_cents: [1099, 1499, 1599],
+  }
+]
+```
+
+And a more complex object showing how you can internationalize and set style:
+```js
+{
+  "welcome_message": {
+    copy: {
+      'en': 'Welcome!',
+      'es': "¡Bienvenidos!",
+    }, style: {
+      color: '#0F0',
+      fontWeight: '700',
+    }
+  },
+  "buy_button" : {
+    copy: {
+      'en': 'Buy',
+      'es': "Comprar",
+    }, style: {
+      backgroundColor: "#F00",
+      border: "border-radius 10px",
+    }
+  }
+}
+```
+
 ## Getting Started
 
-### Get your API Key
+In four easy steps!
+
+### 1. Get your API Key
 
 You'll need a [Configly](https://www.config.ly) account. Registration is lightning quick&mdash;you can register via
 visiting [https://www.config.ly/signup](https://www.config.ly/signup).
@@ -52,27 +112,115 @@ visiting [https://www.config.ly/signup](https://www.config.ly/signup).
 After signing up, you can grab your API Key from [https://www.config.ly/register](https://www.config.ly/register).
 You'll need your API Key to setup the API below.
 
-### Library Installation
+### 2. Create your first Config
+From [https://www.config.ly/config](https://www.config.ly/config), create a new Config via the "Add" button:
+![image](https://user-images.githubusercontent.com/184923/98487495-3b42ca80-21f1-11eb-9bfc-bfd429733362.png)
+
+Consider creating a simple `JSON Object or Array` Config called `greetings` and give it the value of:
+`['hello', 'hola', '你好', 'नमस्ते']`:
+
+[https://www.config.ly/config](https://www.config.ly/config) should look like this:
+
+![image](https://user-images.githubusercontent.com/184923/98494454-09d6f880-220b-11eb-9ef7-36709ddc129f.png)
 
+Be sure to save via clicking 'Send to Clients'. Now, we'll write client code to fetch this key.
+
+### 3. Install the client library
+
+If you're using bundler, add the following line to your project's `Gemfile`:
+```sh
+gem 'configly-ruby', '~> 0.0.5'
+```
+
+Or, if you're using the Gem directly from your application, you can run:
 ```sh
 gem install configly-ruby
 ```
 
 You will need to set the `CONFIGLY_API_KEY` environment variable.
 
-### Using this library with websockets
+### 4. Fetch the Config
+In a Rails controller, add the following code
+```ruby
+def get
+   begin
+      key = Configly::Client.get(params[:key])
+      render plain: key
+   rescue Configly::KeyError
+      render :status => 404
+   end
+end
+```
+
+Map the route, and then request it in your browser with the `key` params (e.g. `http://localhost:3000/configly?key=test1234`). 
+
+Try changing some values on [https://www.config.ly/config](https://www.config.ly/config) to confirm that
+the client is getting the updates.
+
+Congratulations you have Configly working end-to-end! Now, feel free to use Configly with all your projects!
+
+## Configuring this library to use websockets
 Coming soon...
 
 ## Usage
+> The golden rule of Configly library use is: **do NOT** assign the result of a `get()`
+to a long-lived variable; in order to check for new values from the server, you must call `get()`.
+
+The package needs to be configured with your account's API key, which is available in the
+[Configly Configulator](https://config.ly/config)
+
+```
+// This value is stored on the Config.ly servers.
+store_catalog:
+{
+   has_sale: true,
+   discount: 0.8,
+   items: ['T Shirt', 'Hoodie', 'Ferrari'],
+   price: [ 100, 250,  200000],
+}
+```
 
-To fetch a key, use the following command:
+On the Ruby client:
 
 ```ruby
-Configly::Client.get(KEY)
+begin
+   catalog = Configly::Client.get(KEY)
+   items = catalog['items']
+   prices = catalog['prices']
+
+   items.each_with_index do |item, index|
+      Rails.logger.debug("#{item}: #{prices[index]} USD")
+   end
+rescue Configly::KeyError
+   Rails.logger.error("Something went wrong")
+end
 ```
 
-If the key doesn't exist (or if you are using the websockets client and it hasn't been prefetched), this will rais a `Configly::KeyError`
+Note: If the key doesn't exist, this will raise a `Configly::KeyError`
+
+Here is an example with feature flags. 
+// These values are stored on the Config.ly server
+```
+feature1_enabled: true
+feature2_enabled: false
+```
+
+On the ruby client:
+
+```ruby
+begin
+  if Configly::Client.get('feature1_enabled')
+    # Logic for feature 1
+  end
+
+  if Configly::Client.get('feature2_enabled')
+    # Logic for feature 2
+  end
+rescue Configly::KeyError
+   Rails.logger.error("Something went wrong")
+end
+```
 
 ## License
 
-This repository is published under the [MIT](LICENSE.md) license.
+This repository is published under the [MIT](LICENSE.md) license.

data/configly-ruby.gemspec

@@ -3,7 +3,7 @@ require_relative 'lib/configly/version'
 
 Gem::Specification.new do |s|
   s.name        = 'configly-ruby'
-  s.version     = '0.0.5'
+  s.version     = '0.0.6'
   s.date        = '2020-11-16'
   s.summary     = "Configly"
   s.description = "Configly SDK gem"

data/lib/configly/client.rb

@@ -8,7 +8,7 @@ CONFIGLY_VALUE_URL = '/api/v1/value'
 module Configly
     class Client
         @keys = {}
-        @caches = {}
+        @ttl_expirations = {}
         @use_ws = false
         def self.init
             @use_ws = true
@@ -31,7 +31,7 @@ module Configly
         end
 
         def self.load_initial_data
-            @keys = fetch(get_keys_to_preload)
+            fetch(get_keys_to_preload, false)
         end
 
         def self.start_web_socket_client
@@ -62,19 +62,38 @@ module Configly
             end
         end
 
-        def self.fetch(keys)
-            uri = URI("https://#{CONFIGLY_SERVER}#{CONFIGLY_VALUE_URL}?#{generate_qs(keys)}")
-            loaded_keys = {}
-            Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
-                request = Net::HTTP::Get.new uri
-                request.basic_auth get_api_key, ''
-                response = http.request request
-                data = JSON.parse(response.body)['data']
-                data.keys.each do |key|
-                    loaded_keys[key] = data[key]['value']
+        def self.fetch(keys, use_ttls)
+            current_time = Time.now.to_i
+
+            # If we aren't using the TTLs, fetch all keys
+            if !use_ttls
+                keys_to_fetch = keys
+            else
+                # Otherwise, fetch the keys that are unfetched or expired
+                keys_to_fetch = []
+                keys.each do |key|
+                    if !@ttl_expirations.has_key?(key) || @ttl_expirations[key] < current_time
+                        keys_to_fetch << key
+                    end
+                end
+            end
+
+            # Only actually execute the request if there are keys to fetch
+            if keys_to_fetch.length > 0
+                uri = URI("https://#{CONFIGLY_SERVER}#{CONFIGLY_VALUE_URL}?#{generate_qs(keys_to_fetch)}")
+
+                Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+                    request = Net::HTTP::Get.new uri
+                    request.basic_auth get_api_key, ''
+                    response = http.request request
+                    data = JSON.parse(response.body)['data']
+                    data.keys.each do |key|
+                        # Set the key and the expiration
+                        @keys[key] = data[key]['value']
+                        @ttl_expirations[key] = current_time + data[key]['ttl']
+                    end
                 end
             end
-            return loaded_keys
         end
 
         def self.get(key)
@@ -85,9 +104,9 @@ module Configly
                     raise KeyError.new(key)
                 end
             else
-                loaded_keys = fetch([key])
-                if loaded_keys.has_key? key
-                    return loaded_keys[key]
+                fetch([key], true)
+                if @keys.has_key? key
+                    return @keys[key]
                 else
                     raise KeyError.new(key)
                 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configly-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Dana Levine