tggl 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f188afbee52710e401e85119af7b088532901da7d0b98ff18c98f7de131e701a
-  data.tar.gz: bea5d9bc300e893e0f612f74b5724e751330f68f6cf1fc91d2df57cc431001c5
+  metadata.gz: cc176934b429ebb7ba025c8e0b91702443edef4d470f72c2cb315ff52b41a6fa
+  data.tar.gz: af39ab816611de04c1e85e6d81711428249c713e2464dc0a45b76ccbc147b490
 SHA512:
-  metadata.gz: 6d5c607bd0920f1015e21fbd32fbaeb89218659e74a9182db55db1e2165962a6725862eaeca627bcbde3b51d2df722625a5ad180cc05f15e0a093abfb938a90d
-  data.tar.gz: a9e71e5cecf685624229bbf1aba6c6601d8655494f1d4edb990d98cb0562ebffa186993ef1e6295f3210aef4e4f224448a561f25145f45e6f9db7166b932d5c1
+  metadata.gz: e50c639a4ac523900a07f488102760f56cb81946678f23301016d6a6ecf7cd9742ab3d2254c22809de1be207d20b6dc0f640258e763c72d6a5a3ad5c522e0742
+  data.tar.gz: 91ec02dca2c10894638bece25229a667157dc15761fbdc3812875168b937d2601df2239509aee87b64608a480fb3d968b8ec57a31573f4f891f7779f5da0c00c

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 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

@@ -24,27 +24,31 @@ module Tggl
     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 StandardError.new "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 StandardError.new 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

@@ -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,7 +248,7 @@ 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 StandardError.new "Unsupported operator #{rule[:operator]}"

data/lib/tggl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tggl
-  VERSION = "0.2.0"
+  VERSION = "1.0.1"
 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,8 @@ 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.description = "The Ruby SDK can be used to evaluate flags and report usage to the Tggl API or a Proxy."
   spec.homepage = "https://tggl.io/developers/sdks/ruby"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -23,7 +24,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
     end
-  end
+  end + ["README.md"]
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tggl
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - nick-keller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xxhash
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description:
+description: The Ruby SDK can be used to evaluate flags and report usage to the Tggl
+  API or a Proxy.
 email:
 - hello@tggl.io
 executables: []
@@ -120,5 +121,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Tggl client for Ruby
+summary: Tggl Ruby SDK
 test_files: []