traitify 1.8.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58c9b5d889ea03bdf0e6772d54ea60557a4683f5
-  data.tar.gz: 25820511725fc3dcf27e3118edbdc80003fcab57
+SHA256:
+  metadata.gz: '080c41445afd77a214878d4d168ec0282c57e67a9d4c35d87e41de7313d903c1'
+  data.tar.gz: 65c2e954bf74dda9d72a0d99907794310b2497af7360f10922f25a7dfdfddb66
 SHA512:
-  metadata.gz: 9038ae9d321c42c792cec46bc35007c4af394700ffa67b8c815a9dce48199e64e8a0b9a3c94ffc539039f9eff96798cc790df8073238a6e54a6470ce1967994e
-  data.tar.gz: 18a402a17d30443eb74a0a05c58de3fc520bd7999cc6cac7244d2f34c90556d5a3ec0e68ae498e706b544bc557fdbabb1325b141bdb4d26c994d2965386a8bb1
+  metadata.gz: 01f85cca8ab81448f68e9b5c105678186e330280b12ac2d0aeca3cba8ab5995cc444516b592e2c793c1e29009b8fe8bf149e6d18e4712c637a5cfc0e88e07427
+  data.tar.gz: ea19044bc059b70eef832b98edead636712727e6fc00508639e4d0ec452b327a27209834118af5b300abd298f770f9dd4fd27f1ee88d062d04ebca5d2b641ec0

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  rubocop-traitify: .rubocop_traitify.yml
+
+Rails:
+  Enabled: false
+
+# Requires breaking change
+Airbnb/OptArgParameters:
+  Enabled: true
+  Exclude:
+    - lib/traitify/client/model.rb

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 1.9.0
+
+* Features
+  * Added locales
+
+### 1.8.4
+
+* Bug Fixes
+  * Removed require meant for development
+
+### 1.8.3
+
+* Bug Fixes
+  * Fixed error handling bug on special cases
+  * Updated docs
+
 ### 1.8.2
 
 * Bug Fixes

data/Gemfile

@@ -1,4 +1,8 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in traitify.gemspec
 gemspec
+
+group :development do
+  gem "rubocop-traitify"
+end

data/Gemfile.lock

@@ -1,56 +1,123 @@
 PATH
   remote: .
   specs:
-    traitify (1.8.1)
-      faraday (~> 0.9)
-      faraday_middleware (~> 0.9)
-      hashie (~> 3.0)
+    traitify (2.0.0)
+      activesupport (>= 5.1, < 8.x)
+      faraday (~> 2.5)
+      faraday-net_http (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.7)
-    binding_of_caller (0.7.2)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
-    coderay (1.1.0)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    debug_inspector (0.0.2)
-    diff-lcs (1.2.5)
-    faraday (0.9.1)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.9.1)
-      faraday (>= 0.7.4, < 0.10)
-    hashie (3.4.1)
-    method_source (0.8.2)
-    multipart-post (2.0.0)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.4.2)
-    rspec (2.99.0)
-      rspec-core (~> 2.99.0)
-      rspec-expectations (~> 2.99.0)
-      rspec-mocks (~> 2.99.0)
-    rspec-core (2.99.2)
-    rspec-expectations (2.99.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.99.3)
-    safe_yaml (1.0.4)
-    slop (3.6.0)
-    webmock (1.20.4)
-      addressable (>= 2.3.6)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    debug_inspector (1.1.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.0)
+    rack (2.2.4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-airbnb (4.0.0)
+      rubocop (~> 0.93.1)
+      rubocop-performance (~> 1.10.2)
+      rubocop-rails (~> 2.9.1)
+      rubocop-rspec (~> 1.44.1)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    rubocop-traitify (1.1.0)
+      rubocop-airbnb (~> 4.0.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-20
+  arm64-darwin-21
 
 DEPENDENCIES
-  binding_of_caller (~> 0.7)
-  bundler (~> 1.3)
-  pry (~> 0.10)
-  rake (~> 10.1)
-  rspec (~> 2.14)
+  binding_of_caller (~> 1.0)
+  bundler (~> 2.2)
+  pry (~> 0.14)
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rubocop-traitify
+  simplecov (~> 0.21.2)
   traitify!
-  webmock (~> 1.13)
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.2.33

data/README.md

@@ -1,6 +1,6 @@
 # Traitify
 
-Traitify is a ruby gem wrapper for the Traitify Developer's API
+Traitify is a ruby gem wrapper for Traitify's Personality API
 
 ## Installation
 
@@ -14,40 +14,44 @@ Or install it yourself with:
 
 ## Usage
 
-First, it is helpful to configure Traitify, otherwise everytime you create a Traitify object you must add the configuration
+The Traitify Client supports dynamically creating resource routes as seen in the examples below. Alternatively, HTTP methods (get, post, put, delete, path) can be used directly.
+
+It is helpful to configure Traitify, otherwise everytime you create a Traitify object you must add the configuration options.
 
 ### Configuration
 
-All the configuration options can be found in `lib/Traitify/configuration.rb`
+All the configuration options can be found in `lib/traitify/configuration.rb`
 
     Traitify.configure do |traitify|
-      traitify.secret = "secret"
-      traitify.api_host = "http://example.com"
-      traitify.api_version = "v1"
+      traitify.host = "https://api-sandbox.traitify.com"
+      traitify.version = "v1"
+      traitify.secret_key = "secret"
+      traitify.public_key = "public" # Optional
       traitify.deck_id = "deck-uuid"  # Optional
       traitify.image_pack = "image-pack-type"  # Optional
+      traitify.locale_key = "en-us"  # Optional
     end
 
 #### With config file:
 
     traitify = Traitify.new
-    traitify.create_assessment
+    traitify.assessments.create
 
 #### Without config file:
 
     traitify = Traitify.new(
-      api_host: "http://example.com",
-      api_version: "v1",
-      deck_id: "deck-uuid",
-      secret: "secret"
+      host: "https://api-sandbox.traitify.com",
+      version: "v1",
+      secret_key: "secret",
+      deck_id: "deck-uuid"
     )
-    traitify.create_assessment
+    traitify.assessments.create
 
 ### Decks
 
 #### Getting all the decks:
 
-    decks = traitify.decks
+    decks = traitify.decks.data
 
 Returns an array of Deck objects:
 
@@ -61,26 +65,27 @@ Returns an array of Deck objects:
 
 #### Creating an assessment:
 
-    assessment = traitify.create_assessment
+    assessment = traitify.assessments.create
 
 You must can specify the deck in your configuration or override it here
 
-    assessment = traitify.create_assessment(deck_id: "deck-uuid")
+    assessment = traitify.assessments.create(deck_id: "deck-uuid")
 
-You can also specify an image pack, otherwise a default image pack associated with the secret is used
+You can optionally specify image pack or locale
 
-    assessment = traitify.create_assessment(image_pack: "full-color")
+    assessment = traitify.assessments.create(image_pack: "full-color")
 
 Returns an assessment object:
 
-    assessment.id           #=> "assessment-uuid"
-    assessment.deck_id      #=> "deck-uuid"
-    assessment.created_at   #=> Returns time in Epoch format
-    assessment.completed_at #=> nil
+    data = assessment.data
+    data.id           #=> "assessment-uuid"
+    data.deck_id      #=> "deck-uuid"
+    data.created_at   #=> Returns time in Epoch format
+    data.completed_at #=> nil
 
 #### Finding an assessment:
 
-    assessment = traitify.find_assessment("assessment-uuid")
+    assessment = traitify.assessments("assessment-uuid").data
 
 Returns an assessment object as seen above
 
@@ -90,7 +95,7 @@ An assessment can be taken through our javascript plugin or by getting the slide
 
 #### Finding an assessment's slides:
 
-    slides = traitify.find_slides("assessment-uuid")
+    slides = traitify.assessments("assessment-uuid").slides.data
 
 Returns an array of slides
 
@@ -104,20 +109,20 @@ Returns an array of slides
       slide
     end
 
-    traitify.update_slides("assessment-uuid", slides)
+    traitify.assessments("assessment-uuid").slides.update(slides)
 
 #### Updating a single assessment slide:
 
-    slide = assessment.slides.first
+    slide = assessment.slides.data.first
     slide.response = true
     slide.time_taken = 600
-    traitify.update_slide(assessment.id, slide)
+    traitify.assessments(assessment.id).slides(slide.id).update(slide.to_h)
 
 ### Results
 
 #### Getting an assessment's results
 
-    results = traitify.find_results("assessment-uuid")
+    results = traitify.assessments("assessment-uuid").personality_types.data
 
 Returns a results object:
 
@@ -146,10 +151,39 @@ Returns a results object:
 
 #### Getting an assessment's personality traits
 
-    traits = traitify.assessment_personality_traits("assessment-uuid")
+    traits = traitify.assessments("assessment-uuid").personality_traits.data
     trait = traits.first
     trait.score #=> 100
     personality_trait = trait.personality_trait
     personality_trait.name        #=> "Imaginative"
     personality_trait.definition  #=> "Able to think symbolically and play with ideas."
     personality_trait.description #=> "Coming Soon"
+
+#### Getting an assessment's analytics
+
+    traits = traitify.analytics.decks("deck-uuid").personality_traits.data
+    types = traitify.analytics.decks("deck-uuid").personality_types.data
+    assessments = traitify.analytics.decks("deck-uuid").assessments.data
+
+#### Getting a profile
+
+    profile = traitify.profiles("profile-uuid").data
+    profile.first_name        #=> "John"
+    profile.last_name         #=> "Doe"
+    profile.email             #=> "johndoe@example.com"
+
+#### Creating a profile
+
+    profile = traitify.profiles.create({
+        first_name: "John",
+        last_name: "Doe",
+        email: "johndoe@example.com"
+    }).data
+
+    profile.first_name        #=> "John"
+    profile.last_name         #=> "Doe"
+    profile.email             #=> "johndoe@example.com"
+
+#### More results
+
+More API endpoints may be available. You can find more at [app.traitify.com/developer](https://app.traitify.com/developer).

data/lib/traitify/client/connection.rb

@@ -0,0 +1,22 @@
+require "faraday"
+require "faraday/net_http"
+require "traitify/middleware/formatter"
+require "traitify/middleware/raise_error"
+
+module Traitify
+  class Client
+    module Connection
+      def connection(options = {})
+        Faraday.new(options) do |faraday|
+          faraday.request :authorization, :basic, secret_key || public_key, "x"
+          faraday.request :json
+          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
+        end
+      end
+    end
+  end
+end

data/lib/traitify/client/model.rb

@@ -0,0 +1,45 @@
+module Traitify
+  class Client
+    module Model
+      def find(params = {})
+        copy.set(verb: :get).add_params(params).request
+      end
+      alias_method :all, :find
+
+      def create(params = {})
+        copy.set(verb: :post, params: params).request
+      end
+
+      def destroy
+        copy.set(verb: :delete).request
+      end
+
+      def update(params, verb = :put)
+        copy.set(verb: verb, params: params).request
+      end
+
+      def base(name, params = {})
+        client = copy.set(type: name, verb: :get).add_path("/#{name}")
+
+        if [NilClass, Hash, Array].include? params.class
+          client.set(params: params)
+        else
+          client.add_path("/#{params}")
+        end
+
+        client
+      end
+
+      private
+
+      def copy
+        Traitify.new(options).set(
+          type: type.deep_dup,
+          verb: verb.deep_dup,
+          path: path.deep_dup,
+          params: params.deep_dup
+        )
+      end
+    end
+  end
+end

data/lib/traitify/client/overrides.rb

@@ -0,0 +1,27 @@
+module Traitify
+  class Client
+    module Overrides
+      def perform_overrides
+        send("#{type}_override") if respond_to? "#{type}_override"
+
+        self
+      end
+
+      def assessments_override
+        if params[:data] && params[:data].is_a?(Array)
+          @params[:data] = params[:data].join(",")
+        end
+      end
+
+      def personality_types_override
+        if image_pack && params[:image_pack].nil?
+          @params[:image_pack] = image_pack
+        end
+      end
+
+      def locales_override
+        @params.delete(:locale_key)
+      end
+    end
+  end
+end

data/lib/traitify/client/request.rb

@@ -0,0 +1,33 @@
+module Traitify
+  class Client
+    module Request
+      [:get, :post, :put, :delete, :patch].each do |verb|
+        define_method verb do |path, params = {}|
+          copy.set(verb: verb, path: path, params: params).request
+        end
+      end
+
+      def request
+        @request = Traitify::Response.new(base_request)
+      end
+      alias_method :fetch, :request
+
+      def data
+        @data ||= request.data
+      end
+
+      private
+
+      def base_request
+        unless locale_key.nil? || params.is_a?(Array) || params[:locale_key]
+          set_param(:locale_key, locale_key)
+        end
+
+        request_path = [version, path].join
+        request_params = params&.as_json
+
+        connection(url: host).public_send(verb, request_path, request_params)
+      end
+    end
+  end
+end

data/lib/traitify/client/setup.rb

@@ -0,0 +1,25 @@
+module Traitify
+  class Client
+    module Setup
+      def set(options)
+        @type = options[:type] if options[:type]
+        @verb = options[:verb] if options[:verb]
+        @path = options[:path] if options[:path]
+        @params = options[:params] if options[:params]
+        perform_overrides
+      end
+
+      def set_param(key, value)
+        set(params: params.merge(key => value))
+      end
+
+      def add_params(new_params)
+        set(params: params.merge(new_params))
+      end
+
+      def add_path(value)
+        set(path: path + value)
+      end
+    end
+  end
+end

data/lib/traitify/client.rb

@@ -1,40 +1,33 @@
-# require base modules
-require "traitify/connection"
-require "traitify/request"
-require "hashie"
-# require client modules in lib/Traitify/client
-Dir[File.expand_path("../client/*.rb", __FILE__)].each {|f| require f }
+require "uri"
+Dir[File.expand_path("../client/*.rb", __FILE__)].each{ |f| require f }
 
 module Traitify
   class Client
     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
-
-    alias_method :api_host, :host
-    alias_method :api_host=, :host=
-
-    alias_method :api_version, :version
-    alias_method :api_version=, :version=
-
-    alias_method :secret, :secret_key
-    alias_method :secret=, :secret_key=
+    attr_reader :type, :verb, :path, :params
 
     def initialize(options = {})
-      options = Traitify.options.merge(options)
-
-      options.each do |key, value|
+      Traitify.options.merge(options).each do |key, value|
         send("#{key}=", value) unless value.nil?
       end
+
+      set(verb: :get, path: "", params: {})
     end
 
-    include Traitify::Connection
-    include Traitify::Configuration
-    include Traitify::Request
+    def method_missing(method_name, *args, &block)
+      base(method_name, *args)
+    end
 
-    include Traitify::Client::Deck
-    include Traitify::Client::Assessment
-    include Traitify::Client::Slide
-    include Traitify::Client::Result
-    include Traitify::Client::Career
-    include Traitify::Client::Major
+    def to_hash
+      Hash[instance_variables.collect{ |key| [key.to_s.delete("@"), instance_variable_get(key)] }]
+    end
+    alias_method :to_h, :to_hash
+
+    include Traitify::Configuration
+    include Traitify::Client::Connection
+    include Traitify::Client::Model
+    include Traitify::Client::Overrides
+    include Traitify::Client::Request
+    include Traitify::Client::Setup
   end
 end

data/lib/traitify/configuration.rb

@@ -6,26 +6,18 @@ module Traitify
       :secret_key,
       :version,
       :deck_id,
-      :image_pack
-    ]
+      :image_pack,
+      :locale_key
+    ].freeze
 
     attr_accessor(*VALID_OPTIONS_KEYS)
 
-    alias_method :api_host, :host
-    alias_method :api_host=, :host=
-
-    alias_method :api_version, :version
-    alias_method :api_version=, :version=
-
-    alias_method :secret, :secret_key
-    alias_method :secret=, :secret_key=
-
     def configure
       yield self
     end
 
     def options
-      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+      Hash[VALID_OPTIONS_KEYS.collect{ |key| [key, send(key)] }]
     end
   end
 end

data/lib/traitify/data.rb

@@ -0,0 +1,18 @@
+module Traitify
+  class Data < OpenStruct
+    def self.new(data)
+      case data
+      when Array
+        data.collect{ |row| new row }
+      when Hash
+        super data.transform_values{ |value| new value }
+      else
+        data
+      end
+    end
+
+    def as_json(*args)
+      @table.as_json(*args)
+    end
+  end
+end