freckle_io 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fc8caa12258554fc19ede9bc3e3c42c64fce818ac32e2e4b51184b797b05c11
-  data.tar.gz: 0576ac82dbd77449d34025630f69732f0c8752a212a1c378ea4658b5db123117
+  metadata.gz: '09c8ed65bf1bde96bbb41d1a60ec5efff20fb078663921277acddd6db61604fd'
+  data.tar.gz: a8c0b02dd374c6c479a0e22b491ae9e4b9c00dae960cacf23968fcee2ec954e5
 SHA512:
-  metadata.gz: 5f14ec28d9f6a33362e85e403c836a93291e44fa6625f85e26bd7c9ff0010d15216a8921173b0c09818e468b8ef1fdec451e6413dfaab838af01ed752c1e358d
-  data.tar.gz: 68c4df72922751e0cdfd019ec7ea0a4498308d20f1a75d679758d7d8796a214fd8bc6e855e5e81c7a2bf5a56eee0ec7c65d1c26c9157b00a5682f0365eec083f
+  metadata.gz: 5952aed31584850de9eb2164797d03dde8369a0d2a8204b635a7f17c49a29f0295693cfcc4733a4a76f9415b4fef72119e79ba3f6a7d0f70f05038c9446574bc
+  data.tar.gz: 5f8e1266dffb1b5c179e736a11f174fd69fed1f6f3632ac31e452f869b50fae1e1e1d7871ba07cebc7b0764280a5b66951fab68d3bbd5c616bca3f8c795d82c6

data/.rubocop.yml

@@ -1,7 +1,8 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
+  NewCops: enable
   Exclude:
     - "bin/**/*"
     - ".bundle/**/*"
@@ -10,15 +11,18 @@ AllCops:
     - "node_modules/**/*"
     - "**/*.gemspec"
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 Layout/DotPosition:
   EnforcedStyle: trailing
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
+Layout/LineLength:
+  Enabled: true
+  Max: 80
 
 Metrics/BlockLength:
-  ExcludedMethods:
+  AllowedPatterns:
     - context
     - describe
     - feature
@@ -28,8 +32,6 @@ Metrics/BlockLength:
     - namespace
     - draw
 
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
 Style/Documentation:
   Enabled: false
 Style/FrozenStringLiteralComment:

data/freckle-io.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name         = "freckle_io"
-  spec.version      = "0.1.1"
+  spec.version      = "1.0.0"
   spec.authors      = ["Domenico Giuseppe Garofoli"]
   spec.email        = ["sirion1987@gmail.com"]
 
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.license      = "MIT"
   spec.require_path = ["lib"]
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.files        = `git ls-files -z`.split("\x0")
   spec.test_files   = Dir["spec/**/*.rb"]
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_runtime_dependency "dotenv"
-  spec.add_runtime_dependency "dry-validation", "~> 0.13.0"
+  spec.add_runtime_dependency "dry-validation", "~> 1.9.0"
   spec.add_runtime_dependency "faraday", ">= 0.15.2"
   spec.add_runtime_dependency "faraday_middleware", ">= 0.12"
   spec.add_runtime_dependency "typhoeus"

data/lib/freckle_io/client/entries.rb

@@ -2,27 +2,6 @@ module FreckleIO
   module Client
     class Entries
       ENTRY_ENDPOINT = "/v2/entries".freeze
-      ALLOWED_KEYS = %i(
-        user_ids
-        description
-        project_ids
-        tag_ids
-        tag_filter_type
-        invoice_ids
-        import_ids
-        from
-        to
-        invoiced
-        invoiced_at_from
-        invoiced_at_to
-        updated_from
-        updated_to
-        billable
-        approved_at_from
-        approved_at_to
-        approved_by_ids
-        per_page
-      ).freeze
       VALIDATOR_MODULE = "FreckleIO::Validator::Entry".freeze
 
       def all(params = {})
@@ -42,11 +21,7 @@ module FreckleIO
       end
 
       def entry_params(params)
-        @entry_params = Params.new(
-          params,
-          ALLOWED_KEYS,
-          VALIDATOR_MODULE
-        ).call
+        @entry_params = Params.new(params, VALIDATOR_MODULE).call
       end
     end
   end

data/lib/freckle_io/client/project_groups.rb

@@ -2,7 +2,6 @@ module FreckleIO
   module Client
     class ProjectGroups
       PROJECT_GROUPS_ENDPOINT = "/v2/project_groups".freeze
-      ALLOWED_KEYS = %i(name project_ids per_page).freeze
       VALIDATOR_MODULE = "FreckleIO::Validator::ProjectGroup".freeze
 
       def all(params = {})
@@ -27,7 +26,6 @@ module FreckleIO
       def project_groups_params(params)
         @project_groups_params = Params.new(
           params,
-          ALLOWED_KEYS,
           VALIDATOR_MODULE
         ).call
       end

data/lib/freckle_io/client/projects.rb

@@ -2,14 +2,6 @@ module FreckleIO
   module Client
     class Projects
       PROJECT_ENDPOINT = "/v2/projects".freeze
-      ALLOWED_KEYS = %i(
-        name
-        project_group_ids
-        billing_increment
-        enabled
-        billable
-        per_page
-      ).freeze
       VALIDATOR_MODULE = "FreckleIO::Validator::Project".freeze
 
       def all(params = {})
@@ -31,11 +23,7 @@ module FreckleIO
       end
 
       def project_params(params)
-        @project_params = Params.new(
-          params,
-          ALLOWED_KEYS,
-          VALIDATOR_MODULE
-        ).call
+        @project_params = Params.new(params, VALIDATOR_MODULE).call
       end
     end
   end

data/lib/freckle_io/client/tags.rb

@@ -2,7 +2,6 @@ module FreckleIO
   module Client
     class Tags
       TAG_ENDPOINT = "/v2/tags".freeze
-      ALLOWED_KEYS = %i(name billable per_page).freeze
       VALIDATOR_MODULE = "FreckleIO::Validator::Tag".freeze
 
       def all(params = {})
@@ -22,11 +21,7 @@ module FreckleIO
       end
 
       def tag_params(params)
-        @tag_params = Params.new(
-          params,
-          ALLOWED_KEYS,
-          VALIDATOR_MODULE
-        ).call
+        @tag_params = Params.new(params, VALIDATOR_MODULE).call
       end
     end
   end

data/lib/freckle_io/client/users.rb

@@ -2,7 +2,6 @@ module FreckleIO
   module Client
     class Users
       USER_ENDPOINT = "/v2/users".freeze
-      ALLOWED_KEYS = %i(name email role state per_page).freeze
       VALIDATOR_MODULE = "FreckleIO::Validator::User".freeze
 
       def all(params = {})
@@ -24,11 +23,7 @@ module FreckleIO
       end
 
       def user_params(params)
-        @user_params = Params.new(
-          params,
-          ALLOWED_KEYS,
-          VALIDATOR_MODULE
-        ).call
+        @user_params = Params.new(params, VALIDATOR_MODULE).call
       end
     end
   end

data/lib/freckle_io/configuration.rb

@@ -6,11 +6,11 @@ module FreckleIO
 
     DEFAULT_URL = "https://api.nokotime.com/v2".freeze
 
-    attr_writer :auth_type
-    attr_writer :token
-    attr_writer :url
-    attr_writer :per_page
-    attr_writer :max_concurrency
+    attr_writer :auth_type,
+                :token,
+                :url,
+                :per_page,
+                :max_concurrency
 
     def initialize
       @token = nil

data/lib/freckle_io/connection.rb

@@ -8,13 +8,11 @@ module FreckleIO
 
     # rubocop:disable Metrics/MethodLength
     def get(path, params: {}, request_options: {})
-      response = connection.get do |request|
+      connection.get do |request|
         authorize_request(request)
         set_request_options(request, request_options)
         request.url path, params
       end
-
-      response
     rescue Faraday::ConnectionFailed => e
       raise Errors::Connection::Failed.new(e), e.message
     rescue Faraday::ResourceNotFound => e

data/lib/freckle_io/params.rb

@@ -1,21 +1,18 @@
 module FreckleIO
   class Params
-    attr_reader :params
-    attr_reader :allowed_keys
-    attr_reader :validator_module
+    attr_reader :params,
+                :validator_module
 
     def initialize(
       params,
-      allowed_keys,
       validator_module
     )
       @params = params
-      @allowed_keys = allowed_keys
       @validator_module = validator_module
     end
 
     def call
-      return validator.output if valid?
+      return validator.to_h if valid?
 
       raise Errors::Params::InvalidParams.new, validator_messages
     end
@@ -27,7 +24,7 @@ module FreckleIO
     end
 
     def validator
-      @validator ||= which_validator_module.validation(params, allowed_keys)
+      @validator ||= which_validator_module.new.call(params)
     end
 
     def which_validator_module
@@ -37,9 +34,7 @@ module FreckleIO
     end
 
     def validator_messages
-      messages = validator.messages(full: true)
-      return messages.values.join(",") if messages.is_a?(Hash)
-
+      messages = validator.errors(full: true).messages
       messages.join(",")
     end
   end

data/lib/freckle_io/request/multiple_pages.rb

@@ -3,9 +3,9 @@ require "faraday_middleware"
 module FreckleIO
   module Request
     class MultiplePages
-      attr_reader :path
-      attr_reader :params
-      attr_reader :last_responses
+      attr_reader :path,
+                  :params,
+                  :last_responses
 
       def get(path, params: {})
         @path ||= path

data/lib/freckle_io/request/single_page.rb

@@ -3,8 +3,8 @@ require "freckle_io/paginator"
 module FreckleIO
   module Request
     class SinglePage
-      attr_reader :last_response
-      attr_reader :raw_links
+      attr_reader :last_response,
+                  :raw_links
 
       def initialize
         @last_response = nil

data/lib/freckle_io/validator/base_contract.rb

@@ -0,0 +1,16 @@
+module FreckleIO
+  module Validator
+    class BaseContract < Dry::Validation::Contract
+      EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i.freeze
+
+      config.messages.backend = :i18n
+      config.messages.load_paths << File.join(__dir__, "validation.yml")
+
+      register_macro(:email_format) do
+        if !value.nil? && !EMAIL_REGEX.match?(value)
+          key.failure(:invalid_email_format)
+        end
+      end
+    end
+  end
+end

data/lib/freckle_io/validator/entry.rb

@@ -1,57 +1,33 @@
 module FreckleIO
   module Validator
-    module Entry
-      # rubocop:disable Metrics/MethodLength,
-      # rubocop:disable Metrics/AbcSize,
-      # rubocop:disable Lint/NestedMethodDefinition
-      # rubocop:disable Metrics/BlockLength,
-      def self.validation(params, valid_keys)
-        Dry::Validation.Schema do
-          configure do
-            config.messages_file = File.join(
-              __dir__, "validation.yml"
-            )
-            config.namespace = :entry
-
-            predicates(RestrictedHash)
-
-            option :allowed_keys
-
-            def valid_tag_filter_type
-              ["and", "combination of"]
-            end
-          end
+    class Entry < FreckleIO::Validator::BaseContract
+      schema do
+        optional(:user_ids).filled(:string)
+        optional(:description).filled(:string)
+        optional(:project_ids).filled(:string)
+        optional(:tag_ids).filled(:string)
+        optional(:tag_filter_type).filled(:string)
+        optional(:invoice_ids).filled(:string)
+        optional(:import_ids).filled(:string)
+        optional(:from).filled(:string)
+        optional(:to).filled(:string)
+        optional(:invoiced).filled(:bool)
+        optional(:invoiced_at_from).filled(:string)
+        optional(:invoiced_at_to).filled(:string)
+        optional(:updated_from).filled(:string)
+        optional(:updated_to).filled(:string)
+        optional(:billable).filled(:bool)
+        optional(:approved_at_from).filled(:string)
+        optional(:approved_at_to).filled(:string)
+        optional(:approved_by_ids).filled(:string)
+        optional(:per_page).filled(:integer)
+      end
 
-          restricted_hash?(allowed_keys) do
-            optional(:user_ids).filled :str?
-            optional(:description).filled :str?
-            optional(:project_ids).filled :str?
-            optional(:tag_ids).filled :str?
-            optional(:tag_filter_type).filled :str?
-            optional(
-              :tag_filter_type
-            ).value(included_in?: valid_tag_filter_type)
-            optional(:invoice_ids).filled :str?
-            optional(:import_ids).filled :str?
-            optional(:from).filled :str?
-            optional(:to).filled :str?
-            optional(:invoiced).filled :bool?
-            optional(:invoiced_at_from).filled :str?
-            optional(:invoiced_at_to).filled :str?
-            optional(:updated_from).filled :str?
-            optional(:updated_to).filled :str?
-            optional(:billable).filled :bool?
-            optional(:approved_at_from).filled :str?
-            optional(:approved_at_to).filled :str?
-            optional(:approved_by_ids).filled :str?
-            optional(:per_page).filled :int?
-          end
-        end.with(allowed_keys: valid_keys).call(params)
+      rule(:tag_filter_type) do
+        if !value.nil? && !["and", "combination of"].include?(value)
+          key.failure(:invalid_tag_filter_type)
+        end
       end
-      # rubocop:enable Metrics/MethodLength,
-      # rubocop:enable Metrics/AbcSize,
-      # rubocop:enable Lint/NestedMethodDefinition
-      # rubocop:enable Metrics/BlockLength,
     end
   end
 end

data/lib/freckle_io/validator/project.rb

@@ -1,46 +1,20 @@
 module FreckleIO
   module Validator
-    module Project
-      # rubocop:disable Metrics/MethodLength,
-      # rubocop:disable Metrics/AbcSize,
-      # rubocop:disable Lint/NestedMethodDefinition
-      def self.validation(params, valid_keys)
-        Dry::Validation.Schema do
-          configure do
-            config.messages_file = File.join(
-              __dir__, "validation.yml"
-            )
-            config.namespace = :project
-
-            predicates(RestrictedHash)
-
-            option :allowed_keys
-
-            def valid_increment
-              %w(1 5 6 10 15)
-            end
-
-            def valid_increment?(_options, values)
-              values.split(",").all? do |value|
-                valid_increment.include?(value)
-              end
-            end
-          end
+    class Project < FreckleIO::Validator::BaseContract
+      schema do
+        optional(:name).filled(:string)
+        optional(:project_group_ids).filled(:string)
+        optional(:billing_increment).filled(:string)
+        optional(:enabled).filled(:bool)
+        optional(:billable).filled(:bool)
+        optional(:per_page).filled(:integer)
+      end
 
-          restricted_hash?(allowed_keys) do
-            optional(:name).filled :str?
-            optional(:project_group_ids).filled :str?
-            optional(:billing_increment).filled :str?
-            optional(:billing_increment).filled(valid_increment?: {})
-            optional(:enabled).filled :bool?
-            optional(:billable).filled :bool?
-            optional(:per_page).filled :int?
-          end
-        end.with(allowed_keys: valid_keys).call(params)
+      rule(:billing_increment) do
+        if !value.nil? && !%w(1 5 6 10 15).include?(value)
+          key.failure(:invalid_billing_increment)
+        end
       end
-      # rubocop:enable Metrics/MethodLength,
-      # rubocop:enable Metrics/AbcSize,
-      # rubocop:enable Lint/NestedMethodDefinition
     end
   end
 end

data/lib/freckle_io/validator/project_group.rb

@@ -1,30 +1,11 @@
 module FreckleIO
   module Validator
-    module ProjectGroup
-      # rubocop:disable Metrics/MethodLength,
-      # rubocop:disable Metrics/AbcSize,
-      def self.validation(params, valid_keys)
-        Dry::Validation.Schema do
-          configure do
-            config.messages_file = File.join(
-              __dir__, "validation.yml"
-            )
-            config.namespace = :project_group
-
-            predicates(RestrictedHash)
-
-            option :allowed_keys
-          end
-
-          restricted_hash?(allowed_keys) do
-            optional(:name).filled :str?
-            optional(:project_ids).filled :str?
-            optional(:per_page).filled :int?
-          end
-        end.with(allowed_keys: valid_keys).call(params)
+    class ProjectGroup < FreckleIO::Validator::BaseContract
+      schema do
+        optional(:name).filled(:string)
+        optional(:project_ids).filled(:string)
+        optional(:per_page).filled(:integer)
       end
-      # rubocop:enable Metrics/MethodLength,
-      # rubocop:enable Metrics/AbcSize,
     end
   end
 end

data/lib/freckle_io/validator/tag.rb

@@ -1,30 +1,11 @@
 module FreckleIO
   module Validator
-    module Tag
-      # rubocop:disable Metrics/MethodLength,
-      # rubocop:disable Metrics/AbcSize,
-      def self.validation(params, valid_keys)
-        Dry::Validation.Schema do
-          configure do
-            config.messages_file = File.join(
-              __dir__, "validation.yml"
-            )
-            config.namespace = :tag
-
-            predicates(RestrictedHash)
-
-            option :allowed_keys
-          end
-
-          restricted_hash?(allowed_keys) do
-            optional(:name).filled :str?
-            optional(:billable).filled :bool?
-            optional(:per_page).filled :int?
-          end
-        end.with(allowed_keys: valid_keys).call(params)
+    class Tag < FreckleIO::Validator::BaseContract
+      schema do
+        optional(:name).filled(:string)
+        optional(:billable).filled(:bool)
+        optional(:per_page).filled(:integer)
       end
-      # rubocop:enable Metrics/MethodLength,
-      # rubocop:enable Metrics/AbcSize,
     end
   end
 end

data/lib/freckle_io/validator/user.rb

@@ -1,43 +1,19 @@
 module FreckleIO
   module Validator
-    module User
-      # rubocop:disable Metrics/MethodLength,
-      # rubocop:disable Metrics/AbcSize,
-      # rubocop:disable Lint/NestedMethodDefinition
-      def self.validation(params, valid_keys)
-        Dry::Validation.Schema do
-          configure do
-            config.messages_file = File.join(
-              __dir__, "validation.yml"
-            )
-            config.namespace = :user
-
-            predicates(RestrictedHash)
-
-            option :allowed_keys
-
-            def valid_roles
-              %w(supervisor leader coworker contractor)
-            end
-
-            def valid_states
-              %w(disabled pending active suspended)
-            end
-          end
-
-          restricted_hash?(allowed_keys) do
-            optional(:name).filled :str?
-            optional(:email).filled :str?
-            optional(:email).value(format?: /\A[^@\s]+@[^@\s]+\z/)
-            optional(:role).value(included_in?: valid_roles)
-            optional(:state).value(included_in?: valid_states)
-            optional(:per_page).filled :int?
-          end
-        end.with(allowed_keys: valid_keys).call(params)
+    class User < FreckleIO::Validator::BaseContract
+      schema do
+        optional(:name).filled(:string)
+        optional(:email).filled(:string)
+        optional(:per_page).filled(:integer)
+        optional(:role).value(
+          included_in?: %w(supervisor leader coworker contractor)
+        )
+        optional(:state).value(
+          included_in?: %w(disabled pending active suspended)
+        )
       end
-      # rubocop:enable Metrics/MethodLength,
-      # rubocop:enable Metrics/AbcSize,
-      # rubocop:enable Lint/NestedMethodDefinition
+
+      rule(:email).validate(:email_format)
     end
   end
 end

data/lib/freckle_io/validator/validation.yml

@@ -1,14 +1,9 @@
 en:
-  errors:
-    rules:
-      user:
-        restricted_hash?: "has unknown keys. Allowed keys are: name, email, role, state and per_page"
-      project:
-        restricted_hash?: "has unknown keys. Allowed keys are: name, project_group_ids, billing_increment, enabled, billable and per_page"
-        valid_increment?: "has invalid values. Allowed values are: 1, 5, 6, 10, 15"
-      entry:
-        restricted_hash?: "has unknown keys. Allowed keys are: user_ids, description, project_ids, tag_ids, tag_filter_type, invoice_ids, import_ids, from, to, invoiced, invoice_at_from, invoice_at_to, updated_from, updated_to, billable, approved_at_from, approved_at_to, approved_by_ids and per_page"
-      tag:
-        restricted_hash?: "has unknown keys. Allowed keys are: name, billable and per_page"
-      project_group:
-        restricted_hash?: "has unknown keys. Allowed keys are: name, project ids and per_page"
+  dry_validation:
+    errors:
+      invalid_email_format: "not a valid email format"
+      rules:
+        billing_increment:
+          invalid_billing_increment: "has invalid values. Allowed values are: 1, 5, 6, 10, 15"
+        tag_filter_type:
+          invalid_tag_filter_type: "has invalid values. Allowed values are: and, combination of"

data/lib/freckle_io.rb

@@ -8,7 +8,7 @@ require "freckle_io/errors/connection"
 require "freckle_io/errors/params"
 require "freckle_io/request/multiple_pages"
 require "freckle_io/request/single_page"
-require "freckle_io/validator/restricted_hash"
+require "freckle_io/validator/base_contract"
 require "freckle_io/validator/user"
 require "freckle_io/validator/project"
 require "freckle_io/validator/entry"