shiftplanning 0.0.1

data/lib/example.rb

@@ -0,0 +1,21 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'shiftplanning'
+API_KEY = '9eea91f6fcaa9573b3949f4eb3b58b3d4624b2d0'#"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+
+interface = SP::Interface.new(API_KEY, :verbose => true, :outfile => '/home/krichardson/Desktop/output')
+request   = SP::Request.new
+
+request.staff.login.params = {:username => 'krichardson@customerdirect.com', :password => 'T0p@z098765'}#{:username => 'hmoon@nabootique.com', :password => 'J@zZ'}
+
+interface.submit(request.staff.login)
+puts interface.token
+puts request.staff.login.supported_methods.inspect
+puts request.staff.login.required_params('get').inspect
+
+interface.submit(request.api.config, request.api.methods)
+puts interface.requests.inspect; puts
+puts interface.responses.inspect; puts
+puts interface.last_response.inspect; puts
+

data/lib/shiftplanning.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+=begin
+  
+  Copyright (C) 2013 Kyle Richardson
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+  
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+   
+=end
+
+require 'rubygems'
+require 'json'
+require 'shiftplanning/interface'
+require 'shiftplanning/http_error'
+
+class ShiftPlanning; VERSION = '0.0.1' end
+# Aliasing ShiftPlanning as SP 
+class SP < ShiftPlanning; end

data/lib/shiftplanning/config.rb

@@ -0,0 +1,59 @@
+=begin
+  
+  Copyright (C) 2013 Kyle Richardson
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+  
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+   
+=end
+
+require 'uri'
+require 'net/http'
+
+class ShiftPlanning
+  class Config
+    # Setup class variables 
+    @@uri = URI.parse("http://www.shiftplanning.com/api/")
+    @@http = Net::HTTP.new(@@uri.host, @@uri.port)
+    @@api_path = @@uri.path
+    @@return_types = %w(json xml html)
+    
+    # Define getters and setters
+    attr_accessor :api_key, :token
+    attr_reader :output
+    
+    # Constructor
+    #**********************************
+    def initialize _api_key, options = {}
+      self.api_key = _api_key
+      self.output=(options[:output]||'json')
+      self.token=(options[:token])
+      @session = options[:session]
+      self.token = @session[:sp_token] unless @session.nil?
+      @@http.set_debug_output(options[:outfile]||$stdout) if options[:verbose]
+    end
+    
+    # Setter for output type 
+    #**********************************
+    def output= _output
+      _output = _output.to_s
+        
+      if @@return_types.include?(_output)
+        @output = _output
+      else
+        raise "#{_output} is not a valid output type"
+      end
+    end
+  end
+end

data/lib/shiftplanning/http_error.rb

@@ -0,0 +1,28 @@
+=begin
+  
+  Copyright (C) 2013 Kyle Richardson
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+  
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+   
+=end
+
+class ShiftPlanning
+  class HTTPError < Exception
+    def initialize code
+      super
+      message = code.to_s
+    end
+  end
+end

data/lib/shiftplanning/interface.rb

@@ -0,0 +1,108 @@
+=begin
+  
+  Copyright (C) 2013 Kyle Richardson
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+  
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+   
+=end
+
+require 'shiftplanning/config'
+require 'shiftplanning/request'
+
+class ShiftPlanning
+  class Interface < ShiftPlanning::Config
+    attr_reader(:last_request, :last_response, :requests, :responses, :last_response_raw)
+    
+    #**********************************
+    def initialize api_key, options = {}
+      super(api_key, options)
+      @request = Net::HTTP::Post.new(@@api_path)
+      @last_response = nil
+      @last_request = nil
+    end
+    
+    #**********************************
+    def submit *args
+      @requests = []; @responses = []
+      msgs = []
+      
+      args.each{ |_request|
+        _request.params[:module] = _request.module
+        _request.params[:method] = _request.method
+        req = {:key => api_key, :output => output, :request => _request.params}
+        req[:token] = token unless token.nil?
+        @requests << req
+        req = JSON::generate(req)
+        self.last_request = req#_request.to_json
+        
+        request.set_form_data({"data" => req})
+        response = @@http.request(request)
+        @last_response_raw = response
+        
+        if http_error?(response)
+          raise HTTPError, response.code
+        else
+          (output == 'json' ? 
+            (self.last_response = JSON.parse(response.body); @responses << JSON.parse(response.body)) : 
+            (self.last_response = response.body; @responses << response.body)
+          )
+          
+          @session[:sp_token] = last_response['token'] if(output == 'json' && @session != nil)  
+          self.token = last_response['token'] if output == 'json'
+          self.token = @session[:sp_token] unless @session.nil?
+          msgs << response_msg(last_response['status']) if output == 'json'
+        end
+      }
+      
+      msgs
+    end
+    
+    private
+    def last_response=(response); @last_response = response end
+    def last_request=(request); @last_request = request end
+    def request; @request end
+    def request=(request); @request = request end
+    def http_error?(response); (response.code.to_i != 200) end
+    
+    #**********************************
+    def response_msg code  
+      case code.to_i
+      when -3 : 'Flagged API Key - Pemanently Banned'
+      when -2 : 'Flagged API Key - Too Many invalid access attempts - contact us'
+      when -1 : 'Flagged API Key - Temporarily Disabled - contact us'
+      when 1 : 'Success -'
+      when 2 : 'Invalid API key - App must be granted a valid key by ShiftPlanning'
+      when 3 : 'Invalid token key - Please re-authenticate'
+      when 4 : 'Invalid Method - No Method with that name exists in our API'
+      when 5 : 'Invalid Module - No Module with that name exists in our API'
+      when 6 : 'Invalid Action - No Action with that name exists in our API'
+      when 7 : 'Authentication Failed - You do not have permissions to access the service'
+      when 8 : 'Missing parameters - Your request is missing a required parameter'
+      when 9 : 'Invalid parameters - Your request has an invalid parameter type'
+      when 10 : 'Extra parameters - Your request has an extra/unallowed parameter type'
+      when 12 : 'Create Failed - Your CREATE request failed'
+      when 13 : 'Update Failed - Your UPDATE request failed'
+      when 14 : 'Delete Failed - Your DELETE request failed'
+      when 20 : 'Incorrect Permissions - You don\'t have the proper permissions to access this'
+      when 90 : 'Suspended API key - Access for your account has been suspended, please contact ShiftPlanning'
+      when 91 : 'Throttle exceeded - You have exceeded the max allowed requests. Try again later.'
+      when 98 : 'Bad API Paramaters - Invalid POST request. See Manual.'
+      when 99 : 'Service Offline - This service is temporarily offline. Try again later.'
+      else
+        'Error code not found'
+      end
+    end
+  end
+end

data/lib/shiftplanning/request.rb

@@ -0,0 +1,239 @@
+=begin
+  
+  Copyright (C) 2013 Kyle Richardson
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+  
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+   
+=end
+
+require 'shiftplanning/request/sp_module'
+
+class ShiftPlanning
+  class Request < ShiftPlanning::Config
+    # Setup getters and setters 
+    attr_reader(
+      :api, :admin, :messaging, :reports, :payroll, :schedule, :timeclock, 
+      :staff, :availability, :location, :training, :group, :sales, :dashboard, :terminal
+    )
+    
+    # Constructor 
+    #**********************************
+    def initialize
+      @api = _api.new(SPModule.new('api.methods', 'GET'), SPModule.new('api.config', 'GET'))
+      @admin = _admin.new(
+        SPModule.new('admin.settings', 'GET', {}, %w(GET UPDATE), {:GET => ['token'], :UPDATE => ['token']}), 
+        SPModule.new('admin.details', 'GET', {}, %w(GET UPDATE), {:GET => ['token'], :UPDATE => ['token']}), 
+        SPModule.new('admin.files', 'GET', {}, %w(GET), {:GET => 'token'}), 
+        SPModule.new('admin.file', 'GET', {}, %w(GET UPDATE DELETE CREATE), {
+          :GET => %w(token id), :UPDATE => %w(token id), :DELETE => %w(token id), 
+          :CREATE => %W(token filename filedata filelength mimetype)
+        }), 
+        SPModule.new('admin.backups', 'GET', {}, %w(GET), {:GET => ['token']}),
+        SPModule.new('admin.backup', 'GET', {}, %w(GET DELETE CREATE), {:GET => %w(token id), :CREATE => %w(token filename filedata filelength mimetype), :DELETE => %w(token id)}), 
+        SPModule.new('admin.nrequests', 'GET', {}, %w(GET), {:GET => %w(token)}), 
+        SPModule.new('admin.business', 'GET', {}, %w(GET), {:GET => %w(token)}), 
+        SPModule.new('admin.group_perms', 'GET', {}, %w(GET UPDATE), {:GET => %w(token), :UPDATE => %w(token)})
+      )
+      @messaging = _messaging.new(
+        SPModule.new('messaging.messages', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('messaging.message', 'GET', {}, %w(GET CREATE DELETE UPDATE), {
+          :GET => %w(token id), :CREATE => %w(token subject message to), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('messaging.shift', 'CREATE', {}, %w(CREATE), {:CREATE => %w(token subject message id)}),
+        SPModule.new('messaging.wall', 'GET', {}, %w(GET CREATE DELETE), {:GET => %w(token), :CREATE => %w(token post), :DELETE => %w(token id delete)}),
+        SPModule.new('messaging.notice', 'GET', {}, %w(GET UPDATE CREATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('messaging.notices', 'GET', {}, %w(GET), {:GET => %w(token)})
+      )
+      @reports = _reports.new(
+        SPModule.new('reports.schedule', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date type)}),
+        SPModule.new('reports.budget', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date)}),
+        SPModule.new('reports.timesheets', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date type)}),
+        SPModule.new('reports.employee', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date type)}),
+        SPModule.new('reports.custom', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date type fields)}),
+        SPModule.new('reports.daily_peak_hours_new', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date)}),
+        SPModule.new('reports.daily_peak_hours', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date)})
+      )
+      @payroll = _payroll.new(
+        SPModule.new('payroll.report', 'GET', {}, %w(GET), {:GET => %w(token type)}),
+        SPModule.new('payroll.ratecards', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('payroll.ratecard', 'GET', {}, %w(GET CREATE DELETE UPDATE), {:GET => %w(token id), :CREATE => %w(token name), :UPDATE => %w(token id), :DELETE => %w(token id)})
+      )
+      @schedule = _schedule.new(
+        SPModule.new('schedule.schedules', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.schedule', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token name), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('schedule.shifts', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.shift', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token start_time end_time start_date end_date), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('schedule.shiftapprove', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token id), :UPDATE => %w(token), :DELETE => %w(token id)
+        }),
+        SPModule.new('schedule.trade', 'GET', {}, %w(GET CREATE UDPATE), {:GET => %w(token id), :CREATE => %w(token shift tradewith reason), :UPDATE => %w(token trade action)}),
+        SPModule.new('schedule.trades', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.tradelist', 'GET', {}, %w(GET), {:GET => %w(token id)}),
+        SPModule.new('schedule.tradeswap', 'CREATE', {}, %w(CREATE UPDATE), {:CREATE => %w(token shift swap reason), :UPDATE => %w(token trade action)}),
+        SPModule.new('schedule.vacations', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.vacation', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token start_date end_date), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('schedule.conflicts', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.copy', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.clear', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.restore', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('schedule.wizard', 'GET', {}, %w(GET), {:GET => %w(token from_start from_end to_start to_end)}),
+        SPModule.new('schedule.adjust', 'UPDATE', {}, %w(UPDATE), {:UPDATE => %w(token from to budge)}),
+        SPModule.new('schedule.fill', 'GET', {}, %w(GET), {:GET => %w(token shifts)}),
+        SPModule.new('schedule.publish', 'GET', {}, %w(GET), {:GET => %w(token shifts)}),
+        SPModule.new('schedule.requests', 'UPDATE', {}, %w(UPDATE), {:UPDATE => %w(token id type mode)}),
+        SPModule.new('schedule.breakrule', 'GET', {}, %w(GET CREATE DELETE), {:GET => %w(token id), :CREATE => %w(token id break paid), :DELETE => %w(token id)}),
+        SPModule.new('schedule.shiftrequests', 'CREATE', {}, %w(CREATE), {:CREATE => %w(token shift)})
+      )
+      @timeclock = _timeclock.new(
+        SPModule.new('timeclock.timeclocks', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('timeclock.timeclock', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token start_date schedule employee start_time), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('timeclock.clockin', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('timeclock.preclockin', 'GET', {}, %w(GET CREATE), {:GET => %w(token), :CREATE => %w(token)}),
+        SPModule.new('timeclock.preclockins', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('timeclock.clockout', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('timeclock.status', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('timeclock.manage', 'GET', {}, %w(GET), {:GET => %w(token id action)}),
+        SPModule.new('timeclock.screenshot', 'GET', {}, %w(GET), {:GET => %w(token filedata)}),
+        SPModule.new('timeclock.event', 'CREATE', {}, %w(CREATE UPDATE DELETE), {
+          :CREATE => %w(token timeclock type), :UPDATE => %w(token timeclock type), :DELETE => %w(token timeclock type event)
+        }),
+        SPModule.new('timeclock.timesheets', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('timeclock.addclocktime', 'GET', {}, %w(GET), {:GET => %w(token employee datein dateout)}),
+        SPModule.new('timeclock.savenote', 'GET', {}, %w(GET), {:GET => %w(token id)}),
+        SPModule.new('timeclock.forceclockout', 'GET', {}, %w(GET), {:GET => %w(token id)}),
+        SPModule.new('timeclock.location', 'CREATE', {}, %w(CREATE DELETE), {:CREATE => %w(token name), :DELETE => %w(token id)}),
+        SPModule.new('timeclock.terminal', 'CREATE', {}, %w(DELETE CREATE UPDATE), {:CREATE => %w(token name location), :UPDATE => %w(token id), :DELETE => %w(token id)})
+      )
+      @staff = _staff.new(
+        SPModule.new('staff.login', 'GET', {}, %w(GET), {:GET => %w(username password)}),
+        SPModule.new('staff.logout', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('staff.employees', 'GET', {}, %w(GET CREATE), {:GET => %w(token), :CREATE => %w(token)}),
+        SPModule.new('staff.employee', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token), :CREATE => %w(token), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('staff.skills', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('staff.skill', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token name), :UPDATE => %w(token id name), :DELETE => %w(token id)
+        }),
+        SPModule.new('staff.customfields', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('staff.customfield', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token name type), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('staff.ping', 'GET', {}, %w(CREATE), {:CREATE => %w(token to message)})
+      )
+      @availability = _availability.new(
+        SPModule.new('availability.available', 'GET', {}, %w(GET), {:GET => %w(token start_date)}),
+        SPModule.new('availability.weekly', 'GET', {}, %w(GET UPDATE DELETE), {:GET => %w(token), :UPDATE => %w(token flag), :DELETE => %w(token start_time end_time)}),
+        SPModule.new('availability.future', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token), :CREATE => %w(token start_date), :UPDATE => %w(token id flag), :DELETE => %w(token id)
+        }),
+        SPModule.new('availability.approve', 'GET', {}, %w(GET UPDATE CREATE), {:GET => %w(token type), :CREATE => %w(token), :UPDATE => %w(token user type action)})
+      ) 
+      @location = _location.new(
+        SPModule.new('location.locations', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('location.location', 'GET', {}, %w(GET CREATE UPDATE DELETE), {
+          :GET => %w(token id), :CREATE => %w(token name type), :UPDATE => %w(token id), :DELETE => %w(token id)
+        })
+      )
+      @training = _training.new(
+        SPModule.new('training.progress', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('training.sections', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('training.section', 'GET', {}, %w(GET UPDATE DELETE CREATE), {
+          :GET => %w(token id), :CREATE => %w(token title), :UPDATE => %w(token id title), :DELETE => %w(token id)
+        }),
+        SPModule.new('training.modules', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('training.module', 'GET', {}, %w(GET UPDATE DELETE CREATE), {
+          :GET => %w(token id), :CREATE => %w(token title), :UPDATE => %w(token id), :DELETE => %w(token id)
+        }),
+        SPModule.new('training.complete', 'UPDATE', {}, %w(UPDATE), {:UPDATE => %w(token id)}),
+        SPModule.new('training.reorder', 'UPDATE', {}, %w(UPDATE), {:UPDATE => %w(token mode)}),
+        SPModule.new('training.digital_signature', 'GET', {}, %w(GET), {:GET => %w(token module_id)}),
+        SPModule.new('training.comments', 'GET', {}, %w(GET UPDATE), {:GET => %w(token module_id type), :UPDATE => %w(token module_id type)}),
+        SPModule.new('training.sync', 'UPDATE', {}, %w(UPDATE), {:UPDATE => %w(token id)}),
+        SPModule.new('training.quiz', 'UPDATE', {}, %w(UPDATE), {:UPDATE => %w(token answer)}),
+        SPModule.new('training.multiassign', 'UPDATE', {}, %w(UPDATE), {:UPDATE => %w(token assignments modules mode)}),
+        SPModule.new('training.tutorial', 'GET', {}, %w(GET), {:GET => %w(token tutorial_id)})
+      )
+      @group = _group.new(
+        SPModule.new('group.accounts', 'GET', {}, %w(GET CREATE), {:GET => %w(token), :CREATE => %w(token accounts)}),
+        SPModule.new('group.account', 'GET', {}, %w(GET UPDATE DELETE CREATE), {:GET => %w(token id), :CREATE => %w(token), :UPDATE => %w(token id), :DELETE => %w(token id)}),
+        SPModule.new('group.accountsplit', 'CREATE', {}, %w(CREATE), {:CREATE => %w(token location main_user_id)}),
+        SPModule.new('group.reports', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date type)})
+      )
+      @sales = _sales.new(
+        SPModule.new('sales.budgets', 'GET', {}, %w(GET), {:GET => %w(token start_date end_date)}),
+        SPModule.new('sales.budget', 'GET', {}, %w(GET UPDATE CREATE DELETE), {
+          :GET => %w(token start_date end_date), :CREATE => %w(token start_date end_date), :UPDATE => %w(token start_date end_date), :DELETE => %w(token start_date end_date)
+        })
+      )
+      @dashboard = _dashboard.new(
+        SPModule.new('dashboard.onnow', 'GET', {}, %w(GET), {:GET => %w(token)}),
+        SPModule.new('dashboard.notifications', 'GET', {}, %w(GET), {:GET => %w(token)})
+      )
+      @terminal = _terminal.new(
+        SPModule.new('terminal.login', 'GET', {}, %w(GET), {:GET => %w(token terminal_key)}),
+        SPModule.new('terminal.clockin', 'GET', {}, %w(GET), {:GET => %w(token terminal_key)}),
+        SPModule.new('terminal.clockout', 'GET', {}, %w(GET), {:GET => %w(token terminal_key)})
+      )
+    end
+    
+    private # <<PRIVATE 
+      def _api; Struct.new(:methods, :config) end
+      def _admin; Struct.new(:settings, :details, :files, :file, :backups, :backup, :nrequests, :business, :group_perms) end
+      def _messaging; Struct.new(:messages, :message, :shift, :wall, :notice, :notices) end
+      def _reports; Struct.new(:schedule, :budget, :timesheets, :employee, :custom, :daily_peak_hours_new, :daily_peak_hours) end
+      def _payroll; Struct.new(:report, :ratecards, :ratecard) end
+      def _staff; Struct.new(:login, :logout, :employees, :employee, :skills, :skill, :customfields, :customfield, :ping) end
+      def _availability; Struct.new(:available, :weekly, :future, :approve) end
+      def _location; Struct.new(:locations, :location) end
+      def _group; Struct.new(:accounts, :account, :accountsplit, :reports) end
+      def _sales; Struct.new(:budgets, :budget) end
+      def _dashboard; Struct.new(:onnow, :notifications) end
+      def _terminal; Struct.new(:login, :clockin, :clockout) end
+      
+      def _schedule 
+        Struct.new(
+          :schedules, :schedule, :shifts, :shift, :shiftapprove, :trade, :trades, 
+          :tradelist, :tradeswap, :vacations, :vacation, :confilcts, :copy, :clear, :restore, :wizard,
+          :adjust, :fill, :publish, :requests, :breakrule, :shiftrequests
+        )
+      end
+      
+      def _timeclock
+        Struct.new(
+          :timeclocks, :timeclock, :clockin, :preclockin, :preclockins, :clockout, :status, :manage, 
+          :screenshot, :event, :timesheets, :addclocktime, :savenote, :forceclockout, :location, :terminal
+        )
+      end
+      
+      def _training
+        Struct.new(
+          :progress, :sections, :section, :modules, :module, :complete, :reorder, :digital_signature, 
+          :comments, :sync, :quiz, :multiassign, :tutorial
+        )
+      end
+    # PRIVATE 
+  end
+end

data/lib/shiftplanning/request/sp_module.rb

@@ -0,0 +1,52 @@
+=begin
+  
+  Copyright (C) 2013 Kyle Richardson
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+  
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+   
+=end
+
+class SPModule
+  # Setup getters and setters 
+  attr_reader :supported_methods, :module
+  attr_accessor :params, :method
+  
+  # Constructor 
+  #**********************************
+  def initialize _module = '', _method = '', _params = {}, supported_methods = %w(GET), required_params = {:GET => []}
+    @supported_methods = supported_methods
+    @required_params = required_params
+    @params = _params
+    @module = _module
+    @method = _method 
+  end
+  
+  #**********************************
+  def required_params method
+    case method.class.to_s
+    when 'Symbol' : method = method.to_s.upcase.to_sym
+    when 'String' : method = method.upcase.to_sym
+    else
+      raise %q('method' should be a String or a Symbol)
+    end
+    
+    case method
+    when :GET : @required_params[:GET]||'Unsupported method'
+    when :CREATE : @required_params[:CREATE]||'Unsupported method' 
+    when :UPDATE : @required_params[:UPDATE]||'Unsupported method'
+    when :DELETE : @required_params[:DELETE]||'Unsupported method'
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: shiftplanning
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- FractalPenguin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-29 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "    Copyright (C) 2013  Kyle Richardson\n\n    This program is free software; you can redistribute it and/or\n    modify it under the terms of the GNU General Public License\n    as published by the Free Software Foundation; either version 2\n    of the License, or (at your option) any later version.\n    \n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU General Public License for more details.\n    \n    You should have received a copy of the GNU General Public License\n    along with this program; if not, write to the Free Software\n    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.\n"
+email: kylerchrdsn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/example.rb
+- lib/shiftplanning.rb
+- lib/shiftplanning/request/sp_module.rb
+- lib/shiftplanning/interface.rb
+- lib/shiftplanning/http_error.rb
+- lib/shiftplanning/request.rb
+- lib/shiftplanning/config.rb
+has_rdoc: true
+homepage: https://github.com/Kylerchrdsn/ShiftPlanning-ruby
+licenses: 
+- GPL-2
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Aids in interacting with ShiftPlanning API.  Their site has SDKs for Javascript, PHP, C#, ASP.NET, and Python, but not Ruby @.@
+test_files: []
+