bwapi 10.0.0.pre.549 → 10.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2VhNGVkM2JmZTY4Y2NjODhmZTVjMDIzODUxYzQ0NDg0YTJlYTE1Ng==
-  data.tar.gz: !binary |-
-    MmNlMDc2Nzc2NDExZGM1ODE4MzgxNTQ5MmMzZGEzYWQwNjViNmM5Nw==
+SHA1:
+  metadata.gz: 6d9f016e4bc3be418b87ee218885361211367513
+  data.tar.gz: 85912ea24c6d2f4de96252032a1a03af8abb1940
 SHA512:
-  metadata.gz: !binary |-
-    NmQ0MjhkYmE0OTQ5NmNiMGYxZjRmMjQ3YTdmYzQ2ODkxYzc5N2Q0MzJhYzYz
-    ZjMwNjFhZDNlNzZiZTliYjM2Nzc3YzM3MjNiMjUzMDk4Y2IxZTE2NDZlZjZh
-    ODNlOTkzYzJmNjBkNGY3Yzg2MTExZTUwMjQ2ZDY1ZmFhM2Y0YmE=
-  data.tar.gz: !binary |-
-    MWMzZmZjMmVhNGJjNWI4OTk2ZWUzN2ZiMGZlNGFmOGMxZmZkNzM4MTU2MjEx
-    ZDg3MWY3ZjQ4NTRmN2ZiNjJlOWM5ZDc2NmU2YjVjODIxMTY4MTA5ODM0MTk5
-    OWNjZTRjYzNhZDUwYzQ1MGRjZmY4ODdlMGU0YmJkNGY3MTI3YTg=
+  metadata.gz: 0b5b7ef979fe845621032300dc9cb279875be0eb77c275c20ab353ed86dc767f088082d2eb8752d44c6a76448f4af17eea8eb12873a6e84132d894a6564725ae
+  data.tar.gz: de0ca9c16a38db3acba187739fcc75d1c8d1b7a4a657eb333031a407db5bd914dbdc1924b3182df10189ec1d3a4eb967ab2e9f22f02502b0b066d787e7d5b583

data/.editorconfig

@@ -7,5 +7,5 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.rb]
-indent_style = space
+indent_style = spaces
 indent_size = 2

data/.gitignore

@@ -2,7 +2,7 @@
 *.rbc
 .bundle
 .config
-.idea/
+.idea
 coverage
 InstalledFiles
 lib/bundler/man

data/lib/bwapi/client.rb

@@ -4,12 +4,9 @@ require 'bwapi/request'
 require 'bwapi/performance'
 
 require 'bwapi/client/admin'
-require 'bwapi/client/aggregates'
-require 'bwapi/client/author'
 require 'bwapi/client/brandwatch'
 require 'bwapi/client/client'
 require 'bwapi/client/command_center'
-require 'bwapi/client/dimensions'
 require 'bwapi/client/error_codes'
 require 'bwapi/client/filters'
 require 'bwapi/client/languages'
@@ -19,9 +16,9 @@ require 'bwapi/client/me'
 require 'bwapi/client/metrics'
 require 'bwapi/client/oauth'
 require 'bwapi/client/ping'
+require 'bwapi/client/sso'
 require 'bwapi/client/projects'
 require 'bwapi/client/query_validation'
-require 'bwapi/client/sso'
 require 'bwapi/client/test_search'
 require 'bwapi/client/user'
 require 'faraday'
@@ -35,12 +32,9 @@ module BWAPI
     include BWAPI::Performance
 
     include BWAPI::Client::Admin
-    include BWAPI::Client::Aggregates
-    include BWAPI::Client::Author
     include BWAPI::Client::Brandwatch
     include BWAPI::Client::Client
     include BWAPI::Client::CommandCenter
-    include BWAPI::Client::Dimensions
     include BWAPI::Client::ErrorCodes
     include BWAPI::Client::Filters
     include BWAPI::Client::Languages
@@ -51,8 +45,8 @@ module BWAPI
     include BWAPI::Client::OAuth
     include BWAPI::Client::Ping
     include BWAPI::Client::Projects
-    include BWAPI::Client::QueryValidation
     include BWAPI::Client::SSO
+    include BWAPI::Client::QueryValidation
     include BWAPI::Client::TestSearch
     include BWAPI::Client::User
 
@@ -65,19 +59,11 @@ module BWAPI
       end
     end
 
-    # Check is access token has expired
-    #
-    # @return [Boolean] access token expiry status
-    def access_token_expired?
-      return true if @access_token.nil? || @access_token_expiry.nil?
-      seconds_until_access_token_expires <= 0
-    end
-
     # Check if user is authenicated
     #
     # @return [Boolean] Authenticated status
     def authenticated?
-      (@access_token && !access_token_expired?) ? true : false
+      @access_token ? true : false
     end
 
     # Check if user is a brandwatch-application-client type
@@ -123,14 +109,5 @@ module BWAPI
       reset_connection
       @verify_ssl = value
     end
-
-    private
-
-    # Returns the number of seconds until the access token expires
-    #
-    # @return [Integer] seconds until expiry
-    def seconds_until_access_token_expires
-      DateTime.parse(@access_token_expiry).to_time.to_i - Time.now.to_i
-    end
   end
 end

data/lib/bwapi/client/admin.rb

@@ -1,5 +1,4 @@
 require 'bwapi/client/admin/become'
-require 'bwapi/client/admin/demographics'
 require 'bwapi/client/admin/search'
 require 'bwapi/client/admin/clients/sub_clients'
 require 'bwapi/client/admin/clients/users'
@@ -28,7 +27,6 @@ module BWAPI
       end
 
       include BWAPI::Client::Admin::Become
-      include BWAPI::Client::Admin::Demographics
       include BWAPI::Client::Admin::Search
       include BWAPI::Client::Admin::Clients::SubClients
       include BWAPI::Client::Admin::Clients::Users

data/lib/bwapi/client/brandwatch.rb

@@ -1,8 +1,5 @@
 require 'bwapi/client/brandwatch/become'
 require 'bwapi/client/brandwatch/clients'
-require 'bwapi/client/brandwatch/log_level'
-require 'bwapi/client/brandwatch/price_structures'
-require 'bwapi/client/brandwatch/usage_report'
 
 module BWAPI
   class Client
@@ -29,9 +26,6 @@ module BWAPI
 
       include BWAPI::Client::Brandwatch::Become
       include BWAPI::Client::Brandwatch::Clients
-      include BWAPI::Client::Brandwatch::LogLevel
-      include BWAPI::Client::Brandwatch::PriceStructures
-      include BWAPI::Client::Brandwatch::UsageReport
     end
   end
 end

data/lib/bwapi/client/brandwatch/become.rb

@@ -5,6 +5,8 @@ module BWAPI
       module Become
         # Become user
         #
+        # @note must be a super admin user
+        #
         # @param user_id [Integer] The user id
         # @return [Hash] User credentials
         def brandwatch_become(user_id)

data/lib/bwapi/client/brandwatch/clients.rb

@@ -1,4 +1,3 @@
-require 'bwapi/client/brandwatch/clients/command_center'
 require 'bwapi/client/brandwatch/clients/users'
 require 'bwapi/client/brandwatch/clients/modules'
 
@@ -9,6 +8,8 @@ module BWAPI
       module Clients
         # Get specific clients
         #
+        # @note must be a super admin user
+        #
         # @param opts [Hash] options Hash of parameters
         # @options opts [String] nameContains Client name search (case insensitive)
         # @return [Hash] List of filtered clients
@@ -18,6 +19,8 @@ module BWAPI
 
         # Create a new parent client
         #
+        # @note must be a super admin user
+        #
         # @param opts [Hash] options Hash of parameters
         # @option opts [String] address1 Address line one of the client
         # @option opts [String] address2 Address line two of the client
@@ -53,6 +56,8 @@ module BWAPI
 
         # Get specific client
         #
+        # @note must be a super admin user
+        #
         # @param client_id [Integer] Id of the client
         # @return [Hash] Specific client
         def brandwatch_get_client(client_id)
@@ -61,6 +66,8 @@ module BWAPI
 
         # Update an existing parent client
         #
+        # @note must be a super admin user
+        #
         # @param client_id [Integer] Id of the client
         # @param opts [Hash] options Hash of parameters
         # @option opts [String] address1 Address line one of the client
@@ -95,7 +102,6 @@ module BWAPI
           put "brandwatch/clients/#{client_id}", opts
         end
 
-        include BWAPI::Client::Brandwatch::Clients::CommandCenter
         include BWAPI::Client::Brandwatch::Clients::Users
         include BWAPI::Client::Brandwatch::Clients::Modules
       end

data/lib/bwapi/client/brandwatch/clients/users.rb

@@ -6,6 +6,8 @@ module BWAPI
         module Users
           # Create a new client user
           #
+          # @note must be a super admin user
+          #
           # @param client_id [Integer] Id of the client
           # @param opts [Hash] options Hash of parameters
           # @option opts [String] address The users address

data/lib/bwapi/client/command_center.rb

@@ -1,12 +1,6 @@
-require 'bwapi/client/command_center/category_colours'
 require 'bwapi/client/command_center/client'
-require 'bwapi/client/command_center/colour_palette'
-require 'bwapi/client/command_center/display_access'
 require 'bwapi/client/command_center/displays'
-require 'bwapi/client/command_center/projects'
-require 'bwapi/client/command_center/query_colours'
 require 'bwapi/client/command_center/scene_types'
-require 'bwapi/client/command_center/tag_colours'
 require 'bwapi/client/command_center/themes'
 require 'bwapi/client/command_center/users'
 
@@ -14,15 +8,9 @@ module BWAPI
   class Client
     # CommandCenter module for commandcenter endpoints
     module CommandCenter
-      include BWAPI::Client::CommandCenter::CategoryColours
       include BWAPI::Client::CommandCenter::Client
-      include BWAPI::Client::CommandCenter::ColourPalette
-      include BWAPI::Client::CommandCenter::DisplayAccess
       include BWAPI::Client::CommandCenter::Displays
-      include BWAPI::Client::CommandCenter::Projects
-      include BWAPI::Client::CommandCenter::QueryColours
       include BWAPI::Client::CommandCenter::SceneTypes
-      include BWAPI::Client::CommandCenter::TagColours
       include BWAPI::Client::CommandCenter::Themes
       include BWAPI::Client::CommandCenter::Users
     end

data/lib/bwapi/client/command_center/displays/scenes.rb

@@ -35,7 +35,7 @@ module BWAPI
           # @param [Integer] display_id The display id
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] id The id of scene
-          # @option opts [String] name The name of the scene
+          # @option opts String] name The name of the scene
           # @option opts [Integer] projectId The project id
           # @option opts [Integer] displayId The display id
           # @option opts [Hash] options Scene options

data/lib/bwapi/client/command_center/scene_types.rb

@@ -1,7 +1,7 @@
 module BWAPI
   class Client
     module CommandCenter
-      # SceneTypes module for commandcenter/scenetypes endpoints
+      # Displays module for commandcenter/scenetypes endpoints
       module SceneTypes
         # Get the scene types visible to the user
         #
@@ -18,12 +18,12 @@ module BWAPI
           get "commandcenter/scenetypes/#{scene_type_id}"
         end
 
-        # Get an existing scene type sub scene types
+        # Get an existing scene type
         #
         # @param [Integer] scene_type_id the scene type id
         # @return [Hash] Specific scene type with sub scences
         def get_scene_type_with_sub_scenes(scene_type_id)
-          get "commandcenter/scenetypes/#{scene_type_id}/subscenes"
+          get "commandcenter/scenetypes/#{scene_type_id}"
         end
       end
     end

data/lib/bwapi/client/oauth.rb

@@ -61,8 +61,7 @@ module BWAPI
       # @param opts [Hash] options hash of parameters
       def oauth_request(opts = {})
         response = post('oauth/token', opts)
-        self.access_token = response['access_token']
-        self.access_token_expiry = Time.at(Time.now.to_i + response['expires_in']).iso8601
+        self.access_token  = response['access_token']
         self.refresh_token = response['refresh_token'] if application_client?
         response
       end

data/lib/bwapi/client/projects.rb

@@ -1,20 +1,19 @@
-require 'bwapi/client/projects/bulk_actions'
+require 'bwapi/client/projects/bulkactions'
 require 'bwapi/client/projects/categories'
 require 'bwapi/client/projects/data'
 require 'bwapi/client/projects/data_download'
 require 'bwapi/client/projects/demographics'
 require 'bwapi/client/projects/facebook_queries'
+require 'bwapi/client/projects/twitter_queries'
 require 'bwapi/client/projects/group'
+require 'bwapi/client/projects/signals'
+require 'bwapi/client/projects/summary'
+require 'bwapi/client/projects/sharing'
+require 'bwapi/client/projects/stream_dashboards'
 require 'bwapi/client/projects/queries'
-require 'bwapi/client/projects/query/mentionfind'
 require 'bwapi/client/projects/query_groups'
 require 'bwapi/client/projects/rules'
-require 'bwapi/client/projects/sharing'
-require 'bwapi/client/projects/signals'
-require 'bwapi/client/projects/stream_dashboards'
-require 'bwapi/client/projects/summary'
 require 'bwapi/client/projects/tags'
-require 'bwapi/client/projects/twitter_queries'
 require 'bwapi/client/projects/users'
 require 'bwapi/client/projects/workflow'
 
@@ -88,16 +87,15 @@ module BWAPI
       include BWAPI::Client::Projects::Demographics
       include BWAPI::Client::Projects::FacebookQueries
       include BWAPI::Client::Projects::Group
+      include BWAPI::Client::Projects::TwitterQueries
+      include BWAPI::Client::Projects::Signals
+      include BWAPI::Client::Projects::Summary
+      include BWAPI::Client::Projects::Sharing
+      include BWAPI::Client::Projects::StreamDashboards
       include BWAPI::Client::Projects::Queries
-      include BWAPI::Client::Projects::Query::MentionFind
       include BWAPI::Client::Projects::QueryGroups
       include BWAPI::Client::Projects::Rules
-      include BWAPI::Client::Projects::Sharing
-      include BWAPI::Client::Projects::Signals
-      include BWAPI::Client::Projects::StreamDashboards
-      include BWAPI::Client::Projects::Summary
       include BWAPI::Client::Projects::Tags
-      include BWAPI::Client::Projects::TwitterQueries
       include BWAPI::Client::Projects::Users
       include BWAPI::Client::Projects::Workflow
     end

data/lib/bwapi/client/projects/{bulk_actions.rb → bulkactions.rb}

@@ -1,5 +1,5 @@
-require 'bwapi/client/projects/bulk_actions/mentions'
-require 'bwapi/client/projects/bulk_actions/author'
+require 'bwapi/client/projects/bulkactions/mentions'
+require 'bwapi/client/projects/bulkactions/author'
 
 module BWAPI
   class Client

data/lib/bwapi/client/projects/data.rb

@@ -1,14 +1,4 @@
-require 'bwapi/client/projects/data/audience'
-require 'bwapi/client/projects/data/audience_activity'
-require 'bwapi/client/projects/data/channel_metrics'
-require 'bwapi/client/projects/data/emoticons'
-require 'bwapi/client/projects/data/hashtags'
-require 'bwapi/client/projects/data/headlines'
-require 'bwapi/client/projects/data/mentioned_authors'
-require 'bwapi/client/projects/data/impressions'
 require 'bwapi/client/projects/data/mentions'
-require 'bwapi/client/projects/data/owner_activity'
-require 'bwapi/client/projects/data/urls'
 require 'bwapi/client/projects/data/volume'
 
 module BWAPI
@@ -39,17 +29,7 @@ module BWAPI
           get "projects/#{project_id}/data/headlines", opts
         end
 
-        include BWAPI::Client::Projects::Data::Audience
-        include BWAPI::Client::Projects::Data::AudienceActivity
-        include BWAPI::Client::Projects::Data::ChannelMetrics
-        include BWAPI::Client::Projects::Data::Emoticons
-        include BWAPI::Client::Projects::Data::Hashtags
-        include BWAPI::Client::Projects::Data::Headlines
-        include BWAPI::Client::Projects::Data::Impressions
-        include BWAPI::Client::Projects::Data::MentionedAuthors
         include BWAPI::Client::Projects::Data::Mentions
-        include BWAPI::Client::Projects::Data::OwnerActivity
-        include BWAPI::Client::Projects::Data::Urls
         include BWAPI::Client::Projects::Data::Volume
       end
     end

data/lib/bwapi/client/projects/data/mentions.rb

@@ -31,7 +31,7 @@ module BWAPI
             patch "projects/#{project_id}/data/mentions", opts
           end
 
-          # Get mentions that fall within the submitted filters with full text
+          # Get mentions that fall within the submitted filters with fulltext
           #
           # @param project_id [Integer] Id of project
           # @param opts [Hash] options hash of parameters
@@ -42,7 +42,7 @@ module BWAPI
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
           # @return [Hash] All Mentions
-          def data_mentions_full_text(project_id, opts = {})
+          def data_mentions_fulltext(project_id, opts = {})
             get "projects/#{project_id}/data/mentions/fulltext", opts
           end
 
@@ -61,36 +61,6 @@ module BWAPI
             get "projects/#{project_id}/data/mentions/tweets", opts
           end
 
-          # Get mentions that fall within the submitted filters for all facebook posts
-          #
-          # @param project_id [Integer] Id of project
-          # @param opts [Hash] options hash of parameters
-          # @option opts [Hash] filter The filters to apply
-          # @option opts [Integer] page Page of projects to retrieve
-          # @option opts [Integer] pageSize Results per page of results
-          # @option opts [String] orderBy Parameter to sort by
-          # @option opts [String] orderDirection Direction of sort
-          # @option opts [Integer] orderByCategory Category to sort by when orderBy category
-          # @return [Hash] All Mentions
-          def data_mentions_facebook_posts(project_id, opts = {})
-            get "projects/#{project_id}/data/mentions/facebookposts", opts
-          end
-
-          # Get mentions that fall within the submitted filters for all facebook comments
-          #
-          # @param project_id [Integer] Id of project
-          # @param opts [Hash] options hash of parameters
-          # @option opts [Hash] filter The filters to apply
-          # @option opts [Integer] page Page of projects to retrieve
-          # @option opts [Integer] pageSize Results per page of results
-          # @option opts [String] orderBy Parameter to sort by
-          # @option opts [String] orderDirection Direction of sort
-          # @option opts [Integer] orderByCategory Category to sort by when orderBy category
-          # @return [Hash] All Mentions
-          def data_mentions_facebook_comments(project_id, opts = {})
-            get "projects/#{project_id}/data/mentions/facebookcomments", opts
-          end
-
           include BWAPI::Client::Projects::Data::Mentions::Notes
         end
       end

data/lib/bwapi/client/projects/signals/groups.rb

@@ -10,22 +10,20 @@ module BWAPI
           # @param projectId [Integer] Id of the existing project
           # @option opts [Integer] page Page of results to retrieve
           # @option opts [Integer] pageSize Results per page of results
-          # @return [Hash] Returns All signal groups for project
+          # @return [Hash] All signal groups for project
           def signal_groups(project_id, opts = {})
             get "/projects/#{project_id}/signals/groups", opts
           end
 
           # Get a specific signal group
-          #
           # @param projectId [Integer] Id of project
           # @param groupId [Integer] Id of group
-          # @return [Hash] Returns a specific signals group
+          # @return [Hash] specific signals group
           def get_signal_group(project_id, group_id)
             get "/projects/#{project_id}/signals/groups/#{group_id}"
           end
 
           # Create a new signal group
-          #
           # @param projectId [Integer] Project ID of the Signal Group to be updated
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] projectId Project ID of Signal Group
@@ -35,13 +33,12 @@ module BWAPI
           # @option opts [Date] lastModified Last modified date of the Signal Group
           # @option opts [Integer] id ID of Signal Group
           # @option opts [String] creator Creator of the Signal Group
-          # @return [Hash] Retuns the new signal group
+          # @return [Hash] new signal group
           def create_signal_group(project_id, opts = {})
             post "/projects/#{project_id}/signals/groups", opts
           end
 
           # Update a signal group
-          #
           # @param projectId [Integer] Project ID of the Signal Group to be updated
           # @param groupId [Integer] Id of group
           # @param opts [Hash] options hash of parameters
@@ -52,28 +49,18 @@ module BWAPI
           # @option opts [Date] lastModified Last modified date of the Signal Group
           # @option opts [Integer] id ID of Signal Group
           # @option opts [String] creator Creator of the Signal Group
-          # @return [Hash] Returns the updated signal group
+          # @return [Hash] updated signal group
           def update_signal_group(project_id, group_id, opts = {})
             put "/projects/#{project_id}/signals/groups/#{group_id}", opts
           end
 
           # Delete a signal group
-          #
           # @param projectId [Integer] Id of project
           # @param groupId [Integer] Id of group
-          # @return [Hash] Returns the deleted signal group
+          # @return [Hash] deleted signal group
           def delete_signal_group(project_id, group_id)
             delete "/projects/#{project_id}/signals/groups/#{group_id}"
           end
-
-          # Get all signals for a specific group
-          #
-          # @param projectId [Integer] Id of project
-          # @param groupId [Integer] Id of group
-          # @return [Hash] Returns a specific signal group signals
-          def get_signal_group_signals(project_id, group_id)
-            get "/projects/#{project_id}/signals/groups/#{group_id}/signals"
-          end
         end
       end
     end