badges 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94ba37e390392c87e71b7e0e7c149fbf5abefcda
-  data.tar.gz: 713f593501a9d8413debf985c3a4429ce0fcc8d1
+  metadata.gz: 83abc324aa59bc81fa5a5912c571241635939a07
+  data.tar.gz: f8f5c32225e1dcf6475782a66f6b74dc272eda3d
 SHA512:
-  metadata.gz: 55447da027202aa56d5650054071ef5650be9e21a6a0a0a5da7e950d6f4b6d2474ed1483defdfa270cee33967ae87be398a264102a11ff882069630dfca6b7fa
-  data.tar.gz: c9f49465423566edf0a80df3a4008689283dc32f21acb4e5d1dcd6266f77599cafa2914a9eb939fe1855603dfb733554f222bbc198a248ae39e36cd230b32076
+  metadata.gz: 6eedbf1ba5cb9dd7c916f2f0ce9e42d1d567144622e2ca7dee5c52018b8d88a376dc576416a401c9c5419061d161776cf2cb3b40e38d70c189a10269d941a90d
+  data.tar.gz: e0770b7b2945a0cfecdfb918b25ec1a03555c2940de0428fe92bbb10bb032eea591f799dc2c3f4a8823960e7c0b1941d3586eae6575c9c65f09d6a9ca8a6e42e

data/README.md

@@ -29,100 +29,59 @@ Or install it yourself as:
 
 ## Class usage
 
-CodeSchool example:
+Both *Badges::CodeSchool* and *Badges::Treehouse* are a subclass of *Request*. Because of this, they share the same methods and variables, and function in exactly the same way. Examples following the first will be considerably shorter.
+
+#### Badges::CodeSchool
+
+Create a new instance of a CodeSchool badge request.
 
     codeschool = Badges::CodeSchool.new('username')
     
-    codeschool.response
-    => nil # if false username
-    
-    codeschool.username
-    => "username"
+Badges gem knows the proper url for the request. If the base url for the request happens to change one day, you can optionally pass in a different base url and the gem will use that instead.
+
+    codeschool = Badges::CodeSchool.new('username', 'http://www.codeschool.com/users/')
+
+CodeSchool is a subclass of Request, so it inherits these useful methods and variables pertaining to your api request.
+
+    codeschool.user_id
+    => "user"
     
     codeschool.profile_url
     => "http://www.codeschool.com/users/username"
     
-    codeschool.avatar_url
-    => "http://example.com/avatar.jpg"
-    
-    codeschool.badges
-    => [{"name"=>"Badge", "badge"=>"http://example.com/badge.png", "course_url"=>"http://example.com"}]
-    
-    codeschool.courses_completed
-    => [{"title"=>"Course", "url"=>"http://example.com", "badge"=>"http://example.com/badge.png"}]
+    codeschool.valid?
+    => true
     
-    codeschool.courses_in_progress
-    => [{"title"=>"Course", "url"=>"http://example.com", "badge"=>"http://example.com/badge.png"}]
+    codeschool.code
+    => 200
     
-    codeschool.member_since
-    => "2011-03-22T06:54:21Z"
+    codeschool.message
+    => "OK"
     
-    codeschool.total_score
-    => "<b>114225</b>"
+Any error in the request will yield a message in the console or log.
     
-Team Treehouse example:
+Retrieved JSON is stored as a plain Ruby object inside the variable *codeschool.body*. Here's an example of proper usage:
 
-    treehouse = Badges::Treehouse.new('profile_name')
-    
-    treehouse.response
-    => nil # if false username
-    
-    treehouse.profile_name
-    => "profile_name"
-    
-    treehouse.profile_url
-    => "http://teamtreehouse.com/profile_name"
-    
-    treehouse.avatar_url
+    codeschool.body.user.avatar
     => "http://example.com/avatar.jpg"
+
+    codeschool.body.courses.completed.count
+    => 11
     
-    treehouse.badges
-    => [{"id"=>49, "name"=>"Badge", "url"=>"http://example.com", "icon_url"=>"http://example.com/badge.png", "earned_date"=>"2012-09-11T18:41:13Z", "courses"=>[]}]
-    
-    treehouse.full_name
-    => "First Last"
-    
-    treehouse.points
-    => {"total"=>1740, "html"=>447, "css"=>483, "javascript"=>0, "ruby"=>0, "ios"=>0, "business"=>0, "android"=>0, "php"=>0, "wordpress"=>0, "design"=>180, "dev tools"=>0}
-    
-    treehouse.points_android
-    => 1
-    
-    treehouse.points_business
-    => 1
-    
-    treehouse.points_css
-    => 1
-    
-    treehouse.points_design
-    => 1
-    
-    treehouse.points_dev_tools
-    => 1
-    
-    treehouse.points_html
-    => 1
-    
-    treehouse.points_ios
-    => 1
-    
-    treehouse.points_javascript
-    => 1
-    
-    treehouse.points_php
-    => 1
-    
-    treehouse.points_ruby
-    => 1
-    
-    treehouse.points_total
-    => 10
-    
-    treehouse.points_wordpress
+    codeschool.body.courses.completed[0].title
+    => "Rails for Zombies"
+
+You can view all the attributes of the JSON request online in a nice tree view gui by using the [Json Editor Online](http://www.jsoneditoronline.org).
 
-## Rails helpers
+#### Badges::Treehouse
 
-Create new badge object in your controller.
+    treehouse = Badges::Treehouse.new('username')
+
+## Rails view helpers
+
+#### list_badges
+
+Create a new instance of a badge request in the controller.
 
     class BadgesController < ApplicationController
       def index
@@ -131,21 +90,23 @@ Create new badge object in your controller.
       end
     end
 
-Inside your view, use the class methods directly, or the list_badges helper to create a list of badges. Params left out are assumed to be false.
+Inside your view, use the list_badges view helper to create a list of badges. Params left out are assumed to be false. You can also use class methods and variables inside the view.
 
     <h1>Badges#index</h1>
     <p>Find me in app/views/badges/index.html.erb</p>
     
-    <%= image_tag @codeschool.avatar_url %>
-    <%= list_badges @codeschool, codeschool_badges: {image: true, link: true, text: true}, id: 'test', class: 'test' %>
-    <%= list_badges @codeschool, codeschool_courses_completed: {image: true, link: true, text: true}, id: 'test', class: 'test' %>
-    <%= list_badges @codeschool, codeschool_courses_in_progress: {image: true, link: true, text: true}, id: 'test', class: 'test' %>
+    <%= image_tag @codeschool.body.user.avatar %>
+    <%= list_badges @codeschool, codeschool_badges: {image: true, link: true, text: true}, id: 'codeschool_badges', class: 'badges' %>
+    <%= list_badges @codeschool, codeschool_courses_completed: {image: true, link: true, text: true}, id: 'codeschool_courses_completed', class: 'badges' %>
+    <%= list_badges @codeschool, codeschool_courses_in_progress: {image: true, link: true, text: true}, id: 'codeschool_courses_in_progress', class: 'badges' %>
     
-    <%= @treehouse.avatar_url %>
-    <%= list_badges @treehouse, treehouse_badges: {image: true, link: true, text: true}, id: 'test', class: 'test' %>
+    <%= image_tag @treehouse.body.gravatar_url %>
+    <%= list_badges @treehouse, treehouse_badges: {image: true, link: true, text: true}, id: 'treehouse_badges', class: 'badges' %>
 
 Tip: Use css/sass afterwards to style this list appropriately.
 
+*list_badges* will render nothing if there is an error in the request. Check the console or log for an error message.
+
 ## Contributing
 
 1. Fork it

data/badges.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   
   spec.add_dependency 'activesupport'
   spec.add_dependency 'httparty'
+  spec.add_dependency 'dish'
   spec.add_dependency 'markaby'
   
   spec.add_development_dependency 'bundler', '~> 1.3'

data/lib/badges.rb

@@ -1,151 +1,48 @@
 require 'badges/version'
 require 'active_support/core_ext/object/blank'
 require 'httparty'
+require 'dish'
 
 module Badges
-  class Badge
+  class Request
     include HTTParty
-    attr_reader :user_id, :profile_url, :response
+    attr_reader :user_id, :profile_url, :code, :message, :body
     
     def initialize(user_id, base_url)
       @user_id = user_id
       @profile_url = base_url + user_id
-      @response = get(profile_url + '.json')
+      
+      response = HTTParty.get(@profile_url + '.json')
+      
+      @code = response.code
+      @message = response.message
+      @body = Dish parse(response.body)
+      
+      puts "#{self.class.name}: Response Error #{@code}, #{@message}" unless valid?
+    end
+    
+    def valid?
+      @code == 200 ? true : false
     end
     
     private
     
-    def get(url)
-      begin
-        JSON.parse HTTParty.get(url).response.body
-      rescue
+    def parse(body)
+      JSON.parse body
+      rescue JSON::ParserError
         nil
-      end
-    end
-    
-    def obtain_key(hash, key)
-      if hash.has_key?(key)
-        hash[key]
-      end
     end
   end
   
-  class CodeSchool < Badge
-    def initialize(user_id)
-      super(user_id, 'http://www.codeschool.com/users/')
-      
-      @response = nil if obtain_key(@response, 'error')
-    end
-    
-    def avatar_url
-      user = obtain_key @response, 'user' if @response
-      obtain_key user, 'avatar' if !user.blank?
-    end
-    
-    def badges
-      obtain_key @response, 'badges' if @response
-    end
-    
-    def courses_completed
-      courses = obtain_key @response, 'courses' if @response
-      obtain_key courses, 'completed' if !courses.blank?
-    end
-    
-    def courses_in_progress
-      courses = obtain_key @response, 'courses' if @response
-      obtain_key courses, 'in_progress' if !courses.blank?
-    end
-    
-    def member_since
-      user = obtain_key @response, 'user' if @response
-      obtain_key user, 'member_since' if !user.blank?
-    end
-    
-    def total_score
-      user = obtain_key @response, 'user' if @response
-      obtain_key user, 'total_score' if !user.blank?
+  class CodeSchool < Request
+    def initialize(user_id, base_url='http://www.codeschool.com/users/')
+      super(user_id, base_url)
     end
   end
   
-  class Treehouse < Badge
-    def initialize(user_id)
-      super(user_id, 'http://teamtreehouse.com/')
-    end
-    
-    def avatar_url
-      obtain_key @response, 'gravatar_url' if @response
-    end
-    
-    def badges
-      obtain_key @response, 'badges' if @response
-    end
-    
-    def full_name
-      obtain_key @response, 'name' if @response
-    end
-    
-    def points
-      obtain_key @response, 'points' if @response
-    end
-    
-    def points_android
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'android' if !points.blank?
-    end
-    
-    def points_business
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'business' if !points.blank?
-    end
-    
-    def points_css
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'css' if !points.blank?
-    end
-    
-    def points_design
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'design' if !points.blank?
-    end
-    
-    def points_dev_tools
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'dev tools' if !points.blank?
-    end
-    
-    def points_html
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'html' if !points.blank?
-    end
-    
-    def points_ios
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'ios' if !points.blank?
-    end
-    
-    def points_javascript
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'javascript' if !points.blank?
-    end
-    
-    def points_php
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'php' if !points.blank?
-    end
-    
-    def points_ruby
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'ruby' if !points.blank?
-    end
-    
-    def points_total
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'total' if !points.blank?
-    end
-    
-    def points_wordpress
-      points = obtain_key @response, 'points' if @response
-      obtain_key points, 'wordpress' if !points.blank?
+  class Treehouse < Request
+    def initialize(user_id, base_url='http://teamtreehouse.com/')
+      super(user_id, base_url)
     end
   end
 end

data/lib/badges/version.rb

@@ -1,3 +1,3 @@
 module Badges
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/badges/view_helpers.rb

@@ -3,25 +3,25 @@ require 'markaby'
 module Badges
   module ViewHelpers
     def list_badges(obj, options={})
-      return if obj.response.blank?
+      return unless obj.code == 200
       
       # Code School
-         
+      
       # badges
-      if !options[:codeschool_badges].blank? && !obj.badges.blank?
+      unless options[:codeschool_badges].blank? || obj.body.badges.blank?
         html = Markaby::Builder.new
         
         html.send :ul, ({id: options[:id]} if options[:id]), ({class: options[:class]} if options[:class]) do
-          obj.badges.each do |course|
+          obj.body.badges.each do |course|
             li do
               if options[:codeschool_badges][:link]
-                a href: course['course_url'] do
-                  img src: course['badge'] if options[:codeschool_badges][:image]
-                  span course['name'] if options[:codeschool_badges][:text]
+                a href: course.course_url do
+                  img src: course.badge if options[:codeschool_badges][:image]
+                  span course.name if options[:codeschool_badges][:text]
                 end
               else
-                img src: course['badge'] if options[:codeschool_badges][:image]
-                span course['name'] if options[:codeschool_badges][:text]
+                img src: course.badge if options[:codeschool_badges][:image]
+                span course.name if options[:codeschool_badges][:text]
               end
             end
           end
@@ -31,20 +31,20 @@ module Badges
       end
       
       # courses completed
-      if !options[:codeschool_courses_completed].blank? && !obj.courses_completed.blank?
+      unless options[:codeschool_courses_completed].blank? || obj.body.courses.completed.blank?
         html = Markaby::Builder.new
         
         html.send :ul, ({id: options[:id]} if options[:id]), ({class: options[:class]} if options[:class]) do
-          obj.courses_completed.each do |course|
+          obj.body.courses.completed.each do |course|
             li do
               if options[:codeschool_courses_completed][:link]
-                a href: course['url'] do
-                  img src: course['badge'] if options[:codeschool_courses_completed][:image]
-                  span course['title'] if options[:codeschool_courses_completed][:text]
+                a href: course.url do
+                  img src: course.badge if options[:codeschool_courses_completed][:image]
+                  span course.title if options[:codeschool_courses_completed][:text]
                 end
               else
-                img src: course['badge'] if options[:codeschool_courses_completed][:image]
-                span course['title'] if options[:codeschool_courses_completed][:text]
+                img src: course.badge if options[:codeschool_courses_completed][:image]
+                span course.title if options[:codeschool_courses_completed][:text]
               end
             end
           end
@@ -54,20 +54,20 @@ module Badges
       end
       
       # courses in progress
-      if !options[:codeschool_courses_in_progress].blank? && !obj.courses_in_progress.blank?
+      unless options[:codeschool_courses_in_progress].blank? || obj.body.courses.in_progress.blank?
         html = Markaby::Builder.new
         
         html.send :ul, ({id: options[:id]} if options[:id]), ({class: options[:class]} if options[:class]) do
-          obj.courses_in_progress.each do |course|
+          obj.body.courses.in_progress.each do |course|
             li do
               if options[:codeschool_courses_in_progress][:link]
-                a href: course['url'] do
-                  img src: course['badge'] if options[:codeschool_courses_in_progress][:image]
-                  span course['title'] if options[:codeschool_courses_in_progress][:text]
+                a href: course.url do
+                  img src: course.badge if options[:codeschool_courses_in_progress][:image]
+                  span course.title if options[:codeschool_courses_in_progress][:text]
                 end
               else
-                img src: course['badge'] if options[:codeschool_courses_in_progress][:image]
-                span course['title'] if options[:codeschool_courses_in_progress][:text]
+                img src: course.badge if options[:codeschool_courses_in_progress][:image]
+                span course.title if options[:codeschool_courses_in_progress][:text]
               end
             end
           end
@@ -79,20 +79,20 @@ module Badges
       # Treehouse
       
       # badges
-      if !options[:treehouse_badges].blank? && !obj.badges.blank?
+      unless options[:treehouse_badges].blank? || obj.body.badges.blank?
         html = Markaby::Builder.new
         
         html.send :ul, ({id: options[:id]} if options[:id]), ({class: options[:class]} if options[:class]) do
-          obj.badges.each do |course|
+          obj.body.badges.each do |course|
             li do
               if options[:treehouse_badges][:link]
-                a href: course['url'] do
-                  img src: course['icon_url'] if options[:treehouse_badges][:image]
-                  span course['name'] if options[:treehouse_badges][:text]
+                a href: course.url do
+                  img src: course.icon_url if options[:treehouse_badges][:image]
+                  span course.name if options[:treehouse_badges][:text]
                 end
               else
-                img src: course['icon_url'] if options[:treehouse_badges][:image]
-                span course['name'] if options[:treehouse_badges][:text]
+                img src: course.icon_url if options[:treehouse_badges][:image]
+                span course.name if options[:treehouse_badges][:text]
               end
             end
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: badges
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Keil Miller Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: markaby
   requirement: !ruby/object:Gem::Requirement