shift_planning 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f32e3accb175f8bfa729f4c1e69fb8805b7deea
+  data.tar.gz: c7788df7f61e701563b54aa09937292b5a2edc86
+SHA512:
+  metadata.gz: 24dd987600e1da7b07b37ff0e4de3d7594b495a0694574b461cd4516a0dbe13f8e4b5a4a63db1ddba71143b716488d3729f05b3be07958194375a6d2aced6455
+  data.tar.gz: 52f616fccf147237fc35672921a594fd4449a930ea2bc3931c167c2cbeb79ac20fc5b5afdb00034dd980a39ef7f730e49d5a9d331ad229f440478dfb35b069df

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/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shift_planning.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tyler Mercier
+
+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,49 @@
+# ShiftPlanning
+
+Ruby gem for the [Shift Planning API](http://www.shiftplanning.com)
+
+## Status
+[![Gem Version](https://badge.fury.io/rb/shift_planning.png)](http://badge.fury.io/rb/shift_planning)
+[![Build Status](https://secure.travis-ci.org/tylermercier/shift_planning.png)](http://travis-ci.org/tylermercier/shift_planning)
+[![Code Climate](https://codeclimate.com/github/tylermercier/shift_planning.png)](https://codeclimate.com/github/tylermercier/shift_planning)
+
+## 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
+
+    ShiftPlanning.init({
+      :username => 'username',
+      :password => 'password',
+      :key => 'api_key'
+    })
+
+    ShiftPlanning.skills
+
+    ShiftPlanning.employees
+
+    ShiftPlanning.employee(887992)
+
+    ShiftPlanning.add_skill(887992, 50186)
+
+    ShiftPlanning.remove_skill(887992, 50186)
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/ShiftPlanning/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,13 @@
+#!/usr/bin/env rake
+require "bundler"
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: 'test'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/shift_planning/client.rb

@@ -0,0 +1,57 @@
+require 'http'
+require 'json'
+require 'base64'
+
+module ShiftPlanning
+  class Client
+    def initialize(config = {})
+      raise ArgumentError.new('Missing username') unless config.has_key? :username
+      @username = config[:username]
+      raise ArgumentError.new('Missing password') unless config.has_key? :password
+      @password = config[:password]
+      raise ArgumentError.new('Missing api key') unless config.has_key? :key
+      @key = config[:key]
+      @url = 'http://www.shiftplanning.com/api/'
+      @headers = {
+        "Content-Type" => "application/x-www-form-urlencoded"
+      }
+    end
+
+    def authenticated?
+      !@token.nil?
+    end
+
+    def authenticate
+      body = body_formatter({
+        "key" => @key,
+        "request" => {
+          "module" => "staff.login",
+          "method" => "GET",
+          "username" => @username,
+          "password" => @password
+        }
+      })
+      response = HTTP.with(@headers).post(@url, body)
+      @token = JSON.parse(response)["token"]
+    end
+
+    def request(api_module, request={}, method='GET')
+      authenticate unless authenticated?
+
+      body = body_formatter({
+        "token" => @token,
+        "method" => method,
+        "module" => api_module,
+        "request" => request
+      })
+      response = HTTP.with(@headers).post(@url, body)
+      JSON.parse(response)
+    end
+
+    def body_formatter(body)
+      {
+        :body => "data=#{JSON.dump(body)}"
+      }
+    end
+  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,38 @@
+require "shift_planning/version"
+require "shift_planning/client"
+
+module ShiftPlanning
+  extend self
+
+  def init(options={})
+    @@client = ShiftPlanning::Client.new(options)
+  end
+
+  def skills
+    @@client.request('staff.skills')
+  end
+
+  def employees
+    @@client.request('staff.employees')
+  end
+
+  def employee(employee_id)
+    @@client.request('staff.employee', "id" => employee_id)
+  end
+
+  def add_skill(employee_id, skill_id)
+    args = {
+      "id" => employee_id,
+      "addskill" => skill_id
+    }
+    @@client.request('staff.employee', args, "UPDATE")
+  end
+
+  def remove_skill(employee_id, skill_id)
+    args = {
+      "id" => employee_id,
+      "removeskill" => skill_id
+    }
+    @@client.request('staff.employee', args, "UPDATE")
+  end
+end

data/shift_planning.gemspec

@@ -0,0 +1,26 @@
+# 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"
+  spec.version       = ShiftPlanning::VERSION
+  spec.authors       = ["Tyler Mercier"]
+  spec.email         = ["tylermercier@gmail.com"]
+  spec.summary       = %q{Shift Planning API gem}
+  spec.description   = %q{Shift Planning API gem}
+  spec.homepage      = ""
+  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_dependency "http"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "webmock"
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'webmock/minitest'
+
+Minitest::Reporters.use!(Minitest::Reporters::DefaultReporter.new(color: true))
+
+ENV['RACK_ENV'] = 'test'
+
+Dir[File.dirname(__FILE__) + '/../lib/*.rb'].each do |file|
+  require File.basename(file, File.extname(file))
+end

data/test/unit/client_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe 'Client' do
+  before do
+    @client = ShiftPlanning::Client.new({
+      :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 '#authenticate' do
+    it 'requests auth token and saves it' do
+      @client.authenticate
+      assert @client.authenticated?
+    end
+  end
+
+  describe '#request' 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 => {})
+
+      args = {
+        "id" => 1,
+        "addskill" => 2
+      }
+      @client.request('staff.employee', args, "UPDATE")
+      assert true
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: shift_planning
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Mercier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shift Planning API gem
+email:
+- tylermercier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shift_planning.rb
+- lib/shift_planning/client.rb
+- lib/shift_planning/version.rb
+- shift_planning.gemspec
+- test/test_helper.rb
+- test/unit/client_test.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Shift Planning API gem
+test_files:
+- test/test_helper.rb
+- test/unit/client_test.rb