docbase 0.2.1 → 0.3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.travis.yml +7 -4
- data/CHANGELOG.md +6 -0
- data/Gemfile +5 -0
- data/README.md +47 -3
- data/docbase.gemspec +2 -5
- data/lib/docbase/client.rb +28 -0
- data/lib/docbase/version.rb +1 -1
- metadata +3 -46
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ea2127b20dfc325138964d09c46246c78ee9cc1986a70ee7b4cbb06848d1ae11
|
4
|
+
data.tar.gz: c4cecb8593f7879d5001e2bced56b99df06daea4ef7f76c7bab274ce61e66d75
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f8722682659f35fc26d13d15ce3d8e324abc5cbdcebc323a777fca5f871471405e7bd8e99ab541580347d38f079b32e28d53cd294c90da89a709647dd70e26ce
|
7
|
+
data.tar.gz: '04176870525bcf117b29b7dd3562ed7643bc8ca003f8b9cbb017dae381cce975e045dce024ab08c120d1610fd64c85dfe98082a9d70e8dabd03cf64a6865952e'
|
data/.travis.yml
CHANGED
data/CHANGELOG.md
CHANGED
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -40,6 +40,16 @@ client = DocBase::Client.new(team: 'your_team')
|
|
40
40
|
client.teams.body
|
41
41
|
# => [{ domain: 'kray', name: 'kray' }, { domain: 'danny', name: 'danny' }]
|
42
42
|
```
|
43
|
+
|
44
|
+
### users
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
client.users(q: 'name')
|
48
|
+
client.users(q: 'name', page: 2)
|
49
|
+
client.users(q: 'name', page: 1, per_page: 100)
|
50
|
+
client.users(q: 'name', page: 1, per_page: 100, include_user_groups: true)
|
51
|
+
```
|
52
|
+
|
43
53
|
### tags
|
44
54
|
|
45
55
|
```ruby
|
@@ -72,14 +82,36 @@ params = {
|
|
72
82
|
client.create_group(params)
|
73
83
|
```
|
74
84
|
|
85
|
+
#### Add users to group
|
86
|
+
|
87
|
+
```ruby
|
88
|
+
params = {
|
89
|
+
group_id: 1,
|
90
|
+
user_ids: [10, 11, 12]
|
91
|
+
}
|
92
|
+
|
93
|
+
client.add_users_to_group(params)
|
94
|
+
```
|
95
|
+
|
96
|
+
#### Remove users from group
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
params = {
|
100
|
+
group_id: 1,
|
101
|
+
user_ids: [10, 11, 12]
|
102
|
+
}
|
103
|
+
|
104
|
+
client.remove_users_from_group(params)
|
105
|
+
```
|
106
|
+
|
75
107
|
### posts
|
76
108
|
|
77
109
|
#### Search
|
78
110
|
|
79
111
|
```ruby
|
80
|
-
client.
|
81
|
-
client.
|
82
|
-
client.
|
112
|
+
client.posts(q: 'body')
|
113
|
+
client.posts(q: 'body', page: 2)
|
114
|
+
client.posts(q: 'body', page: 1, per_page: 100)
|
83
115
|
```
|
84
116
|
|
85
117
|
#### Show
|
@@ -121,6 +153,18 @@ params = {
|
|
121
153
|
client.update_post(params)
|
122
154
|
```
|
123
155
|
|
156
|
+
#### Archive
|
157
|
+
|
158
|
+
```ruby
|
159
|
+
client.archive_post(1)
|
160
|
+
```
|
161
|
+
|
162
|
+
#### Unarchive
|
163
|
+
|
164
|
+
```ruby
|
165
|
+
client.unarchive_post(1)
|
166
|
+
```
|
167
|
+
|
124
168
|
#### Delete
|
125
169
|
|
126
170
|
```ruby
|
data/docbase.gemspec
CHANGED
@@ -17,9 +17,6 @@ Gem::Specification.new do |spec|
|
|
17
17
|
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
18
18
|
spec.require_paths = ['lib']
|
19
19
|
|
20
|
-
spec.
|
21
|
-
spec.
|
22
|
-
spec.add_development_dependency 'bundler', '~> 1.16'
|
23
|
-
spec.add_development_dependency 'rake', '~> 10.4'
|
24
|
-
spec.add_development_dependency 'rspec', '~> 3.8.0'
|
20
|
+
spec.add_dependency 'faraday', '~> 0.15.2'
|
21
|
+
spec.add_dependency 'faraday_middleware', '~> 0.12.2'
|
25
22
|
end
|
data/lib/docbase/client.rb
CHANGED
@@ -23,6 +23,10 @@ module DocBase
|
|
23
23
|
connection.get('/teams')
|
24
24
|
end
|
25
25
|
|
26
|
+
def users(q: nil, page: 1, per_page: 100, include_user_groups: false)
|
27
|
+
connection.get("/teams/#{team!}/users", q: q, page: page, per_page: per_page, include_user_groups: include_user_groups)
|
28
|
+
end
|
29
|
+
|
26
30
|
def tags
|
27
31
|
connection.get("/teams/#{team!}/tags")
|
28
32
|
end
|
@@ -39,6 +43,22 @@ module DocBase
|
|
39
43
|
connection.post("/teams/#{team!}/groups", params)
|
40
44
|
end
|
41
45
|
|
46
|
+
def add_users_to_group(params)
|
47
|
+
group_id = params[:group_id].to_i
|
48
|
+
raise NotSetTeamError if group_id <= 0
|
49
|
+
|
50
|
+
users_params = except(params, :group_id)
|
51
|
+
connection.post("/teams/#{team!}/groups/#{group_id}/users", users_params)
|
52
|
+
end
|
53
|
+
|
54
|
+
def remove_users_from_group(params)
|
55
|
+
group_id = params[:group_id].to_i
|
56
|
+
raise NotSetTeamError if group_id <= 0
|
57
|
+
|
58
|
+
users_params = except(params, :group_id)
|
59
|
+
connection.delete("/teams/#{team!}/groups/#{group_id}/users", users_params)
|
60
|
+
end
|
61
|
+
|
42
62
|
def post(id)
|
43
63
|
connection.get("/teams/#{team!}/posts/#{id}")
|
44
64
|
end
|
@@ -63,6 +83,14 @@ module DocBase
|
|
63
83
|
connection.delete("/teams/#{team!}/posts/#{id}")
|
64
84
|
end
|
65
85
|
|
86
|
+
def archive_post(id)
|
87
|
+
connection.put("/teams/#{team!}/posts/#{id}/archive")
|
88
|
+
end
|
89
|
+
|
90
|
+
def unarchive_post(id)
|
91
|
+
connection.put("/teams/#{team!}/posts/#{id}/unarchive")
|
92
|
+
end
|
93
|
+
|
66
94
|
def create_comment(params)
|
67
95
|
post_id = params[:post_id].to_i
|
68
96
|
raise NotSetTeamError if post_id <= 0
|
data/lib/docbase/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: docbase
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- ttakuru88
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2019-04-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
@@ -38,48 +38,6 @@ dependencies:
|
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: 0.12.2
|
41
|
-
- !ruby/object:Gem::Dependency
|
42
|
-
name: bundler
|
43
|
-
requirement: !ruby/object:Gem::Requirement
|
44
|
-
requirements:
|
45
|
-
- - "~>"
|
46
|
-
- !ruby/object:Gem::Version
|
47
|
-
version: '1.16'
|
48
|
-
type: :development
|
49
|
-
prerelease: false
|
50
|
-
version_requirements: !ruby/object:Gem::Requirement
|
51
|
-
requirements:
|
52
|
-
- - "~>"
|
53
|
-
- !ruby/object:Gem::Version
|
54
|
-
version: '1.16'
|
55
|
-
- !ruby/object:Gem::Dependency
|
56
|
-
name: rake
|
57
|
-
requirement: !ruby/object:Gem::Requirement
|
58
|
-
requirements:
|
59
|
-
- - "~>"
|
60
|
-
- !ruby/object:Gem::Version
|
61
|
-
version: '10.4'
|
62
|
-
type: :development
|
63
|
-
prerelease: false
|
64
|
-
version_requirements: !ruby/object:Gem::Requirement
|
65
|
-
requirements:
|
66
|
-
- - "~>"
|
67
|
-
- !ruby/object:Gem::Version
|
68
|
-
version: '10.4'
|
69
|
-
- !ruby/object:Gem::Dependency
|
70
|
-
name: rspec
|
71
|
-
requirement: !ruby/object:Gem::Requirement
|
72
|
-
requirements:
|
73
|
-
- - "~>"
|
74
|
-
- !ruby/object:Gem::Version
|
75
|
-
version: 3.8.0
|
76
|
-
type: :development
|
77
|
-
prerelease: false
|
78
|
-
version_requirements: !ruby/object:Gem::Requirement
|
79
|
-
requirements:
|
80
|
-
- - "~>"
|
81
|
-
- !ruby/object:Gem::Version
|
82
|
-
version: 3.8.0
|
83
41
|
description: DocBase API Client, written in Ruby
|
84
42
|
email:
|
85
43
|
- asaumi+docbase-ruby@kray.jp
|
@@ -121,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
121
79
|
- !ruby/object:Gem::Version
|
122
80
|
version: '0'
|
123
81
|
requirements: []
|
124
|
-
|
125
|
-
rubygems_version: 2.7.6
|
82
|
+
rubygems_version: 3.0.3
|
126
83
|
signing_key:
|
127
84
|
specification_version: 4
|
128
85
|
summary: DocBase API Client, written in Ruby
|