splinter-pto 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64509e85be57dcc511d83fd3d6e3e618b514df6c303fb4a02e726d115bfac9b0
-  data.tar.gz: 5a14982c46a12344c65ea41b3c7ce1b55315c7a878499db4c338606acd8d6ba4
+  metadata.gz: a59c344c2b2855841431b98c542f12757b06275df2fe0073df337b147524fc8e
+  data.tar.gz: cda5af416943056e2c42c46b8e623cb8c6122a0bc5d5b323a34300a7a8b5c4b4
 SHA512:
-  metadata.gz: 82cf3fce2f905fc903b92f4bd765a2f9ffc1e39961952d744200ed476768fb832169f5725dbd94337531cc3b19fd886f9ba778d01754d24c36142a15c4894db3
-  data.tar.gz: 1165baf24e244defc497b04c229e684623c5ea18cc4b527fba452279f5c5e72f27f0d019a9dbe670395a7448ea73c70dfc5bff94e0737d5ab1c9685a4f8f0ef4
+  metadata.gz: 1314d55b3972cfb9b53e9b3a8409e67aee3d862b0b3471cf7f828df4ee3f3d2df787fe70638cab7d2c1e4bb1664f2ac6487ec246bf83dd1483df356a4eb859be
+  data.tar.gz: 68f10155d9e6715cfaf749ad47ccfa6f4ba0a6788a23873fbac84a16fb59f1b505e437f0aedbd2c700f5f662bfb3695fac8368368971657e0663c429f6848ad7

data/.rubocop.yml

@@ -2,8 +2,12 @@ inherit_from: .rubocop_todo.yml
 
 require:
   - rubocop-rspec
+  - rubocop-rake
   - rubocop-packaging
 
+AllCops:
+  NewCops: enable
+
 Style/Documentation:
   Enabled: false
 RSpec/MultipleExpectations:

data/Gemfile

@@ -4,3 +4,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in splinter.gemspec
 gemspec
+
+# Development Dependencies
+group :development, :test do
+  gem 'pry', '~> 0.13'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.7', '>= 3.9.0'
+  gem 'rubocop', '~> 1.65'
+  gem 'rubocop-packaging', '~> 0.5'
+  gem 'rubocop-rake', '~> 0.6'
+  gem 'rubocop-rspec', '~> 3.0'
+end

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    splinter-pto (0.1.5)
+    splinter-pto (0.1.7)
+      json
       rest-client (~> 2.0)
 
 GEM
@@ -10,32 +11,35 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
+    domain_name (0.6.20240107)
     http-accept (1.7.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
-    json (2.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    mime-types (3.3.1)
+    mime-types (3.5.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    mime-types-data (3.2024.0305)
     netrc (0.11.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
+      racc
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
+    racc (1.8.0)
+    rainbow (3.1.1)
     rake (13.0.3)
-    regexp_parser (2.1.1)
+    regexp_parser (2.9.2)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rexml (3.2.5)
+    rexml (3.3.1)
+      strscan
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -49,39 +53,40 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (0.93.1)
+    rubocop (1.65.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.6.0)
-      parser (>= 3.0.1.1)
-    rubocop-packaging (0.5.1)
-      rubocop (>= 0.89, < 2.0)
-    rubocop-rspec (1.44.1)
-      rubocop (~> 0.87)
-      rubocop-ast (>= 0.7.1)
-    ruby-progressbar (1.11.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.7)
-    unicode-display_width (1.7.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-packaging (0.5.2)
+      rubocop (>= 1.33, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.0.3)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  json
   pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.7, >= 3.9.0)
-  rubocop (~> 0.85)
-  rubocop-packaging (~> 0.1)
-  rubocop-rspec (~> 1.39)
+  rubocop (~> 1.65)
+  rubocop-packaging (~> 0.5)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 3.0)
   splinter-pto!
 
 BUNDLED WITH

data/README.md

@@ -19,7 +19,37 @@ Or install it yourself as:
     $ gem install splinter-pto
 
 ## Usage
-# TODO
+
+### Configuration
+
+Configure an API Key:
+
+```ruby
+Splinter.configure do |c|
+  c.api_key = "MY_API_KEY"
+end
+```
+
+### OOO Events
+
+```ruby
+# Get all PTO Events
+Splinter::OOOEvents.get_all
+
+event_id = 1 # example event ID
+Splinter::OOOEvents.find(event_id)
+```
+
+### OOO Types
+
+```ruby
+# List all OOO Event Types
+Splinter::OOOTypes.get_all
+
+# Find a specific event type by ID
+type_id = '1'
+Splinter::OOOTypes.find(type_id)
+```
 
 ## Development
 

data/lib/splinter/api.rb

@@ -2,29 +2,41 @@
 
 require 'rest-client'
 require 'json'
+require 'uri'
 
 module Splinter
   class API
-    BASE_URL = 'https://ninja-bot.treehoppr.com/api/beta'
+    BASE_URL = 'https://ninja.tryroots.io/api/beta'
 
     def self.get(endpoint)
-      headers = { 'Authorization': "Token #{Splinter.configuration.api_key}" }
-      response = RestClient.get("#{BASE_URL}/#{endpoint}", headers)
+      response = RestClient.get(build_url(endpoint), headers)
       JSON.parse(response.body)
     end
 
     def self.paginated_get(endpoint, params = {})
-      headers = { 'Authorization': "Token #{Splinter.configuration.api_key}" }
-      url = "#{BASE_URL}/#{endpoint}"
+      url = build_url(endpoint, params)
       results = []
+
       loop do
-        result = RestClient.get(url, headers.merge({ params: params }))
+        result = RestClient.get(url, headers)
         parsed_result = JSON.parse(result.body)
         results.concat(parsed_result['results'])
-        url = parsed_result.dig('next')
+        url = parsed_result&.dig('next')
         break if url.nil?
       end
+
       results
     end
+
+    def self.headers
+      { Authorization: "Token #{Splinter.configuration.api_key}" }
+    end
+
+    def self.build_url(endpoint, params = {})
+      url = "#{BASE_URL}/#{endpoint}"
+      url += "?#{URI.encode_www_form(params)}" unless params.empty?
+
+      url
+    end
   end
 end

data/lib/splinter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Splinter
-  VERSION = '0.1.5'
+  VERSION = '0.1.7'
 end

data/splinter.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Ruby wrapper for the PTO by Roots API'
   spec.homepage      = 'https://gitlab.com/gitlab-com/people-group/peopleops-eng/splinter'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://gitlab.com/gitlab-com/people-group/peopleops-eng/splinter'
@@ -26,13 +26,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rest-client', '~> 2.0'
+  spec.add_dependency 'json'
+  spec.add_dependency 'rest-client', '~> 2.0'
 
-  spec.add_development_dependency 'json'
-  spec.add_development_dependency 'pry', '~> 0.13'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.7', '>= 3.9.0'
-  spec.add_development_dependency 'rubocop', '~> 0.85'
-  spec.add_development_dependency 'rubocop-packaging', '~> 0.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.39'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: splinter-pto
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Lien Van Den Steen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -31,7 +17,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,96 +25,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.85'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.85'
-- !ruby/object:Gem::Dependency
-  name: rubocop-packaging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
-description: 
+        version: '2.0'
+description:
 email:
 - lvandensteen@gitlab.com
 executables: []
@@ -162,7 +72,8 @@ metadata:
   homepage_uri: https://gitlab.com/gitlab-com/people-group/peopleops-eng/splinter
   source_code_uri: https://gitlab.com/gitlab-com/people-group/peopleops-eng/splinter
   changelog_uri: https://gitlab.com/gitlab-com/people-group/peopleops-eng/splinter
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,15 +81,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for the PTO by Roots API
 test_files: []