configly-ruby 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42b4285e7b42e00601a87e46cfb8680f07762ad577ae26ab840aeecefa57d1a
-  data.tar.gz: 96d5942a380b62128d30fac438dff07bfa47746ea85668926c6ab735eeec770c
+  metadata.gz: f5cd1a5ca5bd4fff4a416180ea014a83b38c53abb3bf88c95c73a1847acab147
+  data.tar.gz: 39f1058a0f232c79c974c3b3f40225e2bf9c686f2fa2a6a35ea1957d101d6ea7
 SHA512:
-  metadata.gz: b4f4fd9e7fb133c3ba13376929c06bd64a09c8e707347ddb325887ebb4d4161de3952af67b47edba1d0239401c1758a2c379980e29a2dec73dab0615a265210e
-  data.tar.gz: e0be4959d0af7c1bd59aa2d1030190cfaa4d798c9d2982f8badc0180f8b924cddee7d0fc892dfcefad0302968bfcce444b213fff253e525dee34383eed41b2e0
+  metadata.gz: 7b62c2e1201994d6d6b7e657a4f0ff8054f7fdf27a4c0f72d5321da02aa9216326329ed9c5ce269c53141587a565e6facfccfb206465d7662c378860463826b8
+  data.tar.gz: c8faaf70b43269cb72058eb129378de450bd5186135131d9200b4e77e9ea4c3899094e0c7f33d5499d4c10d8a73b9bc931d06e034dbd43c23eae60056f7f0dbc

data/README.md

@@ -9,12 +9,17 @@ Table of Contents
 
   * [What is Configly?](#what-is-configly)
      * [Core Features](#core-features)
+     * [Concepts/ Data Model](#concepts--data-model)
   * [Getting Started](#getting-started)
-     * [Get your API Key](#get-your-api-key)
-     * [Library installation](#library-installation)
+    + [1. Get your API Key](#1-get-your-api-key)
+    + [2. Create your first Config](#2-create-your-first-config)
+    + [3. Install the client library](#3-install-the-client-library)
+    + [4. Fetch the Config](#4-fetch-the-config)
   * [Usage](#usage)
-  * [Example](#example)
+    * [Feature Flags](#feature-flags)
+  * [Configuring this library to use websockets](#configuring-this-library-to-use-websockets)
   * [License](#license)
+- [Configly Ruby Library](#configly-ruby-library)
 
 
 ## What is Configly?
@@ -38,7 +43,7 @@ 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.
+- High availability, high-throughput, low-latency backend.
 - Smart caching on the client libraries to minimize server requests.
 - Client libraries available in an expanding amount of languages.
 
@@ -128,9 +133,9 @@ Be sure to save via clicking 'Send to Clients'. Now, we'll write client code to
 
 ### 3. Install the client library
 
-If you're using bundler, add the following line to your project's `Gemfile`:
+If you're using [Bundler](https://bundler.io/) (as is often the case with Rails), add the following line to your project's `Gemfile`:
 ```sh
-gem 'configly-ruby', '~> 0.0.5'
+gem 'configly-ruby', '~> 1.0.0'
 ```
 
 Or, if you're using the Gem directly from your application, you can run:
@@ -138,7 +143,7 @@ Or, if you're using the Gem directly from your application, you can run:
 gem install configly-ruby
 ```
 
-You will need to set the `CONFIGLY_API_KEY` environment variable.
+You will need to set the `CONFIGLY_API_KEY` [environment variable](https://www.rubyguides.com/2019/01/ruby-environment-variables/).
 
 ### 4. Fetch the Config
 In a Rails controller, add the following code
@@ -184,8 +189,9 @@ store_catalog:
 On the Ruby client:
 
 ```ruby
+# You can try this example out by setting the `CONFIGLY_API_KEY` environmental variable to our demo account: 'Dem0apiKEY' 
 begin
-   catalog = Configly::Client.get(KEY)
+   catalog = Configly::Client.get("store_catalog")
    items = catalog['items']
    prices = catalog['prices']
 
@@ -199,9 +205,12 @@ end
 
 Note: If the key doesn't exist, this will raise a `Configly::KeyError`
 
+### Feature Flags
 Here is an example with feature flags. 
-// These values are stored on the Config.ly server
+
 ```
+// These values are stored on the Config.ly server
+
 feature1_enabled: true
 feature2_enabled: false
 ```
@@ -209,6 +218,9 @@ feature2_enabled: false
 On the ruby client:
 
 ```ruby
+# Remember, you need to set the `CONFIGLY_API_KEY` environment variable. 
+# You can find your API Key on https://www.config.ly/config.
+
 begin
   if Configly::Client.get('feature1_enabled')
     # Logic for feature 1

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.7'
+  s.version     = '1.0.0'
   s.date        = '2020-11-16'
   s.summary     = "Configly"
   s.description = "Configly SDK gem"

data/lib/configly/client.rb

@@ -84,6 +84,7 @@ module Configly
 
                 Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
                     request = Net::HTTP::Get.new uri
+                    request['X-Lib-Version'] = "configly-ruby/#{Configly::VERSION}"
                     request.basic_auth get_api_key, ''
                     response = http.request request
                     data = JSON.parse(response.body)['data']

data/lib/configly/version.rb

@@ -1,3 +1,3 @@
 module Configly
-  VERSION = "0.0.7"
+  VERSION = "1.0.0"
 end

metadata

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