bwapi 10.0.0 → 11.0.0.pre.550

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 6d9f016e4bc3be418b87ee218885361211367513
-  data.tar.gz: 85912ea24c6d2f4de96252032a1a03af8abb1940
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmE0Zjc0MzMxYWQ3YTYxZjUxYTA3Njg0OGViNzQ4ZDc2YzEwYjRlYw==
+  data.tar.gz: !binary |-
+    ZWMwNjk4YzI5ZTViMzYzM2M1MmNhMGEzZjY0OTI1ODYyYWQ3OTE3ZA==
 SHA512:
-  metadata.gz: 0b5b7ef979fe845621032300dc9cb279875be0eb77c275c20ab353ed86dc767f088082d2eb8752d44c6a76448f4af17eea8eb12873a6e84132d894a6564725ae
-  data.tar.gz: de0ca9c16a38db3acba187739fcc75d1c8d1b7a4a657eb333031a407db5bd914dbdc1924b3182df10189ec1d3a4eb967ab2e9f22f02502b0b066d787e7d5b583
+  metadata.gz: !binary |-
+    OWE2NDQ3YWI0YzY4NzYxMTc1MGNjMDM2ZDM0MTE2MDAwNmM0YjMzMTYwYjVm
+    OTc3Nzg2M2Y4ZWZmZmQwMTE4YzYyNjQ2MjIxZDgwMmZkY2JlMjIwZGE4ODMw
+    YTkyNGFmNDdhYTQxN2QyM2JhZjI1NTQ2N2Y4NzBjNzNhZDYzNjc=
+  data.tar.gz: !binary |-
+    NzZjM2MxYWZmNmJhYjlmN2RkMDU3NjdmZTYyNDI3Yzk5YzFhZDA4ZmFiODgw
+    ODQzZmNjNmMyZDE3MjcwODhmYTVlYjAxNDkyODU4ZmMyN2VkNDgyNTcwOTRi
+    ZGEyYWI1ZjA4NGVkY2Y0ZjMzNTZjYTE5NmFjZWFjMjE1MzNkYjU=

data/.editorconfig

@@ -7,5 +7,5 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.rb]
-indent_style = spaces
+indent_style = space
 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,9 +4,12 @@ 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'
@@ -16,9 +19,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'
@@ -32,9 +35,12 @@ 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
@@ -45,8 +51,8 @@ module BWAPI
     include BWAPI::Client::OAuth
     include BWAPI::Client::Ping
     include BWAPI::Client::Projects
-    include BWAPI::Client::SSO
     include BWAPI::Client::QueryValidation
+    include BWAPI::Client::SSO
     include BWAPI::Client::TestSearch
     include BWAPI::Client::User
 
@@ -59,11 +65,19 @@ 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 ? true : false
+      (@access_token && !access_token_expired?) ? true : false
     end
 
     # Check if user is a brandwatch-application-client type
@@ -109,5 +123,14 @@ 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,4 +1,5 @@
 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'
@@ -27,6 +28,7 @@ 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/admin/demographics.rb

@@ -0,0 +1,17 @@
+module BWAPI
+  class Client
+    module Admin
+      # Demographics module for admin/demographics endpoints
+      module Demographics
+        # Get the classification of an author by author description
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [String] description of the author
+        # @return [Hash] Classification of an author
+        def classify_author(opts = {})
+          get 'admin/demographics/classify', opts
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/aggregates.rb

@@ -0,0 +1,13 @@
+module BWAPI
+  class Client
+    # Aggregates module for aggregates endpoints
+    module Aggregates
+      # Get the list of current aggregate dimensions
+      #
+      # @return [Array] All aggregates
+      def aggregates
+        get 'aggregates'
+      end
+    end
+  end
+end

data/lib/bwapi/client/author.rb

@@ -0,0 +1,56 @@
+module BWAPI
+  class Client
+    # Author module for author endpoints
+    module Author
+      # Gets all author professions
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] page Page of results to retrieve
+      # @option opts [Integer] pageSize Results per page of results
+      # @return [Hash] All author professions
+      def author_professions(opts = {})
+        get 'authors/professions', opts
+      end
+
+      # Gets all author interests
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] page Page of results to retrieve
+      # @option opts [Integer] pageSize Results per page of results
+      # @return [Hash] All author interests
+      def author_interests(opts = {})
+        get 'authors/interests', opts
+      end
+
+      # Get an Author with its associated accounts using an account name/domain tuple
+      #
+      # @param name [String] Account username
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] domain Account domain
+      # @return [Hash] Author
+      def get_author(name, opts = {})
+        get "authors/#{name}", opts
+      end
+
+      # Update an Author using an account name/domain tuple
+      #
+      # @param name [String] Account username
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] accountType Account type of Author Patch
+      # @option opts [Array] addInterests Interests to add of Author Patch
+      # @option opts [Array] addProfessions Professions to add of Author Patch
+      # @option opts [String] domain Domain of Author Patch
+      # @option opts [String] gender Gender of Author Patch
+      # @option opts [Integer] projectId Project ID of Author Patch
+      # @option opts [Integer] queryId Query ID of Author Patch
+      # @option opts [Array] removeInterests Interests to remove of Author Patch
+      # @option opts [Array] removeProfessions Professions to remove of Author Patch
+      # @option opts [Integer] resourceId Resource ID of Author Patch
+      # @option opts [String] username Username of Author to be patched
+      # @return [Hash] Updated author
+      def update_author(name, opts = {})
+        patch "authors/#{name}", opts
+      end
+    end
+  end
+end

data/lib/bwapi/client/brandwatch.rb

@@ -1,5 +1,8 @@
 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
@@ -26,6 +29,9 @@ 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,8 +5,6 @@ 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,3 +1,4 @@
+require 'bwapi/client/brandwatch/clients/command_center'
 require 'bwapi/client/brandwatch/clients/users'
 require 'bwapi/client/brandwatch/clients/modules'
 
@@ -8,8 +9,6 @@ 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
@@ -19,8 +18,6 @@ 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
@@ -56,8 +53,6 @@ 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)
@@ -66,8 +61,6 @@ 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
@@ -102,6 +95,7 @@ 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/command_center.rb

@@ -0,0 +1,20 @@
+require 'bwapi/client/brandwatch/clients/command_center/limits'
+require 'bwapi/client/brandwatch/clients/command_center/scene_types'
+require 'bwapi/client/brandwatch/clients/command_center/themes'
+require 'bwapi/client/brandwatch/clients/command_center/users'
+
+module BWAPI
+  class Client
+    module Brandwatch
+      module Clients
+        # CommandCenter module for brandwatch/client/{client_id}/commandcenter endpoints
+        module CommandCenter
+          include BWAPI::Client::Brandwatch::Clients::CommandCenter::Limits
+          include BWAPI::Client::Brandwatch::Clients::CommandCenter::SceneTypes
+          include BWAPI::Client::Brandwatch::Clients::CommandCenter::Themes
+          include BWAPI::Client::Brandwatch::Clients::CommandCenter::Users
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module Clients
+        module CommandCenter
+          # Limits module for brandwatch/client/{client_id}/commandcenter/limits endpoints
+          module Limits
+            # Fetch configured limits for a Vizia client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_vizia_limits(client_id)
+              get "/brandwatch/clients/#{client_id}/commandcenter/limits"
+            end
+
+            # Create limits for a Vizia client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_create_vizia_limits(client_id, opts = {})
+              post "/brandwatch/clients/#{client_id}/commandcenter/limits", opts
+            end
+
+            # Update limits for a Vizia client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_update_vizia_limits(client_id, opts = {})
+              put "/brandwatch/clients/#{client_id}/commandcenter/limits", opts
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module Clients
+        module CommandCenter
+          # SceneTypes module for brandwatch/client/{client_id}/commandcenter/scenetypes endpoints
+          module SceneTypes
+            # Fetch all scene types enabled for given client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_scene_types(client_id)
+              get "/brandwatch/clients/#{client_id}/commandcenter/scenetypes"
+            end
+
+            # Alter Vizia scene types enabled for client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_update_scene_type(client_id, opts = {})
+              put "/brandwatch/clients/#{client_id}/commandcenter/scenetypes", opts
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module Clients
+        module CommandCenter
+          # Themes module for brandwatch/client/{client_id}/commandcenter/themes endpoints
+          module Themes
+            # Get Vizia themes enabled for client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_themes(client_id)
+              get "brandwatch/client/#{client_id}/commandcenter/themes"
+            end
+
+            # Alter Vizia themes enabled for client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_update_themes(client_id, opts = {})
+              get "brandwatch/client/#{client_id}/commandcenter/themes", opts
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'bwapi/client/brandwatch/clients/command_center/users/access'
+
+module BWAPI
+  class Client
+    module Brandwatch
+      module Clients
+        module CommandCenter
+          # Users module for brandwatch/client/{client_id}/commandcenter/users endpoints
+          module Users
+            # Fetch Vizia access levels for all users in client
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_users_access_levels(client_id)
+              get "brandwatch/client/#{client_id}/commandcenter/users"
+            end
+
+            # Fetch a single user's Vizia access level
+            #
+            # TODO: Add parameters documentation
+            def brandwatch_user_access_level(client_id, user_id)
+              get "brandwatch/client/#{client_id}/commandcenter/users/#{user_id}"
+            end
+
+            include BWAPI::Client::Brandwatch::Clients::CommandCenter::Users::Access
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module Clients
+        module CommandCenter
+          module Users
+            # Access module for brandwatch/client/{client_id}/commandcenter/users/{user_id}/access endpoints
+            module Access
+              # Update a user's Vizia access level
+              #
+              # TODO: Add parameters documentation
+              def brandwatch_update_user_access_level(client_id, user_id, access_level)
+                put "brandwatch/client/#{client_id}/commandcenter/users/#{user_id}/access/#{access_level}"
+              end
+
+              # Revoke a user's Vizia access
+              #
+              # TODO: Add parameters documentation
+              def brandwatch_delete_user_access_level(client_id, user_id, access_level)
+                delete "brandwatch/client/#{client_id}/commandcenter/users/#{user_id}/access/#{access_level}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end