bwapi 9.0.0.pre.390 → 9.0.0.pre.401
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 +8 -8
- data/CHANGELOG.md +18 -0
- data/CONTRIBUTING.md +14 -0
- data/README.md +30 -34
- data/bwapi.gemspec +1 -1
- data/lib/bwapi/client/admin.rb +2 -2
- data/lib/bwapi/client/admin/become.rb +1 -1
- data/lib/bwapi/client/admin/search.rb +3 -3
- data/lib/bwapi/client/admin/sub_clients.rb +5 -5
- data/lib/bwapi/client/admin/users.rb +4 -4
- data/lib/bwapi/client/admin/users/sharing.rb +2 -2
- data/lib/bwapi/client/brandwatch.rb +1 -1
- data/lib/bwapi/client/brandwatch/become.rb +1 -1
- data/lib/bwapi/client/brandwatch/client_modules.rb +2 -2
- data/lib/bwapi/client/client.rb +2 -2
- data/lib/bwapi/client/command_center/client.rb +1 -1
- data/lib/bwapi/client/command_center/displays.rb +5 -5
- data/lib/bwapi/client/command_center/displays/events.rb +5 -5
- data/lib/bwapi/client/command_center/displays/messages.rb +5 -5
- data/lib/bwapi/client/command_center/displays/scenes.rb +6 -6
- data/lib/bwapi/client/command_center/displays/screens.rb +6 -6
- data/lib/bwapi/client/command_center/displays/users.rb +5 -5
- data/lib/bwapi/client/command_center/displays/users/access.rb +2 -2
- data/lib/bwapi/client/command_center/scene_types.rb +3 -3
- data/lib/bwapi/client/command_center/themes.rb +1 -1
- data/lib/bwapi/client/command_center/users.rb +3 -3
- data/lib/bwapi/client/command_center/users/access.rb +1 -1
- data/lib/bwapi/client/error_codes.rb +1 -1
- data/lib/bwapi/client/filters.rb +1 -1
- data/lib/bwapi/client/languages.rb +1 -1
- data/lib/bwapi/client/locations.rb +2 -2
- data/lib/bwapi/client/logout.rb +1 -1
- data/lib/bwapi/client/me.rb +1 -1
- data/lib/bwapi/client/metrics.rb +1 -1
- data/lib/bwapi/client/ping.rb +5 -5
- data/lib/bwapi/client/projects.rb +5 -5
- data/lib/bwapi/client/projects/bulkactions.rb +1 -1
- data/lib/bwapi/client/projects/bulkactions/author.rb +1 -1
- data/lib/bwapi/client/projects/bulkactions/mentions.rb +1 -1
- data/lib/bwapi/client/projects/categories.rb +4 -4
- data/lib/bwapi/client/projects/categories/copy.rb +1 -1
- data/lib/bwapi/client/projects/data.rb +2 -2
- data/lib/bwapi/client/projects/data/mentions.rb +4 -4
- data/lib/bwapi/client/projects/data/mentions/notes.rb +4 -4
- data/lib/bwapi/client/projects/data/volume.rb +1 -1
- data/lib/bwapi/client/projects/data_download.rb +3 -3
- data/lib/bwapi/client/projects/demographics.rb +1 -1
- data/lib/bwapi/client/projects/facebook_queries.rb +5 -5
- data/lib/bwapi/client/projects/group/author_group.rb +5 -5
- data/lib/bwapi/client/projects/group/location_group.rb +5 -5
- data/lib/bwapi/client/projects/group/site_group.rb +5 -5
- data/lib/bwapi/client/projects/queries.rb +6 -6
- data/lib/bwapi/client/projects/queries/backfill.rb +4 -4
- data/lib/bwapi/client/projects/queries/date_range.rb +5 -5
- data/lib/bwapi/client/projects/queries/mentions.rb +3 -3
- data/lib/bwapi/client/projects/query_groups.rb +5 -5
- data/lib/bwapi/client/projects/rules.rb +5 -5
- data/lib/bwapi/client/projects/rules/backfill.rb +1 -1
- data/lib/bwapi/client/projects/rules/copy.rb +1 -1
- data/lib/bwapi/client/projects/sharing.rb +5 -5
- data/lib/bwapi/client/projects/signals.rb +1 -1
- data/lib/bwapi/client/projects/signals/groups.rb +5 -5
- data/lib/bwapi/client/projects/stream_dashboards.rb +6 -6
- data/lib/bwapi/client/projects/stream_dashboards/streams.rb +5 -5
- data/lib/bwapi/client/projects/summary.rb +1 -1
- data/lib/bwapi/client/projects/tags.rb +5 -5
- data/lib/bwapi/client/projects/twitter_queries.rb +4 -4
- data/lib/bwapi/client/projects/users.rb +1 -1
- data/lib/bwapi/client/projects/workflow.rb +1 -1
- data/lib/bwapi/client/query_validation.rb +2 -2
- data/lib/bwapi/client/sso.rb +1 -1
- data/lib/bwapi/client/test_search.rb +1 -1
- data/lib/bwapi/client/user.rb +2 -2
- data/lib/bwapi/client/user/notifications.rb +4 -4
- data/lib/bwapi/request.rb +6 -6
- metadata +5 -3
@@ -6,7 +6,7 @@ module BWAPI
|
|
6
6
|
# Get all twitter queries in a project
|
7
7
|
#
|
8
8
|
# @param project_id [Integer] Id of project
|
9
|
-
# @return [
|
9
|
+
# @return [Hash] All twitter queries in project
|
10
10
|
def twitter_queries(project_id)
|
11
11
|
get "projects/#{project_id}/twitterqueries"
|
12
12
|
end
|
@@ -15,7 +15,7 @@ module BWAPI
|
|
15
15
|
#
|
16
16
|
# @param project_id [Integer] Id of project
|
17
17
|
# @param query_id [Integer] Id of twitter query
|
18
|
-
# @return [
|
18
|
+
# @return [Hash] Specific twitter query
|
19
19
|
def get_twitter_query(project_id, query_id)
|
20
20
|
get "projects/#{project_id}/twitterqueries/#{query_id}"
|
21
21
|
end
|
@@ -43,7 +43,7 @@ module BWAPI
|
|
43
43
|
# @option opts [String] type Query type
|
44
44
|
# @option opts [String] twitterLimit Twitter limit
|
45
45
|
# @option opts [String] twitterScreenName Twitter screen name
|
46
|
-
# @return [
|
46
|
+
# @return [Hash] New twitter query
|
47
47
|
def create_twitter_query(project_id, opts = {})
|
48
48
|
post "projects/#{project_id}/twitterqueries", opts
|
49
49
|
end
|
@@ -72,7 +72,7 @@ module BWAPI
|
|
72
72
|
# @option opts [String] type Query type
|
73
73
|
# @option opts [String] twitterLimit Twitter limit
|
74
74
|
# @option opts [String] twitterScreenName Twitter screen name
|
75
|
-
# @return [
|
75
|
+
# @return [Hash] Updated twitter query
|
76
76
|
def update_twitter_query(project_id, query_id, opts = {})
|
77
77
|
put "projects/#{project_id}/twitterqueries/#{query_id}", opts
|
78
78
|
end
|
@@ -6,7 +6,7 @@ module BWAPI
|
|
6
6
|
# Get all users shared with project
|
7
7
|
#
|
8
8
|
# @param project_id [Integer] Id of project
|
9
|
-
# @return [
|
9
|
+
# @return [Hash] All users shared to project
|
10
10
|
def project_users(project_id)
|
11
11
|
get "projects/#{project_id}/users"
|
12
12
|
end
|
@@ -6,7 +6,7 @@ module BWAPI
|
|
6
6
|
# Get all workflow categories for project
|
7
7
|
#
|
8
8
|
# @param project_id [Integer] Id of project
|
9
|
-
# @return [
|
9
|
+
# @return [Hash] Workflow categories for project
|
10
10
|
def workflow(project_id)
|
11
11
|
get "projects/#{project_id}/workflow"
|
12
12
|
end
|
@@ -7,7 +7,7 @@ module BWAPI
|
|
7
7
|
# @param opts [Hash] options hash of parameters
|
8
8
|
# @option opts [String] query Query string
|
9
9
|
# @option opts [Array] language Languages for query string
|
10
|
-
# @return [
|
10
|
+
# @return [Hash] Query string validation results
|
11
11
|
def query_validation(opts = {})
|
12
12
|
get 'query-validation', opts
|
13
13
|
end
|
@@ -17,7 +17,7 @@ module BWAPI
|
|
17
17
|
# @param opts [Hash] options hash of parameters
|
18
18
|
# @option opts [String] query Query string
|
19
19
|
# @option opts [Array] language Languages for query string
|
20
|
-
# @return [
|
20
|
+
# @return [Hash] Query string validation results
|
21
21
|
def search_within(opts = {})
|
22
22
|
get 'query-validation/searchwithin', opts
|
23
23
|
end
|
data/lib/bwapi/client/sso.rb
CHANGED
@@ -5,7 +5,7 @@ module BWAPI
|
|
5
5
|
# Retrieve full text for a given url
|
6
6
|
# @param opts [Hash] options hash of parameters
|
7
7
|
# @option opts [String] url the url to test search
|
8
|
-
# @return [
|
8
|
+
# @return [Hash] full text of the url
|
9
9
|
def test_search_content(opts = {})
|
10
10
|
get 'testsearch/content', opts
|
11
11
|
end
|
data/lib/bwapi/client/user.rb
CHANGED
@@ -6,7 +6,7 @@ module BWAPI
|
|
6
6
|
module User
|
7
7
|
# Get the current user
|
8
8
|
#
|
9
|
-
# @return [
|
9
|
+
# @return [Hash] User information
|
10
10
|
def user
|
11
11
|
get 'user'
|
12
12
|
end
|
@@ -32,7 +32,7 @@ module BWAPI
|
|
32
32
|
# @option opts [String] firstName The users first name
|
33
33
|
# @option opts [String] mobile The users mobile number
|
34
34
|
# @option opts [Date] creationDate Date the user was created on
|
35
|
-
# @return [
|
35
|
+
# @return [Hash] Updated user information
|
36
36
|
def update_user(opts = {})
|
37
37
|
put 'user', opts
|
38
38
|
end
|
@@ -11,7 +11,7 @@ module BWAPI
|
|
11
11
|
# @option opts [String] body the body text of the notification
|
12
12
|
# @option opts [String] subject the subject text of the notification
|
13
13
|
# @option opts [String] type the type of notification
|
14
|
-
# @return [
|
14
|
+
# @return [Hash] new user notification
|
15
15
|
def create_notification(opts = {})
|
16
16
|
post 'user/notifications', opts
|
17
17
|
end
|
@@ -21,7 +21,7 @@ module BWAPI
|
|
21
21
|
# @param opts [Hash] options hash of parameters
|
22
22
|
# @option opts [Integer] page Page of projects to retrieve
|
23
23
|
# @option opts [Integer] pageSize Results per page of results
|
24
|
-
# @return [
|
24
|
+
# @return [Hash] user notifications
|
25
25
|
def notifications(opts = {})
|
26
26
|
get 'user/notifications', opts
|
27
27
|
end
|
@@ -35,7 +35,7 @@ module BWAPI
|
|
35
35
|
# @option opts [String] body the body text of the notification
|
36
36
|
# @option opts [String] subject the subject text of the notification
|
37
37
|
# @option opts [String] type the type of notification
|
38
|
-
# @return [
|
38
|
+
# @return [Hash] edited user notification
|
39
39
|
def update_notification(notification_id, opts = {})
|
40
40
|
put "user/notifications/#{notification_id}", opts
|
41
41
|
end
|
@@ -45,7 +45,7 @@ module BWAPI
|
|
45
45
|
# @param notification_id [Integer] Id of notification
|
46
46
|
# @param opts [Hash] options Hash of parameters
|
47
47
|
# @option opts [Boolean] read if the notification has been read
|
48
|
-
# @return [
|
48
|
+
# @return [Hash] patched user notifications
|
49
49
|
def patch_notification(notification_id, opts = {})
|
50
50
|
patch "user/notifications/#{notification_id}", opts
|
51
51
|
end
|
data/lib/bwapi/request.rb
CHANGED
@@ -9,7 +9,7 @@ module BWAPI
|
|
9
9
|
#
|
10
10
|
# @param path [String] URL path to send request
|
11
11
|
# @param opts [Hash] Request parameters
|
12
|
-
# @return [
|
12
|
+
# @return [Hash] Response body
|
13
13
|
def get(path, opts = {})
|
14
14
|
request(:get, path, opts).body
|
15
15
|
end
|
@@ -18,7 +18,7 @@ module BWAPI
|
|
18
18
|
#
|
19
19
|
# @param path [String] URL path to send request
|
20
20
|
# @param opts [Hash] Request parameters
|
21
|
-
# @return [
|
21
|
+
# @return [Hash] Response body
|
22
22
|
def delete(path, opts = {})
|
23
23
|
request(:delete, path, opts).body
|
24
24
|
end
|
@@ -27,7 +27,7 @@ module BWAPI
|
|
27
27
|
#
|
28
28
|
# @param path [String] URL path to send request
|
29
29
|
# @param opts [Hash] Request parameters
|
30
|
-
# @return [
|
30
|
+
# @return [Hash] Response body
|
31
31
|
def post(path, opts = {})
|
32
32
|
request(:post, path, opts).body
|
33
33
|
end
|
@@ -36,7 +36,7 @@ module BWAPI
|
|
36
36
|
#
|
37
37
|
# @param path [String] URL path to send request
|
38
38
|
# @param opts [Hash] Request parameters
|
39
|
-
# @return [
|
39
|
+
# @return [Hash] Response body
|
40
40
|
def put(path, opts = {})
|
41
41
|
request(:put, path, opts).body
|
42
42
|
end
|
@@ -45,7 +45,7 @@ module BWAPI
|
|
45
45
|
#
|
46
46
|
# @param path [String] URL path to send request
|
47
47
|
# @param opts [Hash] Request parameters
|
48
|
-
# @return [
|
48
|
+
# @return [Hash] Response body
|
49
49
|
def patch(path, opts = {})
|
50
50
|
request(:patch, path, opts).body
|
51
51
|
end
|
@@ -57,7 +57,7 @@ module BWAPI
|
|
57
57
|
# @param method [String] Type of request
|
58
58
|
# @param path [String] URL path to send request
|
59
59
|
# @param opts [Hash] Request parameters
|
60
|
-
# @return [
|
60
|
+
# @return [Hash] Response
|
61
61
|
def request(method, path, opts = {})
|
62
62
|
response = connection.send(method) do |r|
|
63
63
|
case method
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: bwapi
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 9.0.0.pre.
|
4
|
+
version: 9.0.0.pre.401
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Jonathan Chrisp
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-08-
|
11
|
+
date: 2014-08-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rspec
|
@@ -161,6 +161,8 @@ files:
|
|
161
161
|
- .gitignore
|
162
162
|
- .rubocop.yml
|
163
163
|
- .travis.yml
|
164
|
+
- CHANGELOG.md
|
165
|
+
- CONTRIBUTING.md
|
164
166
|
- Gemfile
|
165
167
|
- LICENCE.md
|
166
168
|
- README.md
|
@@ -273,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
273
275
|
version: 1.3.1
|
274
276
|
requirements: []
|
275
277
|
rubyforge_project:
|
276
|
-
rubygems_version: 2.
|
278
|
+
rubygems_version: 2.4.1
|
277
279
|
signing_key:
|
278
280
|
specification_version: 4
|
279
281
|
summary: Brandwatch API Wrapper
|