shift_planning 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca87d9153c5e9db23c2e970284df203b53bfb3be
-  data.tar.gz: c9dcecebb9c5b77e56e24b7fa166b0ca5b36bef4
+  metadata.gz: 336bfa5c60eae23b1b4f90198d2f009cc0a3dd95
+  data.tar.gz: 97642f94520ee1b5ff78516fd4c925fdfc2801e7
 SHA512:
-  metadata.gz: 922f34965feeb62c14e1753d5984e32038548172dc5d6e24ec0846ab2dbd6a8965215cac61b62ab92c640341d8c7bf443ed3bfd1b20affcc942015075ccd18cf
-  data.tar.gz: 972218116bf791697af08555903f390527d82a9bb98404f74ef40f0abfcf6fa96a0b68b3e8cce5ea39f36be216bc1a99fee41c221b077b7c97b8ab75cbd444ee
+  metadata.gz: fbe92410be5dd32f5c06a81a4364c3634dad1e4fee96cb77bb406a9a5fe60f007d917df9617bb15b4c2b09518e0b24ffab4515d84bd15cb59f9364b0557b015b
+  data.tar.gz: 49d100494d4b9922e325a9f2bf3789d89f18d0f931e3daa896f0b5e219e8f364e87d8c2b0174cb997a1fd25502220eb4319bad4e1a076a2803ccd42bcd7967c8

data/lib/shift_planning.rb

@@ -1,52 +1,53 @@
 require "shift_planning/version"
+require "shift_planning/api_error"
 require "shift_planning/client"
 
 module ShiftPlanning
   extend self
 
   def init(options={})
-    @@client = Client.new(options)
+    @@client = ShiftPlanning::Client.new(options)
   end
 
   def get(api_module, request={})
-    @@client.get(api_module, request)
+    @@client.request("GET", api_module, request)
   end
 
   def create(api_module, request={})
-    @@client.create(api_module, request)
+    @@client.request("CREATE", api_module, request)
   end
 
   def update(api_module, request={})
-    @@client.update(api_module, request)
+    @@client.request("UPDATE", api_module, request)
   end
 
   def delete(api_module, request={})
-    @@client.delete(api_module, request)
+    @@client.request("DELETE", api_module, request)
   end
 
-  # convience methods
+  # convenience methods
 
   def skills
-    @@client.get('staff.skills')
+    get('staff.skills')
   end
 
   def employees
-    @@client.get('staff.employees')
+    get('staff.employees')
   end
 
   def employee(employee_id)
-    @@client.get('staff.employee', "id" => employee_id)
+    get('staff.employee', "id" => employee_id)
   end
 
   def add_skill(employee_id, skill_id)
-    @@client.update('staff.employee', {
+    update('staff.employee', {
       "id" => employee_id,
       "addskill" => skill_id
     })
   end
 
   def remove_skill(employee_id, skill_id)
-    @@client.update('staff.employee', {
+    update('staff.employee', {
       "id" => employee_id,
       "removeskill" => skill_id
     })

data/lib/shift_planning/client.rb

@@ -1,17 +1,22 @@
 require "http"
 require "json"
 require "base64"
-require_relative "api_error"
 
 module ShiftPlanning
   class Client
+    attr_accessor :strict
+
     def initialize(config = {})
-      raise ArgumentError.new('Missing username') unless config.key? :username
+      raise ArgumentError.new('Missing username') unless config.key?(:username)
       @username = config[:username]
-      raise ArgumentError.new('Missing password') unless config.key? :password
+
+      raise ArgumentError.new('Missing password') unless config.key?(:password)
       @password = config[:password]
-      raise ArgumentError.new('Missing api key') unless config.key? :key
+
+      raise ArgumentError.new('Missing api key') unless config.key?(:key)
       @key = config[:key]
+
+      @strict = config.key?(:strict) ? config[:strict] : true
       @url = 'http://www.shiftplanning.com/api/'
       @headers = {
         "Content-Type" => "application/x-www-form-urlencoded"
@@ -36,24 +41,6 @@ module ShiftPlanning
       @token = JSON.parse(response)["token"]
     end
 
-    def get(api_module, request={})
-      request("GET", api_module, request)
-    end
-
-    def create(api_module, request={})
-      request("CREATE", api_module, request)
-    end
-
-    def update(api_module, request={})
-      request("UPDATE", api_module, request)
-    end
-
-    def delete(api_module, request={})
-      request("DELETE", api_module, request)
-    end
-
-    private
-
     def request(method, api_module, request)
       authenticate unless authenticated?
 
@@ -65,7 +52,7 @@ module ShiftPlanning
       })
       response = HTTP.with(@headers).post(@url, body)
       result = JSON.parse(response)
-      raise ApiError.new(result) if is_error_response? result
+      raise ApiError.new(result) if @strict && is_error_response?(result)
       result
     end
 

data/lib/shift_planning/version.rb

@@ -1,3 +1,3 @@
 module ShiftPlanning
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/test/unit/api_error_test.rb

@@ -1,37 +1,35 @@
 require 'test_helper'
 
 describe 'ApiError' do
-  describe '#constructor' do
-    def check(status, message)
-      error = ShiftPlanning::ApiError.new("status" => status)
-      assert_equal message, error.message
-    end
+  it "Maps status codes" do
+    assert_status_code(-3, "Flagged API Key - Pemanently Banned")
+    assert_status_code(-2, "Flagged API Key - Too Many invalid access attempts - contact us")
+    assert_status_code(-1, "Flagged API Key - Temporarily Disabled - contact us")
+    assert_status_code(1, "Success -")
+    assert_status_code(2, "Invalid API key - App must be granted a valid key by ShiftPlanning")
+    assert_status_code(3, "Invalid token key - Please re-authenticate")
+    assert_status_code(4, "Invalid Method - No Method with that name exists in our API")
+    assert_status_code(5, "Invalid Module - No Module with that name exists in our API")
+    assert_status_code(6, "Invalid Action - No Action with that name exists in our API")
+    assert_status_code(7, "Authentication Failed - You do not have permissions to access the service")
+    assert_status_code(8, "Missing parameters - Your request is missing a required parameter")
+    assert_status_code(9, "Invalid parameters - Your request has an invalid parameter type")
+    assert_status_code(10, "Extra parameters - Your request has an extra/unallowed parameter type")
+    assert_status_code(12, "Create Failed - Your CREATE request failed")
+    assert_status_code(13, "Update Failed - Your UPDATE request failed")
+    assert_status_code(14, "Delete Failed - Your DELETE request failed")
+    assert_status_code(15, "Get Failed - Your GET request failed")
+    assert_status_code(20, "Incorrect Permissions - You don't have the proper permissions to access this")
+    assert_status_code(90, "Suspended API key - Access for your account has been suspended, please contact ShiftPlanning")
+    assert_status_code(91, "Throttle exceeded - You have exceeded the max allowed requests. Try again later.")
+    assert_status_code(98, "Bad API Paramaters - Invalid POST request. See Manual.")
+    assert_status_code(99, "Service Offline - This service is temporarily offline. Try again later.")
+    assert_status_code(100, "Can not connect to LDAP - host or port are incorect")
+    assert_status_code(101, "Can not connect to LDAP - username or password are incorrect")
+  end
 
-    it "handles api status" do
-      check(-3, "Flagged API Key - Pemanently Banned")
-      check(-2, "Flagged API Key - Too Many invalid access attempts - contact us")
-      check(-1, "Flagged API Key - Temporarily Disabled - contact us")
-      check(1, "Success -")
-      check(2, "Invalid API key - App must be granted a valid key by ShiftPlanning")
-      check(3, "Invalid token key - Please re-authenticate")
-      check(4, "Invalid Method - No Method with that name exists in our API")
-      check(5, "Invalid Module - No Module with that name exists in our API")
-      check(6, "Invalid Action - No Action with that name exists in our API")
-      check(7, "Authentication Failed - You do not have permissions to access the service")
-      check(8, "Missing parameters - Your request is missing a required parameter")
-      check(9, "Invalid parameters - Your request has an invalid parameter type")
-      check(10, "Extra parameters - Your request has an extra/unallowed parameter type")
-      check(12, "Create Failed - Your CREATE request failed")
-      check(13, "Update Failed - Your UPDATE request failed")
-      check(14, "Delete Failed - Your DELETE request failed")
-      check(15, "Get Failed - Your GET request failed")
-      check(20, "Incorrect Permissions - You don't have the proper permissions to access this")
-      check(90, "Suspended API key - Access for your account has been suspended, please contact ShiftPlanning")
-      check(91, "Throttle exceeded - You have exceeded the max allowed requests. Try again later.")
-      check(98, "Bad API Paramaters - Invalid POST request. See Manual.")
-      check(99, "Service Offline - This service is temporarily offline. Try again later.")
-      check(100, "Can not connect to LDAP - host or port are incorect")
-      check(101, "Can not connect to LDAP - username or password are incorrect")
-    end
+  def assert_status_code(status, message)
+    error = ShiftPlanning::ApiError.new("status" => status)
+    assert_equal message, error.message
   end
 end

data/test/unit/client_test.rb

@@ -8,8 +8,8 @@ describe 'Client' do
       :key => 'e145a81787a46fc24802f1626befb20dcd76fd7b'
     })
     stub_request(:post, "http://www.shiftplanning.com/api/")
-      .with(:body => {"data"=>"{\"key\":\"e145a81787a46fc24802f1626befb20dcd76fd7b\",\"request\":{\"module\":\"staff.login\",\"method\":\"GET\",\"username\":\"devapi\",\"password\":\"password\"}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
-      .to_return(:status => 200, :body => "{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\"}", :headers => {})
+        .with(:body => {"data"=>"{\"key\":\"e145a81787a46fc24802f1626befb20dcd76fd7b\",\"request\":{\"module\":\"staff.login\",\"method\":\"GET\",\"username\":\"devapi\",\"password\":\"password\"}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
+        .to_return(:status => 200, :body => "{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\"}", :headers => {})
   end
 
   describe '#initialize' do
@@ -17,21 +17,21 @@ describe 'Client' do
       err = -> {
         ShiftPlanning::Client.new(:password => '', :key => '')
       }.must_raise ArgumentError
-      err.message.must_match /username/
+      err.message.must_match(/username/)
     end
 
     it 'password is a required field' do
       err = -> {
         ShiftPlanning::Client.new(:username => '', :key => '')
       }.must_raise ArgumentError
-      err.message.must_match /password/
+      err.message.must_match(/password/)
     end
 
     it 'key is a required field' do
       err = -> {
         ShiftPlanning::Client.new(:username => '', :password => '')
       }.must_raise ArgumentError
-      err.message.must_match /key/
+      err.message.must_match(/key/)
     end
   end
 
@@ -42,27 +42,31 @@ describe 'Client' do
     end
   end
 
-  describe '#get' do
-    it 'authenticates and makes api request' do
+  describe '#request' do
+    it 'authenticates and posts request body' do
       stub_request(:post, "http://www.shiftplanning.com/api/")
         .with(:body => {"data"=>"{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\",\"method\":\"GET\",\"module\":\"staff.employee\",\"request\":{\"id\":1}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
         .to_return(:status => 200, :body => "{\"status\":1, \"id\":\"1\"}", :headers => {})
-      employee = @client.get('staff.employee', "id" => 1)
+      employee = @client.request('GET', 'staff.employee', "id" => 1)
       assert 1, employee[:id]
     end
-  end
 
-  describe '#update' do
-    it 'authenticates and makes api request' do
+    it 'raises errors on failure code' do
       stub_request(:post, "http://www.shiftplanning.com/api/")
-        .with(:body => {"data"=>"{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\",\"method\":\"UPDATE\",\"module\":\"staff.employee\",\"request\":{\"id\":1,\"addskill\":2}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
-        .to_return(:status => 200, :body => "{\"status\":1, \"id\":\"1\"}", :headers => {})
+        .with(:body => {"data"=>"{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\",\"method\":\"GET\",\"module\":\"staff.employee\",\"request\":{\"id\":1}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
+        .to_return(:status => 200, :body => "{\"status\":8}", :headers => {})
+      err = -> {
+        @client.request('GET', 'staff.employee', "id" => 1)
+      }.must_raise ShiftPlanning::ApiError
+      err.message.must_match(/Missing parameters/)
+    end
 
-      employee = @client.update('staff.employee', {
-        "id" => 1,
-        "addskill" => 2
-      })
-      assert 1, employee[:id]
+    it 'ignores errors when strict is false' do
+      @client.strict = false
+      stub_request(:post, "http://www.shiftplanning.com/api/")
+        .with(:body => {"data"=>"{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\",\"method\":\"GET\",\"module\":\"staff.employee\",\"request\":{\"id\":1}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
+        .to_return(:status => 200, :body => "{\"status\":8}", :headers => {})
+      @client.request('GET', 'staff.employee', "id" => 1)
     end
   end
 end

data/test/unit/shift_planning_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+describe 'ShiftPlanning' do
+  before do
+    ShiftPlanning.init({
+      :strict => false,
+      :username => 'devapi',
+      :password => 'password',
+      :key => 'e145a81787a46fc24802f1626befb20dcd76fd7b'
+    })
+    stub_request(:post, "http://www.shiftplanning.com/api/")
+      .with(:body => {"data"=>"{\"key\":\"e145a81787a46fc24802f1626befb20dcd76fd7b\",\"request\":{\"module\":\"staff.login\",\"method\":\"GET\",\"username\":\"devapi\",\"password\":\"password\"}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
+      .to_return(:status => 200, :body => "{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\"}", :headers => {})
+  end
+
+  describe '#get' do
+    it 'authenticates and makes api request' do
+      stub_request(:post, "http://www.shiftplanning.com/api/")
+        .with(:body => {"data"=>"{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\",\"method\":\"GET\",\"module\":\"staff.employee\",\"request\":{\"id\":1}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
+        .to_return(:status => 200, :body => "{\"status\":1, \"id\":\"1\"}", :headers => {})
+      employee = ShiftPlanning.get('staff.employee', "id" => 1)
+      assert 1, employee[:id]
+    end
+  end
+
+  describe '#update' do
+    it 'authenticates and makes api request' do
+      stub_request(:post, "http://www.shiftplanning.com/api/")
+        .with(:body => {"data"=>"{\"token\":\"1714d482a0f3a5e3472fb51c481dc571fd6724e1\",\"method\":\"UPDATE\",\"module\":\"staff.employee\",\"request\":{\"id\":1,\"addskill\":2}}"}, :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'www.shiftplanning.com', 'User-Agent'=>'RubyHTTPGem/0.5.0'})
+        .to_return(:status => 200, :body => "{\"status\":1, \"id\":\"1\"}", :headers => {})
+
+      employee = ShiftPlanning.update('staff.employee', {
+        "id" => 1,
+        "addskill" => 2
+      })
+      assert 1, employee[:id]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shift_planning
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Tyler Mercier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -102,6 +102,7 @@ files:
 - test/test_helper.rb
 - test/unit/api_error_test.rb
 - test/unit/client_test.rb
+- test/unit/shift_planning_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -130,3 +131,4 @@ test_files:
 - test/test_helper.rb
 - test/unit/api_error_test.rb
 - test/unit/client_test.rb
+- test/unit/shift_planning_test.rb