shift_planning_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a00b22e1642429521f5103c7eaf0e20ae3993cfe
+  data.tar.gz: 78bb7a25952d05fe37219418abbc968b086249ea
+SHA512:
+  metadata.gz: 53996b6f0d27c1d7b508bb1146ef2306ef0f28239192059dcfdb58d6ef7395ddd3d2ad7196e74df740ff8932b414f54077c456a59b91e7353da54689bedb0787
+  data.tar.gz: 4e3d55892480d541e614a640b0592217fa00b2adaf9536118426c7d160e1cde5f584fbd6df932d76a75a74caedfbf3668b86899e29c2775cfe83d94e9a0cd20b

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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Askar Zinurov
+
+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,50 @@
+# ShiftPlanning
+
+Ruby client gem for http://www.shiftplanning.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shift_planning'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shift_planning
+
+## Usage
+
+Call client.<api_namespace>.<method>_<endpoint>(required_arg_1, required_arg_2 [, optional_params_hash])
+
+```ruby
+  client = ShiftPlanning::Client.new(your_api_key)
+  client.staff.get_login(username, password, { remember: 1 })
+  client.api.get_methods
+
+  ...
+
+  client.staff.get_logout
+```
+
+Rescue from api errors with:
+
+```ruby
+  begin
+    ...
+  rescue ShiftPlanning::ApiError => e
+    ...
+  end
+```
+For more info follow http://www.shiftplanning.com/api/
+
+## Contributing
+
+1. Fork it ( http://github.com/AskarZinurov/shift_planning/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 @@
+require "bundler/gem_tasks"

data/lib/shift_planning/api_error.rb

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

data/lib/shift_planning/api_module.rb

@@ -0,0 +1,24 @@
+class ShiftPlanning::ApiModule
+  attr_reader :name
+
+  def initialize(connection, name)
+    @name = name
+    @connection = connection
+  end
+
+  class << self
+    %w[get create update delete].each do |method|
+      define_method(method) do |endpoint, params = []|
+        define_method("#{ method }_#{ endpoint }") do |*args|
+          if params.length > args.length
+            raise ArgumentError.new("Wrong number of arguments (#{ args.length } for #{ params.length })")
+          end
+          params_hash = {}
+          params.each_with_index { |p, i| params_hash[p] = args[i] }
+          params_hash = args[params.length].merge(params_hash) if args[params.length]
+          @connection.call(method.upcase, "#{ name }.#{ endpoint }", params_hash)
+        end
+      end
+    end
+  end
+end

data/lib/shift_planning/client.rb

@@ -0,0 +1,207 @@
+require 'shift_planning/api_error'
+require 'shift_planning/connection'
+require 'shift_planning/api_module'
+
+class ShiftPlanning::Client
+  attr_reader :connection
+
+  def initialize(key)
+    @connection = ShiftPlanning::Connection.new(key)
+    draw_routes
+  end
+
+  private
+
+  def draw_routes
+    # API map
+    api_module :staff do |m|
+      m.get :login, [:username, :password]
+      m.get :logout
+
+      m.get :employees
+      m.create :employees
+
+      m.get :employee, [:id]
+      m.create :employee
+      m.update :employee, [:id]
+      m.delete :employee, [:id]
+
+      m.get :skills
+      m.get :skill, [:id]
+      m.create :skill, [:name]
+      m.update :skill, [:id, :name]
+      m.delete :skill, [:id]
+
+      m.get :customfields
+      m.get :customfield, [:id]
+      m.create :customfield, [:name, :type]
+      m.update :customfield, [:id]
+      m.delete :customfield, [:id]
+
+      m.create :ping, [:to, :message]
+
+      m.update :formatcheck, [:type]
+
+      m.get :leavetypes
+      m.update :leavetypes, [:id]
+    end
+
+    api_module :terminal do |m|
+      m.get :login, [:terminal_key]
+      m.get :clockin, [:terminal_key]
+      m.get :clockout, [:terminal_key]
+    end
+
+    api_module :location do |m|
+      m.get :locations
+
+      m.get :location, [:id]
+      m.create :location, [:name, :type]
+      m.update :location, [:id]
+      m.delete :location, [:id]
+    end
+
+    api_module :api do |m|
+      m.get :methods
+      m.get :config
+    end
+
+    api_module :timeclock do |m|
+      m.get :timeclocks
+
+      m.get :timeclock, [:id]
+      m.create :timeclock, [:start_date, :schedule, :employee, :start_time]
+      m.update :timeclock, [:id]
+      m.delete :timeclock, [:id]
+
+      m.get :clockin
+
+      m.get :preclockin
+      m.create :preclockin
+
+      m.get :preclockins
+
+      m.get :clockout
+
+      m.get :status
+
+      m.get :manage, [:id, :action]
+
+      m.get :screenshots
+
+      m.create :screenshot, [:filedata]
+
+      m.create :event, [:timeclock, :type]
+      m.update :event, [:timeclock, :type]
+      m.delete :event, [:timeclock, :type, :event]
+
+      m.get :timesheets
+
+      m.get :addclocktime, [:employee, :datein]
+
+      m.get :savenote, [:id]
+
+      m.get :forceclockout, [:id]
+
+      m.create :location, [:name]
+      m.delete :location, [:id]
+
+      m.create :terminal, [:name, :location]
+      m.update :terminal, [:id]
+      m.delete :terminal, [:id]
+    end
+
+    api_module :schedule do |m|
+      m.get :schedules
+
+      m.get :schedule, [:id]
+      m.create :schedule, [:name]
+      m.update :schedule, [:id]
+      m.delete :schedule, [:id]
+
+      m.get :shifts
+
+      m.get :shift, [:id]
+      m.create :shift, [:start_time, :end_time, :start_date, :end_date]
+      m.update :shift, [:id]
+      m.delete :shift, [:id]
+
+      m.get :shiftapprove, [:id]
+      m.create :shiftapprove, [:id]
+      m.update :shiftapprove #?
+      m.delete :shiftapprove, [:id]
+
+      m.get :trades
+
+      m.get :trade, [:id]
+      m.create :trade, [:shift, :tradewith, :reason]
+      m.update :trade, [:trade, :action]
+
+      m.get :tradelist, [:id]
+
+      m.create :tradeswap, [:shift, :swap, :reason]
+      m.update :tradeswap, [:trade, :action]
+
+      m.get :vacations
+
+      m.get :vacation, [:id]
+      m.create :vacation, [:start_date, :end_date]
+      m.update :vacation, [:id]
+      m.delete :vacation, [:id]
+
+      m.get :collisions, [:start_date, :end_date]
+
+      m.get :conflicts
+
+      m.get :copy, [:from_start, :from_end, :to_start, :to_end]
+
+      m.get :clear
+
+      m.get :restore
+
+      m.get :wizard, [:from_start, :from_end, :to_start, :to_end]
+
+      m.update :adjust, [:from, :to, :budge]
+
+      m.get :fill, [:shifts]
+
+      m.get :publish, [:shifts]
+
+      m.update :requests, [:id, :type, :mode]
+
+      m.create :ical, [:url, :name]
+      m.update :ical, [:ical_id]
+      m.get :ical # [:id] ?
+      m.delete :ical # [:ical_id] ?
+
+      m.create :ical_events, [:ical_id]
+      m.update :ical_events #?
+      m.get :ical_events
+      m.delete :ical_events # [:ical_event_id] ?
+
+      m.get :breakrule, [:id]
+      m.create :breakrule, [:id, :break, :paid]
+      m.delete :breakrule, [:id]
+
+      m.create :shiftrequests, [:shift]
+
+      m.get :notes, [:start_date]
+
+      m.get :note, [:id]
+      m.create :note, [:date, :note]
+      m.update :note, [:id]
+      m.delete :note, [:id]
+
+      m.get :count_notes, [:start_date, :end_date]
+
+      m.get :publish_note, [:id]
+    end
+  end
+
+  def api_module(name, &block)
+    mod = Class.new(ShiftPlanning::ApiModule)
+    block.call(mod)
+    self.class.class_eval { attr_reader name }
+    instance_variable_set "@#{ name }", mod.new(connection, name)
+  end
+end

data/lib/shift_planning/connection.rb

@@ -0,0 +1,45 @@
+class ShiftPlanning::Connection
+  attr_reader :http
+
+  def initialize(key)
+    @key = key
+    @token = nil
+    @http = Faraday.new(url: "http://www.shiftplanning.com") do |conn|
+      conn.request :url_encoded
+
+      conn.response :json
+      conn.response :logger
+
+      conn.adapter Faraday.default_adapter
+    end
+  end
+
+  def call(method, command, params = {})
+    request_params = {
+      request: params.merge(
+        method: method,
+        module: command
+      ),
+      output: 'json'
+    }
+
+    response = http.post('/api/', data: JSON::generate(signed_params(request_params))).body
+    ShiftPlanning::ApiError.parse(response['status'])
+
+    parse_data response do |data|
+      @token = data['token'] if data.has_key?('token')
+    end
+  end
+
+  private
+
+  def parse_data(response_data, &block)
+    data = response_data
+    block.call(data) if block_given?
+    data['data']
+  end
+
+  def signed_params(params)
+    params.merge(key: @key, token: @token)
+  end
+end

data/lib/shift_planning/version.rb

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

data/lib/shift_planning.rb

@@ -0,0 +1,4 @@
+require "faraday"
+require "faraday_middleware"
+require "shift_planning/version"
+require "shift_planning/client"

data/shift_planning.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shift_planning/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shift_planning_client"
+  spec.version       = ShiftPlanning::VERSION
+  spec.authors       = ["Askar Zinurov"]
+  spec.email         = ["mail@asktim.ru"]
+  spec.summary       = %q{Client library to www.shiftplanning.com}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/AskarZinurov/shift_planning"
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.1.7"
+
+  spec.add_runtime_dependency 'faraday', "~> 0.9"
+  spec.add_runtime_dependency 'faraday_middleware', "~> 0.9.1"
+end

data/spec/client_spec.rb

@@ -0,0 +1,29 @@
+require "shift_planning"
+
+describe ShiftPlanning::Client do
+  context 'staff' do
+    subject(:client) { described_class.new(ENV['SHIFT_PLANNING_KEY']) }
+
+    it 'should raise argument error' do
+      expect{ client.staff.get_login('azaza') }.to raise_error(ArgumentError)
+    end
+
+    it 'should raise ApiError' do
+      expect{ client.staff.get_login('azaza', 'lalka') }.to raise_error(ShiftPlanning::ApiError)
+    end
+
+    context 'logged in' do
+      before do
+        client.staff.get_login(ENV['SHIFT_PLANNING_STAFF_USERNAME'], ENV['SHIFT_PLANNING_STAFF_PASSWORD'])
+      end
+
+      it 'should return skills' do
+        client.staff.get_skills.should == ''
+      end
+
+      it 'can logout' do
+        client.staff.get_logout.should == ''
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: shift_planning_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Askar Zinurov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !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: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: ''
+email:
+- mail@asktim.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shift_planning.rb
+- lib/shift_planning/api_error.rb
+- lib/shift_planning/api_module.rb
+- lib/shift_planning/client.rb
+- lib/shift_planning/connection.rb
+- lib/shift_planning/version.rb
+- shift_planning.gemspec
+- spec/client_spec.rb
+homepage: https://github.com/AskarZinurov/shift_planning
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Client library to www.shiftplanning.com
+test_files:
+- spec/client_spec.rb