bwapi 6.5.0.pre.256 → 7.0.0.pre.271

Sign up to get free protection for your applications and to get access to all the features.
Files changed (91) hide show
  1. checksums.yaml +8 -8
  2. data/.editorconfig +11 -0
  3. data/.rubocop.yml +17 -0
  4. data/.travis.yml +7 -3
  5. data/bin/bwapi +2 -1
  6. data/bwapi.gemspec +13 -10
  7. data/lib/bwapi.rb +6 -6
  8. data/lib/bwapi/authentication.rb +9 -17
  9. data/lib/bwapi/client.rb +5 -4
  10. data/lib/bwapi/client/admin.rb +6 -6
  11. data/lib/bwapi/client/admin/become.rb +4 -4
  12. data/lib/bwapi/client/admin/search.rb +9 -12
  13. data/lib/bwapi/client/admin/sub_clients.rb +8 -13
  14. data/lib/bwapi/client/admin/users.rb +7 -7
  15. data/lib/bwapi/client/admin/users/sharing.rb +5 -7
  16. data/lib/bwapi/client/brandwatch.rb +4 -4
  17. data/lib/bwapi/client/brandwatch/become.rb +4 -4
  18. data/lib/bwapi/client/brandwatch/client_modules.rb +5 -6
  19. data/lib/bwapi/client/client.rb +5 -6
  20. data/lib/bwapi/client/command_center.rb +3 -3
  21. data/lib/bwapi/client/command_center/client.rb +4 -4
  22. data/lib/bwapi/client/command_center/displays.rb +9 -9
  23. data/lib/bwapi/client/command_center/displays/events.rb +8 -8
  24. data/lib/bwapi/client/command_center/displays/messages.rb +7 -8
  25. data/lib/bwapi/client/command_center/displays/scenes.rb +9 -9
  26. data/lib/bwapi/client/command_center/displays/screens.rb +9 -9
  27. data/lib/bwapi/client/command_center/displays/users.rb +7 -8
  28. data/lib/bwapi/client/command_center/displays/users/access.rb +4 -5
  29. data/lib/bwapi/client/command_center/scene_types.rb +6 -6
  30. data/lib/bwapi/client/command_center/themes.rb +4 -4
  31. data/lib/bwapi/client/command_center/users.rb +6 -6
  32. data/lib/bwapi/client/command_center/users/access.rb +5 -5
  33. data/lib/bwapi/client/error_codes.rb +4 -4
  34. data/lib/bwapi/client/filters.rb +4 -4
  35. data/lib/bwapi/client/languages.rb +3 -3
  36. data/lib/bwapi/client/location.rb +5 -5
  37. data/lib/bwapi/client/logout.rb +12 -14
  38. data/lib/bwapi/client/me.rb +3 -3
  39. data/lib/bwapi/client/metrics.rb +3 -3
  40. data/lib/bwapi/client/oauth.rb +8 -8
  41. data/lib/bwapi/client/ping.rb +8 -8
  42. data/lib/bwapi/client/projects.rb +10 -10
  43. data/lib/bwapi/client/projects/bulkactions.rb +4 -4
  44. data/lib/bwapi/client/projects/bulkactions/author.rb +4 -3
  45. data/lib/bwapi/client/projects/bulkactions/mentions.rb +4 -3
  46. data/lib/bwapi/client/projects/categories.rb +6 -20
  47. data/lib/bwapi/client/projects/data.rb +4 -5
  48. data/lib/bwapi/client/projects/data/mentions.rb +7 -7
  49. data/lib/bwapi/client/projects/data/volume.rb +11 -11
  50. data/lib/bwapi/client/projects/data_download.rb +6 -7
  51. data/lib/bwapi/client/projects/demographics.rb +3 -4
  52. data/lib/bwapi/client/projects/facebook_queries.rb +8 -9
  53. data/lib/bwapi/client/projects/group.rb +2 -2
  54. data/lib/bwapi/client/projects/group/author_group.rb +8 -7
  55. data/lib/bwapi/client/projects/group/location_group.rb +7 -7
  56. data/lib/bwapi/client/projects/group/site_group.rb +7 -7
  57. data/lib/bwapi/client/projects/queries.rb +9 -10
  58. data/lib/bwapi/client/projects/queries/backfill.rb +6 -8
  59. data/lib/bwapi/client/projects/queries/date_range.rb +9 -9
  60. data/lib/bwapi/client/projects/queries/mentions.rb +5 -8
  61. data/lib/bwapi/client/projects/query_groups.rb +7 -9
  62. data/lib/bwapi/client/projects/rules.rb +7 -9
  63. data/lib/bwapi/client/projects/rules/backfill.rb +4 -4
  64. data/lib/bwapi/client/projects/rules/copy.rb +4 -4
  65. data/lib/bwapi/client/projects/sharing.rb +8 -9
  66. data/lib/bwapi/client/projects/signals.rb +5 -5
  67. data/lib/bwapi/client/projects/stream_dashboards.rb +10 -10
  68. data/lib/bwapi/client/projects/stream_dashboards/streams.rb +6 -7
  69. data/lib/bwapi/client/projects/summary.rb +5 -6
  70. data/lib/bwapi/client/projects/tags.rb +8 -9
  71. data/lib/bwapi/client/projects/twitter_queries.rb +7 -8
  72. data/lib/bwapi/client/projects/users.rb +4 -4
  73. data/lib/bwapi/client/projects/workflow.rb +4 -4
  74. data/lib/bwapi/client/query_validation.rb +7 -7
  75. data/lib/bwapi/client/sso.rb +4 -4
  76. data/lib/bwapi/client/test_search.rb +9 -8
  77. data/lib/bwapi/client/user.rb +6 -6
  78. data/lib/bwapi/client/user/notifications.rb +8 -8
  79. data/lib/bwapi/configuration.rb +6 -6
  80. data/lib/bwapi/connection.rb +10 -19
  81. data/lib/bwapi/error.rb +43 -36
  82. data/lib/bwapi/request.rb +24 -27
  83. data/lib/bwapi/version.rb +5 -2
  84. data/lib/faraday/response/brandwatch_error.rb +21 -22
  85. data/spec/bwapi/authentication_spec.rb +7 -7
  86. data/spec/bwapi/client_spec.rb +17 -17
  87. data/spec/bwapi_spec.rb +3 -3
  88. data/spec/fixtures/.netrc +1 -1
  89. data/spec/helper.rb +4 -2
  90. metadata +61 -4
  91. data/lib/faraday/utils/utils.rb +0 -26
@@ -1,3 +1,5 @@
1
+ # encoding: utf-8
2
+
1
3
  module BWAPI
2
4
  class Client
3
5
  module Admin
@@ -5,16 +7,14 @@ module BWAPI
5
7
  module Users
6
8
  # Sharing module for admin/users/sharing endpoints
7
9
  module Sharing
8
-
9
10
  # Get a list of project shares for user
10
11
  #
11
12
  # @param client_id [Integer] Id of the client
12
13
  # @param user_id [Integer] Id of the user
13
14
  # @return [Hashie::Mash] All shares for client user
14
- def client_users_sharing client_id, user_id
15
+ def client_users_sharing(client_id, user_id)
15
16
  get "admin/client/#{client_id}/users/#{user_id}/sharing"
16
17
  end
17
- alias :users_sharing :client_users_sharing
18
18
 
19
19
  # Update a list of project shares for user
20
20
  #
@@ -23,14 +23,12 @@ module BWAPI
23
23
  # @param opts [Hash] options Hash of parameters
24
24
  # @option opts [Array] ProjectShareDTO The shares of the user
25
25
  # @return [Hashie::Mash] Updated shares for client user
26
- def update_client_users_sharing client_id, user_id, opts
26
+ def update_client_users_sharing(client_id, user_id, opts)
27
27
  get "admin/client/#{client_id}/users/#{user_id}/sharing", opts
28
28
  end
29
- alias :update_users_sharing :update_client_users_sharing
30
-
31
29
  end
32
30
  end
33
31
  end
34
32
  end
35
33
  end
36
- end
34
+ end
@@ -1,3 +1,5 @@
1
+ # encoding: utf-8
2
+
1
3
  require 'bwapi/client/brandwatch/become'
2
4
  require 'bwapi/client/brandwatch/client_modules'
3
5
 
@@ -5,7 +7,6 @@ module BWAPI
5
7
  class Client
6
8
  # Brandwatch module for brandwatch endpoints
7
9
  module Brandwatch
8
-
9
10
  # Create a new data download in project
10
11
  #
11
12
  # @param project_id [Integer] Id of project
@@ -21,13 +22,12 @@ module BWAPI
21
22
  # @option opts [String] downloadLinkCSV The link to download the CSV format
22
23
  # @option opts [Array] additionalColumns The additional columns for the data download
23
24
  # @return [Hashie::Mash] New data download
24
- def brandwatch_data_download project_id, opts={}
25
+ def brandwatch_data_download(project_id, opts = {})
25
26
  post "brandwatch/#{project_id}/datadownload", opts
26
27
  end
27
28
 
28
29
  include BWAPI::Client::Brandwatch::Become
29
30
  include BWAPI::Client::Brandwatch::ClientModules
30
-
31
31
  end
32
32
  end
33
- end
33
+ end
@@ -1,20 +1,20 @@
1
+ # encoding: utf-8
2
+
1
3
  module BWAPI
2
4
  class Client
3
5
  module Brandwatch
4
6
  # Become module for brandwatch/become endpoint
5
7
  module Become
6
-
7
8
  # Become user
8
9
  #
9
10
  # @note must be a super admin user
10
11
  #
11
12
  # @param user_id [Integer] The user id
12
13
  # @return [Hashie::Mash] User credentials
13
- def brandwatch_become user_id
14
+ def brandwatch_become(user_id)
14
15
  get "brandwatch/become/#{user_id}"
15
16
  end
16
-
17
17
  end
18
18
  end
19
19
  end
20
- end
20
+ end
@@ -1,14 +1,14 @@
1
+ # encoding: utf-8
1
2
  module BWAPI
2
3
  class Client
3
4
  module Brandwatch
4
5
  # ClientModules module for brandwatch/clientModules endpoints
5
6
  module ClientModules
6
-
7
7
  # Get a specific clients modules
8
8
  #
9
9
  # @param client_id [Integer] Id of the client
10
10
  # @return [Hashie::Mash] Specific clients modules
11
- def brandwatch_client_modules client_id
11
+ def brandwatch_client_modules(client_id)
12
12
  get "brandwatch/clientModules/#{client_id}"
13
13
  end
14
14
 
@@ -17,11 +17,10 @@ module BWAPI
17
17
  # @param opts [Hash] options Hash of parameters
18
18
  # @option opts [Array] ClientModules Client Modules to edit
19
19
  # @return [Hashie::Mash] Update client modules
20
- def update_brandwatch_client_module opts={}
21
- put "brandwatch/clientModules", opts
20
+ def update_brandwatch_client_module(opts = {})
21
+ put 'brandwatch/clientModules', opts
22
22
  end
23
-
24
23
  end
25
24
  end
26
25
  end
27
- end
26
+ end
@@ -1,23 +1,22 @@
1
+ # encoding: utf-8
2
+
1
3
  module BWAPI
2
4
  class Client
3
5
  # Client module for client endpoints
4
6
  module Client
5
-
6
7
  # Get the current users client
7
8
  #
8
9
  # @return [Hashie::Mash] Client information
9
10
  def client
10
- get "client"
11
+ get 'client'
11
12
  end
12
13
 
13
14
  # Get the current users client modules
14
15
  #
15
16
  # @return [Hashie::Mash] Client module information
16
17
  def client_modules
17
- get "client/modules"
18
+ get 'client/modules'
18
19
  end
19
- alias :modules :client_modules
20
-
21
20
  end
22
21
  end
23
- end
22
+ end
@@ -1,3 +1,5 @@
1
+ # encoding: utf-8
2
+
1
3
  require 'bwapi/client/command_center/client'
2
4
  require 'bwapi/client/command_center/displays'
3
5
  require 'bwapi/client/command_center/scene_types'
@@ -8,13 +10,11 @@ module BWAPI
8
10
  class Client
9
11
  # CommandCenter module for commandcenter endpoints
10
12
  module CommandCenter
11
-
12
13
  include BWAPI::Client::CommandCenter::Client
13
14
  include BWAPI::Client::CommandCenter::Displays
14
15
  include BWAPI::Client::CommandCenter::SceneTypes
15
16
  include BWAPI::Client::CommandCenter::Themes
16
17
  include BWAPI::Client::CommandCenter::Users
17
-
18
18
  end
19
19
  end
20
- end
20
+ end
@@ -1,17 +1,17 @@
1
+ # encoding: utf-8
2
+
1
3
  module BWAPI
2
4
  class Client
3
5
  module CommandCenter
4
6
  # Themes module for commandcenter/themes endpoints
5
7
  module Client
6
-
7
8
  # Get vizia client information
8
9
  #
9
10
  # @return [Hashie::Mash] All themes
10
11
  def vizia_client
11
- get "commandcenter/client"
12
+ get 'commandcenter/client'
12
13
  end
13
-
14
14
  end
15
15
  end
16
16
  end
17
- end
17
+ end
@@ -1,3 +1,5 @@
1
+ # encoding: utf-8
2
+
1
3
  require 'bwapi/client/command_center/displays/events'
2
4
  require 'bwapi/client/command_center/displays/messages'
3
5
  require 'bwapi/client/command_center/displays/scenes'
@@ -9,19 +11,18 @@ module BWAPI
9
11
  module CommandCenter
10
12
  # Displays module for commandcenter/displays endpoints
11
13
  module Displays
12
-
13
14
  # Get the displays visible to the user
14
15
  #
15
16
  # @return [Hashie::Mash] All displays
16
17
  def displays
17
- get "commandcenter/displays"
18
+ get 'commandcenter/displays'
18
19
  end
19
20
 
20
21
  # Get an existing display
21
22
  #
22
23
  # @param [Integer] display_id the display id
23
24
  # @return [Hashie::Mash] Specific display
24
- def get_display display_id
25
+ def get_display(display_id)
25
26
  get "commandcenter/displays/#{display_id}"
26
27
  end
27
28
 
@@ -36,8 +37,8 @@ module BWAPI
36
37
  # @option opts [String] created Date display was created
37
38
  # @option opts [Boolean] enabled Whether display is enabled
38
39
  # @return [Hashie::Mash] New display
39
- def create_display opts={}
40
- post "commandcenter/displays", opts
40
+ def create_display(opts = {})
41
+ post 'commandcenter/displays', opts
41
42
  end
42
43
 
43
44
  # Update an existing display
@@ -52,7 +53,7 @@ module BWAPI
52
53
  # @option opts [String] created Date display was created
53
54
  # @option opts [Boolean] enabled Whether display is enabled
54
55
  # @return [Hashie::Mash] Updated display
55
- def update_display display_id, opts={}
56
+ def update_display(display_id, opts = {})
56
57
  put "commandcenter/displays/#{display_id}", opts
57
58
  end
58
59
 
@@ -60,7 +61,7 @@ module BWAPI
60
61
  #
61
62
  # @param [Integer] display_id the display id
62
63
  # @return [Hashie::Mash] Deleted display
63
- def delete_display display_id
64
+ def delete_display(display_id)
64
65
  delete "commandcenter/displays/#{display_id}"
65
66
  end
66
67
 
@@ -69,8 +70,7 @@ module BWAPI
69
70
  include BWAPI::Client::CommandCenter::Displays::Scenes
70
71
  include BWAPI::Client::CommandCenter::Displays::Screens
71
72
  include BWAPI::Client::CommandCenter::Displays::Users
72
-
73
73
  end
74
74
  end
75
75
  end
76
- end
76
+ end
@@ -1,15 +1,16 @@
1
+ # encoding: utf-8
2
+
1
3
  module BWAPI
2
4
  class Client
3
5
  module CommandCenter
4
6
  module Displays
5
7
  # Displays module for commandcenter/displays/events endpoints
6
8
  module Events
7
-
8
9
  # Get the events for an existing display
9
10
  #
10
11
  # @param [Integer] display_id The display id
11
12
  # @return [Hashie::Mash] All events for display
12
- def events display_id
13
+ def events(display_id)
13
14
  get "commandcenter/displays/#{display_id}/events"
14
15
  end
15
16
 
@@ -18,7 +19,7 @@ module BWAPI
18
19
  # @param [Integer] display_id The display id
19
20
  # @param [Integer] event_id The event id
20
21
  # @return [Hashie::Mash] Specific event for display
21
- def get_event display_id, event_id
22
+ def get_event(display_id, event_id)
22
23
  get "commandcenter/displays/#{display_id}/events/#{event_id}"
23
24
  end
24
25
 
@@ -38,7 +39,7 @@ module BWAPI
38
39
  # @option opts [Boolean] enabled Whether event is enabled
39
40
  # @option opts [Hash] filters Event filter options
40
41
  # @return [Hashie::Mash] New display event
41
- def create_event display_id, opts={}
42
+ def create_event(display_id, opts = {})
42
43
  post "commandcenter/displays/#{display_id}/events", opts
43
44
  end
44
45
 
@@ -58,7 +59,7 @@ module BWAPI
58
59
  # @option opts [Boolean] enabled Whether event is enabled
59
60
  # @option opts [Hash] filters Event filter options
60
61
  # @return [Hashie::Mash] Updated display event
61
- def update_event display_id, event_id, opts={}
62
+ def update_event(display_id, event_id, opts = {})
62
63
  put "commandcenter/displays/#{display_id}/events/#{event_id}", opts
63
64
  end
64
65
 
@@ -67,12 +68,11 @@ module BWAPI
67
68
  # @param [Integer] display_id The display id
68
69
  # @param [Integer] event_id The event id
69
70
  # @return [Hashie::Mash] Deleted display event
70
- def delete_event display_id, event_id
71
+ def delete_event(display_id, event_id)
71
72
  delete "commandcenter/displays/#{display_id}/events/#{event_id}"
72
73
  end
73
-
74
74
  end
75
75
  end
76
76
  end
77
77
  end
78
- end
78
+ end
@@ -1,15 +1,15 @@
1
+ # encoding: utf-8
1
2
  module BWAPI
2
3
  class Client
3
4
  module CommandCenter
4
5
  module Displays
5
6
  # Displays module for commandcenter/displays/messages endpoints
6
7
  module Messages
7
-
8
8
  # Get the messages for an existing display
9
9
  #
10
10
  # @param [Integer] display_id The display id
11
11
  # @return [Hashie::Mash] All messages for display
12
- def messages display_id
12
+ def messages(display_id)
13
13
  get "commandcenter/displays/#{display_id}/messages"
14
14
  end
15
15
 
@@ -18,7 +18,7 @@ module BWAPI
18
18
  # @param [Integer] display_id The display id
19
19
  # @param [Integer] message_id The message id
20
20
  # @return [Hashie::Mash] Specific message for display
21
- def get_message display_id, message_id
21
+ def get_message(display_id, message_id)
22
22
  get "commandcenter/displays/#{display_id}/messages/#{message_id}"
23
23
  end
24
24
 
@@ -36,7 +36,7 @@ module BWAPI
36
36
  # @option opts [Boolean] enabled Whether message is enabled
37
37
  # @option opts [Array] screenIds ScreenIds where message is shown
38
38
  # @return [Hashie::Mash] New display message
39
- def create_message display_id, opts={}
39
+ def create_message(display_id, opts = {})
40
40
  post "commandcenter/displays/#{display_id}/message", opts
41
41
  end
42
42
 
@@ -54,7 +54,7 @@ module BWAPI
54
54
  # @option opts [Boolean] enabled Whether message is enabled
55
55
  # @option opts [Array] screenIds ScreenIds where message is shown
56
56
  # @return [Hashie::Mash] Updated display message
57
- def update_message display_id, message_id, opts={}
57
+ def update_message(display_id, message_id, opts = {})
58
58
  put "commandcenter/displays/#{display_id}/messages/#{message_id}", opts
59
59
  end
60
60
 
@@ -63,12 +63,11 @@ module BWAPI
63
63
  # @param [Integer] display_id The display id
64
64
  # @param [Integer] message_id The message id
65
65
  # @return [Hashie::Mash] Deleted display message
66
- def delete_message display_id, message_id
66
+ def delete_message(display_id, message_id)
67
67
  delete "commandcenter/displays/#{display_id}/messages/#{message_id}"
68
68
  end
69
-
70
69
  end
71
70
  end
72
71
  end
73
72
  end
74
- end
73
+ end
@@ -1,15 +1,16 @@
1
+ # encoding: utf-8
2
+
1
3
  module BWAPI
2
4
  class Client
3
5
  module CommandCenter
4
6
  module Displays
5
7
  # Displays module for commandcenter/displays/scenes endpoints
6
8
  module Scenes
7
-
8
9
  # Get the scenes for an existing display
9
10
  #
10
11
  # @param [Integer] display_id The display id
11
12
  # @return [Hashie::Mash] All scenes for display
12
- def scenes display_id
13
+ def scenes(display_id)
13
14
  get "commandcenter/displays/#{display_id}/scenes"
14
15
  end
15
16
 
@@ -18,7 +19,7 @@ module BWAPI
18
19
  # @param [Integer] display_id The display id
19
20
  # @param [Integer] scene_id The scene id
20
21
  # @return [Hashie::Mash] Specific scene for display
21
- def get_scene display_id, scene_id
22
+ def get_scene(display_id, scene_id)
22
23
  get "commandcenter/displays/#{display_id}/scenes/#{scene_id}"
23
24
  end
24
25
 
@@ -27,7 +28,7 @@ module BWAPI
27
28
  # @param [Integer] display_id The display id
28
29
  # @param [Integer] scene_id The scene id
29
30
  # @return [Hashie::Mash] Specific sub scenes for display scene
30
- def get_scene_with_sub_scenes display_id, scene_id
31
+ def get_scene_with_sub_scenes(display_id, scene_id)
31
32
  get "commandcenter/displays/#{display_id}/scenes/#{scene_id}/subscenes"
32
33
  end
33
34
 
@@ -46,7 +47,7 @@ module BWAPI
46
47
  # @option opts [Boolean] enabled Whether scene is enabled
47
48
  # @option opts [Hash] filter Filter options
48
49
  # @return [Hashie::Mash] New display scene
49
- def create_scene display_id, opts={}
50
+ def create_scene(display_id, opts = {})
50
51
  post "commandcenter/displays/#{display_id}/scenes", opts
51
52
  end
52
53
 
@@ -65,7 +66,7 @@ module BWAPI
65
66
  # @option opts [Boolean] enabled Whether scene is enabled
66
67
  # @option opts [Hash] filter Filter options
67
68
  # @return [Hashie::Mash] Updated display scene
68
- def update_scene display_id, scene_id, opts={}
69
+ def update_scene(display_id, scene_id, opts = {})
69
70
  put "commandcenter/displays/#{display_id}/scenes/#{scene_id}", opts
70
71
  end
71
72
 
@@ -74,12 +75,11 @@ module BWAPI
74
75
  # @param [Integer] display_id The display id
75
76
  # @param [Integer] scene_id The scene id
76
77
  # @return [Hashie::Mash] Deleted display scene
77
- def delete_scene display_id, scene_id
78
+ def delete_scene(display_id, scene_id)
78
79
  delete "commandcenter/displays/#{display_id}/scenes/#{scene_id}"
79
80
  end
80
-
81
81
  end
82
82
  end
83
83
  end
84
84
  end
85
- end
85
+ end