traitify 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63fba7187cd2db760a452ee645019b4b3c7f4639
-  data.tar.gz: a4679dc09c00cf736d46499ce4d8b48b35880ed3
+  metadata.gz: ddc1513959fbaa40d7eee6277c6f8c78579750bb
+  data.tar.gz: f70c23b1ebd7962997aac709f8b596c8fd7e38ad
 SHA512:
-  metadata.gz: a11b1f2283ab1414f20c8e7cab20a9ce555bd90dc17becf00f8af96d15e6c0a1ac78c02b87492f350f19c9884e74b328541da66419ca805977a1eb5a88917b6b
-  data.tar.gz: 10f132345ad8f3a41005ad0aaf07c80f38daf94c7c7c283a5a8ef1e07fd7f47d89f1c76ba6b836a827d7ab530b986a6693b21370af0cd1afcaeb11b079b45bee
+  metadata.gz: fccc6837f3529e1c3fe1eaf46e62c3298b1aaf5683463168dbe6bf9509ebdf4d59aca0bb7ba503061517fdd78c038d3e5ff681984f58537eda3291e76bea0b86
+  data.tar.gz: 568cb75b501279b86d7eaea660893f068d92c7e30572a8400e6bd19590162684de06db3ecae8e22a2ea9db4d18c8714b79a3af0e81d80794165ba7eb582c3879

data/CHANGELOG.md

@@ -1,12 +1,10 @@
-### 1.1.0
+### 1.1.1
 
 * Features
-  * Added ability to get results (by [@tomprats])
-
-### 1.0.1
-
-* Bug Fixes
-  * Fixed error with package requires being capitalized (by [@cpreisinger])
+  * Get Decks
+  * Get/Create Assessments
+  * Get/Update Slides
+  * Get Personality Blend, Types, and Traits
 
   [@cpreisinger]:https://github.com/cpreisinger
   [@tomprats]:https://github.com/tomprats

data/Gemfile

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

data/Gemfile.lock

@@ -4,6 +4,7 @@ PATH
     traitify (1.1.0)
       faraday (~> 0.8.0)
       faraday_middleware (~> 0.9.0)
+      hashie
 
 GEM
   remote: https://rubygems.org/
@@ -20,6 +21,7 @@ GEM
       multipart-post (~> 1.2.0)
     faraday_middleware (0.9.1)
       faraday (>= 0.7.4, < 0.10)
+    hashie (2.1.1)
     method_source (0.8.2)
     multipart-post (1.2.0)
     pry (0.9.12.6)

data/README.md

@@ -6,7 +6,7 @@ Traitify is a ruby gem wrapper for the Traitify Developer's API
 
 Add this line to your Gemfile (using bundler):
 
-    gem 'traitify'
+    gem "traitify"
 
 Or install it yourself with:
 
@@ -14,77 +14,73 @@ 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
+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"
+    Traitify.configure do |traitify|
+      traitify.secret = "secret"
+      traitify.api_host = "http://example.com"
+      traitify.api_version = "v1"
+      traitify.deck_id = "deck-uuid"  # Optional
+      traitify.image_pack = "image-pack-type"  # Optional
     end
 
 #### With config file:
 
-    tom = Traitify.new
-    tom.create_assessment
+    traitify = Traitify.new
+    traitify.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"
+    traitify = Traitify.new(
+      api_host: "http://example.com",
+      api_version: "v1",
+      deck_id: "deck-uuid",
+      secret: "secret"
     )
+    traitify.create_assessment
 
-Returns a user object:
+### Decks
 
-    user.id         #=> "toms-uuid"
-    user.first_name #=> "Tom"
-    user.last_name  #=> "Prats"
-    user.email      #=> "tom@tomprats.com"
+#### Getting all the decks:
 
-#### Finding a user:
+    decks = traitify.decks
 
-    tom.find_user("toms-uuid")
+Returns an array of Deck objects:
 
-Returns a user object as seen above
+    deck = decks.first
+    deck.id                   #=> "deck-uuid"
+    deck.name                 #=> "Career"
+    deck.description          #=> "Description of deck"
+    # And more
 
 ### Assessments
 
 #### Creating an assessment:
 
-    assessment = tom.create_assessment
+    assessment = traitify.create_assessment
 
-You can also pass a user id to tie it to a user
+You must can specify the deck in your configuration or override it here
 
-    assessment = tom.create_assessment(user_id: "toms-uuid")
+    assessment = traitify.create_assessment(deck_id: "deck-uuid")
 
-You must can specify the deck in your configuration or override it here
+You can also specify an image pack, otherwise a default image pack associated with the secret is used
 
-    assessment = tom.create_assessment(deck_id: "deck-uuid")
+    assessment = traitify.create_assessment(image_pack: "full-color")
 
 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.created_at   #=> Returns time in Epoch format
     assessment.completed_at #=> nil
 
 #### Finding an assessment:
 
-    assessment = tom.find_assessment("assessment-uuid")
+    assessment = traitify.find_assessment("assessment-uuid")
 
 Returns an assessment object as seen above
 
@@ -94,17 +90,13 @@ An assessment can be taken through our javascript plugin or by getting the slide
 
 #### 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 = traitify.find_slides("assessment-uuid")
 
-    slides.assessment_id #=> "assessment-uuid"
-    slides.first         #=> Slide object
-    slides.all           #=> Array of slide objects
+Returns an array of slides
 
 #### Updating an assessment's slides:
 
-    slides.all.map! do |slide|
+    slides.map! do |slide|
       # true for me, false for not me
       slide.response = true
       # Pass in the time it took to make that choice (milliseconds)
@@ -112,30 +104,20 @@ Returns a slides object which has the assessment id but also functions as an arr
       slide
     end
 
-    tom.update_slides(slides)
+    traitify.update_slides("assessment-uuid", 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
-    )
-
+    traitify.update_slide(assessment.id, slide)
 
 ### Results
 
 #### Getting an assessment's results
 
-    results = tom.find_results("assessment-uuid")
+    results = traitify.find_results("assessment-uuid")
 
 Returns a results object:
 
@@ -143,24 +125,31 @@ Returns a results 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_blend.personality_type_1 #=> Personality type object
+    personality_blend.personality_type_2 #=> Personality type object
+    personality_blend.name               #=> "Visionary Creator"
+    personality_blend.description        #=> "Visionary Creator description"
+    personality_blend.compliments        #=> "Visionary Creator compliments"
+    personality_blend.conflicts          #=> "Visionary Creator conflicts"
+
+    type = results.personality_types.first
+    type.score                   #=> 100
+    personality_type = type.personality_type
     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"
+
+#### Getting an assessment's personality traits
+
+    traits = traitify.assessment_personality_traits("assessment-uuid")
+    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"

data/lib/traitify/client.rb

@@ -1,13 +1,7 @@
 # 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 "hashie"
 # require client modules in lib/Traitify/client
 Dir[File.expand_path("../client/*.rb", __FILE__)].each {|f| require f }
 
@@ -27,9 +21,9 @@ module Traitify
     include Traitify::Configuration
     include Traitify::Request
 
+    include Traitify::Client::Deck
     include Traitify::Client::Assessment
-    include Traitify::Client::User
-    include Traitify::Client::Result
     include Traitify::Client::Slide
+    include Traitify::Client::Result
   end
 end

data/lib/traitify/client/assessments.rb

@@ -2,19 +2,19 @@ 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]
+        deck_id = options[:deck_id] || options["deck_id"] || self.deck_id
+        assessment_params = { deck_id: deck_id }
         response = post("/assessments", assessment_params)
 
-        Traitify::Assessment.parse_json(response)
+        Hashie::Mash.new(response)
       end
 
-      def find_assessment(assessment_id)
+      def assessment(assessment_id)
         response = get("/assessments/#{assessment_id}")
 
-        Traitify::Assessment.parse_json(response)
+        Hashie::Mash.new(response)
       end
+      alias_method :find_assessment, :assessment
     end
   end
 end

data/lib/traitify/client/decks.rb

@@ -0,0 +1,12 @@
+module Traitify
+  class Client
+    module Deck
+      def decks
+        response = get("/decks")
+
+        response.collect { |deck| Hashie::Mash.new(deck) }
+      end
+      alias_method :find_decks, :decks
+    end
+  end
+end

data/lib/traitify/client/results.rb

@@ -1,7 +1,7 @@
 module Traitify
   class Client
     module Result
-      def find_results(assessment_id, image_pack = nil)
+      def results(assessment_id, image_pack = nil)
         image_pack ||= self.image_pack
 
         if image_pack
@@ -10,8 +10,20 @@ module Traitify
           response = get("/assessments/#{assessment_id}/personality_types")
         end
 
-        Traitify::Result.parse_json(response)
+        Hashie::Mash.new(response)
       end
+      alias_method :find_results, :results
+
+      def assessment_personality_traits(assessment_id, personality_type_id = nil)
+        if personality_type_id
+          response = get("/assessments/#{assessment_id}/personality_types/#{personality_type_id}/personality_traits")
+        else
+          response = get("/assessments/#{assessment_id}/personality_traits")
+        end
+
+        response.collect { |personality_trait| Hashie::Mash.new(personality_trait) }
+      end
+      alias_method :find_assessment_personality_traits, :assessment_personality_traits
     end
   end
 end

data/lib/traitify/client/slides.rb

@@ -4,32 +4,25 @@ module Traitify
       def find_slides(assessment_id)
         response = get("/assessments/#{assessment_id}/slides")
 
-        Traitify::Slides.parse_json(assessment_id, response)
+        response.collect { |slide| Hashie::Mash.new(slide) }
       end
 
-      def update_slides(slides)
-        response = put("/assessments/#{slides.assessment_id}/slides", slides.to_update_params)
+      def update_slides(assessment_id, slides)
+        response = put("/assessments/#{assessment_id}/slides", slides)
 
-        Traitify::Slides.parse_json(slides.assessment_id, response)
+        response.collect { |slide| Hashie::Mash.new(slide) }
       end
 
-      def update_slide(hash_or_assessment_id, slide = nil)
-        if slide
-          assessment_id = hash_or_assessment_id
-          slide_id = slide.id
-          hash = slide.to_update_params.tap { |s| s.delete(:id) }
-        else
-          assessment_id = hash_or_assessment_id[:assessment_id]
-          slide_id =      hash_or_assessment_id[:slide_id]
-          hash = {
-            response:   hash_or_assessment_id[:response],
-            time_taken: hash_or_assessment_id[:time_taken]
-          }
-        end
+      def update_slide(assessment_id, slide)
+        slide_id = slide["id"] || slide[:id] || slide.id
+        params = {
+          response: slide["response"] || slide[:response] || slide.response,
+          time_taken: slide["time_taken"] || slide[:time_taken] || slide.time_taken,
+        }
 
-        response = put("/assessments/#{assessment_id}/slides/#{slide_id}", hash)
+        response = put("/assessments/#{assessment_id}/slides/#{slide_id}", params)
 
-        Traitify::Slide.parse_json(response)
+        Hashie::Mash.new(response)
       end
     end
   end

data/lib/traitify/error.rb

@@ -27,12 +27,10 @@ module Traitify
 
     private
     def error_message
-      message =  "#{response.env[:method].upcase} "
+      message =  "#{response.env[:method].upcase} | "
       message << "#{response.env[:url].to_s} | "
-      message << "#{response.status}: "
-      if response.body && response.body.respond_to?(map)
-        message << "#{response.body.map{|k,v| "#{k}: #{v.first}"}.join(", ")}"
-      end
+      message << "#{response.status} | "
+      message << "#{response.body}"
       message
     end
   end

data/lib/traitify/version.rb

@@ -1,3 +1,3 @@
 module Traitify
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/support/mocks/decks.json

@@ -0,0 +1,12 @@
+[
+  {
+    "id": "deck-uuid",
+    "name": "Career Deck",
+    "personality_group_id": "personality-group-uuid",
+    "personality_group_name": null,
+    "created_at": 1396230166317,
+    "active": true,
+    "slide_count": null,
+    "personality_group": null
+  }
+]