uboost-client 0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENCE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Gonzalo Rodríguez-Baltanás Díaz, Haiku Learning Systems
+
+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.markdown

@@ -0,0 +1,48 @@
+# uBoost Client API
+
+This is the unofficial ruby client for uBoost API. It is a wrapper for the REST interface described at [https://github.com/chriskk/uBoost-API-v2](https://github.com/chriskk/uBoost-API-v2)
+
+## Installing
+
+```bash
+gem install 'uboost-client'
+```
+
+## API
+
+```ruby
+require 'uboost-client'
+
+client = UboostClient::Client.new(:subdomain => 'test_subdomain', :api_credentials => 
+  {:username => 'api_username', password => 'api_password'})
+
+# Examples
+
+client.account.create({ "user_name" => "test_user_2" })
+=>
+  #<OpenStruct student={"id"=>921679358, "external_id"=>nil, "catalog_id"=>109, "site_id"=>98, "user_name"=>"test_user_2", "encrypted_password"=>"kabyle00", "points"=>0, "points_accumulated"=>0, ...}
+
+client.account.select(921679358)
+
+client.account.delete(921679358)
+
+client.account.update(921679358, {:first_name => 'custom name'})
+
+client.account.find(:user_name => 'isaacnewtonx')
+
+client.account.find(:external_id => '3253466')
+
+client.account.token(921679358)
+
+client.points.point_transactions_for_account(921679358)
+
+client.account.points_transactions(921679358)
+
+client.points.add_points_to_account(921679359, 30, {:description => 'a description'})
+
+client.badges.award(921679359, 1)
+
+client.badges.unaward(921679359, 1)
+
+client.widgets.profile(921679358)
+```

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require File.expand_path('./lib/uboost-client/version')
+
+desc "Build gem"
+task 'build' do
+  system("gem build uboost-client.gemspec")
+end
+
+desc "Publish gem"
+task "release" do
+  system("gem push uboost-client-#{UboostClient::VERSION}.gem")
+end
+
+desc "Remove built gems"
+task "clear" do
+  system("rm *.gem")
+end

data/lib/uboost-client/uboost_client.rb

@@ -0,0 +1,208 @@
+require 'rubygems'
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module UboostClient
+
+  class Client
+
+    attr_accessor :subdomain, :api_credentials
+
+    def initialize(options = Hash.new)
+      @subdomain        = options[:subdomain]
+      @api_credentials  = options[:api_credentials]
+    end
+
+    def connection
+      url = "https://#{@api_credentials[:username]}:#{@api_credentials[:password]}@#{@subdomain}.uboost.com"
+      Faraday.new(url) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def account
+      @account ||= UboostClient::Account.new(self)
+    end
+
+    def points
+      @points ||= UboostClient::Points.new(self)
+    end
+
+    def badges
+      @badges ||= UboostClient::Badges.new(self)
+    end
+
+    def widgets
+      @widgets ||= UboostClient::Widgets.new(self)
+    end
+
+  end
+
+  class Account
+    attr_accessor :client, :url
+
+    def initialize(client)
+      @client = client
+      @url = '/api/accounts'
+    end
+
+    def create(data)
+      data = {'account' => data}
+      response = client.connection.post do |req|
+        req.url @url
+        req.headers['Content-Type'] = 'application/json'
+        req.body = JSON.generate(data)
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def select(account_id)
+      response = client.connection.get "#{@url}/#{account_id}"
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def update(account_id, hash)
+      data = {'account' => hash}
+      response = client.connection.put do |req|
+        req.url "#{@url}/#{account_id}"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = JSON.generate(data)
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def delete(account_id)
+      response = client.connection.delete "#{@url}/#{account_id}"
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def find(query)
+      response = client.connection.get do |req|
+        req.url @url + "/find", query
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def token(id)
+      response = client.connection.get "#{@url}/#{id}/sign_in_user"
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def points_transactions(account_id, options = nil)
+      response = client.connection.get do |req|
+        req.url @url + "/#{account_id}/points_transactions", options
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+  end
+
+  class Points
+
+    attr_accessor :connection, :url
+
+    def initialize(client)
+      client.connection = client
+      @url = '/api/points_transactions'
+    end
+
+    def points_transactions_for_account(id_or_options)
+      options = id_or_options
+      options = {:account_id => id_or_options} if !id_or_options.is_a? Hash
+      response = client.connection.get do |req|
+        req.url @url, options
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def add_points_to_account(id, points, options = nil)
+      data = {:points_transaction => {:account_id => id, :points_change => points}}
+      data[:points_transaction].merge!(options) if options
+      response = client.connection.post do |req|
+        req.url @url
+        req.headers['Content-Type'] = 'application/json'
+        req.body = JSON.generate(data)
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+  end
+
+  class Badges
+
+    attr_accessor :client, :url
+
+    def initialize(client)
+      @client = client
+      @url = '/api/badges'
+    end
+
+    def award(account_id, badge_type_id, options = nil)
+      data = {:badge => {:account_id => account_id, :badge_type_id => badge_type_id}}
+      data[:badge].merge!(options) if options
+      response = client.connection.post do |req|
+        req.url @url
+        req.headers['Content-Type'] = 'application/json'
+        req.body = JSON.generate(data)
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def unaward(account_id, badge_type_id, options = nil)
+      data = {:badge => {:account_id => account_id, :badge_type_id => badge_type_id}}
+      data[:badge].merge!(options) if options
+      response = client.connection.delete do |req|
+        req.url @url + "/unaward"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = JSON.generate(data)
+      end
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+  end
+
+  class Widgets
+    attr_accessor :url, :client
+
+    def initialize(client)
+      @client = client
+      @url = '/api/widgets'
+    end
+
+    def get_sso_token(account_id)
+      client.account.token(account_id).student["sso_token"]
+    end
+
+    def profile(account_id)
+      response = @client.connection.get @url + '/profile', :sso_token => get_sso_token(account_id)
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def ubar(account_id, options = Hash.new)
+      options = {:align => "", :bar_color => '', :div_id => ''}.merge(options)
+      token = get_sso_token(account_id)
+      subdomain_url = client.subdomain + ".uboost.com"
+
+"      <div style='position: absolute; bottom: 0px; z-index: 2; height: 36px;' id='#{options[:div_id]}'>
+        <object>
+          <param value='#{subdomain_url}/uBar.swf' name='movie'>
+          <param value='100%' name='width'>
+          <param value='100%' name='height'>
+          <param value='transparent' name='wmode'>
+          <param value='always' name='allowScriptAccess'>
+          <param value='url=#{subdomain_url}/ubar/&token=#{token}&align=#{options[:align]}&barColor=#{options[:bar_color]}&divId=#{options[:div_id]}'
+           name='flashvars'>
+          <param value='false' name='cacheBusting'>
+          <param value='true' name='allowFullScreen'>
+          <embed width='1280' height='400' wmode='transparent' allowfullscreen='true' quality='high'
+            cachebusting='false' flashvars='url=#{subdomain_url}/ubar/&token=#{token}&align=#{options[:align]}&barColor=#{options[:bar_color]}&divId=#{:div_id}'
+            allowscriptaccess='always' src='#{subdomain_url}/uBar.swf'>
+        </object>
+      </div>"
+    end
+  end
+
+end

data/lib/uboost-client/version.rb

@@ -0,0 +1,3 @@
+class UboostClient
+  VERSION = "0.1"  
+end

data/lib/uboost-client.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'uboost-client', 'uboost_client')

data/spec/simple_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path('lib/uboost-client')
+
+subdomain        = ENV['UBOOST_SUBDOMAIN']
+api_credentials  = { :username => ENV['UBOOST_USERNAME'], :password => ENV['UBOOST_PASSWORD'] }
+
+client = UboostClient::Client.new(:subdomain => subdomain, :api_credentials => api_credentials)
+
+# puts client.account.create({ "user_name" => "test_user_2" })
+puts client.account.select(921679358).inspect
+# puts client.account.delete(921679358)
+# puts client.account.update(921679358, {:first_name => 'custom name'})
+# puts client.account.find(:user_name => 'isaacnewtonx')
+# puts client.account.find(:external_id => '3253466')
+# puts client.account.token(921679358)
+# puts client.points.point_transactions_for_account(921679358)
+# puts client.account.points_transactions(921679358)
+# puts client.points.add_points_to_account(921679359, 30, {:description => 'whatps'})
+# puts client.badges.award(921679359, 1)
+# puts client.badges.unaward(921679359, 1)
+# puts client.widgets.profile(921679358)

data/uboost-client.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('./lib/uboost-client/version')
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gonzalo Rodríguez-Baltanás Díaz"]
+  gem.email         = ["siotopo@gmail.com"]
+  gem.description   = %q{uBoost ruby client}
+  gem.homepage      = "https://github.com/haikulearning/uboost-client"
+  gem.summary       = gem.description
+
+  gem.name          = "uboost-client"
+  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split("\n")
+  gem.version       = UboostClient::VERSION
+
+  gem.add_dependency "faraday"
+  gem.add_development_dependency "bundler", ">= 1.0"
+  gem.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: uboost-client
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Gonzalo Rodríguez-Baltanás Díaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: uBoost ruby client
+email:
+- siotopo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENCE.txt
+- README.markdown
+- Rakefile
+- lib/uboost-client.rb
+- lib/uboost-client/uboost_client.rb
+- lib/uboost-client/version.rb
+- spec/simple_test.rb
+- uboost-client.gemspec
+homepage: https://github.com/haikulearning/uboost-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: uBoost ruby client
+test_files: []