shift_planning_client 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7294a68657aca437e20331a4fe5497d8d3e58bfc
-  data.tar.gz: 958543fe3eaa3eabb14ad3448f4deb4e7f76cb0c
+  metadata.gz: 1a5cd44b86aedbb0320a4c776642b7a4a9354d31
+  data.tar.gz: 10e18af9854af65f905c3f21df8a9e389a86a5bd
 SHA512:
-  metadata.gz: 41debc8235e4de3c1801bf0382e8f3b0e039f0b736403b9ce64e98461bc5eb527453d1b5fc8bf469bd3ae6d30a3e5e4d7aa04a5d5b82906c61224d2ac3ea9e3c
-  data.tar.gz: 221694141bc6c83a17266cce400a7dfa415f842b966a2ddaa6539578140eb5b961445ff40543550826caf7ecd1dd5a275d8a97b80b09b6569ce6b223e7b18722
+  metadata.gz: 1c77cb32176ceb63e29ad56aba6fc25159645eb6403ce5555765322dd6df089d67ace899efb982513d799c44ce7e5893a99f0f6b114cca2d193b700d21e72b97
+  data.tar.gz: c9368998487139c022a47caebc83ee30979f889fc1c7da15a0aee36ee8c4e65724d403944b43b13159cd5d4baf16a2aea96c6d1b1dec30faf2dcd4e8f211f375

data/README.md

@@ -6,7 +6,7 @@ Ruby client gem for http://www.shiftplanning.com
 
 Add this line to your application's Gemfile:
 
-    gem 'shift_planning'
+    gem 'shift_planning_client'
 
 And then execute:
 
@@ -34,6 +34,18 @@ client.<api_namespace>.<method>_<endpoint>(required_arg_1, required_arg_2 [, opt
   client.staff.get_logout
 ```
 
+or
+
+```ruby
+  shift_planning = ShiftPlanning::AuthenticationKeeper.new('api_key', 'username', 'password')
+  shift_planning.run do |c|
+    c.timeclock.get_clockin()
+
+    ...
+
+  end
+```
+
 Rescue from api errors with:
 
 ```ruby
@@ -46,6 +58,12 @@ Rescue from api errors with:
 Api map described in lib/shift_planning/client.rb
 For more info follow http://www.shiftplanning.com/api/
 
+To run specs:
+
+```bash
+SHIFT_PLANNING_KEY='key' SHIFT_PLANNING_STAFF_USERNAME='username' SHIFT_PLANNING_STAFF_PASSWORD='password' rspec spec
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/AskarZinurov/shift_planning/fork )

data/lib/shift_planning.rb

@@ -2,3 +2,4 @@ require "faraday"
 require "faraday_middleware"
 require "shift_planning/version"
 require "shift_planning/client"
+require "shift_planning/authentication_keeper"

data/lib/shift_planning/api_error.rb

@@ -1,4 +1,6 @@
 class ShiftPlanning::ApiError < Exception
+  attr_reader :code
+
   CODES = {
     -3 => 'Flagged API Key - Pemanently Banned',
     -2 => 'Flagged API Key - Too Many invalid access attempts - contact us',

data/lib/shift_planning/authentication_keeper.rb

@@ -0,0 +1,28 @@
+class ShiftPlanning::AuthenticationKeeper
+  attr_reader :client
+
+  def initialize(api_key, username, password)
+    @client = ShiftPlanning::Client.new(api_key)
+    @username = username
+    @password = password
+  end
+
+  def run(&block)
+    login unless @client.connection.authenticated?
+    block.call @client
+  rescue ShiftPlanning::ApiError => e
+    raise e if e.code != 3
+    login
+    block.call @client
+  end
+
+  def logout
+    @client.staff.get_logout if @client.connection.authenticated?
+  end
+
+  private
+
+  def login
+    @client.staff.get_login(@username, @password)
+  end
+end

data/lib/shift_planning/connection.rb

@@ -31,6 +31,10 @@ class ShiftPlanning::Connection
     end
   end
 
+  def authenticated?
+    @token && !@token.empty?
+  end
+
   private
 
   def parse_data(response_data, &block)

data/lib/shift_planning/version.rb

@@ -1,3 +1,3 @@
 module ShiftPlanning
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/shift_planning.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "rspec", "~> 3.1.7"
+  spec.add_development_dependency "rspec", "~> 3.1"
 
   spec.add_runtime_dependency 'faraday', "~> 0.9"
   spec.add_runtime_dependency 'faraday_middleware', "~> 0.9.1"

data/spec/authentication_keeper_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ShiftPlanning::AuthenticationKeeper do
+  let(:client_stub) { double(connection: '', staff: '') }
+
+  subject(:client) { described_class.new('key', 'username', 'password') }
+
+  before do
+    client.instance_variable_set '@client', client_stub
+    allow(client_stub.connection).to receive(:authenticated?) { true }
+    allow(client_stub.staff).to receive(:get_login) { true }
+  end
+
+  it 'should catch expired token error' do
+    expect(client).to receive(:login) { true }
+    results = [ ->(c) { true }, ->(c) { raise(ShiftPlanning::ApiError.parse(3)) }]
+    client.run { |c| results.pop.call(c) }
+  end
+
+  it 'should raise api error' do
+    expect do
+      client.run { |c| raise(ShiftPlanning::ApiError.parse(3)) }
+    end.to raise_error(ShiftPlanning::ApiError)
+  end
+end

data/spec/client_spec.rb

@@ -1,4 +1,4 @@
-require "shift_planning"
+require 'spec_helper'
 
 describe ShiftPlanning::Client do
   context 'staff' do
@@ -18,11 +18,11 @@ describe ShiftPlanning::Client do
       end
 
       it 'should return skills' do
-        client.staff.get_skills.should == ''
+        expect(client.staff.get_skills).to eq('')
       end
 
       it 'can logout' do
-        client.staff.get_logout.should == ''
+        expect(client.staff.get_logout).to eq('')
       end
     end
   end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'shift_planning'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shift_planning_client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Askar Zinurov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.7
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.7
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -95,11 +95,14 @@ files:
 - lib/shift_planning.rb
 - lib/shift_planning/api_error.rb
 - lib/shift_planning/api_module.rb
+- lib/shift_planning/authentication_keeper.rb
 - lib/shift_planning/client.rb
 - lib/shift_planning/connection.rb
 - lib/shift_planning/version.rb
 - shift_planning.gemspec
+- spec/authentication_keeper_spec.rb
 - spec/client_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/AskarZinurov/shift_planning
 licenses:
 - MIT
@@ -125,4 +128,6 @@ signing_key:
 specification_version: 4
 summary: Client library to www.shiftplanning.com
 test_files:
+- spec/authentication_keeper_spec.rb
 - spec/client_spec.rb
+- spec/spec_helper.rb