paychex_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 9f78afb440d84e9a5176bd9c870017eaff629de329dd03231ba2341765907dcb
-  data.tar.gz: 9130a0af28b1b20dca4e83c66a7ded516f53e2762d153eced828d00543873bda
+SHA1:
+  metadata.gz: 9de0f7cad757b537924ef7f2f44d900c35e5012d
+  data.tar.gz: d309d3026ae13f12cfb9007522e8740a207278c8
 SHA512:
-  metadata.gz: a02a59856b12ec65389025d56d38fb34031a3de2b00f0aee78248a51594c3a765d9d2f3225fd54e047ffb7a7dc4fc46c26d51df1363fbe478724675266a8befb
-  data.tar.gz: b2b057ee0cdf27aa2a7ef7c664f2775e53c15da03c7c8acc275b5d6c6fcc8d78252c298b96cf94bd2b7ab4afb6c10039edcc0d63540a347e1ec787a6bfe6ae47
+  metadata.gz: e41269cc0be06d85a2e81a1ea1322ec56c49e887febe6aeb6bb35cada13976a6500085c70f91f9f5033780da7b4d5fedddf1ad4cc0447213652a0bf2600cb3a7
+  data.tar.gz: bd2845c4f9e0682e580cc1b9a6657702f3771cf195cbae783cad649ab713864709b6cb7dd94a56a2b5b6f8b2a4cf8e556a2e7528eb64249e2a923acde928b36d

data/.gitignore

@@ -5,3 +5,4 @@ bridge_api.iml
 .byebug.*
 .byebug_history
 .*.gem
+coverage

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+Metrics/ClassLength:
+  Max: 150
+Metrics/LineLength:
+  Max: 120
+Style/Documentation:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'paychex_api.gemspec'
+    - 'spec/**/*'
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Metrics/MethodLength:
+    Exclude:
+      - spec/**/*
+Naming/AccessorMethodName:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,7 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+SimpleCov.minimum_coverage 80
+SimpleCov.minimum_coverage_by_file 80
+SimpleCov.start do
+  add_group 'lib', 'lib'
+  add_filter 'spec'
+end

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.5.0
+
+RUN apt-get update
+
+RUN mkdir -p /usr/src/app
+COPY Gemfile /usr/src/app/
+COPY Gemfile.lock /usr/src/app/
+COPY paychex_api.gemspec /usr/src/app/
+COPY /lib/paychex_api/version.rb /usr/src/app/lib/paychex_api/
+
+WORKDIR /usr/src/app
+RUN bundle install --system
+
+COPY . /usr/src/app/

data/Gemfile

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

data/Gemfile.lock

@@ -1,27 +1,29 @@
 PATH
   remote: .
   specs:
-    bridge_api (0.0.1)
-      faraday (~> 0.9.0)
-      faraday_middleware (~> 0.9.0)
+    paychex_api (0.0.3)
+      faraday (~> 0.9.2)
+      faraday_middleware (~> 0.9.2)
       footrest (>= 0.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
     byebug (8.2.5)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
+    docile (1.3.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.9.2)
@@ -30,13 +32,24 @@ GEM
       activesupport (>= 3.0.0)
       faraday (~> 0.9.0)
       link_header (>= 0.0.7)
+    gergich (0.2.2)
+      httparty (~> 0.6)
+      sqlite3 (~> 1.3)
     hashdiff (0.3.7)
-    i18n (0.9.1)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
+    json (2.1.0)
     link_header (0.0.8)
     method_source (0.9.0)
-    minitest (5.11.1)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
     multipart-post (2.0.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -44,6 +57,7 @@ GEM
     rack (1.6.8)
     rack-protection (1.5.3)
       rack
+    rainbow (3.0.0)
     rake (0.9.6)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -53,15 +67,30 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.4)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
+    sqlite3 (1.3.13)
     thread_safe (0.3.6)
     tilt (1.4.1)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.3.2)
     webmock (1.22.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -71,15 +100,18 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bridge_api!
   bundler (~> 1.0, >= 1.0.0)
   byebug (~> 8.2.2)
+  gergich (~> 0.2.2)
+  paychex_api!
   pry (~> 0)
   rake (~> 0)
   rspec (~> 2.6)
+  rubocop (~> 0.54.0)
+  simplecov (~> 0.16.1)
   sinatra (~> 1.0)
   tilt (~> 1.3, >= 1.3.4)
   webmock (~> 1.22.6)
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/bin/jenkins

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+set +e
+EXIT_CODES=0
+
+echo "Analyzing ruby code with rubocop"
+bundle exec gergich capture rubocop "bundle exec rubocop --fail-level autocorrect"
+EXIT_CODES=$(($EXIT_CODES + $?))
+
+echo 'Running ruby specs'
+bundle exec rspec
+EXIT_CODES=$(($EXIT_CODES + $?))
+
+bundle exec gergich publish
+exit $EXIT_CODES

data/build.sh

@@ -0,0 +1,5 @@
+set -e
+
+docker-compose build
+docker-compose up -d
+docker-compose run -T web bin/jenkins

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '2'
+
+services:
+  web:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    environment:
+      APP_DOMAIN: web
+      GERGICH_KEY: "${GERGICH_KEY}"
+      GERRIT_PROJECT: "${GERRIT_PROJECT}"
+      GERRIT_HOST: "${GERRIT_HOST}"
+      GERRIT_BRANCH: "${GERRIT_BRANCH}"
+    volumes:
+      - "coverage:/usr/src/app/coverage"
+
+volumes:
+  coverage: {}

data/lib/paychex_api.rb

@@ -1,2 +1,11 @@
 require 'paychex_api/version'
 require 'paychex_api/client'
+
+module PaychexAPI
+  class << self
+    attr_accessor :proxy
+    def configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/paychex_api/api_array.rb

@@ -3,24 +3,27 @@ module PaychexAPI
   class ApiArray
     include Enumerable
 
+    MAX_PAGES = 100
+
     @next_page = nil
     @prev_page = nil
 
-    attr_reader :status, :headers, :members, :links, :metadata, :members
+    attr_reader :status, :headers, :members, :links, :metadata
+    attr_writer :next_page
 
     def self.process_response(response, api_client)
       ApiArray.new(response, api_client)
     end
 
     def initialize(response, api_client)
-      @meta_fields = %w(metadata links)
+      @meta_fields = %w[metadata links]
       @api_client = api_client
       @links = []
       @metadata = {}
       case response.status
-        when *((200..206).to_a + [302])
-          apply_response_metadata(response)
-          @members = get_response_content(response)
+      when *((200..206).to_a + [302])
+        apply_response_metadata(response)
+        @members = get_response_content(response)
       end
     end
 
@@ -28,16 +31,16 @@ module PaychexAPI
       @members.length
     end
 
-    def [](i)
-      @members[i]
+    def [](index)
+      @members[index]
     end
 
     def last
       @members.last
     end
 
-    def each(&block)
-      @members.each { |member| block.call(member) }
+    def each
+      @members.each { |member| yield(member) }
     end
 
     def pages?
@@ -48,33 +51,40 @@ module PaychexAPI
       load_page(@next_page)
     end
 
-    def each_page(&block)
-      block.call(@members, @linked, @meta)
+    def each_page
+      yield(@members, @linked, @meta)
       while @next_page
         response = get_page(@next_page)
         apply_response_metadata(response, false)
         @members = get_response_content(response)
-        block.call(@members, @linked, @meta)
+        yield(@members, @linked, @meta)
       end
       @link_hash = {}
     end
 
     def all_pages!
-      if pages?
-        response = get_page(@next_page)
-        apply_response_metadata(response)
-        @members.concat(get_response_content(response))
-        while @next_page
-          response = get_page(@next_page)
-          apply_response_metadata(response)
-          @members.concat(get_response_content(response))
-        end
-      end
+      return self unless pages?
+      combine_page
+      combine_pages
       self
     end
 
     private
 
+    def combine_pages
+      counter = 0
+      while @next_page && counter <= MAX_PAGES
+        combine_page
+        counter += 1
+      end
+    end
+
+    def combine_page
+      response = get_page(@next_page)
+      apply_response_metadata(response)
+      @members.concat(get_response_content(response))
+    end
+
     def get_page(url, params = {})
       query = URI.parse(url).query
       p = CGI.parse(query).merge(params)
@@ -93,15 +103,13 @@ module PaychexAPI
     def get_response_content(response)
       return [] unless response.body.is_a?(Hash)
       content = response.body['content']
-      if content.length > 0
-        return content
-      end
+      return content unless content.empty?
       []
     end
 
     def apply_response_metadata(response, concat = true)
       unless concat
-        @links = {}
+        @links = []
         @metadata = {}
       end
       @status = response.status
@@ -113,31 +121,26 @@ module PaychexAPI
     end
 
     def init_linked(response)
-      if response.body.is_a?(Hash) && response.body.key?('links')
-        @links = @links.concat(response.body['links'])
-      end
+      return nil unless response.body.is_a?(Hash) && response.body.key?('links')
+      @links = @links.concat(response.body['links'])
     end
 
     def init_meta(response)
-      if response.body.is_a?(Hash) && response.body.key?('metadata')
-        @metadata = response.body['metadata']
-      end
+      return nil unless response.body.is_a?(Hash) && response.body.key?('metadata')
+      @metadata = response.body['metadata']
     end
 
     def init_pages(response)
-      @next_page = nil
-      @prev_page = nil
-      if response.body.is_a?(Hash) && response.body.key?('links')
-        response.body['links'].each do |link|
-          case link['rel']
-            when 'next'
-              @next_page = link['href']
-            when 'prev'
-              @prev_page = link['href']
-          end
+      return nil unless response.body.is_a?(Hash) && response.body.key?('links')
+      @next_page, @prev_page = nil
+      response.body['links'].each do |link|
+        case link['rel']
+        when 'next'
+          @next_page = link['href']
+        when 'prev'
+          @prev_page = link['href']
         end
       end
     end
-
   end
 end

data/lib/paychex_api/client.rb

@@ -11,68 +11,98 @@ require 'paychex_api/api_array'
 
 module PaychexAPI
   class Client < Footrest::Client
-
-    API_PATH = ""
-    COMPANIES_PATH = '/companies'
-    ORGANIZATIONS_PATH = '/organizations'
-    JOB_TITLES_PATH = '/jobtitles'
-    WORKER_STATUSES_PATH = '/workerstatuses'
-    WORKERS_PATH = '/workers'
-    COMMUNICATIONS_PATH = '/communications'
-    COMPENSATION_PATH = '/compensation'
-    DIRECT_DEPOSITS_PATH = '/directdeposits'
-    PAY_PERIODS_PATH = '/payperiods'
-    PAY_COMPONENTS_PATH = '/paycomponents'
-    CHECKS_PATH = '/checks'
-    OAUTH_TOKEN_PATH = '/auth/oauth/v2/token'
+    API_PATH = ''.freeze
+    COMPANIES_PATH = '/companies'.freeze
+    ASSOCIATIONS_PATH = '/'.freeze
+    ORGANIZATIONS_PATH = '/organizations'.freeze
+    JOB_TITLES_PATH = '/jobtitles'.freeze
+    WORKER_STATUSES_PATH = '/workerstatuses'.freeze
+    WORKERS_PATH = '/workers'.freeze
+    COMMUNICATIONS_PATH = '/communications'.freeze
+    COMPENSATION_PATH = '/compensation'.freeze
+    DIRECT_DEPOSITS_PATH = '/directdeposits'.freeze
+    PAY_PERIODS_PATH = '/payperiods'.freeze
+    PAY_COMPONENTS_PATH = '/paycomponents'.freeze
+    CHECKS_PATH = '/checks'.freeze
+    OAUTH_TOKEN_PATH = '/auth/oauth/v2/token'.freeze
 
     attr_reader :authorization
 
     Dir[File.dirname(__FILE__) + '/client/*.rb'].each do |file|
       require file
-      include self.const_get("#{File.basename(file).gsub('.rb','').split("_").map{|ea| ea.capitalize}.join('')}")
+      include const_get(File.basename(file).gsub('.rb', '').split('_').map(&:capitalize).join('').to_s)
     end
 
     # Override Footrest request for ApiArray support
     def request(method, &block)
-      if @authorization.blank? || @authorization['expiration'] <= DateTime.now - 30.seconds
-        temp_client =  get_default_faraday
-        response = temp_client.post(
-          OAUTH_TOKEN_PATH,
-          {
-            client_id: config[:client_id],
-            client_secret: config[:client_secret],
-            grant_type: 'client_credentials'
-          }
-        )
-        @authorization = response.body
-        @authorization['expiration'] = DateTime.now + @authorization['expires_in'].to_i.seconds
-      end
-      connection.headers[:authorization] =   "Bearer #{@authorization['access_token']}"
-      ApiArray::process_response(connection.send(method, &block), self)
+      authorize if @authorization.blank? || @authorization['expiration'] <= Time.now - 30.seconds
+      connection.headers[:authorization] = "Bearer #{@authorization['access_token']}"
+      ApiArray.process_response(connection.send(method, &block), self)
+    end
+
+    def authorize
+      response = default_faraday.post(
+        OAUTH_TOKEN_PATH,
+        client_id: config[:client_id],
+        client_secret: config[:client_secret],
+        grant_type: 'client_credentials'
+      )
+      @authorization = response.body
+      @authorization['expiration'] = Time.now + @authorization['expires_in'].to_i.seconds
     end
 
     def set_connection(config)
       config[:logger] = config[:logging] if config[:logging]
-      @connection = get_default_faraday
+      @connection = default_faraday
+    end
+
+    def faraday_default_use(faraday)
+      faraday.use Footrest::ParseJson, content_type: /\bjson$/
+      faraday.use Footrest::RaiseFootrestErrors
+      faraday.use Footrest::Pagination
+      faraday.use Footrest::FollowRedirects, limit: 5 if config[:follow_redirects]
+      faraday
+    end
+
+    def faraday_default_headers(faraday)
+      faraday.headers[:accept]          = 'application/json'
+      faraday.headers[:user_agent]      = 'Footrest'
+      faraday
+    end
+
+    def faraday_default_request(faraday)
+      faraday.request :multipart
+      faraday.request :url_encoded
+      faraday
+    end
+
+    def faraday_logger(faraday)
+      if config[:logger] == true
+        faraday.response :logger
+      elsif config[:logger]
+        faraday.use Faraday::Response::Logger, config[:logger]
+      end
+      faraday
+    end
+
+    def faraday_proxy(faraday)
+      faraday.proxy PaychexAPI.proxy if PaychexAPI.proxy
+      faraday
+    end
+
+    def faraday_config(faraday)
+      faraday = faraday_logger(faraday)
+      faraday = faraday_default_request(faraday)
+      faraday = faraday_default_use(faraday)
+      faraday = faraday_default_headers(faraday)
+      faraday = faraday_proxy(faraday)
+      faraday.adapter Faraday.default_adapter
+      faraday
     end
 
-    def get_default_faraday
+    def default_faraday
       Faraday.new(url: config[:prefix]) do |faraday|
-        faraday.request                     :multipart
-        faraday.request                     :url_encoded
-        if config[:logger] == true
-          faraday.response :logger
-        elsif config[:logger]
-          faraday.use Faraday::Response::Logger, config[:logger]
-        end
-        faraday.use                         Footrest::FollowRedirects, limit: 5 unless config[:follow_redirects] == false
-        faraday.adapter                     Faraday.default_adapter
-        faraday.use                         Footrest::ParseJson, :content_type => /\bjson$/
-        faraday.use                         Footrest::RaiseFootrestErrors
-        faraday.use                         Footrest::Pagination
-        faraday.headers[:accept]          = "application/json"
-        faraday.headers[:user_agent]      = "Footrest"
+        faraday_config(faraday)
       end
     end
   end