freckle_io 0.0.3

data/lib/freckle_io/configuration.rb

@@ -0,0 +1,48 @@
+require "freckle_io/authentication"
+
+module FreckleIO
+  class Configuration
+    include Authentication
+
+    DEFAULT_URL = "https://api.letsfreckle.com/v2".freeze
+
+    attr_writer :auth_type
+    attr_writer :token
+    attr_writer :url
+    attr_writer :per_page
+    attr_writer :max_concurrency
+
+    def initialize
+      @token = nil
+    end
+
+    def auth_type
+      unless valid_auth?(@auth_type)
+        raise(
+          Errors::Configuration,
+          "#{@auth_type} isn't valid type authentication"
+        )
+      end
+
+      @auth_type || raise(Errors::Configuration, "Authentication type missing!")
+    end
+
+    def token
+      @token || raise(Errors::Configuration, "Token missing!")
+    end
+
+    def url
+      @url || self.class::DEFAULT_URL
+    end
+
+    def per_page
+      @per_page || nil
+    end
+
+    def max_concurrency
+      @max_concurrency || raise(
+        Errors::Configuration, "Max concurrency missing!"
+      )
+    end
+  end
+end

data/lib/freckle_io/connection.rb

@@ -0,0 +1,80 @@
+require "freckle_io/authentication"
+require "faraday"
+require "faraday_middleware"
+
+module FreckleIO
+  class Connection
+    include FreckleIO::Authentication
+
+    # rubocop:disable Metrics/MethodLength
+    def get(path, params: {}, request_options: {})
+      response = 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
+      raise Errors::Connection::ResourceNotFound.new(e), e.message
+    rescue Faraday::ClientError => e
+      raise Errors::Connection::ClientError.new(e), e.message
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def get_in_parallel(
+      path,
+      from_page_number,
+      to_page_number,
+      params: {},
+      request_options: {}
+    )
+      responses = []
+
+      connection.in_parallel(manager) do
+        (from_page_number..to_page_number).each do |page|
+          merged_params = {page: page}.merge(params)
+
+          responses << get(
+            path, params: merged_params, request_options: request_options
+          )
+        end
+      end
+
+      responses
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(default_options) do |connection|
+        connection.request  :json
+        connection.response :json, content_type: /\bjson$/
+        connection.response :raise_error
+        connection.adapter  :typhoeus
+      end
+    end
+
+    def default_options
+      {
+        url: FreckleIO.configuration.url,
+        headers: {
+          user_agent: "MyFreckleBot/1.0"
+        }
+      }
+    end
+
+    def set_request_options(request, options)
+      request.options.timeout = options[:timeout]
+      request.options.open_timeout = options[:open_timeout]
+    end
+
+    def manager
+      @manager ||= Typhoeus::Hydra.new(
+        max_concurrency: FreckleIO.configuration.max_concurrency
+      )
+    end
+  end
+end

data/lib/freckle_io/errors/configuration.rb

@@ -0,0 +1,5 @@
+module FreckleIO
+  module Errors
+    class Configuration < StandardError; end
+  end
+end

data/lib/freckle_io/errors/connection.rb

@@ -0,0 +1,9 @@
+module FreckleIO
+  module Errors
+    module Connection
+      class Failed < StandardError; end
+      class ResourceNotFound < StandardError; end
+      class ClientError < StandardError; end
+    end
+  end
+end

data/lib/freckle_io/errors/params.rb

@@ -0,0 +1,8 @@
+module FreckleIO
+  module Errors
+    module Params
+      class InvalidParams < StandardError; end
+      class InvalidModule < StandardError; end
+    end
+  end
+end

data/lib/freckle_io/paginator.rb

@@ -0,0 +1,70 @@
+require "uri"
+require "cgi"
+
+module FreckleIO
+  class Paginator
+    attr_reader :raw_links
+
+    def initialize(raw_links)
+      @raw_links = raw_links
+    end
+
+    def next
+      find("next")&.dig(:url)
+    end
+
+    def prev
+      find("prev")&.dig(:url)
+    end
+
+    def first
+      find("first")&.dig(:url)
+    end
+
+    def last
+      find("last")&.dig(:url)
+    end
+
+    def total_pages
+      find("last")&.dig(:number_page)
+    end
+
+    private
+
+    def find(rel)
+      pages.find { |page| page[:rel] == rel }
+    end
+
+    def pages
+      return {} if raw_links.empty?
+
+      @pages ||=
+        raw_links.split(",").map do |link|
+          url, rel, number_page = split_and_clean_link(link)
+
+          {
+            url: "#{url.path}?#{url.query}",
+            rel: rel,
+            number_page: number_page
+          }
+        end
+    end
+
+    # Example of link response headers:
+    # "<https://api.letsfreckle.com/v2/users?page=2>; rel=\"last\""
+    #
+    # The first element is an URI. "Rel" means the relative position
+    # of the current page, in this case is last page.
+
+    def split_and_clean_link(link)
+      raw_url, rel = link.split(";").map(&:strip)
+
+      raw_url = raw_url.gsub(/<|>/, "")
+      rel = rel.gsub(/(rel=)?"/, "")
+      url = URI.parse(raw_url)
+      page = CGI.parse(url.query)["page"].first
+
+      [url, rel, page]
+    end
+  end
+end

data/lib/freckle_io/params.rb

@@ -0,0 +1,46 @@
+module FreckleIO
+  class Params
+    attr_reader :params
+    attr_reader :allowed_keys
+    attr_reader :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?
+
+      raise Errors::Params::InvalidParams.new, validator_messages
+    end
+
+    private
+
+    def valid?
+      validator.errors.empty?
+    end
+
+    def validator
+      @validator ||= which_validator_module.validation(params, allowed_keys)
+    end
+
+    def which_validator_module
+      Kernel.const_get(validator_module)
+    rescue NameError => e
+      raise Errors::Params::InvalidModule.new(e), e.message
+    end
+
+    def validator_messages
+      messages = validator.messages(full: true)
+      return messages.values.join(",") if messages.is_a?(Hash)
+
+      messages.join(",")
+    end
+  end
+end

data/lib/freckle_io/request/multiple_pages.rb

@@ -0,0 +1,62 @@
+require "faraday_middleware"
+
+module FreckleIO
+  module Request
+    class MultiplePages
+      attr_reader :path
+      attr_reader :params
+      attr_reader :last_responses
+
+      def get(path, params: {})
+        @path ||= path
+        @params ||= default_params.merge(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
+
+      def default_params
+        {
+          per_page: FreckleIO.configuration.per_page
+        }
+      end
+    end
+  end
+end

data/lib/freckle_io/request/single_page.rb

@@ -0,0 +1,73 @@
+require "freckle_io/paginator"
+
+module FreckleIO
+  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/freckle_io/validator/entry.rb

@@ -0,0 +1,57 @@
+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
+
+          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)
+      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

@@ -0,0 +1,46 @@
+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
+
+          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)
+      end
+      # rubocop:enable Metrics/MethodLength,
+      # rubocop:enable Metrics/AbcSize,
+      # rubocop:enable Lint/NestedMethodDefinition
+    end
+  end
+end

data/lib/freckle_io/validator/project_group.rb

@@ -0,0 +1,30 @@
+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)
+      end
+      # rubocop:enable Metrics/MethodLength,
+      # rubocop:enable Metrics/AbcSize,
+    end
+  end
+end

data/lib/freckle_io/validator/restricted_hash.rb

@@ -0,0 +1,11 @@
+module FreckleIO
+  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/freckle_io/validator/tag.rb

@@ -0,0 +1,30 @@
+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)
+      end
+      # rubocop:enable Metrics/MethodLength,
+      # rubocop:enable Metrics/AbcSize,
+    end
+  end
+end

data/lib/freckle_io/validator/user.rb

@@ -0,0 +1,43 @@
+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)
+      end
+      # rubocop:enable Metrics/MethodLength,
+      # rubocop:enable Metrics/AbcSize,
+      # rubocop:enable Lint/NestedMethodDefinition
+    end
+  end
+end

data/lib/freckle_io/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/freckle_io.rb

@@ -0,0 +1,35 @@
+require "dry-validation"
+
+require "freckle_io/configuration"
+require "freckle_io/connection"
+require "freckle_io/params"
+require "freckle_io/errors/configuration"
+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/user"
+require "freckle_io/validator/project"
+require "freckle_io/validator/entry"
+require "freckle_io/validator/tag"
+require "freckle_io/validator/project_group"
+require "freckle_io/client/users"
+require "freckle_io/client/projects"
+require "freckle_io/client/entries"
+require "freckle_io/client/tags"
+require "freckle_io/client/project_groups"
+
+module FreckleIO
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end