traitify 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63fba7187cd2db760a452ee645019b4b3c7f4639
+  data.tar.gz: a4679dc09c00cf736d46499ce4d8b48b35880ed3
+SHA512:
+  metadata.gz: a11b1f2283ab1414f20c8e7cab20a9ce555bd90dc17becf00f8af96d15e6c0a1ac78c02b87492f350f19c9884e74b328541da66419ca805977a1eb5a88917b6b
+  data.tar.gz: 10f132345ad8f3a41005ad0aaf07c80f38daf94c7c7c283a5a8ef1e07fd7f47d89f1c76ba6b836a827d7ab530b986a6693b21370af0cd1afcaeb11b079b45bee

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+# .dat*
+# .repl_history
+# build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+### 1.1.0
+
+* Features
+  * Added ability to get results (by [@tomprats])
+
+### 1.0.1
+
+* Bug Fixes
+  * Fixed error with package requires being capitalized (by [@cpreisinger])
+
+  [@cpreisinger]:https://github.com/cpreisinger
+  [@tomprats]:https://github.com/tomprats

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    traitify (1.1.0)
+      faraday (~> 0.8.0)
+      faraday_middleware (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    binding_of_caller (0.7.2)
+      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.8.9)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    method_source (0.8.2)
+    multipart-post (1.2.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    safe_yaml (1.0.3)
+    slop (3.5.0)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binding_of_caller
+  bundler (~> 1.3)
+  pry
+  rake (~> 10.1.0)
+  rspec (~> 2.14.0)
+  traitify!
+  webmock (~> 1.13.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tom Prats
+
+MIT License
+
+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,166 @@
+# Traitify
+
+Traitify is a ruby gem wrapper for the Traitify Developer's API
+
+## Installation
+
+Add this line to your Gemfile (using bundler):
+
+    gem 'traitify'
+
+Or install it yourself with:
+
+    gem install traitify
+
+## Usage
+
+First it is helpful to configure Traitify, otherwise everytime you create a Traitify object you must add the configuration
+
+### Configuration
+
+All the configuration options can be found in `lib/Traitify/configuration.rb`
+
+    Traitify.configure do |tom|
+      tom.secret = "secret"
+      tom.api_host = "http://example.com"
+      tom.api_version = "v1"
+      tom.deck_id = "deck-uuid"
+    end
+
+#### With config file:
+
+    tom = Traitify.new
+    tom.create_assessment
+
+#### Without config file:
+
+    tom = Traitify.new(api_host: "http://example.com", api_version: "v1", deck_id: "deck-uuid", secret: "secret")
+    tom.create_assessment
+
+### Users
+
+#### Creating a user:
+
+    user = tom.create_user(
+      first_name: "Tom",
+      last_name: "Prats",
+      email: "tom@tomprats.com"
+    )
+
+Returns a user object:
+
+    user.id         #=> "toms-uuid"
+    user.first_name #=> "Tom"
+    user.last_name  #=> "Prats"
+    user.email      #=> "tom@tomprats.com"
+
+#### Finding a user:
+
+    tom.find_user("toms-uuid")
+
+Returns a user object as seen above
+
+### Assessments
+
+#### Creating an assessment:
+
+    assessment = tom.create_assessment
+
+You can also pass a user id to tie it to a user
+
+    assessment = tom.create_assessment(user_id: "toms-uuid")
+
+You must can specify the deck in your configuration or override it here
+
+    assessment = tom.create_assessment(deck_id: "deck-uuid")
+
+Returns an assessment object:
+
+    assessment.id           #=> "assessment-uuid"
+    assessment.deck_id      #=> "deck-uuid"
+    assessment.user_id      #=> "toms-uuid"
+    assessment.created_at   #=> 46197-10-17 12:29:08 -0400
+    assessment.completed_at #=> nil
+
+#### Finding an assessment:
+
+    assessment = tom.find_assessment("assessment-uuid")
+
+Returns an assessment object as seen above
+
+#### Taking an assessment:
+
+An assessment can be taken through our javascript plugin or by getting the slides and iterating through them
+
+#### Finding an assessment's slides:
+
+    slides = tom.find_slides("assessment_id")
+
+Returns a slides object which has the assessment id but also functions as an array
+
+    slides.assessment_id #=> "assessment-uuid"
+    slides.first         #=> Slide object
+    slides.all           #=> Array of slide objects
+
+#### Updating an assessment's slides:
+
+    slides.all.map! do |slide|
+      # true for me, false for not me
+      slide.response = true
+      # Pass in the time it took to make that choice (milliseconds)
+      slide.time_taken = 600
+      slide
+    end
+
+    tom.update_slides(slides)
+
+#### Updating a single assessment slide:
+
+    slide = assessment.slides.first
+    slide.response = true
+    slide.time_taken = 600
+    slides.first = tom.update_slide(assessment.id, slide)
+
+Or with a hash
+
+    assessment.slides.first = tom.update_slide(
+      assessment_id: assessment.id,
+      slide_id:      assessment.slides.first.id,
+      response:      0,
+      time_taken:    600
+    )
+
+
+### Results
+
+#### Getting an assessment's results
+
+    results = tom.find_results("assessment-uuid")
+
+Returns a results object:
+
+    results.personality_blend #=> Personality blend object
+    results.personality_types #=> Array of personality type objects (with scores)
+
+    personality_blend = results.personality_blend
+    personality_blend.personality_type1                     #=> Personality type object (without score)
+    personality_blend.personality_type2                     #=> Personality type object (without score)
+    personality_blend.name                                  #=> "Visionary Creator"
+    personality_blend.description                           #=> "Visionary Creator description"
+    personality_blend.compliments                           #=> "Visionary Creator compliments"
+    personality_blend.conflicts                             #=> "Visionary Creator conflicts"
+    personality_blend.compatible_work_environment_1         #=> "Example text here"
+    personality_blend.compatible_work_environment_2         #=> "Example text here"
+    personality_blend.compatible_work_environment_3         #=> "Example text here"
+    personality_blend.compatible_work_environment_4         #=> "Example text here"
+
+    personality_type = results.personality_types.first
+    personality_type.name        #=> "Creator"
+    personality_type.description #=> "Creator description"
+    personality_type.badge       #=> Badge object
+    personality_type.score       #=> 100
+
+    badge = personality_type.badge
+    badge.image_small  #=> "http://s3.amazonaws.com/traitify-api/badges/creator/flat/small"
+    badge.image_medium #=> "http://s3.amazonaws.com/traitify-api/badges/creator/flat/medium"
+    badge.image_large  #=> "http://s3.amazonaws.com/traitify-api/badges/creator/flat/large"

data/lib/traitify.rb

@@ -0,0 +1,13 @@
+require "traitify/version"
+require "traitify/configuration"
+require "traitify/client"
+
+module Traitify
+  extend Configuration
+
+  class << self
+    def new(options = {})
+      Traitify::Client.new(options)
+    end
+  end
+end

data/lib/traitify/assessments.rb

@@ -0,0 +1,36 @@
+module Traitify
+  class Assessment
+    attr_accessor :id, :deck_id, :user_id, :created_at, :completed_at
+
+    def initialize(options = {})
+      self.id            = options[:id]
+      self.deck_id       = options[:deck_id]
+      self.user_id       = options[:user_id]
+      self.created_at    = options[:created_at]
+      self.completed_at  = options[:completed_at]
+    end
+
+    def self.parse_json(assessment)
+      created_at = assessment["created_at"] ? Time.at(assessment["created_at"]) : nil
+      completed_at = assessment["completed_at"] ? Time.at(assessment["completed_at"]) : nil
+
+      Assessment.new(
+        id:           assessment["id"],
+        deck_id:      assessment["deck_id"],
+        user_id:      assessment["user_id"],
+        created_at:   created_at,
+        completed_at: completed_at
+      )
+    end
+
+    def to_hash
+      {
+        id:           id,
+        deck_id:      deck_id,
+        user_id:      user_id,
+        created_at:   created_at,
+        completed_at: completed_at
+      }
+    end
+  end
+end

data/lib/traitify/badges.rb

@@ -0,0 +1,43 @@
+module Traitify
+  class Badge
+    attr_accessor :image_small, :image_medium, :image_large, :font_color, :color_1, :color_2, :color_3
+
+    def initialize(options = {})
+      self.image_small  = options[:image_small]
+      self.image_medium = options[:image_medium]
+      self.image_large  = options[:image_large]
+      self.font_color   = options[:font_color]
+      self.color_1      = options[:color1]
+      self.color_2      = options[:color2]
+      self.color_3      = options[:color3]
+    end
+
+    def self.parse_json(badge)
+      if badge
+        Badge.new(
+          image_small:  badge["image_small"],
+          image_medium: badge["image_medium"],
+          image_large:  badge["image_large"],
+          font_color:   badge["font_color"],
+          color_1:      badge["color_1"],
+          color_2:      badge["color_2"],
+          color_3:      badge["color_3"]
+        )
+      else
+        nil
+      end
+    end
+
+    def to_hash
+      {
+        image_small:  image_small,
+        image_medium: image_medium,
+        image_large:  image_large,
+        font_color:   font_color,
+        color_1:      color1,
+        color_2:      color2,
+        color_3:      color3
+      }
+    end
+  end
+end

data/lib/traitify/client.rb

@@ -0,0 +1,35 @@
+# require base modules
+require "traitify/connection"
+require "traitify/request"
+require "traitify/assessments"
+require "traitify/badges"
+require "traitify/personality_blends"
+require "traitify/personality_types"
+require "traitify/results"
+require "traitify/slides"
+require "traitify/users"
+# require client modules in lib/Traitify/client
+Dir[File.expand_path("../client/*.rb", __FILE__)].each {|f| require f }
+
+module Traitify
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options = {})
+      options = Traitify.options.merge(options)
+
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Traitify::Connection
+    include Traitify::Configuration
+    include Traitify::Request
+
+    include Traitify::Client::Assessment
+    include Traitify::Client::User
+    include Traitify::Client::Result
+    include Traitify::Client::Slide
+  end
+end

data/lib/traitify/client/assessments.rb

@@ -0,0 +1,20 @@
+module Traitify
+  class Client
+    module Assessment
+      def create_assessment(options = {})
+        assessment_params = { deck_id: self.deck_id }
+        assessment_params.merge!(deck_id: options[:deck_id]) if options[:deck_id]
+        assessment_params.merge!(user_id: options[:user_id]) if options[:user_id]
+        response = post("/assessments", assessment_params)
+
+        Traitify::Assessment.parse_json(response)
+      end
+
+      def find_assessment(assessment_id)
+        response = get("/assessments/#{assessment_id}")
+
+        Traitify::Assessment.parse_json(response)
+      end
+    end
+  end
+end