bwapi 1.0.0

data/lib/bwapi/client/admin/users.rb

@@ -0,0 +1,95 @@
+require 'bwapi/client/admin/users/sharing'
+
+module BWAPI
+  class Client
+    module Admin
+      module Clients
+        module Users
+
+          # Get all users for client
+          #
+          # @param id [Integer] Id of the client
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] page Page of projects to retrieve
+          # @option opts [Integer] pageSize Results per page of results
+          # @return [Hashie::Mash] All client users
+          def client_users id, opts={}
+            get "admin/clients/#{id}/users", opts
+          end
+
+          # Get a specific user in client
+          #
+          # @param client_id [Integer] Id of the client
+          # @param user_id [Integer] Id of the user
+          # @return [Hashie::Mash] Specific client user
+          def get_client_user client_id, user_id
+            get "admin/clients/#{client_id}/users/#{user_id}"
+          end
+          alias :get_user :get_client_user
+
+
+          # Create a new client user
+          #
+          # @param id [Integer] Id of the client
+          # @param opts [Hash] options Hash of parameters
+          # @option opts [Integer] id Id of the user
+          # @option opts [Hash] tags The users assigned tags
+          # @option opts [String] passwordConfirmation The confirmed password
+          # @option opts [Boolean] enabled The status of the user
+          # @option opts [String] lastName The last name of the user
+          # @option opts [String] phone The users phone number
+          # @option opts [String] department The users department
+          # @option opts [String] job The users job
+          # @option opts [String] messenger The users IM details
+          # @option opts [String] password The password of the user
+          # @option opts [Integer] clientId The users client id
+          # @option opts [String] username The users username
+          # @option opts [String] address The users address
+          # @option opts [String] uiRole The users ui role
+          # @option opts [Array] apiRole The users api role
+          # @option opts [String] firstName The users first name
+          # @option opts [String] mobile The users mobile number
+          # @option opts [Date] creationDate Date the user was created on
+          # @return [Hashie::Mash] New user
+          def create_client_user id, opts
+            post "admin/clients/#{id}/users", opts
+          end
+          alias :create_user :create_client_user
+
+          # Update an existing client user
+          #
+          # @param client_id [Integer] Id of the client
+          # @param user_id [Integer] Id of the user
+          # @param opts [Hash] options Hash of parameters
+          # @option opts [Integer] id Id of the user
+          # @option opts [Hash] tags The users assigned tags
+          # @option opts [String] passwordConfirmation The confirmed password
+          # @option opts [Boolean] enabled The status of the user
+          # @option opts [String] lastName The last name of the user
+          # @option opts [String] phone The users phone number
+          # @option opts [String] department The users department
+          # @option opts [String] job The users job
+          # @option opts [String] messenger The users IM details
+          # @option opts [String] password The password of the user
+          # @option opts [Integer] clientId The users client id
+          # @option opts [String] username The users username
+          # @option opts [String] address The users address
+          # @option opts [String] uiRole The users ui role
+          # @option opts [Array] apiRole The users api role
+          # @option opts [String] firstName The users first name
+          # @option opts [String] mobile The users mobile number
+          # @option opts [Date] creationDate Date the user was created on
+          # @return [Hashie::Mash] New user
+          def update_client_user client_id, user_id, opts
+            put "admin/clients/#{client_id}/users/#{user_id}", opts
+          end
+          alias :update_user :update_client_user
+
+
+          include BWAPI::Client::Admin::Clients::Users::Sharing
+
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/admin/users/sharing.rb

@@ -0,0 +1,35 @@
+module BWAPI
+  class Client
+    module Admin
+      module Clients
+        module Users
+          module Sharing
+
+            # Get a list of project shares for user
+            #
+            # @param client_id [Integer] Id of the client
+            # @param user_id [Integer] Id of the user
+            # @return [Hashie::Mash] All shares for client user
+            def client_users_sharing client_id, user_id
+              get "admin/client/#{client_id}/users/#{user_id}/sharing"
+            end
+            alias :users_sharing :client_users_sharing
+
+            # Update a list of project shares for user
+            #
+            # @param client_id [Integer] Id of the client
+            # @param user_id [Integer] Id of the user
+            # @param opts [Hash] options Hash of parameters
+            # @option opts [Array] ProjectShareDTO The shares of the user
+            # @return [Hashie::Mash] Updated shares for client user
+            def update_client_users_sharing client_id, user_id, opts
+              get "admin/client/#{client_id}/users/#{user_id}/sharing", opts
+            end
+            alias :update_users_sharing :update_client_users_sharing
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/brandwatch.rb

@@ -0,0 +1,33 @@
+require 'bwapi/client/brandwatch/become'
+require 'bwapi/client/brandwatch/client_modules'
+
+module BWAPI
+  class Client
+    module Brandwatch
+
+      # Create a new data download in project
+      #
+      # @param id [Integer] Id of project
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] projectId Id of the project
+      # @option opts [Integer] id Id of the data download
+      # @option opts [Integer] queryId Id of the query
+      # @option opts [Int] percentComplete The percentage complete of data download
+      # @option opts [String] status The status of the download
+      # @option opts [String] queryName The query name of the data download
+      # @option opts [Date] endDate The end date of the data download
+      # @option opts [Date] requestDate The request date of the data download
+      # @option opts [String] downloadLinkXLS The link to download the XLS format
+      # @option opts [String] downloadLinkCSV The link to download the CSV format
+      # @option opts [Array] additionalColumns The additional columns for the data download
+      # @return [Hashie::Mash] New data download
+      def brandwatch_data_download id, opts
+        post "brandwatch/#{project_id}/datadownload", opts
+      end
+
+      include BWAPI::Client::Brandwatch::Become
+      include BWAPI::Client::Brandwatch::ClientModules
+
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module Become
+
+        # Become user
+        #
+        # @note must be a super admin user
+        #
+        # @param id [Integer] The user id
+        # @return [Hashie::Mash] User credentials
+        def brandwatch_become id
+          get "brandwatch/become/#{id}"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module ClientModules
+
+        # Get a specific clients modules
+        #
+        # @param id [Integer] Id of the client
+        # @return [Hashie::Mash] Specific clients modules
+        def brandwatch_client_modules id
+          get "brandwatch/clientModules/#{id}"
+        end
+
+        # Update brandwatch client modules
+        #
+        # @param opts [Hash] options Hash of parameters
+        # @option opts [Array] ClientModules Client Modules to edit
+        # @return [Hashie::Mash] Update client modules
+        def update_brandwatch_client_module opts
+          put "brandwatch/clientModules", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/bwapi/client/client.rb

@@ -0,0 +1,22 @@
+module BWAPI
+  class Client
+    module Client
+
+      # Get the current users client
+      #
+      # @return [Hashie::Mash] Client information
+      def client
+        get "client"
+      end
+
+      # Get the current users client modules
+      #
+      # @return [Hashie::Mash] Client module information
+      def client_modules
+        get "client/modules"
+      end
+      alias :modules :client_modules
+
+    end
+  end
+end

data/lib/bwapi/client/error_codes.rb

@@ -0,0 +1,14 @@
+module BWAPI
+  class Client
+    module ErrorCodes
+
+      # Get the api error codes
+      #
+      # @return [Hashie::Mash] Error codes information
+      def error_codes
+        get "errorCodes"
+      end
+
+    end
+  end
+end

data/lib/bwapi/client/filters.rb

@@ -0,0 +1,14 @@
+module BWAPI
+  class Client
+    module Filters
+
+      # Get the currently supported filters
+      #
+      # @return [Hashie::Mash] Current filters
+      def filters
+        get "filters"
+      end
+
+    end
+  end
+end

data/lib/bwapi/client/logout.rb

@@ -0,0 +1,24 @@
+module BWAPI
+  class Client
+    module Logout
+
+      # Logout user
+      #
+      # @return [Hashie::Mash] Logout information
+      def logout
+        begin
+          get "logout"
+        ensure
+          self.username       = nil
+          self.password       = nil
+          self.access_token   = nil
+          self.client_id      = nil
+          self.access_token   = nil
+          self.refresh_token  = nil
+          self.expires_in     = nil
+        end
+      end
+
+    end
+  end
+end

data/lib/bwapi/client/me.rb

@@ -0,0 +1,42 @@
+module BWAPI
+  class Client
+    module Me
+
+      # Get user information
+      #
+      # @return [Hashie::Mash] User information
+      def me
+        get 'me'
+      end
+
+      # Get users client name
+      #
+      # @return [String] Users client name
+      def client_name
+        me.client.name
+      end
+
+      # Get users client id
+      #
+      # @return [String] Users client id
+      def client_id
+        me.client.id
+      end
+
+      # Get users client id
+      #
+      # @return [String] Users client id
+      def client_id
+        me.client.id
+      end
+
+      # Get users id
+      #
+      # @return [String] Users role
+      def user_id
+        me.id
+      end
+
+    end
+  end
+end

data/lib/bwapi/client/oauth.rb

@@ -0,0 +1,78 @@
+module BWAPI
+  class Client
+    module OAuth
+
+      # Authenticate a user
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] username User name of user
+      # @option opts [String] password User name of user
+      # @option opts [String] grant_type Grant type of user
+      # @option opts [String] client_secret Client secret
+      # @option opts [String] client_id Client id
+      # @option opts [String] force_urlencoded Force urlencoded
+      def oauth_token opts={}
+        opts = {
+          username: username,
+          password: password,
+          grant_type: 'password',
+          client_secret: client_secret,
+          client_id: client_id,
+          force_urlencoded: true
+        }.merge opts
+
+        begin
+          creds  = post 'oauth/token', opts
+        rescue BWAPI::BWError
+          return false
+        else
+          self.access_token = creds.access_token
+          self.expires_in = creds.expires_in
+
+          if application_client?
+            self.refresh_token = creds.refresh_token
+          end
+
+          return true
+        end
+      end
+      alias :login :oauth_token
+
+      # Refresh a authenticated users oauth_token
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] username User name of user
+      # @option opts [String] password User name of user
+      # @option opts [String] grant_type Grant type of user
+      # @option opts [String] client_id Client id
+      # @option opts [String] force_urlencoded Force urlencoded
+      def oauth_refresh_token opts={}
+        opts = {
+          username: username,
+          password: password,
+          refresh_token: refresh_token,
+          grant_type: 'refresh_token',
+          client_id: client_id,
+          force_urlencoded: true
+        }.merge opts
+
+        begin
+          creds = post 'oauth/token', opts
+        rescue BWAPI::BWError
+          return false
+        else
+          self.access_token = creds.access_token
+          self.expires_in = creds.expires_in
+
+          if application_client?
+            self.access_token = creds.access_token
+          end
+
+          return true
+        end
+      end
+      alias :refresh :oauth_refresh_token
+
+    end
+  end
+end

data/lib/bwapi/client/ping.rb

@@ -0,0 +1,42 @@
+module BWAPI
+  class Client
+    module Ping
+
+      # Get ping checking access and available HTTP verbs
+      #
+      # @return [Hashie::Mash] User id and name
+      def get_ping
+        get "ping"
+      end
+
+      # Post ping checking access and available HTTP verbs
+      #
+      # @return [Hashie::Mash] User id and name
+      def create_ping
+        post "ping"
+      end
+
+      # Put ping checking access and available HTTP verbs
+      #
+      # @return [Hashie::Mash] User id and name
+      def update_ping
+        put "ping"
+      end
+
+      # Patch ping checking access and available HTTP verbs
+      #
+      # @return [Hashie::Mash] User id and name
+      def patch_ping
+        patch "ping"
+      end
+
+      # Delete ping checking access and available HTTP verbs
+      #
+      # @return [Hashie::Mash] User id and name
+      def delete_ping
+        delete "ping"
+      end
+
+    end
+  end
+end