paylocity_web_service 0.1.5 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13bc282646a644fa31a73793b130888d3835a1a2cfb4680503a984692dff8a7
-  data.tar.gz: 79f972097465eb78320d651dcf4de69176c2ced85dc49add173b42fc00cc2514
+  metadata.gz: 8ed38f1a130e21d527fa2f42777314ecf3a200eeceb28cd1c1d6d6bebf13d5c5
+  data.tar.gz: 67d80bab97b9568534e1c031683267cdbaf503caabd4264d58d98e287be60104
 SHA512:
-  metadata.gz: f1019e51d9a9c4c4c8191fd02fd01c999a7af501f3d03ef64ee446e314028f22b5c23b924f53508ce9194db5e98e0da4fb2ef510783a53c6d843364faa5ac7d4
-  data.tar.gz: 0ae1f759d98638bbafeabbdc4373c4ff3c68364f53f06a6447f59c74a3e26f93ff10c1302f10978d192aa175818b50dff0462d68f9d0a09f27894f9035163478
+  metadata.gz: ff5f640ac32954fbbbd6641d2b6c709d65b91ff4dc88844f6fbaf8525af539d69340afaf21114b82eff2020c986842a09bd2d54744068afcf3cd51a86fd94f37
+  data.tar.gz: dd71548e6420fb38bebbd99848d5f960f1d1d51fd79230379a8853f0686fb2c5e90dd7227e975fdafa3cbecae0eec14d95ed2dd9462fc204cd76032b07e82a66

data/.github/workflows/rspec.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    environment: test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: SANDBOX_PAYLOCITY_CLIENT_ID=${{ secrets.SANDBOX_PAYLOCITY_CLIENT_ID }} SANDBOX_PAYLOCITY_CLIENT_SECRET=${{ secrets.SANDBOX_PAYLOCITY_CLIENT_SECRET }} SANDBOX_PAYLOCITY_DEMO_COMPANY_ID=${{ secrets.SANDBOX_PAYLOCITY_DEMO_COMPANY_ID }} SANDBOX_PAYLOCITY_ENDPOINT=${{ secrets.SANDBOX_PAYLOCITY_ENDPOINT }} SANDBOX_PAYLOCITY_PUBLIC_KEY="${{ secrets.SANDBOX_PAYLOCITY_PUBLIC_KEY }}" bundle exec rspec

data/.gitignore

@@ -11,3 +11,4 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+.env.test

data/Gemfile

@@ -8,10 +8,11 @@ gemspec
 # The following gems are required for local development and will not be included by `gem install mygem` or `bundle add mygem`.
 group :development, :test do
   gem 'awesome_print', require: 'ap'
-  gem 'pry-byebug'
+  gem 'rails'
+  gem 'pry'
   gem 'rubocop'
   gem 'rake'
   gem 'bundler'
   gem "rspec", "~> 3.0"
-  gem 'webmock', '~> 3.8', '>= 3.8.2'
+  gem 'dotenv'
 end

data/lib/paylocity_web_service/authentication.rb

@@ -5,7 +5,7 @@ require 'paylocity_web_service/cache'
 module PaylocityWebService
   module Authentication
     def access_token
-      token = PaylocityWebService::Cache.read(access_token_cache_key)
+      token = cache_store.read(access_token_cache_key)
 
       if token.nil?
         refresh_token
@@ -26,15 +26,24 @@ module PaylocityWebService
         }
       end
 
-
       body = JSON.parse(resp.body)
       token, expires_in = body['access_token'], body['expires_in']
-      PaylocityWebService::Cache.write(access_token_cache_key, token, expires_in)
+      cache_store.write(access_token_cache_key, token, expires_in: expires_in)
       token
     end
 
     def access_token_cache_key
-      'access_token_cache_key'
+      raise 'company_id is required' if company_id.nil?
+      "PaylocityCompany/#{company_id}/AccessToken/#{endpoint}"
+    end
+
+
+    def cache_store
+      if defined?(Rails)
+        Rails.cache
+      else
+        PaylocityWebService::Cache
+      end
     end
 
     def basic_auth_token

data/lib/paylocity_web_service/cache.rb

@@ -9,8 +9,9 @@ module PaylocityWebService
       store[key][:value]
     end
 
-    def self.write(key, value, expires_in = 3600 )
-      expires_at = (Time.now.to_i + expires_in) - 60
+    def self.write(key, value, options = {} )
+      expires_in = options[:expires_in] || 3600
+      expires_at = (Time.now.to_i + expires_in.to_i) - 60
       store[key] = { value: value, expires_at: expires_at}
     end
 
@@ -18,7 +19,7 @@ module PaylocityWebService
       @cache_store ||= {}
     end
 
-    def self.flush!
+    def self.clear
       @cache_store = {}
     end
   end

data/lib/paylocity_web_service/client/companies.rb

@@ -1,16 +1,16 @@
 module PaylocityWebService
   class Client
     module Companies
-      CodeResources = %W(costcenter1 costcenter2 costcenter3 deductions earnings taxes paygrade positions)
+      CodeResources = %W(costCenter1 costCenter2 costCenter3 deductions earnings taxes paygrade positions)
 
       def company_schema
         get("/api/v2/companies/#{company_id}/openapi")
       end
 
       # Available Code Resources:
-      # - costcenter1
-      # - costcenter2
-      # - costcenter3
+      # - costCenter1
+      # - costCenter2
+      # - costCenter3
       # - deductions
       # - earnings
       # - taxes
@@ -23,6 +23,15 @@ module PaylocityWebService
       def code_resources
         CodeResources
       end
+
+      # Paylocity hasn't provide a way to check the connectivity of the API, we have to fire a request to check it.
+      def company_connected?
+        return true if company_codes('costCenter1').status == 200
+        return true if company_schema.code == 200
+        false
+      rescue => e
+        false 
+      end
     end
   end
 end

data/lib/paylocity_web_service/client/credentials.rb

@@ -1,8 +1,8 @@
 module PaylocityWebService
   class Client
     module Credentials
-      def create_client_credential
-        post("/api/v2/credentials/secrets")
+      def create_client_credential(options={})
+        post("/api/v2/credentials/secrets", options)
       end
     end
   end

data/lib/paylocity_web_service/connection.rb

@@ -95,6 +95,7 @@ module PaylocityWebService
         conn.use Faraday::Request::Authorization, :Bearer, access_token
         conn.request :retry, max: 2
         conn.request :json
+        conn.request :instrumentation, name: 'request.paylocity'
 
         # conn.use PaylocityWebService::Middleware::Response::RaiseError
         conn.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/

data/lib/paylocity_web_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaylocityWebService
-  VERSION = "0.1.5"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paylocity_web_service
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.3
 platform: ruby
 authors:
 - Ryan Lv
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -45,10 +45,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the API of Paylocity Web Service

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.2.15