traitify 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '080c41445afd77a214878d4d168ec0282c57e67a9d4c35d87e41de7313d903c1'
-  data.tar.gz: 65c2e954bf74dda9d72a0d99907794310b2497af7360f10922f25a7dfdfddb66
+  metadata.gz: f9a2fc61b25125bd280cbe82b3c1c0eb5562aca678c09a1852384c221b9cd51f
+  data.tar.gz: 3c4f1593e2ff811e884fd82855e4076c80e720a9da3682fe098747eca200ad05
 SHA512:
-  metadata.gz: 01f85cca8ab81448f68e9b5c105678186e330280b12ac2d0aeca3cba8ab5995cc444516b592e2c793c1e29009b8fe8bf149e6d18e4712c637a5cfc0e88e07427
-  data.tar.gz: ea19044bc059b70eef832b98edead636712727e6fc00508639e4d0ec452b327a27209834118af5b300abd298f770f9dd4fd27f1ee88d062d04ebca5d2b641ec0
+  metadata.gz: 1912577c0370b0a9aa817cb13ea1c34b865a61532a3648359e58e7a1117bf87b89bc5c016b899db554d70c74a3c0b9038e1f70d586af01021ce6e916d9d043a6
+  data.tar.gz: 72a6ba2691c93b0acb9eb318e52e3389a8b769c4860c09b6de8cf804b9ff63f128e0ea2b8e7c65c7044628d366ccf3c5db5c9493c92bb484642f9e114c51563e

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+### 2.1.0
+
+* Features
+  * Added automatic retries
+
+### 2.0.1
+
+* Bug Fixes
+  * Fixed an issue with nested params
+
+### 2.0.0
+
+* Features
+  * Refactored everything
+  * Added dynamic system to build a request
+  * Added overrides for specific resources
+  * Added dynamic system to interact with a response
+
+* Breaking Changes
+  * Removed custom methods for resources
+
 ### 1.9.0
 
 * Features
@@ -81,6 +102,3 @@
   * Get/Create Assessments
   * Get/Update Slides
   * Get Personality Blend, Types, and Traits
-
-  [@cpreisinger]:https://github.com/cpreisinger
-  [@tomprats]:https://github.com/tomprats

data/Gemfile.lock

@@ -1,40 +1,55 @@
 PATH
   remote: .
   specs:
-    traitify (2.0.0)
+    traitify (2.1.0)
       activesupport (>= 5.1, < 8.x)
       faraday (~> 2.5)
       faraday-net_http (~> 3.0)
+      faraday-retry (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3.1)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crack (0.4.5)
       rexml
     debug_inspector (1.1.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.5.2)
+    drb (2.2.0)
+      ruby2_keywords
+    faraday (2.8.1)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.0)
+    faraday-net_http (3.0.2)
+    faraday-retry (2.2.0)
+      faraday (~> 2.0)
     hashdiff (1.0.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.16.3)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -42,7 +57,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.0)
-    rack (2.2.4)
+    rack (3.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -96,7 +111,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
     webmock (3.18.1)
@@ -107,6 +122,7 @@ GEM
 PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   binding_of_caller (~> 1.0)

data/README.md

@@ -47,6 +47,50 @@ All the configuration options can be found in `lib/traitify/configuration.rb`
     )
     traitify.assessments.create
 
+### Auto Retry
+
+Requests that fail can be automatically retried.
+
+#### Retry Configuration
+
+Retrying can be configured in multiple ways.
+
+Through the general config:
+
+    Traitify.configure do |traitify|
+      traitify.auto_retry = true
+      traitify.retry_options = retry_options
+    end
+
+    traitify = Traitify.new
+    assessment = traitify.assessments("assessment-uuid").data
+
+On a specific request:
+
+    traitify = Traitify.new
+    assessment = traitify.retriable(retry_options).assessments("assessment-uuid").data
+
+Or with both:
+
+    Traitify.configure do |traitify|
+      traitify.auto_retry = false
+      traitify.retry_options = retry_options
+    end
+
+    traitify = Traitify.new
+    assessment = traitify.retriable.assessments("assessment-uuid").data
+
+This allows fine tuned control when and what to retry.
+
+#### Retry Options
+
+The options are passed to the [Faraday Retry](https://github.com/lostisland/faraday-retry) middleware. Supported options can be found in their documentation.
+
+    retry_options = {
+      methods: [:get, :post],
+      retry_statuses: [429, 500]
+    }
+
 ### Decks
 
 #### Getting all the decks:

data/lib/traitify/client/connection.rb

@@ -1,5 +1,6 @@
 require "faraday"
 require "faraday/net_http"
+require "faraday/retry"
 require "traitify/middleware/formatter"
 require "traitify/middleware/raise_error"
 
@@ -8,13 +9,15 @@ module Traitify
     module Connection
       def connection(options = {})
         Faraday.new(options) do |faraday|
-          faraday.request :authorization, :basic, secret_key || public_key, "x"
-          faraday.request :json
+          faraday.request(:authorization, :basic, secret_key || public_key, "x")
+          faraday.request(:json)
+          faraday.request(:retry, retry_options) if auto_retry
           faraday.headers["Accept"] = "application/json"
-          faraday.response :logger, Traitify.logger, formatter: Traitify::Middleware::Formatter
-          faraday.response :raise_traitify_error
-          faraday.response :json
-          faraday.adapter :net_http
+          faraday.options.params_encoder = Faraday::FlatParamsEncoder
+          faraday.response(:logger, Traitify.logger, formatter: Traitify::Middleware::Formatter)
+          faraday.response(:raise_traitify_error)
+          faraday.response(:json)
+          faraday.adapter(:net_http)
         end
       end
     end

data/lib/traitify/client/request.rb

@@ -7,13 +7,20 @@ module Traitify
         end
       end
 
+      def data
+        @data ||= request.data
+      end
+
       def request
         @request = Traitify::Response.new(base_request)
       end
       alias_method :fetch, :request
 
-      def data
-        @data ||= request.data
+      def retriable(**options)
+        copy.tap do |client|
+          client.auto_retry = true
+          client.retry_options = options unless options.blank?
+        end
       end
 
       private

data/lib/traitify/configuration.rb

@@ -5,9 +5,11 @@ module Traitify
       :public_key,
       :secret_key,
       :version,
+      :auto_retry,
       :deck_id,
       :image_pack,
-      :locale_key
+      :locale_key,
+      :retry_options
     ].freeze
 
     attr_accessor(*VALID_OPTIONS_KEYS)

data/lib/traitify/version.rb

@@ -1,3 +1,3 @@
 module Traitify
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/traitify.rb

@@ -1,3 +1,5 @@
+require "active_support"
+require "active_support/core_ext/object/deep_dup"
 require "traitify/configuration"
 require "traitify/client"
 require "traitify/data"
@@ -5,8 +7,6 @@ require "traitify/error"
 require "traitify/response"
 require "traitify/version"
 require "logger"
-require "active_support"
-require "active_support/core_ext/object/deep_dup"
 
 module Traitify
   extend Configuration

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require "active_support/core_ext/object/conversions"
 require "active_support/core_ext/object/json"
 require "webmock/rspec"

data/spec/support/mocks/aggregate.json

@@ -0,0 +1,7 @@
+{
+  "assessments": {
+    "completed_count": 5,
+    "created_count": 20,
+    "started_count": 10
+  }
+}

data/spec/traitify/client/examples/analytics_spec.rb

@@ -14,6 +14,22 @@ describe Traitify::Client do
   let(:client){ Traitify.new }
 
   describe ".analytics" do
+    context ".aggregate" do
+      let(:data){
+        client.analytics.decks("big-five")
+          .aggregate(stats: [:created_count, :started_count, :completed_count]).data
+      }
+
+      before(:each) do
+        query = "locale_key=en-us&stats=created_count&stats=started_count&stats=completed_count"
+        stub_it(:get, "/analytics/decks/big-five/aggregate?#{query}", "aggregate")
+      end
+
+      it "returns assessments" do
+        expect(data.assessments.started_count).to eq(10)
+      end
+    end
+
     context ".assessments" do
       let(:assessments){ client.analytics.decks("deck-id").assessments.data }
 

data/spec/traitify/client/examples/configuration_spec.rb

@@ -14,15 +14,15 @@ describe Traitify::Client do
       end
     end
 
-    it "assigns secret" do
-      expect(traitify.secret_key).to eq("secret")
+    it "assigns host" do
+      expect(traitify.host).to eq("https://example.com")
     end
 
-    it "assigns api_host" do
-      expect(traitify.host).to eq("https://example.com")
+    it "assigns secret" do
+      expect(traitify.secret_key).to eq("secret")
     end
 
-    it "assigns api_version" do
+    it "assigns version" do
       expect(traitify.version).to eq("v1")
     end
   end

data/spec/traitify/client/examples/retry_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe Traitify::Client do
+  before do
+    Traitify.configure do |client|
+      client.secret_key = "secret"
+      client.host = "https://example.com"
+      client.version = "v1"
+      client.deck_id = "deck-uuid"
+      client.logger = Logger.new("/dev/null")
+    end
+  end
+
+  let(:client){ Traitify.new(auto_retry: false) }
+
+  describe ".auto_retry" do
+    it "is set to true" do
+      client = Traitify.new(auto_retry: true)
+
+      expect(client.auto_retry).to eq(true)
+    end
+
+    it "is set to false" do
+      expect(client.auto_retry).to eq(false)
+    end
+  end
+
+  describe ".retriable" do
+    it "sets auto_retry" do
+      expect(client.retriable.auto_retry).to eq(true)
+    end
+
+    it "sets retry_options" do
+      expect(client.retriable(retry_statuses: [500]).retry_options).to match(
+        retry_statuses: [500]
+      )
+    end
+
+    it "uses existing retry_options" do
+      client = Traitify.new(retry_options: {retry_statuses: [500]})
+
+      expect(client.retriable.retry_options).to match(
+        retry_statuses: [500]
+      )
+    end
+
+    it "is retriable when extended" do
+      expect(client.retriable.profiles.auto_retry).to eq(true)
+    end
+
+    it "is retriable when nested" do
+      expect(client.profiles.retriable.auto_retry).to eq(true)
+    end
+
+    it "doesn't leak" do
+      expect(client.retriable.auto_retry).to eq(true)
+      expect(client.profiles.auto_retry).to eq(false)
+    end
+  end
+end

data/traitify.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Traitify Gem"
   spec.description   = "Traitify is a ruby gem wrapper for the Traitify API"
   spec.authors       = ["Tom Prats", "Eric Fleming", "Carson Wright"]
-  spec.email         = "tom@traitify.com"
+  spec.email         = "tom.prats@paradox.ai"
   spec.homepage      = "https://www.traitify.com"
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -21,12 +21,14 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activesupport", ">= 5.1", "< 8.x"
   spec.add_runtime_dependency "faraday", "~> 2.5"
   spec.add_runtime_dependency "faraday-net_http", "~> 3.0"
+  spec.add_runtime_dependency "faraday-retry", "~> 2.2"
 
   spec.add_development_dependency "binding_of_caller", "~> 1.0"
   spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "pry", "~> 0.14"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rubocop-traitify", "~> 1.10"
   spec.add_development_dependency "simplecov", "~> 0.21.2"
   spec.add_development_dependency "webmock", "~> 3.18"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traitify
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tom Prats
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,6 +60,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-traitify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +187,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.18'
 description: Traitify is a ruby gem wrapper for the Traitify API
-email: tom@traitify.com
+email: tom.prats@paradox.ai
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -187,6 +215,7 @@ files:
 - lib/traitify/version.rb
 - paths.yml
 - spec/spec_helper.rb
+- spec/support/mocks/aggregate.json
 - spec/support/mocks/assessment.json
 - spec/support/mocks/assessment_analytics.json
 - spec/support/mocks/assessment_with_results.json
@@ -216,6 +245,7 @@ files:
 - spec/traitify/client/examples/major_spec.rb
 - spec/traitify/client/examples/profiles_spec.rb
 - spec/traitify/client/examples/result_spec.rb
+- spec/traitify/client/examples/retry_spec.rb
 - spec/traitify/client/examples/slide_spec.rb
 - spec/traitify/client/model_spec.rb
 - spec/traitify/client/request_spec.rb
@@ -251,6 +281,7 @@ specification_version: 4
 summary: Traitify Gem
 test_files:
 - spec/spec_helper.rb
+- spec/support/mocks/aggregate.json
 - spec/support/mocks/assessment.json
 - spec/support/mocks/assessment_analytics.json
 - spec/support/mocks/assessment_with_results.json
@@ -280,6 +311,7 @@ test_files:
 - spec/traitify/client/examples/major_spec.rb
 - spec/traitify/client/examples/profiles_spec.rb
 - spec/traitify/client/examples/result_spec.rb
+- spec/traitify/client/examples/retry_spec.rb
 - spec/traitify/client/examples/slide_spec.rb
 - spec/traitify/client/model_spec.rb
 - spec/traitify/client/request_spec.rb