researchable-freedcamp-api 0.1.2 → 0.1.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8ad49b10c4da65d1a26113907ba125c2028abe47fef02f1f81c7e10d8f3f988a
4
- data.tar.gz: bdff27b7cc946fbe620ecaced671ced639e30c805ddcc463cd06026709971111
3
+ metadata.gz: 8548577689d043fe6092a9e0ae799567f47d84e0c6e69328c60672d55c4c5572
4
+ data.tar.gz: 6862254a6953128dd131af3e79b30c3db0c7f2b653030dbbcf68ef5322b0df47
5
5
  SHA512:
6
- metadata.gz: 4547b1347784513899432b34aee63de5bce20f8922e32c6f9b151b3c36a4bd3f10092a00f77b7f33b94d9c266879f38336bf04587964689d5324b4285606c7f6
7
- data.tar.gz: dce7e0ae7cd0a45c2f72168dea410a3c47a1b516ea5b4882eeb2ed36116c8163cd999e4dcf0083737bbbf9d91cd5146fd5cc4db579844fb24202d6bcbef28d00
6
+ metadata.gz: 3b8f801e3292b50c989717d5b7306afc4ccafac6901c2f0bdc0ddce5591ab4e592ee394e6f06ffada6107d498cb1ecfb0d0271c45770ce993d6c91138a3857be
7
+ data.tar.gz: c47b871a253656a2d3e78e819d279f3a66a616bfac2afa1e5034acb98b4547da052003184322e92d4436bc22429479a109252c9fad119f9606423fcb7061eba2
@@ -0,0 +1,33 @@
1
+ # typed: strict
2
+ # frozen_string_literal: true
3
+
4
+ module Researchable
5
+ module FreedcampApi
6
+ APP_WALL = 1
7
+ APP_TODOS = 2
8
+ APP_DISCUSSIONS = 3
9
+ APP_MILESTONES = 4
10
+ APP_TIME = 5
11
+ APP_FILES = 6
12
+ APP_INVOICES = 7
13
+ APP_BUGTRACKER = 13
14
+ APP_WIKI = 14
15
+ APP_CRM = 16
16
+ APP_PASSMAN = 17
17
+ APP_TASKY = 18
18
+ APP_CALENDAR = 19
19
+ APP_INVOICESPLUS = 20
20
+ MODULE_GDOCS = 21
21
+ MODULE_PROJ_CLONING = 22
22
+
23
+ PROGRESS_NO_PROGRESS = 0
24
+ PROGRESS_IN_PROGRESS = 2
25
+ PROGRESS_COMPLETED = 1
26
+
27
+ STATUS_NOT_STARTED = 0
28
+ STATUS_COMPLETED = 1
29
+ STATUS_IN_PROGRESS = 2
30
+ STATUS_INVALID = 3
31
+ STATUS_REVIEW = 4
32
+ end
33
+ end
@@ -23,7 +23,7 @@ module Researchable
23
23
 
24
24
  while has_more
25
25
  temp = yield limit, offset
26
- has_more = T.let(temp.dig('data', 'meta', 'has_more') == 'true', T::Boolean)
26
+ has_more = T.let(temp.dig('data', 'meta', 'has_more') == true, T::Boolean)
27
27
  result += temp['data'][keyword]
28
28
  offset += limit
29
29
  end
@@ -0,0 +1,20 @@
1
+ # typed: false
2
+ module Researchable
3
+ module FreedcampApi
4
+ class GetUser < Endpoint
5
+ string :user_id, default: 'current'
6
+ # @api private
7
+ def execute
8
+ get_user(user_id)
9
+ end
10
+
11
+ #sig do
12
+ #params().returns(
13
+ #)
14
+ #end
15
+ def get_user(task_id)
16
+ session.get("/users/#{task_id}")['data']
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,37 @@
1
+ # typed: false
2
+ module Researchable
3
+ module FreedcampApi
4
+ class ListLists < Endpoint
5
+ string :project_id, default: nil
6
+ integer :app_id, default: Researchable::FreedcampApi::APP_TODOS
7
+ # @api private
8
+ def execute
9
+ check_app_id(app_id)
10
+ list_lists(app_id, project_id)
11
+ end
12
+
13
+ private
14
+
15
+ def check_app_id(app_id)
16
+ return if allowed_apps.include? app_id
17
+
18
+ raise "app_id not allowed: #{app_id} not in #{allowed_apps}"
19
+ end
20
+
21
+ def allowed_apps
22
+ [APP_TODOS, APP_FILES, APP_DISCUSSIONS, APP_WIKI, APP_PASSMAN]
23
+ end
24
+
25
+ def list_lists(app_id, project_id)
26
+ project_id_query = project_id ? "&project_id=#{project_id}" : ''
27
+ fetch_all('lists') do |limit, offset|
28
+ url = "/lists/#{app_id}
29
+ ?limit=#{limit}
30
+ &offset=#{offset}
31
+ #{project_id_query}"
32
+ session.get(url)
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -1 +1,33 @@
1
- # typed: strict
1
+ # typed: false
2
+ module Researchable
3
+ module FreedcampApi
4
+ class ListProjects < Endpoint
5
+ integer :project_id, default: nil
6
+ integer :f_with_archived, default: 1
7
+
8
+ # Accepts "active", "archived", "all" values. Omitting is equal to "active".
9
+ string :lists_status, default: 'active'
10
+ integer :f_cf, default: 1
11
+
12
+ # @api private
13
+ def execute
14
+ list_projects(project_id)
15
+ end
16
+
17
+ # sig do
18
+ # params(
19
+ # project_id: T.nilable(Integer)
20
+ # ).returns(
21
+ # T::Array[Researchable::FreedcampApi::Structs::Task]
22
+ # )
23
+ # end
24
+ def list_projects(project_id)
25
+ project_query = project_id ? "/#{project_id}" : '/'
26
+ fetch_all('projects') do |limit, offset|
27
+ session.get("/projects#{project_query}?limit=#{limit}
28
+ &offset=#{offset}")
29
+ end
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,40 @@
1
+ # typed: false
2
+ module Researchable
3
+ module FreedcampApi
4
+ class ListTasks < Endpoint
5
+ integer :project_id, default: nil
6
+ integer :f_with_archived, default: 1
7
+
8
+ # Accepts "active", "archived", "all" values. Omitting is equal to "active".
9
+ string :lists_status, default: 'active'
10
+ string :assigned_to_id, default: nil
11
+ integer :f_cf, default: 1
12
+
13
+ # @api private
14
+ def execute
15
+ list_tasks(task_id)
16
+ end
17
+
18
+ sig do
19
+ params(
20
+ task_id: T.nilable(Integer)
21
+ ).returns(
22
+ T::Array[Researchable::FreedcampApi::Structs::Task]
23
+ )
24
+ end
25
+ def list_tasks(task_id)
26
+ task_query = task_id ? "/#{task_id}" : '/'
27
+ assigned_to_id_query = assigned_to_id ? "&assigned_to_id[]=#{assigned_to_id}" : ''
28
+ fetch_all('tasks') do |limit, offset|
29
+ url = "/tasks#{task_query}?limit=#{limit}
30
+ &offset=#{offset}
31
+ #{assigned_to_id_query}
32
+ &f_with_archived=#{f_with_archived}
33
+ &f_cf=#{f_cf}
34
+ &lists_status=#{lists_status}"
35
+ session.get(url)
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end
@@ -3,11 +3,14 @@ module Researchable
3
3
  module FreedcampApi
4
4
  class ListTasks < Endpoint
5
5
  integer :task_id, default: nil
6
- integer :f_with_archived, default: 1
6
+ integer :f_with_archived, default: 0
7
+ array :status, default: []
7
8
 
8
9
  # Accepts "active", "archived", "all" values. Omitting is equal to "active".
9
10
  string :lists_status, default: 'active'
11
+ string :assigned_to_id, default: nil
10
12
  integer :f_cf, default: 1
13
+ boolean :include_subtasks, default: true
11
14
 
12
15
  # @api private
13
16
  def execute
@@ -23,13 +26,24 @@ module Researchable
23
26
  end
24
27
  def list_tasks(task_id)
25
28
  task_query = task_id ? "/#{task_id}" : '/'
26
- fetch_all('tasks') do |limit, offset|
27
- session.get("/tasks#{task_query}?limit=#{limit}
29
+ assigned_to_id_query = assigned_to_id ? "&assigned_to_id[]=#{assigned_to_id}" : ''
30
+ f_with_archived_query = f_with_archived ? "&f_with_archived=#{f_with_archived}" : ''
31
+ status_query = status.reduce('') { |tot, cur| "#{tot}&status[]=#{cur}" }
32
+ # status[]=&status[]=2
33
+ tasks = fetch_all('tasks') do |limit, offset|
34
+ url = "/tasks#{task_query}?limit=#{limit}
28
35
  &offset=#{offset}
29
- &f_with_archived=#{f_with_archived}
36
+ #{assigned_to_id_query}
37
+ #{f_with_archived_query}
38
+ #{status_query}
30
39
  &f_cf=#{f_cf}
31
- &lists_status=#{lists_status}")
40
+ &lists_status=#{lists_status}"
41
+ session.get(url)
32
42
  end
43
+
44
+ return tasks if include_subtasks
45
+
46
+ tasks.select { |task| task['h_top_id'].blank? }
33
47
  end
34
48
  end
35
49
  end
@@ -1,7 +1,6 @@
1
1
  # typed: strict
2
2
  require 'json'
3
3
  require 'httparty'
4
- require 'byebug'
5
4
 
6
5
  require_relative '../structs/signature'
7
6
  require_relative '../structs/task'
@@ -24,16 +23,13 @@ module Researchable
24
23
  sig { returns(String) }
25
24
  attr_reader :secret_key
26
25
 
27
- sig { returns(T::Boolean) }
28
- attr_reader :use_cache
29
-
30
26
  # rubocop:enable Style/AccessorGrouping
31
27
 
32
- sig { params(public_key: String, secret_key: String, use_cache: T::Boolean).void }
33
- def initialize(public_key: ENV['PUBLIC_KEY'], secret_key: ENV['SECRET_KEY'], use_cache: true)
28
+ sig { params(public_key: String, secret_key: String).void }
29
+ def initialize(public_key: ENV['PUBLIC_KEY'], secret_key: ENV['SECRET_KEY'])
34
30
  @public_key = public_key
35
31
  @secret_key = secret_key
36
- @use_cache = use_cache
32
+ @debug = false
37
33
  end
38
34
 
39
35
  sig { override.params(path: String).returns(T::Hash[T.untyped, T.untyped]) }
@@ -69,32 +65,21 @@ module Researchable
69
65
  ).returns(T::Hash[T.untyped, T.untyped])
70
66
  end
71
67
  def call_url(path, method, data = {})
72
- cache_url = "output/#{Digest::SHA1.hexdigest(path + method.to_s)}"
73
- content = if data == {} && File.exist?(cache_url) && @use_cache
74
- render_cache(cache_url)
75
- else
76
- render_call(path, method, data, cache_url)
77
- end
68
+ content = render_call(path, method, data)
78
69
 
79
70
  content = JSON.parse(content) if content
80
71
  content
81
72
  end
82
73
 
83
- def render_cache(cache_url)
84
- file = File.open(cache_url)
85
- content = file.read
86
- end
87
-
88
- def render_call(path, method, data, cache_url)
74
+ def render_call(path, method, data)
89
75
  signature = generate_signature
90
76
  url = make_url(path, signature)
91
77
  data = serialize_data(data)
92
- content = HTTParty.send(method,
93
- url,
94
- body: data,
95
- headers: HEADERS).body
96
- File.open(cache_url, 'w') { |f| f.write content }
97
- content
78
+ puts url if @debug
79
+ HTTParty.send(method,
80
+ url,
81
+ body: data,
82
+ headers: HEADERS).body
98
83
  end
99
84
 
100
85
  def serialize_data(data = {})
@@ -108,7 +93,10 @@ module Researchable
108
93
  def make_url(path, signature)
109
94
  result = BASE + path
110
95
  sep = result.include?('?') ? '&' : '?'
111
- result + "#{sep}api_key=#{signature.api_key}&timestamp=#{signature.timestamp}&hash=#{signature.calculated_hash}"
96
+ result += "#{sep}api_key=#{signature.api_key}&timestamp=#{signature.timestamp}&hash=#{signature.calculated_hash}"
97
+ result = result.gsub(/\n\s+/, '')
98
+ puts result if @debug
99
+ result
112
100
  end
113
101
 
114
102
  sig { returns(Signature) }
@@ -42,6 +42,9 @@ module Researchable
42
42
 
43
43
  const :status, T.nilable(Integer)
44
44
  const :status_title, T.nilable(String)
45
+
46
+ # 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.
47
+ const :h_top_id, T.nilable(String)
45
48
  end
46
49
  end
47
50
  end
@@ -3,6 +3,6 @@
3
3
 
4
4
  module Researchable
5
5
  module FreedcampApi
6
- VERSION = "0.1.2"
6
+ VERSION = "0.1.6"
7
7
  end
8
8
  end
@@ -3,14 +3,21 @@
3
3
 
4
4
  require 'active_interaction'
5
5
  require_relative 'freedcamp_api/version'
6
+ require_relative 'freedcamp_api/constants'
6
7
  require_relative 'freedcamp_api/structs'
7
8
  require_relative 'freedcamp_api/sessions'
8
9
  require_relative 'freedcamp_api/endpoint'
9
10
 
11
+ require_relative 'freedcamp_api/list_projects'
12
+
10
13
  require_relative 'freedcamp_api/list_tasks'
11
14
  require_relative 'freedcamp_api/update_task'
12
15
  require_relative 'freedcamp_api/create_task'
13
16
 
17
+ require_relative 'freedcamp_api/get_user'
18
+
19
+ require_relative 'freedcamp_api/list_lists'
20
+
14
21
  require_relative 'freedcamp_api/create_comment'
15
22
 
16
23
  module Researchable
data/test.rb CHANGED
@@ -12,6 +12,7 @@ require 'researchable-freedcamp-api'
12
12
  # Pry.start
13
13
  #
14
14
  # Researchable::FreedcampApi::ListTasks.run!
15
+ ENV['USE_CACHE'] = 'true'
15
16
  puts Researchable::FreedcampApi::ListTasks.run!(task_id: 44_509_132).to_json
16
17
 
17
18
  progress = 2
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: researchable-freedcamp-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.1.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Frank Blaauw
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-27 00:00:00.000000000 Z
11
+ date: 2022-02-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: active_interaction
@@ -126,11 +126,15 @@ files:
126
126
  - bin/setup
127
127
  - lib/researchable-freedcamp-api.rb
128
128
  - lib/researchable/freedcamp_api.rb
129
+ - lib/researchable/freedcamp_api/constants.rb
129
130
  - lib/researchable/freedcamp_api/create_comment.rb
130
131
  - lib/researchable/freedcamp_api/create_task.rb
131
132
  - lib/researchable/freedcamp_api/endpoint.rb
133
+ - lib/researchable/freedcamp_api/get_user.rb
134
+ - lib/researchable/freedcamp_api/list_lists.rb
132
135
  - lib/researchable/freedcamp_api/list_milestones.rb
133
136
  - lib/researchable/freedcamp_api/list_projects.rb
137
+ - lib/researchable/freedcamp_api/list_task_lists.rb
134
138
  - lib/researchable/freedcamp_api/list_tasks.rb
135
139
  - lib/researchable/freedcamp_api/sessions.rb
136
140
  - lib/researchable/freedcamp_api/sessions/session.rb