shift_planning 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d4357767a2ca3b873c9638189f0d2442118d8ac
-  data.tar.gz: 28885e46a117d01722519761d6a378d8a189ffad
+  metadata.gz: 5d9d965889cdec208eaa3b63d9a0d106a2492aae
+  data.tar.gz: 082ba58213165e24381c22e319b9f8851d142c72
 SHA512:
-  metadata.gz: 28cd1989d5f629f75cfa743f571241a0d2143d03a9734104747057e31a14872807fa0e82e3dbdfcb0704e4d695c9f3f792ce73d18ebc429de32201ae780a2eee
-  data.tar.gz: b44504cd64b0094f2c04ca7b3e746ab7afefc4bd8227d9c3970a9dda9cfbb6a3abb4ab4632241c491dd963fef3d98e3da31d3100f5de829e80fc279864c6fd79
+  metadata.gz: 7b994e218f879a8d8546291baff43c6daf40054613e206aa586391653ccb61124506e13610566745881b438acc4c03f5db5e59d437bb36f66a92d8e073fa2c35
+  data.tar.gz: 7b7d62e28efe2f356fa95be08baa19a99ec4f45cf4c20bc0d9af36691d0e7b9afe98fb2fdbcc304b25b76ac89935a982678b8ee13ad865008b4344f6eacee099

data/lib/shift_planning/api_error.rb

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

data/lib/shift_planning/client.rb

@@ -1,6 +1,7 @@
-require 'http'
-require 'json'
-require 'base64'
+require "http"
+require "json"
+require "base64"
+require_relative "api_error"
 
 module ShiftPlanning
   class Client
@@ -63,7 +64,9 @@ module ShiftPlanning
         "request" => request
       })
       response = HTTP.with(@headers).post(@url, body)
-      JSON.parse(response)
+      result = JSON.parse(response)
+      raise ApiError.new(result) if result["status"] != "1"
+      result
     end
 
     def body_formatter(body)

data/lib/shift_planning/version.rb

@@ -1,3 +1,3 @@
 module ShiftPlanning
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/test/unit/api_error_test.rb

@@ -0,0 +1,37 @@
+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 "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
+  end
+end

data/test/unit/client_test.rb

@@ -46,7 +46,7 @@ describe 'Client' 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 => "{\"id\":\"1\"}", :headers => {})
+        .to_return(:status => 200, :body => "{\"status\":\"1\", \"id\":\"1\"}", :headers => {})
       employee = @client.get('staff.employee', "id" => 1)
       assert 1, employee[:id]
     end
@@ -56,7 +56,7 @@ describe 'Client' 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 => "{\"id\":\"1\"}", :headers => {})
+        .to_return(:status => 200, :body => "{\"status\":\"1\", \"id\":\"1\"}", :headers => {})
 
       employee = @client.update('staff.employee', {
         "id" => 1,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shift_planning
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Tyler Mercier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -95,10 +95,12 @@ files:
 - README.md
 - Rakefile
 - lib/shift_planning.rb
+- lib/shift_planning/api_error.rb
 - lib/shift_planning/client.rb
 - lib/shift_planning/version.rb
 - shift_planning.gemspec
 - test/test_helper.rb
+- test/unit/api_error_test.rb
 - test/unit/client_test.rb
 homepage: ''
 licenses:
@@ -126,4 +128,5 @@ specification_version: 4
 summary: Shift Planning API gem
 test_files:
 - test/test_helper.rb
+- test/unit/api_error_test.rb
 - test/unit/client_test.rb