configly-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c22fd1c7b4856a9ad62ae8a870a40bbe447431c365a9a717faa512919e2fdce1
+  data.tar.gz: 1f1ea045a27b1dc8a5895b0d5f08054bfe0e9fdf15aae1c9759b21a3243ac0d6
+SHA512:
+  metadata.gz: 13beb93697288800ff73e9d14f870c3c5071e82aaaae93ed72dbb0d21270e122040ba8f1fa025bff32317e5754500539cd6d4a5c04dcd37c3c2cb250f3976d00
+  data.tar.gz: 39050f72a4cc0a5705a705a92616f316d20945d5e6becf91057c8e2b9935e1a731271680c546399c8589e0c08fe23fff0797fc1f15963ad95e429d79aabf055d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dana11235@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in configly-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    configly-ruby (0.0.1)
+      faye-websocket (~> 0.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    eventmachine (1.2.7)
+    faye-websocket (0.11.0)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  configly-ruby!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dana Levine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Configly React 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)
+
+Table of Contents
+=================
+
+  * [What is Configly?](#what-is-configly)
+     * [Core Features](#core-features)
+  * [Getting Started](#getting-started)
+     * [Get your API Key](#get-your-api-key)
+     * [Library installation](#library-installation)
+  * [Usage](#usage)
+  * [Example](#example)
+  * [License](#license)
+
+
+## What is Configly?
+
+[Configly](https://www.config.ly) is the place software developers put their static / config data—like
+ copy, styling, and minor configuration values.
+They can then update that data directly from [https://www.config.ly](https://www.config.ly/)
+without having to wait for a deploy process / app store review. Their app or webapp receives the data near instantly.
+Non-technical folks themselves can publish changes freeing developers to focus on hard software problems and not copy tweaks.
+
+On the backend, [Configly](https://www.config.ly) provides a read-optimized static-data key/value store built
+with the aim of being low-latency, and high-availability. The client libraries are made to be dead-simple, lean, and efficient 
+(via enhancements like caching). There is a fancy [web UI called the Configulator](https://config.ly/config)
+for setting and updating the configs as well as seeing things like change history. Configly is built for modern software development.
+
+There are a host of other benefits to using Configly (
+such as ensuring you do not have [data duplicated across clients](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), reducing load on your primary DB, and better tolerance for traffic spikes),
+read more about the benefits at [Configly](config.ly).
+
+### Core Features
+
+- 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.
+- Client libraries available in an expanding amount of languages.
+
+## Getting Started
+
+### Get your API Key
+
+You'll need a [Configly](https://www.config.ly) account. Registration is lightning quick—you can register via
+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
+
+```sh
+gem install configly-ruby
+```
+
+You will need to set the `CONFIGLY_API_KEY` environment variable.
+
+If you want to use the optional websocket library, you can set:
+```
+CONFIGLY_KEYS_TO_PRELOAD=test1,test2,test3 (these are the keys you want to use)
+CONFIGLY_USE_WS=true
+```
+
+## Usage
+
+To fetch a key, use the following command:
+
+```ruby
+Configly::Client.get(KEY)
+```
+
+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`
+
+## License
+
+This repository is published under the [MIT](LICENSE.md) license.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "configly/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/configly-ruby.gemspec

@@ -0,0 +1,19 @@
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+require_relative 'lib/configly/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'configly-ruby'
+  s.version     = '0.0.2'
+  s.date        = '2020-11-15'
+  s.summary     = "Configly"
+  s.description = "Configly SDK gem"
+  s.authors     = ["Dana Levine"]
+  s.email       = 'dana11235@gmail.com'
+  s.files       = `git ls-files -z`.split("\x0")
+  s.homepage    = 'https://rubygems.org/gems/configly'
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency 'faye-websocket', '~> 0.11'
+
+  s.require_paths = ["lib"]
+end

data/lib/configly/client.rb

@@ -0,0 +1,105 @@
+require 'net/http'
+require 'faye/websocket'
+require 'eventmachine'
+
+CONFIGLY_SERVER = 'api.config.ly'
+CONFIGLY_VALUE_URL = '/api/v1/value'
+
+module Configly
+    class Client
+        @keys = {}
+        @caches = {}
+        @use_ws = false
+        def self.init
+            @use_ws = true
+            if get_api_key
+                load_initial_data
+                Thread.new { EM.run { start_web_socket_client }}
+            end
+        end
+
+        def self.get_api_key
+            return ENV['CONFIGLY_API_KEY']
+        end
+
+        def self.get_keys_to_preload
+            return ENV['CONFIGLY_KEYS_TO_PRELOAD'].split(',')
+        end
+
+        def self.generate_qs(keys_to_preload)
+            return keys_to_preload.map { |key| "keys[]=#{key}" }.join("&")
+        end
+
+        def self.load_initial_data
+            @keys = fetch(get_keys_to_preload)
+        end
+
+        def self.start_web_socket_client
+            ws = Faye::WebSocket::Client.new("ws://configly.herokuapp.com", nil, {:ping => 30})
+
+            ws.on :open do |event|
+                Rails.logger.debug :open
+                ws.send(JSON.generate({"apiKey" => get_api_key, "type" => "handshake"}))
+            end
+
+            ws.on :message do |event|
+                Rails.logger.debug :message
+                data = JSON.parse(event.data)
+                if data["type"] == "configUpdate"
+                    payload = data["payload"]["payload"]
+                    keyToUpdate = payload['key']
+                    value = payload['value']
+                    @keys[keyToUpdate] = value
+                end
+
+                Rails.logger.debug @keys
+            end
+
+            ws.on :close do |event|
+                Rails.logger.debug :close
+                Rails.logger.debug event.code
+                start_web_socket_client
+            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
+                print "\n#{response.code}\n"
+                print "\n#{response.body}\n"
+                data = JSON.parse(response.body)['data']
+                data.keys.each do |key|
+                    loaded_keys[key] = data[key]['value']
+                end
+            end
+            return loaded_keys
+        end
+
+        def self.get(key)
+            if @use_ws
+                if @keys.has_key? key
+                    return @keys[key]
+                else
+                    raise KeyError.new(key)
+                end
+            else
+                loaded_keys = fetch([key])
+                if loaded_keys.has_key? key
+                    return[key]
+                else
+                    raise KeyError.new(key)
+                end
+            end
+        end
+    end
+
+    class KeyError < KeyError
+        def initialize(key)
+            super(key)
+        end
+    end
+end

data/lib/configly/railtie.rb

@@ -0,0 +1,9 @@
+module Configly
+    class Railtie < Rails::Railtie
+        config.after_initialize do
+            if ENV['CONFIGLY_USE_WS']
+                Client.init
+            end
+        end
+    end
+end

data/lib/configly/ruby.rb

@@ -0,0 +1,3 @@
+require 'configly/client'
+require 'configly/railtie'
+require 'configly/version'

data/lib/configly/version.rb

@@ -0,0 +1,3 @@
+module Configly
+  VERSION = "0.1.0"
+end

data/spec/configly/ruby_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe Configly::Ruby do
+  it "has a version number" do
+    expect(Configly::Ruby::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "configly/ruby"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: configly-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dana Levine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Configly SDK gem
+email: dana11235@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- configly-ruby.gemspec
+- lib/configly/client.rb
+- lib/configly/railtie.rb
+- lib/configly/ruby.rb
+- lib/configly/version.rb
+- spec/configly/ruby_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/configly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Configly
+test_files: []