talentlms 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e7382d7696dd177403fb5baae0e0616dce60b86
-  data.tar.gz: 2a183732ab174a48b4389e9142c2f89072c63785
+  metadata.gz: 4e3b54836421ee2bd2c72bfde400bbf7482c63bb
+  data.tar.gz: 00ec7ae82a6eb16c3404b0471f3f3add14d3b4e2
 SHA512:
-  metadata.gz: 8348f14f0370ea7bdace178d85c1b019a6c17b44231550156af73fb1e4f4959a712fac350e9478a18d72772391086f23b5b09cdd61ed7cb4070fbd7dcd44350c
-  data.tar.gz: 776c9f0bc04a9b9ce1d6813dfc8695fe39649c1394b365d4beec28a3696b469fa684f4ce2167353072b36e03d64eeda1219400583a9e0e4f4632f900b9766a6e
+  metadata.gz: 7b1f6dcb4defd3c221e557505a7a2b5f767fe8891f05a318fd5b65043f359f54be630414b26cf0ae11dc1d3c0238cf6f3fdf1ce4fdafa5236997185be00b60ac
+  data.tar.gz: 7775aaf9949a97116e48f6e679f63039fdcce99b26919363acca7934f08f26e7d882947c6b2efab55b19c4b67616531978b54deb7b89006e61915921c265b26a

data/README.md

@@ -23,78 +23,78 @@ Or install it yourself as:
 
 ## Usage
 
-    @client = TalentLMS::Client.new({
+    TalentLMS.init({
       :api_key => '03a82de6de2d939564aa607b0e24a030b5047c54ed87c77fea',
       :sub_domain => 'example'
     })
 
-    @client.users
+    TalentLMS.users
 
-    @client.users(:id => 1)
+    TalentLMS.users(:id => 1)
 
-    @client.users(:email => 'tyler@example.com')
+    TalentLMS.users(:email => 'tyler@example.com')
 
-    @client.courses
+    TalentLMS.courses
 
-    @client.courses(:id => 1)
+    TalentLMS.courses(:id => 1)
 
-    @client.categories
+    TalentLMS.categories
 
-    @client.categories(:id => 1)
+    TalentLMS.categories(:id => 1)
 
-    @client.groups
+    TalentLMS.groups
 
-    @client.groups(:id => 1)
+    TalentLMS.groups(:id => 1)
 
-    @client.branches
+    TalentLMS.branches
 
-    @client.branches(:id => 1)
+    TalentLMS.branches(:id => 1)
 
-    @client.siteinfo
+    TalentLMS.siteinfo
 
-    @client.siteinfo
+    TalentLMS.siteinfo
 
-    @client.userlogin
+    TalentLMS.userlogin
 
-    @client.userlogout
+    TalentLMS.userlogout
 
-    @client.usersignup
+    TalentLMS.usersignup
 
-    @client.usersetstatus(:user_id =>1, status => 'complete')
+    TalentLMS.usersetstatus(:user_id =>1, status => 'complete')
 
-    @client.forgotusername(email => 'tyler@example.com', domain_url => 'http://www.example.com/login')
+    TalentLMS.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')
+    TalentLMS.forgotpassword(username => 'tyler', domain_url => 'http://www.example.com', redirect_url => 'http://www.example.com/login')
 
-    @client.addusertocourse
+    TalentLMS.addusertocourse
 
-    @client.addusertobranch(:user_id => 1, :branch_id => 111)
+    TalentLMS.addusertobranch(:user_id => 1, :branch_id => 111)
 
-    @client.addcoursetobranch(:course_id => 1, :branch_id => 111)
+    TalentLMS.addcoursetobranch(:course_id => 1, :branch_id => 111)
 
-    @client.addusertogroup(:user_id => 1, :group_key => 12)
+    TalentLMS.addusertogroup(:user_id => 1, :group_key => 12)
 
-    @client.removeuserfromgroup(:user_id => 1, :group_id => 12)
+    TalentLMS.removeuserfromgroup(:user_id => 1, :group_id => 12)
 
-    @client.addcoursetogroup(:course_id => 1, :group_id => 12)
+    TalentLMS.addcoursetogroup(:course_id => 1, :group_id => 12)
 
-    @client.gotocourse(:user_id => 1, :course_id => 1)
+    TalentLMS.gotocourse(:user_id => 1, :course_id => 1)
 
-    @client.buycourse
+    TalentLMS.buycourse
 
-    @client.buycategorycourses
+    TalentLMS.buycategorycourses
 
-    @client.getcustomregistrationfields
+    TalentLMS.getcustomregistrationfields
 
-    @client.categoryleafsandcourses(:id => 3)
+    TalentLMS.categoryleafsandcourses(:id => 3)
 
-    @client.getusersprogressinunits(:unit_id => 56, :user_id => 1)
+    TalentLMS.getusersprogressinunits(:unit_id => 56, :user_id => 1)
 
-    @client.creategroup
+    TalentLMS.creategroup
 
-    @client.createbranch
+    TalentLMS.createbranch
 
-    @client.ratelimit
+    TalentLMS.ratelimit
 
 ## Contributing
 

data/lib/talentlms.rb

@@ -1,14 +1,21 @@
 require "talentlms/version"
 require "talentlms/client"
+require "talentlms/api_error"
 
 module TalentLMS
   extend self
 
   def init(options={})
-    @@client = TalentLMS::Client.new(options)
+    @@client = Client.new(options)
   end
 
   def method_missing(method, *args, &block)
-    @@client.send(method, *args, &block)
+    response = @@client.send(method, *args, &block)
+    raise ApiError.new(response) if error_response?(response)
+    response
+  end
+
+  def error_response?(response)
+    response.is_a?(Hash) && response.key?("error")
   end
 end

data/lib/talentlms/api_error.rb

@@ -0,0 +1,8 @@
+class ApiError < Exception
+  attr_accessor :message
+
+  def initialize(response)
+    @type = response["error"]["type"]
+    @message = response["error"]["message"]
+  end
+end

data/lib/talentlms/client.rb

@@ -5,10 +5,10 @@ require 'base64'
 module TalentLMS
   class Client
     def initialize(config = {})
-      raise ArgumentError.new('Missing API key') unless config.has_key?(:api_key)
+      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)
+      raise ArgumentError.new('Missing sub_domain') unless config.has_key?(:sub_domain)
       @sub_domain = config[:sub_domain]
 
       @version = 'v1' || config[:version]

data/lib/talentlms/version.rb

@@ -1,3 +1,3 @@
 module Talentlms
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/unit/api_test.rb

@@ -37,4 +37,13 @@ describe 'API' do
     expected = {"id" => 5}
     assert_equal expected, TalentLMS.courses(:id => 5)
   end
+
+  it 'throws exception with details on error' do
+    error_message = "{\"error\":{\"type\": \"invalid_request_error\", \"message\": \"Invalid arguments provided\"}}"
+    stub_request(:get, "https://example.talentlms.com/api/v1/courses/id:5")
+      .with(:headers => @headers)
+      .to_return(:status => 200, :body => error_message, :headers => {})
+
+    assert_raises(ApiError) { TalentLMS.courses(:id => 5) }
+  end
 end

data/test/unit/client_test.rb

@@ -9,6 +9,22 @@ describe 'Client' do
     })
   end
 
+  describe '#initialize' do
+    it 'api_key is a required field' do
+      err = -> {
+        TalentLMS::Client.new(:sub_domain => '')
+      }.must_raise ArgumentError
+      err.message.must_match /api_key/
+    end
+
+    it 'subdomain is a required field' do
+      err = -> {
+        TalentLMS::Client.new(:api_key => '')
+      }.must_raise ArgumentError
+      err.message.must_match /sub_domain/
+    end
+  end
+
   describe '#auth_header' do
     it 'adds auth header without white space' do
       expected = 'Basic MDNhODJkZTZkZTJkOTM5NTY0YWE2MDdiMGUyNGEwMzBiNTA0N2M1NGVkODdjNzdmZWE6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: talentlms
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tyler Mercier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -95,6 +95,7 @@ files:
 - README.md
 - Rakefile
 - lib/talentlms.rb
+- lib/talentlms/api_error.rb
 - lib/talentlms/client.rb
 - lib/talentlms/version.rb
 - talentlms.gemspec