kaze_client 0.1.1p0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 687ef335a59eb5c25b4efece8a9e74f49a12a465b4018512c01246d2753fd218
-  data.tar.gz: 45905959e188ba363b09fa69bd96839e3b31057fac1704ede9c9a9fa3bbb020d
+  metadata.gz: e71be7a11e6eda6cc3c131cca7f758b86a899c7def80d9fe0c88e6856ef92eb0
+  data.tar.gz: '094490f87b08e879d00769788ca1213b84e3b49a5ac07a57a6b4e6b6ffeaa0c8'
 SHA512:
-  metadata.gz: 0eddfc2630c7ebd3aab7b17403662dd8922dc7f6a36488ac62b450d5246311763a2a4c0942e7618be16084267d2f64e0493fa17148c3b0c134d66f018f4d8536
-  data.tar.gz: 15c60ae8c4b65d96a63f1438c9dd7560d9f5e449a39780ad4040556973f2c185a6ec69980ae257e8a1cf6da5dfda1990a0c293398d7aca662defebbee2e4f77c
+  metadata.gz: 717a355889796d246c24e0b1b9cb6db5ae688115417342fc103a490a3164b2fbce486ead122712b6f66ae5ab1c2286273bd8db4ac8bf0e73689650491ad21c3b
+  data.tar.gz: 7282041426db6859a0b911d220efb9cca946cca5d294447927ca0ccf13ecd01ce56be8246599ab22eb4967e6366ec93a0c7ca0ec95780de95e3ade431f29d19d

data/.rubocop.yml

@@ -1,2 +1,104 @@
 AllCops:
-  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+

data/CHANGELOG.md

@@ -1,8 +1,3 @@
-## [0.1.1p1] - 2022-05-31
-
-- Replace KazeClient::CompaniesRequest (/api/companies) with KazeClient::PartnersRequest (/api/partners).
-- Upgrade rubocop.
-
 ## [0.1.1] - 2022-05-31
 
 - Rename the gem to KazeClient to follow the rebranding of LastBill to Kaze.

data/Gemfile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in kaze_client.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+gem "rake", "~> 13.0"
 
-gem 'rspec', '~> 3.0'
+gem "rspec", "~> 3.0"
 
-gem 'rubocop', '~> 1.7'
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kaze_client (0.1.1)
+    kaze_client (0.1.0)
       httparty (~> 0.18, >= 0.18.1)
 
 GEM
@@ -9,19 +9,19 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.4.4)
-    httparty (0.20.0)
+    httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.4.1)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
+    mime-types-data (3.2021.0225)
     multi_xml (0.6.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
-    rainbow (3.1.1)
+    rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.5.0)
+    regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -36,22 +36,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.30.0)
+    rubocop (1.15.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
-  aarch64-linux
   x86_64-darwin-20
 
 DEPENDENCIES

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'kaze_client'
+require "bundler/setup"
+require "kaze_client"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'kaze_client'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/kaze_client.gemspec

@@ -1,36 +1,35 @@
 # frozen_string_literal: true
 
-require_relative 'lib/kaze_client/version'
+require_relative "lib/kaze_client/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'kaze_client'
+  spec.name          = "kaze_client"
   spec.version       = KazeClient::VERSION
-  spec.authors       = ['Matthieu Ciappara']
-  spec.email         = ['ciappa_m@modulotech.fr']
+  spec.authors       = ["Matthieu Ciappara"]
+  spec.email         = ["ciappa_m@modulotech.fr"]
 
-  spec.summary       = 'This is the official Ruby client library for Kaze API.'
+  spec.summary       = "This is the official Ruby client library for Kaze API."
   spec.description = <<~TEXT
     This is the official Ruby client library for Kaze (https://www.kaze.so/) API.
 
     The API documentation can be found at https://documenter.getpostman.com/view/15303175/U16nLQ7r.
   TEXT
-  spec.homepage      = 'https://github.com/moduloTech/kaze_client'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.homepage      = "https://github.com/moduloTech/kaze_client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/moduloTech/kaze_client'
-  spec.metadata['changelog_uri'] = 'https://github.com/moduloTech/kaze_client/blob/master/CHANGELOG.md'
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/moduloTech/kaze_client"
+  spec.metadata["changelog_uri"] = "https://github.com/moduloTech/kaze_client/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'httparty', '~> 0.18', '>= 0.18.1'
-  # spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.add_runtime_dependency "httparty", "~> 0.18", ">= 0.18.1"
 end

data/lib/kaze_client/client.rb

@@ -13,7 +13,7 @@ module KazeClient
     # @see KazeClient::Client#login
     attr_reader :token
 
-    # @param base_url [String] The server's base URL (e.g. https://app.kaze.so)
+    # @param base_url [String] The server's base URL (e.g. https://app.kaze.som)
     def initialize(base_url)
       @base_url = base_url
       @token    = nil
@@ -52,14 +52,14 @@ module KazeClient
     def login(login = @login, password = @password)
       # Impossible to login using nil login or password.
       # The first call to #login must be given a login and a password.
-      raise KazeClient::Error::InvalidCredentials, 'Please set login and password' if login.nil? || password.nil?
+      raise KazeClient::Error::InvalidCredentials, "Please set login and password" if login.nil? || password.nil?
 
       request = KazeClient::LoginRequest.new(login: login, password: password)
 
       response = do_execute(request)
 
       # Store the token for next request and the login/password for next call
-      @token    = response['token']
+      @token    = response["token"]
       @login    = login
       @password = password
 

data/lib/kaze_client/error/disabled_account.rb

@@ -5,7 +5,7 @@ module KazeClient
     # @author ciappa_m@modulotech.fr
     # 403 error sent by Kaze server when trying to log in with a disabled account
     class DisabledAccount < Forbidden
-      def initialize(msg = 'User account was disabled by administrator')
+      def initialize(msg = "User account was disabled by administrator")
         super(msg)
       end
     end

data/lib/kaze_client/error/forbidden.rb

@@ -5,7 +5,7 @@ module KazeClient
     # @author ciappa_m@modulotech.fr
     # Generic 403 error sent by Kaze server
     class Forbidden < Generic
-      def initialize(msg = '403 Forbidden')
+      def initialize(msg = "403 Forbidden")
         super(status: :forbidden, message: msg)
       end
     end

data/lib/kaze_client/error/generic.rb

@@ -15,7 +15,7 @@ module KazeClient
       attr_reader :error
 
       # The default error message
-      DEFAULT_MESSAGE = 'An unknown error occured'
+      DEFAULT_MESSAGE = "An unknown error occured"
 
       def initialize(status: :internal_server_error, error: nil,
                      message: DEFAULT_MESSAGE)

data/lib/kaze_client/error/internal_server_error.rb

@@ -5,7 +5,7 @@ module KazeClient
     # @author ciappa_m@modulotech.fr
     # Generic 500 error sent by Kaze server
     class InternalServerError < Generic
-      def initialize(msg = 'An unknown error occured')
+      def initialize(msg = "An unknown error occured")
         super(message: msg)
       end
     end

data/lib/kaze_client/error/invalid_credentials.rb

@@ -5,7 +5,7 @@ module KazeClient
     # @author ciappa_m@modulotech.fr
     # 401 error sent by Kaze server when trying to log in with invalid credentials
     class InvalidCredentials < Unauthorized
-      def initialize(msg = 'Invalid Login or Password')
+      def initialize(msg = "Invalid Login or Password")
         super(msg)
       end
     end

data/lib/kaze_client/error/no_private_token.rb

@@ -5,7 +5,7 @@ module KazeClient
     # @author ciappa_m@modulotech.fr
     # 403 error sent by Kaze server when trying to log in and user has no token
     class NoPrivateToken < Forbidden
-      def initialize(msg = 'User has no private token assigned')
+      def initialize(msg = "User has no private token assigned")
         super(msg)
       end
     end

data/lib/kaze_client/error/not_found.rb

@@ -5,7 +5,7 @@ module KazeClient
     # @author ciappa_m@modulotech.fr
     # 404 error sent by Kaze server
     class NotFound < Generic
-      def initialize(msg = '404 Not Found')
+      def initialize(msg = "404 Not Found")
         super(status: :not_found, message: msg)
       end
     end

data/lib/kaze_client/error/unauthorized.rb

@@ -5,7 +5,7 @@ module KazeClient
     # @author ciappa_m@modulotech.fr
     # Generic 401 error sent by Kaze server
     class Unauthorized < Generic
-      def initialize(msg = '401 Unauthorized')
+      def initialize(msg = "401 Unauthorized")
         super(status: :unauthorized, message: msg)
       end
     end

data/lib/kaze_client/errors.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Require the error classes
-require_relative 'error/generic'
-require_relative 'error/unauthorized'
-require_relative 'error/forbidden'
-require_relative 'error/not_found'
-require_relative 'error/internal_server_error'
-require_relative 'error/disabled_account'
-require_relative 'error/invalid_credentials'
-require_relative 'error/no_endpoint'
-require_relative 'error/no_private_token'
+require_relative "error/generic"
+require_relative "error/unauthorized"
+require_relative "error/forbidden"
+require_relative "error/not_found"
+require_relative "error/internal_server_error"
+require_relative "error/disabled_account"
+require_relative "error/invalid_credentials"
+require_relative "error/no_endpoint"
+require_relative "error/no_private_token"

data/lib/kaze_client/request/request.rb

@@ -9,8 +9,8 @@ module KazeClient
   class Request
     # Those headers are added on all requests by default
     DEFAULT_HEADERS = {
-      'Content-Type' => 'application/json',
-      'Accept' => 'application/json'
+      "Content-Type" => "application/json",
+      "Accept" => "application/json"
     }.freeze
 
     # @return [String, Symbol] The HTTP verb to use for the request
@@ -69,14 +69,14 @@ module KazeClient
       return KazeClient::Error::NotFound.new if response.code == 404
 
       # Return the adequate error class for the error code in the response
-      "KazeClient::Error::#{response.parsed_response['error'].camelize}"
-        .constantize.new(response.parsed_response['message'])
+      "KazeClient::Error::#{response.parsed_response["error"].camelize}"
+        .constantize.new(response.parsed_response["message"])
     rescue NameError
       # This means no error class exists for the error code in the response, we fallback to a
       # generic error
       Error::Generic.new(status: response.code,
-                         error: response.parsed_response['error'],
-                         message: response.parsed_response['message'])
+                         error: response.parsed_response["error"],
+                         message: response.parsed_response["message"])
     end
 
     protected

data/lib/kaze_client/request/requests/{partners_request.rb → companies_request.rb}

@@ -8,12 +8,12 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @see KazeClient::Utils::ListRequest
   # @since 0.1.0
-  class PartnersRequest < Utils::FinalRequest
+  class CompaniesRequest < Utils::FinalRequest
     include Utils::AuthentifiedRequest
     include Utils::ListRequest
 
     def initialize
-      super(:get, 'api/partners')
+      super(:get, "api/companies")
     end
   end
 end

data/lib/kaze_client/request/requests/create_job_request.rb

@@ -19,7 +19,7 @@ module KazeClient
     # @param target_id [String] The id of the target company.
     # @param workflow [Hash] The workflow to use to create the job.
     def initialize(target_id, workflow)
-      super(:post, 'api/jobs')
+      super(:post, "api/jobs")
 
       @target_id = target_id
       @workflow  = workflow

data/lib/kaze_client/request/requests/job_workflows_request.rb

@@ -13,7 +13,7 @@ module KazeClient
     include Utils::ListRequest
 
     def initialize
-      super(:get, 'api/job_workflows')
+      super(:get, "api/job_workflows")
     end
   end
 end

data/lib/kaze_client/request/requests/jobs_request.rb

@@ -12,7 +12,7 @@ module KazeClient
     include Utils::ListRequest
 
     def initialize
-      super(:get, 'api/jobs')
+      super(:get, "api/jobs")
     end
   end
 end

data/lib/kaze_client/request/requests/login_request.rb

@@ -13,7 +13,7 @@ module KazeClient
     # @param login [String] The user login.
     # @param password [String] The user password.
     def initialize(login:, password:)
-      super(:post, 'api/login')
+      super(:post, "api/login")
 
       @login    = login
       @password = password

data/lib/kaze_client/request/requests/profile_request.rb

@@ -11,7 +11,7 @@ module KazeClient
     include Utils::AuthentifiedRequest
 
     def initialize
-      super(:get, 'api/profile')
+      super(:get, "api/profile")
     end
   end
 end

data/lib/kaze_client/request/requests/utils/authentified_request.rb

@@ -16,7 +16,7 @@ module KazeClient
       # @return [KazeClient::Utils::AuthentifiedRequest] self (to chain methods)
       def with_token(token)
         @token                    = token
-        @headers['Authorization'] = token
+        @headers["Authorization"] = token
 
         self
       end

data/lib/kaze_client/request/requests/utils/list_request.rb

@@ -73,7 +73,7 @@ module KazeClient
       # @return [KazeClient::Utils::ListRequest] self (to chain methods)
       def add_order_direction(direction)
         # Ensure the +direction+ parameter is valid; default direction is ascendant
-        @order_direction = %w[asc desc].include?(direction.to_s) ? direction.to_s : 'asc'
+        @order_direction = %w[asc desc].include?(direction.to_s) ? direction.to_s : "asc"
 
         @query[:order_direction] = @order_direction
 

data/lib/kaze_client/requests.rb

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
 # The base request object - for custom/newest APIs
-require_relative 'request/request'
+require_relative "request/request"
 
 # Modules included in requests
-require_relative 'request/requests/utils/authentified_request'
-require_relative 'request/requests/utils/list_request'
+require_relative "request/requests/utils/authentified_request"
+require_relative "request/requests/utils/list_request"
 
 # The base object for pre-crafted requests
-require_relative 'request/requests/utils/final_request'
+require_relative "request/requests/utils/final_request"
 
 # The pre-crafted requests
-require_relative 'request/requests/assign_performer_request'
-require_relative 'request/requests/partners_request'
-require_relative 'request/requests/create_job_request'
-require_relative 'request/requests/job_request'
-require_relative 'request/requests/job_workflow_request'
-require_relative 'request/requests/job_workflows_request'
-require_relative 'request/requests/jobs_request'
-require_relative 'request/requests/login_request'
-require_relative 'request/requests/profile_request'
-require_relative 'request/requests/update_template_request'
+require_relative "request/requests/assign_performer_request"
+require_relative "request/requests/companies_request"
+require_relative "request/requests/create_job_request"
+require_relative "request/requests/job_request"
+require_relative "request/requests/job_workflow_request"
+require_relative "request/requests/job_workflows_request"
+require_relative "request/requests/jobs_request"
+require_relative "request/requests/login_request"
+require_relative "request/requests/profile_request"
+require_relative "request/requests/update_template_request"

data/lib/kaze_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KazeClient
-  VERSION = '0.1.1p0'
+  VERSION = "0.1.1"
 end

data/lib/kaze_client.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 # I only need some very specific parts of activesupport.
-require 'activesupport/blank'
-require 'activesupport/camelize'
+require "activesupport/blank"
+require "activesupport/camelize"
 
 # Require HTTParty
-require 'httparty'
+require "httparty"
 
 # Require the version number
-require_relative 'kaze_client/version'
+require_relative "kaze_client/version"
 
 # Require the different parts of the gem
-require_relative 'kaze_client/errors'
-require_relative 'kaze_client/requests'
-require_relative 'kaze_client/response'
-require_relative 'kaze_client/client'
+require_relative "kaze_client/errors"
+require_relative "kaze_client/requests"
+require_relative "kaze_client/response"
+require_relative "kaze_client/client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kaze_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1p0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matthieu Ciappara
@@ -70,13 +70,13 @@ files:
 - lib/kaze_client/errors.rb
 - lib/kaze_client/request/request.rb
 - lib/kaze_client/request/requests/assign_performer_request.rb
+- lib/kaze_client/request/requests/companies_request.rb
 - lib/kaze_client/request/requests/create_job_request.rb
 - lib/kaze_client/request/requests/job_request.rb
 - lib/kaze_client/request/requests/job_workflow_request.rb
 - lib/kaze_client/request/requests/job_workflows_request.rb
 - lib/kaze_client/request/requests/jobs_request.rb
 - lib/kaze_client/request/requests/login_request.rb
-- lib/kaze_client/request/requests/partners_request.rb
 - lib/kaze_client/request/requests/profile_request.rb
 - lib/kaze_client/request/requests/update_template_request.rb
 - lib/kaze_client/request/requests/utils/authentified_request.rb
@@ -100,12 +100,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
 signing_key: