spartacus 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55167635bca28b3de5ad8cc9644bf93bcc234db3
-  data.tar.gz: 3a90cfb49485d165d076b1ae59b014b535c50a4e
+  metadata.gz: 463d2d3196f7020795237b2ce625c2f91ff15896
+  data.tar.gz: 5073015371d6d0f9040540e4f79feed3de940292
 SHA512:
-  metadata.gz: 7a75288da0527c3ff9958bc75e857eb291344c6461f085d429c66a2ab26e12e6514df3bc290d7024c485d1065ea63eab67d4cd7d8adaa65093f40154fbf9c661
-  data.tar.gz: 0e2217b953097ffd0c41e08573d4513fce1f2cf12310e9b9c790e75c83d2b99d29327e149f8750d069abe0791f71192833982af7af8afe0bcec24d975159690a
+  metadata.gz: 7390f465b1c6b5cb81761c96c90cfb0754fe39c16fb91fbb4f7316512e0a0da715f6854c4e12141dd5f45b57309e883c789dca6938a1f0ecbe19caa78a99b26b
+  data.tar.gz: efc045df13159164354be16a6b08c3708f5150134a32834013645bcd6705aaceb59045b269adc33f2ac4e40fba6733d053e98a345b39e6b27bbfd5e3a1765367

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,11 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 bmneely
+
+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,45 @@
+#Spartacus
+
+Ruby toolkit for the Bloc API.
+
+![Spartacus](http://bloc-global-assets.s3.amazonaws.com/spartacus.png)
+
+##Quick start
+
+Install via Rubygems
+
+```bash
+gem install spartacus
+```
+
+... or add to your Gemfile
+
+```ruby
+gem "spartacus", "~> 0.1.6"
+```
+
+## Usage
+
+Create a new `Spartacus` client using your Bloc username and password:
+
+```ruby
+sc = Spartacus.new("ben@bloc.io", "gooderpassword")
+```
+
+Then use the client to make requests:
+
+```ruby
+sc.update_checkpoint(129, {name: "New Checkpint Name"})
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Acknowledgements
+
+This gem is inspired by [octokit](https://github.com/octokit)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/client/alumni_stories.rb

@@ -0,0 +1,29 @@
+require_relative 'base_client'
+
+module AlumniStories
+  include BaseClient
+
+  # Create a checkpoint
+  #
+  # @param id [Integer] An alumni story id.
+  # @param direction [String] The direction to move to the alumni story.
+  # @return [AlumniStory] The updated alumni story
+  # @example Update an alumni story sort order
+  #   Spartacus#update_alum_story_sort_order(1, {name: 'Real Cool Checkpoint'})
+  def update_alum_story_sort_order(id, direction='down')
+    accepted_params = ['up', 'down', :up, :down]
+    if accepted_params.include?(direction)
+
+      url = "#{@api_base_path}/alum_stories/#{id}/update_sort_order"
+
+      handle_timeouts do
+        response = self.class.post(url,
+                                   headers: auth_header,
+                                   query: { direction: direction })
+        convert_response(response, "alumni_story")
+      end
+    else
+      raise InvalidDirectionError
+    end
+  end
+end

data/lib/client/base_client.rb

@@ -0,0 +1,41 @@
+require_relative 'class_factory'
+
+module BaseClient
+  # Handle API timouts
+  def handle_timeouts
+    begin
+      yield
+    rescue Net::OpenTimeout, Net::ReadTimeout
+      {}
+    end
+  end
+
+  # This needs a better name
+  def convert_response(response, name)
+    if success?(response.code)
+     ClassFactory.build_response_object(response.body, name)
+    else
+     return response
+    end
+  end
+
+  def success?(code)
+    code.between?(200, 299)
+  end
+
+  # Set the API Authorization Header
+  #
+  # @return [Hash] The authorization header
+  def auth_header
+    { "authorization" => @auth_token }
+  end
+
+  def convert_keys(options)
+    options.keys.each {|k| options[k.to_s] = options.delete(k) if k.kind_of?(Symbol)}
+    options
+  end
+
+  def whitelist_params(options, whitelist)
+    options.select {|k, v| whitelist.include?(k)}
+  end
+end

data/lib/client/checkpoints.rb

@@ -0,0 +1,62 @@
+require_relative 'base_client'
+
+module Checkpoints
+  include BaseClient
+  # Get a checkpoint
+  #
+  # @param id [Integer] A roadmap section id.
+  # @return [Checkpoint] The checkpoint.
+  # @example Get a checkpoint
+  #   Spartacus#get_checkpoint(1, {name: 'Real Cool Checkpoint'})
+  def get_checkpoint(id)
+    url = "#{@api_base_path}/checkpoints/#{id}"
+
+    handle_timeouts do
+      response = self.class.get(url, headers: auth_header)
+      convert_response(response, "checkpoint")
+    end
+  end
+
+  # Update a checkpoint
+  #
+  # @param id [Integer] A checkpoint id.
+  # @param options [Hash] A customizable set of options.
+  # @option options [String] :name Checkpoint name.
+  # @option options [String] :summary Checkpoint summary.
+  # @option options [String] :body Checkpoint body.
+  # @option options [String] :assignment Checkpoint assignment.
+  # @option options [String] :assignment Checkpoint body and assignment.
+  # @option options [Integer] :points Checkpoint point.
+  # @option options [String] :body_and_assignment Checkpoint body and Assignment
+  # @return [Checkpoint] The updated checkpoint
+  # @example Update a checkpoint
+  #   Spartacus#update_checkpoint(129, {name: 'Real Cool Checkpoint'})
+  def update_checkpoint(id, options={})
+    whitelist = ['name', 'summary', 'body', 'assignment','body_and_assignment', 'points']
+
+    options = convert_keys(options)
+    checkpoint_params = whitelist_params(options, whitelist)
+    url = "#{@api_base_path}/checkpoints/#{id}"
+
+    handle_timeouts do
+      response = self.class.put(url, headers: auth_header,
+                                query: { checkpoint: checkpoint_params })
+      convert_response(response, "checkpoint")
+    end
+  end
+
+  # 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}"
+
+    handle_timeouts do
+      response = self.class.delete(url, headers: auth_header)
+      convert_response(response, "checkpoint")
+    end
+  end
+end

data/lib/client/class_factory.rb

@@ -0,0 +1,31 @@
+require 'json'
+require 'active_support/inflector'
+
+module ClassFactory
+  def ClassFactory.build_response_object(json_string, name)
+    response_hash = JSON.parse(json_string)
+    if Object.const_defined?(name.camelize)
+      name.camelize.constantize.new(response_hash)
+    else
+      generic_class = ClassFactory::GenericClass.new
+      generic_class.create_class name
+      name.camelize.constantize.new(response_hash)
+    end
+  end
+
+  class GenericClass
+    def create_class name
+      Object.const_set(name.classify,
+      Class.new do
+        def initialize(hash)
+          hash.each do |k,v|
+            self.instance_variable_set("@#{k}", v)
+            self.class.send(:define_method, k, proc{self.instance_variable_get("@#{k}")})
+            self.class.send(:define_method, "#{k}=", proc{|v| self.instance_variable_set("@#{k}", v)})
+          end
+        end
+      end
+      )
+    end
+  end
+end

data/lib/client/roadmap_sections.rb

@@ -0,0 +1,30 @@
+require_relative 'base_client'
+
+module RoadmapSections
+  include BaseClient
+  # Create a checkpoint
+  #
+  # @param id [Integer] A roadmap section id.
+  # @param options [Hash] A customizable set of options.
+  # @option options [String] :name Checkpoint name.
+  # @option options [String] :summary Checkpoint summary.
+  # @option options [String] :body Checkpoint body.
+  # @option options [String] :assignment Checkpoint assignment.
+  # @option options [Integer] :points Checkpoint point.
+  # @option options [String] :body_and_assignment Checkpoint body and Assignment
+  # @return [Checkpoint] The created checkpoint
+  # @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) }
+    url = "#{@api_base_path}/roadmap_sections/#{id}/create_checkpoint"
+
+    handle_timeouts do
+      response = self.class.post(url,
+                                 headers: auth_header,
+                                 query: { checkpoint: checkpoint_params })
+      convert_response(response, "checkpoint")
+    end
+  end
+end

data/lib/client/users.rb

@@ -0,0 +1,220 @@
+module Users
+
+  # Get all users
+  #
+  # @return [HTTParty::Response] All users.
+  # @example Get all users
+  #   Spartacus#get_users
+  def get_users
+    url = "#{@api_base_path}/users"
+    handle_timeouts do
+      self.class.get(url, headers: auth_header)
+    end
+  end
+
+  # Get your own user
+  #
+  # @return [User] You.
+  # @example Get yourself
+  #   Spartacus#get_me
+  def get_me
+    url = "#{@api_base_path}/users/me"
+    handle_timeouts do
+      response = self.class.get(url, headers: auth_header)
+      convert_response(response, "user")
+    end
+  end
+
+  # Get all user
+  #
+  # @param id [Integer] A user id.
+  # @return [User] A user.
+  # @example Get a user
+  #   Spartacus#get_user
+  def get_user(id)
+    url = "#{@api_base_path}/users/#{id}"
+    handle_timeouts do
+      response = self.class.get(url, headers: auth_header)
+      convert_response(response, "user")
+    end
+  end
+
+  # Get available mentors for a user
+  #
+  # @param id [Integer] A user id.
+  # @return [User] Available mentors.
+  # @example Get avaiable mentors
+  #   Spartacus#get_available_mentors
+  def get_available_mentors
+    url = "#{@api_base_path}/users/available_mentors"
+    handle_timeouts do
+      response = self.class.get(url, headers: auth_header)
+      convert_response(response, "user")
+    end
+  end
+
+  # Get user availability
+  #
+  # @param id [Integer] A user id.
+  # @return [HTTParty::Response] User availability.
+  # @example Get user availability
+  #   Spartacus#get_availability
+  def get_availability(id)
+    url = "#{@api_base_path}/users/#{id}/availability"
+    handle_timeouts do
+      self.class.get(url, headers: auth_header)
+    end
+  end
+
+  # Get user enrollments
+  #
+  # @param id [Integer] A user id.
+  # @return [HTTParty::Response] User enrollments.
+  # @example Get user enrollments
+  #   Spartacus#get_enrollments
+  def get_enrollments(id)
+    url = "#{@api_base_path}/users/#{id}/enrollments"
+    handle_timeouts do
+      self.class.get(url, headers: auth_header)
+    end
+  end
+
+  # Get user accomplishments
+  #
+  # @param id [Integer] A user id.
+  # @return [HTTParty::Response] User accomplishments.
+  # @example Get user accomplishments
+  #   Spartacus#get_accomplishments
+  def get_accomplishments(id)
+    url = "#{@api_base_path}/users/#{id}/accomplishments"
+    handle_timeouts do
+      self.class.get(url, headers: auth_header)
+    end
+  end
+
+  # Mark user's current enrollment as onboarded
+  #
+  # @param id [Integer] A user id.
+  # @return [HTTParty::Response] Succes or failure message.
+  # @example Onboard user
+  #   Spartacus#onboard
+  def onboard(id)
+    url = "#{@api_base_path}/users/#{id}/onboard"
+    handle_timeouts do
+      self.class.post(url, headers: auth_header)
+    end
+  end
+
+  # Update the user's password
+  #
+  # @param id [Integer] A user id.
+  # @param password [String] User password.
+  # @return [User] Updated user.
+  # @example Update user password
+  #   Spartacus#update_password
+  def update_password(id, password)
+    url = "#{@api_base_path}/users/#{id}/update_password"
+    handle_timeouts do
+      response = self.class.put(url, headers: auth_header,
+                                query: { user: { password: password,
+                                                 confirmation: password } })
+      convert_response(response, "user")
+
+    end
+  end
+
+  # Update a user
+  #
+  # @param id [Integer] A user id.
+  # @param options [Hash] A customizable set of options.
+  # @option options [String] :email User email.
+  # @option options [String] :first_name User first_name.
+  # @option options [String] :last_name User last name.
+  # @option options [String] :twitter_handle User Twitter handle.
+  # @option options [String] :dribbble_handle User Dribbble handle.
+  # @option options [String] :github_handle User GitHub handle.
+  # @option options [String] :codecademy_handle User Codecademy handle.
+  # @option options [String] :linkedin User LinkIn profile.
+  # @option options [String] :time_zone User time zone
+  # @option options [String] :bio User biography.
+  # @option options [String] :name User fullname.
+  # @option options [String] :photo User photo.
+  # @option options [String] :os User operating system.
+  # @option options [Boolean] :dismissed_holiday_freeze User dismissed
+  #                                                     holiday freeze.
+  # @option options [String] :title User title.
+  # @option options [String] :lead_mentor_account User lead mentor account.
+  # @option options [String] :password User password.
+  # @option options [String] :password_confirmation User password confirmation.
+  # @option options [Boolean] :remember_me Remeber user.
+  # @option options [String] :facebook_id User Facebook ID.
+  # @option options [String] :stripe_customer_id User Stripe customer ID.
+  # @option options [String] :stripe_token User Stripe token.
+  # @option options [String] :skype_handle User Skype handle.
+  # @option options [String] :referral_token User referral token.
+  # @option options [Boolean] :send_new_message_emails Send user new emails.
+  # @option options [String] :referred_by_id User referred by ID.
+  # @option options [String] :google_plus_id User GooglePlus ID.
+  # @option options [Boolean] :private_profile Set user profile to private.
+  # @option options [Integer] :quota User student quota.
+  # @option options [Integer] :quota_limit User student quota limit.
+  # @option options [Integer] :first_visit_id User first visit ID.
+  # @option options [Integer] :crm_lead_id User CRM lead ID.
+  # @option options [String] :phone_num User phone number.
+  # @option options [String] :role User role.
+  # @option options [Integer] :student_profile User student profile.
+  # @option options [String] :tos
+  # @return [User] The updated user.
+  # @example Update a user's data
+  #   Spartacus#update_user_data(129, {how_heard: 'On the Googles'})
+  def update_user(id, options={})
+    whitelist = ['email','first_name','last_name','twitter_handle',
+                 'dribbble_handle','github_handle','codecademy_handle',
+                 'linkedin','time_zone','bio','name','photo','os',
+                 'dismissed_holiday_freeze','title','lead_mentor_account',
+                 'password','password_confirmation','remember_me','facebook_id',
+                 'stripe_customer_id','stripe_token','skype_handle',
+                 'referral_token','send_new_message_emails','referred_by_id',
+                 'google_plus_id','private_profile','quota','quota_limit',
+                 'first_visit_id','crm_lead_id','phone_num','role',
+                 'student_profile','tos']
+
+    options = convert_keys(options)
+    user_params = whitelist_params(options, whitelist)
+    url = "#{@api_base_path}/users/#{id}"
+
+    handle_timeouts do
+      response = self.class.put(url, headers: auth_header,
+                                query: { user: user_params })
+      convert_response(response, "User")
+    end
+  end
+
+  # 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']
+
+    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,
+                                query: { user_data: user_data_params })
+      convert_response(response, "UserData")
+    end
+  end
+
+  def replace_availability(id, time_slots={})
+  end
+end

data/spartacus.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'spartacus'
+  s.version     = '0.2.0  '
+  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)/})
+  s.require_paths = ["lib"]
+  s.date        = '2015-09-25'
+  s.summary     = 'A client for the Bloc AP'
+  s.description = 'A client for the Bloc API'
+  s.authors     = ['Ben Neely']
+  s.email       = 'ben@bloc.to'
+  s.homepage    = 'http://rubygems.org/gems/spartacus'
+  s.license     = 'MIT'
+  s.add_runtime_dependency 'httparty', '~>0.13.7'
+  s.add_runtime_dependency 'activesupport', '~>4.2'
+  s.add_runtime_dependency 'json', '~>1.8'
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spartacus
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Neely
@@ -52,13 +52,68 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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: rake
+  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: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/client/alumni_stories.rb
+- lib/client/base_client.rb
+- lib/client/checkpoints.rb
+- lib/client/class_factory.rb
+- lib/client/roadmap_sections.rb
+- lib/client/users.rb
 - lib/spartacus.rb
+- spartacus.gemspec
+- spec/.keep
 homepage: http://rubygems.org/gems/spartacus
 licenses:
 - MIT
@@ -83,5 +138,6 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A client for the Bloc AP
-test_files: []
+test_files:
+- spec/.keep
 has_rdoc: