nokotime-ruby-client 0.1.0

data/lib/nokotime/request/multiple_pages.rb

@@ -0,0 +1,50 @@
+module Nokotime
+  module Request
+    class MultiplePages
+      attr_reader :path
+      attr_reader :params
+      attr_reader :last_responses
+
+      def get(path, params: {})
+        @path ||= path
+        @params ||= params.compact
+
+        retrieve_all_pages
+
+        self
+      end
+
+      private
+
+      def retrieve_all_pages
+        @last_responses ||= client.get_in_parallel(
+          path, 2, total_pages, params: params
+        )
+
+        @last_responses.unshift([@first_response])
+        @last_responses.flatten!
+      end
+
+      def total_pages
+        @total_pages ||= first_page.total_pages
+      end
+
+      def first_page
+        @first_page ||= first_single_page.get(
+          path, params: params
+        )
+        @first_response = @first_page.last_response
+
+        @first_page
+      end
+
+      def first_single_page
+        @first_single_page ||= SinglePage.new
+      end
+
+      def client
+        @client ||= Connection.new
+      end
+    end
+  end
+end

data/lib/nokotime/request/single_page.rb

@@ -0,0 +1,71 @@
+module Nokotime
+  module Request
+    class SinglePage
+      attr_reader :last_response
+      attr_reader :raw_links
+
+      def initialize
+        @last_response = nil
+        @raw_links = nil
+      end
+
+      def get(path, params: {}, request_options: {})
+        @last_response = client.get(
+          path,
+          params: params,
+          request_options: request_options
+        )
+
+        @raw_links = @last_response.headers["link"] || []
+
+        self
+      end
+
+      def next
+        next? ? get(paginator.next) : nil
+      end
+
+      def next?
+        paginator.next
+      end
+
+      def prev
+        prev? ? get(paginator.prev) : nil
+      end
+
+      def prev?
+        paginator.prev
+      end
+
+      def last
+        last? ? get(paginator.last) : nil
+      end
+
+      def last?
+        paginator.last
+      end
+
+      def first
+        first? ? get(paginator.first) : nil
+      end
+
+      def first?
+        paginator.first
+      end
+
+      def total_pages
+        paginator.total_pages.to_i
+      end
+
+      private
+
+      def paginator
+        @paginator = Paginator.new(raw_links)
+      end
+
+      def client
+        @client = Connection.new
+      end
+    end
+  end
+end

data/lib/nokotime/validator/entry_schema.rb

@@ -0,0 +1,74 @@
+module Nokotime
+  module Validator
+    # rubocop:disable Metrics/BlockLength
+    module EntrySchema
+      ENTRY_SCHEMA = Dry::Validation.Schema do
+        configure do
+          config.namespace = :entry
+          config.messages_file = File.join(__dir__, "validation.yml")
+
+          predicates(RestrictedHash)
+
+          def valid_tag_filter_type
+            %w(and combination of)
+          end
+
+          # rubocop:disable Metrics/MethodLength
+          def 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
+            )
+          end
+          # rubocop:enable Metrics/MethodLength
+        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
+      # rubocop:enable Metrics/BlockLength
+
+      def self.validate(attributes)
+        ENTRY_SCHEMA.call(attributes)
+      end
+    end
+  end
+end

data/lib/nokotime/validator/project_group_schema.rb

@@ -0,0 +1,28 @@
+module Nokotime
+  module Validator
+    module ProjectGroupSchema
+      PROJECT_GROUP_SCHEMA = Dry::Validation.Schema do
+        configure do
+          config.namespace = :project_group
+          config.messages_file = File.join(__dir__, "validation.yml")
+
+          predicates(RestrictedHash)
+
+          def allowed_keys
+            %i(name project_ids per_page)
+          end
+        end
+
+        restricted_hash?(allowed_keys) do
+          optional(:name).filled :str?
+          optional(:project_ids).filled :str?
+          optional(:per_page).filled :int?
+        end
+      end
+
+      def self.validate(attributes)
+        PROJECT_GROUP_SCHEMA.call(attributes)
+      end
+    end
+  end
+end

data/lib/nokotime/validator/project_schema.rb

@@ -0,0 +1,49 @@
+module Nokotime
+  module Validator
+    module ProjectSchema
+      PROJECT_SCHEMA = Dry::Validation.Schema do
+        configure do
+          config.namespace = :project
+          config.messages_file = File.join(__dir__, "validation.yml")
+
+          predicates(RestrictedHash)
+
+          def allowed_keys
+            %i(
+              name
+              project_group_ids
+              billing_increment
+              enabled
+              billable
+              per_page
+            )
+          end
+
+          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
+
+        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
+
+      def self.validate(attributes)
+        PROJECT_SCHEMA.call(attributes)
+      end
+    end
+  end
+end

data/lib/nokotime/validator/restricted_hash.rb

@@ -0,0 +1,11 @@
+module Nokotime
+  module Validator
+    module RestrictedHash
+      include Dry::Logic::Predicates
+
+      predicate(:restricted_hash?) do |allowed_keys, hash|
+        (hash.keys - allowed_keys).empty?
+      end
+    end
+  end
+end

data/lib/nokotime/validator/tag_schema.rb

@@ -0,0 +1,28 @@
+module Nokotime
+  module Validator
+    module TagSchema
+      TAG_SCHEMA = Dry::Validation.Schema do
+        configure do
+          config.namespace = :tag
+          config.messages_file = File.join(__dir__, "validation.yml")
+
+          predicates(RestrictedHash)
+
+          def allowed_keys
+            %i(name billable per_page)
+          end
+        end
+
+        restricted_hash?(allowed_keys) do
+          optional(:name).filled :str?
+          optional(:billable).filled :bool?
+          optional(:per_page).filled :int?
+        end
+      end
+
+      def self.validate(attributes)
+        TAG_SCHEMA.call(attributes)
+      end
+    end
+  end
+end

data/lib/nokotime/validator/user_schema.rb

@@ -0,0 +1,41 @@
+module Nokotime
+  module Validator
+    module UserSchema
+      USER_SCHEMA = Dry::Validation.Schema do
+        EMAIL_REGEX = /\A[^@\s]+@[^@\s]+\z/.freeze
+
+        configure do
+          config.namespace = :user
+          config.messages_file = File.join(__dir__, "validation.yml")
+
+          predicates(RestrictedHash)
+
+          def valid_roles
+            %w(supervisor leader coworker contractor)
+          end
+
+          def valid_states
+            %w(disabled pending active suspended)
+          end
+
+          def allowed_keys
+            %i(name email role state per_page)
+          end
+        end
+
+        restricted_hash?(allowed_keys) do
+          optional(:name).filled :str?
+          optional(:email).filled :str?
+          optional(:email).value(format?: EMAIL_REGEX)
+          optional(:role).value(included_in?: valid_roles)
+          optional(:state).value(included_in?: valid_states)
+          optional(:per_page).filled :int?
+        end
+      end
+
+      def self.validate(attributes)
+        USER_SCHEMA.call(attributes)
+      end
+    end
+  end
+end

data/lib/nokotime/validator/validation.yml

@@ -0,0 +1,14 @@
+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"

data/lib/nokotime/version.rb

@@ -0,0 +1,3 @@
+module Nokotime
+  VERSION = "0.1.0".freeze
+end

data/nokotime-ruby-client.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "nokotime/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nokotime-ruby-client"
+  spec.version       = Nokotime::VERSION
+  spec.authors       = ["Domenico Giuseppe Garofoli"]
+  spec.email         = ["sirion1987@gmail.com"]
+
+  spec.summary       = "Ruby client for Noko API."
+  spec.description   = "Ruby client for Noko API. #ruby #client #nokotime"
+  spec.homepage      = "https://github.com/sirion1987/nokotime-ruby-client"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-console"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "dotenv"
+  spec.add_runtime_dependency "dry-validation"
+  spec.add_runtime_dependency "faraday", ">= 0.15.2"
+  spec.add_runtime_dependency "faraday_middleware", ">= 0.12"
+  spec.add_runtime_dependency "typhoeus"
+end

metadata

@@ -0,0 +1,304 @@
+--- !ruby/object:Gem::Specification
+name: nokotime-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Domenico Giuseppe Garofoli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Ruby client for Noko API. #ruby #client #nokotime'
+email:
+- sirion1987@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.test.sample"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nokotime.rb
+- lib/nokotime/authentication.rb
+- lib/nokotime/client/entries.rb
+- lib/nokotime/client/project_groups.rb
+- lib/nokotime/client/projects.rb
+- lib/nokotime/client/tags.rb
+- lib/nokotime/client/users.rb
+- lib/nokotime/configuration.rb
+- lib/nokotime/connection.rb
+- lib/nokotime/errors/configuration.rb
+- lib/nokotime/errors/connection.rb
+- lib/nokotime/errors/invalid_params.rb
+- lib/nokotime/paginator.rb
+- lib/nokotime/request/multiple_pages.rb
+- lib/nokotime/request/single_page.rb
+- lib/nokotime/validator/entry_schema.rb
+- lib/nokotime/validator/project_group_schema.rb
+- lib/nokotime/validator/project_schema.rb
+- lib/nokotime/validator/restricted_hash.rb
+- lib/nokotime/validator/tag_schema.rb
+- lib/nokotime/validator/user_schema.rb
+- lib/nokotime/validator/validation.yml
+- lib/nokotime/version.rb
+- nokotime-ruby-client.gemspec
+homepage: https://github.com/sirion1987/nokotime-ruby-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for Noko API.
+test_files: []