talentlms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac0dec21de1848e106494349efde89e7a0987f32
+  data.tar.gz: 3170a23e6d4f092f36ff8a571b705dbc11de8c8c
+SHA512:
+  metadata.gz: ca1f462b79ebb2456518e8d502b53d0a51c29b0fc1266d63d5a2c3646dcf9dc0d2dbd3e9197c4bf5b33c8fa03abbe4fbad24357f06d3e2779dca8ee326f9c1f1
+  data.tar.gz: 37ddedea22e72c351cfe3334eb453996c82645068bca673d30743005f9944bdf22420e5d414b193abd9dbe942df29943fe2ba923d7cb17f07f3d0a7bda327884

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tyler Mercier
+
+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,105 @@
+# Talentlms
+
+Ruby gem for the [Talent LMS API](http://www.talentlms.com)
+
+## Status
+[![Gem Version](https://badge.fury.io/rb/talentlms.png)](http://badge.fury.io/rb/talentlms)
+[![Build Status](https://secure.travis-ci.org/tylermercier/talentlms.png)](http://travis-ci.org/tylermercier/talentlms)
+[![Code Climate](https://codeclimate.com/github/tylermercier/talentlms.png)](https://codeclimate.com/github/tylermercier/talentlms)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'talentlms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install talentlms
+
+## Usage
+
+    @client = TalentLMS::Client.new({
+      :api_key => '03a82de6de2d939564aa607b0e24a030b5047c54ed87c77fea',
+      :sub_domain => 'example'
+    })
+
+    @client.users
+
+    @client.users(:id => 1)
+
+    @client.users(:email => 'tyler@example.com')
+
+    @client.courses
+
+    @client.courses(:id => 1)
+
+    @client.categories
+
+    @client.categories(:id => 1)
+
+    @client.groups
+
+    @client.groups(:id => 1)
+
+    @client.branches
+
+    @client.branches(:id => 1)
+
+    @client.siteinfo
+
+    @client.siteinfo
+
+    @client.userlogin
+
+    @client.userlogout
+
+    @client.usersignup
+
+    @client.usersetstatus(:user_id =>1, status => 'complete')
+
+    @client.forgotusername(email => 'tyler@example.com', domain_url => 'http://www.example.com/login')
+
+    @client.forgotpassword(username => 'tyler', domain_url => 'http://www.example.com', redirect_url => 'http://www.example.com/login')
+
+    @client.addusertocourse
+
+    @client.addusertobranch(:user_id => 1, :branch_id => 111)
+
+    @client.addcoursetobranch(:course_id => 1, :branch_id => 111)
+
+    @client.addusertogroup(:user_id => 1, :group_key => 12)
+
+    @client.removeuserfromgroup(:user_id => 1, :group_id => 12)
+
+    @client.addcoursetogroup(:course_id => 1, :group_id => 12)
+
+    @client.gotocourse(:user_id => 1, :course_id => 1)
+
+    @client.buycourse
+
+    @client.buycategorycourses
+
+    @client.getcustomregistrationfields
+
+    @client.categoryleafsandcourses(:id => 3)
+
+    @client.getusersprogressinunits(:unit_id => 56, :user_id => 1)
+
+    @client.creategroup
+
+    @client.createbranch
+
+    @client.ratelimit
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/talentlms/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler"
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: 'test'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/talentlms.rb

@@ -0,0 +1,2 @@
+require "talentlms/version"
+require "talentlms/client"

data/lib/talentlms/client.rb

@@ -0,0 +1,35 @@
+require 'http'
+require 'json'
+require 'base64'
+
+module TalentLMS
+  class Client
+    def initialize(config = {})
+      raise ArgumentError.new('Missing API key') unless config.has_key?(:api_key)
+      @auth_header = auth_header(config[:api_key])
+
+      raise ArgumentError.new('Missing Sub Domain') unless config.has_key?(:sub_domain)
+      @sub_domain = config[:sub_domain]
+
+      @version = 'v1' || config[:version]
+    end
+
+    def auth_header(username)
+      key = Base64.strict_encode64("#{username}:")
+      { 'Authorization' => "Basic #{key}" }
+    end
+
+    def route_for_method(method, options=nil)
+      url = "https://#{@sub_domain}.talentlms.com/api/#{@version}/#{method}"
+      return url if options.nil?
+      arguments = options.map {|k,v| "#{k}:#{v}"}.join(',')
+      "#{url}/#{arguments}"
+    end
+
+    def method_missing(sym, *args, &block)
+      url = route_for_method(sym.to_s, *args)
+      response = HTTP.with(@auth_header).get(url)
+      JSON.parse(response)
+    end
+  end
+end

data/lib/talentlms/version.rb

@@ -0,0 +1,3 @@
+module Talentlms
+  VERSION = "0.0.1"
+end

data/talentlms.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'talentlms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "talentlms"
+  spec.version       = Talentlms::VERSION
+  spec.authors       = ["Tyler Mercier"]
+  spec.email         = ["tylermercier@gmail.com"]
+  spec.summary       = %q{Talent LMS API gem}
+  spec.description   = %q{Talent LMS API gem}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "webmock"
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'webmock/minitest'
+
+Minitest::Reporters.use!(Minitest::Reporters::DefaultReporter.new(color: true))
+
+ENV['RACK_ENV'] = 'test'
+
+Dir[File.dirname(__FILE__) + '/../lib/*.rb'].each do |file|
+  require File.basename(file, File.extname(file))
+end

data/test/unit/client_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+describe 'Client' do
+  before do
+    @key = '03a82de6de2d939564aa607b0e24a030b5047c54ed87c77fea'
+    @client = TalentLMS::Client.new({
+      :api_key => @key,
+      :sub_domain => 'example'
+    })
+    @headers = {
+      'Authorization' => 'Basic MDNhODJkZTZkZTJkOTM5NTY0YWE2MDdiMGUyNGEwMzBiNTA0N2M1NGVkODdjNzdmZWE6',
+      'Host' => 'example.talentlms.com',
+      'User-Agent' => 'RubyHTTPGem/0.5.0'
+    }
+  end
+
+  describe '#auth_header' do
+    it 'adds auth header without white space' do
+      expected = @headers["Authorization"]
+      assert_equal expected, @client.auth_header(@key)["Authorization"]
+    end
+  end
+
+  describe '#route_for_method' do
+    it 'creates index route' do
+      expected = 'https://example.talentlms.com/api/v1/users'
+      assert_equal expected, @client.route_for_method('users')
+    end
+
+    it 'creates index route with argument' do
+      expected = 'https://example.talentlms.com/api/v1/users/id:1'
+      assert_equal expected, @client.route_for_method('users', :id => 1)
+    end
+
+    it 'creates index route with arguments' do
+      expected = 'https://example.talentlms.com/api/v1/usersetstatus/user_id:1,status:ok'
+      assert_equal expected, @client.route_for_method('usersetstatus', :user_id => 1, :status => 'ok')
+    end
+  end
+
+  describe 'API' do
+    it 'finds user by id' do
+      stub_request(:get, "https://example.talentlms.com/api/v1/users/id:1").
+        with(:headers => @headers).
+        to_return(:status => 200, :body => "{\"id\": 1}", :headers => {})
+
+      expected = {"id" => 1}
+      assert_equal expected, @client.users(:id => 1)
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: talentlms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Mercier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: Talent LMS API gem
+email:
+- tylermercier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/talentlms.rb
+- lib/talentlms/client.rb
+- lib/talentlms/version.rb
+- talentlms.gemspec
+- test/test_helper.rb
+- test/unit/client_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Talent LMS API gem
+test_files:
+- test/test_helper.rb
+- test/unit/client_test.rb