badges 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c93936af21bbeade438e46a117aed48ef2a9027a
-  data.tar.gz: 756a2ddff2b56a85afdb72f48c404ae416f589c6
+  metadata.gz: 94ba37e390392c87e71b7e0e7c149fbf5abefcda
+  data.tar.gz: 713f593501a9d8413debf985c3a4429ce0fcc8d1
 SHA512:
-  metadata.gz: 282c0be03afe7c89cd1ef4262ad63331a9ef10d9b333173606d44c18e0f97397a79968b8f8b1f1c26a7fe3b6ace5a0133fbd5852a582c5fb66410f2e8f2c4776
-  data.tar.gz: 52d11a131b865972e4491f5a1dd7b12af82eda5a20bf11c840be440afc986304446b880dd3d2af80156a61878e3e591ff723283635a84c826fa61afc9631d283
+  metadata.gz: 55447da027202aa56d5650054071ef5650be9e21a6a0a0a5da7e950d6f4b6d2474ed1483defdfa270cee33967ae87be398a264102a11ff882069630dfca6b7fa
+  data.tar.gz: c9f49465423566edf0a80df3a4008689283dc32f21acb4e5d1dcd6266f77599cafa2914a9eb939fe1855603dfb733554f222bbc198a248ae39e36cd230b32076

data/README.md

@@ -1,6 +1,10 @@
-# Badges
+[![Badges Logo](badges.png)](https://github.com/keilmillerjr/badges)
 
-Badges is a Ruby gem that allows you to connect to different API's to retrieve your earned badges and profile information.
+By [Keil Miller Jr](http://keilmiller.com)
+
+[![Gem Version](https://badge.fury.io/rb/badges.png)](http://badge.fury.io/rb/badges)
+
+**badges** is a Ruby gem that allows you to connect to different API's to retrieve your earned badges and profile information.
 
 ## Installation
 
@@ -19,14 +23,19 @@ Or install it yourself as:
 ## Requirements
 
 * Ruby 1.9.3 or higher
+* activesupport
 * httparty
+* markaby
 
-## Usage
+## Class usage
 
 CodeSchool example:
 
     codeschool = Badges::CodeSchool.new('username')
     
+    codeschool.response
+    => nil # if false username
+    
     codeschool.username
     => "username"
     
@@ -36,12 +45,12 @@ CodeSchool example:
     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.courses_completed[0]['title']
-    => "Course"
-    
     codeschool.courses_in_progress
     => [{"title"=>"Course", "url"=>"http://example.com", "badge"=>"http://example.com/badge.png"}]
     
@@ -55,29 +64,87 @@ Team Treehouse example:
 
     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
+    => "http://example.com/avatar.jpg"
+    
     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.badges[0]['name']
-    => "Badge"
-    
-    treehouse.gravatar_url
-    => "http://example.com/avatar.jpg"
     
-    treehouse.name
+    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
-    => 1740
+    => 10
+    
+    treehouse.points_wordpress
+
+## Rails helpers
+
+Create new badge object in your controller.
+
+    class BadgesController < ApplicationController
+      def index
+        @codeschool = Badges::CodeSchool.new('keilmillerjr')
+        @treehouse = Badges::Treehouse.new('keilmillerjr')
+      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.
+
+    <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' %>
+    
+    <%= @treehouse.avatar_url %>
+    <%= list_badges @treehouse, treehouse_badges: {image: true, link: true, text: true}, id: 'test', class: 'test' %>
+
+Tip: Use css/sass afterwards to style this list appropriately.
 
 ## Contributing
 

data/badges.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
   
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'markaby'
+  
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  
-  spec.add_development_dependency 'httparty'
 end

data/lib/badges.rb

@@ -1,9 +1,17 @@
 require 'badges/version'
+require 'active_support/core_ext/object/blank'
 require 'httparty'
 
 module Badges
   class Badge
     include HTTParty
+    attr_reader :user_id, :profile_url, :response
+    
+    def initialize(user_id, base_url)
+      @user_id = user_id
+      @profile_url = base_url + user_id
+      @response = get(profile_url + '.json')
+    end
     
     private
     
@@ -14,115 +22,132 @@ module Badges
         nil
       end
     end
+    
+    def obtain_key(hash, key)
+      if hash.has_key?(key)
+        hash[key]
+      end
+    end
   end
   
   class CodeSchool < Badge
-    attr_reader :profile_url, :username
-    
-    def initialize(username)
-      @username = username
-      @profile_url = 'http://www.codeschool.com/users/' + @username
+    def initialize(user_id)
+      super(user_id, 'http://www.codeschool.com/users/')
       
-      @response = get(@profile_url + '.json')
+      @response = nil if obtain_key(@response, 'error')
     end
     
     def avatar_url
-      begin
-        @response['user']['avatar']
-      rescue
-        nil
-      end
+      user = obtain_key @response, 'user' if @response
+      obtain_key user, 'avatar' if !user.blank?
     end
     
     def badges
-      begin
-        @response['badges']
-      rescue
-        nil
-      end
+      obtain_key @response, 'badges' if @response
     end
     
     def courses_completed
-      begin
-        @response['courses']['completed']
-      rescue
-        nil
-      end
+      courses = obtain_key @response, 'courses' if @response
+      obtain_key courses, 'completed' if !courses.blank?
     end
     
     def courses_in_progress
-      begin
-        @response['courses']['in_progress']
-      rescue
-        nil
-      end
+      courses = obtain_key @response, 'courses' if @response
+      obtain_key courses, 'in_progress' if !courses.blank?
     end
     
     def member_since
-      begin
-        @response['user']['member_since']
-      rescue
-        nil
-      end
+      user = obtain_key @response, 'user' if @response
+      obtain_key user, 'member_since' if !user.blank?
     end
     
     def total_score
-      begin
-        @response['user']['total_score']
-      rescue
-        nil
-      end
+      user = obtain_key @response, 'user' if @response
+      obtain_key user, 'total_score' if !user.blank?
     end
   end
   
   class Treehouse < Badge
-    attr_reader :profile_name, :profile_url
+    def initialize(user_id)
+      super(user_id, 'http://teamtreehouse.com/')
+    end
     
-    def initialize(profile_name)
-      @profile_name = profile_name
-      @profile_url = 'http://teamtreehouse.com/' + @profile_name
-      
-      @response = get(@profile_url + '.json')
+    def avatar_url
+      obtain_key @response, 'gravatar_url' if @response
     end
     
     def badges
-      begin
-        @response['badges']
-      rescue
-        nil
-      end
+      obtain_key @response, 'badges' if @response
     end
     
-    def gravatar_url
-      begin
-        @response['gravatar_url']
-      rescue
-        nil
-      end
+    def full_name
+      obtain_key @response, 'name' if @response
     end
     
-    def name
-      begin
-        @response['name']
-      rescue
-        nil
-      end
+    def points
+      obtain_key @response, 'points' if @response
     end
     
-    def points
-      begin
-        @response['points']
-      rescue
-        nil
-      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
-      begin
-        @response['points']['total']
-      rescue
-        nil
-      end
+      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?
     end
   end
 end
+
+require 'badges/railtie' if defined?(Rails)

data/lib/badges/railtie.rb

@@ -0,0 +1,9 @@
+require 'badges/view_helpers'
+
+module Badges
+  class Railtie < Rails::Railtie
+    initializer 'badges.view_helpers' do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/badges/version.rb

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

data/lib/badges/view_helpers.rb

@@ -0,0 +1,105 @@
+require 'markaby'
+
+module Badges
+  module ViewHelpers
+    def list_badges(obj, options={})
+      return if obj.response.blank?
+      
+      # Code School
+         
+      # badges
+      if !options[:codeschool_badges].blank? && !obj.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|
+            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]
+                end
+              else
+                img src: course['badge'] if options[:codeschool_badges][:image]
+                span course['name'] if options[:codeschool_badges][:text]
+              end
+            end
+          end
+        end
+        
+        return html.to_s.html_safe
+      end
+      
+      # courses completed
+      if !options[:codeschool_courses_completed].blank? && !obj.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|
+            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]
+                end
+              else
+                img src: course['badge'] if options[:codeschool_courses_completed][:image]
+                span course['title'] if options[:codeschool_courses_completed][:text]
+              end
+            end
+          end
+        end
+        
+        return html.to_s.html_safe
+      end
+      
+      # courses in progress
+      if !options[:codeschool_courses_in_progress].blank? && !obj.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|
+            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]
+                end
+              else
+                img src: course['badge'] if options[:codeschool_courses_in_progress][:image]
+                span course['title'] if options[:codeschool_courses_in_progress][:text]
+              end
+            end
+          end
+        end
+        
+        return html.to_s.html_safe
+      end
+      
+      # Treehouse
+      
+      # badges
+      if !options[:treehouse_badges].blank? && !obj.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|
+            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]
+                end
+              else
+                img src: course['icon_url'] if options[:treehouse_badges][:image]
+                span course['name'] if options[:treehouse_badges][:text]
+              end
+            end
+          end
+        end
+        
+        return html.to_s.html_safe
+      end
+    end
+  end
+end

metadata

@@ -1,37 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: badges
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Keil Miller Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: markaby
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -66,8 +94,11 @@ files:
 - README.md
 - Rakefile
 - badges.gemspec
+- badges.png
 - lib/badges.rb
+- lib/badges/railtie.rb
 - lib/badges/version.rb
+- lib/badges/view_helpers.rb
 homepage: https://github.com/keilmillerjr/badges
 licenses:
 - MIT