spartacus 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d82d4054fc362cd3424dd7e8b11f93c49f53784
-  data.tar.gz: 80ed221d733539482a3a6ffa98e00c50dbb43cb5
+  metadata.gz: 31da9b0ec8269d6bd47177af89c7f2721723f62e
+  data.tar.gz: f35356df271699f8a20d8f10e2e01711447cec0e
 SHA512:
-  metadata.gz: 4c4cfb7845038386351feae29156e369766fe2e0c72ac73c94744c615eeb675652b5ffd1e7cf8d0ccb6a9f427cfa216fd9873aa13f93bf95b4e2f8bd9c559a76
-  data.tar.gz: 98ebfc836c4cf24df5d1b882b81d40f8272559c8b775c36a5d4a602bbafa9048d73950c50a9638aa3fdc046f4a165d9d05697e1c4d5e35d625bf38a8cd6f0fa2
+  metadata.gz: c4ac64a7fb61f7ba4aa75a17268c2e78bfef24dac1e8487294e1074d5ed79aa717f9100f5f4d2bfe857397177cee5d4d2a22a95273f9b944b92ce10c4ba20b55
+  data.tar.gz: d5889bae900be86b0060f25a643c398f6330b7d666410f0f42765a3764cacf97531a00d2baf58b10d676734441ebe40cdf3241e5a7dae829a97394e90aedc796

data/README.md

@@ -15,7 +15,7 @@ gem install spartacus
 ... or add to your Gemfile
 
 ```ruby
-gem "spartacus", "~> 0.2.2"
+gem "spartacus", "~> 0.2.5"
 ```
 
 ## Usage
@@ -32,6 +32,10 @@ Then use the client to make requests:
 sc.update_checkpoint(129, {name: "New Checkpint Name"})
 ```
 
+## Documentation
+
+All the documentation lives [here](http://www.rubydoc.info/github/bmneely/spartacus/).
+
 ## Contributing
 
 1. Fork it

data/lib/client/alumni_stories.rb

@@ -3,7 +3,7 @@ require_relative 'base_client'
 module AlumniStories
   include BaseClient
 
-  # Create a checkpoint
+  # Change the sort order of an alumni story.
   #
   # @param id [Integer] An alumni story id.
   # @param direction [String] The direction to move to the alumni story.
@@ -17,7 +17,7 @@ module AlumniStories
       url = "#{@api_base_path}/alum_stories/#{id}/update_sort_order"
 
       handle_timeouts do
-        response = self.class.post(url,
+        response = self.class.put(url,
                                    headers: auth_header,
                                    body: { direction: direction })
         convert_response(response, "alumni_story")

data/lib/client/chapters.rb

@@ -0,0 +1,4 @@
+module Chapters
+  def show_chapters
+  end
+end

data/lib/client/checkpoints.rb

@@ -45,18 +45,18 @@ module Checkpoints
     end
   end
 
-  # Delete a checkpoint
+  # # Delete a checkpoint
+  # #
+  # # @param id [Integer] A checkpoint id.
+  # # @return [Checkpoint] The deleted checkpoint.
+  # # @example Delete a checkpoint
+  # #   Spartacus#delete_checkpoint(1, {name: 'Real Cool Checkpoint'})
+  # def delete_checkpoint(id)
+  #   url = "#{@api_base_path}/checkpoints/#{id}"
   #
-  # @param id [Integer] A checkpoint id.
-  # @return [Checkpoint] The deleted checkpoint.
-  # @example Delete a checkpoint
-  #   Spartacus#delete_checkpoint(1, {name: 'Real Cool Checkpoint'})
-  def delete_checkpoint(id)
-    url = "#{@api_base_path}/checkpoints/#{id}"
-
-    handle_timeouts do
-      response = self.class.delete(url, headers: auth_header)
-      convert_response(response, "checkpoint")
-    end
-  end
+  #   handle_timeouts do
+  #     response = self.class.delete(url, headers: auth_header)
+  #     convert_response(response, "checkpoint")
+  #   end
+  # end
 end

data/lib/client/course_subjects.rb

@@ -0,0 +1,58 @@
+module CourseSubjects
+
+  # Create a course subject
+  #
+  # @param name [String] Name of the subject.
+  # @param display_name [String] User friendly name of the subject.
+  # @param occupation_name [String] Name of a person who has this job.
+  # @param options [Hash] A customizable set of options.
+  # @option options [Array] :default_goal_options Default goal options.
+  # @option options [Integer] :director_id Id of the course director.
+  # @option options [String] :director_slug User friendly director name.
+  # @return [CourseSubject] The created course subject
+  # @example Create a course subject
+  #   Spartacus#create_course_subject()
+  def create_course_subject(name, display_name, occupation_name, options={})
+    whitelist = ['default_goal_options', 'director_id', 'director_slug']
+
+    options = convert_keys(options)
+    course_subject_params = whitelist_params(options, whitelist)
+    course_subject_params.merge!({ name: name, display_name: display_name, occupation_name: occupation_name })
+    url = "#{@api_base_path}/course_subjects"
+
+    handle_timeouts do
+      response = self.class.post(url,
+                                 headers: auth_header,
+                                 body: { course_subject: course_subject_params })
+      convert_response(response, "course_subject")
+    end
+  end
+
+  # Update a course subject
+  #
+  # @param id [Integer] A course subject id.
+  # @param options [Hash] A customizable set of options.
+  # @option options [String] :name Name of the subject.
+  # @option options [String] :display_name User friendly name of the subject.
+  # @option options [String] :occupation_name Name of a person who has this job.
+  # @option options [Array] :default_goal_options Default goal options.
+  # @option options [Integer] :director_id Id of the course director.
+  # @option options [String] :director_slug User friendly director name.
+  # @return [CourseSubject] The updated course subject
+  # @example Update a course subject
+  #   Spartacus#update_course_subject()
+  def update_course_subject(id, options={})
+    whitelist = ['name', 'display_name', 'occupation_name', 'default_goal_options', 'director_id', 'director_slug']
+
+    options = convert_keys(options)
+    course_subject_params = whitelist_params(options, whitelist)
+    url = "#{@api_base_path}/course_subjects/#{id}"
+
+    handle_timeouts do
+      response = self.class.put(url,
+                                 headers: auth_header,
+                                 body: { course_subject: course_subject_params })
+      convert_response(response, "course_subject")
+    end
+  end
+end

data/lib/client/roadmap_sections.rb

@@ -16,8 +16,10 @@ module RoadmapSections
   # @example Create a checkpoint
   #   Spartacus#create_checkpoint(1, {name: 'Real Cool Checkpoint'})
   def create_checkpoint(id, options={})
-    accepted_params = ['name', 'summary', 'body', 'assignment', 'points', 'body_and_assignment']
-    checkpoint_params = options.select {|k, v| accepted_params.include?(k) }
+    whitelist = ['name', 'summary', 'body', 'assignment','body_and_assignment', 'points']
+
+    options = convert_keys(options)
+    checkpoint_params = whitelist_params(options, whitelist)
     url = "#{@api_base_path}/roadmap_sections/#{id}/create_checkpoint"
 
     handle_timeouts do

data/lib/client/users.rb

@@ -1,4 +1,7 @@
+require_relative 'base_client'
+
 module Users
+  include BaseClient
 
   # Get all users
   #
@@ -190,31 +193,31 @@ module Users
     end
   end
 
-  # Update a user's data
+  # # Update a user's data
+  # #
+  # # @param id [Integer] A user id.
+  # # @param options [Hash] A customizable set of options.
+  # # @option options [String] :how_heard How user heard about Bloc.
+  # # @option options [String] :how_heard_details How user heard about Bloc details.
+  # # @option options [String] :how_paid How user paid for Bloc.
+  # # @option options [String] :how_paid_details How user paid for Bloc details.
+  # # @return [UserData] The updated user data.
+  # # @example Update a user's data
+  # #   Spartacus#update_user_data(129, {how_heard: 'On the Googles'})
+  # def update_user_data(id, options={})
+  #   whitelist = ['how_heard', 'how_heard_details', 'how_paid', 'how_paid_details']
   #
-  # @param id [Integer] A user id.
-  # @param options [Hash] A customizable set of options.
-  # @option options [String] :how_heard How user heard about Bloc.
-  # @option options [String] :how_heard_details How user heard about Bloc details.
-  # @option options [String] :how_paid How user paid for Bloc.
-  # @option options [String] :how_paid_details How user paid for Bloc details.
-  # @return [UserData] The updated user data.
-  # @example Update a user's data
-  #   Spartacus#update_user_data(129, {how_heard: 'On the Googles'})
-  def update_user_data(id, options={})
-    whitelist = ['how_heard', 'how_heard_details', 'how_paid', 'how_paid_details']
-
-    options = convert_keys(options)
-    user_data_params = whitelist_params(options, whitelist)
-    url = "#{@api_base_path}/users/#{id}/update_user_data"
-
-    handle_timeouts do
-      response = self.class.put(url, headers: auth_header,
-                                body: { user_data: user_data_params })
-      convert_response(response, "UserData")
-    end
-  end
-
-  def replace_availability(id, time_slots={})
-  end
+  #   options = convert_keys(options)
+  #   user_data_params = whitelist_params(options, whitelist)
+  #   url = "#{@api_base_path}/users/#{id}/update_user_data"
+  #
+  #   handle_timeouts do
+  #     response = self.class.put(url, headers: auth_header,
+  #                               body: { user_data: user_data_params })
+  #     convert_response(response, "UserData")
+  #   end
+  # end
+
+  # def replace_availability(id, time_slots={})
+  # end
 end

data/lib/spartacus.rb

@@ -3,6 +3,7 @@ require 'json'
 
 require_relative 'client/alumni_stories'
 require_relative 'client/checkpoints'
+require_relative 'client/course_subjects'
 require_relative 'client/roadmap_sections'
 require_relative 'client/users'
 
@@ -14,6 +15,7 @@ class Spartacus
   include Users
   include RoadmapSections
   include AlumniStories
+  include CourseSubjects
 
   def initialize(email, password, api_base_path="https://www.bloc.io/api/v1")
     @api_base_path = api_base_path

data/spartacus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'spartacus'
-  s.version     = '0.2.2'
+  s.version     = '0.2.5'
   s.files         = `git ls-files`.split($\)
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
@@ -18,4 +18,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
 end

data/spec/cassettes/alumni_stories.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:3000/api/v1/alum_stories/2/update_sort_order
+    body:
+      encoding: UTF-8
+      string: direction=down
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"7363e85fe9edee6f053a4b319588c086"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - 49d671bd-e495-40aa-b1ae-e6c32b4e9d13
+      X-Runtime:
+      - '0.475900'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"success":true}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:26:41 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/checkpoints.yml

@@ -0,0 +1,398 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/checkpoints/1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"67ef082b2c11d7439fda872589a3235b"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - 17cee9da-faed-4c74-b9fb-7c16b08c74b5
+      X-Runtime:
+      - '0.280414'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"id":1,"name":"Command Line","body":"As a programmer, you''ll spend
+        a lot of your time on the command line in your terminal. The commands you
+        use will depend on your operating system. If you use OS X or Linux, you''ll
+        be entering Unix commands. If you use Windows, you''ll be entering MS-DOS
+        commands. Proficiency with Unix and MS-DOS commands in a terminal contributes
+        to proficiency in programming, so it''s important to practice these. This
+        screencast leads you through some basic commands.\r\n\r\n\u003ccenter\u003e\r\n\u003cvideo
+        width=\"853\" height=\"505\" controls\u003e \u003csource src=\"https://bloc-global-assets.s3.amazonaws.com/screencasts/Command%20Line.mp4\"
+        type=\"video/mp4\"\u003e \r\n\u003c/video\u003e\r\n\u003c/center\u003e\r\n\r\n###
+        Snippets from the Screencast\r\n\r\n### OS X\r\n\r\n```bash\r\n# Working with
+        directories: (OS X)\r\n\r\n$ pwd         #=\u003e print working directory\r\n$
+        ls          #=\u003e list all subdirectories in the current directory\r\n$
+        ls -l       #=\u003e more details on our listed directories\r\n$ mkdir code  #=\u003e
+        make a directory named code\r\n$ cd code     #=\u003e change directories to
+        code\r\n$ pwd         #=\u003e validate that you are now in the code directory\r\n$
+        cd ..       #=\u003e move up one level in the directory chain\r\n$ cd code     #=\u003e
+        change back to the code directory\r\n$ open .      #=\u003e open the finder
+        window for the current directory\r\n$ man mkdir   #=\u003e open the manual
+        for the mkdir command\r\n$ q           #=\u003e exit out of the manual\r\n```\r\n\r\n```bash\r\n#
+        man mkdir output (OS X)\r\n\r\nNAME\r\n     mkdir -- make directories\r\n\r\nSYNOPSIS\r\n     mkdir
+        [-pv] [-m mode] directory_name ...\r\n\r\nDESCRIPTION\r\n     The mkdir utility
+        creates the directories named as operands, in the order specified, using mode
+        rwxrwxrwx (0777)...\r\n```\r\n\r\n```bash\r\n# Working with files: (OS X)\r\n\r\n$
+        touch snippets.rb                       #=\u003e create a new file in the
+        code directory, named snippets.rb\r\n$ ls -l                                   #=\u003e
+        validate that snippets.rb was created\r\n$ cat snippets.rb                         #=\u003e
+        view snippets.rb contents\r\n$ echo hello world                        #=\u003e
+        print something\r\n$ echo puts \\\"hello world\\\" \u003e snippets.rb #=\u003e
+        add puts hello\r\n$ cat snippets.rb                         #=\u003e view
+        snippets.rb contents\r\n$ cp snippets.rb hello.rb                 #=\u003e
+        make a copy of snippets, named hello\r\n$ mv hello.rb helloworld.rb               #=\u003e
+        rename hello to helloworld\r\n$ rm helloworld.rb                        #=\u003e
+        delete helloworld\r\n$ ls -l                                   #=\u003e view
+        the contents of the code directory\r\n$ grep hello snippets.rb                  #=\u003e
+        search the snippets file for the hello string\r\n$ cd ..                                   #=\u003e
+        move up one level\r\n$ grep -r e code                          #=\u003e search
+        the code directory for any file that has an \"e\" in it\r\n```\r\n\r\n```\r\n#
+        Recursive option for working with directories\r\n\r\n$ mkdir temp         #=\u003e
+        make a temp directory\r\n$ cp temp temp2      #=\u003e try to make a copy
+        of temp, named temp2 (won''t work)\r\n$ rm temp            #=\u003e try to
+        delete temp (won''t work)\r\n$ cp -r temp temp2   #=\u003e make a copy of
+        temp, named temp2 (recursively)\r\n$ rm -r temp2        #=\u003e delete temp2
+        (recursively)\r\n$ ls -l              #=\u003e view the contents of the temp
+        directory\r\n```\r\n\r\n### Windows\r\n\r\n```\r\n# Working with directories:
+        (Windows)\r\n\r\n$ cd          #=\u003e prints working directory (or chdir)\r\n$
+        dir /b      #=\u003e show all subdirectories in the current directory (just
+        directory name)\r\n$ dir         #=\u003e more details on our listed directories
+        (/p seperates into pages)\r\n$ md code     #=\u003e make a directory named
+        code (or mkdir)\r\n$ cd code     #=\u003e change directories to code\r\n$
+        cd          #=\u003e validate that you are now in the code directory\r\n$
+        cd ..       #=\u003e move up one level in the directory chain\r\n$ cd code     #=\u003e
+        change back to the code directory\r\n$ start .     #=\u003e starts a windows
+        explorer window for the current directory\r\n$ help md     #=\u003e get help
+        info for the mkdir command (or mkdir)\r\n```\r\n\r\n```\r\n# help md (Windows)\r\n\r\nNAME\r\n     md
+        -- make directories\r\n\r\nCreates a directory.\r\n\r\nMKDIR [drive:]path\r\nMD
+        [drive:]path\r\n```\r\n\r\n```\r\n# Working with files: (Windows)\r\n\r\n$
+        cd. \u003e snippets.rb                       #=\u003e create a new file in
+        the code directory, named snippets.rb\r\n$ dir                                     #=\u003e
+        validate that snippets.rb was created\r\n$ type snippets.rb                        #=\u003e
+        display snippets.rb contents\r\n$ echo hello world                        #=\u003e
+        print something\r\n$ echo puts \\\"hello world\\\" \u003e snippets.rb #=\u003e
+        add puts hello\r\n$ type snippets.rb                        #=\u003e display
+        snippets.rb contents\r\n$ copy snippets.rb hello.rb               #=\u003e
+        make a copy of snippets, named hello\r\n$ rename hello.rb helloworld.rb           #=\u003e
+        rename hello to helloworld\r\n$ del helloworld.rb                       #=\u003e
+        delete helloworld\r\n$ dir                                     #=\u003e view
+        the contents of the code directory\r\n$ find \"hello\" snippets.rb                #=\u003e
+        search the snippets file for the hello string\r\n$ findstr /s /i e code                    #=\u003e
+        search the current directory for any file that has an \"e\" in it\r\n```\r\n\r\n```\r\n#
+        Recursive option for working with directories (Windows)\r\n\r\n$ md temp              #=\u003e
+        make a temp directory\r\n$ xcopy temp temp2     #=\u003e try to make a copy
+        of temp, named temp2 (won''t work b/c temp is empty)\r\n$ xcopy /e temp temp2  #=\u003e
+        make an empty copy of temp, named temp2\r\n$ dir                  #=\u003e
+        validate that temp2 was created\r\n$ rd temp2             #=\u003e remove
+        temp2 directory\r\n$ cd temp              #=\u003e change to the temp directory\r\n$
+        cd. \u003e test.txt       #=\u003e create a test file in the temp directory,
+        named test.txt\r\n$ cd ..                #=\u003e move up one level\r\n$ xcopy
+        temp temp2     #=\u003e make a copy of temp, named temp2 (works because it''s
+        not empty)\r\n$ dir                  #=\u003e validate that temp2 was created\r\n$
+        rd temp2             #=\u003e try to delete temp (won''t work because temp2
+        is not empty)\r\n$ rd temp2 /s          #=\u003e delete temp2 (recursively)\r\n$
+        dir                  #=\u003e view the contents of the directory\r\n```\r\n\r\n###
+        Resources\r\n* [Zed Shaw](http://zedshaw.com/#/start) writes a series of programming
+        ebooks. His [Command Line - Learn Code the Hard Way](http://cli.learncodethehardway.org/)
+        is a great resource for strengthening your CLI skills.\r\n* This is a [comprehensive
+        index of OS X terminal commands](http://ss64.com/osx/).\r\n* This is a [comprehensive
+        index of Windows terminal commands](http://ss64.com/nt/).\r\n* This [Basic
+        Unix Tutorial](http://snap.nlc.dcccd.edu/learn/idaho/unixindex.html) was created
+        by Idaho State University, and serves as a nice reference guide.\r\n* Here''s
+        some [more detail on grep](http://www.panix.com/~elflord/unix/grep.html).
+        Once you get proficient with grep options, you''ll find it much faster than
+        searching in your GUI.","parent_id":9,"created_at":"2012-11-25T22:55:59.365-05:00","updated_at":"2015-05-13T13:20:03.314-04:00","assignment":"Create
+        your own code directory, similar to the one in the screencast. Create files
+        for some of the Ruby exercises you completed. Name your files in accordance
+        with the exercise, and use a `.rb` extension. To seed the content of the files,
+        you can open them outside of the terminal and paste the code in. Once you
+        have a code directory filled with a handful of `.rb` files, try copying them,
+        renaming them and searching them. Make sure to experiment with different options
+        for each command as well. When you have a better feel for the command line,
+        delete all of the copies you made, leaving only the original `.rb` files you
+        created.\r\n\r\nAfter you''ve completed the tasks above, copy your entire
+        terminal session text and send it to your mentor. (If you already have a Github
+        account, you can paste it in a new Gist and send the link to your mentor.
+        If you don''t have a Github account, we''ll create one in the next checkpoint.)","summary":null,"points":1,"project_name":"","roadmap_id":1,"active":true,"job_prep":false,"version":[0,0],"body_file_path":"","uuid":"337340a0-cc2c-43bd-86c1-d8387487d58c","ref":"337340a0-cc2c-43bd-86c1-d8387487d58c|0","retroactive_optional_date":null}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:13:00 GMT
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/checkpoints/-1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - d3e429eb-5105-4ade-93d1-65b1836893c7
+      X-Runtime:
+      - '0.225733'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"message":"Resource not found"}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:13:00 GMT
+- request:
+    method: put
+    uri: http://localhost:3000/api/v1/checkpoints/2
+    body:
+      encoding: UTF-8
+      string: checkpoint[name]=My%20Checkpoint
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"f4e8bab8402f056716ba3f174d6db83c"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - f66b4590-0498-402e-b409-fb944b3ddf00
+      X-Runtime:
+      - '0.239184'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"id":2,"name":"My Checkpoint","body":"Before you build an application,
+        you must have an idea of what it should look like and how it will be interpreted
+        by users. Developers often use **wireframes** to illustrate their application
+        before they start coding. When drafting a wireframe, think about the primary
+        purpose of your application. Why should it exist? How will it make someone''s
+        life better? Wireframes **should not** be complicated. They should be highly
+        general, but still provide a context for the application throughout development.\r\n\r\nThere
+        are dozens of wireframing tools, but pencil and paper is our preference. It
+        is often tempting to incorporate all of the features that your application
+        could have in a wireframe. Don''t get distracted though, and err on the side
+        of simplicity. Reduce the number of pages and features that your site must
+        have to the absolute minimum. You''ll know when you''ve reached the minimally
+        viable product, (aka MVP), because if you were to remove one more thing, the
+        product would cease to make sense.  \r\n \r\n### Resources\r\n* [The Boxing
+        Glove Technique](http://www.90percentofeverything.com/2008/01/02/the-boxing-glove-wireframing-technique/)
+        is an interesting method to help keep your wireframes simple.\r\n* Learn how
+        [37signals does HTML Prototyping](http://blog.handcraft.com/2010/07/how-37signals-does-html-prototyping/).\r\n*
+        If you want to use a tool to build wireframes [Balsamiq](http://www.balsamiq.com/products/mockups)
+        has a free trial license. It''s a nice wireframing tool, but remember that
+        pencil and paper are perfectly fine. ","parent_id":43,"created_at":"2012-11-25T22:55:59.504-05:00","updated_at":"2015-10-08T01:09:05.231-04:00","assignment":"Draft
+        a wireframe for your Blog application. Create the individual pages, as well
+        as the user flow. To illustrate user flow, create a diagram that describes
+        how a user goes through the different pages of your application. When you
+        think you have a good wireframe drafted, push it to Github.\r\n\r\nWe can''t
+        stress this enough: **err on the side of simplicity**. The goal is to get
+        an idea of all the pages you''ll need to make a useful app, and how they work
+        together.","summary":null,"points":1,"project_name":"","roadmap_id":1,"active":true,"job_prep":false,"version":[0,0],"body_file_path":"","uuid":"479dbf5e-6d01-44e9-bd77-655a0fabaf48","ref":"479dbf5e-6d01-44e9-bd77-655a0fabaf48|0","retroactive_optional_date":null}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:13:01 GMT
+- request:
+    method: put
+    uri: http://localhost:3000/api/v1/checkpoints/3
+    body:
+      encoding: UTF-8
+      string: checkpoint[name]=My%20Checkpoint&checkpoint[summary]=Great%20Summary&checkpoint[body]=Really%20great%20checkpoint&checkpoint[assignment]=Do%20the%20work%20well&checkpoint[points]=5
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"dd9b8cb21292c772e8df299d6f72545f"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - f678ea37-741c-4086-9deb-2bc4cea62ac9
+      X-Runtime:
+      - '0.406227'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"id":3,"name":"My Checkpoint","body":"Really great checkpoint","parent_id":7,"created_at":"2012-11-25T22:55:59.522-05:00","updated_at":"2015-10-08T01:09:05.852-04:00","assignment":"Do
+        the work well","summary":"Great Summary","points":5,"project_name":"","roadmap_id":1,"active":true,"job_prep":false,"version":[0,0],"body_file_path":"","uuid":"cdaa8f1f-f165-48ad-997b-b3c875c22a2b","ref":"cdaa8f1f-f165-48ad-997b-b3c875c22a2b|0","retroactive_optional_date":null}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:13:02 GMT
+- request:
+    method: put
+    uri: http://localhost:3000/api/v1/checkpoints/-1
+    body:
+      encoding: UTF-8
+      string: checkpoint[name]=My%20Checkpoint
+    headers: {}
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - d8027568-9e19-4a24-91db-ec556ddd7853
+      X-Runtime:
+      - '0.232196'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"message":"Resource not found"}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:13:02 GMT
+- request:
+    method: delete
+    uri: http://localhost:3000/api/v1/checkpoints/1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - e0372469-f709-496f-a344-39930f602ed4
+      X-Runtime:
+      - '0.255790'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"message":"Resource not found"}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:13:03 GMT
+- request:
+    method: delete
+    uri: http://localhost:3000/api/v1/checkpoints/-1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - 252d6db8-781f-41a3-9d21-984d1859320a
+      X-Runtime:
+      - '0.290977'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"message":"Resource not found"}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 05:13:03 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/roadmap_sections.yml

@@ -0,0 +1,119 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/roadmap_sections/1/create_checkpoint
+    body:
+      encoding: UTF-8
+      string: checkpoint[name]=My%20Checkpoint
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"7ea5d04b30b7bb36a3a6eecdc4748c92"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - 95473b53-16b6-444d-ab1f-c841a87bf644
+      X-Runtime:
+      - '0.434640'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"id":1788,"name":"My Checkpoint","body":null,"parent_id":null,"created_at":"2015-10-08T06:08:57.035Z","updated_at":"2015-10-08T06:08:57.035Z","assignment":null,"summary":null,"points":1,"project_name":"","roadmap_id":null,"active":true,"job_prep":false,"version":[0,0],"body_file_path":"","uuid":"1ad02a6d-6a54-4a75-947a-3c41be3d7b6d","ref":"1ad02a6d-6a54-4a75-947a-3c41be3d7b6d|0","retroactive_optional_date":null}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 06:08:57 GMT
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/roadmap_sections/-1/create_checkpoint
+    body:
+      encoding: UTF-8
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - 2606a433-5680-4d52-baea-6677273a52cc
+      X-Runtime:
+      - '0.226633'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"message":"Resource not found"}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 06:08:58 GMT
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/roadmap_sections/2/create_checkpoint
+    body:
+      encoding: UTF-8
+      string: checkpoint[name]=My%20Checkpoint&checkpoint[summary]=Great%20Summary&checkpoint[body]=Really%20great%20checkpoint&checkpoint[assignment]=Do%20the%20work%20well&checkpoint[points]=5
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"6940afdc3e4fec332723ab58c1d8fdf3"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Meta-Request-Version:
+      - 0.3.4
+      X-Request-Id:
+      - b3fee978-de98-443f-bcb1-3def6fcaa61d
+      X-Runtime:
+      - '0.545259'
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"id":1789,"name":"My Checkpoint","body":"Really great checkpoint","parent_id":null,"created_at":"2015-10-08T06:09:24.783Z","updated_at":"2015-10-08T06:09:24.783Z","assignment":"Do
+        the work well","summary":"Great Summary","points":5,"project_name":"","roadmap_id":null,"active":true,"job_prep":false,"version":[0,0],"body_file_path":"","uuid":"c9b685eb-626a-43ea-80d7-e1b36df4d248","ref":"c9b685eb-626a-43ea-80d7-e1b36df4d248|0","retroactive_optional_date":null}'
+    http_version: 
+  recorded_at: Thu, 08 Oct 2015 06:09:25 GMT
+recorded_with: VCR 2.9.3

data/spec/client/alumni_stories_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe AlumniStories do
+  before do
+    @client = Spartacus.new(ENV['BLOCUSER'], ENV['BLOCPASS'], 'http://localhost:3000/api/v1')
+  end
+
+  describe '#update_alum_story_sort_order' do
+    it 'returns an AlumniStory object' do
+      VCR.use_cassette 'alumni_stories', record: :new_episodes do
+        response = @client.update_alum_story_sort_order(2)
+        expect(response).to be_an_instance_of(AlumniStory)
+      end
+    end
+
+    it 'returns an error message for a missing alumni story' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.get_checkpoint(-1)
+        expect(response.message).to eq('Not Found')
+        expect(response.code).to eq(404)
+      end
+    end
+  end
+end

data/spec/client/checkpoints_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Checkpoints do
+  before do
+    @client = Spartacus.new(ENV['BLOCUSER'], ENV['BLOCPASS'], 'http://localhost:3000/api/v1')
+  end
+
+  describe '#get_checkpoint' do
+    it 'returns a Checkpoint object' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.get_checkpoint(1)
+        expect(response).to be_an_instance_of(Checkpoint)
+      end
+    end
+
+    it 'returns an error message for a missing checkpoint' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.get_checkpoint(-1)
+        expect(response.message).to eq('Not Found')
+        expect(response.code).to eq(404)
+      end
+    end
+  end
+
+  describe '#update_checkpoint' do
+    it 'returns a Checkpoint object' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.update_checkpoint(2, {name: 'My Checkpoint'})
+        expect(response).to be_an_instance_of(Checkpoint)
+        expect(response.name).to eq('My Checkpoint')
+      end
+    end
+
+    it 'updates checkpoint attributes' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        attributes = {
+          name: "My Checkpoint",
+          summary: "Great Summary",
+          body: "Really great checkpoint",
+          assignment: "Do the work well",
+          points: 5
+        }
+
+        response = @client.update_checkpoint(3, attributes)
+        expect(response.name).to eq(attributes['name'])
+        expect(response.summary).to eq(attributes['summary'])
+        expect(response.body).to eq(attributes['body'])
+        expect(response.assignment).to eq(attributes['assignment'])
+        expect(response.points).to eq(attributes['points'])
+      end
+    end
+
+    it 'returns an error message for a messing checkpoint' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.update_checkpoint(-1, {name: 'My Checkpoint'})
+        expect(response.message).to eq('Not Found')
+        expect(response.code).to eq(404)
+      end
+    end
+  end
+end

data/spec/client/roadmap_sections_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe RoadmapSections do
+  before do
+    @client = Spartacus.new(ENV['BLOCUSER'], ENV['BLOCPASS'], 'http://localhost:3000/api/v1')
+  end
+
+  describe '#create_checkpoint' do
+    it 'returns a Checkpoint object' do
+      VCR.use_cassette 'roadmap_sections', record: :new_episodes do
+        response = @client.create_checkpoint(1, {name: 'My Checkpoint'})
+        expect(response).to be_an_instance_of(Checkpoint)
+        expect(response.name).to eq('My Checkpoint')
+      end
+    end
+
+    it 'returns an Checkpoint object' do
+      VCR.use_cassette 'roadmap_sections', record: :new_episodes do
+        attributes = {
+          name: "My Checkpoint",
+          summary: "Great Summary",
+          body: "Really great checkpoint",
+          assignment: "Do the work well",
+          points: 5
+        }
+
+        response = @client.create_checkpoint(2, attributes)
+        expect(response.name).to eq(attributes['name'])
+        expect(response.summary).to eq(attributes['summary'])
+        expect(response.body).to eq(attributes['body'])
+        expect(response.assignment).to eq(attributes['assignment'])
+        expect(response.points).to eq(attributes['points'])
+      end
+    end
+
+    it 'returns an error message for a missing roadmap section' do
+      VCR.use_cassette 'roadmap_sections', record: :new_episodes do
+        response = @client.create_checkpoint(-1)
+        expect(response.message).to eq('Not Found')
+        expect(response.code).to eq(404)
+      end
+    end
+  end
+end

data/spec/client/users_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Checkpoints do
+  before do
+    @client = Spartacus.new(ENV['BLOCUSER'], ENV['BLOCPASS'], 'http://localhost:3000/api/v1')
+  end
+
+  describe '#get_checkpoint' do
+    it 'returns a Checkpoint object' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.get_checkpoint(1)
+        expect(response).to be_an_instance_of(Checkpoint)
+      end
+    end
+
+    it 'returns an error message for a missing checkpoint' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.get_checkpoint(-1)
+        expect(response.message).to eq('Not Found')
+        expect(response.code).to eq(404)
+      end
+    end
+  end
+
+  describe '#update_checkpoint' do
+    it 'returns a Checkpoint object' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.update_checkpoint(2, {name: 'My Checkpoint'})
+        expect(response).to be_an_instance_of(Checkpoint)
+        expect(response.name).to eq('My Checkpoint')
+      end
+    end
+
+    it 'updates checkpoint attributes' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        attributes = {
+          name: "My Checkpoint",
+          summary: "Great Summary",
+          body: "Really great checkpoint",
+          assignment: "Do the work well",
+          points: 5
+        }
+
+        response = @client.update_checkpoint(3, attributes)
+        expect(response.name).to eq(attributes['name'])
+        expect(response.summary).to eq(attributes['summary'])
+        expect(response.body).to eq(attributes['body'])
+        expect(response.assignment).to eq(attributes['assignment'])
+        expect(response.points).to eq(attributes['points'])
+      end
+    end
+
+    it 'returns an error message for a messing checkpoint' do
+      VCR.use_cassette 'checkpoints', record: :new_episodes do
+        response = @client.update_checkpoint(-1, {name: 'My Checkpoint'})
+        expect(response.message).to eq('Not Found')
+        expect(response.code).to eq(404)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require_relative '../lib/spartacus'
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.ignore_request do |request|
+    URI(request.uri).request_uri == '/api/v1/sessions'
+  end
+
+  c.before_record do |i|
+    i.response.headers.delete('Set-Cookie')
+    i.request.headers.delete('Authorization')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spartacus
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Ben Neely
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A client for the Bloc API
 email: ben@bloc.to
 executables: []
@@ -105,16 +133,26 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- foo.rb
 - lib/client/alumni_stories.rb
 - lib/client/base_client.rb
+- lib/client/chapters.rb
 - lib/client/checkpoints.rb
 - lib/client/class_factory.rb
+- lib/client/course_subjects.rb
 - lib/client/roadmap_sections.rb
 - lib/client/users.rb
 - lib/spartacus.rb
 - spartacus.gemspec
 - spec/.keep
+- spec/cassettes/alumni_stories.yml
+- spec/cassettes/checkpoints.yml
+- spec/cassettes/roadmap_sections.yml
+- spec/client/alumni_stories_spec.rb
+- spec/client/checkpoints_spec.rb
+- spec/client/roadmap_sections_spec.rb
+- spec/client/users_spec.rb
+- spec/spartacus_spec.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/spartacus
 licenses:
 - MIT
@@ -135,9 +173,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A client for the Bloc AP
 test_files:
 - spec/.keep
+- spec/cassettes/alumni_stories.yml
+- spec/cassettes/checkpoints.yml
+- spec/cassettes/roadmap_sections.yml
+- spec/client/alumni_stories_spec.rb
+- spec/client/checkpoints_spec.rb
+- spec/client/roadmap_sections_spec.rb
+- spec/client/users_spec.rb
+- spec/spartacus_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/foo.rb

@@ -1,11 +0,0 @@
-require_relative 'lib/spartacus'
-
-sc = Spartacus.new("ben@bloc.io", "6EjixAvNg2oRTJ", "https://www.bloc.io/api/v1")
-# puts sc.update_password(537104, "chinese1")
-puts sc.update_checkpoint(129, {"body" => "my awesome checkpoint!!!!!!!!!!!!!!!", "name" => "DDDDDDDDDD"})
-# checkpoint = sc.create_checkpoint(1, {name: "Super great awesome checkpoint", "body" => "WOOOOOOOHHH!!!!!H"})
-# puts checkpoint
-# puts sc.update_user(sc.get_me.id, {name: "Ben INTERNETS"})
-# puts checkpoint.name
-# puts sc.update_alum_story_sort_order(10)
-# puts sc.delete_checkpoint(1788)