tggl 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb38936e03d4a7db6f476eff96402f4cff1e1a77f543df54e206ae5838f6089
-  data.tar.gz: 4c44d480fa26bb4beb22eeb8e18eb9b3a7eb763e75444b13eb89094e441b6d55
+  metadata.gz: 4f2f3f7c97f21e54b3592793c93c5921072fcb3ad5cae368722387f5944b15be
+  data.tar.gz: 4d11a8c0c434364968b8b6aceea82743e5c858e67c6deaa8e4e681bec130256d
 SHA512:
-  metadata.gz: 4ed25464e700635d8bc60f6afa5f13d62bfe1b67197a4d3c5c3c802e90ff663086f0f6be654880617b1bed447af6bbbcb10b57dabdd53c639ce85880ba2d9e9f
-  data.tar.gz: cefcc8813e1231125bce0491e189c3a315695289f6fb07d343d6d978889ac60237c35a28aaea88faf0b5fcb0640c85d3423b6048a4485a6ab1e66a8825491cbd
+  metadata.gz: 0b97a0bb7f6f4ebc6c970295d48f00d4eaac668440dc0c86024bdc232ff791fef0e015f19d20130fb03a24b0d7ae6f5931ba971129a4b09ad4a61f05667e5d0b
+  data.tar.gz: 11d96b403156f66bc924d7f79e349b1e8591316129ebfa9511f2084be013bf6fc59dc8c5d3a3e40b4100f8d4f84b7de79f6a9f4c354922ffc6a66f90fe201e13

data/README.md

@@ -1,35 +1,54 @@
-# Tggl
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tggl`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://tggl.io/tggl-io-logo-white.svg">
+    <img align="center" alt="Tggl Logo" src="https://tggl.io/tggl-io-logo-black.svg" width="200rem" />
+  </picture>
+</p>
+
+<h1 align="center">Tggl Ruby SDK</h1>
+
+<p align="center">
+  The Ruby SDK can be used both on the client and server to evaluate flags and report usage to the Tggl API or a <a href="https://tggl.io/developers/evaluating-flags/tggl-proxy">proxy</a>.
+</p>
+
+<p align="center">
+  <a href="https://tggl.io/">🔗 Website</a>
+  •
+  <a href="https://tggl.io/developers/sdks/ruby">📚 Documentation</a>
+  •
+  <a href="https://rubygems.org/gems/tggl">📦 RubyGem</a>
+  •
+  <a href="https://www.youtube.com/@Tggl-io">🎥 Videos</a>
+</p>
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tggl.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Install the dependency:
+
+```bash
+gem install tggl
+```
+
+Start evaluating flags:
+
+```rb
+require "tggl"
+ 
+$client = Tggl::Client.new("YOUR_API_KEY")
+ 
+# An API call to Tggl is performed here
+$flags = $client.eval_context({
+  userId: "abc",
+  email: "foo@gmail.com",
+  country: "FR",
+  # ...
+})
+ 
+if $flags.is_active? "my-feature"
+  # ...
+end
+ 
+if $flags.get "my-feature" == "Variation A"
+  # ...
+end
+```

data/lib/tggl/client.rb

@@ -18,33 +18,37 @@ module Tggl
 
     def eval_context(context)
       response = eval_contexts([context]).first
-      raise "Unexpected empty response from Tggl" if response.nil?
+      raise StandardError.new "Unexpected empty response from Tggl" if response.nil?
 
       response
     end
 
     def eval_contexts(contexts)
-      uri = URI(@url)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-
-      request = Net::HTTP::Post.new(uri.path, {
-        'X-Tggl-Api-Key' => @api_key,
-        'Content-Type' => 'application/json'
-      })
-      request.body = contexts.to_json
-
-      response = http.request(request)
-      result = JSON.parse(response.body, symbolize_names: true)
-
-      if response.code.to_i > 200
-        if result.nil?
-          raise "Invalid response from Tggl: #{response.code}"
+      begin
+        uri = URI(@url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        request = Net::HTTP::Post.new(uri.path, {
+          'X-Tggl-Api-Key' => @api_key,
+          'Content-Type' => 'application/json'
+        })
+        request.body = contexts.to_json
+
+        response = http.request(request)
+        result = JSON.parse(response.body, symbolize_names: true)
+
+        if response.code.to_i > 200
+          if result.nil?
+            raise StandardError.new "Invalid response from Tggl: #{response.code}"
+          end
+          raise StandardError.new result['error']
         end
-        raise result['error']
-      end
 
-      result.map { |flags| Response.new(flags) }
+        result.map { |flags| Response.new(flags, reporter: @reporter) }
+      rescue
+        contexts.map { || Response.new({}, reporter: @reporter) }
+      end
     end
   end
 end

data/lib/tggl/local_client.rb

@@ -32,9 +32,9 @@ module Tggl
 
       if response.code.to_i > 200
         if result.nil?
-          raise "Invalid response from Tggl: #{response.code}"
+          raise StandardError.new "Invalid response from Tggl: #{response.code}"
         end
-        raise result['error']
+        raise StandardError.new result['error']
       end
 
       @config = Hash.new
@@ -139,12 +139,12 @@ module Tggl
 
       if rule[:operator] === "STR_AFTER"
         return false unless value.is_a?(String)
-        return value >= rule[:value]
+        return (value >= rule[:value]) != (rule[:negate].nil? ? false : rule[:negate])
       end
 
       if rule[:operator] === "STR_BEFORE"
         return false unless value.is_a?(String)
-        return value <= rule[:value]
+        return (value <= rule[:value]) != (rule[:negate].nil? ? false : rule[:negate])
       end
 
       if rule[:operator] === "REGEXP"
@@ -179,9 +179,9 @@ module Tggl
       if rule[:operator] === "DATE_AFTER"
         if value.is_a?(String)
           val = value[0, '2000-01-01T23:59:59'.length] + ('2000-01-01T23:59:59'[value.length..] || "")
-          return rule[:iso] <= val
+          return (rule[:iso] <= val) != (rule[:negate].nil? ? false : rule[:negate])
         elsif value.is_a?(Integer) || value.is_a?(Float)
-          return value < 631_152_000_000 ? (value * 1000 >= rule[:timestamp]) : (value >= rule[:timestamp])
+          return (value < 631_152_000_000 ? (value * 1000 >= rule[:timestamp]) : (value >= rule[:timestamp])) != (rule[:negate].nil? ? false : rule[:negate])
         end
         return false
       end
@@ -189,9 +189,9 @@ module Tggl
       if rule[:operator] === "DATE_BEFORE"
         if value.is_a?(String)
           val = value[0, '2000-01-01T00:00:00'.length] + ('2000-01-01T00:00:00'[value.length..] || "")
-          return rule[:iso] >= val
+          return (rule[:iso] >= val) != (rule[:negate].nil? ? false : rule[:negate])
         elsif value.is_a?(Integer) || value.is_a?(Float)
-          return value < 631_152_000_000 ? (value * 1000 <= rule[:timestamp]) : (value <= rule[:timestamp])
+          return (value < 631_152_000_000 ? (value * 1000 <= rule[:timestamp]) : (value <= rule[:timestamp])) != (rule[:negate].nil? ? false : rule[:negate])
         end
         return false
       end
@@ -248,10 +248,10 @@ module Tggl
         return false unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
         probability = XXhash.xxh32(value.to_s, rule[:seed]) / 0xFFFFFFFF.to_f
         probability -= 1.0e-8 if probability == 1
-        return probability >= rule[:rangeStart] && probability < rule[:rangeEnd]
+        return (probability >= rule[:rangeStart] && probability < rule[:rangeEnd]) != (rule[:negate].nil? ? false : rule[:negate])
       end
 
-      raise "Unsupported operator #{rule[:operator]}"
+      raise StandardError.new "Unsupported operator #{rule[:operator]}"
     end
   end
 end

data/lib/tggl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tggl
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/sig/tggl/response.rbs

@@ -3,7 +3,7 @@ module Tggl
     @flags: Hash[Symbol, any]
     @reporter: Reporting | nil
 
-    def initialize: (Hash[Symbol, untyped] flags, Reporting | nil reporter) -> void
+    def initialize: (Hash[Symbol, untyped] flags, { reporter: Reporting | nil, error?: Exception | nil } options) -> void
 
     def is_active?: (String slug) -> bool
     def get: (String slug, untyped default_value) -> untyped

data/tggl.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["nick-keller"]
   spec.email = ["hello@tggl.io"]
 
-  spec.summary = "Tggl client for Ruby"
+  spec.summary = "Tggl Ruby SDK"
   spec.homepage = "https://tggl.io/developers/sdks/ruby"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tggl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - nick-keller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xxhash
@@ -120,5 +120,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Tggl client for Ruby
+summary: Tggl Ruby SDK
 test_files: []