kaze_client 0.1.1

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module KazeClient
+  module Utils
+    # @author ciappa_m@modulotech.fr
+    # Included by the request where a list will be returned.
+    # @see KazeClient::Request
+    module ListRequest
+      # @return [Integer,String] The page to fetch.
+      attr_reader :page
+
+      # @return [Integer] The number of items to fetch by page; between 1 and 100.
+      attr_reader :per_page
+
+      # @return [String] The field to use for the list order.
+      attr_reader :order_field
+
+      # @return ['asc', 'desc'] The direction of the order.
+      attr_reader :order_direction
+
+      # @return [Hash] The filters to apply to the query.
+      attr_reader :filters
+
+      def initialize(method, url)
+        super(method, url)
+
+        @query   ||= {}
+        @filters ||= {}
+      end
+
+      # @param page [Integer,String] Set the page to fetch
+      # @return [KazeClient::Utils::ListRequest] self (to chain methods)
+      def add_page(page)
+        # Ensure the +per_page+ parameter is valid; default is 1
+        @page = if !page.is_a?(Numeric) || page.to_i < 1
+                  1
+                else
+                  page
+                end
+
+        @query[:page] = @page
+
+        self
+      end
+
+      # @param per_page [Integer,String] Set the number of items to fetch per page
+      # @return [KazeClient::Utils::ListRequest] self (to chain methods)
+      def add_per_page(per_page)
+        # Ensure the +per_page+ parameter is between 1 and 100
+        @per_page = if !per_page.is_a?(Numeric) || per_page.to_i < 1
+                      1
+                    elsif per_page > 100
+                      100
+                    else
+                      per_page
+                    end
+
+        @query[:per_page] = @per_page
+
+        self
+      end
+
+      # @param field [String] Set the field to use for the list order
+      # @return [KazeClient::Utils::ListRequest] self (to chain methods)
+      def add_order_field(field)
+        @order_field         = field
+        @query[:order_field] = @order_field
+
+        self
+      end
+
+      # @param direction ['asc','desc'] Set the direction of the order.
+      # @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"
+
+        @query[:order_direction] = @order_direction
+
+        self
+      end
+
+      # @!method filter_by_id(value)
+      #   This is an example. Any method beginning with +filter_by_+ is valid and defined using
+      #   +method_missing+. This adds a filter on the string following +filter_by_+ to the query.
+      #   @param value [String] Add a filter to the query.
+      #   @return [KazeClient::Utils::ListRequest] self (to chain methods)
+      #   @example To filter on id then on name
+      #     filter_by_id(2).filter_by_name('foo')
+      def method_missing(method_name, *args, &block)
+        match_data = method_name.match(/^filter_by_(\w+)/)
+
+        # Match_data[0] is the whole match while match_data[1] is the first capture group; here
+        # it is the field to filter on.
+        # Only the first given argument is considered to be the value to filter on. Possible
+        # subsequent arguments are ignored.
+        match_data ? filter_by(match_data[1], args[0]) : super
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        method_name.match?(/^filter_by_/) || super
+      end
+
+      private
+
+      def filter_by(field, value)
+        # Initialize the filters Hash if needed
+        # @filters ||= {}
+
+        # Store the filter
+        @filters[field] = value
+
+        # Set the filter on the query parameters
+        @query["filter[#{field}]"] = value
+
+        self
+      end
+    end
+  end
+end

data/lib/kaze_client/requests.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# The base request object - for custom/newest APIs
+require_relative "request/request"
+
+# Modules included in requests
+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"
+
+# The pre-crafted requests
+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/response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author ciappa_m@modulotech.fr
+  # Represents response from a Kaze API
+  # @see KazeClient::Client
+  # @see KazeClient::Request
+  # @since 0.1.0
+  class Response
+    # @return [HTTParty::Response] The response object from HTTParty call
+    attr_reader :original_response
+
+    # @return [Hash] The JSON object resulting from HTTParty parsed response
+    attr_reader :parsed_response
+
+    # @param response [HTTParty::Response] The response object from HTTParty call
+    def initialize(response)
+      @original_response = response
+      @parsed_response   = response.parsed_response
+    end
+
+    def method_missing(method_name, *args, &block)
+      if %i[original_response parsed_response].include?(method_name)
+        send(method_name)
+      else
+        @parsed_response.send(method_name, *args, &block)
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      %i[original_response parsed_response].include?(method_name) || super
+    end
+  end
+end

data/lib/kaze_client/version.rb

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

data/lib/kaze_client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# I only need some very specific parts of activesupport.
+require "activesupport/blank"
+require "activesupport/camelize"
+
+# Require HTTParty
+require "httparty"
+
+# Require the version number
+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"

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: kaze_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthieu Ciappara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: |
+  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.
+email:
+- ciappa_m@modulotech.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kaze_client.gemspec
+- lib/activesupport/blank.rb
+- lib/activesupport/camelize.rb
+- lib/kaze_client.rb
+- lib/kaze_client/client.rb
+- lib/kaze_client/error/disabled_account.rb
+- lib/kaze_client/error/forbidden.rb
+- lib/kaze_client/error/generic.rb
+- lib/kaze_client/error/internal_server_error.rb
+- lib/kaze_client/error/invalid_credentials.rb
+- lib/kaze_client/error/no_endpoint.rb
+- lib/kaze_client/error/no_private_token.rb
+- lib/kaze_client/error/not_found.rb
+- lib/kaze_client/error/unauthorized.rb
+- 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/profile_request.rb
+- lib/kaze_client/request/requests/update_template_request.rb
+- lib/kaze_client/request/requests/utils/authentified_request.rb
+- lib/kaze_client/request/requests/utils/final_request.rb
+- lib/kaze_client/request/requests/utils/list_request.rb
+- lib/kaze_client/requests.rb
+- lib/kaze_client/response.rb
+- lib/kaze_client/version.rb
+homepage: https://github.com/moduloTech/kaze_client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moduloTech/kaze_client
+  source_code_uri: https://github.com/moduloTech/kaze_client
+  changelog_uri: https://github.com/moduloTech/kaze_client/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: This is the official Ruby client library for Kaze API.
+test_files: []