researchable-freedcamp-api 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ad49b10c4da65d1a26113907ba125c2028abe47fef02f1f81c7e10d8f3f988a
-  data.tar.gz: bdff27b7cc946fbe620ecaced671ced639e30c805ddcc463cd06026709971111
+  metadata.gz: 8548577689d043fe6092a9e0ae799567f47d84e0c6e69328c60672d55c4c5572
+  data.tar.gz: 6862254a6953128dd131af3e79b30c3db0c7f2b653030dbbcf68ef5322b0df47
 SHA512:
-  metadata.gz: 4547b1347784513899432b34aee63de5bce20f8922e32c6f9b151b3c36a4bd3f10092a00f77b7f33b94d9c266879f38336bf04587964689d5324b4285606c7f6
-  data.tar.gz: dce7e0ae7cd0a45c2f72168dea410a3c47a1b516ea5b4882eeb2ed36116c8163cd999e4dcf0083737bbbf9d91cd5146fd5cc4db579844fb24202d6bcbef28d00
+  metadata.gz: 3b8f801e3292b50c989717d5b7306afc4ccafac6901c2f0bdc0ddce5591ab4e592ee394e6f06ffada6107d498cb1ecfb0d0271c45770ce993d6c91138a3857be
+  data.tar.gz: c47b871a253656a2d3e78e819d279f3a66a616bfac2afa1e5034acb98b4547da052003184322e92d4436bc22429479a109252c9fad119f9606423fcb7061eba2

data/lib/researchable/freedcamp_api/constants.rb

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Researchable
+  module FreedcampApi
+    APP_WALL = 1
+    APP_TODOS = 2
+    APP_DISCUSSIONS = 3
+    APP_MILESTONES = 4
+    APP_TIME = 5
+    APP_FILES = 6
+    APP_INVOICES = 7
+    APP_BUGTRACKER = 13
+    APP_WIKI = 14
+    APP_CRM = 16
+    APP_PASSMAN = 17
+    APP_TASKY = 18
+    APP_CALENDAR = 19
+    APP_INVOICESPLUS = 20
+    MODULE_GDOCS = 21
+    MODULE_PROJ_CLONING = 22
+
+    PROGRESS_NO_PROGRESS = 0
+    PROGRESS_IN_PROGRESS = 2
+    PROGRESS_COMPLETED = 1
+
+    STATUS_NOT_STARTED = 0
+    STATUS_COMPLETED = 1
+    STATUS_IN_PROGRESS = 2
+    STATUS_INVALID = 3
+    STATUS_REVIEW = 4
+  end
+end

data/lib/researchable/freedcamp_api/endpoint.rb

@@ -23,7 +23,7 @@ module Researchable
 
         while has_more
           temp = yield limit, offset
-          has_more = T.let(temp.dig('data', 'meta', 'has_more') == 'true', T::Boolean)
+          has_more = T.let(temp.dig('data', 'meta', 'has_more') == true, T::Boolean)
           result += temp['data'][keyword]
           offset += limit
         end

data/lib/researchable/freedcamp_api/get_user.rb

@@ -0,0 +1,20 @@
+# typed: false
+module Researchable
+  module FreedcampApi
+    class GetUser < Endpoint
+      string :user_id, default: 'current'
+      # @api private
+      def execute
+        get_user(user_id)
+      end
+
+      #sig do
+        #params().returns(
+        #)
+      #end
+      def get_user(task_id)
+        session.get("/users/#{task_id}")['data']
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/list_lists.rb

@@ -0,0 +1,37 @@
+# typed: false
+module Researchable
+  module FreedcampApi
+    class ListLists < Endpoint
+      string :project_id, default: nil
+      integer :app_id, default: Researchable::FreedcampApi::APP_TODOS
+      # @api private
+      def execute
+        check_app_id(app_id)
+        list_lists(app_id, project_id)
+      end
+
+      private
+
+      def check_app_id(app_id)
+        return if allowed_apps.include? app_id
+
+        raise "app_id not allowed: #{app_id} not in #{allowed_apps}"
+      end
+
+      def allowed_apps
+        [APP_TODOS, APP_FILES, APP_DISCUSSIONS, APP_WIKI, APP_PASSMAN]
+      end
+
+      def list_lists(app_id, project_id)
+        project_id_query = project_id ? "&project_id=#{project_id}" : ''
+        fetch_all('lists') do |limit, offset|
+          url = "/lists/#{app_id}
+                  ?limit=#{limit}
+                  &offset=#{offset}
+                   #{project_id_query}"
+          session.get(url)
+        end
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/list_projects.rb

@@ -1 +1,33 @@
-# typed: strict
+# typed: false
+module Researchable
+  module FreedcampApi
+    class ListProjects < Endpoint
+      integer :project_id, default: nil
+      integer :f_with_archived, default: 1
+
+      # Accepts "active", "archived", "all" values. Omitting is equal to "active".
+      string :lists_status, default: 'active'
+      integer :f_cf, default: 1
+
+      # @api private
+      def execute
+        list_projects(project_id)
+      end
+
+      # sig do
+      # params(
+      # project_id: T.nilable(Integer)
+      # ).returns(
+      # T::Array[Researchable::FreedcampApi::Structs::Task]
+      # )
+      # end
+      def list_projects(project_id)
+        project_query = project_id ? "/#{project_id}" : '/'
+        fetch_all('projects') do |limit, offset|
+          session.get("/projects#{project_query}?limit=#{limit}
+                   &offset=#{offset}")
+        end
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/list_task_lists.rb

@@ -0,0 +1,40 @@
+# typed: false
+module Researchable
+  module FreedcampApi
+    class ListTasks < Endpoint
+      integer :project_id, default: nil
+      integer :f_with_archived, default: 1
+
+      # Accepts "active", "archived", "all" values. Omitting is equal to "active".
+      string :lists_status, default: 'active'
+      string :assigned_to_id, default: nil
+      integer :f_cf, default: 1
+
+      # @api private
+      def execute
+        list_tasks(task_id)
+      end
+
+      sig do
+        params(
+          task_id: T.nilable(Integer)
+        ).returns(
+          T::Array[Researchable::FreedcampApi::Structs::Task]
+        )
+      end
+      def list_tasks(task_id)
+        task_query = task_id ? "/#{task_id}" : '/'
+        assigned_to_id_query = assigned_to_id ? "&assigned_to_id[]=#{assigned_to_id}" : ''
+        fetch_all('tasks') do |limit, offset|
+          url = "/tasks#{task_query}?limit=#{limit}
+                   &offset=#{offset}
+                   #{assigned_to_id_query}
+                   &f_with_archived=#{f_with_archived}
+                   &f_cf=#{f_cf}
+                   &lists_status=#{lists_status}"
+          session.get(url)
+        end
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/list_tasks.rb

@@ -3,11 +3,14 @@ module Researchable
   module FreedcampApi
     class ListTasks < Endpoint
       integer :task_id, default: nil
-      integer :f_with_archived, default: 1
+      integer :f_with_archived, default: 0
+      array :status, default: []
 
       # Accepts "active", "archived", "all" values. Omitting is equal to "active".
       string :lists_status, default: 'active'
+      string :assigned_to_id, default: nil
       integer :f_cf, default: 1
+      boolean :include_subtasks, default: true
 
       # @api private
       def execute
@@ -23,13 +26,24 @@ module Researchable
       end
       def list_tasks(task_id)
         task_query = task_id ? "/#{task_id}" : '/'
-        fetch_all('tasks') do |limit, offset|
-          session.get("/tasks#{task_query}?limit=#{limit}
+        assigned_to_id_query = assigned_to_id ? "&assigned_to_id[]=#{assigned_to_id}" : ''
+        f_with_archived_query = f_with_archived ? "&f_with_archived=#{f_with_archived}" : ''
+        status_query = status.reduce('') { |tot, cur| "#{tot}&status[]=#{cur}" }
+        # status[]=&status[]=2
+        tasks = fetch_all('tasks') do |limit, offset|
+          url = "/tasks#{task_query}?limit=#{limit}
                    &offset=#{offset}
-                   &f_with_archived=#{f_with_archived}
+                   #{assigned_to_id_query}
+                   #{f_with_archived_query}
+                   #{status_query}
                    &f_cf=#{f_cf}
-                   &lists_status=#{lists_status}")
+                   &lists_status=#{lists_status}"
+          session.get(url)
         end
+
+        return tasks if include_subtasks
+
+        tasks.select { |task| task['h_top_id'].blank? }
       end
     end
   end

data/lib/researchable/freedcamp_api/sessions/signed_session.rb

@@ -1,7 +1,6 @@
 # typed: strict
 require 'json'
 require 'httparty'
-require 'byebug'
 
 require_relative '../structs/signature'
 require_relative '../structs/task'
@@ -24,16 +23,13 @@ module Researchable
         sig { returns(String) }
         attr_reader :secret_key
 
-        sig { returns(T::Boolean) }
-        attr_reader :use_cache
-
         # rubocop:enable Style/AccessorGrouping
 
-        sig { params(public_key: String, secret_key: String, use_cache: T::Boolean).void }
-        def initialize(public_key: ENV['PUBLIC_KEY'], secret_key: ENV['SECRET_KEY'], use_cache: true)
+        sig { params(public_key: String, secret_key: String).void }
+        def initialize(public_key: ENV['PUBLIC_KEY'], secret_key: ENV['SECRET_KEY'])
           @public_key = public_key
           @secret_key = secret_key
-          @use_cache = use_cache
+          @debug = false
         end
 
         sig { override.params(path: String).returns(T::Hash[T.untyped, T.untyped]) }
@@ -69,32 +65,21 @@ module Researchable
           ).returns(T::Hash[T.untyped, T.untyped])
         end
         def call_url(path, method, data = {})
-          cache_url = "output/#{Digest::SHA1.hexdigest(path + method.to_s)}"
-          content = if data == {} && File.exist?(cache_url) && @use_cache
-                      render_cache(cache_url)
-                    else
-                      render_call(path, method, data, cache_url)
-                    end
+          content = render_call(path, method, data)
 
           content = JSON.parse(content) if content
           content
         end
 
-        def render_cache(cache_url)
-          file = File.open(cache_url)
-          content = file.read
-        end
-
-        def render_call(path, method, data, cache_url)
+        def render_call(path, method, data)
           signature = generate_signature
           url = make_url(path, signature)
           data = serialize_data(data)
-          content = HTTParty.send(method,
-                                  url,
-                                  body: data,
-                                  headers: HEADERS).body
-          File.open(cache_url, 'w') { |f| f.write content }
-          content
+          puts url if @debug
+          HTTParty.send(method,
+                        url,
+                        body: data,
+                        headers: HEADERS).body
         end
 
         def serialize_data(data = {})
@@ -108,7 +93,10 @@ module Researchable
         def make_url(path, signature)
           result = BASE + path
           sep = result.include?('?') ? '&' : '?'
-          result + "#{sep}api_key=#{signature.api_key}&timestamp=#{signature.timestamp}&hash=#{signature.calculated_hash}"
+          result += "#{sep}api_key=#{signature.api_key}&timestamp=#{signature.timestamp}&hash=#{signature.calculated_hash}"
+          result = result.gsub(/\n\s+/, '')
+          puts result if @debug
+          result
         end
 
         sig { returns(Signature) }

data/lib/researchable/freedcamp_api/structs/task.rb

@@ -42,6 +42,9 @@ module Researchable
 
         const :status, T.nilable(Integer)
         const :status_title, T.nilable(String)
+
+        # Shows the top parent task id (so is equal to h_parent_id for subtasks with h_level=1, and differs for subtasks with h_level > 1). Is an empty string for top-level tasks.
+        const :h_top_id, T.nilable(String)
       end
     end
   end

data/lib/researchable/freedcamp_api/version.rb

@@ -3,6 +3,6 @@
 
 module Researchable
   module FreedcampApi
-    VERSION = "0.1.2"
+    VERSION = "0.1.6"
   end
 end

data/lib/researchable/freedcamp_api.rb

@@ -3,14 +3,21 @@
 
 require 'active_interaction'
 require_relative 'freedcamp_api/version'
+require_relative 'freedcamp_api/constants'
 require_relative 'freedcamp_api/structs'
 require_relative 'freedcamp_api/sessions'
 require_relative 'freedcamp_api/endpoint'
 
+require_relative 'freedcamp_api/list_projects'
+
 require_relative 'freedcamp_api/list_tasks'
 require_relative 'freedcamp_api/update_task'
 require_relative 'freedcamp_api/create_task'
 
+require_relative 'freedcamp_api/get_user'
+
+require_relative 'freedcamp_api/list_lists'
+
 require_relative 'freedcamp_api/create_comment'
 
 module Researchable

data/test.rb

@@ -12,6 +12,7 @@ require 'researchable-freedcamp-api'
 # Pry.start
 #
 # Researchable::FreedcampApi::ListTasks.run!
+ENV['USE_CACHE'] = 'true'
 puts Researchable::FreedcampApi::ListTasks.run!(task_id: 44_509_132).to_json
 
 progress = 2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: researchable-freedcamp-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Frank Blaauw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_interaction
@@ -126,11 +126,15 @@ files:
 - bin/setup
 - lib/researchable-freedcamp-api.rb
 - lib/researchable/freedcamp_api.rb
+- lib/researchable/freedcamp_api/constants.rb
 - lib/researchable/freedcamp_api/create_comment.rb
 - lib/researchable/freedcamp_api/create_task.rb
 - lib/researchable/freedcamp_api/endpoint.rb
+- lib/researchable/freedcamp_api/get_user.rb
+- lib/researchable/freedcamp_api/list_lists.rb
 - lib/researchable/freedcamp_api/list_milestones.rb
 - lib/researchable/freedcamp_api/list_projects.rb
+- lib/researchable/freedcamp_api/list_task_lists.rb
 - lib/researchable/freedcamp_api/list_tasks.rb
 - lib/researchable/freedcamp_api/sessions.rb
 - lib/researchable/freedcamp_api/sessions/session.rb